mixlib-versioning 1.0.0 → 1.1.0

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

@@ -1,6 +1,6 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Author:: Christopher Maier (<cm@opscode.com>)
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Christopher Maier (<cm@chef.io>)
 # Copyright:: Copyright (c) 2013 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -41,10 +41,9 @@ module Mixlib
       # 11.0.0-alpha.1-1-gcea071e
       # ```
       #
-      # @author Seth Chisamore (<schisamo@opscode.com>)
-      # @author Christopher Maier (<cm@opscode.com>)
+      # @author Seth Chisamore (<schisamo@chef.io>)
+      # @author Christopher Maier (<cm@chef.io>)
       class GitDescribe < Format
-
         GIT_DESCRIBE_REGEX = /^(\d+)\.(\d+)\.(\d+)(?:\-|\.)?(.+)?\-(\d+)\-g([a-f0-9]{7,40})(?:\-)?(\d+)?$/
 
         attr_reader :commits_since, :commit_sha
@@ -54,7 +53,7 @@ module Mixlib
           match = version_string.match(GIT_DESCRIBE_REGEX) rescue nil
 
           unless match
-            raise Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
+            fail 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]
@@ -64,7 +63,6 @@ module Mixlib
           # we'll store our internal information in that format
           @build = "#{@commits_since}.g#{@commit_sha}.#{@iteration}"
         end
-
       end # class GitDescribe
     end # class Format
   end # module Versioning

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

@@ -1,6 +1,6 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Author:: Christopher Maier (<cm@opscode.com>)
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Christopher Maier (<cm@chef.io>)
 # Copyright:: Copyright (c) 2013 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -51,10 +51,9 @@ module Mixlib
       # 11.0.0-alpha1+20121218164140.git.207.694b062
       # ```
       #
-      # @author Seth Chisamore (<schisamo@opscode.com>)
-      # @author Christopher Maier (<cm@opscode.com>)
+      # @author Seth Chisamore (<schisamo@chef.io>)
+      # @author Christopher Maier (<cm@chef.io>)
       class OpscodeSemVer < SemVer
-
         # The pattern is: `YYYYMMDDHHMMSS.git.COMMITS_SINCE.SHA1`
         OPSCODE_BUILD_REGEX = /^\d{14}(\.git\.\d+\.[a-f0-9]{7})?$/
 
@@ -72,19 +71,9 @@ module Mixlib
         def parse(version_string)
           super(version_string)
 
-          unless @prerelease.nil?
-            unless @prerelease.match(OPSCODE_PRERELEASE_REGEX)
-              raise Mixlib::Versioning::ParseError, "'#{@prerelease}' is not a valid Opscode pre-release signifier!"
-            end
-          end
-
-          unless @build.nil?
-            unless @build.match(OPSCODE_BUILD_REGEX)
-              raise Mixlib::Versioning::ParseError, "'#{@build}' is not a valid Opscode build signifier!"
-            end
-          end
+          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)
         end
-
       end # class OpscodeSemVer
     end # class Format
   end # module Versioning

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

@@ -1,6 +1,6 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Author:: Christopher Maier (<cm@opscode.com>)
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Christopher Maier (<cm@chef.io>)
 # Copyright:: Copyright (c) 2013 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -39,10 +39,9 @@ module Mixlib
       # 10.16.2
       # ```
       #
-      # @author Seth Chisamore (<schisamo@opscode.com>)
-      # @author Christopher Maier (<cm@opscode.com>)
+      # @author Seth Chisamore (<schisamo@chef.io>)
+      # @author Christopher Maier (<cm@chef.io>)
       class Rubygems < Format
-
         RUBYGEMS_REGEX = /^(\d+)\.(\d+)\.(\d+)(?:\.([[:alnum:]]+(?:\.[[:alnum:]]+)?))?(?:\-(\d+))?$/
 
         # @see Format#parse
@@ -50,16 +49,15 @@ module Mixlib
           match = version_string.match(RUBYGEMS_REGEX) rescue nil
 
           unless match
-            raise Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
+            fail 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)
 
           # Do not convert @build to an integer; SemVer sorting logic will handle the conversion
-          @prerelease = nil if (@prerelease.nil? || @prerelease.empty?)
+          @prerelease = nil if @prerelease.nil? || @prerelease.empty?
         end
-
       end # class Rubygems
     end # class Format
   end # module Versioning

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

