mixlib-versioning 1.0.0

data/spec/mixlib/versioning/format/opscode_semver_spec.rb

@@ -0,0 +1,113 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe Mixlib::Versioning::Format::OpscodeSemVer do
+
+  subject{ described_class.new(version_string) }
+
+  it_should_behave_like Mixlib::Versioning::Format::SemVer
+
+  it_has_behavior "rejects invalid version strings", {
+    "1.0.0-poop.0" => "non-valid pre-release type",
+    "1.0.0+2010AA08010101" => "a malformed timestamp",
+    "1.0.0+cvs.33.e0f985a" => "a malformed git describe: no git string",
+    "1.0.0+git.AA.e0f985a" => "a malformed git describe: non-numeric COMMITS_SINCE",
+    "1.0.0+git.33.z0f985a" => "a malformed git describe: invalid SHA1"
+  }
+
+  it_has_behavior "serializable", [
+    "1.0.0",
+    "1.0.0-alpha.1",
+    "1.0.0-alpha.1+20130308110833",
+    "1.0.0+20130308110833.git.2.94a1dde"
+  ]
+
+  it_has_behavior "sortable" do
+    let(:unsorted_version_strings){%w{
+      1.0.0-beta.2
+      1.0.0-alpha
+      1.0.0-rc.1+20130309074433
+      1.0.0
+      1.0.0-beta.11
+      1.0.0+20121009074433
+      1.0.0-rc.1
+      1.0.0-alpha.1
+      1.3.7+20131009104433.git.2.94a1dde
+      1.3.7+20131009104433
+      1.3.7+20131009074433
+    }}
+    let(:sorted_version_strings){%w{
+      1.0.0-alpha
+      1.0.0-alpha.1
+      1.0.0-beta.2
+      1.0.0-beta.11
+      1.0.0-rc.1
+      1.0.0-rc.1+20130309074433
+      1.0.0
+      1.0.0+20121009074433
+      1.3.7+20131009074433
+      1.3.7+20131009104433
+      1.3.7+20131009104433.git.2.94a1dde
+    }}
+    let(:min){ "1.0.0-alpha" }
+    let(:max){ "1.3.7+20131009104433.git.2.94a1dde" }
+  end # it_has_behavior
+
+  it_has_behavior "filterable" do
+    let(:unsorted_version_strings){%w{
+      1.0.0-beta.2
+      1.0.0-alpha
+      1.0.0-rc.1+20130309074433
+      1.0.0
+      1.0.0-beta.11
+      1.0.0+20121009074433
+      1.0.0-rc.1
+      1.0.0-alpha.1
+      1.3.7+20131009104433.git.2.94a1dde
+      1.3.7+20131009104433
+      1.3.7+20131009074433
+    }}
+    let(:release_versions){%w{ 1.0.0 }}
+    let(:prerelease_versions){%w{
+      1.0.0-beta.2
+      1.0.0-alpha
+      1.0.0-beta.11
+      1.0.0-rc.1
+      1.0.0-alpha.1
+    }}
+    let(:build_versions){%w{
+      1.0.0-rc.1+20130309074433
+      1.0.0+20121009074433
+      1.3.7+20131009104433.git.2.94a1dde
+      1.3.7+20131009104433
+      1.3.7+20131009074433
+    }}
+    let(:release_build_versions){%w{
+      1.0.0+20121009074433
+      1.3.7+20131009104433.git.2.94a1dde
+      1.3.7+20131009104433
+      1.3.7+20131009074433
+    }}
+    let(:prerelease_build_versions){%w{
+      1.0.0-rc.1+20130309074433
+    }}
+  end # it_has_behavior
+
+end # describe

data/spec/mixlib/versioning/format/rubygems_spec.rb

