unit_measurements 5.10.0 → 5.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 519b4112a693a9c722e1241381eafb095005e4cbdef9792662e339df52087abf
-  data.tar.gz: 34054c7ef9056fe40d25f698403f0585b805c7426710302b102e93709582090b
+  metadata.gz: 299b2e4f1e3ebfedd82a18f0010b1aef87e464a00b17bb0fdccbd3d1d1d43807
+  data.tar.gz: a80df705e041ae39d0008e8f4e58b792850fc0b5cd74c4983846e02a371b7216
 SHA512:
-  metadata.gz: cbfdf296b4fab0d7b2c5a7932939ca9cba3205d42f9709d72b070b98748b97cd68a4a29d10c9f086fbd9decf65f906a977458f902e70a04ba2ee019326062f5a
-  data.tar.gz: df52b1126595b98d905a9f9b86b9884dcddd4c06b3ac547ba8bbac0d2dc4108d35329b1a629d278bf4cadf2959d4923e27be14a08702d8b5fd911affc977a0db
+  metadata.gz: 5c01c9a8d9b7fd6f3315b8befea0d852cb3e9c8ba8b2866975f60055c697f5fbb8af8fb7844f94144ca1b3919107bc8fb4570945974a1a62568febe1d665cd61
+  data.tar.gz: 880f955b5cf1ff30c51247ed3338a68ed78b4a9d416d9f7a594ca377b403749f5c3fad8b1515c56b2cf5b2656ddaa7b4759bad8ca38e8b383043b12b1853b597

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## [5.11.1](https://github.com/shivam091/unit_measurements/compare/v5.11.0...v5.11.1) - 2023-11-16
+
+### What's changed
+
+- Moved `BaseError` to base file for removing uninitialized constant error in reverse dependencies viz.
+[unit_measurements-rails](https://rubygems.org/gems/unit_measurements-rails) and
+[composite_unit_measurements](https://rubygems.org/gems/composite_unit_measurements).
+
+----------
+
+## [5.11.0](https://github.com/shivam091/unit_measurements/compare/v5.10.0...v5.11.0) - 2023-11-11
+
+### What's new
+
+- Added `#systems` method to return unit systems within the unit group.
+- Added `#ratio` method to calculate the ratio between two units.
+
+----------
+
 ## [5.10.0](https://github.com/shivam091/unit_measurements/compare/v5.9.0...v5.10.0) - 2023-11-09
 
 ### What's new

data/Gemfile.lock

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

data/README.md

@@ -179,6 +179,13 @@ UnitMeasurements::Length.parse("1:2 km to m")
 #=> 500.0 m
 ```
 
+**Calculate the ratio between two units:**
+
+```ruby
+UnitMeasurements::Length.ratio("in", "ft")
+#=> "12.0 in/ft"
+```
+
 **Formatting measurement:**
 
 If you want to format the measurement to certain format, you can use `#to_fs` method.
@@ -239,6 +246,13 @@ UnitMeasurements::Length.unit_names_with_aliases
 #=> ["\"", "'", "feet", "foot", "ft", "in", "inch", "inches", "m", "meter", "meters", "metre", "metres", "mi", "mile", "miles", "yard", "yards", "yd"]
 ```
 
+**See list of unit systems defined within the unit group:**
+
+```ruby
+UnitMeasurements::Length.systems
+#=> ["metric", "imperial", "us_customary", "astronomical"]
+```
+
 **See list of units within the unit system:**
 
 You can use `#units_for` or `#units_for!` methods to find units within the unit system.

data/lib/unit_measurements/base.rb

@@ -5,7 +5,25 @@
 require "active_support/all"
 require "unit_measurements/version"
 
+# The +UnitMeasurements+ module serves as a container for various functionalities
+# related to unit measurements. It provides methods for creating custom unit
+# groups, defining units, performing arithmetic operations,  comparison between
+# measurements, conversions, normalization of input strings, parsing measurements
+# from strings, and more. It is a fundamental part of the unit measurements library.
+#
+# @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+# @since 0.1.0
 module UnitMeasurements
+  # This is the base class for custom errors in the +UnitMeasurements+ module.
+  #
+  # @see ParseError
+  # @see PrimitiveUnitAlreadySetError
+  # @see UnitAlreadyDefinedError
+  # @see UnitError
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.1.0
+  class BaseError < StandardError; end
+
   class << self
     # Allows setting an instance of +Configuration+ containing values of desired
     # configurable options.

data/lib/unit_measurements/measurement.rb

@@ -243,7 +243,7 @@ module UnitMeasurements
       def_delegators :unit_group, :primitive, :units, :cache_file, :unit_names,
                      :unit_with_name_and_aliases, :unit_names_with_aliases,
                      :unit_for, :unit_for!, :defined?, :unit_or_alias?, :[],
-                     :units_for, :units_for!
+                     :units_for, :units_for!, :systems
 
       # Parses an input string and returns a +Measurement+ instance depending on
       # the input string. This method first normalizes the +input+ internally,
@@ -368,6 +368,40 @@ module UnitMeasurements
         cached.clear_cache
       end
 
+      # Calculates the ratio between two units.
+      #
+      # This method takes a source unit and a target unit, and returns the ratio
+      # between them as a string representation.
+      #
+      # @example Calculating the ratio between 'in' and 'ft':
+      #   UnitMeasurements::Length.ratio("in", "ft")
+      #   => "12.0 in/ft"
+      #
+      #   UnitMeasurements::Length.ratio(UnitMeasurements::Length.unit_for("in"), "ft")
+      #   => "12.0 in/ft"
+      #
+      # @param [Unit|String|Symbol] source_unit
+      #   The source unit for the ratio calculation.
+      # @param [Unit|String|Symbol] target_unit
+      #   The target unit for the ratio calculation.
+      #
+      # @return [String] The ratio between the source and target units.
+      #
+      # @raise [UnitError]
+      #   If either the source unit or the target unit is not found in the unit group.
+      #
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 5.11.0
+      def ratio(source_unit, target_unit)
+        source_unit = source_unit.is_a?(Unit) ? source_unit : unit_for!(source_unit)
+        target_unit = target_unit.is_a?(Unit) ? target_unit : unit_for!(target_unit)
+
+        source_quantity = 1
+        target_quantity = new(source_quantity, target_unit).convert_to(source_unit).quantity
+
+        "#{target_quantity} #{source_unit}/#{target_unit}"
+      end
+
       private
 
       # @private

data/lib/unit_measurements/unit_group.rb

@@ -247,6 +247,22 @@ module UnitMeasurements
       system_units
     end
 
+    # Returns an array of unit system names defined within the unit group.
+    #
+    # It scans through the units and compiles a list of unique system names.
+    #
+    # @example
+    #   UnitMeasurements::Length.systems
+    #   => ["metric", "imperial", "us_customary", "astronomical"]
+    #
+    # @return [Array<String>] An array of unit system names.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.11.0
+    def systems
+      units.map { _1.system }.uniq
+    end
+
     private
 
     # @private

data/lib/unit_measurements/version.rb

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

data/lib/unit_measurements.rb

@@ -2,26 +2,6 @@
 # -*- frozen_string_literal: true -*-
 # -*- warn_indent: true -*-
 
-# The +UnitMeasurements+ module serves as a container for various functionalities
-# related to unit measurements. It provides methods for creating custom unit
-# groups, defining units, performing arithmetic operations,  comparison between
-# measurements, conversions, normalization of input strings, parsing measurements
-# from strings, and more. It is a fundamental part of the unit measurements library.
-#
-# @author {Harshal V. Ladhe}[https://shivam091.github.io/]
-# @since 0.1.0
-module UnitMeasurements
-  # This is the base class for custom errors in the +UnitMeasurements+ module.
-  #
-  # @see ParseError
-  # @see PrimitiveUnitAlreadySetError
-  # @see UnitAlreadyDefinedError
-  # @see UnitError
-  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
-  # @since 1.1.0
-  class BaseError < StandardError; end
-end
-
 require "unit_measurements/base"
 
 require "unit_measurements/unit_groups/all"

metadata

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