ruby-measurement 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31687bfdd62b83ca04ffba2a8d1c106d767f8ac4
-  data.tar.gz: 5eb61379bb4dc5b1eaf051c96cf1c55353bb4b0b
+SHA256:
+  metadata.gz: e9ad871d0be538a1fe0b81b6f7e30d88c843a6d8c26b0682dd4ce68289ebfdf8
+  data.tar.gz: fad2d4f562bbca29e685fd64f36ce7473b2b470479daaeb3a02bd707d409c198
 SHA512:
-  metadata.gz: 25e76a22f35f3e5af25a1f79bf0f396eeba2273da6d6d8011dc11f34e02e868b374227aa1f95ee6a541ddaf1b98d6408ddb30f6898a49c43d12852128e8ba79f
-  data.tar.gz: e7f70d5166d49109632bbc8c8a0b8cf3c706fea85c5dc4b3abaddebc0af46581468394ffdae920fdea235bad66dcf1cc0d9b6aa9afe6ab52988ac593454d8d4c
+  metadata.gz: 9476515fecd08634e5f194ec1333e8d23ed7978046c99f72aa1a120b462961b711c2c49948bd4927eacfea9add0f378dfd1da865aded3f0f4ec9cff345a0a562
+  data.tar.gz: b14f4807067541c3d498f021e0cf79108a768358b8969258ee2452988cb70a3cc06a1cec83bfc6236ecf399f69459845dbb0b98e9cdf9226396cdd28f173d9e5

data/.github/workflows/CI.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - head
+          - '3.0'
+          - '2.7'
+          - '2.6'
+          - '2.5'
+    continue-on-error: ${{ matrix.ruby == 'head' }}
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: |
+          bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## ruby-measurement 1.3.0 (Aug 1, 2021)
+
+* Added `Comparable` module to `Measurement`, supporting `<` and `>` operators. *Edmund Lee*
+
 ## ruby-measurement 1.2.3 (Mar 27, 2016)
 
 * Updated parsing to accept UTF-8 fractions (½, ⅓, etc.). *Matt Huggins*

data/README.md

@@ -1,6 +1,6 @@
 # Measurement
 
