unit_measurements 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aac3030ed1c46bb4bdfe831bc9bedb29ad2a8b0e28595ba4726b2a3ff5e24791
-  data.tar.gz: 9179c7b41ef7e84b6864ef98ccb45210ab34b2488830aa3de5552659b7f39039
+  metadata.gz: bbb7978f79ac8f4fac738ef87936cf1bf20397c74772c35120205aed22d1ac1c
+  data.tar.gz: 1b99cb2665a071d0e721f78cabad86fc50a39e2eda8349bd5813ba80c48afe89
 SHA512:
-  metadata.gz: 5435fba092be97c1c8407b917857c1990db07d1aa1729653ecf14519d98dcec2a4c5e5ad0c4997586eb2f72b17d1099506068aa99eb592ee35ddd8da4a2f8ba7
-  data.tar.gz: 5938944868b729168d49d1f5e7e888029931bb17237fd72c66980bf6b47d7fe58f8eefdd94f1927652d9b5d1e3e480e8df746f5c7607995390ea7caeec186634
+  metadata.gz: 27da14501c804050def9568138cfcab08b7b81eeab9d47ba3c23117534d2f32f33ed42260c9199d95f1c5cc71e715d1844cc493be34e347989c9fb71932fb058
+  data.tar.gz: e6c5e47ab28b199599cc7b86b748205d3124c52fbbdfb83a38849876177764e280ce6d324336908ebdff0eff6a3acdb98b8cf8a8bc94ef8f325deca2d378f560

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [1.7.0](https://github.com/shivam091/unit_measurements/compare/v1.6.0...v1.7.0) - 2023-08-20
+
+### What's new
+
+- Added support to convert the measurements to other numeric types viz.,
+  `Integer`, `BigDecimal`, `Rational`, `Complex`, and `Float`.
+
+----------
+
+## [1.6.0](https://github.com/shivam091/unit_measurements/compare/v1.5.1...v1.6.0) - 2023-08-19
+
+### What's new
+
+- Added support to perform mathematical operations on the measurements.
+
+----------
+
 ## [1.5.1](https://github.com/shivam091/unit_measurements/compare/v1.5.0...v1.5.1) - 2023-08-18
 
 ### What's updated

data/Gemfile.lock

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

data/README.md

@@ -348,6 +348,45 @@ UnitMeasurements::Weight.new(4, :kg) / UnitMeasurements::Weight.new(2, :kg)
 #=> 2 kg
 ```
 
+### Math
+
+You can perform mathematical operations on the measurements.
+
+**Methods:**
+1. `#round` - Rounds quantity of the measurement. If `ndigits` is not specified, quantity is rounded to `Integer`.
+2. `#abs` - Returns absolute value of the measurement quantity.
+3. `#floor` - Rounds quantity of the measurement to next lower integer.
+4. `#ceil` - Rounds quantity of the measurement to next higher integer.
+
+```ruby
+UnitMeasurements::Weight.new(1, :g).convert_to(:st).round(4)
+#=> 0.0002 st
+UnitMeasurements::Length.new(-17.625, :m).abs
+#=> 17.625 m
+UnitMeasurements::Length.new(17.625, :m).floor
+#=> 17 m
+UnitMeasurements::Length.new(17.625, :m).ceil
+#=> 18 m
+```
+
+### Conversions
+
+You can convert measurement quantity directly to other numeric types viz.
+`Integer`, `BigDecimal`, `Rational`, `Complex`, and `Float`.
+
+```ruby
+UnitMeasurements::Weight.new(2.25567, :kg).to_i
+#=> 2 kg
+UnitMeasurements::Weight.new(2.25567, :kg).to_f
+#=> 2.25567 kg
+UnitMeasurements::Weight.new(2.25567, :kg).to_r
+#=> 225567/100000 kg
+UnitMeasurements::Weight.new(2.25567, :kg).to_d
+#=> 2.25567 kg
+UnitMeasurements::Weight.new(2.25567, :kg).to_c
+#=> 2.25567+0i kg
+```
+
 ## Units
 
 The **`UnitMeasurements::Unit`** class is used to represent the units for a measurement.

data/lib/unit_measurements/base.rb

@@ -27,6 +27,8 @@ require "unit_measurements/unit"
 require "unit_measurements/unit_group"
 require "unit_measurements/arithmetic"
 require "unit_measurements/comparison"
+require "unit_measurements/conversion"
+require "unit_measurements/math"
 require "unit_measurements/normalizer"
 require "unit_measurements/parser"
 require "unit_measurements/formatter"

data/lib/unit_measurements/conversion.rb

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  module Conversion
+    # Converts quantity of the measurement to +Integer+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_i
+    #   => 2 kg
+    #
+    # @return [Measurement]
+    def to_i
+      self.class.new(quantity.to_i, unit)
+    end
+
+    # Converts quantity of the measurement to +Float+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_f
+    #   => 2.25567 kg
+    #
+    # @return [Measurement]
+    def to_f
+      self.class.new(quantity.to_f, unit)
+    end
+
+    # Converts quantity of the measurement to +Rational+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_r
+    #   => 225567/100000 kg
+    #
+    # @return [Measurement]
+    def to_r
+      self.class.new(quantity.to_r, unit)
+    end
+
+    # Converts quantity of the measurement to +Complex+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_c
+    #   => 2.25567+0i kg
+    #
+    # @return [Measurement]
+    def to_c
+      self.class.new(quantity.to_c, unit)
+    end
+
+    # Converts quantity of the measurement to +BigDecimal+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_d
+    #   => 2.25567 kg
+    #
+    # @return [Measurement]
+    def to_d
+      self.class.new(quantity.to_d, unit)
+    end
+  end
+end

data/lib/unit_measurements/math.rb

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  module Math
+    # Rounds quantity of the measurement. If `ndigits` is not specified,
+    # quantity is rounded to `Integer`.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(1, :g).convert_to(:st).round(4)
+    #   => 0.0002 st
+    #
+    # @param [Integer] ndigits
+    #
+    # @return [Measurement]
+    def round(ndigits = 0)
+      self.class.new(quantity.round(ndigits), unit)
+    end
+
+    # Returns absolute value of the measurement quantity.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(-17.625, :m).abs
+    #   => 17.625 m
+    #
+    # @return [Measurement]
+    def abs
+      self.class.new(quantity.abs, unit)
+    end
+
+    # Rounds quantity of the measurement to next lower integer.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(17.625, :m).floor
+    #   => 17 m
+    #
+    # @return [Measurement]
+    def floor(*args)
+      self.class.new(quantity.floor(*args), unit)
+    end
+
+    # Rounds quantity of the measurement to next higher integer.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(17.625, :m).ceil
+    #   => 18 m
+    #
+    # @return [Measurement]
+    def ceil(*args)
+      self.class.new(quantity.ceil(*args), unit)
+    end
+  end
+end

data/lib/unit_measurements/measurement.rb

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

data/lib/unit_measurements/unit_groups/length.rb

@@ -3,10 +3,10 @@
 # -*- warn_indent: true -*-
 
 UnitMeasurements::Length = UnitMeasurements.build do
-  si_unit :m, aliases: %i[meter metre meters metres]
+  si_unit :m, aliases: [:meter, :metre, :meters, :metres]
 
-  unit :in, value: "25.4 mm", aliases: %i[" inch inches]
-  unit :ft, value: "12 in", aliases: %i[' foot feet]
-  unit :yd, value: "3 ft", aliases: %i[yard yards]
-  unit :mi, value: "1760 yd", aliases: %i[mile miles]
+  unit :in, value: "25.4 mm", aliases: [:'"', :inch, :inches]
+  unit :ft, value: "12 in", aliases: [:"'", :foot, :feet]
+  unit :yd, value: "3 ft", aliases: [:yard, :yards]
+  unit :mi, value: "1760 yd", aliases: [:mile, :miles]
 end

data/lib/unit_measurements/unit_groups/weight.rb

@@ -3,8 +3,8 @@
 # -*- warn_indent: true -*-
 
 UnitMeasurements::Weight = UnitMeasurements.build do
-  si_unit :g, aliases: %i[gram grams gramme grammes]
+  si_unit :g, aliases: [:gram, :grams, :gramme, :grammes]
 
-  unit :q, value: "100 kg", aliases: %i[quintal quintals]
-  unit :t, value: "10 q", aliases: %i[tonne tonnes metric\ tonne metric\ tonnes]
+  unit :q, value: "100 kg", aliases: [:quintal, :quintals]
+  unit :t, value: "10 q", aliases: [:tonne, :tonnes, :"metric tonne", :"metric tonnes"]
 end

data/lib/unit_measurements/version.rb

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

data/units.md

@@ -5,7 +5,7 @@ bundled units before converting your measurements.
 
 **Notes:**
 1. Base unit for each unit group is highlighted.
-2. Unit numbers suffixed with `*` support all [SI prefixes](README.md#si-units-support).
+2. Unit names suffixed with `*` support all [SI prefixes](README.md#si-units-support).
 
 Below are the units which are bundled in the unit_measurements.
 
@@ -13,9 +13,9 @@ Below are the units which are bundled in the unit_measurements.
 
 These units are defined in `UnitMeasurements::Length`.
 
-| # | Symbol | Aliases |
+| # | Name | Aliases |
 |:--|:--|:--|
-| **1\*** | **m** | **meter, metre, meters, metres** |
+| **1** | **m\*** | **meter, metre, meters, metres** |
 | 2 | in | ", inch, inches |
 | 3 | ft | ', foot, feet |
 | 4 | yd | yard, yards |
@@ -25,8 +25,8 @@ These units are defined in `UnitMeasurements::Length`.
 
 These units are defined in `UnitMeasurements::Weight`.
 
-| # | Symbol | Aliases |
+| # | Name | Aliases |
 |--|--|--|
-| **1\*** | **g** | **gram, grams, gramme, grammes** |
+| **1** | **g\*** | **gram, grams, gramme, grammes** |
 | 2 | q | quintal, quintals |
 | 3 | t | tonne, tonnes, metric tonne, metric tonnes |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,10 +106,12 @@ files:
 - lib/unit_measurements/arithmetic.rb
 - lib/unit_measurements/base.rb
 - lib/unit_measurements/comparison.rb
+- lib/unit_measurements/conversion.rb
 - lib/unit_measurements/errors/parse_error.rb
 - lib/unit_measurements/errors/unit_already_defined_error.rb
 - lib/unit_measurements/errors/unit_error.rb
 - lib/unit_measurements/formatter.rb
+- lib/unit_measurements/math.rb
 - lib/unit_measurements/measurement.rb
 - lib/unit_measurements/normalizer.rb
 - lib/unit_measurements/parser.rb