versionomy 0.4.1 → 0.4.2

data/History.rdoc

@@ -1,3 +1,7 @@
+=== 0.4.2 / 2012-02-17
+
+* Support psych interface for YAML serialization.
+
 === 0.4.1 / 2011-04-26
 
 * Support underscore "_" as a delimiter.

data/Version

@@ -1 +1 @@
-0.4.1
+0.4.2

data/lib/versionomy.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy entry point
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2008-2009 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -36,22 +36,16 @@
 
 require 'blockenspiel'
 
-
-dir_ = ::File.expand_path('versionomy', ::File.dirname(__FILE__))
-
-includes_ = [
- 'errors',
- 'schema',
- 'schema/field',
- 'schema/wrapper',
- 'format',
- 'format/base',
- 'format/delimiter',
- 'value',
- 'conversion',
- 'conversion/base',
- 'conversion/parsing',
- 'interface',
- 'version',
-]
-includes_.each{ |file_| require "#{dir_}/#{file_}" }
+require 'versionomy/errors'
+require 'versionomy/schema'
+require 'versionomy/schema/field'
+require 'versionomy/schema/wrapper'
+require 'versionomy/format'
+require 'versionomy/format/base'
+require 'versionomy/format/delimiter'
+require 'versionomy/value'
+require 'versionomy/conversion'
+require 'versionomy/conversion/base'
+require 'versionomy/conversion/parsing'
+require 'versionomy/interface'
+require 'versionomy/version'

data/lib/versionomy/conversion.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy conversion interface and registry
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2008-2009 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -38,14 +38,14 @@ require 'thread'
 
 
 module Versionomy
-  
-  
+
+
   # === Conversion between version schemas.
-  # 
+  #
   # Conversions are algorithms for converting from one schema to another.
   # This is useful for performing conversions as well as comparing version
   # numbers that use different schemas.
-  # 
+  #
   # To implement a conversion algorithm, implement the API defined by
   # Versionomy::Conversion::Base. Then, register your conversion by calling
   # Versionomy::Conversion#register. You will need to specify which schemas
@@ -54,49 +54,49 @@ module Versionomy
   # it will use your conversion. You can register the same conversion object
   # for multiple pairs of schemas, but you can register only one conversion
   # object for any pair.
-  # 
+  #
   # A common technique for doing conversions is to unparse the version to a
   # string, and then parse it in the new format. Versionomy provides a tool,
   # Versionomy::Conversion::Parsing, for performing such conversions. The
   # conversions between the standard and rubygems formats uses this tool.
   # See Versionomy::Conversion::Rubygems for annotated examples.
-  
+
   module Conversion
-    
+
     @registry = {}
     @mutex = ::Mutex.new
-    
+
     class << self
-      
-      
+
+
       # Convert the given value to the given format. This is identical to
       # calling <tt>value_.convert(format_, convert_params_)</tt>.
-      # 
+      #
       # The format may be specified as a format object or as the name of a
       # format in the Format registry.
-      # 
+      #
       # Raises Versionomy::Errors::ConversionError if the value could not
       # be converted.
-      
+
       def convert(value_, format_, convert_params_=nil)
         value_.convert(format_, convert_params_)
       end
-      
-      
+
+
       # Get a conversion capable of converting between the given schemas.
-      # 
+      #
       # The schemas may be specified as format names, Format objects,
       # schema wrapper objects, or the root field of the schema.
-      # 
+      #
       # If strict is set to false, returns nil if no such conversion could
       # be found. If strict is set to true, may raise one of these errors:
-      # 
+      #
       # Raises Versionomy::Errors::UnknownFormatError if a format was
       # specified by name but the name is not known.
-      # 
+      #
       # Raises Versionomy::Errors::UnknownConversionError if the formats
       # were recognized but no conversion was found to handle them.
-      
+
       def get(from_schema_, to_schema_, strict_=false)
         key_ = _get_key(from_schema_, to_schema_)
         conversion_ = @mutex.synchronize{ @registry[key_] }
@@ -105,19 +105,19 @@ module Versionomy
         end
         conversion_
       end
-      
-      
+
+
       # Register the given conversion as the handler for the given schemas.
-      # 
+      #
       # The schemas may be specified as format names, Format objects,
       # schema wrapper objects, or the root field of the schema.
-      # 
+      #
       # Raises Versionomy::Errors::ConversionRedefinedError if a conversion
       # has already been registered for the given schemas.
-      # 
+      #
       # Raises Versionomy::Errors::UnknownFormatError if a format was
       # specified by name but the name is not known.
-      
+
       def register(from_schema_, to_schema_, conversion_, silent_=false)
         key_ = _get_key(from_schema_, to_schema_)
         @mutex.synchronize do
@@ -130,25 +130,25 @@ module Versionomy
           end
         end
       end
-      
-      
+
+
       private
-      
+
       def _get_key(from_schema_, to_schema_)  # :nodoc:
         [_get_schema(from_schema_), _get_schema(to_schema_)]
       end
-      
+
       def _get_schema(schema_)  # :nodoc:
         schema_ = Format.get(schema_, true) if schema_.kind_of?(::String) || schema_.kind_of?(::Symbol)
         schema_ = schema_.schema if schema_.respond_to?(:schema)
         schema_ = schema_.root_field if schema_.respond_to?(:root_field)
         schema_
       end
-      
-      
+
+
     end
-    
+
   end
-  
-  
+
+
 end

data/lib/versionomy/conversion/base.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy conversion base class
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2008-2009 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -35,40 +35,40 @@
 
 
 module Versionomy
