Class: Origen::VersionString
- Includes:
- Utility::TimeAndDate
- Defined in:
- lib/origen/version_string.rb
Class Method Summary collapse
-
.development_timestamp ⇒ Object
Returns a new development timestamp version string.
-
.maximum_version(condition) ⇒ Object
Returns the maximum Origen version that would satisfy the given condition, if the condition does not specify a maximum nil will be returned.
-
.minimum_version(condition) ⇒ Object
Returns the minimum Origen version that would satisfy the given condition, if the condition does not specify a minimum nil will be returned.
-
.production_timestamp ⇒ Object
Returns a new production timestamp version string.
Instance Method Summary collapse
- #bugfix ⇒ Object (also: #tiny)
-
#condition_met?(condition) ⇒ Boolean
Returns true if the version fulfills the supplied condition.
-
#development? ⇒ Boolean
Returns true if the version is a development tag.
- #greater_than?(version) ⇒ Boolean (also: #gt?)
- #greater_than_or_equal_to?(version) ⇒ Boolean (also: #gte?)
-
#initialize(version, prefix = 'v') ⇒ VersionString
constructor
returns version number string but strips out prefix.
- #latest? ⇒ Boolean
- #less_than?(version) ⇒ Boolean (also: #lt?)
- #less_than_or_equal_to?(version) ⇒ Boolean (also: #lte?)
- #major ⇒ Object
- #minor ⇒ Object
- #next_dev(type = :minor) ⇒ Object
- #next_prod(type = :minor) ⇒ Object
-
#numeric ⇒ Object
Returns a numeric representation of the version, this can be used for chronological comparison with other versions.
- #pre ⇒ Object (also: #dev)
-
#prefixed(str = 'v') ⇒ Object
Returns the version prefixed with the given value (āvā by default) if not already present.
-
#production? ⇒ Boolean
Returns true if the version is a production tag.
-
#semantic? ⇒ Boolean
Returns true if the version is a semantic format version number.
-
#timestamp? ⇒ Boolean
Returns true if the version is a timestamp format version number.
-
#to_date ⇒ Object
Returns the version as a date, only applicable for timestamps, otherwise an error will be raised.
-
#to_time ⇒ Object
Returns the version as a time, only applicable for timestamps, otherwise an error will be raised.
-
#valid?(_options = {}) ⇒ Boolean
Returns true if the version is a correctly formatted semantic or timestamp version number.
-
#validate!(msg = nil) ⇒ Object
Will raise an error if the version is not valid, i.e.
-
#validate_condition!(condition, tag) ⇒ Object
Validates the given condition and the extracted tag, returns the tag wrapped in a VersionString if valid, will raise an error if not.
Methods included from Utility::TimeAndDate
Methods inherited from String
#camel_case, #escape_underscores, #excel_col_index, #is_downcase?, #is_numeric?, #is_upcase?, #is_verilog_number?, #pad_leading_zeros, #squeeze_lines, #symbolize, #titleize, #to_bool, #to_dec, #to_lines, #to_numeric, #to_snakecase, #to_snakecase!
Constructor Details
#initialize(version, prefix = 'v') ⇒ VersionString
returns version number string but strips out prefix
7 8 9 10 |
# File 'lib/origen/version_string.rb', line 7 def initialize(version, prefix = 'v') version.gsub!(/^#{prefix}/, '') # remove leading prefix super(version) end |
Class Method Details
.development_timestamp ⇒ Object
Returns a new development timestamp version string
18 19 20 |
# File 'lib/origen/version_string.rb', line 18 def self. VersionString.new("#{User.current.initials}_#{time_now(format: :universal, underscore: true)}") end |
.maximum_version(condition) ⇒ Object
Returns the maximum Origen version that would satisfy the given condition, if the condition does not specify a maximum nil will be returned
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/origen/version_string.rb', line 335 def self.maximum_version(condition) if condition =~ /^==?\s*(.*)/ version = Regexp.last_match[1] elsif condition =~ /^<=\s*(.*)/ version = Regexp.last_match[1] elsif condition =~ /^<\s*(.*)/ # This is tricky to support, would probably require a lookup # table of all versions to be maintained fail 'Maximum < version is currently not supported!' elsif condition =~ /^>=?\s*(.*)/ nil else version = condition end VersionString.new(version).validate! if version end |
.minimum_version(condition) ⇒ Object
Returns the minimum Origen version that would satisfy the given condition, if the condition does not specify a minimum nil will be returned
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/origen/version_string.rb', line 316 def self.minimum_version(condition) if condition =~ /^==?\s*(.*)/ version = Regexp.last_match[1] elsif condition =~ /^>=\s*(.*)/ version = Regexp.last_match[1] elsif condition =~ /^>\s*(.*)/ # This is tricky to support, would probably require a lookup # table of all versions to be maintained fail 'Minimum > version is currently not supported!' elsif condition =~ /^<=?\s*(.*)/ nil else version = condition end VersionString.new(version).validate! if version end |
.production_timestamp ⇒ Object
Returns a new production timestamp version string
13 14 15 |
# File 'lib/origen/version_string.rb', line 13 def self. VersionString.new("Rel#{time_now(format: :universal, include_time: false)}") end |
Instance Method Details
#bugfix ⇒ Object Also known as: tiny
146 147 148 149 150 151 152 153 154 155 |
# File 'lib/origen/version_string.rb', line 146 def bugfix @bugfix ||= begin if semantic? self =~ /v?\d+.\d+.(\d+)/ Regexp.last_match[1].to_i else fail "#{self} is not a valid semantic version number!" end end end |
#condition_met?(condition) ⇒ Boolean
Returns true if the version fulfills the supplied condition. Example conditions:
"v2.1.3" # must equal the given version
"= v2.1.3" # alias for the above
"> v2.1.3" # must be greater than the given version
">= v2.1.3" # must be greater than or equal to the given version
"< v2.1.3" # must be less than the given version
"<= v2.1.3" # must be less than or equal to the given version
"production" # must be a production tag
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/origen/version_string.rb', line 191 def condition_met?(condition) condition = condition.to_s.strip if condition == 'prod' || condition == 'production' production? elsif condition =~ /^>=\s*(.*)/ tag = validate_condition!(condition, Regexp.last_match[1]) # Force false in the case where a production and development # timestamp fall on the same date. Since the production tag # does not contain time information it is impossible to say # which one is greater if production? != tag.production? && && to_date == tag.to_date false else numeric >= tag.numeric && ((self.latest? || tag.latest?) || self. == tag.) end elsif condition =~ /^>\s*(.*)/ tag = validate_condition!(condition, Regexp.last_match[1]) if production? != tag.production? && && to_date == tag.to_date false else numeric > tag.numeric && ((self.latest? || tag.latest?) || self. == tag.) end elsif condition =~ /^<=\s*(.*)/ tag = validate_condition!(condition, Regexp.last_match[1]) numeric <= tag.numeric && ((self.latest? || tag.latest?) || self. == tag.) elsif condition =~ /^<\s*(.*)/ tag = validate_condition!(condition, Regexp.last_match[1]) numeric < tag.numeric && ((self.latest? || tag.latest?) || self. == tag.) elsif condition =~ /^==?\s*(.*)/ tag = validate_condition!(condition, Regexp.last_match[1]) self == tag else tag = validate_condition!(condition, condition) self == tag end end |
#development? ⇒ Boolean
Returns true if the version is a development tag
28 29 30 |
# File 'lib/origen/version_string.rb', line 28 def development? !production? end |
#greater_than?(version) ⇒ Boolean Also known as: gt?
42 43 44 |
# File 'lib/origen/version_string.rb', line 42 def greater_than?(version) condition_met?("> #{version}") end |
#greater_than_or_equal_to?(version) ⇒ Boolean Also known as: gte?
47 48 49 |
# File 'lib/origen/version_string.rb', line 47 def greater_than_or_equal_to?(version) condition_met?(">= #{version}") end |
#latest? ⇒ Boolean
171 172 173 |
# File 'lib/origen/version_string.rb', line 171 def latest? downcase == 'trunk' || downcase == 'latest' end |
#less_than?(version) ⇒ Boolean Also known as: lt?
32 33 34 |
# File 'lib/origen/version_string.rb', line 32 def less_than?(version) condition_met?("< #{version}") end |
#less_than_or_equal_to?(version) ⇒ Boolean Also known as: lte?
37 38 39 |
# File 'lib/origen/version_string.rb', line 37 def less_than_or_equal_to?(version) condition_met?("<= #{version}") end |
#major ⇒ Object
124 125 126 127 128 129 130 131 132 133 |
# File 'lib/origen/version_string.rb', line 124 def major @major ||= begin if semantic? self =~ /v?(\d+)/ Regexp.last_match[1].to_i else fail "#{self} is not a valid semantic version number!" end end end |
#minor ⇒ Object
135 136 137 138 139 140 141 142 143 144 |
# File 'lib/origen/version_string.rb', line 135 def minor @minor ||= begin if semantic? self =~ /v?\d+.(\d+)/ Regexp.last_match[1].to_i else fail "#{self} is not a valid semantic version number!" end end end |
#next_dev(type = :minor) ⇒ Object
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/origen/version_string.rb', line 65 def next_dev(type = :minor) if semantic? if pre if self =~ /dev/ VersionString.new("#{major}.#{minor + 1}.0.pre#{pre + 1}") else VersionString.new("#{major}.#{minor}.#{tiny}.pre#{pre + 1}") end else case type when :major VersionString.new("#{major + 1}.0.0.pre0") when :minor, :development VersionString.new("#{major}.#{minor + 1}.0.pre0") when :tiny, :bugfix VersionString.new("#{major}.#{minor}.#{tiny + 1}.pre0") else fail "Unknown version counter type '#{type}', must be :major, :minor or :tiny" end end else VersionString.new("#{User.current.initials}_#{time_now(format: :universal, underscore: true)}") end end |
#next_prod(type = :minor) ⇒ Object
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/origen/version_string.rb', line 90 def next_prod(type = :minor) if semantic? if pre if self =~ /dev/ case type when :major VersionString.new("#{major + 1}.0.0") when :minor, :production VersionString.new("#{major}.#{minor + 1}.0") when :tiny, :bugfix VersionString.new("#{major}.#{minor}.#{tiny + 1}") else fail "Unknown version counter type '#{type}', must be :major, :minor or :tiny" end else VersionString.new("#{major}.#{minor}.#{tiny}") end else case type when :major VersionString.new("#{major + 1}.0.0") when :minor, :production VersionString.new("#{major}.#{minor + 1}.0") when :tiny, :bugfix VersionString.new("#{major}.#{minor}.#{tiny + 1}") else fail "Unknown version counter type '#{type}', must be :major, :minor or :tiny" end end else VersionString.new("Rel#{time_now(format: :universal, include_time: false)}") end end |
#numeric ⇒ Object
Returns a numeric representation of the version, this can be used for chronological comparison with other versions
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/origen/version_string.rb', line 238 def numeric if latest? 1_000_000_000_000_000_000_000_000_000 elsif semantic? # This assumes each counter will never go > 1000 if development? self =~ /v?(\d+).(\d+).(\d+).(dev|pre)(\d+)/ (Regexp.last_match[1].to_i * 1000 * 1000 * 1000) + (Regexp.last_match[2].to_i * 1000 * 1000) + (Regexp.last_match[3].to_i * 1000) + Regexp.last_match[5].to_i else self =~ /v?(\d+).(\d+).(\d+)/ (Regexp.last_match[1].to_i * 1000 * 1000 * 1000) + (Regexp.last_match[2].to_i * 1000 * 1000) + (Regexp.last_match[3].to_i * 1000) end elsif to_time.to_i else validate! end end |
#pre ⇒ Object Also known as: dev
158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/origen/version_string.rb', line 158 def pre @pre ||= begin if semantic? if self =~ /(dev|pre)(\d+)$/ Regexp.last_match[2].to_i end else fail "#{self} is not a valid semantic version number!" end end end |
#prefixed(str = 'v') ⇒ Object
Returns the version prefixed with the given value (āvā by default) if not already present
354 355 356 357 358 359 360 |
# File 'lib/origen/version_string.rb', line 354 def prefixed(str = 'v') if self =~ /^#{str}/ to_s else "#{str}#{self}" end end |
#production? ⇒ Boolean
Returns true if the version is a production tag
23 24 25 |
# File 'lib/origen/version_string.rb', line 23 def production? !!(self =~ /^v?\d+\.\d+\.\d+$/ || self =~ /^Rel\d+$/) end |
#semantic? ⇒ Boolean
Returns true if the version is a semantic format version number
59 60 61 62 63 |
# File 'lib/origen/version_string.rb', line 59 def semantic? !!(self =~ /^v?\d+\.\d+\.\d+$/ || self =~ /^v?\d+\.\d+\.\d+\.(dev|pre)\d+$/ ) end |
#timestamp? ⇒ Boolean
Returns true if the version is a timestamp format version number
176 177 178 179 |
# File 'lib/origen/version_string.rb', line 176 def !!(self =~ /^Rel\d\d\d\d\d\d\d\d$/ || self =~ /^\w\w\w?_\d\d\d\d_\d\d_\d\d_\d\d_\d\d$/) end |
#to_date ⇒ Object
Returns the version as a date, only applicable for timestamps, otherwise an error will be raised
282 283 284 285 286 287 288 289 290 |
# File 'lib/origen/version_string.rb', line 282 def to_date if latest? Date.new(10_000, 1, 1) elsif to_time.to_date else fail "Version tag #{self} cannot be converted to a date!" end end |
#to_time ⇒ Object
Returns the version as a time, only applicable for timestamps, otherwise an error will be raised
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/origen/version_string.rb', line 264 def to_time if latest? Time.new(10_000, 1, 1) elsif if development? self =~ /\w+_(\d\d\d\d)_(\d\d)_(\d\d)_(\d\d)_(\d\d)$/ Time.new(Regexp.last_match[1], Regexp.last_match[2], Regexp.last_match[3], Regexp.last_match[4], Regexp.last_match[5]) else self =~ /Rel(\d\d\d\d)(\d\d)(\d\d)/ Time.new(Regexp.last_match[1], Regexp.last_match[2], Regexp.last_match[3]) end else fail "Version tag #{self} cannot be converted to a time!" end end |
#valid?(_options = {}) ⇒ Boolean
Returns true if the version is a correctly formatted semantic or timestamp version number
54 55 56 |
# File 'lib/origen/version_string.rb', line 54 def valid?( = {}) latest? || semantic? || end |
#validate!(msg = nil) ⇒ Object
Will raise an error if the version is not valid, i.e. if valid? returns false
303 304 305 306 307 308 309 310 311 312 |
# File 'lib/origen/version_string.rb', line 303 def validate!(msg = nil) unless valid? if msg fail msg else fail "The version string, #{self}, is not valid!" end end self end |
#validate_condition!(condition, tag) ⇒ Object
Validates the given condition and the extracted tag, returns the tag wrapped in a VersionString if valid, will raise an error if not
295 296 297 298 299 |
# File 'lib/origen/version_string.rb', line 295 def validate_condition!(condition, tag) tag = VersionString.new(tag) tag.validate!("The version condition, #{condition}, is not valid!") tag end |