versionomy 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.0.4 / 2008-10-24
+
+* Fixed incompatibility with Blockenspiel 0.0.4
+* Fixed a number of issues with remembering value parse settings
+* Parser recognizes additional release type formats
+* Values have a parse method to parse another string in the same form
+* Implemented comparison between value and string
+* Exceptions correctly raised on comparison between incompatible types
+
 === 0.0.3 / 2008-10-21
 
 * Fixed string representations (inspect method)
@@ -5,7 +14,7 @@
 
 === 0.0.2 / 2008-10-20
 
-* Test release: Fixed manifest
+* Fixed manifest
 
 === 0.0.1 / 2008-10-20
 

data/README.txt

@@ -55,7 +55,6 @@ numbers in the wide variety of versioning schemes in use.
  v10.minor                      # => 0
  v10.patchlevel                 # => 2
  v10.to_s                       # => '2008 SP2'
- v10.unparse(:patchlevel_separator => 'p', :required_fields => 2)   # => '2008.0p2'
 
 === Feature list
 

data/Rakefile

@@ -43,7 +43,7 @@ Hoe.new('versionomy', Versionomy::VERSION_STRING) do |p_|
   p_.author = ['Daniel Azuma']
   p_.email = ['dazuma@gmail.com']
   p_.test_globs = ['tests/tc_*.rb']
-  p_.extra_deps = [['blockenspiel', '>= 0.0.1']]
+  p_.extra_deps = [['blockenspiel', '>= 0.0.4']]
   p_.description_sections = ['versionomy']
   p_.url = 'http://virtuoso.rubyforge.org/versionomy'
 end

data/lib/versionomy/errors.rb

@@ -61,6 +61,13 @@ module Versionomy
     end
     
     
+    # This exception is raised if you try to perform a comparison
+    # between incompatible schemas.
+    
+    class SchemaMismatchError < VersionomyError
+    end
+    
+    
     # This exception is raised during parsing if the specified format
     # name is not recognized.
     

data/lib/versionomy/format.rb

@@ -42,7 +42,10 @@ module Versionomy
   module Format
     
     
-    # A simple base formatter
+    # A simple base formatter.
+    # 
+    # Formats need not extend this base class, as long as they duck-type the
+    # required methods name, parse, and unparse.
     
     class Base
       
@@ -50,7 +53,8 @@ module Versionomy
       # If a block is provided, you may call methods of Versionomy::Format::Builder
       # within the block, to specify ways to parse and unparse.
       
-      def initialize(&block_)
+      def initialize(name_, &block_)
+        @name = name_.to_sym
         @parser = @unparser = nil
         Blockenspiel.invoke(block_, Versionomy::Format::Builder.new(self))
       end
@@ -64,6 +68,17 @@ module Versionomy
         @unparser = block_
       end
       
+      def _set_name(name_)  # :nodoc:
+        @name = name_
+      end
+      
+      
+      # The format name
+      
+      def name
+        @name
+      end
+      
       
       # A simple parse algorithm.
       # If a parser block was provided during initialization, calls that block.
@@ -87,7 +102,7 @@ module Versionomy
         if @unparser
           @unparser.call(schema_, value_, params_)
         else
-          value_.value_array.join('.')
+          value_.values.join('.')
         end
       end
       
@@ -124,6 +139,13 @@ module Versionomy
         @format._set_unparser(block_)
       end
       
+      
+      # Specify the format name
+      
+      def set_name(name_)
+        @format._set_name(name_)
+      end
+      
     end
     
     

data/lib/versionomy/schema.rb

@@ -103,7 +103,7 @@ module Versionomy
       @default_subschema = nil
       @formats = Hash.new
       @default_format_name = nil
-      Blockenspiel.invoke(block_, Versionomy::Schema::Builder.new(self))
+      Blockenspiel.invoke(block_, Versionomy::Schema::Builder.new(self)) if block_
       @initial_value = canonicalize_value(@initial_value)
     end
     
@@ -231,17 +231,18 @@ module Versionomy
     end
     
     
-    # Define a formatter for this schema.
-    # You may either pass a formatter or provide a block
-    # that calls methods in Versionomy::Format::Builder.
-    
-    def define_format(name_, formatter_=nil, &block_)
-      if block_
-        @formats[name_] = Versionomy::Format::Base.new(&block_)
-      else
-        @formats[name_] = formatter_
-      end
-      @default_format_name ||= name_
+    # Define a format for this schema.
+    # 
+    # You may either:
+    # 
+    # * pass a format, or
+    # * pass a name and provide a block that calls methods in
+    #   Versionomy::Format::Builder.
+    
+    def define_format(format_=nil, &block_)
+      format_ = Versionomy::Format::Base.new(format_, &block_) if block_
+      @formats[format_.name] = format_
+      @default_format_name ||= format_.name
     end
     
     
@@ -522,12 +523,16 @@ module Versionomy
       end
       
       
-      # Define a formatter for this schema.
-      # You may either pass a formatter or provide a block
-      # that calls methods in Versionomy::Format::Builder.
+      # Define a format for this schema.
+      # 
+      # You may either:
+      # 
+      # * pass a format, or
+      # * pass a name and provide a block that calls methods in
+      #   Versionomy::Format::Builder.
       
-      def define_format(name_, formatter_=nil, &block_)
-        @schema.define_format(name_, formatter_, &block_)
+      def define_format(format_=nil, &block_)
+        @schema.define_format(format_, &block_)
       end
       
       

data/lib/versionomy/standard.rb

@@ -107,12 +107,19 @@ module Versionomy
       # Create a new formatter
       
       def initialize(opts_={})
-        @patchlevel_separator = opts_[:patchlevel_separators] || ['-', 'p']
-        @prerelease_symbol = opts_[:prerelease_symbols] || 'pre'
-        @development_symbol = opts_[:development_symbols] || 'd'
-        @alpha_symbol = opts_[:alpha_symbols] || 'a'
-        @beta_symbol = opts_[:beta_symbols] || 'b'
-        @release_candidate_symbol = opts_[:release_candidate_symbols] || 'rc'
+        @name = opts_[:name] || :standard
+        @patchlevel_separator = opts_[:patchlevel_separator] || ['-', '\s?[Pp]']
+        @prerelease_symbol = opts_[:prerelease_symbol] || '\s?(PRE|Pre|pre)'
+        @development_symbol = opts_[:development_symbol] || '\s?[Dd]'
+        @alpha_symbol = opts_[:alpha_symbol] || '\s?[Aa](LPHA|lpha)?'
+        @beta_symbol = opts_[:beta_symbol] || '\s?[Bb](ETA|eta)?'
+        @release_candidate_symbol = opts_[:release_candidate_symbol] || '\s?(RC|Rc|rc)'
+        @patchlevel_separator_unparse = opts_[:patchlevel_separator_unparse] || '-'
+        @prerelease_symbol_unparse = opts_[:prerelease_symbol_unparse] || 'pre'
+        @development_symbol_unparse = opts_[:development_symbol_unparse] || 'd'
+        @alpha_symbol_unparse = opts_[:alpha_symbol_unparse] || 'a'
+        @beta_symbol_unparse = opts_[:beta_symbol_unparse] || 'b'
+        @release_candidate_symbol_unparse = opts_[:release_candidate_symbol_unparse] || 'rc'
       end
       
       
@@ -133,24 +140,18 @@ module Versionomy
       end
       private :_create_regex
       
-      def _create_separator(given_, default_)  # :nodoc:
-        if given_
-          given_.to_s
-        else
-          if default_.respond_to?(:join)
-            default_[0].to_s
-          else
-            default_.to_s
-          end
-        end
+      
+      # The format name
+      
+      def name
+        @name
       end
-      private :_create_separator
       
       
       # Parse a string for the standard schema.
       
       def parse(schema_, str_, params_)
-        params_ = Hash.new.merge(params_)
+        params_ = {:format => @name}.merge(params_)
         hash_ = Hash.new
         if str_ =~ /^(\d+)(.*)$/
           hash_[:major] = $1.to_i
