mixlib-versioning 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28ef6df6d8dc796e621f82bcee6b89aba96c33c5
-  data.tar.gz: 3e245ccbd6e91f1580fb46b9cceb8beaef3f9571
+  metadata.gz: 75105073144a2c6b947409ff31f4fae6aaa4fb77
+  data.tar.gz: 27c19f85adc97a86c005da5233187ddfee957eee
 SHA512:
-  metadata.gz: 5ad67861275ced52c5be0ef6f253a12417321b17c3f60211cc33e0a676224f0973270599fbc330be4ca67136f8f988128a67f25dc4dd98b3cf9e6108578a19e7
-  data.tar.gz: cf522492b9b76fad90a08330b7c5038c9b80e734fb6a309ff4925c3ee60400c294a62bb0d10355ed984ff868432636566224fcecf9c8166ec962308071f576da
+  metadata.gz: d6affd7ced58f3caf0ebd9e091e7cdd96745c3cfb0c0e95ab0fc462af358194fb7142c61087acdad3c5934dddfebcf411d4afdb33433654ff3f66419dcd84581
+  data.tar.gz: cc5f16b52af8badc2e016a97f1d799e62e81e29548836b420bac1bf47a6b7282f5b6ef14d36b596e0e8f2970d57f0198c08f4ba296253d416b405da65aa0b43b

data/.expeditor/config.yml

@@ -0,0 +1,14 @@
+slack:
+  notify_channel: eng-services-alerts
+
+github:
+  maintainer_group: chef/engineering-services
+  version_tag_format: v{{version}}
+
+merge_actions:
+  built_in:bump_version:
+    ignore_labels: "Version: Skip Bump"
+  bash:.expeditor/update_version.sh:
+    only_if: built_in:bump_version
+  built_in:update_changelog:
+    ignore_labels: "Changelog: Skip Update"

data/.expeditor/update_version.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+#
+# After a PR merge, Chef Expeditor will bump the PATCH version in the VERSION file.
+# It then executes this file to update any other files/components with that new version.
+#
+
+set -evx
+
+sed -i -r "s/VERSION = \".+\"/VERSION = \"$(cat VERSION)\"/" lib/mixlib/versioning/version.rb

data/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Order is important. The last matching pattern has the most precedence.
+
+* @chef/engineering-services

data/.travis.yml

@@ -1,24 +1,25 @@
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-
-bundler_args: --jobs 7
+sudo: false
+language: ruby
+cache: bundler
 
+matrix:
+  include:
+    - rvm: 2.3.4
+    - rvm: 2.4.1
+    - rvm: ruby-head
+  allow_failures:
+    - rvm: ruby-head
 branches:
   only:
-    - master
+  - master
+
+bundler_args: --without changelog
 
-script: bundle exec rake travis:ci
+before_install:
+  - gem install bundler
+  - bundle --version
+  - gem update --system
+  - gem --version
 
-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=
+script:
+  - bundle exec rake travis:ci

data/CHANGELOG.md

@@ -1,18 +1,32 @@
-v1.1.0 / 2015-06-15
--------------------
+# Mixlib::Versioning Changes
 
-### New features
+<!-- latest_release -->
+## [v1.2.1](https://github.com/chef/mixlib-versioning/tree/v1.2.1) (2017-07-24)
+
+#### Merged Pull Requests
+- Use Expeditor for version bumping and CHANGELOG generation [#23](https://github.com/chef/mixlib-versioning/pull/23) ([schisamo](https://github.com/schisamo))
+<!-- latest_release -->
+
+<!-- release_rollup -->
+### Changes since latest stable release
+
+#### Merged Pull Requests
+- Use Expeditor for version bumping and CHANGELOG generation [#23](https://github.com/chef/mixlib-versioning/pull/23) ([schisamo](https://github.com/schisamo)) <!-- 1.2.1 -->
+<!-- release_rollup -->
+
+## [1.1.0](https://github.com/chef/mixlib-versioning/tree/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
+#### Improvements
 
 * Add ability to compare directly with strings.
 * Lock to RuboCop 0.31.0 (also fix style errors)
 
 
-v1.0.0 / 2013-03-29
--------------------
+## [1.0.0](https://github.com/chef/mixlib-versioning/tree/v1.0.0) (2013-03-29)
 
-* The initial release. Versioning parsing shouldn't suck.
+* The initial release. Versioning parsing shouldn't suck.

data/Gemfile

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

data/README.md

@@ -1,19 +1,16 @@
 # 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)
+[![Build Status](https://travis-ci.org/chef/mixlib-versioning.svg?branch=master)](https://travis-ci.org/chef/mixlib-versioning) [![Code Climate](https://codeclimate.com/github/chef/mixlib-versioning.svg)](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:
+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
+## SemVer 2.0.0
 
 **Specification:**
 
-http://semver.org/
+<http://semver.org/>
 
 **Supported Formats:**
 
@@ -23,10 +20,9 @@ MAJOR.MINOR.PATCH-PRERELEASE
 MAJOR.MINOR.PATCH-PRERELEASE+BUILD
 ```
 
-Not much to say here except: *YUNO USE SEMVER!* The specification is focused and
-brief, do yourself a favor and go read it.
+Not much to say here except: _YUNO USE SEMVER!_ The specification is focused and brief, do yourself a favor and go read it.
 
-### Opscode SemVer
+## Opscode SemVer
 
 **Supported Formats:**
 
@@ -43,11 +39,9 @@ MAJOR.MINOR.PATCH-beta.INDEX+YYYYMMDDHHMMSS.git.COMMITS_SINCE.SHA1
 MAJOR.MINOR.PATCH-rc.INDEX+YYYYMMDDHHMMSS.git.COMMITS_SINCE.SHA1
 ```
 
-All the fun of regular SemVer with some extra limits around what constitutes a
-valid pre-release or build version string.
+All the fun of regular SemVer with some extra limits around what constitutes a valid pre-release or build version string.
 
-Valid prerelease version strings use the format: `PRERELEASE_STAGE.INDEX`.
-Valid prerelease stages include: `alpha`, `beta` and `rc`.
+Valid prerelease version strings use the format: `PRERELEASE_STAGE.INDEX`. Valid prerelease stages include: `alpha`, `beta` and `rc`.
 
 All of the following are acceptable Opscode SemVer pre-release versions:
 
@@ -60,9 +54,7 @@ All of the following are acceptable Opscode SemVer pre-release versions:
 11.0.8-rc.2
 ```
 
-Build version strings are limited to timestamps (`YYYYMMDDHHMMSS`), git
-describe strings (`git.COMMITS_SINCE.SHA1`) or a combination of the two
-(`YYYYMMDDHHMMSS.git.COMMITS_SINCE.SHA1`).
+Build version strings are limited to timestamps (`YYYYMMDDHHMMSS`), git describe strings (`git.COMMITS_SINCE.SHA1`) or a combination of the two (`YYYYMMDDHHMMSS.git.COMMITS_SINCE.SHA1`).
 
 All of the following are acceptable Opscode build versions:
 
@@ -79,13 +71,13 @@ And as is true with regular SemVer you can mix pre-release and build versions:
 11.0.8-alpha.2+20130308110833.git.2.94a1dde
 ```
 
-### Rubygems
+## Rubygems
 
 **specification:**
 
-http://docs.rubygems.org/read/chapter/7
+<http://docs.rubygems.org/read/chapter/7>
 
-http://guides.rubygems.org/patterns/
+<http://guides.rubygems.org/patterns/>
 
 **Supported Formats:**
 
@@ -94,9 +86,7 @@ MAJOR.MINOR.PATCH
 MAJOR.MINOR.PATCH.PRERELEASE
 ```
 
-Rubygems is *almost* SemVer compliant but it separates the main version from
-the pre-release version using a "dot". It also does not have the notion of a
-build version like SemVer.
+Rubygems is _almost_ SemVer compliant but it separates the main version from the pre-release version using a "dot". It also does not have the notion of a build version like SemVer.
 
 Examples of valid Rubygems version strings:
 
@@ -108,11 +98,11 @@ Examples of valid Rubygems version strings:
 10.1.1.rc.0
 ```
 
-### Git Describe
+## Git Describe
 
 **Specification:**
 
-http://git-scm.com/docs/git-describe
+<http://git-scm.com/docs/git-describe>
 
 **Supported Formats:**
 
@@ -132,19 +122,42 @@ Examples of valid Git Describe version strings:
 11.0.0-alpha.1-1-gcea071e
 ```
 
+
+## SemVer Partial
+
+
+```text
+MAJOR
+MAJOR.MINOR
+```
+
+Examples of valid SemVer Partial version strings:
+
+```text
+1
+0.1
+1.0
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'mixlib-versioning'
+```
+gem 'mixlib-versioning'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install mixlib-semver
+```
+$ gem install mixlib-semver
+```
 
 ## Usage
 
@@ -336,15 +349,20 @@ All documentation is written using YARD. You can generate a by running:
 rake yard
 ```
 
+## Contributing
+
+For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
+
 ## License
 
 |                      |                                          |
 |:---------------------|:-----------------------------------------|
 | **Author:**          | Seth Chisamore (schisamo@chef.io)
 | **Author:**          | Christopher Maier (cm@chef.io)
-| **Copyright:**       | Copyright (c) 2013 Opscode, Inc.
+| **Copyright:**       | Copyright (c) 2013-2017 Chef Software, Inc.
 | **License:**         | Apache License, Version 2.0
 
+```text
 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
@@ -356,3 +374,4 @@ 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.
+```

data/Rakefile

@@ -1,17 +1,31 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+require "mixlib/versioning/version"
 
-require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:unit)
 
-require 'rubocop/rake_task'
-desc 'Run Ruby style checks'
+require "chefstyle"
+require "rubocop/rake_task"
+desc "Run Ruby style checks"
 RuboCop::RakeTask.new(:style)
 
-require 'yard'
+require "yard"
 YARD::Rake::YardocTask.new(:doc)
 
+begin
+  require "github_changelog_generator/task"
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.issues = false
+    config.future_release = Mixlib::Versioning::VERSION
+  end
+rescue LoadError
+  puts "github_changelog_generator is not available. gem install github_changelog_generator to generate changelogs"
+end
+
 namespace :travis do
-  desc 'Run tests on Travis'
+  desc "Run tests on Travis"
   task ci: [:style, :unit]
 end
 

data/VERSION

@@ -0,0 +1 @@
+1.2.1

data/lib/mixlib/versioning.rb

@@ -2,6 +2,7 @@
 # Author:: Seth Chisamore (<schisamo@chef.io>)
 # Author:: Christopher Maier (<cm@chef.io>)
 # Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Copyright:: Copyright (c) 2017 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,8 +18,8 @@
 # limitations under the License.
 #
 
-require 'mixlib/versioning/exceptions'
-require 'mixlib/versioning/format'
+require "mixlib/versioning/exceptions"
+require "mixlib/versioning/format"
 
 module Mixlib
   # @author Seth Chisamore (<schisamo@chef.io>)
@@ -29,6 +30,7 @@ module Mixlib
       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
@@ -55,7 +57,7 @@ module Mixlib
     #
     def self.parse(version_string, format = nil)
       if version_string.is_a?(Mixlib::Versioning::Format)
-        return version_string
+        version_string
       else
         formats = if format
                     [format].flatten.map { |f| Mixlib::Versioning::Format.for(f) }
@@ -71,7 +73,7 @@ module Mixlib
             next
           end
         end
-        return parsed_version
+        parsed_version
       end
     end
 
@@ -135,7 +137,7 @@ module Mixlib
       # attempt to parse a `Mixlib::Versioning::Format` instance if we were
       # passed a string
       unless filter_version.nil? ||
-             filter_version.is_a?(Mixlib::Versioning::Format)
+          filter_version.is_a?(Mixlib::Versioning::Format)
         filter_version = Mixlib::Versioning.parse(filter_version)
       end
 
@@ -181,13 +183,13 @@ 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

data/lib/mixlib/versioning/format.rb

@@ -1,6 +1,7 @@
 #
 # Author:: Seth Chisamore (<schisamo@chef.io>)
 # Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Copyright:: Copyright (c) 2017 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,10 +17,11 @@
 # 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 "mixlib/versioning/format/git_describe"
+require "mixlib/versioning/format/opscode_semver"
+require "mixlib/versioning/format/rubygems"
+require "mixlib/versioning/format/semver"
+require "mixlib/versioning/format/partial_semver"
 
 module Mixlib
   class Versioning
@@ -30,15 +32,15 @@ module Mixlib
     # @!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 +62,18 @@ module Mixlib
       #
       def self.for(format_type)
         if format_type.is_a?(Class) &&
-           format_type.ancestors.include?(Mixlib::Versioning::Format)
+            format_type.ancestors.include?(Mixlib::Versioning::Format)
           format_type
         else
           case format_type.to_s
-          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 "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}' is not a supported Mixlib::Versioning format"
-            fail Mixlib::Versioning::UnknownFormatError, msg
+            raise Mixlib::Versioning::UnknownFormatError, msg
           end
         end
       end
@@ -90,7 +93,7 @@ module Mixlib
       # @param version_string [String] string representation of the version
       # @raise [Mixlib::Versioning::ParseError] raised if parsing fails
       def parse(_version_string)
-        fail Error, 'You must override the #parse'
+        raise Error, "You must override the #parse"
       end
 
       # @return [Boolean] Whether or not this is a release version
@@ -153,7 +156,7 @@ module Mixlib
         vars = instance_variables.map do |n|
           "#{n}=#{instance_variable_get(n).inspect}"
         end
-        format('#<%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}
@@ -167,7 +170,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
@@ -184,7 +187,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
@@ -269,7 +272,7 @@ module Mixlib
       end
 
       def hash
-        [@major, @minor, @patch, @prerelease, @build].compact.join('.').hash
+        [@major, @minor, @patch, @prerelease, @build].compact.join(".").hash
       end
 
       #########################################################################
@@ -303,8 +306,8 @@ 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