versionomy 0.0.1

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.0.1 / 2008-10-20
+
+* Initial test release

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/versionomy.rb
+lib/versionomy/errors.rb
+lib/versionomy/schema.rb
+lib/versionomy/format.rb
+lib/versionomy/value.rb
+lib/versionomy/standard.rb
+lib/versionomy/version.rb
+tests/tc_standard_basic.rb
+tests/tc_standard_bump.rb
+tests/tc_standard_change.rb
+tests/tc_standard_comparison.rb
+tests/tc_standard_parse.rb

data/README.txt

@@ -0,0 +1,134 @@
+== Versionomy
+
+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.
+
+=== Some examples
+
+ v1 = Versionomy.parse('1.3.2')
+ v1.major                       # => 1
+ v1.minor                       # => 3
+ v1.tiny                        # => 2
+ 
+ v2 = Versionomy.parse('1.4a3')
+ v2.major                       # => 1
+ v2.minor                       # => 4
+ v2.tiny                        # => 0
+ v2.release_type                # => :alpha
+ v2.alpha_version               # => 3
+ v2 > v1                        # => true
+ 
+ v3 = Versionomy.parse('1.4.0b2')
+ v3.major                       # => 1
+ v3.minor                       # => 4
+ v3.tiny                        # => 0
+ v3.release_type                # => :beta
+ v3.alpha_version               # raises NameError
+ v3.beta_version                # => 2
+ v3 > v2                        # => true
+ v3.to_s                        # => '1.4.0b2'
+ 
+ v4 = v3.bump(:beta_version)
+ v4.to_s                        # => '1.4.0b3'
+ 
+ v5 = v3.bump(:release_type)
+ v5.to_s                        # => '1.4.0rc1'
+ 
+ v6 = v3.bump(:tiny)
+ v6.to_s                        # => '1.4.1'
+ 
+ v7 = v3.bump(:major)
+ v7.to_s                        # => '2.0.0'
+ v7.parse_params[:required_fields] = 2
+ v7.to_s                        # => '2.0'
+ 
+ v8 = Versionomy.parse('2.0.0.0')
+ v8.to_s                        # => '2.0.0.0'
+ v8 == v7                       # => true
+ 
+ v9 = v7.bump(:patchlevel)
+ v9.to_s                        # => '2.0-1'
+ 
+ v10 = Versionomy.parse('2008 SP2', :patchlevel_separator => ' SP')
+ v10.major                      # => 2008
+ v10.minor                      # => 0
+ v10.patchlevel                 # => 2
+ v10.to_s                       # => '2008 SP2'
+ v10.unparse(:patchlevel_separator => 'p', :required_fields => 2)   # => '2008.0p2'
+
+=== Feature list
+
+Versionomy's default versioning scheme handles four primary fields (labeled
++major+, +minor+, +tiny+, and +tiny2+). It also supports prerelease versions
+such as "pre", development, alpha, beta, and release candidate. Finally, it
+supports patchlevel numbers for released versions.
+
+Versionomy can compare any two version numbers, and "bump" versions at any
+level. It supports parsing and unparsing in most commonly-used formats, and
+allows you to extend the parsing to include custom formats.
+
+Finally, Versionomy also lets you to specify any arbitrary versioning
+"schema". You can define any number of version number fields, and provide
+your own semantics and behavior for comparing, parsing, and modifying
+version numbers.
+
+=== Requirements
+
+* Ruby 1.8.7 or later.
+* Rubygems
+* mixology gem.
+* blockenspiel gem.
+
+=== Installation
+
+ sudo gem install versionomy
+
+=== Known issues and limitations
+
+* Not yet compatible with Ruby 1.9 due to issues with the mixology gem.
+* JRuby status not yet known.
+
+=== Development and support
+
+Documentation is available at http://virtuoso.rubyforge.org/versionomy
+
+Source code is hosted by Github at http://github.com/dazuma/versionomy/tree
+
+Report bugs on RubyForge at http://rubyforge.org/projects/virtuoso
+
+Contact the author at dazuma at gmail dot com.
+
+=== Author / Credits
+
+Versionomy is written by Daniel Azuma (http://www.daniel-azuma.com).
+
+== LICENSE:
+
+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.

data/Rakefile

@@ -0,0 +1,49 @@
+# -----------------------------------------------------------------------------
+# 
+# Versionomy Rakefile
+# 
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+
+require 'rubygems'
+require 'hoe'
+require File.expand_path("#{File.dirname(__FILE__)}/lib/versionomy.rb")
+
+Hoe.new('versionomy', Versionomy::VERSION_STRING) do |p_|
+  p_.rubyforge_name = 'virtuoso'
+  p_.developer('Daniel Azuma', 'dazuma@gmail.com')
+  p_.author = ['Daniel Azuma']
+  p_.email = ['dazuma@gmail.com']
+  p_.test_globs = ['tests/tc_*.rb']
+  p_.extra_deps = [['blockenspiel', '>= 0.0.1']]
+  p_.description_sections = ['versionomy']
+  p_.url = 'http://virtuoso.rubyforge.org/versionomy'
+end

data/lib/versionomy/errors.rb

@@ -0,0 +1,107 @@
+# -----------------------------------------------------------------------------
+# 
+# Versionomy exceptions
+# 
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+;
+
+
+module Versionomy
+  
+  
+  # This is a namespace for errors that can be thrown by Versionomy.
+  
+  module Errors
+    
+    
+    # Base class for all Versionomy exceptions
+    
+    class VersionomyError < RuntimeError
+    end
+    
+    
+    # This exception is raised if parsing or unparsing failed.
+    
+    class ParseError < VersionomyError
+    end
+    
+    
+    # This exception is raised if you try to set a value that is not
+    # allowed by the schema.
+    
+    class IllegalValueError < VersionomyError
+    end
+    
+    
+    # This exception is raised during parsing if the specified format
+    # name is not recognized.
+    
+    class UnknownFormatError < VersionomyError
+    end
+    
+    
+    # Base class for all Versionomy schema creation exceptions
+    
+    class SchemaCreationError < VersionomyError
+    end
+    
+    
+    # This exception is raised during schema creation if you try to add
+    # the same symbol twice to the same symbolic field.
+    
+    class SymbolRedefinedError < SchemaCreationError
+    end
+    
+    
+    # This exception is raised during schema creation if you try to
+    # create two subschemas covering overlapping ranges.
+    
+    class RangeOverlapError < SchemaCreationError
+    end
+    
+    
+    # This exception is raised during schema creation if the range
+    # specification cannot be interpreted.
+    
+    class RangeSpecificationError < SchemaCreationError
+    end
+    
+    
+    # This exception is raised during schema creation if you try to
+    # add a symbol to a non-symbolic schema.
+    
+    class TypeMismatchError < SchemaCreationError
+    end
+    
+    
+  end
+  
+end

data/lib/versionomy/format.rb

@@ -0,0 +1,132 @@
+# -----------------------------------------------------------------------------
+# 
+# Versionomy format
+# 
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+;
+
+
+module Versionomy
+  
+  
+  # This module is a namespace for tools that may be used to build formatters.
+  
+  module Format
+    
+    
+    # A simple base formatter
+    
+    class Base
+      
+      # Create the formatter.
+      # 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_)
+        @parser = @unparser = nil
+        Blockenspiel.invoke(block_, Versionomy::Format::Builder.new(self))
+      end
+      
+      
+      def _set_parser(block_)  # :nodoc:
+        @parser = block_
+      end
+      
+      def _set_unparser(block_)  # :nodoc:
+        @unparser = block_
+      end
+      
+      
+      # A simple parse algorithm.
+      # If a parser block was provided during initialization, calls that block.
+      # Otherwise, attempts to parse using "." as a delimiter.
+      
+      def parse(schema_, string_, params_)
+        if @parser
+          @parser.call(schema_, string_, params_)
+        else
+          array_ = string_.split('.')
+          Versionomy::Value.new(schema_, array_)
+        end
+      end
+      
+      
+      # A simple parse algorithm.
+      # If an unparser block was provided during initialization, calls that block.
+      # Otherwise, attempts to unparse using "." as a delimiter.
+      
+      def unparse(schema_, value_, params_)
+        if @unparser
+          @unparser.call(schema_, value_, params_)
+        else
+          value_.value_array.join('.')
+        end
+      end
+      
+    end
+    
+    
+    # These methods are available in an initializer block for Versionomy::Format::Base.
+    
+    class Builder < Blockenspiel::Base
+      
+      def initialize(format_)  # :nodoc:
+        @format = format_
+      end
+      
+      
+      # Specify how to parse a string into a version value.
+      # 
+      # The block should take three parameters: a schema, a string, and a parameters hash.
+      # The block should return an object of type Versionomy::Value.
+      # You may raise Versionomy::Errors::ParseError if parsing failed.
+      
+      def to_parse(&block_)
+        @format._set_parser(block_)
+      end
+      
+      
+      # Specify how to represent a version value as a string.
+      # 
+      # The block should take three parameters: a schema, a Versionomy::Value, and a parameters hash.
+      # The block should return a string.
+      # You may raise Versionomy::Errors::ParseError if unparsing failed.
+      
+      def to_unparse(&block_)
+        @format._set_unparser(block_)
+      end
+      
+    end
+    
+    
+  end
+  
+end