mixlib-versioning 1.0.0 → 1.2.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2be21e4975d6fa956538a0eb98cfe608f423a0b34aee5763e627ec31112c66b5
+  data.tar.gz: f7909f08f54a4d094516186f68747b96500a62cdcc8677fe6d631947d0d017c6
+SHA512:
+  metadata.gz: 9b8554a17dc71628a23c83aeee7b7932733476d1b7769d9e83e5a27f0d884bfc18313a28a27348ca407dc5ac537df9f5a87d521debd45eca6b860b6cd83ba04f
+  data.tar.gz: 66d72d18122c944855affd93d57a8ad81f74aedbf8009305d9bd425fd46979b1e41d69cfc8e28d96492957f7ed1df7228a5178e31bfdef0173bcec9825b60972

data/lib/mixlib/versioning.rb

@@ -1,7 +1,7 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Author:: Christopher Maier (<cm@opscode.com>)
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Christopher Maier (<cm@chef.io>)
+# Copyright:: Copyright (c) 2013-2018 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,57 +17,62 @@
 # limitations under the License.
 #
 
-require 'mixlib/versioning/exceptions'
-require 'mixlib/versioning/format'
+require_relative "versioning/exceptions"
+require_relative "versioning/format"
 
 module Mixlib
-  # @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 Versioning
+    DEFAULT_FORMATS = [
+      Mixlib::Versioning::Format::GitDescribe,
+      Mixlib::Versioning::Format::OpscodeSemVer,
+      Mixlib::Versioning::Format::SemVer,
+      Mixlib::Versioning::Format::Rubygems,
+      Mixlib::Versioning::Format::PartialSemVer,
+    ].freeze
 
     # Create a new {Format} instance given a version string to parse, and an
     # optional format type.
     #
     # @example
-    #   Mixlib::Versioning.parse("11.0.0")
-    #   Mixlib::Versioning.parse("11.0.0", :semver)
-    #   Mixlib::Versioning.parse("11.0.0", 'semver')
-    #   Mixlib::Versioning.parse("11.0.0", Mixlib::Versioning::Format::SemVer)
+    #   Mixlib::Versioning.parse('11.0.0')
+    #   Mixlib::Versioning.parse('11.0.0', :semver)
+    #   Mixlib::Versioning.parse('11.0.0', 'semver')
+    #   Mixlib::Versioning.parse('11.0.0', Mixlib::Versioning::Format::SemVer)
     #
     # @param version_string [String] String representatin of the version to
     #   parse
-    # @param format_type [String, Symbol, Mixlib::Versioning::Format] Optional
+    # @param format [String, Symbol, Mixlib::Versioning::Format, Array] Optional
     #   format type to parse the version string as. If this is exluded all
     #   version types will be attempted from most specific to most specific
-    #   with a preference for SemVer formats
-    #
+    #   with a preference for SemVer formats. If it is an array, only version
+    #   types in that list will be considered
     # @raise [Mixlib::Versioning::ParseError] if the parse fails.
     # @raise [Mixlib::Versioning::UnknownFormatError] if the given format type
     #   doesn't exist.
     #
     # @return
     #
-    def self.parse(version_string, format_type=nil)
-      if version_string.kind_of?(Mixlib::Versioning::Format)
-        return version_string
-      elsif format_type
-        return Mixlib::Versioning::Format.for(format_type).new(version_string)
+    def self.parse(version_string, format = nil)
+      if version_string.is_a?(Mixlib::Versioning::Format)
+        version_string
       else
+        formats = if format
+                    [format].flatten.map { |f| Mixlib::Versioning::Format.for(f) }
+                  else
+                    DEFAULT_FORMATS
+                  end
         # Attempt to parse from the most specific formats first.
         parsed_version = nil
-        [
-          Mixlib::Versioning::Format::GitDescribe,
-          Mixlib::Versioning::Format::OpscodeSemVer,
-          Mixlib::Versioning::Format::SemVer,
-          Mixlib::Versioning::Format::Rubygems
-        ].each do |version|
+        formats.each do |version|
           begin
             break parsed_version = version.new(version_string)
           rescue Mixlib::Versioning::ParseError
             next
           end
         end
-        return parsed_version
+        parsed_version
       end
     end
 
@@ -103,7 +108,7 @@ module Mixlib
     #             11.0.1 }
     #
     #   Mixlib::Versioning.find_target_version(all,
-    #                                          "11.0.1",
+    #                                          '11.0.1',
     #                                          true,
     #                                          true)
     #
@@ -124,19 +129,19 @@ module Mixlib
     #   build version specifier will be filtered out.
     #
     def self.find_target_version(all_versions,
-                                 filter_version=nil,
-                                 use_prerelease_versions=false,
-                                 use_build_versions=false)
+                                 filter_version = nil,
+                                 use_prerelease_versions = false,
+                                 use_build_versions = false)
 
       # attempt to parse a `Mixlib::Versioning::Format` instance if we were
       # passed a string
       unless filter_version.nil? ||
