semantic-version 2.0.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f9241c69186fc00e63fefb4d11d5bbbbe36b4e2
+  data.tar.gz: ca581b70fc94866659effd01c5a83d23a8e38b21
+SHA512:
+  metadata.gz: 3de5e410f84e2445dfaf639f9e1827b262dd7bdd74425e923820a9d7d79fd49e73ff021cbd7e79abede01551cfd9c3f26a1de713976851ad8ccaa080fa6d4f79
+  data.tar.gz: 5cde7fcc9a7f6f212d8475d314cd6c116a0ee28c4792d83d2540ce3b34059d73948ae789c186502f8a6f840e810c9bbcc7e6294018f5f652635a0d55ce75bb7d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in semantic-version.gemspec
+gemspec
+
+gem 'parser'
+gem 'pry'

data/LICENSE.md

@@ -0,0 +1,25 @@
+> **Copyright (c) 2015 Chris Keele**
+
+MIT License
+-----------
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+*
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*

data/README.md

@@ -0,0 +1,252 @@
+Semantic::Version
+=================
+
+> *Semantic version objects for Ruby.*
+
+  A utility library that provides a `Semantic::Version` value object.
+
+
+  You can parse strings into version objects or construct them by hand. Any module, class, or object can be given a version through a helper. All version objects properly handle instantiation, duplication, cloning, accessors, mutators, stringification, and comparison; and come with helpful predicate methods.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'semantic-version'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or version your gem with it like so:
+
+1. Create or modify your version file:
+
+  ```ruby
+  # my_gem/version.rb
+
+  require 'semantic/version'
+
+  module MyGem
+    extend Semantic::Version::Helper
+    version '0.0.1'
+  end
+  ```
+
+2. Modify your gemspec:
+
+  ```ruby
+  # my_gem.gemspec
+
+  #...
+  require 'my_gem/version'
+
+  Gem::Specification.new do |spec|
+    #...
+    spec.version = MyGem.version
+    #...
+    spec.add_dependency "semantic-version", "~> 2.0.0"
+    #...
+  end
+  ```
+
+3. Update your `Gemfile.lock`:
+
+  ```sh
+  bundle
+  ```
+
+4. Add the relevant rake tasks *optional*:
+
+  ```ruby
+  # Rakefile
+
+  #...
+  require 'semantic/version/tasks'
+  ```
+
+There is currently no advantage to using `Semantic::Version` objects in your gemspec, outside of using the provided rake tasks, except to declare to the world that your gem is semantic versioning compliant.
+
+Usage
+-----
+
+Versions can be parsed from strings, or constructed piecewise:
+
+```ruby
+Semantic::Version.parse '1.0.0'
+Semantic::Version.new major: 1, minor: 0, patch: 0
+# => #<struct Semantic::Version
+#      number=#<struct Semantic::Version::Number major=1, minor=0, patch=0>,
+#      prerelease=[],
+#      meta=[]
+#    >
+```
+
+Versions can have multiple pre-release and meta tags:
+
+```ruby
+Semantic::Version.parse '1.0.0-alpha.12+build.2981'
+Semantic::Version.new major: 1, minor: 0, patch: 0, prerelease: %w[alpha 12], meta: %w[build 2981]
+# => #<struct Semantic::Version
+#      number=#<struct Semantic::Version::Number major=1, minor=0, patch=0>,
+#      prerelease=["alpha", 12],
+#      meta=["build", 2981]
+#    >
+```
+
+They properly display as strings:
+
+```ruby
+Semantic::Version.parse('1.0.0').to_s
+#=> "1.0.0"
+Semantic::Version.parse('1.0.0-alpha.12').to_s
+#=> "1.0.0-alpha.12"
+Semantic::Version.parse('1.0.0-alpha.12+build.2981').to_s
+#=> "1.0.0-alpha.12+build.2981"
+```
+
+They come with useful accessors, mutators, and predicates:
+
+```ruby
+version = Semantic::Version.new
+
+version.number.to_s
+#=> "0.0.0"
+
+version.bump.number.to_s
+#=> "0.0.1"
+version.bump(:minor).number.to_s
+#=> "0.1.0"
+version.bump(:major, by: 2).number.to_s
+#=> "2.0.0"
+version.bump(:major, to: 20).number.to_s
+#=> "20.0.0"
+
+version.bump!
+version.number.to_s
+#=> "0.0.1"
+version.stable?
+#=> false
+version.bump!(:major, to: 1)
+version.stable?
+#=> true
+
+version.prerelease.to_s
+#=> ""
+version.prerelease?
+#=> false
+version.prerelease = "alpha"
+version.prerelease.to_s
+#=> "alpha"
+version.prerelease?
+#=> true
+version.prerelease << 12
+version.prerelease.to_s
+#=> "alpha.12"
+
+version.meta.to_s
+#=> ""
+version.meta?
+#=> false
+version.meta = %w[build 2981]
+version.meta.to_s
+#=> "build.2981"
+version.meta?
+#=> true
+version.meta += %w[sha e796e5da1f40820dcf5dab85487dd9e9a32f27e8]
+version.meta.to_s
+#=> "build.2981.sha.e796e5da1f40820dcf5dab85487dd9e9a32f27e8"
+
+version.to_s
+#=> "1.0.1-alpha.12+build.2981.sha.e796e5da1f40820dcf5dab85487dd9e9a32f27e8"
+```
+
+Most importantly, they are properly comparable per the Semantic Version spec:
+
+```ruby
+Semantic::Version.parse('1.0.0+build.1') == Semantic::Version.parse('1.0.0+build.2')
+#=> true
+
+%w[
+  1.0.0-alpha
+  1.0.0-alpha.1
+  1.0.0-alpha.beta
+  1.0.0-beta
+  1.0.0-beta.2
+  1.0.0-beta.11
+  1.0.0-rc.1
+  1.0.0
+  2.0.0
+  2.1.0
+  2.1.1
+].map do |string|
+  Semantic::Version.parse string
+end.reduce do |smaller, greater|
+  raise unless smaller < greater
+  greater
+end.to_s
+#=> 2.1.1
+```
+
+Finally, you can give any module, class, or object a version with a simple helper:
+
+```ruby
+module MyGem
+
+  extend Semantic::Version::Helper
+  version '2.0.0' # or self.version = '2.0.0'
+
+end
+
+MyGem.version
+#=> #<struct MyAPI::Version
+#     number=#<struct Semantic::Version::Number major=2, minor=0, patch=0>,
+#     prerelease=[],
+#     meta=[]
+#   >
+
+class MyAPI
+
+  include Semantic::Version::Helper
+  def initialize(version: '0.0.1')
+    self.version = version
+  end
+
+  include Comparable
+  def <=> other
+    version <=> other.version
+  end
+
+end
+
+api1 = MyAPI.new
+#=> #<MyAPI:0x007fb1fb9115e0
+#    @version= #<struct MyAPI::Version
+#      number=#<struct Semantic::Version::Number major=0, minor=0, patch=1>,
+#      prerelease=[],
+#      meta=[]
+#    >
+#  >
+api1.version.to_s
+#=> "0.0.1"
+api2 = MyAPI.new(version: '0.0.2')
+api1 < api2
+#=> true
+```
+
+Take care to never use `attr_accessor` in conjunction with `version` when using this helper, or the coercion magic will be ruined.
+
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/[my-github-username]/semantic-version/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+
+desc 'Open a pry console preloaded with this library'
+task console: 'console:pry'
+
+namespace :console do
+
+  task :pry do
+    sh 'bundle exec pry -I lib -r semantic/version.rb'
+  end
+
+  task :irb do
+    sh 'bundle exec irb -I lib -r semantic/version.rb'
+  end
+
+end

