mixlib-versioning 1.0.0 → 1.2.12

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

@@ -0,0 +1,62 @@
+#
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Christopher Maier (<cm@chef.io>)
+# Author:: Ryan Hass (<rhass@chef.io>)
+# Copyright:: Copyright (c) 2017-2018 Chef Software 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 partial version strings.
+      # -----------------
+      # ```text
+      # MAJOR
+      # MAJOR.MINOR
+      # ```
+      #
+      # EXAMPLES
+      # --------
+      # ```text
+      # 11
+      # 11.0
+      # ```
+      #
+      # @author Seth Chisamore (<schisamo@chef.io>)
+      # @author Christopher Maier (<cm@chef.io>)
+      # @author Ryan Hass (<rhass@chef.io>)
+      class PartialSemVer < Format
+        #  http://rubular.com/r/NmRSN8vCie
+        PARTIAL_REGEX = /^(\d+)\.?(?:(\d*))$/
+        # @see Format#parse
+        def parse(version_string)
+          match = version_string.match(PARTIAL_REGEX) rescue nil
+
+          unless match
+            raise Mixlib::Versioning::ParseError, "'#{version_string}' is not a valid #{self.class} version string!"
+          end
+
+          @major, @minor = match[1..2]
+          @major, @minor, @patch = [@major, @minor, @patch].map(&:to_i)
+
+          # Partial versions do not contain these values, so we just set them to nil.
+          @prerelease = nil
+          @build      = nil
+        end
+      end # class Partial
+    end # class Format
+  end # module Versioning
+end # module Mixlib

data/lib/mixlib/versioning/format/rubygems.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");
@@ -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
@@ -54,12 +53,17 @@ module Mixlib
           end
 
           @major, @minor, @patch, @prerelease, @iteration = match[1..5]
-          @major, @minor, @patch, @iteration = [@major, @minor, @patch, @iteration].map(&:to_i)
+          @major, @minor, @patch = [@major, @minor, @patch].map(&:to_i)
 
-          # Do not convert @build to an integer; SemVer sorting logic will handle the conversion
-          @prerelease = nil if (@prerelease.nil? || @prerelease.empty?)
+          # Do not convert @prerelease or @iteration to an integer;
+          # sorting logic will handle the conversion.
+          @iteration = if @iteration.nil? || @iteration.empty?
+                         nil
+                       else
+                         @iteration.to_i
+                       end
+          @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,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");
@@ -28,7 +28,7 @@ module Mixlib
       # MAJOR.MINOR.PATCH
       # MAJOR.MINOR.PATCH-PRERELEASE
       # MAJOR.MINOR.PATCH-PRERELEASE+BUILD
-      #```
+      # ```
       #
       # EXAMPLES
       # --------
@@ -39,11 +39,10 @@ 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)
@@ -56,10 +55,9 @@ module Mixlib
           @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,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");
@@ -18,6 +18,6 @@
 
 module Mixlib
   class Versioning
-    VERSION = "1.0.0"
+    VERSION = "1.2.12"
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-versioning
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.2.12
 platform: ruby
 authors:
 - Seth Chisamore
@@ -10,118 +9,47 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2019-12-30 00:00:00.000000000 Z
+dependencies: []
 description: General purpose Ruby library that allows you to parse, compare and manipulate
   version strings in multiple formats.
-email:
-- schisamo@opscode.com
-- cm@opscode.com
+email: info@chef.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .yardopts
-- CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE
-- README.md
-- Rakefile
 - lib/mixlib/versioning.rb
 - lib/mixlib/versioning/exceptions.rb
 - lib/mixlib/versioning/format.rb
 - lib/mixlib/versioning/format/git_describe.rb
 - lib/mixlib/versioning/format/opscode_semver.rb
+- lib/mixlib/versioning/format/partial_semver.rb
 - lib/mixlib/versioning/format/rubygems.rb
 - lib/mixlib/versioning/format/semver.rb
 - lib/mixlib/versioning/version.rb
-- mixlib-versioning.gemspec
-- spec/mixlib/versioning/format/git_describe_spec.rb
-- spec/mixlib/versioning/format/opscode_semver_spec.rb
-- spec/mixlib/versioning/format/rubygems_spec.rb
-- spec/mixlib/versioning/format/semver_spec.rb
-- spec/mixlib/versioning/format_spec.rb
-- spec/mixlib/versioning/versioning_spec.rb
-- spec/spec_helper.rb
-- spec/support/shared_examples/basic_semver.rb
-- spec/support/shared_examples/behaviors/filterable.rb
-- spec/support/shared_examples/behaviors/parses_valid_version_strings.rb
-- spec/support/shared_examples/behaviors/rejects_invalid_version_strings.rb
-- spec/support/shared_examples/behaviors/serializable.rb
-- spec/support/shared_examples/behaviors/sortable.rb
-- spec/support/shared_examples/semver.rb
-homepage: https://github.com/opscode/mixlib-versioning
-licenses: []
+homepage: https://github.com/chef/mixlib-versioning
+licenses:
+- Apache-2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: General purpose Ruby library that allows you to parse, compare and manipulate
   version strings in multiple formats.