@@ -0,0 +1,142 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe Mixlib::Versioning::Format::Rubygems do
+
+  subject{ described_class.new(version_string) }
+
+  it_should_behave_like "Basic SemVer"
+
+  it_has_behavior "parses valid version strings", {
+    "10.1.1" => {
+      :major => 10,
+      :minor => 1,
+      :patch => 1,
+      :prerelease => nil,
+      :build => nil,
+      :release? => true,
+      :prerelease? => false,
+      :build? => false,
+      :release_build? => false,
+      :prerelease_build? => false,
+      :iteration => 0
+    },
+    "10.1.1.alpha.1" => {
+      :major => 10,
+      :minor => 1,
+      :patch => 1,
+      :prerelease => "alpha.1",
+      :build => nil,
+      :release? => false,
+      :prerelease? => true,
+      :build? => false,
+      :release_build? => false,
+      :prerelease_build? => false,
+      :iteration => 0
+    },
+    "11.0.8.rc.3" => {
+      :major => 11,
+      :minor => 0,
+      :patch => 8,
+      :prerelease => "rc.3",
+      :build => nil,
+      :release? => false,
+      :prerelease? => true,
+      :build? => false,
+      :release_build? => false,
+      :prerelease_build? => false,
+      :iteration => 0
+    },
+    "11.0.8-33" => {
+      :major => 11,
+      :minor => 0,
+      :patch => 8,
+      :prerelease => nil,
+      :build => nil,
+      :release? => true,
+      :prerelease? => false,
+      :build? => false,
+      :release_build? => false,
+      :prerelease_build? => false,
+      :iteration => 33
+    },
+    "11.0.8.rc.3-1" => {
+      :major => 11,
+      :minor => 0,
+      :patch => 8,
+      :prerelease => "rc.3",
+      :build => nil,
+      :release? => false,
+      :prerelease? => true,
+      :build? => false,
+      :release_build? => false,
+      :prerelease_build? => false,
+      :iteration => 1
+    }
+  }
+
+  it_has_behavior "rejects invalid version strings", {
+    "1.1.1-rutro" => "dash for pre-release delimeter"
+  }
+
+  it_has_behavior "serializable", [
+    "1.0.0",
+    "1.0.0.alpha.1",
+    "1.0.0.beta"
+  ]
+
+  it_has_behavior "sortable" do
+    let(:unsorted_version_strings){%w{
+      1.0.0.beta.2
+      1.3.7.alpha.0
+      1.0.0.alpha
+      1.0.0.rc.1
+      1.0.0
+    }}
+    let(:sorted_version_strings){%w{
+      1.0.0.alpha
+      1.0.0.beta.2
+      1.0.0.rc.1
+      1.0.0
+      1.3.7.alpha.0
+    }}
+    let(:min){ "1.0.0.alpha" }
+    let(:max){ "1.3.7.alpha.0" }
+  end
+
+  # The +Rubygems+ format only produces release and prerelease versions.
+  it_has_behavior "filterable" do
+    let(:unsorted_version_strings){%w{
+      1.0.0.beta.2
+      1.3.7.alpha.0
+      1.0.0.alpha
+      1.0.0.rc.1
+      1.0.0
+    }}
+    let(:release_versions){%w{ 1.0.0 }}
+    let(:prerelease_versions){%w{
+      1.0.0.beta.2
+      1.3.7.alpha.0
+      1.0.0.alpha
+      1.0.0.rc.1
+    }}
+  end
+
+end

data/spec/mixlib/versioning/format/semver_spec.rb

@@ -0,0 +1,107 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe Mixlib::Versioning::Format::SemVer do
+
+  subject{ described_class.new(version_string) }
+
+  it_should_behave_like Mixlib::Versioning::Format::SemVer
+
+  it_has_behavior "serializable", [
+    "1.0.0",
+    "1.0.0-alpha.1",
+    "1.0.0-alpha.1+some.build.version",
+    "1.0.0+build.build.build"
+  ]
+
+  it_has_behavior "sortable" do
+    let(:unsorted_version_strings){%w{
+      1.0.0-beta.2
+      1.0.0-alpha
+      1.0.0-rc.1+build.1
+      1.0.0
+      1.0.0-beta.11
+      1.0.0+0.3.7
+      1.0.0-rc.1
+      1.0.0-alpha.1
+      1.3.7+build.2.b8f12d7
+      1.3.7+build.11.e0f985a
+      1.3.7+build
+    }}
+    let(:sorted_version_strings){%w{
+      1.0.0-alpha
+      1.0.0-alpha.1
+      1.0.0-beta.2
+      1.0.0-beta.11
+      1.0.0-rc.1
+      1.0.0-rc.1+build.1
+      1.0.0
+      1.0.0+0.3.7
+      1.3.7+build
+      1.3.7+build.2.b8f12d7
+      1.3.7+build.11.e0f985a
+    }}
+    let(:min){ "1.0.0-alpha" }
+    let(:max){ "1.3.7+build.11.e0f985a" }
+  end # it_has_behavior
+
+  it_has_behavior "filterable" do
+    let(:unsorted_version_strings){%w{
+      1.0.0-beta.2
+      1.0.0-alpha
+      1.0.0-rc.1+build.1
+      1.0.0
+      1.0.0-beta.11
+      1.0.0+0.3.7
+      1.0.0-rc.1
+      1.0.0-alpha.1
+      1.3.7+build.2.b8f12d7
+      1.3.7+build.11.e0f985a
+      1.3.7+build
+    }}
+    let(:release_versions){%w{
+      1.0.0
+    }}
+    let(:prerelease_versions){%w{
+      1.0.0-beta.2
+      1.0.0-alpha
+      1.0.0-beta.11
+      1.0.0-rc.1
+      1.0.0-alpha.1
+    }}
+    let(:build_versions){%w{
+      1.0.0-rc.1+build.1
+      1.0.0+0.3.7
+      1.3.7+build.2.b8f12d7
+      1.3.7+build.11.e0f985a
+      1.3.7+build
+    }}
+    let(:release_build_versions){%w{
+      1.0.0+0.3.7
+      1.3.7+build.2.b8f12d7
+      1.3.7+build.11.e0f985a
+      1.3.7+build
+    }}
+    let(:prerelease_build_versions){%w{
+      1.0.0-rc.1+build.1
+    }}
+  end # it_has_behavior
+
+end # describe

data/spec/mixlib/versioning/format_spec.rb

@@ -0,0 +1,69 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe Mixlib::Versioning::Format do
+
+  describe "#initialize" do
+    subject{ described_class.new(version_string) }
+    let(:version_string) { "11.0.0" }
+
+    it "descendants must override #parse" do
+      expect { subject }.to raise_error
+    end
+  end
+
+  describe ".for" do
+
+    subject{ described_class }
+
+    [
+      :rubygems,
+      "rubygems",
+      Mixlib::Versioning::Format::Rubygems
+    ].each do |format_type|
+
+      context "format_type is a: #{format_type.class}" do
+        let(:format_type){ format_type }
+        it "returns the correct format class" do
+          subject.for(format_type).should eq Mixlib::Versioning::Format::Rubygems
+        end # it
+      end # context
+
+    end # each
+
+    describe "unknown format_type" do
+      [
+        :poop,
+        "poop",
+        Mixlib::Versioning
+      ].each do |invalid_format_type|
+
+        context "format_type is a: #{invalid_format_type.class}" do
+          it "raises a Mixlib::Versioning::UnknownFormatError" do
+            expect { subject.for(invalid_format_type) }.to raise_error(Mixlib::Versioning::UnknownFormatError)
+          end # it
+        end # context
+
+      end # each
+    end # describe
+
+  end # describe ".for"
+
+end # describe Mixlib::Versioning::Format

data/spec/mixlib/versioning/versioning_spec.rb

@@ -0,0 +1,259 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe Mixlib::Versioning do
+
+  subject{ described_class }
+
+  let(:version_string){ "11.0.0" }
+
+  describe ".parse" do
+
+    describe "parsing when format type is specified" do
+      {
+        "11.0.8" => {
+          :format_type => :semver,
+          :expected_format => Mixlib::Versioning::Format::SemVer
+        },
+        "11.1.1" => {
+          :format_type => :rubygems,
+          :expected_format => Mixlib::Versioning::Format::Rubygems
+        },
+        "11.1.1.alpha.1" => {
+          :format_type => :rubygems,
+          :expected_format => Mixlib::Versioning::Format::Rubygems
+        },
+        "11.1.1-alpha.1" => {
+          :format_type => :opscode_semver,
+          :expected_format => Mixlib::Versioning::Format::OpscodeSemVer
+        },
+        "11.1.1-rc.2" => {
+          :format_type => :opscode_semver,
+          :expected_format => Mixlib::Versioning::Format::SemVer
+        }
+      }.each_pair do |version_string, options|
+
+        context "#{version_string} as #{options[:expected_format]}" do
+          let(:version_string){ version_string }
+          let(:expected_format){ options[:expected_format] }
+
+          [
+            options[:format_type],
+            options[:format_type].to_s,
+            options[:expected_format]
+          ].each do |format_type|
+
+            context "format type as a: #{format_type.class}" do
+              it "parses version string as: #{options[:expected_format]}" do
+                result = subject.parse(version_string, format_type)
+                result.should be_a(expected_format)
+              end # it
+            end # context
+
+          end # each
+        end # context
+      end # each_pair
+
+
+      describe "invalid format type specified" do
+        [
+          :poop,
+          "poop",
+          Mixlib::Versioning
+        ].each do |invalid_format_type|
+
+          context "invalid format as a: #{invalid_format_type.class}" do
+            it "raises a Mixlib::Versioning::UnknownFormatError" do
+              expect { subject.parse(version_string, invalid_format_type) }.to raise_error(Mixlib::Versioning::UnknownFormatError)
+            end # it
+          end # context
+
+        end # each
+
+      end # describe
+    end # describe
+
+    describe "parsing with automatic format detection" do
+      {
+        "11.0.8" => Mixlib::Versioning::Format::SemVer,
+        "11.0.8-1" => Mixlib::Versioning::Format::SemVer,
+        "11.0.8.rc.1" => Mixlib::Versioning::Format::Rubygems,
+        "11.0.8.rc.1-1" => Mixlib::Versioning::Format::Rubygems,
+        "11.0.8-rc.1" => Mixlib::Versioning::Format::OpscodeSemVer,
+
+        "10.18.2" => Mixlib::Versioning::Format::SemVer,
+        "10.18.2-poop" => Mixlib::Versioning::Format::SemVer,
+        "10.18.2.poop" => Mixlib::Versioning::Format::Rubygems,
+        "10.18.2.poop-1" => Mixlib::Versioning::Format::Rubygems,
+
+        "12.1.1+20130311134422" => Mixlib::Versioning::Format::OpscodeSemVer,
+        "12.1.1-rc.3+20130311134422" => Mixlib::Versioning::Format::OpscodeSemVer,
+        "12.1.1+20130308110833.git.2.94a1dde" => Mixlib::Versioning::Format::OpscodeSemVer,
+
+        "10.16.2-49-g21353f0" => Mixlib::Versioning::Format::GitDescribe,
+        "10.16.2-49-g21353f0-1" => Mixlib::Versioning::Format::GitDescribe,
+        "10.16.2.rc.2-49-g21353f0" => Mixlib::Versioning::Format::GitDescribe,
+        "10.16.2-rc.2-49-g21353f0" => Mixlib::Versioning::Format::GitDescribe,
+      }.each_pair do |version_string, expected_format|
+
+        context version_string do
+          let(:version_string){ version_string }
+          it "parses version string as: #{expected_format}" do
+            subject.parse(version_string).should be_a(expected_format)
+          end # it
+        end # context
+
+      end # each_pair
+
+      describe "version_string cannot be parsed" do
+        let(:version_string){ "A.B.C" }
+        it "returns nil" do
+          subject.parse(version_string).should be_nil
+        end
+      end
+
+    end # describe "parsing with automatic format detection"
+
+    describe "parsing an Mixlib::Versioning::Format object" do
+      it "returns the same object" do
+        v = Mixlib::Versioning.parse(version_string)
+        result = subject.parse(v)
+        v.should be result
+      end
+    end
+
+  end # describe .parse
+
+  describe ".find_target_version" do
+    let(:all_versions){%w{
+      11.0.0-beta.1
+      11.0.0-rc.1
+      11.0.0
+      11.0.1
+      11.0.1+2013031116332
+      11.0.2-alpha.0
+      11.0.2-alpha.0+2013041116332
+      11.0.2
+    }}
+    let(:filter_version){ nil }
+    let(:use_prerelease_versions){ false }
+    let(:use_build_versions){ false }
+    let(:subject_find) do
+      subject.find_target_version(all_versions,
+                                  filter_version,
+                                  use_prerelease_versions,
+                                  use_build_versions)
+    end
+
+    {
+      nil => {
+        :releases_only => "11.0.2",
+        :prerelease_versions => "11.0.2-alpha.0",
+        :build_versions => "11.0.1+2013031116332",
+        :prerelease_and_build_versions => "11.0.2-alpha.0+2013041116332"
+      },
+      "11.0.0" => {
+        :releases_only => "11.0.0",
+        :prerelease_versions => "11.0.0-rc.1",
+        :build_versions => nil,
+        :prerelease_and_build_versions => nil
+      },
+      "11.0.2" => {
+        :releases_only => "11.0.2",
+        :prerelease_versions => "11.0.2-alpha.0",
+        :build_versions => nil,
+        :prerelease_and_build_versions => "11.0.2-alpha.0+2013041116332"
+      },
+      "11.0.2" => {
+        :releases_only => "11.0.2",
+        :prerelease_versions => "11.0.2-alpha.0",
+        :build_versions => nil,
+        :prerelease_and_build_versions => "11.0.2-alpha.0+2013041116332"
+      },
+      "11.0.2-alpha.0" => {
+        :releases_only => "11.0.2-alpha.0",
+        :prerelease_versions => "11.0.2-alpha.0",
+        :build_versions => "11.0.2-alpha.0+2013041116332",
+        :prerelease_and_build_versions => "11.0.2-alpha.0+2013041116332"
+      }
+    }.each_pair do |filter_version, options|
+
+      context "filter version of: #{filter_version}" do
+        let(:filter_version){ filter_version }
+        let(:expected_version){ options[:releases_only] }
+
+        it "finds the most recent release version" do
+          subject_find.should eq Mixlib::Versioning.parse(expected_version)
+        end
+
+        context "include pre-release versions" do
+          let(:use_prerelease_versions){ true }
+          let(:expected_version){ options[:prerelease_versions] }
+
+          it "finds the most recent pre-release version" do
+            subject_find.should eq Mixlib::Versioning.parse(expected_version)
+          end # it
+        end # context
+
+        context "include build versions" do
+          let(:use_build_versions){ true }
+          let(:expected_version){ options[:build_versions] }
+
+          it "finds the most recent build version" do
+            subject_find.should eq Mixlib::Versioning.parse(expected_version)
+          end # it
+        end # context
+
+        context "include pre-release and build versions" do
+          let(:use_prerelease_versions){ true }
+          let(:use_build_versions){ true }
+          let(:expected_version){ options[:prerelease_and_build_versions] }
+
+          it "finds the most recent pre-release build version" do
+            subject_find.should eq Mixlib::Versioning.parse(expected_version)
+          end # it
+        end # context
+
+      end # context
+    end # each_pair
+
+    describe "all_versions argument is a mix of String and Mixlib::Versioning::Format instances" do
+      let(:all_versions){[
+        "11.0.0-beta.1",
+        "11.0.0-rc.1",
+        Mixlib::Versioning.parse("11.0.0")
+      ]}
+
+      it "correctly parses the array" do
+        subject_find.should eq Mixlib::Versioning.parse("11.0.0")
+      end
+    end # describe
+
+    describe "filter_version argument is an instance of Mixlib::Versioning::Format" do
+      let(:filter_version){ Mixlib::Versioning::Format::SemVer.new("11.0.0") }
+
+      it "finds the correct version" do
+        subject_find.should eq Mixlib::Versioning.parse("11.0.0")
+      end
+    end
+
+  end # describe
+
+end # describe Mixlib::Versioning