versionomy 0.4.1 → 0.4.2

data/lib/versionomy/format_definitions/rubygems.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy standard format implementation
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,55 +35,55 @@
 
 
 module Versionomy
-  
+
   module Format
-    
-    
+
+
     # Get the rubygems format.
     # This is identical to calling <tt>get('rubygems')</tt>.
-    # 
+    #
     # The rubygems format is designed to be parse-compatible with the
     # Gem::Version class used in rubygems. The only caveat is, whereas
     # Gem::Version handles an arbitrary number of fields, this format is
     # limited to a maximum of 8.
-    # 
+    #
     # For the exact annotated definition of the rubygems schema and format,
     # see the source code for Versionomy::Format::Rubygems#create.
-    
+
     def self.rubygems
       get('rubygems')
     end
-    
-    
+
+
     # This is a namespace for the implementation of the Rubygems schema
     # and format.
-    
+
     module Rubygems
-      
-      
+
+
       # Extra methods added to version values that use the rubygems schema.
-      
+
       module ExtraMethods
-        
-        
+
+
         # Returns true if the version is a prerelease version-- that is,
         # if any of the fields is non-numeric.
-        # 
+        #
         # This behaves the same as the Gem::Version#prerelease? method
         # in rubygems.
-        
+
         def prerelease?
           values_array.any?{ |val_| val_.kind_of?(::String) }
         end
-        
-        
+
+
         # Returns the release for this version.
         # For example, converts "1.2.0.a.1" to "1.2.0".
         # Non-prerelease versions return themselves.
-        # 
+        #
         # This behaves the same as the Gem::Version#release method
         # in rubygems.
-        
+
         def release
           values_ = []
           self.each_field_object do |field_, val_|
@@ -92,14 +92,14 @@ module Versionomy
           end
           Value.new(values_, self.format, self.unparse_params)
         end
-        
-        
+
+
         # Returns a list of the field values, in field order, with
         # trailing zeroes stripped off.
-        # 
+        #
         # This behaves the same as the Gem::Version#parts method
         # in rubygems.
-        
+
         def parts
           unless @parts
             @parts = values_array
@@ -107,23 +107,23 @@ module Versionomy
           end
           @parts
         end
-        
-        
+
+
       end
-      
-      
+
+
       # Create the rubygems format.
       # This method is called internally when Versionomy loads the rubygems
       # format, and you should not need to call it again. It is documented
       # so that you can inspect its source code from RDoc, since the source
       # contains useful examples of how to use the schema and format
       # definition DSLs.
-      
+
       def self.create
-        
+
         # The following is the definition of the rubygems schema
         schema_ = Schema.create do
-          
+
           # Global comparison function
           to_compare_type(:string) do |a_, b_|
             if a_.kind_of?(::Integer)
@@ -140,7 +140,7 @@ module Versionomy
               end
             end
           end
-          
+
           # Global canonicalization function
           to_canonicalize_type(:string) do |val_|
             if val_.kind_of?(::Integer)
@@ -154,7 +154,7 @@ module Versionomy
               end
             end
           end
-          
+
           # The first field has the default value of 1. All other fields
           # have a default value of 0. Thus, the default version number
           # overall is "1.0".
@@ -173,25 +173,25 @@ module Versionomy
               end
             end
           end
-          
+
           # Some field aliases providing alternate names for major fields
           alias_field(:major, :field0)
           alias_field(:minor, :field1)
-          
+
           # Add the methods in this module to each value
           add_module(Format::Rubygems::ExtraMethods)
         end
-        
+
         # The following is the definition of the rubygems format. It
         # understands the rubygems schema defined above.
         format_ = Format::Delimiter.new(schema_) do
-          
+
           # All version number strings must start with the major version.
           # Unlike other fields, it is not preceded by any delimiter.
           field(:field0) do
             recognize_number(:delimiter_regexp => '', :default_delimiter => '')
           end
-          
+
           # The remainder of the version number are represented as strings
           # or integers delimited by periods by default. Each is also
           # dependent on the presence of the previous field, so
@@ -219,50 +219,50 @@ module Versionomy
           field(:field7) do
             recognize_regexp('[0-9a-zA-Z]+', :default_value_optional => true)
           end
-          
+
           # By default, we require that at least the first two fields
           # appear in an unparsed version string.
           default_unparse_params(:required_fields => [:field1])
         end
       end
-      
-      
+
+
     end
-    
-    
+
+
     register('rubygems', Format::Rubygems.create, true)
-    
-    
+
+
   end
-  
-  
+
+
   module Conversion
-    
-    
+
+
     # This is a namespace for the implementation of the conversion between
     # the rubygems and standard formats.
-    
+
     module Rubygems
