semantic_versioning 0.1.0

data/lib/semantic_versioning.rb

@@ -0,0 +1,5 @@
+require 'semantic_versioning/gem_version'
+require 'semantic_versioning/version'
+require 'semantic_versioning/segment'
+require 'semantic_versioning/version_set'
+require 'semantic_versioning/errors'

data/lib/semantic_versioning/errors.rb

@@ -0,0 +1,6 @@
+module SemanticVersioning
+  
+  class ParsingError < ArgumentError; end
+  class IncrementError < ArgumentError; end
+  
+end

data/lib/semantic_versioning/gem_version.rb

@@ -0,0 +1,3 @@
+module SemanticVersioning
+  GEM_VERSION = '0.1.0'
+end

data/lib/semantic_versioning/segment.rb

@@ -0,0 +1,44 @@
+module SemanticVersioning
+
+  class Segment
+
+    include Comparable
+
+    def initialize(input)
+      @input = input
+    end
+
+    def identifiers
+      return [] if @input.nil?
+      ids = @input.split('.')
+      ids.map! { |id| id.match(/^[0-9]+$/) ? id.to_i : id }
+    end
+
+    def <=>(other)
+      return nil unless other.is_a?(Segment)
+      scores = scores_vs(other)
+      scores.compact.detect { |s| s.abs == 1 }
+    end
+
+    private
+
+      def scores_vs(other)
+        ids  = { :self => identifiers, :other => other.identifiers }
+        pids = pad_ids(ids)
+        pids[:self].map.with_index { |id, idx| id <=> pids[:other][idx] }
+      end
+
+      def pad_ids(id_arrays)
+        sorted = id_arrays.sort { |a, b| b[1].length <=> a[1].length  }
+        str, int = '', 0
+        sorted[0][1].each_with_index do |id, idx|
+          if idx >= sorted[1][1].length
+            sorted[1][1] << (id.is_a?(Integer) ? int : str)
+          end
+        end
+        Hash[sorted]
+      end
+
+  end
+
+end

data/lib/semantic_versioning/version.rb

@@ -0,0 +1,92 @@
+module SemanticVersioning
+  
+  class Version
+
+    include Comparable
+
+    PATTERN = /^
+      (?<required>
+        (?<major>[0-9]+)\.
+        (?<minor>[0-9]+)\.
+        (?<patch>[0-9]+)
+      )
+      (-(?<pre>[0-9A-Za-z\-\.]+))?
+      (\+(?<build>[0-9A-Za-z\-\.]+))?
+    $/x
+
+    attr_reader :major, :minor, :patch, :required, :segments
+    attr_accessor :pre, :build
+    alias_method :prerelease, :pre
+
+    def initialize(input, segment = Segment)
+      if (m = input.match(PATTERN))
+        @input = input
+        @major, @minor, @patch = m['major'].to_i, m['minor'].to_i, m['patch'].to_i
+        @required, @pre, @build = m['required'], m['pre'], m['build']
+        @segments = [
+          segment.new(@required),
+          segment.new(@pre),
+          segment.new(@build)
+        ]
+      else
+        raise ParsingError, 'String input not correctly formatted for Semantic Versioning'
+      end
+    end
+
+    def <=>(other)
+      return nil unless other.is_a?(Version)
+      return 0 if to_s == other.to_s
+      if required == other.required
+        return -1 if pre && other.pre.nil?
+        return 1 if pre.nil? && other.pre
+      end
+      scores = segments.map.with_index { |s, idx| s <=> other.segments[idx] }
+      scores.compact.detect { |s| s.abs == 1 }
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      to_s.hash
+    end
+
+    def to_s
+      version = "#{@major}.#{@minor}.#{@patch}"
+      version += "-#{@pre}" unless pre.nil?
+      version += "+#{@build}" unless build.nil?
+      version
+    end
+
+    def increment(identifier)
+      case identifier
+      when :major
+        @major += 1
+        reset(:minor, :patch)
+      when :minor
+        @minor += 1
+        reset(:patch)
+      when :patch
+        @patch += 1
+      else
+        raise IncrementError, 'Only :major, :minor and :patch attributes may be incremented'
+      end
+      clear_optional_identifiers
+    end
+
+    private
+
+      def reset(*identifiers)
+        identifiers.each do |id|
+          instance_variable_set(:"@#{id}", 0)
+        end
+      end
+
+      def clear_optional_identifiers
+        @pre, @build = nil, nil
+      end
+
+  end
+
+end

data/lib/semantic_versioning/version_set.rb

@@ -0,0 +1,15 @@
+require 'set'
+
+module SemanticVersioning
+
+  class VersionSet < SortedSet
+
+    def where(operator, version)
+      version = Version.new(version) if version.is_a? String
+      subset = select { |v| v.send(operator, version) }
+      self.class.new subset
+    end
+
+  end
+
+end

