version_compare 0.1.1 → 0.2.0

data/lib/version_compare.rb

@@ -1,5 +1,5 @@
-require "version_compare/conversions"
-
 module VersionCompare
-  autoload :ComparableVersion, "version_compare/comparable_version"
 end
+
+require "version_compare/conversions"
+require "version_compare/comparable_version"

data/lib/version_compare/comparable_version.rb

@@ -1,71 +1,82 @@
-class ComparableVersion
-  DEFAULT_SEPARATOR = ".".freeze
+module VersionCompare
+  # VersionCompare::ComparableVersion objects compare themselves with other
+  # VersionCompare::ComparableVersion objects.
+  #
+  # @attr value [#to_comparable_version, #to_ary, #to_s] the Version object
+  class ComparableVersion
+    DEFAULT_SEPARATOR = ".".freeze
+    NAMES = %i[major minor tiny patch].freeze
 
-  include Comparable
+    include Comparable
 
-  # ComparableVersion component names
-  NAMES = [:major, :minor, :tiny, :patch].freeze
+    attr_accessor(*NAMES)
+    attr_reader :separator
 
-  attr_accessor *NAMES
-  attr_reader :separator
+    def initialize(value, separator: DEFAULT_SEPARATOR)
+      @separator = separator
 
-  def initialize(value, options = {})
-    @separator = options.fetch(:separator) { DEFAULT_SEPARATOR }
+      @major, @minor, @tiny, @patch =
+        if value.respond_to?(:to_comparable_version)
+          value.to_comparable_version.to_a
+        elsif value.respond_to?(:to_ary)
+          value.to_ary.map(&:to_i)
+        else
+          value.to_s.split(separator).map(&:to_i)
+        end
+    end
 
-    @major, @minor, @tiny, @patch =
-      if value.respond_to?(:to_comparable_version)
-        value.to_comparable_version.to_a
-      elsif value.respond_to?(:to_ary)
-        value.to_ary.map(&:to_i)
-      else
-        value.to_s.split(separator).map(&:to_i)
-      end
-  end
+    def inspect
+      "<#{identification}>"
+    end
 
-  def inspect
-    "<#{identification}>"
-  end
+    # Implicit conversion method.
+    #
+    # @return [VersionCompare::ComparableVersion] self
+    def to_comparable_version
+      self
+    end
 
-  # Implicit conversion method
-  def to_comparable_version
-    self
-  end
+    # @return [String] a String representation of the version
+    def to_s
+      NAMES.map { |name| public_send(name) }.compact.join(separator)
+    end
+    alias :to_str :to_s
 
-  def to_s
-    NAMES.map { |name| public_send(name) }.compact.join(separator)
-  end
-  alias :to_str :to_s
+    # @return [Array] an Array representation of the version's parts
+    def to_a
+      NAMES.map { |name| public_send(name) }.compact
+    end
+    alias :to_ary :to_a
 
-  def to_a
-    NAMES.map { |name| public_send(name) }.compact
-  end
-  alias :to_ary :to_a
+    # ComparableVersion components comparison method. Uses Comparable to assess
+    # whether this ComparableVersion's component value or the other
+    # ComparableVersion's component value is greater or lesser. The first value
+    # to be found as greater or lesser determines which ComparableVersion
+    # object is greater or lesser.
+    #
+    # Missing ComparableVersion components are treated as 0 values, which
+    # effectively gives them no weight in the comparison.
+    #
+    # @params [ComparableVersion] other the other ComparableVersion object we
+    #   are comparing with
+    def <=>(other)
+      NAMES.each do |name|
+        result = send(name).to_i <=> other.send(name).to_i
+        return result unless result.zero?
+      end
 
-  # ComparableVersion components comparison method. Uses Comparable to assess whether
-  # This ComparableVersion's component value or the other ComparableVersion's component value is
-  # greater or lesser. The first value to be found as greater or lesser
-  # determines which ComparableVersion object is greater or lesser.
-  #
-  # Missing ComparableVersion components are treated as 0 values, which effectively gives
-  # them no weight in the comparison.
-  #
-  # @params [ComparableVersion] other the other ComparableVersion object we are comparing with
-  def <=>(other)
-    NAMES.each do |name|
-      result = send(name).to_i <=> other.send(name).to_i
-      return result unless result.zero?
+      0
     end
 
-    0
-  end
+  private
 
-private
+    def identification
+      version_identifiers =
+        NAMES.map { |name|
+          "#{name}:#{send(name)}" if send(name)
+        }.compact.join(", ")
 
-  def identification
-    version_identifiers =
-      NAMES.map { |name| "#{name}:#{send(name)}" if send(name).present? }
-           .compact
-           .join(", ")
-    "#{self.class}[#{version_identifiers}]"
+      "#{self.class}[#{version_identifiers}]"
+    end
   end
 end

data/lib/version_compare/conversions.rb

@@ -1,38 +1,40 @@
-# Conversions is meant to be a common module used to define standard conversion
-# methods. Anytime one of the standard conversion methods are needed, the
-# Conversions module can be included and then used freely.
-module Conversions
-  require_relative "comparable_version"
+module VersionCompare
+  # Conversions is meant to be a common module used to define standard
+  # conversion methods. Anytime one of the standard conversion methods are
+  # needed, the Conversions module can be included and then used freely.
+  module Conversions
 
-  # The `ComparableVersion()` conversion method is defined as a module_function so that it
-  # may also be called directly without needing to include the Conversions module
-  # if so desired.
-  #
-  # @example
-  #   Conversions.ComparableVersion(1.2).to_s # => "1.2"
   module_function
 
-  # Strict conversion method for creating a `ComparableVersion` object out of anything
-  # that sensibly is a ComparableVersion.
-  #
-  # @param [Object] value the object to be converted
-  #
-  # @example
-  #   ComparableVersion(1) # => #<ComparableVersion:0x007fd8144ea658 @major=1, @minor=nil, @tiny=nil, @patch=nil>
-  #   ComparableVersion(1.2) # => #<ComparableVersion:0x007fd8144ea658 @major=1, @minor=2, @tiny=nil, @patch=nil>
-  #   ComparableVersion("1.2.3") # => #<ComparableVersion:0x007fd8144ea658 @major=1, @minor=2, @tiny=3, @patch=nil>
-  #   ComparableVersion(["1", "2", "3", "4"]) # => #<ComparableVersion:0x007fd8144f98b0 @major=1, @minor=2, @tiny=3, @patch=4>
-  def ComparableVersion(value)
-    case value
-    when String,
-         Integer,
-         Float,
-         -> val { val.respond_to?(:to_ary) }
-      ComparableVersion.new(value)
-    when -> val { val.respond_to?(:to_comparable_version) }
-      value.to_comparable_version
-    else
-      raise TypeError, "Cannot convert #{value.inspect} to ComparableVersion"
+    # Strict conversion method for creating a `ComparableVersion` object out of
+    # anything that can be interpreted is a ComparableVersion.
+    #
+    # @param [Object] value the object to be converted
+    #
+    # @example
+    #   ComparableVersion(1)
+    #   # => #<ComparableVersion @major=1, @minor=nil, @tiny=nil, @patch=nil>
+    #
+    #   ComparableVersion(1.2)
+    #   # => #<ComparableVersion @major=1, @minor=2, @tiny=nil, @patch=nil>
+    #
+    #   ComparableVersion("1.2.3")
+    #   # => #<ComparableVersion @major=1, @minor=2, @tiny=3, @patch=nil>
+    #
+    #   ComparableVersion(["1", "2", "3", "4"])
+    #   # => #<ComparableVersion @major=1, @minor=2, @tiny=3, @patch=4>
+    def ComparableVersion(value)
+      case value
+      when String,
+           Integer,
+           Float,
+           -> val { val.respond_to?(:to_ary) }
+        ComparableVersion.new(value)
+      when -> val { val.respond_to?(:to_comparable_version) }
+        value.to_comparable_version
+      else
+        raise TypeError, "Cannot convert #{value.inspect} to ComparableVersion"
+      end
     end
   end
 end

data/lib/version_compare/version.rb

@@ -0,0 +1,3 @@
+module VersionCompare
+  VERSION = "0.2.0"
+end

data/version_compare.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "version_compare/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "version_compare"
+  spec.version       = VersionCompare::VERSION
+  spec.authors       = ["Paul Dobbins"]
+  spec.email         = ["paul.dobbins@icloud.com"]
+
+  spec.summary       = %q{VersionCompare simplifies comparison of version numbers with other version numbers.}
+  spec.description   = %q{VersionCompare simplifies comparison of version numbers with other version numbers. It aims to be as light and flexible as possible. Inputs can be a String, Integer, Float, Array, or any object that defines `#to_comparable_version`.}
+  spec.homepage      = "https://github.com/pdobb/version_compare"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.2"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "pry-byebug", "~> 3.6"
+end

metadata

@@ -1,106 +1,151 @@
 --- !ruby/object:Gem::Specification
 name: version_compare
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Dobbins
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest-rails
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Version Compare allows you to easily compare if one Version is >, >=,
-  ==, !=, <, or <= to another Version.
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: VersionCompare simplifies comparison of version numbers with other version
+  numbers. It aims to be as light and flexible as possible. Inputs can be a String,
+  Integer, Float, Array, or any object that defines `#to_comparable_version`.
 email:
-- pdobbins@gmail.com
+- paul.dobbins@icloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/version_compare.rb
 - lib/version_compare/comparable_version.rb
 - lib/version_compare/conversions.rb
-- test/comparable_version_test.rb
-- test/conversions_test.rb
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/test_helper.rb
+- lib/version_compare/version.rb
+- version_compare.gemspec
 homepage: https://github.com/pdobb/version_compare
 licenses:
 - MIT
@@ -111,54 +156,19 @@ 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: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Compare versions
-test_files:
-- test/comparable_version_test.rb
-- test/conversions_test.rb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
-- test/test_helper.rb
-has_rdoc: 
+summary: VersionCompare simplifies comparison of version numbers with other version
+  numbers.
+test_files: []