mixlib-versioning 1.0.0

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

@@ -0,0 +1,71 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Author:: Christopher Maier (<cm@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.
+#
+
+module Mixlib
+  class Versioning
+    class Format
+      # Handles version strings based on
+      # {https://www.kernel.org/pub/software/scm/git/docs/git-describe.html git describe}
+      # output.
+      #
+      # SUPPORTED FORMATS
+      # -----------------
+      # ```text
+      # MAJOR.MINOR.PATCH-COMMITS_SINCE-gGIT_SHA1
+      # MAJOR.MINOR.PATCH.PRERELEASE-COMMITS_SINCE-gGIT_SHA1
+      # MAJOR.MINOR.PATCH-PRERELEASE-COMMITS_SINCE-gGIT_SHA1-ITERATION
+      # ```
+      #
+      # EXAMPLES
+      # --------
+      # ```text
+      # 10.16.2-49-g21353f0-1
+      # 10.16.2.rc.1-49-g21353f0-1
+      # 11.0.0-alpha-10-g642ffed
+      # 11.0.0-alpha.1-1-gcea071e
+      # ```
+      #
+      # @author Seth Chisamore (<schisamo@opscode.com>)
+      # @author Christopher Maier (<cm@opscode.com>)
+      class GitDescribe < Format
+
+        GIT_DESCRIBE_REGEX = /^(\d+)\.(\d+)\.(\d+)(?:\-|\.)?(.+)?\-(\d+)\-g([a-f0-9]{7,40})(?:\-)?(\d+)?$/
+
+        attr_reader :commits_since, :commit_sha
+
+        # @see Format#parse
+        def parse(version_string)
+          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!"
+          end
+
+          @major, @minor, @patch, @prerelease, @commits_since, @commit_sha, @iteration = match[1..7]
+          @major, @minor, @patch, @commits_since, @iteration = [@major, @minor, @patch, @commits_since, @iteration].map(&:to_i)
+
+          # Our comparison logic is built around SemVer semantics, so
+          # 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
+end # module Mixlib

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

@@ -0,0 +1,91 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Author:: Christopher Maier (<cm@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 'mixlib/versioning/format/semver'
+
+module Mixlib
+  class Versioning
+    class Format
+      # Defines the format of the semantic version scheme used for Opscode
+      # projects.  They are SemVer-2.0.0-rc.1 compliant, but we further
+      # constrain the allowable strings for prerelease and build
+      # signifiers for our own internal standards.
+      #
+      # SUPPORTED FORMATS
+      # -----------------
+      # ```text
+      # MAJOR.MINOR.PATCH
+      # MAJOR.MINOR.PATCH-alpha.INDEX
+      # MAJOR.MINOR.PATCH-beta.INDEX
+      # MAJOR.MINOR.PATCH-rc.INDEX
+      # MAJOR.MINOR.PATCH-alpha.INDEX+YYYYMMDDHHMMSS
+      # MAJOR.MINOR.PATCH-beta.INDEX+YYYYMMDDHHMMSS
+      # MAJOR.MINOR.PATCH-rc.INDEX+YYYYMMDDHHMMSS
+      # MAJOR.MINOR.PATCH-alpha.INDEX+YYYYMMDDHHMMSS.git.COMMITS_SINCE.SHA1
+      # MAJOR.MINOR.PATCH-beta.INDEX+YYYYMMDDHHMMSS.git.COMMITS_SINCE.SHA1
+      # MAJOR.MINOR.PATCH-rc.INDEX+YYYYMMDDHHMMSS.git.COMMITS_SINCE.SHA1
+      # ```
+      #
+      # EXAMPLES
+      # --------
+      # ```text
+      # 11.0.0
+      # 11.0.0-alpha.1
+      # 11.0.0-alpha1+20121218164140
+      # 11.0.0-alpha1+20121218164140.git.207.694b062
+      # ```
+      #
+      # @author Seth Chisamore (<schisamo@opscode.com>)
+      # @author Christopher Maier (<cm@opscode.com>)
+      class OpscodeSemVer < SemVer
+
+        # The pattern is: `YYYYMMDDHHMMSS.git.COMMITS_SINCE.SHA1`
+        OPSCODE_BUILD_REGEX = /^\d{14}(\.git\.\d+\.[a-f0-9]{7})?$/
+
+        # Allows the following:
+        #
+        # ```text
+        # alpha, alpha.0, alpha.1, alpha.2, etc.
+        # beta, beta.0, beta.1, beta.2, etc.
+        # rc, rc.0, rc.1, rc.2, etc.
+        # ```
+        #
+        OPSCODE_PRERELEASE_REGEX = /^(alpha|beta|rc)(\.\d+)?$/
+
+        # @see SemVer#parse
+        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
+        end
+
+      end # class OpscodeSemVer
+    end # class Format
+  end # module Versioning
+end # module Mixlib

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

@@ -0,0 +1,66 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Author:: Christopher Maier (<cm@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.
+#
+
+module Mixlib
+  class Versioning
+    class Format
+      # Handles version strings based on {http://guides.rubygems.org/patterns/}
+      #
+      # SUPPORTED FORMATS
+      # -----------------
+      # ```text
+      # MAJOR.MINOR.PATCH.PRERELEASE
+      # MAJOR.MINOR.PATCH.PRERELEASE-ITERATION
+      # ```
+      #
+      # EXAMPLES
+      # --------
+      # ```text
+      # 10.1.1
+      # 10.1.1.alpha.1
+      # 10.1.1.beta.1
+      # 10.1.1.rc.0
+      # 10.16.2
+      # ```
+      #
+      # @author Seth Chisamore (<schisamo@opscode.com>)
+      # @author Christopher Maier (<cm@opscode.com>)
+      class Rubygems < Format
+
+        RUBYGEMS_REGEX = /^(\d+)\.(\d+)\.(\d+)(?:\.([[:alnum:]]+(?:\.[[:alnum:]]+)?))?(?:\-(\d+))?$/
+
+        # @see Format#parse
+        def parse(version_string)
+          match = version_string.match(RUBYGEMS_REGEX) rescue nil
+
+          unless match
+            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)
+
+          # Do not convert @build to an integer; SemVer sorting logic will handle the conversion
+          @prerelease = nil if (@prerelease.nil? || @prerelease.empty?)
+        end
+
+      end # class Rubygems
+    end # class Format
+  end # module Versioning
+end # module Mixlib

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

@@ -0,0 +1,66 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Author:: Christopher Maier (<cm@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.
+#
+
+module Mixlib
+  class Versioning
+    class Format
+      # Handles version strings based on {http://semver.org/ SemVer 2.0.0-rc.1}.
+      #
+      # SUPPORTED FORMATS
+      # -----------------
+      # ```text
+      # MAJOR.MINOR.PATCH
+      # MAJOR.MINOR.PATCH-PRERELEASE
+      # MAJOR.MINOR.PATCH-PRERELEASE+BUILD
+      #```
+      #
+      # EXAMPLES
+      # --------
+      # ```text
+      # 11.0.0
+      # 11.0.0-alpha.1
+      # 11.0.0-alpha1+20121218164140
+      # 11.0.0-alpha1+20121218164140.git.207.694b062
+      # ```
+      #
+      # @author Seth Chisamore (<schisamo@opscode.com>)
+      # @author Christopher Maier (<cm@opscode.com>)
+      class SemVer < Format
+
+        SEMVER_REGEX = /^(\d+)\.(\d+)\.(\d+)(?:\-([\dA-Za-z\-\.]+))?(?:\+([\dA-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!"
+          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?)
+        end
+
+      end # class SemVer
+    end # class Format
+  end # module Versioning
+end # module Mixlib

data/lib/mixlib/versioning/version.rb

@@ -0,0 +1,23 @@
+#
+# 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.
+#
+
+module Mixlib
+  class Versioning
+    VERSION = "1.0.0"
+  end
+end

data/mixlib-versioning.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+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.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec_junit_formatter"
+
+  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"]
+end

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

@@ -0,0 +1,178 @@
+#
+# 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::GitDescribe do
+
+  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
+    },
+    "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-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
+    }
+  }
+
+  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{
+    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 "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" }
+  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
+    }}
+  end  # it_has_behavior
+
+end # describe