unit_measurements 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 330be281aba063532010cf47f1e0065c35390510749002f368ff3139a22e6b5c
-  data.tar.gz: 26a8aa9db580205a117b11a8b653a5c609d1972be7b3eb76e2b91ec20f02b7be
+  metadata.gz: b4606afee8a816cd36066634a4d6e8e23448548eb51d90d984c5230996f4e12c
+  data.tar.gz: ab4a36000579a4c3aa33f766a883bbd80c3fc1a485dcef6b12725316154db094
 SHA512:
-  metadata.gz: 2d67ddc3a66baec5ce04878b046541dd7b9f3d8da65a18fcf84179f4178c467b3e2276f1a236e22caac9d170815d6529be842fdac2ac45aed79e48b32d136de7
-  data.tar.gz: 331afbfc4616fd9cbccf13ed6c3d01266ba6fd49e9fe4ae06c9f8ed311210a77381056d0037415b4fc4c48477a5fcda48d2d64397c8df3888bcacf1b965c79c8
+  metadata.gz: ffb38111aa3c731166a453fd9f217a2a49a6bffc1db9962c8853af470dcdbf998d51834db785fe5863d2d3d8738cd86ac87d9a1f17ecd98990230683734774e6
+  data.tar.gz: c5e40fbf843746bac311e1e33071dc41b9b936551760f9aa488acd708b54b2ce8c6e26fb83d197f466acda14788f94fc67fd5013d0c5179116be2914f5e5bd25

data/CHANGELOG.md

@@ -1,8 +1,24 @@
+## [1.4.0](https://github.com/shivam091/unit_measurements/compare/v1.3.0...v1.4.0) - 2023-08-17
+
+### What's new
+
+- Added ability to perform `arithmetic` operations of measurements.
+
+----------
+
+## [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. viz.,
+- Added support to specify unit value as an `array` of number and unit.
 
 ----------
 

data/Gemfile.lock

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

data/README.md

@@ -303,6 +303,48 @@ 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
+```
+
+### Arithmetic
+
+You have the ability to perform arithmetic operations on measurements with the same or
+different units within the same unit group. You can perform arithmetic operations on
+measurement by either other compatible measurement or number.
+
+**Methods:**
+1. `#+` - Adds the other measurement quantity or number to the measurement.
+2. `#-` - Subtracts the other measurement quantity or number from the measurement.
+3. `#*` - Multiplies the measurement quantity by other measurement quantity or number.
+4. `#/` - Divides the measurement quantity by other measurement quantity or number.
+
+```ruby
+UnitMeasurements::Weight.new(1, :kg) + UnitMeasurements::Weight.new(1, :g)
+#=> 1.001 kg
+UnitMeasurements::Weight.new(2, :kg) - 1
+#=> 1 kg
+UnitMeasurements::Weight.new(2, :kg) * 2
+#=> 4 kg
+UnitMeasurements::Weight.new(4, :kg) / UnitMeasurements::Weight.new(2, :kg)
+#=> 2 kg
+```
+
 ## Units
 
 The **`UnitMeasurements::Unit`** class is used to represent the units for a measurement.

data/lib/unit_measurements/arithmetic.rb

@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  module Arithmetic
+    # Adds the other measurement quantity or number to the measurement.
+    #
+    # @param [Numeric or Measurement] other
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(1, :kg) + UnitMeasurements::Weight.new(1, :g)
+    #   => 1.001 kg
+    #
+    # @return [Measurement]
+    def +(other)
+      arithmetic_operation(other, :+)
+    end
+
+    # Subtracts the other measurement quantity or number from the measurement.
+    #
+    # @param [Numeric or Measurement] other
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2, :kg) - 1
+    #   => 1 kg
+    #
+    # @return [Measurement]
+    def -(other)
+      arithmetic_operation(other, :-)
+    end
+
+    # Multiplies the measurement quantity by other measurement quantity or number.
+    #
+    # @param [Numeric or Measurement] other
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2, :kg) * 2
+    #   => 4 kg
+    #
+    # @return [Measurement]
+    def *(other)
+      arithmetic_operation(other, :*)
+    end
+
+    # Divides the measurement quantity by other measurement quantity or number.
+    #
+    # @param [Numeric or Measurement] other
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(4, :kg) / UnitMeasurements::Weight.new(2, :kg)
+    #   => 2 kg
+    #
+    # @return [Measurement]
+    def /(other)
+      arithmetic_operation(other, :/)
+    end
+
+    private
+
+    def coerce(other)
+      case other
+      when Numeric    then [self.class.new(other, self.unit), self]
+      when self.class then [other, self]
+      else                 raise TypeError, "Cannot coerce #{other.class} to #{self.class}"
+      end
+    end
+
+    def arithmetic_operation(other, operator)
+      other, _ = coerce(other)
+      self.class.new(self.quantity.public_send(operator, other.convert_to(self.unit).quantity), self.unit)
+    end
+  end
+end

data/lib/unit_measurements/base.rb

@@ -25,6 +25,8 @@ end
 require "unit_measurements/unit_group_builder"
 require "unit_measurements/unit"
 require "unit_measurements/unit_group"
+require "unit_measurements/arithmetic"
+require "unit_measurements/comparison"
 require "unit_measurements/normalizer"
 require "unit_measurements/parser"
 require "unit_measurements/formatter"

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,9 @@
 module UnitMeasurements
   class Measurement
     include Formatter
+    include Comparison
+    include Arithmetic
+
     CONVERSION_STRING_REGEXP = /(.+?)\s?(?:\s+(?:in|to|as)\s+(.+)|\z)/i.freeze
 
     attr_reader :quantity, :unit

data/lib/unit_measurements/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2023-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,7 +103,9 @@ files:
 - README.md
 - Rakefile
 - lib/unit_measurements.rb
+- lib/unit_measurements/arithmetic.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