-test_files:
-- spec/mixlib/versioning/format/git_describe_spec.rb
-- spec/mixlib/versioning/format/opscode_semver_spec.rb
-- spec/mixlib/versioning/format/rubygems_spec.rb
-- spec/mixlib/versioning/format/semver_spec.rb
-- spec/mixlib/versioning/format_spec.rb
-- spec/mixlib/versioning/versioning_spec.rb
-- spec/spec_helper.rb
-- spec/support/shared_examples/basic_semver.rb
-- spec/support/shared_examples/behaviors/filterable.rb
-- spec/support/shared_examples/behaviors/parses_valid_version_strings.rb
-- spec/support/shared_examples/behaviors/rejects_invalid_version_strings.rb
-- spec/support/shared_examples/behaviors/serializable.rb
-- spec/support/shared_examples/behaviors/sortable.rb
-- spec/support/shared_examples/semver.rb
-has_rdoc: 
+test_files: []

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-bin/

data/.yardopts

@@ -1,7 +0,0 @@
---markup=markdown
---markup-provider=redcarpet
---readme=README.md
--
-CHANGELOG.md
-CONTRIBUTING.md
-LICENSE

data/CHANGELOG.md

@@ -1,3 +0,0 @@
-## 1.0.0
-
-* The initial release. Versioning parsing shouldn't suck.

data/CONTRIBUTING.md

@@ -1,188 +0,0 @@
-[jira-project]: http://tickets.opscode.com/browse/MIXLIB
-[github-project]: http://www.github.com/opscode/mixlib-versioning
-[github-opscode]: http://www.github.com/opscode
-[cla]: https://secure.echosign.com/public/hostedForm?formid=PJIF5694K6L
-[cla-corp]: https://secure.echosign.com/public/hostedForm?formid=PIE6C7AX856
-[wiki-contribute]: http://wiki.opscode.com/display/chef/How+to+Contribute
-[wiki-git]: http://wiki.opscode.com/display/chef/Working+with+Git
-[wiki-code-review]: http://wiki.opscode.com/display/chef/Code+Review
-[list-chef-dev]: http://lists.opscode.com/sympa/info/chef-dev
-
-# Contributing to Mixlib::Versioning
-
-We are glad you want to contribute to `Mixlib::Versioning`! The first step is
-the desire to improve the project.
-
-You can find the answers to additional frequently asked questions
-[on the wiki][wiki-contribute].
-
-## Quick-contribute
-
-* Create an account on our [bug tracker][jira-project]
-* Sign our contributor agreement (CLA) [online][cla] (keep reading if you're
-  contributing on behalf of your employer)
-* Create a ticket for your change on the [bug tracker][jira-project]. Tickets
-  should be filed under the **MIXLIB** project with the component set to
-  **mixlib-versioning**.
-* Link to your patch as a rebased git branch or pull request from the ticket
-* Resolve the ticket as fixed
-
-We regularly review contributions and will get back to you if we have any
-suggestions or concerns.
-
-## The Apache License and the CLA/CCLA
-
-Licensing is very important to open source projects, it helps ensure the
-software continues to be available under the terms that the author desired.
-This project uses the Apache 2.0 license to strike a balance between open
-contribution and allowing you to use the software however you would like to.
-
-The license tells you what rights you have that are provided by the copyright
-holder. It is important that the contributor fully understands what rights they
-are licensing and agrees to them. Sometimes the copyright holder isn't the
-contributor, most often when the contributor is doing work for a company.
-
-To make a good faith effort to ensure these criteria are met, Opscode requires
-a Contributor License Agreement (CLA) or a Corporate Contributor License
-Agreement (CCLA) for all contributions. This is without exception due to some
-matters not being related to copyright and to avoid having to continually check
-with our lawyers about small patches.
-
-It only takes a few minutes to complete a CLA, and you retain the copyright to
-your contribution.
-
-You can complete our contributor agreement (CLA) [online][cla]. If you're
-contributing on behalf of your employer, have your employer fill out our
-[Corporate CLA][cla-corp] instead.
-
-## Ticket Tracker (JIRA)
-
-The [ticket tracker][jira-project] is the most important documentation for the
-code base. It provides significant historical information, such as:
-
-* Which release a bug fix is included in
-* Discussion regarding the design and merits of features
-* Error output to aid in finding similar bugs
-
-Each ticket should aim to fix one bug or add one feature.
-
-## Using git
-
-You can get a quick copy of this project's repository by running:
-
-```shell
-git clone git://github.com/opscode/mixlib-versioning.git
-```
-
-For collaboration purposes, it is best if you create a Github account and fork
-the repository to your own account. Once you do this you will be able to push
-your changes to your Github repository for others to see and use.
-
-### Branches and Commits
-
-You should submit your patch as a git branch named after the ticket, such as
-MIXLIB-1337. This is called a _topic branch_ and allows users to associate a
-branch of code with the ticket.
-
-It is a best practice to have your commit message have a _summary line_ that
-includes the ticket number, followed by an empty line and then a brief
-description of the commit. This also helps other contributors understand the
-purpose of changes to the code. Here is an example from the Chef project:
-
-    CHEF-3435: Create deploy dirs before calling scm_provider
-
-    The SCM providers have an assertation that requires the deploy directory to
-    exist. The deploy provider will create missing directories, we don't converge
-    the actions before we call run_action against the SCM provider, so it is not
-    yet created. This ensures we run any converge actions waiting before we call
-    the SCM provider.
-
-Remember that not all users use this library in the same way or on the same
-operating systems as you, so it is helpful to be clear about your use case and
-change so they can understand it even when it doesn't apply to them.
-
-### Github and Pull Requests
-
-All of Opscode's open source projects are available on [Github][github-opscode].
-
-We don't require you to use Github, and we will even take patch diffs attached
-to tickets on the tracker. However Github has a lot of convenient features,
-such as being able to see a diff of changes between a pull request and the main
-repository quickly without downloading the branch.
-
-If you do choose to use a pull request, please provide a link to the pull
-request from the ticket __and__ a link to the ticket from the pull request.
-Because pull requests only have two states, open and closed, we can't easily
-filter pull requests that are waiting for a reply from the author for various
-reasons.
-
-### More information
-
-Additional help with git is available on the [Working with Git][wiki-git] wiki
-page.
-
-## Functional and Unit Tests
-
-There are rspec unit tests in the 'spec' directory. If you don't have rspec
-already installed, you can use the 'bundler' gem to help you get the necessary
-prerequisites by running `sudo gem install bundler` and then `bundle install`
-from the project root. You can run the project's spec tests by running
-`rspec spec/*` or `rake spec` from the root directory of the this repository.
-
-It is good to run the tests once on your system before you get started to
-ensure they all pass so you have a valid baseline. After you write your patch,
-run the tests again to see if they all pass.
-
-If any don't pass, investigate them before submitting your patch.
-
-These tests don't modify your system, and sometimes tests fail because a
-command that would be run has changed because of your patch. This should be a
-simple fix. Other times the failure can show you that an important feature no
-longer works because of your change.
-
-Any new feature should have unit tests included with the patch with good code
-coverage to help protect it from future changes. Similarly, patches that fix a
-bug or regression should have a _regression test_. Simply put, this is a test
-that would fail without your patch but passes with it. The goal is to ensure
-this bug doesn't regress in the future. Consider a regular expression that
-doesn't match a certain pattern that it should, so you provide a patch and a
-test to ensure that the part of the code that uses this regular expression
-works as expected. Later another contributor may modify this regular expression
-in a way that breaks your use cases. The test you wrote will fail, signalling
-to them to research your ticket and use case and accounting for it.
-
-## Code Review
-
-Opscode regularly reviews code contributions and provides suggestions for
-improvement in the code itself or the implementation.
-
-We find contributions by searching the ticket tracker for _resolved_ tickets
-with a status of _fixed_. If we have feedback we will reopen the ticket and you
-should resolve it again when you've made the changes or have a response to our
-feedback. When we believe the patch is ready to be merged, we update the status
-to _Fix Reviewed_.
-
-Depending on the project, these tickets are then merged within a week or two,
-depending on the current release cycle. At this point the ticket status will be
-updated to _Fix Committed_ or _Closed_.
-
-Please see the [Code Review][wiki-code-review] page on the wiki for additional
-information.
-
-## Release Cycle
-
-The versioning for the this project is X.Y.Z and follows
-[SemVer 2.0.0-rc.1 conventions](http://semver.org/):
-
-* X is a major release, which may not be fully compatible with prior major releases
-* Y is a minor release, which adds both new features and bug fixes
-* Z is a patch release, which adds just bug fixes
-
-There are usually beta releases and release candidates (RC) of major and minor
-releases announced on the [chef-dev mailing list][list-chef-dev]. Once an
-RC is released, we wait at least three days to allow for testing for regressions
-before the final release. If a blocking regression is found then another RC is
-made containing the fix and the timer is reset.
-
-Once the official release is made, the release notes are available on the
-[Opscode blog](http://www.opscode.com/blog).