semantic 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc5eebf14efcd2b4befcb8ba52e60629e76b445b
-  data.tar.gz: 9ca2d53ad91425837e2c6f7741fe1226014b397f
+  metadata.gz: 587cd43a2f134032a864c84337c0207c3e8e495d
+  data.tar.gz: c7d7e9475f392a1c57b2567fa89b021edd5b4c73
 SHA512:
-  metadata.gz: 8942617c71dcd13bff01cd7d62f21b7aab644e15938f0c946feadd2c010b8cc9f92a4f98f38af4d26dc6d5f0c4b7e1f76cf3f9e0a4598ef1dc8b2cfd45ed257f
-  data.tar.gz: 4232989b6434c546b6ab358a78f14e9c8dd65e59ed49cf1fe15b178a131bbff3687a7290df2fbe4d252c5ba0430762b00cbac4bd4dc8ecc7c80fbf2c39425495
+  metadata.gz: f1f6fa899e311d1bc4de8d82271e30621cdc16cd65224dcc6c3b690564d9471a6c02ce89800f5aeed23d49efeccf9ae2ccef80abbcff0325587387a0d4dc47f9
+  data.tar.gz: cce04f83bb307dfc73f65968c3d73aaf1420963c1bac84e3964460ea4adb7f25857ce10ba78e4ac540542a35444b17715be7cd873e244a99aec9a3825432044c

data/README.md

@@ -39,5 +39,5 @@ require 'semantic/core_ext'
 
 License
 -------
-Copyright (c) 2012 Josh Lindsey. See LICENSE for details.
+Copyright (c) 2012 Josh Lindsey. See [LICENSE](LICENSE) for details.
 

data/lib/semantic/version.rb

@@ -1,97 +1,108 @@
 # 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
+module Semantic
+  class 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("#{version_str} is not a valid SemVer Version (http://semver.org)") unless version_str =~ SemVerRegexp
 
-    @major, @minor, @patch = version.split('.').map &:to_i
-  end
+      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
 
-  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?
+      @major, @minor, @patch = version.split('.').map &:to_i
+    end
 
-    str
-  end
+    def to_a
+      [@major, @minor, @patch, @pre, @build]
+    end
 
-  def to_h
-    keys = [:major, :minor, :patch, :pre, :build]
-    Hash[keys.zip(self.to_a)]
-  end
+    def to_s
+      str = [@major, @minor, @patch].join '.'
+      str << '-' << @pre unless @pre.nil?
+      str << '+' << @build unless @build.nil?
 
-  alias to_hash to_h
-  alias to_array to_a
-  alias to_string to_s
+      str
+    end
 
-  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 to_h
+      keys = [:major, :minor, :patch, :pre, :build]
+      Hash[keys.zip(self.to_a)]
+    end
 
-  def > other_version
-    if (self <=> other_version) == 1 then true else false end
-  end
+    alias to_hash to_h
+    alias to_array to_a
+    alias to_string to_s
 
-  def < other_version
-    if (self <=> other_version) == -1 then true else false end
-  end
+    def <=> other_version
+      other_version = Version.new(other_version) if other_version.is_a? String
 
-  def >= other_version
-    if (self <=> other_version) >= 0 then true else false end
-  end
+      v1 = self.dup
+      v2 = other_version.dup
 
-  def <= other_version
-    if (self <=> other_version) <= 0 then true else false end
-  end
+      # The build must be excluded from the comparison, so that e.g. 1.2.3+foo and 1.2.3+bar are semantically equal.
+      # "Build metadata SHOULD be ignored when determining version precedence".
+      # (SemVer 2.0.0-rc.2, paragraph 10 - http://www.semver.org)
+      v1.build = nil
+      v2.build = nil
 
-  def == other_version
-    if (self <=> other_version) == 0 then true else false end
-  end
-
-  private
+      compare_recursively(v1.to_a, v2.to_a)
+    end
 
-  def compare_recursively ary1, ary2
-    # Short-circuit the recursion entirely if they're just equal
-    return 0 if ary1 == ary2
+    def > other_version
+      (self <=> other_version) == 1
+    end
 
-    a = ary1.shift; b = ary2.shift
+    def < other_version
+      (self <=> other_version) == -1
+    end
 
-    # Reached the end of the arrays, equal all the way down
-    return 0 if a.nil? and b.nil?
+    def >= other_version
+      (self <=> other_version) >= 0
+    end
 
-    # 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
+    def <= other_version
+      (self <=> other_version) <= 0
     end
 
-    # Less or greater than
-    if a > b
-      return 1
-    elsif a < b
-      return -1
+    def == other_version
+      (self <=> other_version) == 0
     end
 
-    # Recurse down to the next part if equal
-    compare_recursively ary1, ary2
+    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 pre and the other doesn't)
+      if a.nil? and not b.nil?
+        return 1
+      elsif not a.nil? and b.nil?
+        return -1
+      end
+
+      if a < b
+        return -1
+      elsif a > b
+        return 1
+      end
+
+      # Versions are equal thus far, so recurse down to the next part.
+      compare_recursively ary1, ary2
+    end
   end
 end
 

data/lib/semantic.rb

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

data/spec/version_spec.rb

@@ -67,53 +67,83 @@ describe Semantic::Version do
 
   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'