-             filter_version.kind_of?(Mixlib::Versioning::Format)
+          filter_version.is_a?(Mixlib::Versioning::Format)
         filter_version = Mixlib::Versioning.parse(filter_version)
       end
 
       all_versions.map! do |v|
-        if v.kind_of?(Mixlib::Versioning::Format)
+        if v.is_a?(Mixlib::Versioning::Format)
           v
         else
           Mixlib::Versioning.parse(v)
@@ -153,7 +158,7 @@ module Mixlib
         # that prerelease, and then take the most recent. Otherwise, just
         # return the specified prerelease version
         if use_build_versions
-          all_versions.select{|v| v.in_same_prerelease_line?(filter_version)}.max
+          all_versions.select { |v| v.in_same_prerelease_line?(filter_version) }.max
         else
           filter_version
         end
@@ -177,18 +182,17 @@ module Mixlib
           in_release_line && if use_prerelease_versions && use_build_versions
                                v.prerelease_build?
                              elsif !use_prerelease_versions &&
-                                   use_build_versions
+                                 use_build_versions
                                v.release_build?
                              elsif use_prerelease_versions &&
-                                   !use_build_versions
+                                 !use_build_versions
                                v.prerelease?
                              elsif !use_prerelease_versions &&
-                                   !use_build_versions
+                                 !use_build_versions
                                v.release?
                              end
         end.max # select the most recent version
       end # if
     end # self.find_target_version
-
   end # Versioning
 end # Mixlib

data/lib/mixlib/versioning/exceptions.rb

@@ -1,6 +1,6 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Copyright:: Copyright (c) 2013-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/versioning/format.rb

@@ -1,6 +1,6 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Copyright:: Copyright (c) 2013-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,30 +16,30 @@
 # limitations under the License.
 #
 
-require 'mixlib/versioning/format/git_describe'
-require 'mixlib/versioning/format/opscode_semver'
-require 'mixlib/versioning/format/rubygems'
-require 'mixlib/versioning/format/semver'
+require_relative "format/git_describe"
+require_relative "format/opscode_semver"
+require_relative "format/rubygems"
+require_relative "format/semver"
+require_relative "format/partial_semver"
 
 module Mixlib
   class Versioning
-
-    # @author Seth Chisamore (<schisamo@opscode.com>)
+    # @author Seth Chisamore (<schisamo@chef.io>)
     #
     # @!attribute [r] major
     #   @return [Integer] major identifier
     # @!attribute [r] minor
     #   @return [Integer] minor identifier
     # @!attribute [r] patch
-    #   @return [Integer] patch identifier
+    #   @return [Integer, nil] patch identifier
     # @!attribute [r] prerelease
-    #   @return [String] pre-release identifier
+    #   @return [String, nil] pre-release identifier
     # @!attribute [r] build
-    #   @return [String] build identifier
+    #   @return [String, nil] build identifier
     # @!attribute [r] iteration
-    #   @return [String] build interation
+    #   @return [String, nil] build interation
     # @!attribute [r] input
-    #   @return [String] original input version string that was parsed
+    #   @return [String, nil] original input version string that was parsed
     class Format
       include Comparable
 
@@ -60,17 +60,18 @@ module Mixlib
       # @return [Class] the {Mixlib::Versioning::Format} class
       #
       def self.for(format_type)
-        if format_type.kind_of?(Class) &&
-           format_type.ancestors.include?(Mixlib::Versioning::Format)
+        if format_type.is_a?(Class) &&
+            format_type.ancestors.include?(Mixlib::Versioning::Format)
           format_type
         else
           case format_type.to_s
-          when 'semver'; Mixlib::Versioning::Format::SemVer
-          when 'opscode_semver'; Mixlib::Versioning::Format::OpscodeSemVer
-          when 'git_describe'; Mixlib::Versioning::Format::GitDescribe
-          when 'rubygems'; Mixlib::Versioning::Format::Rubygems
+          when "semver" then Mixlib::Versioning::Format::SemVer
+          when "opscode_semver" then Mixlib::Versioning::Format::OpscodeSemVer
+          when "git_describe" then Mixlib::Versioning::Format::GitDescribe
+          when "rubygems" then Mixlib::Versioning::Format::Rubygems
+          when "partial_semver" then Mixlib::Versioning::Format::PartialSemVer
           else
-            msg = "'#{format_type.to_s}' is not a supported Mixlib::Versioning format"
+            msg = "'#{format_type}' is not a supported Mixlib::Versioning format"
             raise Mixlib::Versioning::UnknownFormatError, msg
           end
         end
@@ -90,7 +91,7 @@ module Mixlib
       #
       # @param version_string [String] string representation of the version
       # @raise [Mixlib::Versioning::ParseError] raised if parsing fails
-      def parse(version_string)
+      def parse(_version_string)
         raise Error, "You must override the #parse"
       end
 
@@ -101,22 +102,22 @@ module Mixlib
 
       # @return [Boolean] Whether or not this is a pre-release version
       def prerelease?
-        !!(@prerelease && @build.nil?)
+        !@prerelease.nil? && @build.nil?
       end
 
       # @return [Boolean] Whether or not this is a release build version
       def release_build?
-        !!(@prerelease.nil? && @build)
+        @prerelease.nil? && !@build.nil?
       end
 
       # @return [Boolean] Whether or not this is a pre-release build version
       def prerelease_build?
-        !!(@prerelease && @build)
+        !@prerelease.nil? && !@build.nil?
       end
 
       # @return [Boolean] Whether or not this is a build version
       def build?
-        !!@build
+        !@build.nil?
       end
 
       # Returns `true` if `other` and this {Format} share the same `major`,
@@ -126,8 +127,8 @@ module Mixlib
       # @return [Boolean]
       def in_same_release_line?(other)
         @major == other.major &&
-        @minor == other.minor &&
-        @patch == other.patch
+          @minor == other.minor &&
+          @patch == other.patch
       end
 
       # Returns `true` if `other` an share the same
@@ -137,9 +138,9 @@ module Mixlib
       # @return [Boolean]
       def in_same_prerelease_line?(other)
         @major == other.major &&
-        @minor == other.minor &&
-        @patch == other.patch &&
-        @prerelease == other.prerelease
+          @minor == other.minor &&
+          @patch == other.patch &&
+          @prerelease == other.prerelease
       end
 
       # @return [String] String representation of this {Format} instance
@@ -154,7 +155,7 @@ module Mixlib
         vars = instance_variables.map do |n|
           "#{n}=#{instance_variable_get(n).inspect}"
         end
-        "#<%s:0x%x %s>" % [self.class,object_id,vars.join(', ')]
+        format("#<%s:0x%x %s>", self.class, object_id, vars.join(", "))
       end
 
       # Returns SemVer compliant string representation of this {Format}
@@ -168,7 +169,7 @@ module Mixlib
       #   {Format} instance
       # @todo create a proper serialization abstraction
       def to_semver_string
-        s = [@major, @minor, @patch].join(".")
+        s = [@major, @minor, @patch].map(&:to_i).join(".")
         s += "-#{@prerelease}" if @prerelease
         s += "+#{@build}" if @build
         s
@@ -185,7 +186,7 @@ module Mixlib
       #   {Format} instance
       # @todo create a proper serialization abstraction
       def to_rubygems_string
-        s = [@major, @minor, @patch].join(".")
+        s = [@major, @minor, @patch].map(&:to_i).join(".")
         s += ".#{@prerelease}" if @prerelease
         s
       end
@@ -197,6 +198,10 @@ module Mixlib
       # @return [Integer] -1, 0, or 1 depending on whether the this version is
       #   less than, equal to, or greater than the other version
       def <=>(other)
+        # Check whether the `other' is a String and if so, then get an
+        # instance of *this* class (e.g., GitDescribe, OpscodeSemVer,
+        # SemVer, Rubygems, etc.), so we can compare against it.
+        other = self.class.new(other) if other.is_a?(String)
 
         # First, perform comparisons based on major, minor, and patch
         # versions.  These are always presnt and always non-nil
@@ -251,7 +256,7 @@ module Mixlib
         end
 
         # If we get down here, they're both equal
-        return 0
+        0
       end
 
       # @param other [Mixlib::Versioning::Format]
@@ -305,7 +310,7 @@ module Mixlib
 
         max_length = [a_components.length, b_components.length].max
 
-        (0..(max_length-1)).each do |i|
+        (0..(max_length - 1)).each do |i|
           # Convert the ith component into a number if possible
           a = maybe_int(a_components[i])
           b = maybe_int(b_components[i])
@@ -323,7 +328,7 @@ module Mixlib
           # Now we need to compare appropriately based on type.
           #
           # Numbers have lower precedence than strings; therefore, if
-          # the components are of differnt types (String vs. Integer),
+          # the components are of different types (String vs. Integer),
           # we just return -1 for the numeric one and we're done.
           #
           # If both are the same type (Integer vs. Integer, or String
@@ -343,9 +348,8 @@ module Mixlib
 
         # We've compared all components of both strings; if we've gotten
         # down here, they're totally the same
-        return 0
+        0
       end
-
     end # Format
   end # Versioning
 end # Mixlib

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

@@ -1,7 +1,7 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Author:: Christopher Maier (<cm@opscode.com>)
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Christopher Maier (<cm@chef.io>)
+# Copyright:: Copyright (c) 2013-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -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
@@ -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,7 +1,7 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Author:: Christopher Maier (<cm@opscode.com>)
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Christopher Maier (<cm@chef.io>)
+# Copyright:: Copyright (c) 2013-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,7 +17,7 @@
 # limitations under the License.
 #
 
-require 'mixlib/versioning/format/semver'
+require_relative "semver"
 
 module Mixlib
   class Versioning
@@ -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
+          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
   end # module Versioning