ruby-measurement 1.2.0 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9ad871d0be538a1fe0b81b6f7e30d88c843a6d8c26b0682dd4ce68289ebfdf8
+  data.tar.gz: fad2d4f562bbca29e685fd64f36ce7473b2b470479daaeb3a02bd707d409c198
+SHA512:
+  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,24 +1,39 @@
+## 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*
+
+## ruby-measurement 1.2.2 (Jul 13, 2014)
+
+* Fixed `Measurement::Unit#==` to properly compare units. *Matt Huggins*
+
+## ruby-measurement 1.2.1 (Jul 27, 2013)
+
+* Added `Measurement.names` to list all available units. *Daniele Palombo*
+
 ## ruby-measurement 1.2.0 (Mar 16, 2013)
 
-* Implement `String#to_measurement`, `String#to_unit`,
+* Added `String#to_measurement`, `String#to_unit`,
   `Symbol#to_unit`, and `Numeric#to_measurement`. *Matt Huggins*
 
 ## ruby-measurement 1.1.0 (Feb 6, 2013)
 
-* Move unit definition logic into `Unit` class. *Matt Huggins*
-* Create test suite. *Matt Huggins*
-* Fix parsing of `'` and `"` for feet and inches. *Matt Huggins*
-* Implement missing metric weights and U.S. customary capacities.
-  *Matt Huggins*
-* Fix several conversions that were found to be miscalculating.
+* Moved unit definition logic into `Unit` class. *Matt Huggins*
+* Added test suite. *Matt Huggins*
+* Fixed parsing of `'` and `"` for feet and inches. *Matt Huggins*
+* Added missing metric weights and U.S. customary capacities. *Matt Huggins*
+* Fixed several conversions that were found to be miscalculating.
   *Matt Huggins*
 
 ## ruby-measurement 1.0.0 (Jan 22, 2013)
 
-* Fix parsing of mixed fractions. *Matt Huggins*
-* Allow parsing of quantity & unit to work when not separated by a space.
+* Fixed parsing of mixed fractions. *Matt Huggins*
+* Updated parsing of quantity & unit to work when not separated by a space.
   *Matt Huggins*
-* Change `Measurement` initializer to accept quantity & unit instead of a
+* Updated `Measurement` initializer to accept quantity & unit instead of a
   single string for parsing. *Matt Huggins*
 
 ## ruby-measurement 0.0.1 (Jan 21, 2013)

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 }
@@ -162,6 +162,12 @@ that will be used when displaying a measurement.
     Measurement.parse('3 year')                # => 3.0 yr
     Measurement.parse('3 years')               # => 3.0 yr
 
+### List all units names defined
+
+List all keys you can use as unit
+
+    Measurement::Unit.names                    # => ['count','doz','dozen',...]
+
 ## Contributing
 
 1. Fork it

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

@@ -4,8 +4,8 @@ class String
   def to_measurement
     Measurement.parse(self)
   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

@@ -1,34 +1,56 @@
+# encoding: UTF-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
   RATIONAL_REGEX    = /\A([+-]?\d+\s+)?((\d+)\/(\d+))?\s*#{UNIT_REGEX}?\z/.freeze
   COMPLEX_REGEX     = /\A#{SCIENTIFIC_NUMBER}?#{SCIENTIFIC_NUMBER}i\s*#{UNIT_REGEX}?\z/.freeze
-  
+
+  RATIOS = {
+    '¼' => '1/4',
+    '½' => '1/2',
+    '¾' => '3/4',
+    '⅓' => '1/3',
+    '⅔' => '2/3',
+    '⅕' => '1/5',
+    '⅖' => '2/5',
+    '⅗' => '3/5',
+    '⅘' => '4/5',
+    '⅙' => '1/6',
+    '⅚' => '5/6',
+    '⅛' => '1/8',
+    '⅜' => '3/8',
+    '⅝' => '5/8',
+    '⅞' => '7/8',
+  }.freeze
+
   attr_reader :quantity, :unit
-  
+
   def initialize(quantity, unit_name = :count)
     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
   end
-  
+
   def inspect
     to_s
   end
-  
+
   def to_s
     "#{quantity} #{unit}"
   end
-  
+
   %w(+ - * /).each do |operator|
     class_eval <<-END, __FILE__, __LINE__ + 1
       def #{operator}(obj)
@@ -47,7 +69,7 @@ class Measurement
       end
     END
   end
-  
+
   def **(obj)
     case obj
     when Numeric
@@ -56,41 +78,90 @@ class Measurement
       raise ArgumentError, "Invalid arithmetic: #{self} ** #{obj}"
     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)
     unit = Unit[unit_name]
     raise ArgumentError, "Invalid unit: '#{unit_name}'" unless unit
-    
+
     return dup if unit == @unit
-    
+
     conversion = @unit.conversion(unit.name)
     raise ArgumentError, "Invalid conversion: '#@unit' to '#{unit.name}'" unless conversion
-    
+
     self.class.new(conversion.call(@quantity), unit.name)
   end
-  
+
   def convert_to!(unit_name)
     measurement = convert_to(unit_name)
     @unit, @quantity = measurement.unit, measurement.quantity
     self
   end
