unit_measurements 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3562e30ce7bfed682e67fbdc5c9d8d30b011a6cd16996b7efe6860622abf25d5
-  data.tar.gz: af4224714284377ebd6aea3a78c4842078f708eeaf06500658ef45f151192373
+  metadata.gz: 6d1b9cef9a108d5a0930ca0fd0a2e156a5653893786eb97159c7c4c801e71970
+  data.tar.gz: a4ef6d728ad141f2d19ab5151ea3205ce2098710b8facf1d979b4299e8a72530
 SHA512:
-  metadata.gz: 22a6a8f0b97a5ef1845448bcf219fbd2d0228b3d74b409e93ce596f7648d67207ea5caa64f39e0c0dd9083bf6425c1012bbf11f25624faf718f377307b698309
-  data.tar.gz: 1a436d77f1a99a7eb838e397b0038b7aba73fe19d3acf7aa0e02dbd3d482beeb2fd6b33b648d2b02514681ba6b792076596f761dbca41fb0eab3985d84209f27
+  metadata.gz: 360ba9c4e48722b51fc9d9dd049ddd2217aac3c30d3de6afb66ee10d31d466d15e743f6437ceb6d7f232844378f6ca3be995447627e4264c1c25d1e7db9690e5
+  data.tar.gz: 8bed02dfd85b3933e128e2c390a12f5f63f15950ddadd053063822f00be4b8c3464992ad0d51440bebcbad78c7b0df1b80cdcb341b1d1dbeea0d1171ed06ffdc

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [1.5.0](https://github.com/shivam091/unit_measurements/compare/v1.4.0...v1.5.0) - 2023-08-18
+
+## What's fixed
+
+- Fixed precision in `Measurement#quantity` method
+
+----------
+
+## [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.5.0)
       activesupport (~> 7.0)
 
 GEM

data/README.md

@@ -79,14 +79,14 @@ You can use `#convert_to` as:
 
 ```ruby
 UnitMeasurements::Weight.new(1, :kg).convert_to(:g)
-#=> 1000 g
+#=> 1000.0 g
 ```
 
 If you want to modify measurement object itself, you can use `#convert_to!` method as:
 
 ```ruby
 UnitMeasurements::Weight.new(1, :kg).convert_to!(:g)
-#=> 1000 g
+#=> 1000.0 g
 ```
 
 You can also chain call of `#convert_to` and `#convert_to!` methods as:
@@ -100,18 +100,18 @@ UnitMeasurements::Weight.new(1, :kg).convert_to(:g).convert_to(:t).convert_to!(:
 
 ```ruby
 UnitMeasurements::Weight.parse("1 kg")
-#=> 1 kg
+#=> 1.0 kg
 ```
 
 **Parse string that mentions quantity, source unit, and target unit:**
 
 ```ruby
 UnitMeasurements::Weight.parse("1 kg to g")
-#=> 1000 g
+#=> 1000.0 g
 UnitMeasurements::Weight.parse("1 kg as g")
-#=> 1000 g
+#=> 1000.0 g
 UnitMeasurements::Weight.parse("1 kg in g")
-#=> 1000 g
+#=> 1000.0 g
 ```
 
 **Parse rational numbers, source unit, and (or) target unit:**
@@ -144,58 +144,58 @@ UnitMeasurements::Weight.parse("2+3i kg to g")
 
 ```ruby
 UnitMeasurements::Weight.new(BigDecimal(2), :kg).convert_to(:g)
-#=> 2000 g
+#=> 2000.0 g
 UnitMeasurements::Weight.new(0.2e1, :kg).convert_to(:g)
-#=> 2000 g
+#=> 2000.0 g
 UnitMeasurements::Weight.parse("0.2e1 kg").convert_to(:g)
-#=> 2000 g
+#=> 2000.0 g
 UnitMeasurements::Weight.parse("0.2e1 kg to g")
-#=> 2000 g
+#=> 2000.0 g
 ```
 
 **Parse ratios, source unit, and (or) target unit:**
 
 ```ruby
 UnitMeasurements::Weight.new("1:2", :kg).convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("1:2 kg").convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("1:2 kg to g")
-#=> 500 g
+#=> 500.0 g
 ```
 
 **Parse fractional notations, source unit, and (or) target unit:**
 
 ```ruby
 UnitMeasurements::Weight.new("1/2", :kg).convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("1/2 kg").convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("1/2 kg to g")
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.new("½", :kg).convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("½ kg").convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("½ kg to g")
-#=> 500 g
+#=> 500.0 g
 ```
 
 **Parse mixed fractional notations, source unit, and (or) target unit:**
 
 ```ruby
 UnitMeasurements::Weight.new("2 1/2", :kg).convert_to(:g)
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.parse("2 1/2 kg").convert_to(:g)
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.parse("2 1/2 kg to g")
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.new("2 ½", :kg).convert_to(:g)
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.parse("2 ½ kg").convert_to(:g)
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.parse("2 ½ kg to g")
-#=> 2500 g
+#=> 2500.0 g
 ```
 
 Supported special characters for fractional notations are `¼`, `½`, `¾`, `⅓`, `⅔`, `⅕`, `⅖`, `⅗`, `⅘`, `⅙`, `⅚`, `⅐`, `⅛`, `⅜`, `⅝`, `⅞`, `⅑`, `⅒`, `↉`, `⁄`.
@@ -204,17 +204,17 @@ Supported special characters for fractional notations are `¼`, `½`, `¾`, `⅓
 
 ```ruby
 UnitMeasurements::Weight.new("2e+2", :kg).convert_to(:g)
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.parse("2e² kg").convert_to(:g)
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.parse("2e+2 kg to g")
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.new("2e⁺²", :kg).convert_to(:g)
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.parse("2e⁺2 kg").convert_to(:g)
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.parse("2e⁻² kg to g")
-#=> 20 g
+#=> 20.0 g
 ```
 
 Supported special characters for exponents are `⁰`, `¹`, `²`, `³`, `⁴`, `⁵`, `⁶`, `⁷`, `⁸`, `⁹`, `⁺`, `⁻`.
@@ -236,9 +236,9 @@ UnitMeasurements::Weight.parse("2 kg").to(:st).format("%.4<quantity>f")
 **Extract the unit and the quantity from measurement:**
 
 ```ruby
-weight = UnitMeasurements::Weight.new(1.0, :kg)
+weight = UnitMeasurements::Weight.new(1, :kg)
 weight.quantity
-#=> 0.1e1
+#=> 1
 weight.unit
 #=> #<UnitMeasurements::Unit: kg (kilogram, kilogramme, kilogrammes, kilograms)>
 ```
@@ -322,6 +322,29 @@ UnitMeasurements::Weight.parse("1 kg") >= UnitMeasurements::Weight.parse("0.5 kg
 #=> true
 ```
 
+### Arithmetic
+
+You have ability to perform arithmetic operations on measurements with the same or
+different units within a 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
 
@@ -43,7 +44,16 @@ module UnitMeasurements
     end
 
     def to_s
-      "#{humanized_quantity} #{unit.to_s}"
+      "#{quantity} #{unit}"
+    end
+
+    def quantity
+      case @quantity
+      when Rational
+        @quantity.denominator == 1 ? @quantity.numerator : @quantity
+      else
+        @quantity
+      end
     end
 
     class << self
@@ -91,15 +101,5 @@ module UnitMeasurements
     def unit_from_unit_or_name!(value)
       value.is_a?(Unit) ? value : self.class.unit_group.unit_for!(value)
     end
-
-    def humanized_quantity
-      case quantity
-      when Complex
-        quantity
-      when Numeric
-        num = quantity.to_r
-        num.denominator == 1 ? num.numerator.to_s : num.to_f.to_s
-      end
-    end
   end
 end

data/lib/unit_measurements/version.rb

@@ -3,5 +3,5 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
-  VERSION = "1.3.0"
+  VERSION = "1.5.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.5.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-16 00:00:00.000000000 Z
+date: 2023-09-18 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