semverse 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8aa9e5f86d2b4c6c6f86e7b5377a88ed6d4921cc
+  data.tar.gz: 511807bc05296390996bf576a2e60f7fe989fac7
+SHA512:
+  metadata.gz: dbe293e57f56dd1819826dd8519ae397eaf496d5543eec2dccd4e20c858d994a9604c07dd571c7c0a176e171a77708bc023569e15cea863249c1714bae0fc675
+  data.tar.gz: a2ba180239e13b8cc9d4f8f51ba7936e971f33cd3f4df67c3cbd10431433eb5a237df7e2c8c1edfc5291e9f197b2dc39db4a4fb2ce1ae64c61537901ec872067

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+script: "bundle exec rake spec"
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,28 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "fuubar"
+  gem "yard"
+  gem "guard-rspec"
+  gem "guard-spork"
+  gem "coolline"
+
+  require "rbconfig"
+
+  if RbConfig::CONFIG["target_os"] =~ /darwin/i
+    gem "ruby_gntp", require: false
+
+  elsif RbConfig::CONFIG["target_os"] =~ /linux/i
+    gem "libnotify", require: false
+
+  elsif RbConfig::CONFIG["target_os"] =~ /mswin|mingw/i
+    gem "win32console", require: false
+  end
+end
+
+group :test do
+  gem "spork"
+  gem "rspec"
+end

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'spork', rspec_port: 8991 do
+  watch('Gemfile')
+  watch('spec/spec_helper.rb')  { :rspec }
+end
+
+guard 'rspec', cli: "--color --drb --drb-port 8991 --format Fuubar", all_on_start: false, all_after_pass: false, notification: false do
+  watch(%r{^spec/acceptance/.+_spec\.rb$})
+  watch(%r{^spec/unit/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})          { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')       { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jamie Winsor
+
+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,31 @@
+# Semverse
+[![Gem Version](http://img.shields.io/gem/v/semverse.svg)][gem]
+[![Build Status](http://img.shields.io/travis/berkshelf/semverse.svg)][travis]
+
+An elegant library for representing and comparing SemVer versions and constraints
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'semverse'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install semverse
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/berkshelf/semverse/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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/semverse.rb

@@ -0,0 +1,8 @@
+module Semverse
+  require_relative 'semverse/errors'
+  require_relative 'semverse/gem_version'
+  require_relative 'semverse/version'
+  require_relative 'semverse/constraint'
+
+  DEFAULT_CONSTRAINT = Semverse::Constraint.new('>= 0.0.0').freeze
+end

data/lib/semverse/constraint.rb

@@ -0,0 +1,255 @@
+module Semverse
+  class Constraint
+    class << self
+      # Coerce the object into a constraint.
+      #
+      # @param [Constraint, String]
+      #
+      # @return [Constraint]
+      def coerce(object)
+        if object.nil?
+          DEFAULT_CONSTRAINT
+        else
+          object.is_a?(self) ? object : new(object)
+        end
+      end
+
+      # Split a constraint string into an Array of two elements. The first
+      # element being the operator and second being the version string.
+      #
+      # If the given string does not contain a constraint operator then (=)
+      # will be used.
+      #
+      # If the given string does not contain a valid version string then
+      # nil will be returned.
+      #
+      # @param [#to_s] constraint
+      #
+      # @example splitting a string with a constraint operator and valid version string
+      #   Constraint.split(">= 1.0.0") => [ ">=", "1.0.0" ]
+      #
+      # @example splitting a string without a constraint operator
+      #   Constraint.split("0.0.0") => [ "=", "1.0.0" ]
+      #
+      # @example splitting a string without a valid version string
+      #   Constraint.split("hello") => nil
+      #
+      # @return [Array, nil]
+      def split(constraint)
+        if constraint =~ /^[0-9]/
+          operator = "="
+          version  = constraint
+        else
+          _, operator, version = REGEXP.match(constraint).to_a
+        end
+
+        if operator.nil?
+          raise InvalidConstraintFormat.new(constraint)
+        end
+
+        split_version = case version.to_s
+        when /^(\d+)\.(\d+)\.(\d+)(-([0-9a-z\-\.]+))?(\+([0-9a-z\-\.]+))?$/i
+          [ $1.to_i, $2.to_i, $3.to_i, $5, $7 ]
+        when /^(\d+)\.(\d+)\.(\d+)?$/
+          [ $1.to_i, $2.to_i, $3.to_i, nil, nil ]
+        when /^(\d+)\.(\d+)?$/
+          [ $1.to_i, $2.to_i, nil, nil, nil ]
+        when /^(\d+)$/
+          [ $1.to_i, nil, nil, nil, nil ]
+        else
+          raise InvalidConstraintFormat.new(constraint)
+        end
+
+        [ operator, split_version ].flatten
+      end
+
+      # @param [Semverse::Constraint] constraint
+      # @param [Semverse::Version] target_version
+      #
+      # @return [Boolean]
+      def compare_equal(constraint, target_version)
+        target_version == constraint.version
+      end
+
+      # @param [Semverse::Constraint] constraint
+      # @param [Semverse::Version] target_version
+      #
+      # @return [Boolean]
+      def compare_gt(constraint, target_version)
+        target_version > constraint.version
+      end
+
+      # @param [Semverse::Constraint] constraint
+      # @param [Semverse::Version] target_version
+      #
+      # @return [Boolean]
+      def compare_lt(constraint, target_version)
+        target_version < constraint.version
+      end
+
+      # @param [Semverse::Constraint] constraint
+      # @param [Semverse::Version] target_version
+      #
+      # @return [Boolean]
+      def compare_gte(constraint, target_version)
+        target_version >= constraint.version
+      end
+
+      # @param [Semverse::Constraint] constraint
+      # @param [Semverse::Version] target_version
+      #
+      # @return [Boolean]
+      def compare_lte(constraint, target_version)
+        target_version <= constraint.version
+      end
+
+      # @param [Semverse::Constraint] constraint
+      # @param [Semverse::Version] target_version
+      #
+      # @return [Boolean]
+      def compare_approx(constraint, target_version)
+        min = constraint.version
+        max = if constraint.patch.nil?
+          Version.new([min.major + 1, 0, 0, 0])
+        elsif constraint.build
+          identifiers = constraint.version.identifiers(:build)
+          replace     = identifiers.last.to_i.to_s == identifiers.last.to_s ? "-" : nil
+          Version.new([min.major, min.minor, min.patch, min.pre_release, identifiers.fill(replace, -1).join('.')])
+        elsif constraint.pre_release
+          identifiers = constraint.version.identifiers(:pre_release)
+          replace     = identifiers.last.to_i.to_s == identifiers.last.to_s ? "-" : nil
+          Version.new([min.major, min.minor, min.patch, identifiers.fill(replace, -1).join('.')])
+        else
+          Version.new([min.major, min.minor + 1, 0, 0])
+        end
+        min <= target_version && target_version < max
+      end
+    end
+
+    OPERATOR_TYPES = {
+      "~>" => :approx,
+      "~"  => :approx,
+      ">=" => :greater_than_equal,
+      "<=" => :less_than_equal,
+      "="  => :equal,
+      ">"  => :greater_than,
+      "<"  => :less_than,
+    }.freeze
+
+    COMPARE_FUNS = {
+      approx: method(:compare_approx),
+      greater_than_equal: method(:compare_gte),
+      greater_than: method(:compare_gt),
+      less_than_equal: method(:compare_lte),
+      less_than: method(:compare_lt),
+      equal: method(:compare_equal)
+    }.freeze
+
+    REGEXP = /^(#{OPERATOR_TYPES.keys.join('|')})\s?(.+)$/
+
+    attr_reader :operator
+    attr_reader :major
+    attr_reader :minor
+    attr_reader :patch
+    attr_reader :pre_release
+    attr_reader :build
+
+    # Return the Semverse::Version representation of the major, minor, and patch
+    # attributes of this instance
+    #
+    # @return [Semverse::Version]
+    attr_reader :version
+
+    # @param [#to_s] constraint
+    def initialize(constraint = nil)
+      constraint = constraint.to_s
+      if constraint.nil? || constraint.empty?
+        constraint = '>= 0.0.0'
+      end
+
+      @operator, @major, @minor, @patch, @pre_release, @build = self.class.split(constraint)
+
+      unless operator_type == :approx
+        @minor ||= 0
+        @patch ||= 0
+      end
+
+      @version = Version.new([
+        self.major,
+        self.minor,
+        self.patch,
+        self.pre_release,
+        self.build,
+      ])
+    end
+
+    # @return [Symbol]
+    def operator_type
+      unless type = OPERATOR_TYPES.fetch(operator)
+        raise RuntimeError, "unknown operator type: #{operator}"
+      end
+
+      type
+    end
+
+    # Returns true or false if the given version would be satisfied by
+    # the version constraint.
+    #
+    # @param [Version, #to_s] target
+    #
+    # @return [Boolean]
+    def satisfies?(target)
+      target = Version.coerce(target)
+
+      return false if !version.zero? && greedy_match?(target)
+
+      compare(target)
+    end
+
+    # dep-selector uses include? to determine if a version matches the
+    # constriant.
+    alias_method :include?, :satisfies?
+
+    # @param [Object] other
+    #
+    # @return [Boolean]
+    def ==(other)
+      other.is_a?(self.class) &&
+        self.operator == other.operator &&
+        self.version == other.version
+    end
+    alias_method :eql?, :==
+
+    def inspect
+      "#<#{self.class.to_s} #{to_s}>"
+    end
+
+    def to_s
+      out =  "#{operator} #{major}"
+      out << ".#{minor}" if minor
+      out << ".#{patch}" if patch
+      out << "-#{pre_release}" if pre_release
+      out << "+#{build}" if build
+      out
+    end
+
+    private
+
+      # Returns true if the given version is a pre-release and if the constraint
+      # does not include a pre-release and if the operator isn't < or <=.
+      # This avoids greedy matches, e.g. 2.0.0.alpha won't satisfy >= 1.0.0.
+      #
+      # @param [Semverse::Version] target_version
+      #
+      def greedy_match?(target_version)
+        operator_type !~ /less/ && target_version.pre_release? && !version.pre_release?
+      end
+
+      # @param [Semverse::Version] target
+      #
+      # @return [Boolean]
+      def compare(target)
+        COMPARE_FUNS.fetch(operator_type).call(self, target)
+      end
+  end
+end

data/lib/semverse/errors.rb

@@ -0,0 +1,29 @@
+module Semverse
+  class SemverseError < StandardError; end
+
+  class InvalidVersionFormat < SemverseError
+    attr_reader :version
+
+    # @param [#to_s] version
+    def initialize(version)
+      @version = version
+    end
+
+    def to_s
+      "'#{version}' did not contain a valid version string: 'x.y.z' or 'x.y'."
+    end
+  end
+
+  class InvalidConstraintFormat < SemverseError
+    attr_reader :constraint
+
+    # @param [#to_s] constraint
+    def initialize(constraint)
+      @constraint = constraint
+    end
+
+    def to_s
+      "'#{constraint}' did not contain a valid operator or a valid version string."
+    end
+  end
+end

data/lib/semverse/gem_version.rb

@@ -0,0 +1,3 @@
+module Semverse
+  VERSION = "1.0.0"
+end

data/lib/semverse/version.rb

@@ -0,0 +1,166 @@
+module Semverse
+  class Version
+    class << self
+      # Coerce the object into a version.
+      #
+      # @param [Version, String]
+      #
+      # @return [Version]
+      def coerce(object)
+        object.is_a?(self) ? object : new(object)
+      end
+
+      # @param [#to_s] version_string
+      #
+      # @raise [InvalidVersionFormat]
+      #
+      # @return [Array]
+      def split(version_string)
+        case version_string.to_s
+        when /^(\d+)\.(\d+)\.(\d+)(-([0-9a-z\-\.]+))?(\+([0-9a-z\-\.]+))?$/i
+          [ $1.to_i, $2.to_i, $3.to_i, $5, $7 ]
+        when /^(\d+)\.(\d+)\.(\d+)?$/
+          [ $1.to_i, $2.to_i, $3.to_i ]
+        when /^(\d+)\.(\d+)?$/
+          [ $1.to_i, $2.to_i, 0 ]
+        when /^(\d+)$/
+          [ $1.to_i, 0, 0 ]
+        else
+          raise InvalidVersionFormat.new(version_string)
+        end
+      end
+
+      # Convert the argument to a Version object if it isn't one already.
+      # Creating version objects from Strings involves expensive Regexp
+      # processing, so this improves performance when dealing with objects that
+      # may be instances of Version.
+      # @param version_or_string [Version, #to_s] the object to coerce to a
+      #   Version.
+      # @return [Version] either the version object you gave or a new one if
+      #   you gave a String.
+      def coerce(version_or_string)
+        if version_or_string.kind_of?(self)
+          version_or_string
+        else
+          new(version_or_string.to_s)
+        end
+      end
+
+    end
+
+    include Comparable
+
+    attr_reader :major
+    attr_reader :minor
+    attr_reader :patch
+    attr_reader :pre_release
+    attr_reader :build
+
+    # @overload initialize(version_array)
+    #   @param [Array] version_array
+    #
+    #   @example
+    #     Version.new([1, 2, 3, 'rc.1', 'build.1']) => #<Version: @major=1, @minor=2, @patch=3, @pre_release='rc.1', @build='build.1'>
+    #
+    # @overload initialize(version_string)
+    #   @param [#to_s] version_string
+    #
+    #   @example
+    #     Version.new("1.2.3-rc.1+build.1") => #<Version: @major=1, @minor=2, @patch=3, @pre_release='rc.1', @build='build.1'>
+    #
+    # @overload initialize(version)
+    #   @param [Semverse::Version] version
+    #
+    #   @example
+    #     Version.new(Version.new("1.2.3-rc.1+build.1")) => #<Version: @major=1, @minor=2, @pre_release='rc.1', @build='build.1'>
+    #
+    def initialize(*args)
+      if args.first.is_a?(Array)
+        @major, @minor, @patch, @pre_release, @build = args.first
+      else
+        @major, @minor, @patch, @pre_release, @build = self.class.split(args.first.to_s)
+      end
+
+      @major       ||= 0
+      @minor       ||= 0
+      @patch       ||= 0
+      @pre_release ||= nil
+      @build       ||= nil
+    end
+
+    # @param [Semverse::Version] other
+    #
+    # @return [Integer]
+    def <=>(other)
+      [:major, :minor, :patch].each do |release|
+        ans = self.send(release) <=> other.send(release)
+        return ans if ans != 0
+      end
+      ans = pre_release_and_build_presence_score <=> other.pre_release_and_build_presence_score
+      return ans if ans != 0
+      ans = identifiers_comparaison(other, :pre_release)
+      return ans if ans != 0
+      if build && other.build
+        return identifiers_comparaison(other, :build)
+      else
+        return build.to_s <=> other.build.to_s
+      end
+      0
+    end
+
+    # @return [Array]
+    def identifiers(release)
+      send(release).to_s.split('.').map do |str|
+        str.to_i.to_s == str ? str.to_i : str
+      end
+    end
+
+    def pre_release?
+      !!pre_release
+    end
+
+    def zero?
+      [major, minor, patch].all? { |n| n == 0 }
+    end
+
+    # @return [Integer]
+    def pre_release_and_build_presence_score
+      pre_release ? 0 : (build.nil? ? 1 : 2)
+    end
+
+    # @param [Semverse::Version] other
+    #
+    # @return [Integer]
+    def identifiers_comparaison(other, release)
+      [identifiers(release).length, other.identifiers(release).length].max.times do |i|
+        if identifiers(release)[i].class == other.identifiers(release)[i].class
+          ans = identifiers(release)[i] <=> other.identifiers(release)[i]
+          return ans if ans != 0
+        elsif identifiers(release)[i] && other.identifiers(release)[i]
+          return identifiers(release)[i].class.to_s <=> other.identifiers(release)[i].class.to_s
+        elsif identifiers(release)[i] || other.identifiers(release)[i]
+          return other.identifiers(release)[i].class.to_s <=> identifiers(release)[i].class.to_s
+        end
+      end
+      0
+    end
+
+    # @param [Semverse::Version] other
+    #
+    # @return [Boolean]
+    def eql?(other)
+      other.is_a?(Version) && self == other
+    end
+
+    def inspect
+      "#<#{self.class.to_s} #{to_s}>"
+    end
+
+    def to_s
+      str = "#{major}.#{minor}.#{patch}"
+      str += "-#{pre_release}" if pre_release
+      str += "+#{build}" if build
+      str
+    end
+  end
+end