unit_measurements 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24b2504d7feb77f54138260f7e0947bd86e00225dbe3c6d9e575da3050a24eeb
-  data.tar.gz: 7d9b84113fbf2a2cd5ca1c5a46467296b15f1bf1016c1775b854098245998cee
+  metadata.gz: 3562e30ce7bfed682e67fbdc5c9d8d30b011a6cd16996b7efe6860622abf25d5
+  data.tar.gz: af4224714284377ebd6aea3a78c4842078f708eeaf06500658ef45f151192373
 SHA512:
-  metadata.gz: b5fc7c6e1b2b580fcd5477941e239e8d06a79416b90a7c36145f8d50d32c40c7430b83273038b2974ec51df90673e46672207f8d8ae975c31e99b3612cd3b446
-  data.tar.gz: 7730a9813366e4b36dbf98873a575cf89a33963ee998da6c84d7e6b5fd7c7f5c197530e23f1acaeb2a44e339667f9665d7e3bc62c5164579df06765e01426d85
+  metadata.gz: 22a6a8f0b97a5ef1845448bcf219fbd2d0228b3d74b409e93ce596f7648d67207ea5caa64f39e0c0dd9083bf6425c1012bbf11f25624faf718f377307b698309
+  data.tar.gz: 1a436d77f1a99a7eb838e397b0038b7aba73fe19d3acf7aa0e02dbd3d482beeb2fd6b33b648d2b02514681ba6b792076596f761dbca41fb0eab3985d84209f27

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [1.3.0](https://github.com/shivam091/unit_measurements/compare/v1.2.0...v1.3.0) - 2023-08-16
+
+### What's new
+
+- Added ability to compare two measurements of the same unit group.
+
+----------
+
+## [1.2.0](https://github.com/shivam091/unit_measurements/compare/v1.1.0...v1.2.0) - 2023-08-15
+
+### What's new
+
+- Added support to specify unit value as an `array` of number and unit.
+
+----------
+
 ## [1.1.0](https://github.com/shivam091/unit_measurements/compare/v1.0.0...v1.1.0) - 2023-08-14
 
 ### What's new

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unit_measurements (1.1.0)
+    unit_measurements (1.3.0)
       activesupport (~> 7.0)
 
 GEM

data/README.md

@@ -303,6 +303,25 @@ UnitMeasurements::Weight.unit_or_alias?(:gramme)
 #=> true
 ```
 
+### Comparisons
+
+You have ability to compare the measurements with the same or different units within the same unit group.
+For example, comparing weight with weight will work, comparing a weight with a area would fail.
+Allowed comparisons are `==`, `!=`, `>`, `>=`, `<`, and `<=`.
+
+```ruby
+UnitMeasurements::Weight.new(1, "kg") == UnitMeasurements::Weight.new(1, :kg)
+#=> true
+UnitMeasurements::Weight.parse("1 kg") == UnitMeasurements::Weight.parse("1000 g")
+#=> true
+UnitMeasurements::Weight.parse("1 kg") != UnitMeasurements::Weight.parse("1 g")
+#=> true
+UnitMeasurements::Weight.parse("1 kg") <= UnitMeasurements::Weight.parse("0.5 kg")
+#=> false
+UnitMeasurements::Weight.parse("1 kg") >= UnitMeasurements::Weight.parse("0.5 kg")
+#=> true
+```
+
 ## Units
 
 The **`UnitMeasurements::Unit`** class is used to represent the units for a measurement.
@@ -399,6 +418,9 @@ UnitMeasurements::Time = UnitMeasurements.build do
   # You can also specify conversion string if it's converted against a unit other
   # than the unit group's base unit.
   unit :h, value: "60 min", aliases: [:hour, :hours]
+
+  # You can also specify unit value as an array.
+  unit :d, value: [24, :h], aliases: [:day, :days]
 end
 ```
 

data/lib/unit_measurements/base.rb

@@ -28,6 +28,7 @@ require "unit_measurements/unit_group"
 require "unit_measurements/normalizer"
 require "unit_measurements/parser"
 require "unit_measurements/formatter"
+require "unit_measurements/comparison"
 require "unit_measurements/measurement"
 
 require "unit_measurements/errors/unit_error"

data/lib/unit_measurements/comparison.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  module Comparison
+    include Comparable
+
+    # Compares the quantities of two measurements within the same unit group.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(1, "kg") == UnitMeasurements::Weight.new(1, :kg)
+    #   => true
+    #
+    # @return [Boolean]
+    def <=>(object)
+      return nil unless object.is_a?(self.class)
+
+      quantity <=> object.convert_to(unit.name).quantity
+    end
+  end
+end

data/lib/unit_measurements/measurement.rb

@@ -5,6 +5,8 @@
 module UnitMeasurements
   class Measurement
     include Formatter
+    include Comparison
+
     CONVERSION_STRING_REGEXP = /(.+?)\s?(?:\s+(?:in|to|as)\s+(.+)|\z)/i.freeze
 
     attr_reader :quantity, :unit

data/lib/unit_measurements/unit.rb

@@ -38,13 +38,11 @@ module UnitMeasurements
     end
 
     def conversion_factor
-      if value.is_a?(String)
-        measurement_value, measurement_unit = Parser.parse(value)
-        conversion_factor = unit_group.unit_for!(measurement_unit).conversion_factor
-        conversion_factor * measurement_value
-      else
-        value
-      end
+      return value if value.is_a?(Numeric)
+
+      measurement_value, measurement_unit = parse_value(value)
+      conversion_factor = unit_group.unit_for!(measurement_unit).conversion_factor
+      conversion_factor * measurement_value
     end
 
     private
@@ -75,5 +73,17 @@ module UnitMeasurements
       ["R",  %w(ronna),     1e+27],
       ["Q",  %w(quetta),    1e+30]
     ].map(&:freeze).freeze
+
+    def parse_value(tokens)
+      case tokens
+      when String
+        tokens = Parser.parse(value)
+      when Array
+        raise BaseError, "Cannot parse [number, unit] formatted tokens from #{tokens}." unless tokens.size == 2
+      else
+        raise BaseError, "Value of the unit must be defined as string or array, but received #{tokens}"
+      end
+      [tokens[0].to_r, tokens[1].freeze]
+    end
   end
 end

data/lib/unit_measurements/version.rb

@@ -3,5 +3,5 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -104,6 +104,7 @@ files:
 - Rakefile
 - lib/unit_measurements.rb
 - lib/unit_measurements/base.rb
+- lib/unit_measurements/comparison.rb
 - lib/unit_measurements/errors/parse_error.rb
 - lib/unit_measurements/errors/unit_already_defined_error.rb
 - lib/unit_measurements/errors/unit_error.rb