versionary 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+.*.swp
+.bundle
+.DS_Store
+
+# nesta / sinatra
+._*
+.sass-cache

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# See:
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    versionary (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rake (0.8.7)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  rake (~> 0.8.7)
+  rspec (>= 2.5.0)
+  versionary!

data/README.md

@@ -0,0 +1,30 @@
+# Versionary - a simple gem that allows you to compare version numbers
+
+This was extracted from the [RiverGlide ruby template project](https://github.com/RiverGlide/ruby_project_template)
+
+## Synopsis
+
+A simple, comparable, [rational](http://docs.rubygems.org/read/chapter/7), version number object.
+
+Allows you to do things like this:
+
+    raise "not the right version" unless VersionNumber.of( RUBY_VERSION ) >= VersionNumber.of( '1.9'2' )
+    raise "not the right version" unless VersionNumber.of( RUBY_VERSION ) >= '1.9.2'
+
+Or any other comparison between any VersionNumber you create:
+
+    VersionNumber.of( '0.9.10' ) > '0.9.9'
+    VersionNumber.of( '0.9.9' ) < '0.9.10'
+    VersionNumber.of( '0.9.10' ) >= '0.9.9'
+    VersionNumber.of( '0.9.10' ) == '0.9.10'
+
+As you can see, it does a numerical (rather than alphabetical) comparison of the major, minor and build numbers.
+
+It doesn't do version bumping or anything like that - but if you want to to, fork it, branch, add that ability and send us a pull request :-)
+
+## Usage
+
+If you're using bundler, reference the gem in your Gemfile or gemspec as a runtime dependency and bundler will do the rest... 
+Or, `gem install versionary` and then:
+
+    require 'versionary/version_number'

data/Rakefile

@@ -0,0 +1,35 @@
+puts "\n ** RiverGlide.com - flow without friction **\n"
+
+ENV[ 'MINIMUM_RUBY_VERSION' ] = '1.8.7'
+
+require './rake/required_audits'
+desc "Make sure your environment is ready"
+task :environment_ready => [ 
+  :you_need_the_right_ruby_version, 
+  :you_need_our_dependency_manager, 
+  :you_need_to_install_any_dependencies
+]
+
+begin
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
+rescue NameError => e
+  puts "This problem should get sorted out once you've completed the above instructions:\n" + e.message
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "CukeSalad #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require './rake/testing_tasks/check_internals_with_rspec'
+desc "Checks the environment and runs all tests"
+task :default => [
+  :environment_ready, 
+  :spec 
+]

data/cucumber.yml

@@ -0,0 +1,6 @@
+default: --tags ~@wip --tags ~@todo
+wip: --tags @wip
+todo: --tags @todo
+all: features
+autotest: --color
+autotest-all: --color

data/lib/versionary/version_number.rb

@@ -0,0 +1,72 @@
+module Versionary
+  class VersionNumber
+
+    include Comparable
+
+    attr_reader :major, :minor, :build
+
+    VERSION_PATTERN = /^\d+\.\d+\.\d+$/
+
+    def self.of version
+      self.new version
+    end
+
+    def initialize version
+      raise NotAVersionComplaint.about version if not a_recognised? version
+      number = infer_from version
+      @major = value_of :major, number
+      @minor = value_of :minor, number
+      @build = value_of :build, number
+    end
+
+    def <=> other_version
+      with_other_version = VersionNumber.of(other_version) if other_version.class == String
+      with_other_version = other_version if other_version.class == self.class
+      
+      compare(self, with_other_version)
+    end
+
+    def to_s
+      "#{@major}.#{@minor}.#{@build}" 
+    end
+
+    private
+    def a_recognised? version
+      version =~ VERSION_PATTERN
+    end
+
+    def infer_from version
+      version.split( '.' ).collect { |n| n.to_i }
+    end
+
+    def value_of position, from_numbers
+      positions = {:major => 0, :minor => 1, :build => 2}
+      from_numbers[positions[position]]
+    end
+
+    def compare first_version, second_version
+      differences = []
+      differences[0] = first_version.major <=> second_version.major
+      differences[1] = first_version.minor <=> second_version.minor
+      differences[2] = first_version.build <=> second_version.build
+      differences.each do |indication|
+        return indication if it_is_a_greater_than_or_less_than? indication
+      end
+      0
+    end
+
+    def it_is_a_greater_than_or_less_than? indication
+      indication != 0
+    end
+  end
+
+  class NotAVersionComplaint < Exception
+    def self.about version
+      self.new version
+    end
+    
+    def initialize version
+      super "#{version} is not a recognised version number"
+    end
+  end
+end

data/rake/audit_tasks/you_need_our_dependency_manager.rb

@@ -0,0 +1,16 @@
+task :you_need_our_dependency_manager do
+  begin
+    require 'bundler'
+    puts "You have our preferred dependency manager. Cool!"
+  rescue LoadError => e
+    abort "\nOoops! You're not quite ready to start.\n" +
+      e.message + "\n\n" +
+      "We can fix this easily...\n" +
+      "\nAll you should need to do is run `gem install bundler`\n" + 
+      "\nBefore you do that, we recommend that you use rvm and use a fresh gemset.\n" +
+      "    rvm:                  http://beginrescueend.com/\n" +
+      "    rvm gemsets:          http://beginrescueend.com/gemsets/\n" +
+      "    rvm creating gemsets: http://beginrescueend.com/gemsets/creating/\n" +
+      "\nOnce you've installed bundler into your nice new gemset, run `rake` again and we'll tell you what's next.\n\n"
+  end
+end

data/rake/audit_tasks/you_need_the_right_ruby_version.rb

@@ -0,0 +1,20 @@
+$: << File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "lib")
+require 'versionary/version_number'
+
+task :you_need_the_right_ruby_version do
+  include Versionary
+
+  minimum_ruby_version = ENV[ 'MINIMUM_RUBY_VERSION' ]
+  
+  with_guidance = "
+  Oops! You are using ruby #{RUBY_VERSION}. We really want you to use ruby #{minimum_ruby_version} or higher
+    Suggestion:
+      We like using rvm to manage our ruby versions.
+      That way, you can just say  `rvm use #{minimum_ruby_version}`  and hey presto, you're on version #{minimum_ruby_version}
+      rvm:  http://beginrescueend.com/
+  Hey, it's up to you, but once you're on ruby #{minimum_ruby_version} let us know by running `rake` again.\n\n"
+
+  abort with_guidance if VersionNumber.of( RUBY_VERSION ) < minimum_ruby_version
+  
+  puts "You're using ruby #{RUBY_VERSION}. We're happy about that."
+end

data/rake/audit_tasks/you_need_to_install_any_dependencies.rb

@@ -0,0 +1,11 @@
+task :you_need_to_install_any_dependencies do
+  begin
+    Bundler.setup(:default, :development)
+    puts "You have all the dependencies you need!!\n\n"
+  rescue Bundler::BundlerError => e
+    $stderr.puts "Oops! So near, yet so far.\n\n"
+    $stderr.puts e.message + "\n\n"
+    $stderr.puts "Run `bundle install` and all the dependencies you need will be installed\n\n"
+    exit e.status_code
+  end
+end

data/rake/required_audits.rb

@@ -0,0 +1,3 @@
+require './rake/audit_tasks/you_need_the_right_ruby_version'
+require './rake/audit_tasks/you_need_our_dependency_manager'
+require './rake/audit_tasks/you_need_to_install_any_dependencies'

data/rake/testing_tasks/check_features_with_cucumber.rb

@@ -0,0 +1,18 @@
+begin
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:features)
+  
+  additional_tasks = {
+    :features_wip  => '-p wip',
+    :features_todo => '-p todo'
+  }
+  
+  additional_tasks.each do | task_name, options |
+    Cucumber::Rake::Task.new(task_name) do |wip|
+        wip.cucumber_opts = options 
+    end
+  end
+rescue LoadError => e
+  #do_nothing - bundler will sort this out
+end

data/rake/testing_tasks/check_internals_with_rspec.rb

@@ -0,0 +1,20 @@
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+
+  file_pattern = 'spec/**/*_spec.rb'
+  tasks = { 
+    :spec                  => "-cfd --tag ~wip --tag ~todo",
+    :spec_wip              => "-cfd --tag @wip",
+    :spec_todo             => "-cfd --tag @todo"
+  }
+
+  tasks.each do | task_name, options |
+    RSpec::Core::RakeTask.new(task_name) do |spec|
+      spec.pattern = FileList[file_pattern]
+      spec.rspec_opts = options
+    end
+  end
+rescue LoadError => e
+  #do_nothing - bundler will sort this out
+end

data/spec/versionary/version_number_spec.rb

@@ -0,0 +1,100 @@
+require 'versionary/version_number'
+module Versionary
+  describe VersionNumber do
+    include Versionary
+
+    context "when the versions are the same" do
+      it "tells you they are equal" do
+        VersionNumber.of( RUBY_VERSION ).should == VersionNumber.of( RUBY_VERSION )
+      end
+
+      it "tells you that the first number is not less than second number" do
+        VersionNumber.of( RUBY_VERSION ).should_not < VersionNumber.of( RUBY_VERSION )
+      end
+
+      it "tells you that the first number is not greater than second number" do
+        VersionNumber.of( RUBY_VERSION ).should_not > VersionNumber.of( RUBY_VERSION )
+      end
+    end
+
+    [:major, :minor, :build].each do | position |
+      context "when the #{position} number is different" do
+        context "making the first version lower than the second version" do
+          let(:first_version) {'0.0.9'}
+          let(:second_version) { a_version :higher_than, first_version, position }
+
+          it "tells you that the first number is less than the second number" do
+            VersionNumber.of( first_version ).should < VersionNumber.of( second_version )
+          end
+
+          it "tells you that the first number is not greater than the second number" do
+            VersionNumber.of( first_version ).should_not > VersionNumber.of( second_version )
+          end
+
+          it "tells you that they're not equal" do
+            VersionNumber.of( first_version ).should_not == VersionNumber.of( second_version )
+          end
+        end
+        
+        context "making the first version higher than the second version" do
+          let(:first_version) {'10.10.10'} # to ensure that digits are compared numerically, not alphabetically
+          let(:second_version) { a_version :lower_than, first_version, position }
+
+          it "tells you that the first number is greater than the second number" do
+            VersionNumber.of( first_version ).should > VersionNumber.of( second_version )
+          end
+
+          it "tells you that the first number is not less than the second number" do
+            VersionNumber.of( first_version ).should_not < VersionNumber.of( second_version )
+          end
+
+          it "tells you that they're not equal" do
+            VersionNumber.of( first_version ).should_not == VersionNumber.of( second_version )
+          end
+        end
+      end
+    end
+
+    context "when the latter number is a string" do
+      it "tells you when they're equal as version numbers" do
+        VersionNumber.of('1.9.2').should == '1.9.2'
+      end
+
+      it "tells you when the first version number is greater than a string representation" do
+        VersionNumber.of('1.9.10').should > '1.9.9'
+      end
+      it "tells you when the first version number is less than a string representation" do 
+        VersionNumber.of('1.9.9').should < '1.9.10'
+      end
+
+      it "tells you when the number is not equal to the string representation" do
+        VersionNumber.of('1.9.9').should_not == '1.9.10'
+      end
+    end
+
+    context "when the version number provided is not understood, for example:" do
+      [ "1.9.a",
+        "v1.9.2",
+        "1.9.2a", 
+        "not a version", 
+        ".1.9.2", 
+        "1.9.2.1" 
+      ].each do | unrecognised_version |
+        it "can't understand '#{unrecognised_version}'" do
+          lambda {VersionNumber.of( unrecognised_version )}.should raise_error NotAVersionComplaint
+        end
+      end
+    end
+
+    def a_version higher_or_lower_than, version_number, major_minor_or_build
+      alterations = {:higher_than => :+, :lower_than => :-}
+      positions = {:major => 0, :minor => 1, :build => 2 }
+      altered_by = alterations[higher_or_lower_than]
+      position = positions[major_minor_or_build]
+
+      version_numbers = version_number.split( '.' ).collect {|n| n.to_i}
+      version_numbers[position] = version_numbers[position].send altered_by, 1
+      version_numbers.join '.'
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: versionary
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- RiverGlide
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id003
+description: "Versionary has a simple VersionNumber object that allows you to do things like `raise \"Not the right version\" unless VersionNumber.of( RUBY_VERSION ) >= '1.9.2'` "
+email: 
+- talktous@riverglide.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- cucumber.yml
+- lib/versionary/version_number.rb
+- rake/audit_tasks/you_need_our_dependency_manager.rb
+- rake/audit_tasks/you_need_the_right_ruby_version.rb
+- rake/audit_tasks/you_need_to_install_any_dependencies.rb
+- rake/required_audits.rb
+- rake/testing_tasks/check_features_with_cucumber.rb
+- rake/testing_tasks/check_internals_with_rspec.rb
+- spec/versionary/version_number_spec.rb
+has_rdoc: true
+homepage: https://github.com/RiverGlide/Versionary
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Simple, comparable, rational Version Number object
+test_files: 
+- spec/versionary/version_number_spec.rb