1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
|
# -----------------------------------------------------------------------------
#
# Versionomy value
#
# -----------------------------------------------------------------------------
# Copyright 2008 Daniel Azuma
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# * Neither the name of the copyright holder, nor the names of any other
# contributors to this software, may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# -----------------------------------------------------------------------------
;
begin
require 'psych'
rescue ::LoadError
require 'yaml'
end
module Versionomy
# === Version number value
#
# A version number value is an ordered list of values, corresponding to an
# ordered list of fields defined by a schema. For example, if the schema
# is a simple one of the form "major.minor.tiny", then the the version
# number "1.4.2" would have the values <tt>[1, 4, 2]</tt> in that order,
# corresponding to the fields <tt>[:major, :minor, :tiny]</tt>.
#
# Version number values are comparable with other values that have an
# equivalent schema.
class Value
# Create a value, given a hash or array of values, and a format. Both
# these parameters are required.
#
# The values should either be a hash of field names and values, or an
# array of values that will be interpreted in field order.
#
# You can also optionally provide default unparsing parameters for the
# value.
def initialize(values_, format_, unparse_params_=nil)
unless values_.kind_of?(::Hash) || values_.kind_of?(::Array)
raise ::ArgumentError, "Expected hash or array but got #{values_.class}"
end
@_format = format_
@_unparse_params = unparse_params_
@_field_path = []
@_values = {}
values_ = _canonicalize_values_hash(values_) if values_.kind_of?(::Hash)
field_ = @_format.schema.root_field
while field_
value_ = values_.kind_of?(::Hash) ? values_[field_.name] : values_.shift
value_ = value_ ? field_.canonicalize_value(value_) : field_.default_value
@_field_path << field_
@_values[field_.name] = value_
field_ = field_.child(value_)
end
modules_ = @_format.schema.modules
extend(*modules_) if modules_.size > 0
end
def inspect # :nodoc:
begin
str_ = unparse
"#<#{self.class}:0x#{object_id.to_s(16)} #{str_.inspect}>"
rescue Errors::UnparseError
_inspect
end
end
def _inspect # :nodoc:
"#<#{self.class}:0x#{object_id.to_s(16)} " +
@_field_path.map{ |field_| "#{field_.name}=#{@_values[field_.name].inspect}" }.join(' ')
end
# Returns a string representation generated by unparsing.
# If unparsing fails, does not raise Versionomy::Errors::UnparseError,
# but instead returns the string generated by +inspect+.
def to_s
begin
unparse
rescue Errors::UnparseError
_inspect
end
end
# Unparse this version number and return a string.
#
# Raises Versionomy::Errors::UnparseError if unparsing failed.
def unparse(params_=nil)
@_format.unparse(self, params_)
end
# Return the schema defining the structure and semantics of this
# version number.
def schema
@_format.schema
end
# Return the format defining the schema and formatting/parsing of
# this version number.
def format
@_format
end
# Return the unparsing parameters for this value.
# Returns nil if this value was not created using a parser.
def unparse_params
@_unparse_params ? @_unparse_params.dup : nil
end
# Iterates over each field, in field order, yielding the field name and value.
def each_field
@_field_path.each do |field_|
yield(field_, @_values[field_.name])
end
end
# Iterates over each field, in field order, yielding the
# Versionomy::Schema::Field object and value.
def each_field_object # :nodoc:
@_field_path.each do |field_|
yield(field_, @_values[field_.name])
end
end
# Returns an array of recognized field names for this value, in field order.
# This is the order of the fields actually present in this value, in
# order from most to least significant.
def field_names
@_field_path.map{ |field_| field_.name }
end
# Returns true if this value contains the given field, which may be specified
# as a field object, name, or index.
def has_field?(field_)
case field_
when Schema::Field
@_field_path.include?(field_)
when ::Integer
@_field_path.size > field_ && field_ >= 0
when ::String, ::Symbol
@_values.has_key?(@_format.schema.canonical_name(field_))
else
raise ::ArgumentError
end
end
# Returns the value of the given field, or nil if the field is not
# recognized. The field may be specified as a field object, field name,
# or field index.
def [](field_)
@_values[_interpret_field(field_)]
end
# Returns the value as an array of field values, in field order.
# This is the order of the fields actually present in this value, in
# order from most to least significant.
def values_array
@_field_path.map{ |field_| @_values[field_.name] }
end
# Returns the value as a hash of values keyed by field name.
def values_hash
@_values.dup
end
# Returns a new version number created by bumping the given field. The
# field may be specified as a field object, field name, or field index.
# Returns self unchanged if the field was not recognized or could not
# be modified.
def bump(field_)
name_ = _interpret_field(field_)
return self unless name_ && @_values.include?(name_)
values_ = []
@_field_path.each do |fld_|
oldval_ = @_values[fld_.name]
if fld_.name == name_
newval_ = fld_.bump_value(oldval_)
return self if newval_ == oldval_
values_ << newval_
return Value.new(values_, @_format, @_unparse_params)
else
values_ << oldval_
end
end
self
end
# Returns a new version number created by resetting the given field. The
# field may be specified as a field object, field name, or field index.
# Returns self unchanged if the field was not recognized or could not
# be modified.
def reset(field_)
name_ = _interpret_field(field_)
return self unless name_ && @_values.include?(name_)
values_ = []
@_field_path.each do |fld_|
oldval_ = @_values[fld_.name]
if fld_.name == name_
values_ << fld_.default_value
return Value.new(values_, @_format, @_unparse_params)
else
values_ << oldval_
end
end
self
end
# Returns a new version number created by cloning this version number
# and changing the given field values.
#
# You should pass in a hash of field names to values. These are the
# fields to modify; any other fields will be left alone, unless they
# are implicitly changed by the modifications you are making.
# For example, changing the :release_type on a value using the standard
# format, may change which fields are present in the resulting value.
#
# You may also pass a delta hash to modify the unparse params stored in
# the value.
def change(values_={}, unparse_params_={})
unparse_params_ = @_unparse_params.merge(unparse_params_) if @_unparse_params
values_ = _canonicalize_values_hash(values_)
Value.new(@_values.merge(values_), @_format, unparse_params_)
end
# Attempts to convert this value to the given format, and returns the
# resulting value.
#
# Raises Versionomy::Errors::ConversionError if the value could not
# be converted.
def convert(format_, convert_params_=nil)
if format_.kind_of?(::String) || format_.kind_of?(::Symbol)
format_ = Format.get(format_)
end
return self if @_format == format_
from_schema_ = @_format.schema
to_schema_ = format_.schema
if from_schema_ == to_schema_
return Value.new(@_values, format_, convert_params_)
end
conversion_ = Conversion.get(from_schema_, to_schema_)
if conversion_
conversion_.convert_value(self, format_, convert_params_)
else
standard_format_ = Format.get(:standard)
conversion1_ = Conversion.get(from_schema_, standard_format_)
conversion2_ = Conversion.get(standard_format_, to_schema_)
if conversion1_ && conversion2_
value_ = conversion1_.convert_value(self, standard_format_, convert_params_)
conversion2_.convert_value(value_, format_, convert_params_)
else
raise Errors::UnknownConversionError
end
end
end
def hash # :nodoc:
@_hash ||= @_values.hash
end
# Returns true if this version number is equivalent to the given number.
# This type of equality means their schemas are compatible and their
# field values are equal.
# Note that this is different from the definition of <tt>==</tt>.
def eql?(obj_)
if obj_.kind_of?(::String)
obj_ = @_format.parse(obj_) rescue nil
end
return false unless obj_.kind_of?(Value)
index_ = 0
obj_.each_field_object do |field_, value_|
return false if field_ != @_field_path[index_] || value_ != @_values[field_.name]
index_ += 1
end
true
end
# Returns true if this version number is value-equal to the given number.
# This type of equality means that they are equivalent, or that it is
# possible to convert the RHS to the LHS's format, and that they would
# be equivalent after such a conversion has taken place.
# Note that this is different from the definition of <tt>eql?</tt>.
def ==(obj_)
(self <=> obj_) == 0
end
# Compare this version number with the given version number,
# returning 0 if the two are value-equal, a negative number if the RHS
# is greater, or a positive number if the LHS is greater.
# The comparison may succeed even if the two have different schemas,
# if the RHS can be converted to the LHS's format.
def <=>(obj_)
if obj_.kind_of?(::String)
obj_ = @_format.parse(obj_)
end
return nil unless obj_.kind_of?(Value)
if obj_.schema != @_format.schema
begin
obj_ = obj_.convert(@_format)
rescue
return nil
end
end
obj_.each_field_object do |field_, value_|
val_ = field_.compare_values(@_values[field_.name], value_)
return val_ if val_ != 0
end
0
end
# Compare this version number with the given version number.
# The comparison may succeed even if the two have different schemas,
# if the RHS can be converted to the LHS's format.
def <(obj_)
val_ = (self <=> obj_)
unless val_
raise Errors::SchemaMismatchError
end
val_ < 0
end
# Compare this version number with the given version number.
# The comparison may succeed even if the two have different schemas,
# if the RHS can be converted to the LHS's format.
def >(obj_)
val_ = (self <=> obj_)
unless val_
raise Errors::SchemaMismatchError
end
val_ > 0
end
include ::Comparable
# Field values may be retrieved by calling them as methods.
def method_missing(symbol_)
self[symbol_] || super
end
# :stopdoc:
# Marshal support
# Marshal this version number
def marshal_dump
format_name_ = Format.canonical_name_for(@_format, true)
unparsed_data_ = nil
if @_format.respond_to?(:unparse_for_serialization)
unparsed_data_ = @_format.unparse_for_serialization(self) rescue nil
end
unparsed_data_ ||= @_format.unparse(self) rescue nil
data_ = [format_name_]
case unparsed_data_
when ::Array
data_ << unparsed_data_[0]
data_ << unparsed_data_[1] if unparsed_data_[1]
when ::String
data_ << unparsed_data_
else
data_ << values_array
data_ << @_unparse_params if @_unparse_params
end
data_
end
# Unmarshal this version number.
def marshal_load(data_)
format_ = Format.get(data_[0], true)
if data_[1].kind_of?(::String)
val_ = format_.parse(data_[1], data_[2])
initialize(val_.values_array, format_, val_.unparse_params)
else
initialize(data_[1], format_, data_[2])
end
end
if defined?(::Psych) && respond_to?(:yaml_tag)
# YAML support through psych
# YAML tags. The last one is the canonical one.
yaml_tag "tag:danielazuma.com,2009:version"
yaml_tag "tag:verse15.com,2009:version"
# Deserialize a version number from YAML
def init_with(coder_) # :nodoc:
format_ = Format.get(coder_['format'], true)
value_ = coder_['value']
if value_
value_ = format_.parse(value_, coder_['parse_params'])
initialize(value_.values_array, format_, value_.unparse_params)
else
initialize(coder_['fields'], format_, coder_['unparse_params'])
end
end
# Serialize this version number to YAML format.
def encode_with(coder_) # :nodoc:
data_ = marshal_dump
coder_['format'] = data_[0]
if data_[1].kind_of?(::String)
coder_['value'] = data_[1]
coder_['parse_params'] = data_[2] if data_[2]
else
coder_['fields'] = data_[1]
coder_['unparse_params'] = data_[2] if data_[2]
end
end
elsif respond_to?(:yaml_as)
# YAML support through syck
# YAML tags. The last one is the canonical one.
yaml_as "tag:danielazuma.com,2009:version"
yaml_as "tag:verse15.com,2009:version"
# Deserialize a version number from YAML
def self.yaml_new(klass_, tag_, data_) # :nodoc:
unless data_.kind_of?(::Hash)
raise ::YAML::TypeError, "Invalid version format: #{data_.inspect}"
end
format_ = Format.get(data_['format'], true)
value_ = data_['value']
if value_
format_.parse(value_, data_['parse_params'])
else
Value.new(data_['fields'], format_, data_['unparse_params'])
end
end
# Serialize this version number to YAML format.
def to_yaml(opts_={})
data_ = marshal_dump
::YAML.quick_emit(nil, opts_) do |out_|
out_.map(taguri, to_yaml_style) do |map_|
map_.add('format', data_[0])
if data_[1].kind_of?(::String)
map_.add('value', data_[1])
map_.add('parse_params', data_[2]) if data_[2]
else
map_.add('fields', data_[1])
map_.add('unparse_params', data_[2]) if data_[2]
end
end
end
end
end
# :startdoc:
private
def _interpret_field(field_) # :nodoc:
case field_
when Schema::Field
@_format.schema.canonical_name(field_.name)
when ::Integer
field_ = @_field_path[field_]
field_ ? field_.name : nil
when ::String, ::Symbol
@_format.schema.canonical_name(field_)
end
end
def _canonicalize_values_hash(values_) # :nodoc:
schema_ = @_format.schema
new_values_ = {}
values_.each do |k_,v_|
k_ = schema_.canonical_name(k_)
new_values_[k_] = v_ if k_
end
new_values_
end
end
end
|