mixlib-versioning 1.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+#
+# 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.
+#
+
+require 'mixlib/versioning'
+
+# load all shared examples and shared contexts
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each do |file|
+  require(file)
+end
+
+RSpec.configure do |config|
+  # a little syntactic sugar
+  config.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # run the examples in random order
+  config.order = :rand
+
+  # specify metadata with symobls only (ie no '=> true' required)
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/shared_examples/basic_semver.rb

@@ -0,0 +1,42 @@
+#
+# 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.
+#
+
+shared_examples "Basic SemVer" do
+
+  it_has_behavior "parses valid version strings", {
+    "1.2.3" => {
+      :major => 1,
+      :minor => 2,
+      :patch => 3,
+      :prerelease => nil,
+      :build => nil,
+      :release? => true,
+      :prerelease? => false,
+      :build? => false,
+      :release_build? => false,
+      :prerelease_build? => false
+    }
+  }
+
+  it_has_behavior "rejects invalid version strings", {
+    "a.1.1" => "non-numeric MAJOR",
+    "1.a.1" => "non-numeric MINOR",
+    "1.1.a" => "non-numeric PATCH"
+  }
+
+end

data/spec/support/shared_examples/behaviors/filterable.rb

@@ -0,0 +1,66 @@
+#
+# 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.
+#
+
+shared_examples "filterable" do
+
+  let(:unsorted_versions) do
+    unsorted_version_strings.map{ |v| described_class.new(v) }
+  end
+
+  # this should/will be overriden by calling spec
+  let(:release_versions){[]}
+  let(:prerelease_versions){[]}
+  let(:build_versions){[]}
+  let(:release_build_versions){[]}
+  let(:prerelease_build_versions){[]}
+
+  it "filters by release versions only" do
+    unsorted_versions.select(&:release?).should eq(release_versions.map{|v|
+      described_class.new(v)
+    })
+  end # it
+
+  it "filters by pre-release versions only" do
+    filtered = unsorted_versions.select(&:prerelease?)
+    filtered.should eq(prerelease_versions.map{|v|
+      described_class.new(v)
+    })
+  end # it
+
+  it "filters by build versions only" do
+    filtered = unsorted_versions.select(&:build?)
+    filtered.should eq(build_versions.map{|v|
+      described_class.new(v)
+    })
+  end # it
+
+  it "filters by release build versions only" do
+    filtered = unsorted_versions.select(&:release_build?)
+    filtered.should eq(release_build_versions.map{|v|
+      described_class.new(v)
+    })
+  end # it
+
+  it "filters by pre-release build versions only" do
+    filtered = unsorted_versions.select(&:prerelease_build?)
+    filtered.should eq(prerelease_build_versions.map{|v|
+      described_class.new(v)
+    })
+  end # it
+
+end # shared_examples

data/spec/support/shared_examples/behaviors/parses_valid_version_strings.rb

@@ -0,0 +1,32 @@
+#
+# 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.
+#
+
+shared_examples "parses valid version strings" do |valid_examples|
+
+  valid_examples.each do |version, options|
+
+    context version do
+      let(:version_string){ version }
+
+      options.each_pair do |name, value|
+        its(name){ should eq value}
+      end
+
+    end # context
+  end # valid_examples
+end # shared_examples

data/spec/support/shared_examples/behaviors/rejects_invalid_version_strings.rb

@@ -0,0 +1,32 @@
+#
+# 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.
+#
+
+shared_examples "rejects invalid version strings" do |invalid_examples|
+
+  invalid_examples.each_pair do |version, reason|
+
+    context version do
+      let(:version_string){ version }
+
+      it "fails because: #{reason}" do
+        expect { subject }.to raise_error(Mixlib::Versioning::ParseError)
+      end
+
+    end # context
+  end # invalid_examples
+end # shared_examples

data/spec/support/shared_examples/behaviors/serializable.rb

