mixlib-versioning 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28ef6df6d8dc796e621f82bcee6b89aba96c33c5
+  data.tar.gz: 3e245ccbd6e91f1580fb46b9cceb8beaef3f9571
+SHA512:
+  metadata.gz: 5ad67861275ced52c5be0ef6f253a12417321b17c3f60211cc33e0a676224f0973270599fbc330be4ca67136f8f988128a67f25dc4dd98b3cf9e6108578a19e7
+  data.tar.gz: cf522492b9b76fad90a08330b7c5038c9b80e734fb6a309ff4925c3ee60400c294a62bb0d10355ed984ff868432636566224fcecf9c8166ec962308071f576da

data/.gitignore

@@ -3,6 +3,8 @@
 .bundle
 .config
 .yardoc
+.rspec
+.yardopts
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AbcSize:
+  Enabled: false
+BracesAroundHashParameters:
+  Enabled: false
+ClassLength:
+  Enabled: false
+CyclomaticComplexity:
+  Enabled: false
+Documentation:
+  Enabled: false
+Encoding:
+  Enabled: false
+LineLength:
+  Enabled: false
+MethodLength:
+  Enabled: false
+PerceivedComplexity:
+  Enabled: false
+RescueModifier:
+  Enabled: false
+TrailingComma:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,24 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+bundler_args: --jobs 7
+
+branches:
+  only:
+    - master
+
+script: bundle exec rake travis:ci
+
+notifications:
+  hipchat:
+    on_change: true
+    on_failure: true
+    on_success: false
+    on_pull_requests: false
+    rooms:
+      # Build Statuses
+      - secure: IycrY52k8dhilnU3B2c8mem9LzofQlMISUZSDk2tys0cvW0U3lnCQQiSvT5kTtiKztUABEiT2UqU2QYwUfeW/yYrO3NjB2OBqehRKnEn2oEaapcIugvtsQMySfYqJ7IsKpyh3vTMmgyKPw3OCKh5OJn26lMdHH2R91SXcbUezKI=
+      # Release Engineering
+      - secure: JJlujHzKxsY74bfJHNxH6fQOF5IULeJECXkxx6uU/T+CjxydINwAH5lQ1RUleLZlH0BmQDgxK+O46hiuWdYAyhgCJY9bQOBWG+aQusXIoLvV3qj+rU0dX1wvjEuO/NzkZTPZy7HMGqmCxTdmx/OawoNnpXU8qsI/OJqbISv2bGo=

data/CHANGELOG.md

@@ -1,3 +1,18 @@
-## 1.0.0
+v1.1.0 / 2015-06-15
+-------------------
+
+### New features
+
+* Allow parse to take a list of formats to choose from
+* Update to SemVer 2.0.0
+
+### Improvements
+
+* Add ability to compare directly with strings.
+* Lock to RuboCop 0.31.0 (also fix style errors)
+
+
+v1.0.0 / 2013-03-29
+-------------------
 
 * The initial release. Versioning parsing shouldn't suck.

data/Gemfile

@@ -1,9 +1,8 @@
 source 'https://rubygems.org'
-
 gemspec
 
 group :docs do
-  gem "yard", "~> 0.8.5"
-  gem "redcarpet", "~> 2.2.2"
-  gem "github-markup", "~> 0.7.5"
+  gem 'yard',          '~> 0.8'
+  gem 'redcarpet',     '~> 2.2'
+  gem 'github-markup', '~> 0.7'
 end

data/README.md

@@ -1,10 +1,15 @@
 # Mixlib::Versioning
 