-  
-  def self.parse(str = '0')
-    str = str.strip
-    
-    if str =~ COMPLEX_REGEX
+
+  class << self
+    def parse(str = '0')
+      str = normalize(str)
+
+      case str
+        when COMPLEX_REGEX then unit_name, quantity = parse_complex(str)
+        when SCIENTIFIC_REGEX then unit_name, quantity = parse_scientific(str)
+        when RATIONAL_REGEX then unit_name, quantity = parse_rational(str)
+        else raise ArgumentError, "Unable to parse: '#{str}'"
+      end
+
+      unit_name ||= 'count'
+      unit = Unit[unit_name.strip.downcase]
+      raise ArgumentError, "Invalid unit: '#{unit_name}'" unless unit
+
+      new(quantity, unit)
+    end
+
+    def define(unit_name, &block)
+      Unit.define(unit_name, &block)
+    end
+
+    private
+
+    def normalize(string)
+      string.dup.tap do |str|
+        if str =~ Regexp.new(/(#{RATIOS.keys.join('|')})/)
+          RATIOS.each do |search, replace|
+            str.gsub!(search) { " #{replace}" }
+          end
+        end
+
+        str.strip!
+      end
+    end
+
+    def parse_complex(str)
       real, imaginary, unit_name = str.scan(COMPLEX_REGEX).first
       quantity = Complex(real.to_f, imaginary.to_f).to_f
-    elsif str =~ SCIENTIFIC_REGEX
+      return unit_name, quantity
+    end
+
+    def parse_scientific(str)
       whole, unit_name = str.scan(SCIENTIFIC_REGEX).first
       quantity = whole.to_f
-    elsif str =~ RATIONAL_REGEX
+      return unit_name, quantity
+    end
+
+    def parse_rational(str)
       whole, _, numerator, denominator, unit_name = str.scan(RATIONAL_REGEX).first
-      
+
       if numerator && denominator
         numerator = numerator.to_f + (denominator.to_f * whole.to_f)
         denominator = denominator.to_f
@@ -98,27 +169,15 @@ class Measurement
       else
         quantity = whole.to_f
       end
-    else
-      raise ArgumentError, "Unable to parse: '#{str}'"
+
+      return unit_name, quantity
     end
-    
-    unit_name ||= 'count'
-    unit = Unit[unit_name.strip.downcase]
-    raise ArgumentError, "Invalid unit: '#{unit_name}'" unless unit
-    
-    new(quantity, unit)
   end
-  
-  def self.define(unit_name, &block)
-    Unit.define(unit_name, &block)
-  end
-  
-  private
-  
+
   define(:count) do |unit|
     unit.convert_to(:dozen) { |value| value / 12.0 }
   end
-  
+
   define(:doz) do |unit|
     unit.alias :dozen
     unit.convert_to(:count) { |value| value * 12.0 }

data/lib/ruby-measurement/unit.rb

@@ -3,79 +3,85 @@ require 'set'
 class Measurement
   class Unit
     attr_reader :name, :aliases, :conversions
-    
+
     @definitions = {}
-    
+
     def initialize(name)
       @name = name.to_s
       @aliases = Set.new
       @conversions = {}
       add_alias(name)
     end
-    
+
     def add_alias(*args)
       args.each do |unit_alias|
         @aliases << unit_alias.to_s
         self.class[unit_alias] = self
       end
     end
-    
+
     def add_conversion(unit_name, &block)
       @conversions[unit_name.to_s] = block
     end
-    
+
     def conversion(unit_name)
       unit = self.class[unit_name]
       return nil unless unit
-      
+
       unit.aliases.each do |unit_alias|
         conversion = @conversions[unit_alias.to_s]
         return conversion if conversion
       end
-      
+
       nil
     end
-    
+
     def inspect
       to_s
     end
-    
+
     def to_s
       name
     end
-    
+
     def ==(obj)
-      obj.kind_of?(self.class) && hash == obj.hash
-    end
-    
-    def self.define(unit_name, &block)
-      Builder.new(unit_name, &block)
-    end
-    
-    def self.[](unit_name)
-      @definitions[unit_name.to_s.downcase]
+      obj.kind_of?(self.class) && name == obj.name && aliases == obj.aliases && conversions.all? do |key, proc|
+        [-2.5, -1, 0, 1, 2.5].all? { |n| proc.call(n) == obj.conversions[key].call(n) }
+      end
     end
-    
-    private
-    
-    def self.[]=(unit_name, unit)
-      @definitions[unit_name.to_s.downcase] = unit
+
+    class << self
+      def define(unit_name, &block)
+        Builder.new(unit_name, &block)
+      end
+
+      def [](unit_name)
+        @definitions[unit_name.to_s.downcase]
+      end
+
+      def []=(unit_name, unit)
+        @definitions[unit_name.to_s.downcase] = unit
+      end
+
+      def names
+        @definitions.keys
+      end
     end
-    
+
     class Builder
       def initialize(unit_name, &block)
         @unit = Unit.new(unit_name)
         block.call(self) if block_given?
       end
-      
+
       def alias(*args)
         @unit.add_alias(*args)
       end
-      
+
       def convert_to(unit_name, &block)
         @unit.add_conversion(unit_name, &block)
       end
-      
+
       def to_unit
         @unit
       end