unit_measurements 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d1b9cef9a108d5a0930ca0fd0a2e156a5653893786eb97159c7c4c801e71970
-  data.tar.gz: a4ef6d728ad141f2d19ab5151ea3205ce2098710b8facf1d979b4299e8a72530
+  metadata.gz: daf31532333a9d280d948318fe94079cfb5a8d341f6756a5c64b42843142c80f
+  data.tar.gz: 88a85aed303c4c5209330bdcf14b1ee5696e40b0e815b6b570a60ac6fd4b6db5
 SHA512:
-  metadata.gz: 360ba9c4e48722b51fc9d9dd049ddd2217aac3c30d3de6afb66ee10d31d466d15e743f6437ceb6d7f232844378f6ca3be995447627e4264c1c25d1e7db9690e5
-  data.tar.gz: 8bed02dfd85b3933e128e2c390a12f5f63f15950ddadd053063822f00be4b8c3464992ad0d51440bebcbad78c7b0df1b80cdcb341b1d1dbeea0d1171ed06ffdc
+  metadata.gz: 60febdff329999f4aeedb36fbb8aa70eccf1ab8feecc34c4318daca4949b2df16034a285ce8ac5bee2c99e59f991fe52f456154dba5ae1c945bdf6e732f2ed55
+  data.tar.gz: 8152670ce01518dac56686ccc17f51e5c3b898f6ec90710d9a5ebb66089fa234351a70a0a91a9b9e1adf02cfb0966df3490b02f625aa639239c63440d515e960

data/CHANGELOG.md

@@ -1,8 +1,24 @@
+## [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
+
+- Added extra blank line between method code and last code statement (considered as return).
+
+----------
+
 ## [1.5.0](https://github.com/shivam091/unit_measurements/compare/v1.4.0...v1.5.0) - 2023-08-18
 
-## What's fixed
+### What's fixed
 
-- Fixed precision in `Measurement#quantity` method
+- Fixed precision in `Measurement#quantity` method.
 
 ----------
 

data/Gemfile.lock

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

data/README.md

@@ -307,7 +307,6 @@ UnitMeasurements::Weight.unit_or_alias?(:gramme)
 
 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)
@@ -320,6 +319,10 @@ UnitMeasurements::Weight.parse("1 kg") <= UnitMeasurements::Weight.parse("0.5 kg
 #=> false
 UnitMeasurements::Weight.parse("1 kg") >= UnitMeasurements::Weight.parse("0.5 kg")
 #=> true
+UnitMeasurements::Length.new(1, :ft).between?(UnitMeasurements::Length.new(12, :in), UnitMeasurements::Length.new(24, :in))
+#=> true
+UnitMeasurements::Length.new(1, :ft).clamp(UnitMeasurements::Length.new(13, :in), UnitMeasurements::Length.new(24, :in))
+#=> 13 in
 ```
 
 ### Arithmetic
@@ -345,6 +348,27 @@ 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
+```
+
 ## Units
 
 The **`UnitMeasurements::Unit`** class is used to represent the units for a measurement.

data/lib/unit_measurements/arithmetic.rb

@@ -68,6 +68,7 @@ module UnitMeasurements
 
     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

data/lib/unit_measurements/base.rb

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

data/lib/unit_measurements/errors/parse_error.rb

@@ -8,6 +8,7 @@ module UnitMeasurements
 
     def initialize(string)
       @string = string
+
       super("Unable to parse: '#{string}'.")
     end
   end

data/lib/unit_measurements/errors/unit_already_defined_error.rb

@@ -8,6 +8,7 @@ module UnitMeasurements
 
     def initialize(unit)
       @unit = unit
+
       super("Unit already defined: '#{unit}'.")
     end
   end

data/lib/unit_measurements/errors/unit_error.rb

@@ -8,6 +8,7 @@ module UnitMeasurements
 
     def initialize(unit)
       @unit = unit
+
       super("Invalid unit: '#{unit}'.")
     end
   end

data/lib/unit_measurements/formatter.rb

@@ -22,6 +22,7 @@ module UnitMeasurements
     # @return [String]
     def format(format = nil)
       kwargs = {quantity: quantity, unit: unit.to_s}
+
       (format || DEFAULT_FORMAT) % kwargs
     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,10 @@
 
 module UnitMeasurements
   class Measurement
-    include Formatter
-    include Comparison
     include Arithmetic
+    include Comparison
+    include Formatter
+    include Math
 
     CONVERSION_STRING_REGEXP = /(.+?)\s?(?:\s+(?:in|to|as)\s+(.+)|\z)/i.freeze
 
@@ -26,6 +27,7 @@ module UnitMeasurements
       return self if target_unit == unit
 
       conversion_factor = (unit.conversion_factor / target_unit.conversion_factor)
+
       self.class.new((quantity * conversion_factor), target_unit)
     end
     alias_method :to, :convert_to
@@ -33,6 +35,7 @@ module UnitMeasurements
     def convert_to!(target_unit)
       measurement = convert_to(target_unit)
       @quantity, @unit = measurement.quantity, measurement.unit
+
       self
     end
     alias_method :to!, :convert_to!
@@ -70,6 +73,7 @@ module UnitMeasurements
       def parse(input)
         input = Normalizer.normalize(input)
         source, target = input.match(CONVERSION_STRING_REGEXP)&.captures
+
         target ? _parse(source).convert_to(target) : _parse(source)
       end
 
@@ -77,6 +81,7 @@ module UnitMeasurements
 
       def _parse(string)
         quantity, unit = Parser.parse(string)
+
         new(quantity, unit)
       end
     end
@@ -92,6 +97,7 @@ module UnitMeasurements
       when String
         quantity = Normalizer.normalize(quantity)
         quantity, _ = Parser.parse(quantity)
+
         quantity
       else
         quantity

data/lib/unit_measurements/unit_group_builder.rb

@@ -37,17 +37,20 @@ module UnitMeasurements
         end
         si_units << build_unit("#{short_prefix}#{name}", value: "#{multiplier} #{name}", aliases: si_aliases)
       end
+
       si_units
     end
 
     def build_unit(name, value:, aliases:)
       unit = Unit.new(name, value: value, aliases: aliases)
       check_for_duplicate_unit_names!(unit)
+
       unit
     end
 
     def check_for_duplicate_unit_names!(unit)
       names = @units.flat_map(&:names)
+
       if names.any? { |name| unit.names.include?(name) }
         raise UnitAlreadyDefinedError.new(unit.name)
       end

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.0"
+  VERSION = "1.6.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.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,6 +110,7 @@ files:
 - 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