-      
-      
+
+
       # Create the conversion from standard to rubygems format.
       # This method is called internally when Versionomy loads the rubygems
       # format, and you should not need to call it again. It is documented
       # so that you can inspect its source code from RDoc, since the source
       # contains useful examples of how to use the conversion DSLs.
-      
+
       def self.create_standard_to_rubygems
-        
+
         # We'll use a parsing conversion.
         Conversion::Parsing.new do
-          
+
           # We're going to modify how the standard format version is
           # unparsed, so the rubygems format will have a better chance
           # of parsing it.
           to_modify_unparse_params do |params_, convert_params_|
-            
+
             params_ ||= {}
-            
+
             # If the standard format version has a prerelease notation,
             # make sure it is set off using a delimiter that the rubygems
             # format can recognize. So instead of "1.0b2", we force the
@@ -273,49 +273,49 @@ module Versionomy
             params_[:beta_version_delim] = '.'
             params_[:release_candidate_version_delim] = '.'
             params_[:preview_version_delim] = '.'
-            
+
             # If the standard format version has a patchlevel notation,
             # force it to use the default number rather than letter style.
             # So instead of "1.2c", we force the unparsing to generate
             # "1.2-3".
             params_[:patchlevel_style] = nil
-            
+
             # If the standard format version has a patchlevel notation,
             # force it to use the default delimiter of "-" so the rubygems
             # format will recognize it. So instead of "1.9.1p243", we force
             # the unparsing to generate "1.9.1-243".
             params_[:patchlevel_delim] = nil
-            
+
             # If the standard format version includes a "v" prefix, strip
             # it because rubygems doesn't like it.
             params_[:major_delim] = nil
-            
+
             params_
           end
-          
+
           # Standard formats sometimes allow hyphens and spaces in field
           # delimiters, but the rubygems format requires periods. So modify
           # the unparsed string to conform to rubygems's expectations.
           to_modify_string do |str_, convert_params_|
             str_.gsub(/[\.\s-]+/, '.')
           end
-          
+
         end
-        
+
       end
-      
-      
+
+
       # Create the conversion from rubygems to standard format.
       # This method is called internally when Versionomy loads the rubygems
       # format, and you should not need to call it again. It is documented
       # so that you can inspect its source code from RDoc, since the source
       # contains useful examples of how to use the conversion DSLs.
-      
+
       def self.create_rubygems_to_standard
-        
+
         # We'll use a parsing conversion.
         Conversion::Parsing.new do
-          
+
           # Handle the case where the rubygems version ends with a string
           # field, e.g. "1.0.b". We want to treat this like "1.0b0" rather
           # than "1.0-2" since the rubygems semantic states that this is a
@@ -324,20 +324,20 @@ module Versionomy
           to_modify_string do |str_, convert_params_|
             str_.gsub(/([[:alpha:]])\z/, '\10')
           end
-          
+
         end
-        
+
       end
-      
-      
+
+
     end
-    
-    
+
+
     register(:standard, :rubygems, Conversion::Rubygems.create_standard_to_rubygems, true)
     register(:rubygems, :standard, Conversion::Rubygems.create_rubygems_to_standard, true)
-    
-    
+
+
   end
-  
-  
+
+
 end

data/lib/versionomy/format_definitions/semver.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy semver format implementation
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2010 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,78 +35,78 @@
 
 
 module Versionomy
-  
+
   module Format
-    
-    
+
+
     # Get the semver format.
     # This is identical to calling <tt>get('semver')</tt>.
-    # 
+    #
     # The semver format is designed to conform to the Semantic Versioning
     # spec by Tom Preston-Warner. See http://semver.org/
-    # 
+    #
     # For the exact annotated definition of the semver schema and format,
     # see the source code for Versionomy::Format::Semver#create.
-    
+
     def self.semver
       get('semver')
     end
-    
-    
+
+
     # This is a namespace for the implementation of the semver schema
     # and format.
-    
+
     module Semver
-      
-      
+
+
       # Extra methods added to version values that use the semver schema.
-      
+
       module ExtraMethods
-        
-        
+
+
         # Returns true if the version is a prerelease version-- that is,
         # if the prerelease_suffix is nonempty.
-        
+
         def prerelease?
           prerelease_suffix.length > 0
         end
-        
-        
+
+
         # Returns the release for this version.
         # For example, converts "1.2.0a1" to "1.2.0".
         # Non-prerelease versions return themselves unchanged.
-        
+
         def release
           prerelease? ? self.change(:prerelease_suffix => '') : self
         end
-        
-        
+
+
         # Returns true if this version is compatible with the given version,
         # according to the Semantic Versioning specification.
         # For example, 1.1.0 is compatible with 1.0.0 but not vice versa,
         # 1.1.1 and 1.1.0 are compatible with each other, while 1.0.0 and
         # 2.0.0 are mutually incompatible.
