versionable 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Phil Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,55 @@
+= Versionable
+
+Versionable lets a ruby module or class declare multiple numbered versions of itself, and provides a way to select one based on a gem-like requirement.
+
+The jist:
+  class Versioned
+    include Versionable
+
+    def foo; :past_foo; end
+    def baz; :baz; end
+
+    version "0.5"
+
+    def foo; :foo; end
+    def self.bar; :bar; end
+
+    version "1" do
+      def foo; :future_foo; end
+    end
+
+    version "2" do
+      def foo; :far_future_foo; end
+    end
+  end
+
+And then:
+  Versioned['0'].new.foo                  # => :past_foo
+  Versioned['0.5'].new.foo                # => :foo
+  Versioned['1'].new.foo                  # => :future_foo
+  Versioned['2'].new.foo                  # => :far_future_foo
+  Versioned == Versioned['0.5']           # => true
+  Versioned['>= 1'] == Versioned['2']     # => true
+  Versioned['< 1'] == Versioned['0.5']    # => true
+
+It turns out <tt>Class#dup</tt> can do some crazy things.  Each version is cloned from the previous and then includes its own changes.  This means <tt>def self.class_methods()</tt> and <tt>@@class_variables</tt> end up versioned as well; not just instance methods.
+
+The default version (the one you get without a [requirement]) is determined by the use of blocks passed to the +version+ calls.  The last call without a block is the default one.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Thanks
+
+Thanks to SEOmoz (http://seomoz.org) for letting me build this at my desk in the afternoons instead of on the couch in the middle of the night ^_^.
+
+== Copyright
+
+Copyright (c) 2010 Phil Smith. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "versionable"
+    gem.summary = %Q{An api for versioning ruby modules}
+    gem.description = %Q{Versionable lets a ruby module or class declare multiple numbered versions of itself, and provides a way to select one based on a gem-like requirement.}
+    gem.email = "phil.h.smith@gmail.com"
+    gem.homepage = "http://github.com/phs/versionable"
+    gem.authors = ["Phil Smith"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "versionable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/versionable.rb

@@ -0,0 +1,41 @@
+module Versionable
+  # A StandardError representing an error when creating versions.
+  class VersioningError < StandardError
+  end
+end
+
+require 'versionable/version_number'
+require 'versionable/versions'
+
+# A Mixin enabling versioning of the mixer.  See ClassMethods.
+module Versionable
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  # Provides methods for creating and accessing versions of the class or module.
+  module ClassMethods
+
+    # Build a new version of the class or module.
+    # 
+    # See Versions#build.
+    def version(version_number, &block)
+      versions.build(version_number, &block)
+    end
+
+    # Find a version by number or with a requirement, such as with VersionedClass["< 3.0"].
+    # 
+    # See Versions#find.
+    def [](version_requirement)
+      versions.find(version_requirement)
+    end
+
+    # Get the Versions collection on this class or module.
+    def versions
+      @versions ||= Versions.new(self)
+    end
+
+  end
+
+end

data/lib/versionable/version_number.rb

@@ -0,0 +1,55 @@
+module Versionable
+  # A String containing a dotted sequence of positive integers.
+  class VersionNumber < String
+    VERSION_NUMBER_REGEX = /^(?:0|[1-9]\d*)(?:\.(?:0|[1-9]\d*))*$/
+
+    # Construct a VersionNumber from something that responds to <tt>#to_s</tt>.
+    #
+    # If the to_s'd argument does not match VERSION_NUMBER_REGEX, an ArgumentError is raised.
+    def initialize(v)
+      v = v.to_s
+      raise ArgumentError.new "#{v.inspect} is not a dotted sequence of positive integers" unless v =~ VERSION_NUMBER_REGEX
+      super v
+    end
+
+    # Compare version numbers as lists of integers.
+    #
+    # If one version number has more segments than the other, the shorter one is right-extended with zeros.
+    #
+    # For example, when comparing 0.2 to 0.10.1, the 0.2 is extended to 0.2.0.  The left two 0s are equal, so comparison shifts to 2 and 10: 0.10.1 is the greater version.
+    def <=>(other)
+      my_segments, their_segments = to_s.split('.'), other.to_s.split('.')
+      size_difference = my_segments.size - their_segments.size
+
+      if size_difference > 0
+        their_segments.concat(['0'] * size_difference)
+      elsif size_difference < 0
+        my_segments.concat(['0'] * -size_difference)
+      end
+
+      partwise = my_segments.zip(their_segments).collect { |mine, theirs| mine.to_i <=> theirs.to_i }
+      partwise.detect { |cmp| cmp != 0 } || 0
+    end
+
+    # Test equality based on the <=> operator.
+    #
+    # Particularly, 2 == 2.0 == 2.0.0.0
+    def ==(other)
+      (self <=> other) == 0
+    end
+
+    # Bump to the next most-significant version number.
+    #
+    # VersionNumber.new("2.1").next.to_s # => "3"
+    def next
+      self.class.new(split('.', 2).first.to_i + 1)
+    end
+
+    # Hash the version number string after stripping any trailing zeroes.
+    #
+    # This preserves the hash/equality contract: 2 == 2.0, so they both hash the same as well.
+    def hash
+      sub(/(\.0)+$/, '').to_s.hash
+    end
+  end
+end

data/lib/versionable/versions.rb

@@ -0,0 +1,75 @@
+module Versionable
+  # A container for all versions of a given module.
+  class Versions
+    COMPARISON_REGEX = /^(<|<=|=|>=|>)\s+((?:0|[1-9]\d*)(?:\.(?:0|[1-9]\d*))*)$/
+    
+    # Construct a Versions recording versions of the passed module.
+    def initialize(versioned_module)
+      @latest_version = versioned_module
+    end
+    
+    # Build and store a new version with the given number.
+    # 
+    # Versions must be built in increasing order: if version_number is not greater than the previous version, an ArgumentError is raised.
+    # The initial version number is always 0.
+    # 
+    # If a block parameter is passed, it is included in the created version.
+    # If this is the first time a block is passed, then record the _previous_ version as the default one.
+    # Once build is called with a block, subsequent versions must also pass a block or a VersioningError will be raised.
+    def build(version_number, &block)
+      version_number = VersionNumber.new(version_number)
+
+      raise ArgumentError.new "Can't bump to #{version_number} from #{latest_version_number}" unless latest_version_number < version_number
+      raise VersioningError.new "Once called with a block, all subsequent versions must pass a block." if default_version and not block
+
+      if block and default_version.nil?
+        self.default_version = latest_version
+        self.latest_version = latest_version.dup
+
+        versions[latest_version_number] = default_version
+      else
+        versions[latest_version_number] = latest_version.dup
+      end
+      
+      self.latest_version_number = version_number
+      latest_version.module_eval &block if block
+    end
+    
+    # Find the maximal version satisifying the given requirement.
+    # 
+    # The requirement may be a version string such as "1.0.7", or a comparator followed by a version such as "< 3.0".
+    # 
+    # Returns the matching module if found, nil otherwise.
+    def find(version_requirement)
+      if version_requirement =~ VersionNumber::VERSION_NUMBER_REGEX
+        versions[VersionNumber.new(version_requirement)]
+      elsif version_requirement =~ Versions::COMPARISON_REGEX
+        comparator, version_requirement = $1, VersionNumber.new($2)
+        comparator = '==' if comparator == '=' # stick that in your pipe and smoke it.
+        comparator = comparator.to_sym
+        
+        match = (versions.keys + [latest_version_number]).select { |v| v.send comparator, version_requirement }.max
+
+        versions[match]
+      else
+        nil
+      end
+    end
+    
+  private
+
+    attr_accessor :latest_version       # :nodoc:
+    attr_accessor :default_version      # :nodoc:
+    attr_writer :latest_version_number  # :nodoc:
+
+    def latest_version_number
+      @latest_version_number ||= VersionNumber.new("0")
+    end
+
+    def versions
+      @versions ||= Hash.new do |hash, key|
+        latest_version_number == key ? latest_version : nil
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'versionable'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/versionable/version_number_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Versionable::VersionNumber do
+  
+  def v(version)
+    Versionable::VersionNumber.new(version)
+  end
+  
+  it "is a string" do
+    v("1.0").should be_a String
+  end
+  
+  it "rejects versions that aren't dotted sequences of positive integers" do
+    lambda { v "dog" }.should raise_error ArgumentError
+    lambda { v "-1"  }.should raise_error ArgumentError
+  end
+
+  describe "<=>" do
+    it "sorts by segments from left to right" do
+      v("10.0").should > v("2.0")
+      v("10.1").should < v("10.2")
+    end
+    
+    it "right-pads missing segments with zeros" do
+      v("1").should == v("1.0")
+      v("1.0").should == v("1.0.0.0.0.0.0.0.0")
+      v("10").should > v("3.2.1")
+    end
+  end
+  
+  describe "#next" do
+    it "bumps most significant segment by 1 and drops remainder" do
+      v("1.0").next.should == v("2")
+    end
+  end
+
+  describe "#hash" do
+    it "is the string hash after stripping trailing zero segments" do
+      v("1").hash.should == v("1.0.0.0.0").hash
+      v("1").hash.should_not == v("2").hash
+    end
+  end
+
+end

data/spec/versionable_spec.rb

@@ -0,0 +1,104 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Versionable do
+
+  it "does seemingly nothing by default" do
+    class Unmolested
+      include Versionable
+      def foo; :foo; end
+    end
+
+    Unmolested.new.foo.should == :foo
+  end
+
+  describe ".version" do
+    it "takes a version number" do
+      class Versioned
+        include Versionable
+
+        def foo; :past_foo; end
+        def baz; :baz; end
+
+        version "1"
+
+        def foo; :foo; end
+        def self.bar; :bar; end
+      end
+    end
+    
+    it "rejects bad version numbers" do
+      lambda do
+        class Versioned
+          version "chowder!"
+        end
+      end.should raise_error ArgumentError
+    end
+
+    it "rejects non-increasing version numbers" do
+      lambda do
+        class Versioned; version "0"; end
+      end.should raise_error ArgumentError
+
+      lambda do
+        class Versioned; version "1"; end
+      end.should raise_error ArgumentError
+    end
+    
+    it "takes a block for versions after the default" do
+      class Versioned
+        version "2" do
+          def foo; :future_foo; end
+        end
+      end
+    end
+
+    it "returns the value of its block, if any" do
+      class Versioned
+        (version "3" do
+          def foo; :far_future_foo; end
+          
+          :returned
+        end).should == :returned
+      end
+    end
+
+    it "rejects blockless calls after block ones" do
+      lambda do
+        class Versioned; version "4"; end
+      end.should raise_error Versionable::VersioningError
+    end
+  end
+
+  describe "[]" do
+    it "sends versions to classes" do
+      Unmolested['0'].should be_a Class
+    end
+
+    it "sends the default version to itself" do
+      Unmolested['0'].should == Unmolested
+      Versioned['1'].should == Versioned
+    end
+
+    it "sends other versions to similar classes, representing older or newer functionality" do
+      Versioned['0'].should_not == Versioned
+      Versioned['0'].new.foo.should == :past_foo
+
+      Versioned['1'].bar.should == :bar
+      lambda { Versioned['0'].bar }.should raise_error NoMethodError
+
+      Versioned['2'].should_not == Versioned
+      Versioned['2'].new.foo.should == :future_foo
+
+      Versioned['3'].new.foo.should == :far_future_foo
+    end
+
+    it "takes comparator expressions" do
+      Versioned[">= 0"].should == Versioned['3']
+      Versioned["<= 2"].should == Versioned['2']
+      Versioned["< 2"].should == Versioned['1']
+      Versioned["= 0"].should == Versioned['0']
+      Versioned["> 0"].should == Versioned['3']
+    end
+  end
+  
+end

data/versionable.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{versionable}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Phil Smith"]
+  s.date = %q{2010-04-22}
+  s.description = %q{Versionable lets a ruby module or class declare multiple numbered versions of itself, and provides a way to select one based on a gem-like requirement.}
+  s.email = %q{phil.h.smith@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/versionable.rb",
+     "lib/versionable/version_number.rb",
+     "lib/versionable/versions.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/versionable/version_number_spec.rb",
+     "spec/versionable_spec.rb",
+     "versionable.gemspec"
+  ]
+  s.homepage = %q{http://github.com/phs/versionable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{An api for versioning ruby modules}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/versionable/version_number_spec.rb",
+     "spec/versionable_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: versionable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Phil Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Versionable lets a ruby module or class declare multiple numbered versions of itself, and provides a way to select one based on a gem-like requirement.
+email: phil.h.smith@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/versionable.rb
+- lib/versionable/version_number.rb
+- lib/versionable/versions.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/versionable/version_number_spec.rb
+- spec/versionable_spec.rb
+- versionable.gemspec
+has_rdoc: true
+homepage: http://github.com/phs/versionable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An api for versioning ruby modules
+test_files: 
+- spec/spec_helper.rb
+- spec/versionable/version_number_spec.rb
+- spec/versionable_spec.rb