-[![Build Status](https://secure.travis-ci.org/mhuggins/ruby-measurement.png)](http://travis-ci.org/mhuggins/ruby-measurement)
+[![Build Status](https://github.com/mhuggins/ruby-measurement/actions/workflows/CI.yml/badge.svg)](https://github.com/mhuggins/ruby-measurement/actions/workflows/CI.yml)
 [![Code Climate](https://codeclimate.com/github/mhuggins/ruby-measurement.png)](https://codeclimate.com/github/mhuggins/ruby-measurement)
 
 [ruby-measurement](https://github.com/mhuggins/ruby-measurement) is a simple
@@ -108,10 +108,10 @@ To include just one of these systems of measure, require the gem in per the
 following.
 
     require 'ruby-measurement/measurement'
-    
+
     # Metric units/conversions
     require 'ruby-measurement/definitions/metric'
-    
+
     # U.S. customary units/conversions
     require 'ruby-measurement/definitions/us_customary'
 
@@ -119,13 +119,13 @@ Additionally, specific categories of units of measure can be included per
 system.
 
     require 'ruby-measurement/measurement'
-    
+
     # Metric units/conversions
     require 'ruby-measurement/definitions/metric/area'
     require 'ruby-measurement/definitions/metric/length'
     require 'ruby-measurement/definitions/metric/volume'
     require 'ruby-measurement/definitions/metric/weight'
-    
+
     # U.S. customary units/conversions
     require 'ruby-measurement/definitions/us_customary/area'
     require 'ruby-measurement/definitions/us_customary/length'
@@ -142,13 +142,13 @@ default.
       unit.convert_to(:week) { |value| value / 7.0 }
       unit.convert_to(:year) { |value| value / 365.0 }
     end
-    
+
     Measurement.define(:wk) do |unit|
       unit.alias :week, :weeks
       unit.convert_to(:day) { |value| value * 7.0 }
       unit.convert_to(:year) { |value| value / 52.0 }
     end
-    
+
     Measurement.define(:yr) do |unit|
       unit.alias :year, :years
       unit.convert_to(:day) { |value| value * 365.0 }
@@ -166,7 +166,7 @@ that will be used when displaying a measurement.
 
 List all keys you can use as unit
 
-    Measurement.names                           # => ['count','doz','dozen',...]
+    Measurement::Unit.names                    # => ['count','doz','dozen',...]
 
 ## Contributing
 

data/lib/ruby-measurement/core_ext/string.rb

@@ -6,6 +6,6 @@ class String
   end
 
   def to_unit
-    Measurement::Unit[self] or raise ArgumentError, "Invalid unit: #{self}"
+    Measurement::Unit[self] or raise ArgumentError, "Invalid unit: '#{self}'"
   end
 end

data/lib/ruby-measurement/core_ext/symbol.rb

@@ -2,6 +2,6 @@ require 'ruby-measurement/unit'
 
 class Symbol
   def to_unit
-    Measurement::Unit[self] or raise ArgumentError, "Invalid unit: #{self}"
+    Measurement::Unit[self] or raise ArgumentError, "Invalid unit: '#{self}'"
   end
 end

data/lib/ruby-measurement/measurement.rb

@@ -4,6 +4,8 @@ require 'ruby-measurement/unit'
 require 'ruby-measurement/version'
 
 class Measurement
+  include Comparable
+
   UNIT_REGEX        = /([^\d\s\/].*)/.freeze
   SCIENTIFIC_NUMBER = /([+-]?\d*\.?\d+(?:[Ee][+-]?)?\d*)/.freeze
   SCIENTIFIC_REGEX  = /\A#{SCIENTIFIC_NUMBER}\s*#{UNIT_REGEX}?\z/.freeze
@@ -34,8 +36,8 @@ class Measurement
     unit = unit_name
     unit = Unit[unit_name.to_s] if unit_name.kind_of?(Symbol) || unit_name.kind_of?(String)
 
-    raise ArgumentError, "Invalid quantity: #{quantity}" unless quantity.kind_of?(Numeric)
-    raise ArgumentError, "Invalid unit: #{unit_name}" unless unit.kind_of?(Unit)
+    raise ArgumentError, "Invalid quantity: '#{quantity}'" unless quantity.kind_of?(Numeric)
+    raise ArgumentError, "Invalid unit: '#{unit_name}'" unless unit.kind_of?(Unit)
 
     @quantity = quantity
     @unit = unit
@@ -77,8 +79,18 @@ class Measurement
     end
   end
 
-  def ==(obj)
-    obj.kind_of?(self.class) && quantity == obj.quantity && unit == obj.unit
+  def <=>(obj)
+    if !obj.is_a?(self.class) || obj.unit != self.unit
+      return nil
+    end
+
+    if quantity < obj.quantity
+      -1
+    elsif quantity > obj.quantity
+      1
+    else
+      0
+    end
   end
 
   def convert_to(unit_name)
@@ -123,8 +135,8 @@ class Measurement
 
     private
 
-    def normalize(str)
-      str.dup.tap do |str|
+    def normalize(string)
+      string.dup.tap do |str|
         if str =~ Regexp.new(/(#{RATIOS.keys.join('|')})/)
           RATIOS.each do |search, replace|
             str.gsub!(search) { " #{replace}" }

data/lib/ruby-measurement/version.rb

@@ -1,3 +1,3 @@
 class Measurement
-  VERSION = '1.2.3'
+  VERSION = '1.3.0'
 end

data/ruby-measurement.gemspec

@@ -12,12 +12,12 @@ Gem::Specification.new do |gem|
   gem.summary       = 'Simple gem for calculating and converting measurements'
   gem.homepage      = 'https://github.com/mhuggins/ruby-measurement'
   gem.license       = 'MIT'
-  
+
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_path  = 'lib'
-  
+
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3.0'
 end

data/spec/ruby-measurement/core_ext/string_spec.rb

@@ -14,12 +14,12 @@ RSpec.describe String do
 
     describe 'with valid quantity and invalid unit' do
       subject { '3 people' }
-      specify { expect { subject.to_measurement }.to raise_error }
+      specify { expect { subject.to_measurement }.to raise_error(ArgumentError, "Invalid unit: 'people'") }
     end
 
     describe 'with invalid input' do
       subject { 'foobar' }
-      specify { expect { subject.to_measurement }.to raise_error }
+      specify { expect { subject.to_measurement }.to raise_error(ArgumentError, "Invalid unit: 'foobar'") }
     end
   end
 
@@ -31,7 +31,7 @@ RSpec.describe String do
 
     describe 'with invalid unit' do
       subject { 'person' }
-      specify { expect { subject.to_unit }.to raise_error }
+      specify { expect { subject.to_unit }.to raise_error(ArgumentError, "Invalid unit: 'person'") }
     end
   end
 end

data/spec/ruby-measurement/core_ext/symbol_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Symbol do
 
     describe 'with invalid unit' do
       subject { :person }
-      specify { expect { subject.to_unit }.to raise_error }
+      specify { expect { subject.to_unit }.to raise_error(ArgumentError, "Invalid unit: 'person'") }
     end
   end
 end

data/spec/ruby-measurement/measurement_spec.rb

@@ -38,13 +38,13 @@ RSpec.describe Measurement do
 
     describe 'with invalid quantity' do
       it 'raises exception' do
-        expect { subject.new('hi') }.to raise_exception
+        expect { subject.new('hi') }.to raise_error(ArgumentError, "Invalid quantity: 'hi'")
       end
     end
 
     describe 'with invalid unit' do
       it 'raises exception' do
-        expect { subject.new(3, :finklebaum) }.to raise_exception
+        expect { subject.new(3, :finklebaum) }.to raise_error(ArgumentError, "Invalid unit: 'finklebaum'")
       end
     end
   end
@@ -146,7 +146,7 @@ RSpec.describe Measurement do
       end
 
       it 'raises exception when undefined' do
-        expect { subject.parse('3 finklebaums') }.to raise_error
+        expect { subject.parse('3 finklebaums') }.to raise_error(ArgumentError, "Invalid unit: 'finklebaums'")
       end
     end
   end
@@ -174,11 +174,11 @@ RSpec.describe Measurement do
     end
 
     it 'raises exception if unit exists and is not convertable' do
-      expect { measurement.convert_to(:inches) }.to raise_error
+      expect { measurement.convert_to(:inches) }.to raise_error(ArgumentError, "Invalid conversion: 'count' to 'in.'")
     end
 
     it 'raises exception if unit does not exist' do
-      expect { measurement.convert_to(:finklebaum) }.to raise_error
+      expect { measurement.convert_to(:finklebaum) }.to raise_error(ArgumentError, "Invalid unit: 'finklebaum'")
     end
   end
 
@@ -222,7 +222,7 @@ RSpec.describe Measurement do
     it 'raises exception for incompatible units' do
       other = subject.new(4, :inches)
       expect(other.unit).to_not eq measurement.unit
-      expect { measurement + other }.to raise_error
+      expect { measurement + other }.to raise_error(ArgumentError, "Invalid conversion: 'in.' to 'count'")
     end
   end
 
@@ -231,7 +231,7 @@ RSpec.describe Measurement do
 
     it 'subtracts numeric values' do
       result = measurement - 4
-      expect(result.quantity).to eq -1
+      expect(result.quantity).to eq(-1)
       expect(result.unit).to eq measurement.unit
     end
 
@@ -240,7 +240,7 @@ RSpec.describe Measurement do
       expect(other.unit).to eq measurement.unit
 
       result = measurement - other
-      expect(result.quantity).to eq -1
+      expect(result.quantity).to eq(-1)
       expect(result.unit).to eq measurement.unit
     end
 
@@ -249,14 +249,14 @@ RSpec.describe Measurement do
       expect(other.unit).to_not eq measurement.unit
 
       result = measurement - other
-      expect(result.quantity).to eq -21
+      expect(result.quantity).to eq(-21)
       expect(result.unit).to eq measurement.unit
     end
 
     it 'raises exception for incompatible units' do
       other = subject.new(4, :inches)
       expect(other.unit).to_not eq measurement.unit
-      expect { measurement - other }.to raise_error
+      expect { measurement - other }.to raise_error(ArgumentError, "Invalid conversion: 'in.' to 'count'")
     end
   end
 
@@ -290,7 +290,7 @@ RSpec.describe Measurement do
     it 'raises exception for incompatible units' do
       other = subject.new(4, :inches)
       expect(other.unit).to_not eq measurement.unit
-      expect { measurement * other }.to raise_error
+      expect { measurement * other }.to raise_error(ArgumentError, "Invalid conversion: 'in.' to 'count'")
     end
   end
 
@@ -324,7 +324,7 @@ RSpec.describe Measurement do
     it 'raises exception for incompatible units' do
       other = subject.new(4, :inches)
       expect(other.unit).to_not eq measurement.unit
-      expect { measurement / other }.to raise_error
+      expect { measurement / other }.to raise_error(ArgumentError, "Invalid conversion: 'in.' to 'count'")
     end
   end
 
@@ -336,7 +336,7 @@ RSpec.describe Measurement do
     end
 
     it 'raises exception for non-numeric values' do
-      expect { measurement ** subject.new(3) }.to raise_error
+      expect { measurement ** subject.new(3) }.to raise_error(ArgumentError, 'Invalid arithmetic: 3 count ** 3 count')
     end
   end
 
@@ -360,6 +360,46 @@ RSpec.describe Measurement do
     end
   end
 
+  describe '#>' do
+    let(:measurement) { subject.new(3) }
+
+    it 'raises ArgumentError for non-measurement objects' do
+      expect { measurement > 2 }.to raise_error(ArgumentError)
+    end
+
+    it 'returns false for measurements for different unit' do
+      expect { measurement > subject.new(2, :dozen) }.to raise_error(ArgumentError)
+    end
+
+    it 'returns true for measurements with same unit and larger quantity' do
+      expect(measurement > subject.new(2)).to be true
+    end
+
+    it 'returns false for measurements with same unit and smaller quantity' do
+      expect(measurement > subject.new(4)).to be false
+    end
+  end
+
+  describe '#<' do
+    let(:measurement) { subject.new(3) }
+
+    it 'raises ArgumentError for non-measurement objects' do
+      expect { measurement < 4 }.to raise_error(ArgumentError)
+    end
+
+    it 'returns false for measurements for different unit' do
+      expect { measurement < subject.new(4, :dozen) }.to raise_error(ArgumentError)
+    end
+
+    it 'returns true for measurements with same unit and smaller quantity' do
+      expect(measurement < subject.new(4)).to be true
+    end
+
+    it 'returns false for measurements with same unit and larger quantity' do
+      expect(measurement < subject.new(2)).to be false
+    end
+  end
+
   describe '#to_s' do
     it 'returns the quantity and unit' do
       expect(subject.new(3.5).to_s).to eq '3.5 count'

data/tasks/rspec.rake

@@ -2,5 +2,5 @@ require 'rspec/core/rake_task'
 
 desc 'Run all examples'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = %w(--color)
+  t.rspec_opts = %w(--force-color)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-measurement
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Matt Huggins
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-27 00:00:00.000000000 Z
+date: 2021-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,8 +44,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/CI.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -96,7 +96,7 @@ homepage: https://github.com/mhuggins/ruby-measurement
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,9 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Simple gem for calculating and converting measurements
 test_files:

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-sudo: false
-
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head