-  
-  
+
+
   module Conversion
-    
-    
+
+
     # The base conversion class.
-    # 
+    #
     # This base class defines the API for a conversion. All conversions must
     # define the method <tt>convert_value</tt> documented here. Conversions
     # need not actually extend this base class, as long as they duck-type
     # this method. However, this base class does provide a few convenience
     # methods such as a sane implementation of inspect.
-    
+
     class Base
-      
-      
+
+
       # Create a conversion using a simple DSL.
       # You can pass a block to the initializer that takes the same
       # parameters as convert_value, and the conversion will use that block
       # to perform the conversion.
-      
+
       def initialize(&block_)
         @_converter = block_
       end
-      
-      
+
+
       # Convert the given value to the given format and return the converted
       # value.
-      # 
+      #
       # The convert_params may be interpreted however the particular
       # conversion wishes.
-      # 
+      #
       # Raises Versionomy::Errors::ConversionError if the conversion failed.
-      
+
       def convert_value(value_, format_, convert_params_=nil)
         if @_converter
           @_converter.call(value_, format_, convert_params_)
@@ -76,25 +76,25 @@ module Versionomy
           raise Errors::ConversionError, "Conversion not implemented"
         end
       end
-      
-      
+
+
       # Inspect this conversion.
-      
+
       def inspect
         "#<#{self.class}:0x#{object_id.to_s(16)}>"
       end
-      
-      
+
+
       # The default to_s implementation just calls inspect.
-      
+
       def to_s
         inspect
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end

data/lib/versionomy/conversion/parsing.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy conversion base class
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2008-2009 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -35,27 +35,27 @@
 
 
 module Versionomy
-  
-  
+
+
   module Conversion
-    
-    
+
+
     # A conversion strategy that relies on parsing.
     # Essentially, it unparses the value and then attempts to parse it with
     # the new format.
-    
+
     class Parsing < Base
-      
-      
+
+
       # Create a parsing conversion.
-      # 
+      #
       # By default, this just unparses and reparses using the default
       # parse settings. In some cases, this may be enough, but you may
       # wish to improve the reliability of the conversion by tweaking the
       # parsing settings. To do so, pass a block to the new method, and
       # call methods of Versionomy::Conversion::Parsing::Builder in that
       # block.
-      
+
       def initialize(&block_)
         if block_
           builder_ = Builder.new
@@ -66,16 +66,16 @@ module Versionomy
           @parse_params_generator ||= builder_._get_parse_params_generator
         end
       end
-      
-      
+
+
       # Returns a value equivalent to the given value in the given format.
-      # 
+      #
       # The convert_params are passed to this conversion's customization
       # blocks (if any).
-      # 
+      #
       # Raises Versionomy::Errors::ConversionError if the conversion failed.
       # Typically, this is due to a failure of the parsing or unparsing.
-      
+
       def convert_value(value_, format_, convert_params_=nil)
         begin
           convert_params_ ||= {}
@@ -103,47 +103,47 @@ module Versionomy
           raise Errors::ConversionError, "Parsing failed: #{ex_.inspect}"
         end
       end
-      
-      
+
+
       # Call methods of this class in the block passed to
       # Versionomy::Conversion::Parsing#new to fine-tune the behavior of
       # the converter.
-      
+
       class Builder
-        
+
         include ::Blockenspiel::DSL
-        
-        
+
+
         def initialize  # :nodoc:
           @original_value_modifier = nil
           @string_modifier = nil
           @parse_params_generator = nil
           @unparse_params_modifier = nil
         end
-        
-        
+
+
         # Provide a block that generates the params used to parse the new
         # value. The block should take one parameter, the convert_params
         # passed to convert_value (which may be nil). It should return the
         # parse params that should be used.
-        
+
         def to_generate_parse_params(&block_)
           @parse_params_generator = block_
         end
-        
-        
+
+
         # Provide a block that can modify the params used to unparse the
         # old value. The block should take two parameters: first, the
         # original unparse params from the old value (which may be nil),
         # and second, the convert_params passed to convert_value (which
         # may also be nil). It should return the unparse params that
         # should actually be used.
-        
+
         def to_modify_unparse_params(&block_)
           @unparse_params_modifier = block_
         end
-        
-        
+
+
         # Provide a block that can modify the original value prior to it
         # being unparsed. The block should take two parameters: first, the
         # original value to be converted, and second, the convert_params
@@ -152,46 +152,46 @@ module Versionomy
         # originally passed in. This method may fail-fast by raising a
         # Versionomy::Errors::ConversionError if it determines that the
         # value passed in cannot be converted as is.
-        
+
         def to_modify_original_value(&block_)
           @original_value_modifier = block_
         end
-        
-        
+
+
         # Provide a block that can modify the unparsed string prior to
         # it being passed to the parser. The block should take two
         # parameters: first, the string resulting from unparsing the old
         # value, and second, the convert_params passed to convert_value
         # (which may be nil). It should return the string to be parsed to
         # get the new value.
-        
+
         def to_modify_string(&block_)
           @string_modifier = block_
         end
-        
-        
+
+
         def _get_original_value_modifier  # :nodoc:
           @original_value_modifier
         end
-        
+
         def _get_string_modifier  # :nodoc:
           @string_modifier
         end
-        
+
         def _get_unparse_params_modifier  # :nodoc:
           @unparse_params_modifier
         end
-        
+
         def _get_parse_params_generator  # :nodoc:
           @parse_params_generator
         end
-        
+
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end