@@ -1,6 +1,6 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Author:: Christopher Maier (<cm@opscode.com>)
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Christopher Maier (<cm@chef.io>)
 # Copyright:: Copyright (c) 2013 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -28,7 +28,7 @@ module Mixlib
       # MAJOR.MINOR.PATCH
       # MAJOR.MINOR.PATCH-PRERELEASE
       # MAJOR.MINOR.PATCH-PRERELEASE+BUILD
-      #```
+      # ```
       #
       # EXAMPLES
       # --------
@@ -39,27 +39,25 @@ module Mixlib
       # 11.0.0-alpha1+20121218164140.git.207.694b062
       # ```
       #
-      # @author Seth Chisamore (<schisamo@opscode.com>)
-      # @author Christopher Maier (<cm@opscode.com>)
+      # @author Seth Chisamore (<schisamo@chef.io>)
+      # @author Christopher Maier (<cm@chef.io>)
       class SemVer < Format
-
-        SEMVER_REGEX = /^(\d+)\.(\d+)\.(\d+)(?:\-([\dA-Za-z\-\.]+))?(?:\+([\dA-Za-z\-\.]+))?$/
+        SEMVER_REGEX = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][a-zA-Z0-9-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][a-zA-Z0-9-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$/
 
         # @see Format#parse
         def parse(version_string)
           match = version_string.match(SEMVER_REGEX) rescue nil
 
           unless match
-            raise Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
+            fail Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
           end
 
           @major, @minor, @patch, @prerelease, @build = match[1..5]
           @major, @minor, @patch = [@major, @minor, @patch].map(&:to_i)
 
-          @prerelease = nil if (@prerelease.nil? || @prerelease.empty?)
-          @build = nil if (@build.nil? || @build.empty?)
+          @prerelease = nil if @prerelease.nil? || @prerelease.empty?
+          @build = nil if @build.nil? || @build.empty?
         end
-
       end # class SemVer
     end # class Format
   end # module Versioning

data/lib/mixlib/versioning/version.rb

@@ -1,5 +1,5 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Author:: Seth Chisamore (<schisamo@chef.io>)
 # Copyright:: Copyright (c) 2013 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -18,6 +18,6 @@
 
 module Mixlib
   class Versioning
-    VERSION = "1.0.0"
+    VERSION = '1.1.0'
   end
 end

data/mixlib-versioning.gemspec

@@ -3,20 +3,26 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mixlib/versioning/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "mixlib-versioning"
-  gem.version       = Mixlib::Versioning::VERSION
-  gem.authors       = ["Seth Chisamore", "Christopher Maier"]
-  gem.email         = ["schisamo@opscode.com", "cm@opscode.com"]
-  gem.description   = "General purpose Ruby library that allows you to parse, compare and manipulate version strings in multiple formats."
-  gem.summary       = gem.description
-  gem.homepage      = "https://github.com/opscode/mixlib-versioning"
+Gem::Specification.new do |spec|
+  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.summary       = spec.description
+  spec.homepage      = 'https://github.com/chef/mixlib-versioning'
+  spec.license       = 'Apache 2.0'
 
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "rspec_junit_formatter"
+  spec.required_ruby_version = '>= 1.9'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  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']
+
+  # 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'
 end

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

@@ -1,5 +1,5 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Author:: Seth Chisamore (<schisamo@chef.io>)
 # Copyright:: Copyright (c) 2013 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -19,101 +19,100 @@
 require 'spec_helper'
 
 describe Mixlib::Versioning::Format::GitDescribe do
+  subject { described_class.new(version_string) }
 
-  subject{ described_class.new(version_string) }
-
-  it_has_behavior "parses valid version strings", {
-    "0.10.8-231-g59d6185" => {
-      :major => 0,
-      :minor => 10,
-      :patch => 8,
-      :prerelease => nil,
-      :build => "231.g59d6185.0",
-      :release? => false,
-      :prerelease? => false,
-      :build? => true,
-      :release_build? => true,
-      :prerelease_build? => false,
-      :commits_since => 231,
-      :commit_sha => "59d6185",
-      :iteration => 0
+  it_has_behavior 'parses valid version strings', {
+    '0.10.8-231-g59d6185' => {
+      major: 0,
+      minor: 10,
+      patch: 8,
+      prerelease: nil,
+      build: '231.g59d6185.0',
+      release?: false,
+      prerelease?: false,
+      build?: true,
+      release_build?: true,
+      prerelease_build?: false,
+      commits_since: 231,
+      commit_sha: '59d6185',
+      iteration: 0,
+    },
+    '10.16.2-49-g21353f0-1' => {
+      major: 10,
+      minor: 16,
+      patch: 2,
+      prerelease: nil,
+      build: '49.g21353f0.1',
+      release?: false,
+      prerelease?: false,
+      build?: true,
+      release_build?: true,
+      prerelease_build?: false,
+      commits_since: 49,
+      commit_sha: '21353f0',
+      iteration: 1,
     },
-    "10.16.2-49-g21353f0-1" => {
-      :major => 10,
-      :minor => 16,
-      :patch => 2,
-      :prerelease => nil,
-      :build => "49.g21353f0.1",
-      :release? => false,
-      :prerelease? => false,
-      :build? => true,
-      :release_build? => true,
-      :prerelease_build? => false,
-      :commits_since => 49,
-      :commit_sha => "21353f0",
-      :iteration => 1
+    '10.16.2.rc.1-49-g21353f0-1' => {
+      major: 10,
+      minor: 16,
+      patch: 2,
+      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',
+      iteration: 1,
     },
-    "10.16.2.rc.1-49-g21353f0-1" => {
-      :major => 10,
-      :minor => 16,
-      :patch => 2,
-      :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",
-      :iteration => 1
+    '10.16.2-alpha-49-g21353f0-1' => {
+      major: 10,
+      minor: 16,
+      patch: 2,
+      prerelease: 'alpha',
+      build: '49.g21353f0.1',
+      release?: false,
+      prerelease?: false,
+      build?: true,
+      release_build?: false,
+      prerelease_build?: true,
+      commits_since: 49,
+      commit_sha: '21353f0',
+      iteration: 1,
     },
-    "10.16.2-alpha-49-g21353f0-1" => {
-      :major => 10,
-      :minor => 16,
-      :patch => 2,
-      :prerelease => "alpha",
-      :build => "49.g21353f0.1",
-      :release? => false,
-      :prerelease? => false,
-      :build? => true,
-      :release_build? => false,
-      :prerelease_build? => true,
-      :commits_since => 49,
-      :commit_sha => "21353f0",
-      :iteration => 1
+    '10.16.2-alpha-49-g21353f0' => {
+      major: 10,
+      minor: 16,
+      patch: 2,
+      prerelease: 'alpha',
+      build: '49.g21353f0.0',
+      release?: false,
+      prerelease?: false,
+      build?: true,
+      release_build?: false,
+      prerelease_build?: true,
+      commits_since: 49,
+      commit_sha: '21353f0',
+      iteration: 0,
     },
-    "10.16.2-alpha-49-g21353f0" => {
-      :major => 10,
-      :minor => 16,
-      :patch => 2,
-      :prerelease => "alpha",
-      :build => "49.g21353f0.0",
-      :release? => false,
-      :prerelease? => false,
-      :build? => true,
-      :release_build? => false,
-      :prerelease_build? => true,
-      :commits_since => 49,
-      :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
@@ -124,55 +123,68 @@ 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
-    let(:unsorted_version_strings){ version_strings }
-    let(:sorted_version_strings){%w{
-      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
-    }}
-    let(:min){ "9.0.1-1-gdeadbee-1" }
-    let(:max){ "10.20.2-3-gaaaaaaa-1" }
+  it_has_behavior 'sortable' do
+    let(:unsorted_version_strings) { version_strings }
+    let(:sorted_version_strings) do
+      %w(
+        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
+    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
-    let(:unsorted_version_strings){ version_strings }
-    let(:build_versions){%w{
-      9.0.1-1-gdeadbee-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
-      9.0.1-2-gdeadbe1-1
-      9.0.1-2-gdeadbe1-2
-      9.0.1-2-gdeadbe2-1
-      9.1.1-2-g1234567-1
-    }}
-    let(:release_build_versions){%w{
-      9.0.1-1-gdeadbee-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
-      9.0.1-2-gdeadbe1-1
-      9.0.1-2-gdeadbe1-2
-      9.0.1-2-gdeadbe2-1
-      9.1.1-2-g1234567-1
-    }}
+  it_has_behavior 'filterable' do
+    let(:unsorted_version_strings) { version_strings }
+    let(:build_versions) do
+      %w(
+        9.0.1-1-gdeadbee-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
+        9.0.1-2-gdeadbe1-1
+        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(
+        9.0.1-1-gdeadbee-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
+        9.0.1-2-gdeadbe1-1
+        9.0.1-2-gdeadbe1-2
+        9.0.1-2-gdeadbe2-1
+        9.1.1-2-g1234567-1
+      )
+    end
   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'
+  ]
 end # describe