@@ -181,10 +182,11 @@ module Versionomy
           params_[:required_fields] = 1
         end
         if str_ =~ /^(#{_create_regex(params_[:prerelease_symbol], @prerelease_symbol)})(\d+)(.*)$/
-          params_[:prerelease_symbol] = $1
+          matches_ = $~
+          params_[:prerelease_symbol_unparse] = matches_[1]
           hash_[:release_type] = :prerelease
-          hash_[:prerelease_version] = $2.to_i
-          str_ = $3
+          hash_[:prerelease_version] = matches_[-2].to_i
+          str_ =  matches_[-1]
           if str_ =~ /^\.(\d+)/
             hash_[:prerelease_minor] = $1.to_i
             params_[:prerelease_required_fields] = 2
@@ -192,10 +194,11 @@ module Versionomy
             params_[:prerelease_required_fields] = 1
           end
         elsif str_ =~ /^(#{_create_regex(params_[:development_symbol], @development_symbol)})(\d+)(.*)$/
-          params_[:development_symbol] = $1
+          matches_ = $~
+          params_[:development_symbol_unparse] = matches_[1]
           hash_[:release_type] = :development
-          hash_[:development_version] = $2.to_i
-          str_ = $3
+          hash_[:development_version] = matches_[-2].to_i
+          str_ = matches_[-1]
           if str_ =~ /^\.(\d+)/
             hash_[:development_minor] = $1.to_i
             params_[:development_required_fields] = 2
@@ -203,10 +206,11 @@ module Versionomy
             params_[:development_required_fields] = 1
           end
         elsif str_ =~ /^(#{_create_regex(params_[:alpha_symbol], @alpha_symbol)})(\d+)(.*)$/
-          params_[:alpha_symbol] = $1
+          matches_ = $~
+          params_[:alpha_symbol_unparse] = matches_[1]
           hash_[:release_type] = :alpha
-          hash_[:alpha_version] = $2.to_i
-          str_ = $3
+          hash_[:alpha_version] = matches_[-2].to_i
+          str_ = matches_[-1]
           if str_ =~ /^\.(\d+)/
             hash_[:alpha_minor] = $1.to_i
             params_[:alpha_required_fields] = 2
@@ -214,10 +218,11 @@ module Versionomy
             params_[:alpha_required_fields] = 1
           end
         elsif str_ =~ /^(#{_create_regex(params_[:beta_symbol], @beta_symbol)})(\d+)(.*)$/
-          params_[:beta_symbol] = $1
+          matches_ = $~
+          params_[:beta_symbol_unparse] = matches_[1]
           hash_[:release_type] = :beta
-          hash_[:beta_version] = $2.to_i
-          str_ = $3
+          hash_[:beta_version] = matches_[-2].to_i
+          str_ = matches_[-1]
           if str_ =~ /^\.(\d+)/
             hash_[:beta_minor] = $1.to_i
             params_[:beta_required_fields] = 2
@@ -225,10 +230,11 @@ module Versionomy
             params_[:beta_required_fields] = 1
           end
         elsif str_ =~ /^(#{_create_regex(params_[:release_candidate_symbol], @release_candidate_symbol)})(\d+)(.*)$/
-          params_[:release_candidate_symbol] = $1
-          hash_[:release_candidate_version] = $2.to_i
+          matches_ = $~
+          params_[:release_candidate_symbol_unparse] = matches_[1]
+          hash_[:release_candidate_version] = matches_[-2].to_i
           hash_[:release_type] = :release_candidate
-          str_ = $3
+          str_ = matches_[-1]
           if str_ =~ /^\.(\d+)/
             hash_[:release_candidate_minor] = $1.to_i
             params_[:release_candidate_required_fields] = 2
@@ -238,10 +244,11 @@ module Versionomy
         else
           hash_[:release_type] = :release
           if str_ =~ /^(#{_create_regex(params_[:patchlevel_separator], @patchlevel_separator)})(\d+)(.*)$/
-            params_[:patchlevel_separator] = $1
+            matches_ = $~
+            params_[:patchlevel_separator_unparse] = matches_[1]
             params_[:patchlevel_format] = :digit
-            hash_[:patchlevel] = $2.to_i
-            str_ = $3
+            hash_[:patchlevel] = matches_[-2].to_i
+            str_ = matches_[-1]
             if str_ =~ /^\.(\d+)/
               hash_[:patchlevel_minor] = $1.to_i
               params_[:patchlevel_required_fields] = 2
@@ -273,35 +280,35 @@ module Versionomy
         case value_.release_type
         when :prerelease
           prerelease_required_fields_ = params_[:prerelease_required_fields] || 1
-          str_ << _create_separator(params_[:prerelease_symbol], @prerelease_symbol)
+          str_ << (params_[:prerelease_symbol_unparse] || @prerelease_symbol_unparse)
           str_ << value_.prerelease_version.to_s
           if value_.prerelease_minor > 0 || prerelease_required_fields_ > 1
             str_ << ".#{value_.prerelease_minor}"
           end
         when :development
           development_required_fields_ = params_[:development_required_fields] || 1
-          str_ << _create_separator(params_[:development_symbol], @development_symbol)
+          str_ << (params_[:development_symbol_unparse] || @development_symbol_unparse)
           str_ << value_.development_version.to_s
           if value_.development_minor > 0 || development_required_fields_ > 1
             str_ << ".#{value_.development_minor}"
           end
         when :alpha
           alpha_required_fields_ = params_[:alpha_required_fields] || 1
-          str_ << _create_separator(params_[:alpha_symbol], @alpha_symbol)
+          str_ << (params_[:alpha_symbol_unparse] || @alpha_symbol_unparse)
           str_ << value_.alpha_version.to_s
           if value_.alpha_minor > 0 || alpha_required_fields_ > 1
             str_ << ".#{value_.alpha_minor}"
           end
         when :beta
           beta_required_fields_ = params_[:beta_required_fields] || 1
-          str_ << _create_separator(params_[:beta_symbol], @beta_symbol)
+          str_ << (params_[:beta_symbol_unparse] || @beta_symbol_unparse)
           str_ << value_.beta_version.to_s
           if value_.beta_minor > 0 || beta_required_fields_ > 1
             str_ << ".#{value_.beta_minor}"
           end
         when :release_candidate
           release_candidate_required_fields_ = params_[:release_candidate_required_fields] || 1
-          str_ << _create_separator(params_[:release_candidate_symbol], @release_candidate_symbol)
+          str_ << (params_[:release_candidate_symbol_unparse] || @release_candidate_symbol_unparse)
           str_ << value_.release_candidate_version.to_s
           if value_.release_candidate_minor > 0 || release_candidate_required_fields_ > 1
             str_ << ".#{value_.release_candidate_minor}"
@@ -314,7 +321,7 @@ module Versionomy
             elsif params_[:patchlevel_format] == :alpha_upper
               str_.concat(64 + value_.patchlevel)
             else
-              str_ << _create_separator(params_[:patchlevel_separator], @patchlevel_separator)
+              str_ << (params_[:patchlevel_separator_unparse] || @patchlevel_separator_unparse)
               str_ << value_.patchlevel.to_s
               if value_.patchlevel_minor > 0 || patchlevel_required_fields_ > 1
                 str_ << ".#{value_.patchlevel_minor}"
@@ -372,7 +379,7 @@ module Versionomy
               end
             end
           end
-          define_format(:default, StandardFormat.new)
+          define_format(StandardFormat.new)
         end
       end
       

data/lib/versionomy/value.rb

@@ -93,6 +93,20 @@ module Versionomy
     end
     
     
+    # Get the value of the most significant field
+    
+    def _toplevel_value  # :nodoc:
+      @value
+    end
+    
+    
+    # Get a value representing all fields except the most significant field
+    
+    def _subvalue  # :nodoc:
+      @subvalue
+    end
+    
+    
     # Returns a string representation generated by unparsing.
     # If unparsing fails, does not raise Versionomy::Errors::ParseError,
     # but instead returns the string generated by +inspect+.
@@ -119,6 +133,14 @@ module Versionomy
     end
     
     
+    # Parse another string using the same schema, and same parse parameters
+    # as this value, subject to the given modifications.
+    
+    def parse(str_, params_={})
+      @schema.parse(str_, @parse_params.merge(params_))
+    end
+    
+    
     # Return the schema defining the form of this version number
     
     def schema
@@ -134,6 +156,7 @@ module Versionomy
     
     
     # Returns an array of recognized field names for this value, in field order.
+    
     def fields
       @subvalue ? @subvalue.fields.unshift(@schema.name) : [@schema.name]
     end
@@ -169,8 +192,8 @@ module Versionomy
     
     # Returns the value as an array of field values, in field order.
     
-    def value_array
-      @subvalue ? @subvalue.value_array.unshift(@value) : [@value]
+    def values
+      @subvalue ? @subvalue.values.unshift(@value) : [@value]
     end
     
     
@@ -215,7 +238,7 @@ module Versionomy
     
     
     def hash  # :nodoc:
-      @schema.name.hash ^ @value.hash ^ @subvalue.hash
+      @hash ||= @schema.name.hash ^ @value.hash ^ @subvalue.hash
     end
     
     
@@ -224,11 +247,14 @@ module Versionomy
     # schemas may actually be different.
     
     def eql?(obj_)
+      if obj_.kind_of?(String)
+        obj_ = parse(obj_) rescue nil
+      end
       if obj_.kind_of?(Versionomy::Value)
-        if @schema.name != obj_.schema.name || @value != obj_.toplevel_value
+        if @schema.name != obj_.schema.name || @value != obj_._toplevel_value
           false
         elsif @subvalue
-          @subvalue.eql?(obj_.subvalue)
+          @subvalue.eql?(obj_._subvalue)
         else
           true
         end
@@ -252,23 +278,26 @@ module Versionomy
     # even if the schemas are different.
     
     def <=>(obj_)
-      if obj_.kind_of?(Versionomy::Value)
-        if @schema.name != obj_.schema.name
-          nil
+      if obj_.kind_of?(String)
+        obj_ = parse(obj_)
+      end
+      if !obj_.kind_of?(Versionomy::Value)
+        raise ArgumentError, "comparison of Versionomy::Value with #{obj_.class} failed"
+      end
+      if @schema.name != obj_.schema.name
+        raise SchemaMismatchError
+      end
+      val_ = @schema.compare_values(@value, obj_._toplevel_value)
+      if val_ == 0
+        if @subvalue.nil? && obj_._subvalue.nil?
+          0
+        elsif !@subvalue.nil? && !obj_._subvalue.nil?
+          @subvalue <=> obj_._subvalue
         else
-          val_ = @schema.compare_values(@value, obj_.toplevel_value)
-          if val_ == 0
-            if @subvalue.nil?
-              obj_.subvalue.nil? ? 0 : nil
-            else
-              @subvalue <=> obj_.subvalue
-            end
-          else
-            val_
-          end
+          raise SchemaMismatchError
         end
       else
-        nil
+        val_
       end
     end
     
@@ -291,20 +320,6 @@ module Versionomy
     end
     
     
-    # Get the value of the most significant field
-    
-    def toplevel_value
-      @value
-    end
-    
-    
-    # Get a value representing all fields except the most significant field
-    
-    def subvalue
-      @subvalue
-    end
-    
-    
     # Field values may be retrieved by calling them as methods.
     
     def method_missing(symbol_)

data/lib/versionomy/version.rb

@@ -36,7 +36,7 @@
 
 module Versionomy
   
-  VERSION_STRING = '0.0.3'
+  VERSION_STRING = '0.0.4'
   VERSION = parse(VERSION_STRING)
   
 end

data/tests/tc_standard_comparison.rb

@@ -101,6 +101,27 @@ module Versionomy
       end
       
       
+      # Test equality with string.
+      
+      def test_equality_string
+        value1_ = Versionomy.parse("1.8.7p72")
+        assert_operator(value1_, :==, "1.8.7p72")
+        assert_operator(value1_, :==, "1.8.7.0-72.0")
+      end
+      
+      
+      # Test comparison with string.
+      
+      def test_comparison_string
+        value1_ = Versionomy.parse("1.8.7p72")
+        assert_operator(value1_, :<, "1.8.7p73")
+        assert_operator(value1_, :<, "1.8.8pre1")
+        assert_operator(value1_, :>, "1.8.7p71")
+        assert_operator(value1_, :>, "1.8.7rc2")
+        assert_operator(value1_, :>, "1.8.7.0")
+      end
+      
+      
     end
     
   end

data/tests/tc_standard_parse.rb

@@ -139,6 +139,17 @@ module Versionomy
       end
       
       
+      # Test parsing beta alternates
+      
+      def test_parsing_beta_alternates
+        assert_equal(Versionomy.parse('2.52.1 beta4'), '2.52.1b4')
+        assert_equal(Versionomy.parse('2.52.1B4'), '2.52.1b4')
+        assert_equal(Versionomy.parse('2.52.1BETA4'), '2.52.1b4')
+        assert_equal(Versionomy.parse('2.52.1 Beta4'), '2.52.1b4')
+        assert_not_equal(Versionomy.parse('2.52.1 eta4'), '2.52.1b4')
+      end
+      
+      
       # Test parsing release candidate.
       
       def test_parsing_release_candidate
@@ -156,6 +167,16 @@ module Versionomy
       end
       
       
+      # Test parsing with custom symbols
+      
+      def test_parsing_custom_patchlevel_symbols
+        value1_ = Versionomy.parse('2008 SP2', :patchlevel_separator => '\s?(SP|sp)')
+        assert_equal(2, value1_.patchlevel)
+        value2_ = value1_.parse('2008 sp3')
+        assert_equal(3, value2_.patchlevel)
+      end
+      
+      
     end
     
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: versionomy
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Daniel Azuma
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-21 00:00:00 -07:00
+date: 2008-10-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.1
+        version: 0.0.4
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
+        version: 1.8.1
     version: 
 description: Versionomy is a generalized version number library. It provides tools to represent, manipulate, parse, and compare version numbers in the wide variety of versioning schemes in use.
 email: