semantic 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Josh Lindsey
+
+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.md

@@ -0,0 +1,43 @@
+Semantic
+========
+
+A small Ruby utility class to aid in the storage, parsing, and comparison of SemVer-style Version strings.
+
+See [the SemVer site](http://semver.org) for more details.
+
+Usage
+-----
+
+This library exposes a single class – `Semantic::Version`. Simply pass in a valid SemVer string to
+the initializer.
+
+```ruby
+require 'semantic'
+
+version = Semantic::Version.new '1.6.5'
+version.major             # => 1
+version.minor             # => 6
+version.patch             # => 5
+
+newer_version = Semantic::Version.new '1.7.0'
+version > newer_version   # => false
+newer_version <=> version # => 1
+
+complex_version = Semantic::Version.new '3.7.9-pre.1+revision.15723'
+complex_version.pre       # => "pre.1"
+complex_version.build     # => "revision.15623"
+```
+
+There is also a set of core extensions as an optional require:
+
+```ruby
+require 'semantic'
+require 'semantic/core_ext'
+
+"1.8.7-pre.123".to_version
+```
+
+License
+-------
+Copyright (c) 2012 Josh Lindsey. See LICENSE for details.
+

data/lib/semantic.rb

@@ -0,0 +1,5 @@
+module Semantic
+  GEM_VERSION = '1.0.0'
+  autoload :Version, 'semantic/version'
+end
+

data/lib/semantic/core_ext.rb

@@ -0,0 +1,5 @@
+class String
+  def to_version
+    Semantic::Version.new self
+  end
+end

data/lib/semantic/version.rb

@@ -0,0 +1,85 @@
+# See: http://semver.org
+class Semantic::Version
+  SemVerRegexp = /^(\d+\.\d+\.\d+)(-([0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*))?(\+([0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*))?$/
+  attr_accessor :major, :minor, :patch, :pre, :build
+
+  def initialize version_str
+    raise ArgumentError.new("Not a valid SemVer Version (http://semver.org)") unless version_str =~ SemVerRegexp
+
+    version, parts = version_str.split '-'
+    if not parts.nil? and parts.include? '+'
+      @pre, @build = parts.split '+'
+    elsif version.include? '+'
+      version, @build = version.split '+'
+    else
+      @pre = parts
+    end
+
+
+    @major, @minor, @patch = version.split('.').map &:to_i
+  end
+
+  def to_a
+    [@major, @minor, @patch, @pre, @build]
+  end
+
+  def to_s
+    str = [@major, @minor, @patch].join '.'
+    str << '-' << @pre unless @pre.nil?
+    str << '+' << @build unless @build.nil?
+
+    str
+  end
+
+  def to_h
+    keys = [:major, :minor, :patch, :pre, :build]
+    Hash[keys.zip(self.to_a)]
+  end
+
+  alias to_hash to_h
+  alias to_array to_a
+  alias to_string to_s
+
+  def <=> other_version
+    other_version = Version.new(other_version) if other_version.is_a? String
+    compare_recursively self.to_a.dup, other_version.to_a.dup
+  end
+
+  def > other_version
+    if (self <=> other_version) == 1 then true else false end
+  end
+
+  def < other_version
+    if (self <=> other_version) == -1 then true else false end
+  end
+
+  private
+
+  def compare_recursively ary1, ary2
+    # Short-circuit the recursion entirely if they're just equal
+    return 0 if ary1 == ary2
+
+    a = ary1.shift; b = ary2.shift
+
+    # Reached the end of the arrays, equal all the way down
+    return 0 if a.nil? and b.nil?
+
+    # Mismatched types (ie. one has a build and the other doesn't)
+    if a.nil? and not b.nil?
+      return -1
+    elsif not a.nil? and b.nil?
+      return 1
+    end
+
+    # Less or greater than
+    if a > b
+      return 1
+    elsif a < b
+      return -1
+    end
+
+    # Recurse down to the next part if equal
+    compare_recursively ary1, ary2
+  end
+end
+

data/spec/core_ext_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'semantic/core_ext'
+
+describe 'Core Extensions' do
+  context "String#to_version" do
+    before(:each) do
+      @test_versions = [
+        '1.0.0',
+        '12.45.182',
+        '0.0.1-pre.1',
+        '1.0.1-pre.5+build.123.5',
+        '1.1.1+123',
+        '0.0.0+hello',
+        '1.2.3-1'
+      ]
+
+      @bad_versions = [
+        'a.b.c',
+        '1.a.3',
+        'a.3.4',
+        '5.2.a',
+        'pre3-1.5.3'
+      ]
+    end
+
+    it "extends String with a #to_version method" do
+      String.new.should respond_to(:to_version)
+    end
+
+    it "converts the String into a Version object" do
+      @test_versions.each do |v|
+        expect { v.to_version }.to_not raise_error(ArgumentError)
+        v.to_version.should be_a(Semantic::Version)
+      end
+    end
+
+    it "raises an error on invalid strings" do
+      @bad_versions.each do |v|
+        expect { v.to_version }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  require 'semantic'
+
+  config.mock_framework = :rspec
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/version_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Semantic::Version do
+  before(:each) do
+    @test_versions = [
+      '1.0.0',
+      '12.45.182',
+      '0.0.1-pre.1',
+      '1.0.1-pre.5+build.123.5',
+      '1.1.1+123',
+      '0.0.0+hello',
+      '1.2.3-1'
+    ]
+
+    @bad_versions = [
+      'a.b.c',
+      '1.a.3',
+      'a.3.4',
+      '5.2.a',
+      'pre3-1.5.3'
+    ]
+  end
+
+  context "parsing" do
+    it "parses valid SemVer versions" do
+      @test_versions.each do |v|
+        expect { Semantic::Version.new v }.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "raises an error on invalid versions" do
+      @bad_versions.each do |v|
+        expect { Semantic::Version.new v }.to raise_error(ArgumentError)
+      end
+    end
+
+    it "stores parsed versions in member variables" do
+      v1 = Semantic::Version.new '1.5.9'
+      v1.major.should == 1
+      v1.minor.should == 5
+      v1.patch.should == 9
+      v1.pre.should be_nil
+      v1.build.should be_nil
+
+      v2 = Semantic::Version.new '0.0.1-pre.1'
+      v2.major.should == 0
+      v2.minor.should == 0
+      v2.patch.should == 1
+      v2.pre.should == 'pre.1'
+      v2.build.should be_nil
+
+      v3 = Semantic::Version.new '1.0.1-pre.5+build.123.5'
+      v3.major.should == 1
+      v3.minor.should == 0
+      v3.patch.should == 1
+      v3.pre.should == 'pre.5'
+      v3.build.should == 'build.123.5'
+
+      v4 = Semantic::Version.new '0.0.0+hello'
+      v4.major.should == 0
+      v4.minor.should == 0
+      v4.patch.should == 0
+      v4.pre.should be_nil
+      v4.build.should == 'hello'
+    end
+  end
+
+  context "comparisons" do
+    before(:each) do
+      @v1 = Semantic::Version.new '1.5.9'
+      @v2 = Semantic::Version.new '1.6.0'
+      @v3 = Semantic::Version.new '1.5.9-pre.1'
+      @v4 = Semantic::Version.new '1.5.9-pre.1+build.5127'
+    end
+
+    it "determines sort order" do
+      (@v1 <=> @v2).should == -1
+      (@v3 <=> @v1).should == 1
+      (@v3 <=> @v4).should == -1
+      (@v4 <=> @v4).should == 0
+      (@v4 <=> @v1).should == 1
+
+      [@v3, @v1, @v2, @v4].sort.should == [@v1, @v3, @v4, @v2]
+    end
+
+    it "determines whether it is greater than another instance" do
+      @v1.should_not > @v2
+      @v4.should > @v3
+      @v2.should > @v4
+      @v3.should_not > @v4
+    end
+
+    it "determines whether it is less than another insance" do
+      @v1.should < @v2
+      @v2.should_not < @v4
+      @v4.should < @v2
+      @v3.should < @v4
+    end
+  end
+
+  context "type coercions" do
+    it "converts to a string" do
+      @test_versions.each do |v|
+        Semantic::Version.new(v).to_s.should == v
+      end
+    end
+
+    it "converts to an array" do
+      Semantic::Version.new('1.0.0').to_a.should == [1, 0, 0, nil, nil]
+      Semantic::Version.new('6.1.4-pre.5').to_a.should == [6, 1, 4, 'pre.5', nil]
+      Semantic::Version.new('91.6.0+build.17').to_a.should == [91, 6, 0, nil, 'build.17']
+      Semantic::Version.new('0.1.5-pre.7+build191').to_a.should == [0, 1, 5, 'pre.7', 'build191']
+    end
+
+    it "converts to a hash" do
+      Semantic::Version.new('1.0.0').to_h.should == { major: 1, minor: 0, patch: 0, pre: nil, build: nil }
+      Semantic::Version.new('6.1.4-pre.5').to_h.should == { major: 6, minor: 1, patch: 4, pre: 'pre.5', build: nil }
+      Semantic::Version.new('91.6.0+build.17').to_h.should == { major: 91, minor: 6, patch: 0, pre: nil, build: 'build.17' }
+      Semantic::Version.new('0.1.5-pre.7+build191').to_h.should == { major: 0, minor: 1, patch: 5, pre: 'pre.7', build: 'build191' }
+    end
+
+    it "aliases conversion methods" do
+      v = Semantic::Version.new('0.0.0')
+      [:to_hash, :to_array, :to_string].each { |sym| v.should respond_to(sym) }
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: semantic
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Lindsey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: ! 'Semantic Version utility class for parsing, storing, and comparing
+  versions. See: http://semver.org'
+email:
+- josh@core-apps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/semantic/core_ext.rb
+- lib/semantic/version.rb
+- lib/semantic.rb
+- LICENSE
+- README.md
+- spec/core_ext_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+homepage: https://github.com/jlindsey/semantic
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Semantic Version utility class
+test_files:
+- spec/core_ext_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+has_rdoc: