versionomy 0.0.4 → 0.1.0

data/History.rdoc

@@ -0,0 +1,31 @@
+=== 0.1.0 / 2009-10-14
+
+* Alpha release, opened for public feedback
+* General rearchitecture. Better distinction between format and schema. Schema split into schema and field objects so the API makes more sense. Values are tighter and easier to use. Formats can now be built using a DSL. A bunch of API changes and bug fixes accompanied this-- too many to list.
+* In the standard schema, renamed release type "release" to "final". Also renamed release type "prerelease" to "preview", now sorted between "release candidate" and "final".
+* Documentation is much more complete.
+* Now tested and confirmed compatible with Matz Ruby 1.9.1 and JRuby 1.4.
+* Now uses blockenspiel 0.2; thus longer requires the mixology gem.
+* Building no longer requires hoe.
+
+=== 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)
+* Fixed up equality and hash computation for version values
+
+=== 0.0.2 / 2008-10-20
+
+* Fixed manifest
+
+=== 0.0.1 / 2008-10-20
+
+* Initial test release

data/README.rdoc

@@ -0,0 +1,144 @@
+== 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
+
+ require 'versionomy'
+ 
+ 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 NoMethodError
+ 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 = v4.bump(:release_type)
+ v5.to_s                                  # => '1.4.0rc1'
+ 
+ v6 = v5.bump(:release_type)
+ v6.to_s                                  # => '1.4.0'
+ 
+ v7 = v3.bump(:tiny)
+ v7.to_s                                  # => '1.4.1'
+ 
+ v8 = v3.bump(:major)
+ v8.to_s                                  # => '2.0.0'
+ v8.unparse(:optional_fields => [:tiny])  # => '2.0'
+ 
+ v9 = Versionomy.parse('2.0.0.0')
+ v9.to_s                                  # => '2.0.0.0'
+ v9 == v8                                 # => true
+ 
+ v10 = v8.bump(:patchlevel)
+ v10.to_s                                 # => '2.0.0-1'
+ 
+ microsoft_format = Versionomy.default_format.modified_copy do
+   field(:minor) do
+     recognize_number(:default_value_optional => true,
+                      :delimiter_regexp => '\s?sp',
+                      :default_delimiter => ' SP')
+   end
+ end
+ v11 = microsoft_format.parse('2008 SP2')
+ v11.major                                # => 2008
+ v11.minor                                # => 2
+ v11.tiny                                 # => 0
+ v11.to_s                                 # => '2008 SP2'
+ v11 == Versionomy.parse('2008.2')        # => true
+
+=== Feature list
+
+Versionomy's default versioning scheme handles four primary fields (labeled
++major+, +minor+, +tiny+, and +tiny2+). It also supports prerelease versions
+such as preview, development, alpha, beta, and release candidate. Finally,
+it supports patchlevel numbers for released versions.
+
+Versionomy can compare any two version numbers with compatible structure,
+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 create alternate versioning "schemas".
+You can define any number of version number fields, and provide your own
+semantics for comparing, parsing, and modifying version numbers.
+
+=== Requirements
+
+* Ruby 1.8.6 or later, Ruby 1.9.1 or later, or JRuby 1.4 or later.
+* blockenspiel gem.
+
+=== Installation
+
+ gem install versionomy
+
+=== Known issues and limitations
+
+* Test coverage is still a little skimpy. It is focused on the "standard"
+  version number format and schema, but doesn't fully exercise all the
+  capabilities of custom formats.
+
+=== Development and support
+
+Documentation is available at http://virtuoso.rubyforge.org/versionomy
+
+Source code is hosted by Github at http://github.com/dazuma/versionomy
+
+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-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,
+  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

@@ -3,7 +3,7 @@
 # Versionomy Rakefile
 # 
 # -----------------------------------------------------------------------------
-# Copyright 2008 Daniel Azuma
+# Copyright 2008-2009 Daniel Azuma
 # 
 # All rights reserved.
 # 
@@ -33,17 +33,98 @@
 # -----------------------------------------------------------------------------
 
 
-require 'rubygems'
-require 'hoe'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rdoc/generator/darkfish'
+
 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.4']]