data/spec/semantic_versioning/version_set_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe SemanticVersioning::VersionSet do
+
+  let(:versions) { [v('1.0.0'), v('1.0.10'), v('0.10.0')] }
+  let(:set) { SemanticVersioning::VersionSet.new(versions) }
+
+  it 'yields version in correct order' do
+    results = set.map{ |v| v }
+    results.should == [v('0.10.0'), v('1.0.0'), v('1.0.10')]
+  end
+
+  it 'discards duplicates' do
+    set << v('1.0.0')
+    set.length.should == versions.length
+  end
+
+  describe '#where' do
+    it 'returns a new VersionSet' do
+      set.where(:<, v('1.0.0')).should be_a SemanticVersioning::VersionSet
+    end
+    it 'allows version to be given as a string' do
+      set.where(:<, '1.0.0').first.should be_a SemanticVersioning::Version
+    end
+    specify { set.where(:<,  v('1.0.10')).length.should == 2 }
+    specify { set.where(:<=, v('1.0.10')).length.should == 3 }
+    specify { set.where(:==, v('1.0.0')).length.should == 1 }
+    specify { set.where(:>=, v('1.0.0')).length.should == 2 }
+    specify { set.where(:>,  v('0.10.0')).length.should == 2 }
+  end
+
+end

data/spec/semantic_versioning/version_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe SemanticVersioning::Version do
+
+  let(:version) { v('1.2.3-pre.1+build.2') }
+
+  describe 'accepts only properly formatted strings' do
+    specify do
+      lambda { v('1.0.0-beta.1') }.should_not raise_error
+      lambda { v('1.0.0.0') }.should raise_error(SemanticVersioning::ParsingError)
+    end
+  end
+
+  describe 'instance methods' do
+    specify { version.major.should == 1 }
+    specify { version.minor.should == 2 }
+    specify { version.patch.should == 3 }
+    specify { version.pre.should == 'pre.1' }
+    specify { version.prerelease.should == version.pre }
+    specify { version.build.should == 'build.2' }
+  end
+
+  describe 'segments' do
+    specify do
+      version.segments.all? { |s| s.is_a?(SemanticVersioning::Segment) }.should be_true
+    end
+  end
+
+  describe 'comparisons from semver.org spec 2.0.0-rc.1' do
+    specify { v('1.0.0-alpha').should           be < v('1.0.0-alpha.1') }
+    specify { v('1.0.0-alpha.1').should         be < v('1.0.0-beta.2') }
+    specify { v('1.0.0-beta.2').should          be < v('1.0.0-beta.11') }
+    specify { v('1.0.0-beta.11').should         be < v('1.0.0-rc.1') }
+    specify { v('1.0.0-rc.1').should            be < v('1.0.0-rc.1+build.1') }
+    specify { v('1.0.0-rc.1+build.1').should    be < v('1.0.0') }
+    specify { v('1.0.0').should                 be < v('1.0.0+0.3.7') }
+    specify { v('1.0.0+0.3.7').should           be < v('1.3.7+build') }
+    specify { v('1.3.7+build').should           be < v('1.3.7+build.2.b8f12d7') }
+    specify { v('1.3.7+build.2.b8f12d7').should be < v('1.3.7+build.11.e0f985a') }
+  end
+
+  describe 'more comparisons' do
+    specify { v('1.0.0').should be > v('1.0.0-rc.1+build.1') }
+    specify { v('1.0.0-alpha').should == v('1.0.0-alpha') }
+  end
+
+  describe '#increment' do
+    specify 'major' do
+      version.increment(:major)
+      version.to_s.should == '2.0.0'
+    end
+    specify 'minor' do
+      version.increment(:minor)
+      version.to_s.should == '1.3.0'
+    end
+    specify 'patch' do
+      version.increment(:patch)
+      version.to_s.should == '1.2.4'
+    end
+  end
+
+  describe 'resetting pre and build' do
+    specify 'pre' do
+      version.pre = 'pre.2'
+      version.to_s.should == '1.2.3-pre.2+build.2'
+    end
+    specify 'build' do
+      version.build = 'build.99'
+      version.to_s.should == '1.2.3-pre.1+build.99'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require
+
+require_relative '../lib/semantic_versioning'
+
+def v(i)
+  SemanticVersioning::Version.new(i)
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: semantic_versioning
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joe Corcoran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: A utility for working with software version numbers as specified by Semantic
+  Versioning (http://semver.org/)
+email:
+- joecorcoran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/semantic_versioning/errors.rb
+- lib/semantic_versioning/gem_version.rb
+- lib/semantic_versioning/segment.rb
+- lib/semantic_versioning/version.rb
+- lib/semantic_versioning/version_set.rb
+- lib/semantic_versioning.rb
+- spec/semantic_versioning/version_set_spec.rb
+- spec/semantic_versioning/version_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/joecorcoran/semantic_versioning
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Ruby classes to represent versions and sorted sets of versions. No funny
+  business. Updated as the SemVer spec develops.
+test_files:
+- spec/semantic_versioning/version_set_spec.rb
+- spec/semantic_versioning/version_spec.rb
+- spec/spec_helper.rb