unit_measurements 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3562e30ce7bfed682e67fbdc5c9d8d30b011a6cd16996b7efe6860622abf25d5
-  data.tar.gz: af4224714284377ebd6aea3a78c4842078f708eeaf06500658ef45f151192373
+  metadata.gz: b4606afee8a816cd36066634a4d6e8e23448548eb51d90d984c5230996f4e12c
+  data.tar.gz: ab4a36000579a4c3aa33f766a883bbd80c3fc1a485dcef6b12725316154db094
 SHA512:
-  metadata.gz: 22a6a8f0b97a5ef1845448bcf219fbd2d0228b3d74b409e93ce596f7648d67207ea5caa64f39e0c0dd9083bf6425c1012bbf11f25624faf718f377307b698309
-  data.tar.gz: 1a436d77f1a99a7eb838e397b0038b7aba73fe19d3acf7aa0e02dbd3d482beeb2fd6b33b648d2b02514681ba6b792076596f761dbca41fb0eab3985d84209f27
+  metadata.gz: ffb38111aa3c731166a453fd9f217a2a49a6bffc1db9962c8853af470dcdbf998d51834db785fe5863d2d3d8738cd86ac87d9a1f17ecd98990230683734774e6
+  data.tar.gz: c5e40fbf843746bac311e1e33071dc41b9b936551760f9aa488acd708b54b2ce8c6e26fb83d197f466acda14788f94fc67fd5013d0c5179116be2914f5e5bd25

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [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

data/Gemfile.lock

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

data/README.md

@@ -322,6 +322,29 @@ 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,10 +25,11 @@ 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"
-require "unit_measurements/comparison"
 require "unit_measurements/measurement"
 
 require "unit_measurements/errors/unit_error"

data/lib/unit_measurements/measurement.rb

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

data/lib/unit_measurements/version.rb

@@ -3,5 +3,5 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
-  VERSION = "1.3.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.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-16 00:00:00.000000000 Z
+date: 2023-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,6 +103,7 @@ 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