-        
+
         def compatible_with?(version_)
           self.major == version_.major ? self.minor >= version_.minor : false
         end
-        
-        
+
+
       end
-      
-      
+
+
       # Create the semver format.
       # This method is called internally when Versionomy loads the semver
       # format, and you should not need to call it again. It is documented
       # so that you can inspect its source code from RDoc, since the source
       # contains useful examples of how to use the schema and format
       # definition DSLs.
-      
+
       def self.create
-        
+
         # The following is the definition of the semver schema
         schema_ = Schema.create do
-          
+
           # The first field has the default value of 1. All other fields
           # have a default value of 0. Thus, the default version number
           # overall is "1.0".
@@ -121,25 +121,25 @@ module Versionomy
               end
             end
           end
-          
+
           # An alias
           alias_field(:special_suffix, :prerelease_suffix)
-          
+
           # Add the methods in this module to each value
           add_module(Format::Semver::ExtraMethods)
         end
-        
+
         # The following is the definition of the standard format. It
         # understands the standard schema defined above.
         format_ = Format::Delimiter.new(schema_) do
-          
+
           # All version number strings must start with the major version.
           # Unlike other fields, it is not preceded by the usual "dot"
           # delimiter, but it can be preceded by a "v" indicator.
           field(:major) do
             recognize_number(:delimiter_regexp => 'v?', :default_delimiter => '')
           end
-          
+
           # The remainder of the core version number are represented as
           # integers delimited by periods. These fields are required.
           field(:minor) do
@@ -148,7 +148,7 @@ module Versionomy
           field(:patch) do
             recognize_number
           end
-          
+
           # The optional prerelease field is represented as a string
           # beginning with an alphabetic character.
           field(:prerelease_suffix) do
@@ -157,37 +157,37 @@ module Versionomy
           end
         end
       end
-      
-      
+
+
     end
-    
-    
+
+
     register('semver', Format::Semver.create, true)
-    
-    
+
+
   end
-  
-  
+
+
   module Conversion
-    
-    
+
+
     # This is a namespace for the implementation of the conversion between
     # the semver and standard formats.
-    
+
     module Semver
-      
-      
+
+
       # Create the conversion from standard to semver format.
       # This method is called internally when Versionomy loads the semver
       # format, and you should not need to call it again. It is documented
       # so that you can inspect its source code from RDoc, since the source
       # contains useful examples of how to use the conversion DSLs.
-      
+
       def self.create_standard_to_semver
-        
+
         # We'll use a parsing conversion.
         Conversion::Parsing.new do
-          
+
           # Sanity check the original value and make sure it doesn't
           # include fields that we don't support.
           to_modify_original_value do |value_, convert_params_|
@@ -199,16 +199,16 @@ module Versionomy
             end
             value_
           end
-          
+
           # We're going to modify how the standard format version is
           # unparsed, so the semver format will have a better chance
           # of parsing it.
           to_modify_unparse_params do |params_, convert_params_|
-            
+
             # All three fields are required
             params_[:minor_required] = true
             params_[:tiny_required] = true
-            
+
             # If the standard format version has a prerelease notation,
             # make sure it isn't set off using a delimiter.
             params_[:release_type_delim] = ''
@@ -222,29 +222,29 @@ module Versionomy
             params_[:release_candidate_minor_delim] = '-'
             params_[:preview_version_delim] = ''
             params_[:preview_minor_delim] = '-'
-            
+
             # If the standard format version includes a "v" prefix, strip it
             params_[:major_delim] = nil
-            
+
             params_
           end
-          
+
         end
-        
+
       end
-      
-      
+
+
       # Create the conversion from semver to standard format.
       # This method is called internally when Versionomy loads the semver
       # format, and you should not need to call it again. It is documented
       # so that you can inspect its source code from RDoc, since the source
       # contains useful examples of how to use the conversion DSLs.
-      
+
       def self.create_semver_to_standard
-        
+
         # We'll use a parsing conversion.
         Conversion::Parsing.new do
-          
+
           # Handle the case where the semver version ends with a string
           # field, e.g. "1.0b". We want to treat this like "1.0b0" rather
           # than "1.0-2" since the semver semantic states that this is a
@@ -253,20 +253,20 @@ module Versionomy
           to_modify_string do |str_, convert_params_|
             str_.gsub(/([[:alpha:]])\z/, '\10')
           end
-          
+
         end
-        
+
       end
-      
-      
+
+
     end
-    
-    
+
+
     register(:standard, :semver, Conversion::Semver.create_standard_to_semver, true)
     register(:semver, :standard, Conversion::Semver.create_semver_to_standard, true)
-    
-    
+
+
   end
-  
-  
+
+
 end