data/bin/rake

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", Pathname.new(__FILE__).realpath)
+
+require 'bundler/setup'
+
+require 'rake'
+Rake.application.run

data/lib/semantic/version/data.rb

@@ -0,0 +1,41 @@
+require 'semantic/version/to_string'
+
+module Semantic
+  class Version
+    class Data < Array
+
+      include ToString
+
+      def initialize(*args)
+        super args.compact.map{ |element| Integer(element) rescue element }
+      end
+
+      include Comparable
+
+      def <=> other
+        if [self, other].any?(&:empty?)
+          other.length <=> length # no data always wins
+        else
+          myself = to_a
+          if myself.length < other.length
+            myself << nil until myself.length == other.length
+          end
+          myself.zip(other).reduce(0) do |result, (mine, theirs)|
+            if not result.zero?
+              result
+            else
+              if mine.class == theirs.class
+                mine <=> theirs
+              elsif String === mine
+                return 1
+              else
+                return -1
+              end
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/semantic/version/helper.rb

@@ -0,0 +1,44 @@
+module Semantic
+  class Version
+    module Helper
+
+      def version(number=nil, from: nil)
+        if number
+          self.version = number
+        elsif from
+          self.version = version_class.read(from)
+        else
+          @version
+        end
+      end
+
+      def version= number
+        @version ||= case number
+        when String
+          version_class.parse(number)
+        when version_class
+          number
+        when ::Semantic::Version
+          data = number.to_h
+          version_class.new data.merge(data.delete(:number).to_h)
+        else
+          raise "version must be a string or instance of `Semantic::Version`."
+        end
+      end
+
+    private
+
+      def version_namespace
+        respond_to?(:const_get) ? self : self.class
+      end
+
+      def version_class
+        unless (version_namespace.const_get :Version rescue false)
+          version_namespace.const_set :Version, Class.new(::Semantic::Version)
+        end
+        version_namespace.const_get :Version
+      end
+
+    end
+  end
+end

data/lib/semantic/version/number.rb

@@ -0,0 +1,45 @@
+require 'semantic/version/to_string'
+
+module Semantic
+  class Version
+    class Number < Struct.new(*%i[ major minor patch ])
+
+      include ToString
+
+      def initialize(*args)
+        super *args.map{ |number| Integer number }
+      end
+
+      def stable?
+        major > 0
+      end
+
+      def bump(*args)
+        clone.bump!(*args)
+      end
+
+      def bump!(level = :patch, by: 1, to: nil)
+        tap do |number|
+          if to
+            number[level.to_sym] = to
+          else
+            number[level.to_sym] += by
+          end
+        end
+      end
+
+      include Comparable
+
+      def <=> other
+        members.reduce(0) do |result, member|
+          if not result.zero?
+            result
+          else
+            self[member] <=> other[member]
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/semantic/version/to_string.rb

@@ -0,0 +1,15 @@
+module Semantic
+  class Version
+    module ToString
+
+      def to_s
+        to_a.join('.')
+      end
+
+      def to_str
+        to_s
+      end
+      
+    end
+  end
+end

data/lib/semantic/version.rb

@@ -0,0 +1,103 @@
+require 'forwardable'
+
+module Semantic
+  Version = Struct.new(*%i[ number prerelease meta ])
+end
+
+require 'semantic/version/number'
+require 'semantic/version/data'
+
+module Semantic
+
+  class Version < Struct
+
+    class << self
+
+      extend Forwardable
+      def_delegators :number, :major, :minor, :patch, :stable?
+
+      def pattern
+        /(?<number>\d+\.\d+\.\d+)(\-(?<prerelease>[^+]+))?(\+(?<meta>.+))?/
+      end
+
+      def parse(string)
+        matches = string.match(pattern)
+        (major, minor, patch), prerelease, meta = matches.captures.map{ |list| list.to_s.split('.') }
+        new major: major, minor: minor, patch: patch, prerelease: prerelease, meta: meta
+      end
+
+      def read(file_path)
+        file_path = Pathname.new(file_path) unless file_path.is_a? Pathname
+        string = File.open(file_path) do |file|
+          file.read.gsub(/\A[[:space:]]+/, '').gsub(/[[:space:]]+\z/, '').gsub(/[[:space:]]+/, ' ')
+        end
+        parse string
+      end
+
+    end
+
+    def initialize(major: 0, minor: 0, patch: 0, prerelease: [], meta: [])
+      super Number.new(major, minor, patch), Data.new(*prerelease), Data.new(*meta)
+    end
+
+    def bump(*args)
+      clone.bump!(*args)
+    end
+
+    def bump!(*args)
+      tap do |version|
+        version.number.bump!(*args)
+      end
+    end
+
+    def prerelease?
+      not prerelease.to_a.compact.empty?
+    end
+
+    def prerelease= *array
+      self[:prerelease] = Data.new(*array)
+    end
+
+    def meta?
+      not meta.to_a.compact.empty?
+    end
+
+    def meta= *array
+      self[:meta] = Data.new(*array)
+    end
+
+    def to_s
+      number.to_s.tap do |version|
+        version.concat '-' + prerelease if prerelease?
+        version.concat '+' + meta       if meta?
+      end
+    end
+
+    def to_str
+      to_s
+    end
+
+    def clone
+      self.class.new number.to_h.clone.merge(prerelease: prerelease.clone, meta: meta.clone)
+    end
+
+
+    include Comparable
+
+    def <=> other
+      %i[number prerelease].reduce(0) do |result, member|
+        if not result.zero?
+          result
+        else
+          self[member] <=> other[member]
+        end
+      end
+    end
+
+  end
+end
+
+require 'semantic/version/helper'
+
+Semantic::Version.extend Semantic::Version::Helper
+Semantic::Version.version from: Dir['*.version'].first

data/semantic-version.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'semantic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'semantic-version'
+  spec.version       = Semantic::Version.version
+  spec.authors       = ['Chris Keele']
+  spec.email         = ['dev@chriskeele.com']
+  spec.summary       = 'Semantic version objects for Ruby.'
+  spec.description   = <<-DESC
+    A utility library that provides a `Semantic::Version` value object.
+
+    You can parse strings into version objects or construct them by hand. Any module, class, or object can be given a version through a helper. All version objects properly handle instantiation, duplication, cloning, accessors, mutators, stringification, and comparison; and come with helpful predicate methods.
+  DESC
+  spec.homepage      = 'http://semver.org/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'highline', '~> 1.6.0'
+  spec.add_dependency 'rake',     '~> 10.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'pry'
+end

data/semantic-version.version

@@ -0,0 +1 @@
+2.0.0-alpha.1

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: semantic-version
+version: !ruby/object:Gem::Version
+  version: 2.0.0.pre.alpha.1
+platform: ruby
+authors:
+- Chris Keele
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      A utility library that provides a `Semantic::Version` value object.
+
+      You can parse strings into version objects or construct them by hand. Any module, class, or object can be given a version through a helper. All version objects properly handle instantiation, duplication, cloning, accessors, mutators, stringification, and comparison; and come with helpful predicate methods.
+email:
+- dev@chriskeele.com
+executables:
+- rake
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/rake
+- lib/semantic/version.rb
+- lib/semantic/version/data.rb
+- lib/semantic/version/helper.rb
+- lib/semantic/version/number.rb
+- lib/semantic/version/to_string.rb
+- semantic-version.gemspec
+- semantic-version.version
+homepage: http://semver.org/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Semantic version objects for Ruby.
+test_files: []