+[![Build Status](https://travis-ci.org/chef/mixlib-versioning.png?branch=master)](https://travis-ci.org/chef/mixlib-versioning)
+[![Code Climate](https://codeclimate.com/github/chef/mixlib-versioning.png)](https://codeclimate.com/github/chef/mixlib-versioning)
+
+This project is managed by the CHEF Release Engineering team. For more information on the Release Engineering team's contribution, triage, and release process, please consult the [CHEF Release Engineering OSS Management Guide](https://docs.google.com/a/chef.io/document/d/1oJB0vZb_3bl7_ZU2YMDBkMFdL-EWplW1BJv_FXTUOzg/edit).
+
 Versioning is hard! `mixlib-versioning` is a general Ruby library that allows
 you to parse, compare and manipulate version numbers in multiple formats.
 Currently the following version string formats are supported:
 
-### SemVer 2.0.0-rc.1
+### SemVer 2.0.0
 
 **Specification:**
 
@@ -227,7 +232,7 @@ false
   [1] #<Mixlib::Versioning::Format::OpscodeSemVer:0x3ff009d07260 @major=11, @minor=0, @patch=0, @prerelease="rc.1", @build=nil, @input="11.0.0-rc.1">,
   [2] #<Mixlib::Versioning::Format::OpscodeSemVer:0x3ff009d0d3cc @major=11, @minor=0, @patch=0, @prerelease=nil, @build=nil, @input="11.0.0">
 ]
->> [v3, v1, v2].map{|v| v.to_s}.sort
+>> [v3, v1, v2].map { |v| v.to_s}.sort
 [
   [0] "11.0.0",
   [1] "11.0.0-beta.1",
@@ -331,21 +336,12 @@ All documentation is written using YARD. You can generate a by running:
 rake yard
 ```
 
-## Contributing
-
-See the [CONTRIBUTING](CONTRIBUTING.md) document.
-
-## Reporting Bugs
-
-You can search for known issues in [Opscode's bug tracker][jira]. Tickets
-should be filed under the **MIXLIB** project with the component set to
-**"mixlib-versioning"**.
-
 ## License
 
 |                      |                                          |
 |:---------------------|:-----------------------------------------|
-| **Author:**          | Seth Chisamore (schisamo@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
 
@@ -360,5 +356,3 @@ 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.
-
-[jira]: http://tickets.opscode.com/browse/MIXLIB

data/Rakefile

@@ -1,6 +1,18 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
 require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:unit)
+
+require 'rubocop/rake_task'
+desc 'Run Ruby style checks'
+RuboCop::RakeTask.new(:style)
+
 require 'yard'
+YARD::Rake::YardocTask.new(:doc)
+
+namespace :travis do
+  desc 'Run tests on Travis'
+  task ci: [:style, :unit]
+end
 
-RSpec::Core::RakeTask.new(:spec)
-YARD::Rake::YardocTask.new
+task default: [:style, :unit]

data/lib/mixlib/versioning.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
 #
@@ -21,46 +21,50 @@ require 'mixlib/versioning/exceptions'
 require 'mixlib/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,
+    ].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)
+    def self.parse(version_string, format = nil)
+      if version_string.is_a?(Mixlib::Versioning::Format)
         return version_string
-      elsif format_type
-        return Mixlib::Versioning::Format.for(format_type).new(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
@@ -103,7 +107,7 @@ module Mixlib
     #             11.0.1 }
     #
     #   Mixlib::Versioning.find_target_version(all,
-    #                                          "11.0.1",
+    #                                          '11.0.1',
     #                                          true,
     #                                          true)
     #
@@ -124,19 +128,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 +157,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
@@ -189,6 +193,5 @@ module Mixlib
         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,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
 #

data/lib/mixlib/versioning/format.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
 #
@@ -23,8 +23,7 @@ require 'mixlib/versioning/format/semver'
 
 module Mixlib
   class Versioning
-
-    # @author Seth Chisamore (<schisamo@opscode.com>)
+    # @author Seth Chisamore (<schisamo@chef.io>)
     #
     # @!attribute [r] major
     #   @return [Integer] major identifier
@@ -60,18 +59,18 @@ module Mixlib
       # @return [Class] the {Mixlib::Versioning::Format} class
       #
       def self.for(format_type)
-        if format_type.kind_of?(Class) &&
+        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
           else
-            msg = "'#{format_type.to_s}' is not a supported Mixlib::Versioning format"
-            raise Mixlib::Versioning::UnknownFormatError, msg
+            msg = "'#{format_type}' is not a supported Mixlib::Versioning format"
+            fail Mixlib::Versioning::UnknownFormatError, msg
           end
         end
       end
@@ -90,8 +89,8 @@ module Mixlib
       #
       # @param version_string [String] string representation of the version
       # @raise [Mixlib::Versioning::ParseError] raised if parsing fails
-      def parse(version_string)
-        raise Error, "You must override the #parse"
+      def parse(_version_string)
+        fail Error, 'You must override the #parse'
       end
 
       # @return [Boolean] Whether or not this is a release version
@@ -101,22 +100,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 +125,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 +136,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 +153,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 +167,7 @@ module Mixlib
       #   {Format} instance
       # @todo create a proper serialization abstraction
       def to_semver_string
-        s = [@major, @minor, @patch].join(".")
+        s = [@major, @minor, @patch].join('.')
         s += "-#{@prerelease}" if @prerelease
         s += "+#{@build}" if @build
         s
@@ -185,7 +184,7 @@ module Mixlib
       #   {Format} instance
       # @todo create a proper serialization abstraction
       def to_rubygems_string
-        s = [@major, @minor, @patch].join(".")
+        s = [@major, @minor, @patch].join('.')
         s += ".#{@prerelease}" if @prerelease
         s
       end
@@ -197,6 +196,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 +254,7 @@ module Mixlib
         end
 
         # If we get down here, they're both equal
-        return 0
+        0
       end
 
       # @param other [Mixlib::Versioning::Format]
@@ -266,7 +269,7 @@ module Mixlib
       end
 
       def hash
-        [@major, @minor, @patch, @prerelease, @build].compact.join(".").hash
+        [@major, @minor, @patch, @prerelease, @build].compact.join('.').hash
       end
 
       #########################################################################
@@ -300,12 +303,12 @@ module Mixlib
       # Both `a_item` and `b_item` should be Strings; `nil` is not a
       # valid input.
       def compare_dot_components(a_item, b_item)
-        a_components = a_item.split(".")
-        b_components = b_item.split(".")
+        a_components = a_item.split('.')
+        b_components = b_item.split('.')
 
         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])
@@ -343,9 +346,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