@@ -0,0 +1,51 @@
+#
+# 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.
+#
+
+shared_examples "serializable" do |version_strings|
+
+  describe "#to_s" do
+    version_strings.each do |v|
+      it "reconstructs the initial input for #{v}" do
+        described_class.new(v).to_s.should == v
+      end # it
+    end # version_strings
+  end # describe
+
+  describe "#to_semver_string" do
+    version_strings.each do |v|
+      it "generates a semver version string for #{v}" do
+        subject = described_class.new(v)
+        string = subject.to_semver_string
+        semver = Mixlib::Versioning::Format::SemVer.new(string)
+        string.should eq semver.to_s
+      end # it
+    end # version_strings
+  end # describe
+
+  describe "#to_rubygems_string" do
+    version_strings.each do |v|
+      it "generates a rubygems version string for #{v}" do
+        subject = described_class.new(v)
+        string = subject.to_rubygems_string
+        rubygems = Mixlib::Versioning::Format::Rubygems.new(string)
+        string.should eq rubygems.to_s
+      end # it
+    end # version_strings
+  end # describe
+
+end # shared_examples

data/spec/support/shared_examples/behaviors/sortable.rb

@@ -0,0 +1,45 @@
+#
+# 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.
+#
+
+shared_examples "sortable" do
+
+  let(:unsorted_versions) do
+    unsorted_version_strings.map{ |v| described_class.new(v) }
+  end
+
+  let(:sorted_versions) do
+    sorted_version_strings.map{ |v| described_class.new(v) }
+  end
+
+  it 'responds to <=>' do
+    described_class.should respond_to(:<=>)
+  end
+
+  it "sorts all properly" do
+    unsorted_versions.sort.should eq sorted_versions
+  end
+
+  it "finds the min" do
+    unsorted_versions.min.should eq described_class.new(min)
+  end
+
+  it "finds the max" do
+    unsorted_versions.max.should eq described_class.new(max)
+  end
+
+end # shared_examples

data/spec/support/shared_examples/semver.rb

@@ -0,0 +1,105 @@
+#
+# 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.
+#
+
+require 'mixlib/versioning'
+
+shared_examples Mixlib::Versioning::Format::SemVer do
+
+  it_should_behave_like "Basic SemVer"
+
+  it_has_behavior "parses valid version strings", {
+    "1.0.0-alpha.1" => {
+      :major => 1,
+      :minor => 0,
+      :patch => 0,
+      :prerelease => "alpha.1",
+      :build => nil,
+      :release? => false,
+      :prerelease? => true,
+      :build? => false,
+      :release_build? => false,
+      :prerelease_build? => false
+    },
+    "1.0.0+20130308110833" => {
+      :major => 1,
+      :minor => 0,
+      :patch => 0,
+      :prerelease => nil,
+      :build => "20130308110833",
+      :release? => false,
+      :prerelease? => false,
+      :build? => true,
+      :release_build? => true,
+      :prerelease_build? => false
+    },
+    "1.0.0-beta.3+20130308110833" => {
+      :major => 1,
+      :minor => 0,
+      :patch => 0,
+      :prerelease => "beta.3",
+      :build => "20130308110833",
+      :release? => false,
+      :prerelease? => false,
+      :build? => true,
+      :release_build? => false,
+      :prerelease_build? => true
+    }
+  }
+
+  it_has_behavior "rejects invalid version strings", {
+    "8.8.8.8" => "too many segments: MAJOR.MINOR.PATCH.EXTRA"
+  }
+
+  describe "build qualification" do
+    context "release version" do
+      let(:version_string){"1.0.0"}
+      its(:release?){ should be_true }
+      its(:prerelease?){ should be_false }
+      its(:build?){ should be_false }
+      its(:release_build?){ should be_false }
+      its(:prerelease_build?){ should be_false }
+    end
+
+    context "pre-release version" do
+      let(:version_string){"1.0.0-alpha.1"}
+      its(:release?){ should be_false }
+      its(:prerelease?){ should be_true }
+      its(:build?){ should be_false }
+      its(:release_build?){ should be_false }
+      its(:prerelease_build?){ should be_false }
+    end
+
+    context "pre-release build version" do
+      let(:version_string){"1.0.0-alpha.1+20130308110833"}
+      its(:release?){ should be_false }
+      its(:prerelease?){ should be_false }
+      its(:build?){ should be_true }
+      its(:release_build?){ should be_false }
+      its(:prerelease_build?){ should be_true }
+    end
+
+    context "release build version" do
+      let(:version_string){"1.0.0+20130308110833"}
+      its(:release?){ should be_false }
+      its(:prerelease?){ should be_false }
+      its(:build?){ should be_true }
+      its(:release_build?){ should be_true }
+      its(:prerelease_build?){ should be_false }
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: mixlib-versioning
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Seth Chisamore
+- Christopher Maier
+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'
+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
+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/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: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '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
+signing_key: 
+specification_version: 3
+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: