version_compare 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDgxYzAxZWFkMzA1Mjc1NWIzODA4ZjA2Y2YzMWQ2OGM4ZWZjYjNmNg==
-  data.tar.gz: !binary |-
-    ZDYwNWExZDY4NmIyMjFiOWVhMDEyYmViNTNlNmQyYTdjYWVjNjkzNA==
+SHA256:
+  metadata.gz: dd6d497116771a495a959a05ac9631cc1f5c2ccfa79dd5b07acb0645dc4aad16
+  data.tar.gz: b42d17c0e5b838dbd017238520df113d85f9c1c25edc73a2ae0aa3c7f999055f
 SHA512:
-  metadata.gz: !binary |-
-    ODRlYjc2YmE3N2RiYWY2NjgzZDYxZTg4MzBkZGIxZjgxNmM2NGY4YzY4MGUz
-    NDZlMjc0ZDQ5ODU1MjRkMDY2MjJmMDhkMWUwNjVkMzU0YTczMDk2MzlmYmFi
-    NTY5Mjk1MzY1OTk2YWYxNzZlYTQ4YjJiOGY5OGNjYzVlZGFjNTc=
-  data.tar.gz: !binary |-
-    ZjVjZTM2NjJlYTc1M2Q3M2QwNmY0Nzc4NmNmZDAwN2FlM2E4NTE4NmU4NmNl
-    MTQzZDA0NzExYmVlNzk1YjBkOTVkYWMyOTFjNWZiZjcxMjBiODRiNzAzMjU4
-    ODBkNzYyODMxM2Q3ZjEwMGEwOWNhYzk1OGNjMDQzNDgxZGRhOTU=
+  metadata.gz: 9a0ffe52ba8b4d99e6db7ecdca5cf3d7e4c927e36cd60257182bd1f5d7bdb777517ef30ecf8bc1ac7bee5ddb872746254180c13a8691ea8f625a0bcc8265b8d3
+  data.tar.gz: cd20ac6a80d5dd3f30b92b6837d3d3d9f59ba93c91bfefc0df5c1dd965bf342b58ca66e71cf708d8d02070d787da589de76b27416cd362216b6ae8055bee9431

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+*.gem
+.DS_Store

data/.travis.yml

@@ -0,0 +1,21 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=a8a8d1a4975b389da2409fc5767cf53a7e995e15db36cef9332d9c3f87227abc
+sudo: false
+language: ruby
+rvm:
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - ruby-head
+notifications:
+  email: false
+before_install: gem install bundler -v 1.16.1
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+### 0.2.0 - 2018-04-15
+- Refresh gem.
+- Add VersionCmopare namespace to Conversions module.
+
+
+### 0.1.1 - 2016-07-03
+
+- Update: Renamed "Version" to "ComparableVersion" to avoid name conflicts in including projects.
+- Add ability to specify separator character as an initialization option.
+- Add ComparableVersion#inspect for more informative inspect output.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in version_compare.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    version_compare (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    docile (1.3.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    minitest-reporters (1.2.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.2)
+  pry (~> 0.11)
+  pry-byebug (~> 3.6)
+  rake (~> 10.0)
+  simplecov (~> 0.16)
+  version_compare!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Paul Dobbins
+
+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

@@ -1,13 +1,13 @@
 # Version Compare
 
-[![Gem Version](https://badge.fury.io/rb/version_compare.png)](http://badge.fury.io/rb/version_compare)
+[![Gem Version](https://badge.fury.io/rb/version_compare.svg)](https://badge.fury.io/rb/version_compare)
+[![Build Status](https://travis-ci.org/pdobb/version_compare.svg?branch=master)](https://travis-ci.org/pdobb/version_compare)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/99cb6a37ab03e0aa246e/test_coverage)](https://codeclimate.com/github/pdobb/version_compare/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/99cb6a37ab03e0aa246e/maintainability)](https://codeclimate.com/github/pdobb/version_compare/maintainability)
 
-Version Compare allows you to easily compare if one Version (string) to another
-Version (string). 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`.
+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`.
 
-For simplicity's sake, Version Compare only works with up to four numeric
-values:
+For simplicity's sake, Version Compare only works with up to four numeric values.
 
 ```ruby
 "<major>.<minor>.<tiny>.<patch>"
@@ -15,14 +15,6 @@ values:
 ```
 
 
-## Compatibility
-
-Tested with:
-
-* Ruby: MRI 1.9.3
-* Ruby: MRI 2+
-
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -33,121 +25,150 @@ gem "version_compare"
 
 And then execute:
 
-```ruby
-bundle
-```
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install version_compare
+
+
+## Compatibility
+
+Tested MRI Ruby Versions:
+* 2.2.10
+* 2.3.7
+* 2.4.4
+* 2.5.1
+* edge
+
+VersionCompare has no other dependencies.
 
 
 ## Usage
 
 To get started, you can either use `ComparableVersion.new(<value>)` or `ComparableVersion(<value>)`.
-To get the latter to work, you'll need to call `include ::Conversions` in the
-class or context you're wanting to use it at.
+To get the latter to work, you'll need to call `include VersionCompare::Conversions` in the class or context you're wanting to use it at.
 
 ```ruby
-class MyClass
-  include Conversions
+class MyObject
+  include VersionCompare::Conversions
 
   def my_method
     ComparableVersion(1) > ComparableVersion(2)
   end
 end
+
+MyObject.new.my_method  # => false
 ```
 
 Or, to test on the Rails Console:
 
 ```ruby
-[1] pry(main)> include ::Conversions
-=> Object
-[2] pry(main)> ComparableVersion(1.0) > ComparableVersion(1)
-=> false
+[1] pry(main)> include VersionCompare::Conversions  # => Object
+[2] pry(main)> ComparableVersion(1.0) > ComparableVersion(1)  # => false
 
-# - OR (without using `include ::Conversions`) -
+# - OR (without using `include VersionCompare::Conversions`) -
 
-[1] pry(main)> Conversions.ComparableVersion(1.0) > Conversions.ComparableVersion(1)
-=> false
+[1] pry(main)> VersionCompare::Conversions.ComparableVersion(1.0) > VersionCompare::Conversions.ComparableVersion(1)
+# => false
 ```
 
-ComparableVersion Compare uses the `Comparable` mixin for comparisons, so you get all the
-usual operators:
+ComparableVersion Compare uses the `Comparable` mix-in for comparisons, so you get all the usual operators:
 
 ```ruby
-ComparableVersion(2) > ComparableVersion(1) # => true
-ComparableVersion(1.2) > ComparableVersion(1.2) # => false
-ComparableVersion("1.2.3") >= ComparableVersion("1.2") # => true
-ComparableVersion("1.2.3.4") <= ComparableVersion("1.2.3.4") # => true
-ComparableVersion([1, 2]) == ComparableVersion(["1", "2"]) # => true
-ComparableVersion("1.2.0.0") == ComparableVersion(1.2) # => true
-ComparableVersion("1.0.0.0") != ComparableVersion(1) # => false
-[ComparableVersion(1), ComparableVersion("1.0.0.1"), ComparableVersion(0.1)].sort # => ["0.1", "1", "1.0.0.1"]
-[ComparableVersion(1), ComparableVersion("1.0.0.1"), ComparableVersion(0.1)].sort { |a, b| b <=> a } # => ["1.0.0.1", "1", "0.1"]
+include VersionCompare::Conversions
+
+ComparableVersion(2) > ComparableVersion(1)                   # => true
+ComparableVersion(1.2) > ComparableVersion(1.2)               # => false
+ComparableVersion("1.2.3") >= ComparableVersion("1.2")        # => true
+ComparableVersion("1.2.3.4") <= ComparableVersion("1.2.3.4")  # => true
+ComparableVersion([1, 2]) == ComparableVersion(["1", "2"])    # => true
+ComparableVersion("1.2.0.0") == ComparableVersion(1.2)        # => true
+ComparableVersion("1.0.0.0") != ComparableVersion(1)          # => false
+
+[
+  ComparableVersion(1),
+  ComparableVersion("1.0.0.1"),
+  ComparableVersion(0.1)
+].sort.map(&:to_s)
+# => ["0.1", "1", "1.0.0.1"]
+
+[
+  ComparableVersion(1),
+  ComparableVersion("1.0.0.1"),
+  ComparableVersion(0.1)
+].sort { |a, b| b <=> a }.map(&:to_s)
+# => ["1.0.0.1", "1", "0.1"]
 ```
 
 
 ### Wait, so what exactly is this `ComparableVersion` ... constant?
 
-`ComparableVersion()` is actually a conversion function. It follows the Ruby convention of
-defining a conversion function that uses the same name as the class it
-represents, such as how `Array()` converts inputs to an `Array` object.
-Just like the standard Ruby conversion functions, `ComparableVersion()` tries its hardest
-to convert any ComparableVersion-like input into a new `ComparableVersion` object. Given a numeric,
-string, or array input (which are all obvious conversions to make), `ComparableVersion()`
-is essentially the same as `ComparableVersion.new()`. However, `ComparableVersion()` is otherwise a
-little more strict in that if you pass in an object that doesn't reasonably look
-like a ComparableVersion it will raise a `TypeError` exception. Doing the same for
-`ComparableVersion.new()` will ultimately just `#to_s` the input; and since almost
-every object responds to `#to_s`, the result is that you may end up with a 0
-version. For example:
+`ComparableVersion()` is a conversion function. It follows the Ruby convention of defining a conversion function that uses the same name as the class it represents, such as how `Array()` converts inputs to an `Array` object. Just like the standard Ruby conversion functions, `ComparableVersion()` tries its hardest to convert any ComparableVersion-like input into a new `ComparableVersion` object. Given a numeric, string, or array input (which are all obvious conversions to make), `ComparableVersion()` is essentially the same as `ComparableVersion.new()`. However, `ComparableVersion()` is otherwise a little more strict in that if you pass in an object that doesn't reasonably look like a ComparableVersion it will raise a TypeError. Doing the same for `ComparableVersion.new()` will ultimately just `#to_s` the input and, since almost every object responds to `#to_s`, the result is that you may end up with a 0 version.
 
 ```ruby
-ComparableVersion.new(OpenStruct.new(a: 1)).to_s # => "0"
+VersionCompare::ComparableVersion.new(OpenStruct.new(a: 1)).to_s  # => "0"
 ```
 
 
 ### Can I pass my own custom objects into `ComparableVersion()`?
 
-Yes! All you have to do is define a `#to_comparable_version` implicit conversion method in
-your object that creates a new ComparableVersion object in the usual fashion.
+But of course! All you have to do is define a `#to_comparable_version` implicit conversion method in your object that creates a new ComparableVersion object in the usual fashion.
 
 ```ruby
 class MyObject
   VERSION = 1.9
+
   def to_comparable_version
-    ComparableVersion.new(VERSION.to_s)
+    VersionCompare::ComparableVersion.new(VERSION.to_s)
   end
 end
 
-ComparableVersion(MyObject.new) > ComparableVersion(2.0) # => false
+include VersionCompare::Conversions
+
+ComparableVersion(MyObject.new) > ComparableVersion(2.0)  # => false
 ```
 
 
 ### Why do you seem so excited about the custom object thing?
 
-Because, it opens up the world! Here's an example:
+Because, objects should be [open for extension, but closed for modification](https://en.wikipedia.org/wiki/Open/closed_principle).
 
 ```ruby
 # Given a Rails app:
 
 # /config/application.rb
-module Dummy
+module MyRailsApp
   class Application < Rails::Application
     # ...
 
     VERSION = "1.2".freeze
 
     def to_comparable_version
-      ComparableVersion.new(VERSION) # Or ComparableVersion.new([1, 2]) or whatever...
+      VersionCompare::ComparableVersion.new(VERSION)
     end
   end
 end
 
 # Now, from the context of that Rails app you can call:
-ComparableVersion(Rails.application) > ComparableVersion(1.0) # => true
+include VersionCompare::Conversions
+
+ComparableVersion(Rails.application) > ComparableVersion(1.0)  # => true
 ```
 
-So you see... the sky is the limit!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/version_compare.
 
 
-## Author
+## License
 
-- Paul Dobbins
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,32 +1,10 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'VersionCompare'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-
-task default: :test
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "version_compare"
+require "ostruct"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here