Class: Calabash::Android::Version

Inherits:
Object
  • Object
show all
Defined in:
lib/calabash-android/version.rb

Overview

A model of a software release version that can be used to compare two versions.

Calabash and RunLoop try very hard to comply with Semantic Versioning rules. However, the semantic versioning spec is incompatible with RubyGem's patterns for pre-release gems.

> “But returning to the practical: No release version of SemVer is compatible > with Rubygems.” - _David Kellum_

Calabash and RunLoop version numbers will be in the form `<needs to handle a unix timestamp - found the DeviceAgent-Runner.app.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ Version

Creates a new Version instance with all the attributes set.

Examples:

version = Version.new(0.10.1)
version.major       => 0
version.minor       => 10
version.patch       => 1
version.pre         => false
version.pre_version => nil
version = Version.new(1.6.3.pre5)
version.major       => 1
version.minor       => 6
version.patch       => 3
version.pre         => true
version.pre_version => 5

Parameters:

  • version (String)

    the version string to parse.

Raises:

  • (ArgumentError)

    if version is not in the form 5, 6.1, 7.1.2, 8.2.3.pre1


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/calabash-android/version.rb', line 65

def initialize(version)
  tokens = version.strip.split('.')
  count = tokens.count
  if tokens.empty?
    raise ArgumentError, "expected '#{version}' to be like 5, 6.1, 7.1.2, 8.2.3.pre1"
  end

  if count < 4 and tokens.any? { |elm| elm =~ /\D/ }
    raise ArgumentError, "expected '#{version}' to be like 5, 6.1, 7.1.2, 8.2.3.pre1"
  end

  if count == 4
    @pre = tokens[3]
    pre_tokens = @pre.scan(/\D+|\d+/)
    @pre_version = pre_tokens[1].to_i if pre_tokens.count == 2
  end

  @major, @minor, @patch = version.split('.').map(&:to_i)
end

Instance Attribute Details

#majorInteger

Returns the major version.

Returns:

  • (Integer)

    the major version


26
27
28
# File 'lib/calabash-android/version.rb', line 26

def major
  @major
end

#minorInteger

Returns the minor version.

Returns:

  • (Integer)

    the minor version


30
31
32
# File 'lib/calabash-android/version.rb', line 30

def minor
  @minor
end

#patchInteger

Returns the patch version.

Returns:

  • (Integer)

    the patch version


34
35
36
# File 'lib/calabash-android/version.rb', line 34

def patch
  @patch
end

#preBoolean

Returns true if this is a pre-release version.

Returns:

  • (Boolean)

    true if this is a pre-release version


38
39
40
# File 'lib/calabash-android/version.rb', line 38

def pre
  @pre
end

#pre_versionInteger

Returns if this is a pre-release version, returns the pre-release version; otherwise this is nil.

Returns:

  • (Integer)

    if this is a pre-release version, returns the pre-release version; otherwise this is nil


43
44
45
# File 'lib/calabash-android/version.rb', line 43

def pre_version
  @pre_version
end

Class Method Details

.compare(a, b) ⇒ Integer

Compare version `a` to version `b`.

Examples:

compare Version.new(0.10.0), Version.new(0.9.0)  =>  1
compare Version.new(0.9.0),  Version.new(0.10.0) => -1
compare Version.new(0.9.0),  Version.new(0.9.0)  =>  0

Returns:

  • (Integer)

    an integer `(-1, 1)`


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/calabash-android/version.rb', line 179

def self.compare(a, b)

  if a.major != b.major
    return a.major.to_i > b.major.to_i ? 1 : -1
  end

  a_minor = a.minor ? a.minor.to_i : 0
  b_minor = b.minor ? b.minor.to_i : 0
  if a_minor != b_minor
    return a_minor > b_minor.to_i ? 1 : -1
  end

  a_patch = a.patch ? a.patch.to_i : 0
  b_patch = b.patch ? b.patch.to_i : 0
  if a_patch != b_patch
    return a_patch.to_i > b_patch.to_i ? 1 : -1
  end

  return -1 if a.pre && (!a.pre_version) && b.pre_version
  return 1 if a.pre_version && b.pre && (!b.pre_version)

  return -1 if a.pre && (!b.pre)
  return 1 if (!a.pre) && b.pre

  return -1 if a.pre_version && (!b.pre_version)
  return 1 if (!a.pre_version) && b.pre_version

  if a.pre_version != b.pre_version
    return a.pre_version.to_i > b.pre_version.to_i ? 1 : -1
  end
  0
end

Instance Method Details

#!=(other) ⇒ Boolean

Compare this version to another for inequality.

Parameters:

  • other (Version)

    the version to compare against

Returns:

  • (Boolean)

    true if this Version is not the same as `other`


127
128
129
# File 'lib/calabash-android/version.rb', line 127

def != (other)
  Version.compare(self, other) != 0
end

#<(other) ⇒ Boolean

Is this version less-than another version?

Parameters:

  • other (Version)

    the version to compare against

Returns:

  • (Boolean)

    true if this Version is less-than `other`


134
135
136
# File 'lib/calabash-android/version.rb', line 134

def < (other)
  Version.compare(self, other) < 0
end

#<=(other) ⇒ Boolean

Is this version less-than or equal to another version?

Parameters:

  • other (Version)

    the version to compare against

Returns:

  • (Boolean)

    true if this Version is less-than or equal `other`


148
149
150
# File 'lib/calabash-android/version.rb', line 148

def <= (other)
  Version.compare(self, other) <= 0
end

#<=>(other) ⇒ Integer

Compare version `a` to version `b`.

Examples:

compare Version.new(0.10.0), Version.new(0.9.0)  =>  1
compare Version.new(0.9.0),  Version.new(0.10.0) => -1
compare Version.new(0.9.0),  Version.new(0.9.0)  =>  0

Returns:

  • (Integer)

    an integer `(-1, 1)`


167
168
169
# File 'lib/calabash-android/version.rb', line 167

def <=> (other)
  Version.compare(self, other)
end

#==(other) ⇒ Boolean

Compare this version to another for equality.

Parameters:

  • other (Version)

    the version to compare against

Returns:

  • (Boolean)

    true if this Version is the same as `other`


120
121
122
# File 'lib/calabash-android/version.rb', line 120

def == (other)
  Version.compare(self, other) == 0
end

#>(other) ⇒ Boolean

Is this version greater-than another version?

Parameters:

  • other (Version)

    the version to compare against

Returns:

  • (Boolean)

    true if this Version is greater-than `other`


141
142
143
# File 'lib/calabash-android/version.rb', line 141

def > (other)
  Version.compare(self, other) > 0
end

#>=(other) ⇒ Boolean

Is this version greater-than or equal to another version?

Parameters:

  • other (Version)

    the version to compare against

Returns:

  • (Boolean)

    true if this Version is greater-than or equal `other`


155
156
157
# File 'lib/calabash-android/version.rb', line 155

def >= (other)
  Version.compare(self, other) >= 0
end

#eql?(other) ⇒ Boolean

Compare this version to another for object equality. This allows Version instances to be used as Hash keys.

Parameters:

  • other (Version)

    the version to compare against.

Returns:

  • (Boolean)

100
101
102
# File 'lib/calabash-android/version.rb', line 100

def eql?(other)
  hash == other.hash
end

#hashObject

The hash method for this instance.


105
106
107
108
109
110
111
112
113
114
115
# File 'lib/calabash-android/version.rb', line 105

def hash
  str = [major, minor, patch].map do |str|
    str ? str : "0"
  end.join(".")

  if pre
    str = "#{str}.#{pre}"
  end

  str.hash
end

#inspectObject


93
94
95
# File 'lib/calabash-android/version.rb', line 93

def inspect
  "#<Version #{to_s}>"
end

#to_sString

Returns an string representation of this version.