mixlib-versioning 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.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

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

data/CHANGELOG.md

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

data/CONTRIBUTING.md

@@ -0,0 +1,188 @@
+[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).

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.md

@@ -0,0 +1,364 @@
+# Mixlib::Versioning
+
+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
+
+**Specification:**
+
+http://semver.org/
+
+**Supported Formats:**
+
+```text
+MAJOR.MINOR.PATCH
+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.
+
+### Opscode SemVer
+
+**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
+```
+
+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`.
+
+All of the following are acceptable Opscode SemVer pre-release versions:
+
+```text
+11.0.8-alpha.0
+11.0.8-alpha.1
+11.0.8-beta.7
+11.0.8-beta.8
+11.0.8-rc.1
+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`).
+
+All of the following are acceptable Opscode build versions:
+
+```text
+11.0.8+20130308110833
+11.0.8+git.2.g94a1dde
+11.0.8+20130308110833.git.2.94a1dde
+```
+
+And as is true with regular SemVer you can mix pre-release and build versions:
+
+```text
+11.0.8-rc.1+20130308110833
+11.0.8-alpha.2+20130308110833.git.2.94a1dde
+```
+
+### Rubygems
+
+**specification:**
+
+http://docs.rubygems.org/read/chapter/7
+
+http://guides.rubygems.org/patterns/
+
+**Supported Formats:**
+
+```text
+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.
+
+Examples of valid Rubygems version strings:
+
+```text
+10.1.1
+10.1.1
+10.1.1.alpha.1
+10.1.1.beta.1
+10.1.1.rc.0
+```
+
+### Git Describe
+
+**Specification:**
+
+http://git-scm.com/docs/git-describe
+
+**Supported Formats:**
+
+```text
+MAJOR.MINOR.PATCH-COMMITS_SINCE-gGIT_SHA1
+MAJOR.MINOR.PATCH-COMMITS_SINCE-gGIT_SHA1-ITERATION
+MAJOR.MINOR.PATCH-PRERELEASE-COMMITS_SINCE-gGIT_SHA1
+MAJOR.MINOR.PATCH-PRERELEASE-COMMITS_SINCE-gGIT_SHA1-ITERATION
+```
+
+Examples of valid Git Describe version strings:
+
+```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
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mixlib-versioning'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mixlib-semver
+
+## Usage
+
+### Basic Version String Parsing
+
+```irb
+>> require 'mixlib/versioning'
+true
+>> v1 = Mixlib::Versioning.parse("11.0.3")
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3fecddccff4c @major=11, @minor=0, @patch=3, @prerelease=nil, @build=nil, @input="11.0.3">
+>> v1.release?
+true
+>> v1.prerelease?
+false
+>> v1.build?
+false
+>> v1.prerelease_build?
+false
+>> v2 = Mixlib::Versioning.parse("11.0.0-beta.1")
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3fecde44f420 @major=11, @minor=0, @patch=0, @prerelease="beta.1", @build=nil, @input="11.0.0-beta.1">
+>> v2.release?
+false
+>> v2.prerelease?
+true
+>> v2.build?
+false
+>> v2.prerelease_build?
+false
+>> v3 = Mixlib::Versioning.parse("11.0.6+20130216075209")
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3fecde49568c @major=11, @minor=0, @patch=6, @prerelease=nil, @build="20130216075209", @input="11.0.6+20130216075209">
+>> v3.release?
+false
+>> v3.prerelease?
+false
+>> v3.build?
+true
+>> v3.prerelease_build?
+false
+>> v4 = Mixlib::Versioning.parse("11.0.8-rc.1+20130302083119")
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3fecde4dad7c @major=11, @minor=0, @patch=8, @prerelease="rc.1", @build="20130302083119", @input="11.0.8-rc.1+20130302083119">
+>> v4.release?
+false
+>> v4.prerelease?
+false
+>> v4.build?
+true
+>> v4.prerelease_build?
+true
+>> v5 = Mixlib::Versioning.parse("10.16.8.alpha.0")
+#<Mixlib::Versioning::Format::Rubygems:0x3fecde532bd0 @major=10, @minor=16, @patch=8, @prerelease="alpha.0", @iteration=0, @input="10.16.8.alpha.0">
+>> v5.major
+10
+>> v5.minor
+16
+>> v5.patch
+8
+>> v5.prerelease
+"alpha.0"
+>> v5.release?
+false
+>> v5.prerelease?
+true
+```
+
+### Version Comparison and Sorting
+
+```irb
+>> require 'mixlib/versioning'
+true
+>> v1 = Mixlib::Versioning.parse("11.0.0-beta.1")
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3ff009cd54e0 @major=11, @minor=0, @patch=0, @prerelease="beta.1", @build=nil, @input="11.0.0-beta.1">
+>> v2 = Mixlib::Versioning.parse("11.0.0-rc.1")
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3ff009d07260 @major=11, @minor=0, @patch=0, @prerelease="rc.1", @build=nil, @input="11.0.0-rc.1">
+>> v3 = Mixlib::Versioning.parse("11.0.0")
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3ff009d0d3cc @major=11, @minor=0, @patch=0, @prerelease=nil, @build=nil, @input="11.0.0">
+>> v1 < v2
+true
+>> v3 < v1
+false
+>> v1 == v2
+false
+>> [v3, v1, v2].sort
+[
+  [0] #<Mixlib::Versioning::Format::OpscodeSemVer:0x3ff009cd54e0 @major=11, @minor=0, @patch=0, @prerelease="beta.1", @build=nil, @input="11.0.0-beta.1">,
+  [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
+[
+  [0] "11.0.0",
+  [1] "11.0.0-beta.1",
+  [2] "11.0.0-rc.1"
+]
+```
+
+### Target Version Selection
+
+Basic usage:
+
+```ruby
+>> require 'mixlib/versioning'
+true
+>> all_versions = %w{
+  11.0.0-alpha.1
+  11.0.0-alpha.1-1-gcea071e
+  11.0.0-alpha.3+20130103213604.git.11.3fe70b5
+  11.0.0-alpha.3+20130129075201.git.38.3332a80
+  11.0.0-alpha.3+20130130075202.git.38.3332a80
+  11.0.0-beta.0+20130131044557
+  11.0.0-beta.1+20130201023059.git.5.c9d3320
+  11.0.0-beta.2+20130201035911
+  11.0.0-beta.2+20130201191308.git.4.9aa4cb2
+  11.0.0-rc.1
+  11.0.0+20130204053034.git.1.1802643
+  11.0.4
+  11.0.6-alpha.0+20130208045134.git.2.298c401
+  11.0.6-alpha.0+20130214075209.git.11.5d72e1c
+  11.0.6-alpha.0+20130215075208.git.11.5d72e1c
+  11.0.6-rc.0
+  11.0.6
+  11.0.6+20130216075209
+  11.0.6+20130221075213
+  11.0.8-rc.1
+  11.0.8-rc.1+20130302083119
+  11.0.8-rc.1+20130304083118
+  11.0.8-rc.1+20130305083118
+  11.0.8-rc.1+20130305195925.git.2.94a1dde
+  11.0.8-rc.1+20130306083036.git.2.94a1dde
+  11.0.8-rc.1+20130319083111.git.6.dc8613e
+};''
+""
+>> Mixlib::Versioning.find_target_version(all_versions, "11.0.6", false, false)
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3ffdc91364a4 @major=11, @minor=0, @patch=6, @prerelease=nil, @build=nil, @input="11.0.6">
+>> target = Mixlib::Versioning.find_target_version(all_versions, "11.0.6", false, false)
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3ffdc91364a4 @major=11, @minor=0, @patch=6, @prerelease=nil, @build=nil, @input="11.0.6">
+>> target.to_s
+"11.0.6"
+```
+
+Select latest release version:
+
+```irb
+>> target = Mixlib::Versioning.find_target_version(all_versions, nil, false, false)
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3ffdc91364a4 @major=11, @minor=0, @patch=6, @prerelease=nil, @build=nil, @input="11.0.6">
+>> target.to_s
+"11.0.6"
+```
+
+Select latest pre-release version:
+
+```irb
+>> target = Mixlib::Versioning.find_target_version(all_versions, nil, true, false)
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3ffdc9139078 @major=11, @minor=0, @patch=8, @prerelease="rc.1", @build=nil, @input="11.0.8-rc.1">
+>> target.to_s
+"11.0.8-rc.1"
+```
+
+Select the latest release build version:
+
+```irb
+>> target = Mixlib::Versioning.find_target_version(all_versions, nil, false, true)
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3ffdc91f0bb0 @major=11, @minor=0, @patch=6, @prerelease=nil, @build="20130221075213", @input="11.0.6+20130221075213">
+>> target.to_s
+"11.0.6+20130221075213"
+```
+
+Select the latest pre-release build version:
+
+```irb
+>> target = Mixlib::Versioning.find_target_version(all_versions, nil, true, true)
+#<Mixlib::Versioning::Format::OpscodeSemVer:0x3ffdc91f154c @major=11, @minor=0, @patch=8, @prerelease="rc.1", @build="20130319083111.git.6.dc8613e", @input="11.0.8-rc.1+20130319083111.git.6.dc8613e">
+>> target.to_s
+"11.0.8-rc.1+20130319083111.git.6.dc8613e"
+```
+
+## How to Run the Tests
+
+To run the unit tests, run
+
+```
+rake spec
+```
+
+## Documentation
+
+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)
+| **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.
+
+[jira]: http://tickets.opscode.com/browse/MIXLIB