unit_measurements 5.12.0 → 5.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01978467f274548e8cf792d9b7bfe26ab85155a2c099482cb8b4017641ed900
-  data.tar.gz: d09990112a19291527059e822906a802a051541b654babad13e97110c5557dea
+  metadata.gz: 98def91ad4bff4c38e579a967b82ae5467e52db044246e6c91d00ccee9ea8070
+  data.tar.gz: 5e7c0aca97692daf71dc1923aabfca63f99ccfa0e246e1ec83665c8f821eb784
 SHA512:
-  metadata.gz: 0faa94f0a962f19134ff58276c6c876a30a81817172039c4261eaa9a15eeb61dd7047f61b96168c2115c4ba40711fee42cb4ceb832c6e6640bd9c8e7e0f4343b
-  data.tar.gz: d9213995299feeb51dda98cc4dbbd3bd76f6c4782a8e04b9612cc7f3134b192c74aa80b027779c1b8c862358a84a8c40469753a086ceb94fd5b5ee2b8d33e973
+  metadata.gz: e9a2f7bb789161cdd305eeec424d8b60eaf50c0ce6daa6868699c872ed5abf6bd06ba7fb9d5ae6cdb2d9021c837081553b984d29fb67b75c03af46e1f0b36fd2
+  data.tar.gz: 6098f3468240de037f7a39ec5f0a4ea8e431379523bee2da921f5dbe17368ea772d545e41e187341dfb48749168895a3d24d2a89c70e0b10dc18d9fe2656932a

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [5.13.0](https://github.com/shivam091/unit_measurements/compare/v5.12.0...v5.13.0) - 2023-11-27
+
+### What's new
+
+- Added `Measurement#to_primitive` to convert the measurement to the primitive unit.
+- Added `#cbrt` method to calculate cube root of the measurement quantity.
+- Added `#sqrt` method to calculate square root of the measurement quantity.
+- Aliased `#to_primitive` method as `#in_primitive` and `#as_primitive`.
+
+----------
+
 ## [5.12.0](https://github.com/shivam091/unit_measurements/compare/v5.11.1...v5.12.0) - 2023-11-25
 
 ### What's new

data/Gemfile.lock

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

data/README.md

@@ -116,10 +116,12 @@ UnitMeasurements::Length.new(1, "km").convert_to!("m")
 You can convert the measurement directly to the `primitive` unit of the unit group as:
 
 ```ruby
-UnitMeasurements::Length.new(1, "cm").convert_to("primitive")
+UnitMeasurements::Length.new(1, "cm").to_primitive
 #=> 0.01 m
 ```
 
+Note: `#to_primitive` method is aliased as `#in_primitive` and `#as_primitive`.
+
 **Parse string without having to split out the quantity and source unit:**
 
 This method provides `use_cache` parameter which defaults to `false` to indicate whether the caching of conversion factors should happen.
@@ -444,7 +446,7 @@ unit group using the `primitive` method. You can specify cache file name in unit
 
 ```ruby
 UnitMeasurements::MyUnitGroup = UnitMeasurements.build do
-  # Set primitive unit for the unit group (optional).
+  # Set primitive unit for the unit group.
   primitive "s"
 
   # Group units by the unit system (optional).

data/lib/unit_measurements/math.rb

@@ -87,5 +87,34 @@ module UnitMeasurements
     def ceil(ndigits = 0)
       self.class.new(quantity.ceil(ndigits), unit)
     end
+
+    # Returns square root of the measurement quantity.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(9, "m").sqrt
+    #   => 3.0 m
+    #
+    # @return [Measurement] A new +Measurement+ instance with square root of quantity.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.13.0
+    def sqrt
+      self.class.new((quantity ** Rational(1, 2)), unit)
+    end
+
+    # Returns cube root of the measurement quantity.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(27, "m").cbrt
+    #   => 3.0 m
+    #
+    # @return [Measurement]
+    #   A new +Measurement+ instance with cube root of quantity.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.13.0
+    def cbrt
+      self.class.new((quantity ** Rational(1, 3)), unit)
+    end
   end
 end

data/lib/unit_measurements/measurement.rb

@@ -131,15 +131,11 @@ module UnitMeasurements
     #   UnitMeasurements::Length.new(1, "m").convert_to("cm")
     #   => 100.0 cm
     #
-    #   UnitMeasurements::Length.new(1, "cm").convert_to("primitive")
-    #   => 0.01 m
-    #
-    #   UnitMeasurements::Length.new(1, "m").convert_to("cm", use_cache: true)
-    #   => 100.0 cm
+    #   UnitMeasurements::Length.new(1, "m").convert_to("mm", use_cache: true)
+    #   => 1000.0 cm
     #
     # @param [String|Symbol] target_unit
-    #   The target unit for conversion. Specifing +primitive+ will convert the
-    #   measurement to a primitive unit of the unit group.
+    #   The target unit for conversion.
     # @param [TrueClass|FalseClass] use_cache
     #   Indicates whether to use cached conversion factors.
     #
@@ -147,20 +143,10 @@ module UnitMeasurements
     #   A new +Measurement+ instance with the converted +quantity+ and
     #   +target unit+.
     #
-    # @raise [MissingPrimitiveUnitError]
-    #   if primitive unit is not set for the unit group.
-    #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 1.0.0
     def convert_to(target_unit, use_cache: false)
-      target_unit = if target_unit.to_s.eql?("primitive")
-        primitive_unit = self.class.primitive
-
-        raise MissingPrimitiveUnitError if primitive_unit.nil?
-        primitive_unit
-      else
-        unit_from_unit_or_name!(target_unit)
-      end
+      target_unit = unit_from_unit_or_name!(target_unit)
       return self if target_unit == unit
 
       conversion_factor = calculate_conversion_factor(target_unit, use_cache)
@@ -177,15 +163,11 @@ module UnitMeasurements
     #   UnitMeasurements::Length.new(1, "m").convert_to!("cm")
     #   => 100.0 cm
     #
-    #   UnitMeasurements::Length.new(1, "cm").convert_to!("primitive")
-    #   => 0.01 m
-    #
-    #   UnitMeasurements::Length.new(1, "m").convert_to!("cm", use_cache: true)
-    #   => 100.0 cm
+    #   UnitMeasurements::Length.new(1, "m").convert_to!("mm", use_cache: true)
+    #   => 1000.0 mm
     #
     # @param [String|Symbol] target_unit
-    #   The target unit for conversion. Specifing +primitive+ will convert the
-    #   measurement to a primitive unit of the unit group.
+    #   The target unit for conversion.
     # @param [TrueClass|FalseClass] use_cache
     #   Indicates whether to use cached conversion factors.
     #
@@ -205,6 +187,41 @@ module UnitMeasurements
     alias_method :in!, :convert_to!
     alias_method :as!, :convert_to!
 
+    # Converts the measurement to its primitive unit and returns a new instance
+    # of the +Measurement+.
+    #
+    # The method first retrieves the primitive unit of the unit group associated
+    # with the measurement. If the primitive unit is not set, it raises a
+    # +MissingPrimitiveUnitError+.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(1, "m").to_primitive
+    #   => 1 m
+    #
+    #   UnitMeasurements::Length.new(1, "cm").to_primitive
+    #   => 0.01 m
+    #
+    # @param [TrueClass|FalseClass] use_cache
+    #   Indicates whether to use cached conversion factors.
+    # @return [Measurement]
+    #   A new +Measurement+ instance representing the measurement in its
+    #   primitive unit.
+    #
+    # @raise [MissingPrimitiveUnitError]
+    #   If the primitive unit is not set for the unit group associated with the
+    #   measurement.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.13.0
+    def to_primitive(use_cache: false)
+      primitive_unit = self.class.primitive
+      raise MissingPrimitiveUnitError if primitive_unit.nil?
+
+      convert_to(primitive_unit, use_cache: use_cache)
+    end
+    alias_method :in_primitive, :to_primitive
+    alias_method :as_primitive, :to_primitive
+
     # Returns an object representation of the +Measurement+.
     #
     # @param [TrueClass|FalseClass] dump If +true+, returns the dump representation.

data/lib/unit_measurements/version.rb

@@ -4,5 +4,5 @@
 
 module UnitMeasurements
   # Current stable version.
-  VERSION = "5.12.0"
+  VERSION = "5.13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 5.12.0
+  version: 5.13.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-25 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport