fun_with_version_strings 0.0.2

data/.document

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

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.3.5"
+  gem "jeweler", "~> 1.8.4"
+end
+
+gem "fun_with_files"

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Bryce Anderson
+
+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,47 @@
+= fun_with_version_strings
+
+Declare any Ruby object to have a version:
+
+class MyGem; end
+
+FunWith::VersionStrings.versionize( MyGem, "0.0.3" )
+
+Then the following is true:
+
+    MyGem.version # => "0.0.3"
+    MyGem.version.major  # => 0
+    MyGem.version.minor  # => 0
+    MyGem.version.patch  # => 3
+
+You can also compare versions.  Observe:
+
+    version_a = "9.1.4"
+    version_b = "10.1.0"
+    version_c = "9.2.0"
+    
+    version_c > version_a   # => true
+    version_c == version_a  # => false
+    version_b > version_a   # => true
+    version_b < version_a   # => false
+    
+But comparisons are a bit tricky.  It will try to compare standard strings as version strings, if the standard string is of the proper format.  Otherwise
+it will compare the two as regular strings.  Note that this means that the
+comparison behaves differently depending on whether the left-hand side is
+a regular string.
+    
+
+== Contributing to fun_with_version_strings
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Bryce Anderson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fun_with_version_strings"
+  gem.homepage = "http://github.com/darthschmoo/fun_with_version_strings"
+  gem.license = "MIT"
+  gem.summary = "Add a version string (with :major,:minor, and :patch methods) to a Ruby object."
+  gem.description = "A simple little gem for adding a version string to any Ruby object."
+  gem.email = "keeputahweird@gmail.com"
+  gem.authors = ["Bryce Anderson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fun_with_version_strings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/fun_with_version_strings.rb

@@ -0,0 +1,16 @@
+require 'fun_with_files'
+
+module FunWith
+  module VersionStrings
+  end
+end
+
+root = __FILE__.fwf_filepath.dirname.up
+
+root.join( "lib", "version_strings" ).requir
+
+FunWith::Files::RootPath.rootify( FunWith::VersionStrings, root )
+FunWith::VersionStrings::VersionString.send( :include, FunWith::VersionStrings::Comparator )
+FunWith::VersionStrings.extend( FunWith::VersionStrings::API )
+FunWith::VersionStrings.versionize( FunWith::VersionStrings )
+

data/lib/version_strings/api.rb

@@ -0,0 +1,26 @@
+module FunWith
+  module VersionStrings
+    # methods that can be called directly upon the module FunWith::VersionStrings
+    module API
+      # if no string is given, the given object is assumed to have a root path and
+      # to have a file "VERSION" immediately underneath that root.  That's standard for
+      # my gems.
+      def versionize( obj, version_string = nil )
+        if obj.respond_to?(:version)
+          warn( "FunWith::VersionStrings (warn):  #{obj.to_s[0..100]} already responds to version()")
+        end
+        
+        if version_string.nil?
+          if obj.respond_to?(:root) && obj.root("VERSION").file?
+            version_string = obj.root("VERSION").read
+          else
+            raise "No version string specified, and cannot infer version from VERSION file."
+          end
+        end
+        
+        obj.extend( VersionizeExtender )
+        obj.version( version_string )
+      end
+    end
+  end
+end

data/lib/version_strings/comparator.rb

@@ -0,0 +1,24 @@
+module FunWith
+  module VersionStrings
+    module Comparator
+      
+      # Unless both strings are valid version formats, pass comparison off to super
+      def <=>( rhs )
+        
+        if rhs.is_a?(VersionString) || rhs =~ VersionString::FORMAT_VALIDATOR
+          rhs = rhs.fwvs_version_string
+
+          for level in [:major, :minor, :patch]
+            unless self.send(level) == rhs.send(level)
+              return self.send(level) <=> rhs.send(level)
+            end
+          end
+        
+          return 0
+        else
+          super( rhs )
+        end
+      end
+    end
+  end
+end

data/lib/version_strings/string.rb

@@ -0,0 +1,9 @@
+class String
+  def fwvs_version_string
+    if self.is_a?(FunWith::VersionStrings::VersionString)
+      self.dup
+    else
+      FunWith::VersionStrings::VersionString.new( self )
+    end
+  end
+end

data/lib/version_strings/version_string.rb

@@ -0,0 +1,24 @@
+module FunWith
+  module VersionStrings
+    class VersionString < String
+      FORMAT_VALIDATOR = /^(?:(?<major>\d+)\.?)?(?:(?<minor>\d+)\.?)?(?:(?<patch>\d+))?$/
+      attr_accessor :major, :minor, :patch
+      alias :tiny :patch
+      
+      # version must be of format n.nn or n.nn.nn
+      def initialize( src )
+        @match_data = src.match( FORMAT_VALIDATOR )
+        raise ArgumentError.new( "Not a valid version format for a VersionString." ) if @match_data.nil?
+
+        @major = (@match_data[:major] || 0).to_i
+        @minor = (@match_data[:minor] || 0).to_i
+        @patch = (@match_data[:patch] || 0).to_i
+        
+        super( "#{@major}.#{@minor}.#{@patch}" )
+      end
+    end
+  end
+end
+
+
+

data/lib/version_strings/versionize_extender.rb

@@ -0,0 +1,10 @@
+module FunWith
+  module VersionStrings
+    module VersionizeExtender
+      def version( str = nil )
+        @fwvs_version_string ||= str.fwvs_version_string
+        @fwvs_version_string
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fun_with_version_strings'
+
+include FunWith::VersionStrings
+
+class Test::Unit::TestCase
+end
+
+class VersionStringsTestCase < Test::Unit::TestCase
+  def assert_valid_version_string( str, opts = {} )
+    str = str.fwvs_version_string
+    for level in [:major, :minor, :patch]
+      if opts[level]
+        assert_equal opts[level], str.send(level)
+      end
+    end
+  end
+  
+  def versioned_module( &block )
+    @module = Module.new
+    
+    assert !( @module.respond_to?( :version ) ), "New module shouldn't respond to :version method."
+    
+    FunWith::VersionStrings.versionize( @module, "3.1.2" )
+    assert @module.respond_to?( :version ), "New module should respond to :version method."
+    
+    assert @module.version.is_a?(String), "@module.version should yield a string"
+    assert @module.version.is_a?(FunWith::VersionStrings::VersionString), "@module.version should yield a VersionString"
+    yield
+  end
+end

data/test/test_fun_with_version_strings.rb

@@ -0,0 +1,88 @@
+require 'helper'
+
+class TestFunWithVersionStrings < VersionStringsTestCase
+  context "setup" do
+    should "respond to all the things" do
+      assert "".respond_to?(:fwvs_version_string), "String not responding"
+      assert FunWith::VersionStrings.respond_to?(:root), "FunWith::VersionStrings not responding to root"
+      assert FunWith::VersionStrings.respond_to?(:versionize), "FunWith::VersionStrings not responding to versionize"
+    end    
+  end
+  
+  
+  should "accept the following strings as version formats" do
+    assert_valid_version_string( "", {:major => 0, :minor => 0, :patch => 0})
+    assert_valid_version_string( "0.", {:major => 0, :minor => 0, :patch => 0})
+    assert_valid_version_string( "0.0", {:major => 0, :minor => 0, :patch => 0})
+    assert_valid_version_string( "0.0.", {:major => 0, :minor => 0, :patch => 0})
+    assert_valid_version_string( "0.0.0", {:major => 0, :minor => 0, :patch => 0})
+  end
+  
+  should "compare things correctly" do
+    # larger always comes first
+    gt_comparisons = [
+      ["1.7","1.4"],
+      ["0.9","0.8"],
+      ["0.0.1",""],
+      ["0.0.1","0.0."],
+      ["3.14159","3.141"],
+      ["1",""]
+    ]
+    
+    eq_comparisons = [
+      ["0.0.0",""],
+      ["1.0.0","1.0"],
+      ["1.0.","1"],
+      ["3.1.1","3.1.1"],
+      ["3","3.0."],
+      ["2.4","2.4.0"]
+    ]
+    
+    for c in gt_comparisons
+      assert( c.first.fwvs_version_string > c.last.fwvs_version_string, "#{c.first.inspect} should be greater than #{c.last.inspect}" )
+    end
+    
+    for c in eq_comparisons
+      assert_equal( c.first.fwvs_version_string, c.last.fwvs_version_string )
+    end
+  end
+  
+  context "trying it out" do
+    should "be able to call .version() on a class" do
+      versioned_module do
+        assert @module.version.length == 5, "@module.version.length == 5"
+      end
+    end
+  end
+  
+  context "trying out default approach to finding a module version" do
+    should "raise error when no string given" do
+      mod = Module.new
+
+      assert_raises( RuntimeError ) do
+        FunWith::VersionStrings.versionize( @module )
+      end
+    end
+    
+    should "raise error when root has no VERSION file" do
+      mod = Module.new
+      FunWith::Files::RootPath.rootify(mod, FunWith::VersionStrings.root("test"))
+      assert_raises( RuntimeError ) do
+        FunWith::VersionStrings.versionize( @module )
+      end
+    end
+    
+    should "set version by VERSION file when module has a root" do
+      mod = Module.new
+      FunWith::Files::RootPath.rootify( mod, FunWith::VersionStrings.root )
+      FunWith::VersionStrings.versionize( mod )
+      assert FunWith::VersionStrings.respond_to?(:version)
+      assert mod.respond_to?(:version)
+      assert_equal FunWith::VersionStrings.version, mod.version
+    end
+  end
+  
+  should "compare incorrectly when dealing with regular strings" do
+    flunk "not written"
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: fun_with_version_strings
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Bryce Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fun_with_files
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: A simple little gem for adding a version string to any Ruby object.
+email: keeputahweird@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/fun_with_version_strings.rb
+- lib/version_strings/api.rb
+- lib/version_strings/comparator.rb
+- lib/version_strings/string.rb
+- lib/version_strings/version_string.rb
+- lib/version_strings/versionize_extender.rb
+- test/helper.rb
+- test/test_fun_with_version_strings.rb
+homepage: http://github.com/darthschmoo/fun_with_version_strings
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3139587629202339878
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Add a version string (with :major,:minor, and :patch methods) to a Ruby object.
+test_files: []