+      # These three are all semantically equivalent, according to the spec.
+      @v1_5_9_pre_1 = Semantic::Version.new '1.5.9-pre.1'
+      @v1_5_9_pre_1_build_5127 = Semantic::Version.new '1.5.9-pre.1+build.5127'
+      @v1_5_9_pre_1_build_4352 = Semantic::Version.new '1.5.9-pre.1+build.4352'
+
+      @v1_5_9 = Semantic::Version.new '1.5.9'
+      @v1_6_0 = Semantic::Version.new '1.6.0'
     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
+      # The second parameter here can be a string, so we want to ensure that this kind of comparison works also.
+      (@v1_5_9_pre_1 <=> @v1_5_9_pre_1.to_s).should == 0
+
+      (@v1_5_9_pre_1 <=> @v1_5_9_pre_1_build_5127).should == 0
+      (@v1_5_9_pre_1 <=> @v1_5_9).should == -1
+      (@v1_5_9_pre_1_build_5127 <=> @v1_5_9).should == -1
+
+      @v1_5_9_pre_1_build_5127.build.should == 'build.5127'
 
-      [@v3, @v1, @v2, @v4].sort.should == [@v1, @v3, @v4, @v2]
+      (@v1_5_9 <=> @v1_5_9).should == 0
+
+      (@v1_5_9 <=> @v1_6_0).should == -1
+      (@v1_6_0 <=> @v1_5_9).should == 1
+      (@v1_6_0 <=> @v1_5_9_pre_1).should == 1
+      (@v1_5_9_pre_1 <=> @v1_6_0).should == -1
+
+      [@v1_5_9_pre_1, @v1_5_9_pre_1_build_5127, @v1_5_9, @v1_6_0]
+        .reverse
+        .sort
+        .should == [@v1_5_9_pre_1, @v1_5_9_pre_1_build_5127, @v1_5_9, @v1_6_0]
     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
+      # These should be equal, since "Build metadata SHOULD be ignored when determining version precedence".
+      # (SemVer 2.0.0-rc.2, paragraph 10 - http://www.semver.org)
+      @v1_5_9_pre_1.should_not > @v1_5_9_pre_1_build_5127
+      @v1_5_9_pre_1.should_not < @v1_5_9_pre_1_build_5127
+
+      @v1_6_0.should > @v1_5_9
+      @v1_5_9.should_not > @v1_6_0
+      @v1_5_9.should > @v1_5_9_pre_1_build_5127
+      @v1_5_9.should > @v1_5_9_pre_1
     end
 
-    it "determines whether it is less than another insance" do
-      @v1.should < @v2
-      @v2.should_not < @v4
-      @v4.should < @v2
-      @v3.should < @v4
+    it "determines whether it is less than another instance" do
+      @v1_5_9_pre_1.should_not < @v1_5_9_pre_1_build_5127
+      @v1_5_9_pre_1_build_5127.should_not < @v1_5_9_pre_1
+      @v1_5_9_pre_1.should < @v1_5_9
+      @v1_5_9_pre_1.should < @v1_6_0
+      @v1_5_9_pre_1_build_5127.should < @v1_6_0
+      @v1_5_9.should < @v1_6_0
     end
 
     it "determines whether it is greater than or equal to another instance" do
-      @v1.should >= @v1
-      @v1.should_not >= @v2
-      @v4.should >= @v3
-      @v2.should >= @v4
+      @v1_5_9_pre_1.should >= @v1_5_9_pre_1
+      @v1_5_9_pre_1.should >= @v1_5_9_pre_1_build_5127
+      @v1_5_9_pre_1_build_5127.should >= @v1_5_9_pre_1
+      @v1_5_9.should >= @v1_5_9_pre_1
+      @v1_6_0.should >= @v1_5_9
+      @v1_5_9_pre_1_build_5127.should_not >= @v1_6_0
     end
 
     it "determines whether it is less than or equal to another instance" do
-      @v1.should <= @v2
-      @v4.should_not <= $v3
-      @v2.should <= @v2
-      @v3.should_not <= @v1
+      @v1_5_9_pre_1.should <= @v1_5_9_pre_1_build_5127
+      @v1_6_0.should_not <= @v1_5_9
+      @v1_5_9_pre_1_build_5127.should <= @v1_5_9_pre_1_build_5127
+      @v1_5_9.should_not <= @v1_5_9_pre_1
     end
 
-    it "determines whether it is exactly equal to another instance" do
-      @v1.should == @v1.dup
-      @v2.should == @v2.dup
+    it "determines whether it is semantically equal to another instance" do
+      @v1_5_9_pre_1.should == @v1_5_9_pre_1.dup
+      @v1_5_9_pre_1_build_5127.should == @v1_5_9_pre_1_build_5127.dup
+
+      # "Semantically equal" is the keyword here; these are by definition not "equal" (different build), but should be treated as
+      # equal according to the spec.
+      @v1_5_9_pre_1_build_4352.should == @v1_5_9_pre_1_build_5127
+      @v1_5_9_pre_1_build_4352.should == @v1_5_9_pre_1
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Josh Lindsey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -82,3 +82,4 @@ test_files:
 - spec/core_ext_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
+has_rdoc: