mixlib-versioning 1.1.0 → 1.2.1

data/lib/mixlib/versioning/format/git_describe.rb

@@ -53,7 +53,7 @@ module Mixlib
           match = version_string.match(GIT_DESCRIBE_REGEX) rescue nil
 
           unless match
-            fail Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
+            raise Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
           end
 
           @major, @minor, @patch, @prerelease, @commits_since, @commit_sha, @iteration = match[1..7]

data/lib/mixlib/versioning/format/opscode_semver.rb

@@ -17,7 +17,7 @@
 # limitations under the License.
 #
 
-require 'mixlib/versioning/format/semver'
+require "mixlib/versioning/format/semver"
 
 module Mixlib
   class Versioning
@@ -71,8 +71,8 @@ module Mixlib
         def parse(version_string)
           super(version_string)
 
-          fail Mixlib::Versioning::ParseError, "'#{@prerelease}' is not a valid Opscode pre-release signifier!" unless @prerelease.nil? || @prerelease.match(OPSCODE_PRERELEASE_REGEX)
-          fail Mixlib::Versioning::ParseError, "'#{@build}' is not a valid Opscode build signifier!" unless @build.nil? || @build.match(OPSCODE_BUILD_REGEX)
+          raise Mixlib::Versioning::ParseError, "'#{@prerelease}' is not a valid Opscode pre-release signifier!" unless @prerelease.nil? || @prerelease.match(OPSCODE_PRERELEASE_REGEX)
+          raise Mixlib::Versioning::ParseError, "'#{@build}' is not a valid Opscode build signifier!" unless @build.nil? || @build.match(OPSCODE_BUILD_REGEX)
         end
       end # class OpscodeSemVer
     end # class Format

data/lib/mixlib/versioning/format/partial_semver.rb

@@ -0,0 +1,62 @@
+#
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Christopher Maier (<cm@chef.io>)
+# Author:: Ryan Hass (<rhass@chef.io>)
+# Copyright:: Copyright (c) 2017 Chef Software 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.
+#
+
+module Mixlib
+  class Versioning
+    class Format
+      # Handles partial version strings.
+      # -----------------
+      # ```text
+      # MAJOR
+      # MAJOR.MINOR
+      # ```
+      #
+      # EXAMPLES
+      # --------
+      # ```text
+      # 11
+      # 11.0
+      # ```
+      #
+      # @author Seth Chisamore (<schisamo@chef.io>)
+      # @author Christopher Maier (<cm@chef.io>)
+      # @author Ryan Hass (<rhass@chef.io>)
+      class PartialSemVer < Format
+        #  http://rubular.com/r/NmRSN8vCie
+        PARTIAL_REGEX = /^(\d+)\.?(?:(\d*))$/
+        # @see Format#parse
+        def parse(version_string)
+          match = version_string.match(PARTIAL_REGEX) rescue nil
+
+          unless match
+            raise Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
+          end
+
+          @major, @minor = match[1..2]
+          @major, @minor, @patch = [@major, @minor, @patch].map(&:to_i)
+
+          # Partial versions do not contain these values, so we just set them to nil.
+          @prerelease = nil
+          @build      = nil
+        end
+      end # class Partial
+    end # class Format
+  end # module Versioning
+end # module Mixlib

data/lib/mixlib/versioning/format/rubygems.rb

@@ -49,13 +49,19 @@ module Mixlib
           match = version_string.match(RUBYGEMS_REGEX) rescue nil
 
           unless match
-            fail Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
+            raise Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
           end
 
           @major, @minor, @patch, @prerelease, @iteration = match[1..5]
-          @major, @minor, @patch, @iteration = [@major, @minor, @patch, @iteration].map(&:to_i)
+          @major, @minor, @patch = [@major, @minor, @patch].map(&:to_i)
 
-          # Do not convert @build to an integer; SemVer sorting logic will handle the conversion
+          # Do not convert @prerelease or @iteration to an integer;
+          # sorting logic will handle the conversion.
+          @iteration = if @iteration.nil? || @iteration.empty?
+                         nil
+                       else
+                         @iteration.to_i
+                       end
           @prerelease = nil if @prerelease.nil? || @prerelease.empty?
         end
       end # class Rubygems

data/lib/mixlib/versioning/format/semver.rb

@@ -49,7 +49,7 @@ module Mixlib
           match = version_string.match(SEMVER_REGEX) rescue nil
 
           unless match
-            fail Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
+            raise Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
           end
 
           @major, @minor, @patch, @prerelease, @build = match[1..5]

data/lib/mixlib/versioning/version.rb

@@ -18,6 +18,6 @@
 
 module Mixlib
   class Versioning
-    VERSION = '1.1.0'
+    VERSION = "1.2.1"
   end
 end

data/mixlib-versioning.gemspec

@@ -1,28 +1,28 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mixlib/versioning/version'
+require "mixlib/versioning/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'mixlib-versioning'
+  spec.name          = "mixlib-versioning"
   spec.version       = Mixlib::Versioning::VERSION
-  spec.authors       = ['Seth Chisamore', 'Christopher Maier']
-  spec.email         = ['schisamo@chef.io', 'cm@chef.io']
-  spec.description   = 'General purpose Ruby library that allows you to parse, compare and manipulate version strings in multiple formats.'
+  spec.authors       = ["Seth Chisamore", "Christopher Maier"]
+  spec.email         = ["schisamo@chef.io", "cm@chef.io"]
+  spec.description   = "General purpose Ruby library that allows you to parse, compare and manipulate version strings in multiple formats."
   spec.summary       = spec.description
-  spec.homepage      = 'https://github.com/chef/mixlib-versioning'
-  spec.license       = 'Apache 2.0'
+  spec.homepage      = "https://github.com/chef/mixlib-versioning"
+  spec.license       = "Apache 2.0"
 
-  spec.required_ruby_version = '>= 1.9'
+  spec.required_ruby_version = ">= 2.2"
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
   # Development dependencies
-  spec.add_development_dependency 'rubocop', '= 0.31.0'
-  spec.add_development_dependency 'rspec',   '~> 2.14'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency "chefstyle"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rake", "~> 12"
 end

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

@@ -16,103 +16,103 @@
 # limitations under the License.
 #
 
-require 'spec_helper'
+require "spec_helper"
 
 describe Mixlib::Versioning::Format::GitDescribe do
   subject { described_class.new(version_string) }
 
-  it_has_behavior 'parses valid version strings', {
-    '0.10.8-231-g59d6185' => {
+  it_has_behavior "parses valid version strings", {
+    "0.10.8-231-g59d6185" => {
       major: 0,
       minor: 10,
       patch: 8,
       prerelease: nil,
-      build: '231.g59d6185.0',
+      build: "231.g59d6185.0",
       release?: false,
       prerelease?: false,
       build?: true,
       release_build?: true,
       prerelease_build?: false,
       commits_since: 231,
-      commit_sha: '59d6185',
+      commit_sha: "59d6185",
       iteration: 0,
     },
-    '10.16.2-49-g21353f0-1' => {
+    "10.16.2-49-g21353f0-1" => {
       major: 10,
       minor: 16,
       patch: 2,
       prerelease: nil,
-      build: '49.g21353f0.1',
+      build: "49.g21353f0.1",
       release?: false,
       prerelease?: false,
       build?: true,
       release_build?: true,
       prerelease_build?: false,
       commits_since: 49,
-      commit_sha: '21353f0',
+      commit_sha: "21353f0",
       iteration: 1,
     },
-    '10.16.2.rc.1-49-g21353f0-1' => {
+    "10.16.2.rc.1-49-g21353f0-1" => {
       major: 10,
       minor: 16,
       patch: 2,
-      prerelease: 'rc.1',
-      build: '49.g21353f0.1',
+      prerelease: "rc.1",
+      build: "49.g21353f0.1",
       release?: false,
       prerelease?: false,
       build?: true,
       release_build?: false,
       prerelease_build?: true,
       commits_since: 49,
-      commit_sha: '21353f0',
+      commit_sha: "21353f0",
       iteration: 1,
     },
-    '10.16.2-alpha-49-g21353f0-1' => {
+    "10.16.2-alpha-49-g21353f0-1" => {
       major: 10,
       minor: 16,
       patch: 2,
-      prerelease: 'alpha',
-      build: '49.g21353f0.1',
+      prerelease: "alpha",
+      build: "49.g21353f0.1",
       release?: false,
       prerelease?: false,
       build?: true,
       release_build?: false,
       prerelease_build?: true,
       commits_since: 49,
-      commit_sha: '21353f0',
+      commit_sha: "21353f0",
       iteration: 1,
     },
-    '10.16.2-alpha-49-g21353f0' => {
+    "10.16.2-alpha-49-g21353f0" => {
       major: 10,
       minor: 16,
       patch: 2,
-      prerelease: 'alpha',
-      build: '49.g21353f0.0',
+      prerelease: "alpha",
+      build: "49.g21353f0.0",
       release?: false,
       prerelease?: false,
       build?: true,
       release_build?: false,
       prerelease_build?: true,
       commits_since: 49,
-      commit_sha: '21353f0',
+      commit_sha: "21353f0",
       iteration: 0,
     },
   }
 
-  it_has_behavior 'rejects invalid version strings', {
-    '1.0.0' => 'no git describe data',
-    '1.0.0-alpha.1' => 'no git describe data',
-    '1.0.0-alpha.1+build.deadbeef' => 'no git describe data',
-    '1.0.0-123-gfd0e3a65282cb5f6df3bab6a53f4fcb722340d499-1' => 'too many SHA1 characters',
-    '1.0.0-123-gdeadbe-1' => 'too few SHA1 characters',
-    '1.0.0-123-gNOTHEX1-1' => 'illegal SHA1 characters',
-    '1.0.0-123-g1234567-alpha' => 'non-numeric iteration',
-    '1.0.0-alpha-poop-g1234567-1' => "non-numeric 'commits_since'",
-    '1.0.0-g1234567-1' => "missing 'commits_since'",
-    '1.0.0-123-1' => 'missing SHA1',
+  it_has_behavior "rejects invalid version strings", {
+    "1.0.0" => "no git describe data",
+    "1.0.0-alpha.1" => "no git describe data",
+    "1.0.0-alpha.1+build.deadbeef" => "no git describe data",
+    "1.0.0-123-gfd0e3a65282cb5f6df3bab6a53f4fcb722340d499-1" => "too many SHA1 characters",
+    "1.0.0-123-gdeadbe-1" => "too few SHA1 characters",
+    "1.0.0-123-gNOTHEX1-1" => "illegal SHA1 characters",
+    "1.0.0-123-g1234567-alpha" => "non-numeric iteration",
+    "1.0.0-alpha-poop-g1234567-1" => "non-numeric 'commits_since'",
+    "1.0.0-g1234567-1" => "missing 'commits_since'",
+    "1.0.0-123-1" => "missing SHA1",
   }
 
-  version_strings = %w(
+  version_strings = %w{
     9.0.1-1-gdeadbee-1
     9.1.2-2-g1234567-1
     10.0.0-1-gabcdef3-1
@@ -123,14 +123,14 @@ describe Mixlib::Versioning::Format::GitDescribe do
     9.0.1-2-gdeadbe1-2
     9.0.1-2-gdeadbe2-1
     9.1.1-2-g1234567-1
-  )
+  }
 
-  it_has_behavior 'serializable', version_strings
+  it_has_behavior "serializable", version_strings
 
-  it_has_behavior 'sortable' do
+  it_has_behavior "sortable" do
     let(:unsorted_version_strings) { version_strings }
     let(:sorted_version_strings) do
-      %w(
+      %w{
         9.0.1-1-gdeadbee-1
         9.0.1-2-gdeadbe1-1
         9.0.1-2-gdeadbe1-2
@@ -141,17 +141,17 @@ describe Mixlib::Versioning::Format::GitDescribe do
         10.5.7-2-g21353f0-1
         10.20.2-2-gbbbbbbb-1
         10.20.2-3-gaaaaaaa-1
-      )
+      }
     end
-    let(:min) { '9.0.1-1-gdeadbee-1' }
-    let(:max) { '10.20.2-3-gaaaaaaa-1' }
+    let(:min) { "9.0.1-1-gdeadbee-1" }
+    let(:max) { "10.20.2-3-gaaaaaaa-1" }
   end # it_has_behavior
 
   # The +GitDescribe+ format only produces release build versions.
-  it_has_behavior 'filterable' do
+  it_has_behavior "filterable" do
     let(:unsorted_version_strings) { version_strings }
     let(:build_versions) do
-      %w(
+      %w{
         9.0.1-1-gdeadbee-1
         9.1.2-2-g1234567-1
         10.0.0-1-gabcdef3-1
@@ -162,10 +162,10 @@ describe Mixlib::Versioning::Format::GitDescribe do
         9.0.1-2-gdeadbe1-2
         9.0.1-2-gdeadbe2-1
         9.1.1-2-g1234567-1
-      )
+      }
     end
     let(:release_build_versions) do
-      %w(
+      %w{
         9.0.1-1-gdeadbee-1
         9.1.2-2-g1234567-1
         10.0.0-1-gabcdef3-1
@@ -176,15 +176,15 @@ describe Mixlib::Versioning::Format::GitDescribe do
         9.0.1-2-gdeadbe1-2
         9.0.1-2-gdeadbe2-1
         9.1.1-2-g1234567-1
-      )
+      }
     end
-  end  # it_has_behavior
+  end # it_has_behavior
 
-  it_has_behavior 'comparable', [
-    '9.0.1-1-gdeadbee-1', '9.0.1-2-gdeadbe1-1',
-    '9.0.1-2-gdeadbe1-2', '9.0.1-2-gdeadbe2-1',
-    '9.1.1-2-g1234567-1', '9.1.2-2-g1234567-1',
-    '10.0.0-1-gabcdef3-1', '10.5.7-2-g21353f0-1',
-    '10.20.2-2-gbbbbbbb-1', '10.20.2-3-gaaaaaaa-1'
+  it_has_behavior "comparable", [
+    "9.0.1-1-gdeadbee-1", "9.0.1-2-gdeadbe1-1",
+    "9.0.1-2-gdeadbe1-2", "9.0.1-2-gdeadbe2-1",
+    "9.1.1-2-g1234567-1", "9.1.2-2-g1234567-1",
+    "10.0.0-1-gabcdef3-1", "10.5.7-2-g21353f0-1",
+    "10.20.2-2-gbbbbbbb-1", "10.20.2-3-gaaaaaaa-1"
   ]
 end # describe

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

@@ -16,38 +16,38 @@
 # limitations under the License.
 #
 
-require 'spec_helper'
+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',
-    '11.0.08-rc.1+20130308110833' => 'leading zero invalid',
-    '01.0.8-alpha.2+20130308110833.git.2.94a1dde' => 'leading zero invalid',
-    '11.02.8-rc.1+20130308110833' => 'leading zero invalid',
-    '0008.1.4' => 'leading zero invalid',
-    '11.00000000002.8-rc.1+20130308110833' => 'leading zero invalid',
-    '4.67.00012+build.20131219' => 'leading zero invalid',
-    '3.6.7-rc.007' => 'leading zero invalid',
+  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",
+    "11.0.08-rc.1+20130308110833" => "leading zero invalid",
+    "01.0.8-alpha.2+20130308110833.git.2.94a1dde" => "leading zero invalid",
+    "11.02.8-rc.1+20130308110833" => "leading zero invalid",
+    "0008.1.4" => "leading zero invalid",
+    "11.00000000002.8-rc.1+20130308110833" => "leading zero invalid",
+    "4.67.00012+build.20131219" => "leading zero invalid",
+    "3.6.7-rc.007" => "leading zero invalid",
   }
 
-  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 "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
+  it_has_behavior "sortable" do
     let(:unsorted_version_strings) do
-      %w(
+      %w{
         1.0.0-beta.2
         1.0.0-alpha
         1.0.0-rc.1+20130309074433
@@ -59,10 +59,10 @@ describe Mixlib::Versioning::Format::OpscodeSemVer do
         1.3.7+20131009104433.git.2.94a1dde
         1.3.7+20131009104433
         1.3.7+20131009074433
-      )
+      }
     end
     let(:sorted_version_strings) do
-      %w(
+      %w{
         1.0.0-alpha
         1.0.0-alpha.1
         1.0.0-beta.2
@@ -74,15 +74,15 @@ describe Mixlib::Versioning::Format::OpscodeSemVer do
         1.3.7+20131009074433
         1.3.7+20131009104433
         1.3.7+20131009104433.git.2.94a1dde
-      )
+      }
     end
-    let(:min) { '1.0.0-alpha' }
-    let(:max) { '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
+  it_has_behavior "filterable" do
     let(:unsorted_version_strings) do
-      %w(
+      %w{
         1.0.0-beta.2
         1.0.0-alpha
         1.0.0-rc.1+20130309074433
@@ -94,45 +94,45 @@ describe Mixlib::Versioning::Format::OpscodeSemVer do
         1.3.7+20131009104433.git.2.94a1dde
         1.3.7+20131009104433
         1.3.7+20131009074433
-      )
+      }
     end
-    let(:release_versions) { %w(1.0.0) }
+    let(:release_versions) { %w{1.0.0} }
     let(:prerelease_versions) do
-      %w(
+      %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
-      )
+      }
     end
     let(:build_versions) do
-      %w(
+      %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
-      )
+      }
     end
     let(:release_build_versions) do
-      %w(
+      %w{
         1.0.0+20121009074433
         1.3.7+20131009104433.git.2.94a1dde
         1.3.7+20131009104433
         1.3.7+20131009074433
-      )
+      }
     end
     let(:prerelease_build_versions) do
-      %w(
-        1.0.0-rc.1+20130309074433      )
+      %w{
+        1.0.0-rc.1+20130309074433      }
     end
   end # it_has_behavior
 
-  it_has_behavior 'comparable', [
-    '0.1.0', '0.2.0',
-    '1.0.0-alpha.1', '1.0.0',
-    '1.2.3', '1.2.3+20121009074433',
-    '2.0.0-beta.1', '2.0.0+20131009104433.git.2.94a1dde'
+  it_has_behavior "comparable", [
+    "0.1.0", "0.2.0",
+    "1.0.0-alpha.1", "1.0.0",
+    "1.2.3", "1.2.3+20121009074433",
+    "2.0.0-beta.1", "2.0.0+20131009104433.git.2.94a1dde"
   ]
 end # describe