-  p_.description_sections = ['versionomy']
-  p_.url = 'http://virtuoso.rubyforge.org/versionomy'
+
+# Configuration
+extra_rdoc_files_ = ['README.rdoc', 'History.rdoc']
+
+
+# Default task
+task :default => [:clean, :rdoc, :test]
+
+
+# Clean task
+CLEAN.include(['doc', 'pkg'])
+
+
+# Test task
+Rake::TestTask.new('test') do |task_|
+  task_.pattern = 'tests/tc_*.rb'
+end
+
+
+# RDoc task
+Rake::RDocTask.new do |task_|
+  task_.main = 'README.rdoc'
+  task_.rdoc_files.include(*extra_rdoc_files_)
+  task_.rdoc_files.include('lib/versionomy/**/*.rb')
+  task_.rdoc_dir = 'doc'
+  task_.title = "Versionomy #{Versionomy::VERSION_STRING} documentation"
+  task_.options << '-f' << 'darkfish'
+end
+
+
+# Gem task
+gemspec_ = Gem::Specification.new do |s_|
+  s_.name = 'versionomy'
+  s_.summary = 'Versionomy is a generalized version number library.'
+  s_.version = Versionomy::VERSION_STRING
+  s_.author = 'Daniel Azuma'
+  s_.email = 'dazuma@gmail.com'
+  s_.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.'
+  s_.homepage = 'http://virtuoso.rubyforge.org/versionomy'
+  s_.rubyforge_project = 'virtuoso'
+  s_.required_ruby_version = '>= 1.8.6'
+  s_.files = FileList['lib/**/*.rb', 'tests/**/*.rb', '*.rdoc', 'Rakefile'].to_a
+  s_.extra_rdoc_files = extra_rdoc_files_
+  s_.has_rdoc = true
+  s_.test_files = FileList['tests/tc_*.rb']
+  s_.platform = Gem::Platform::RUBY
+  s_.add_dependency('blockenspiel', '>= 0.2.1')
+end
+Rake::GemPackageTask.new(gemspec_) do |task_|
+  task_.need_zip = false
+  task_.need_tar = true
+end
+
+
+# Publish RDocs
+desc 'Publishes RDocs to RubyForge'
+task :publish_rdoc => [:rerdoc] do
+  config_ = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  username_ = config_['username']
+  sh "rsync -av --delete doc/ #{username_}@rubyforge.org:/var/www/gforge-projects/virtuoso/versionomy"
+end
+
+
+# Publish gem
+task :publish_gem => [:package] do |t_|
+  v_ = ENV["VERSION"]
+  abort "Must supply VERSION=x.y.z" unless v_
+  if v_ != Versionomy::VERSION_STRING
+    abort "Versions don't match: #{v_} vs #{Versionomy::VERSION_STRING}"
+  end
+  gem_pkg_ = "pkg/versionomy-#{v_}.gem"
+  tgz_pkg_ = "pkg/versionomy-#{v_}.tgz"
+  release_notes_ = File.read("README.rdoc").split(/^(==.*)/)[2].strip
+  release_changes_ = File.read("History.rdoc").split(/^(===.*)/)[1..2].join.strip
+  
+  require 'rubyforge'
+  rf_ = RubyForge.new.configure
+  puts "Logging in to RubyForge"
+  rf_.login
+  config_ = rf_.userconfig
+  config_["release_notes"] = release_notes_
+  config_["release_changes"] = release_changes_
+  config_["preformatted"] = true
+  puts "Releasing versionomy #{v_}"
+  rf_.add_release('virtuoso', 'versionomy', v_, gem_pkg_, tgz_pkg_)
 end

data/lib/versionomy/errors.rb

@@ -3,7 +3,7 @@
 # Versionomy exceptions
 # 
 # -----------------------------------------------------------------------------
-# Copyright 2008 Daniel Azuma
+# Copyright 2008-2009 Daniel Azuma
 # 
 # All rights reserved.
 # 
@@ -44,16 +44,22 @@ module Versionomy
     
     # Base class for all Versionomy exceptions
     
-    class VersionomyError < RuntimeError
+    class VersionomyError < ::RuntimeError
     end
     
     
-    # This exception is raised if parsing or unparsing failed.
+    # This exception is raised if parsing failed.
     
     class ParseError < VersionomyError
     end
     
     
+    # This exception is raised if unparsing failed.
+    
+    class UnparseError < VersionomyError
+    end
+    
+    
     # This exception is raised if you try to set a value that is not
     # allowed by the schema.
     
@@ -68,13 +74,6 @@ module Versionomy
     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
@@ -89,7 +88,7 @@ module Versionomy
     
     
     # This exception is raised during schema creation if you try to
-    # create two subschemas covering overlapping ranges.
+    # create two fields covering overlapping ranges.
     
     class RangeOverlapError < SchemaCreationError
     end
@@ -109,6 +108,26 @@ module Versionomy
     end
     
     
+    # This exception is raised during schema creation if you try to
+    # create a circular dependency.
+    
+    class CircularDescendantError < SchemaCreationError
+    end
+    
+    
+    # Base class for all Versionomy format creation exceptions
+    
+    class FormatCreationError < VersionomyError
+    end
+    
+    
+    # This exception is raised if you try to register a format
+    # with a name that has already been used.
+    
+    class FormatRedefinedError < FormatCreationError
+    end
+    
+    
   end
   
 end

data/lib/versionomy/format/base.rb

@@ -0,0 +1,96 @@
+# -----------------------------------------------------------------------------
+# 
+# Versionomy format 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,
+#   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
+  
+  
+  module Format
+    
+    
+    # The base format.
+    # 
+    # This format doesn't actually do anything useful. It causes all strings
+    # to parse to the schema's default value, and unparses all values to the
+    # empty string.
+    # 
+    # Instead, the purpose here is to define the API for a format. All
+    # formats must define the methods +schema+, +parse+, and +unparse+.
+    # Formats need not extend this base class, as long as they duck-type
+    # these methods.
+    
+    class Base
+      
+      
+      # Create an instance of this base format, with the given schema.
+      
+      def initialize(schema_)
+        @schema = schema_
+      end
+      
+      
+      # Returns the schema understood by this format.
+      
+      def schema
+        @schema
+      end
+      
+      
+      # Parse the given string and return a value.
+      # The optional parameter hash can be used to pass parameters to the
+      # parser to affect its behavior. The exact parameters supported are
+      # defined by the format.
+      
+      def parse(string_, params_=nil)
+        Value.new([], self)
+      end
+      
+      
+      # Unparse the given value and return a string.
+      # The optional parameter hash can be used to pass parameters to the
+      # unparser to affect its behavior. The exact parameters supported
+      # are defined by the format.
+      
+      def unparse(value_, params_=nil)
+        ''
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end