unit_measurements 5.13.0 → 5.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98def91ad4bff4c38e579a967b82ae5467e52db044246e6c91d00ccee9ea8070
-  data.tar.gz: 5e7c0aca97692daf71dc1923aabfca63f99ccfa0e246e1ec83665c8f821eb784
+  metadata.gz: 9e89ba7ff921595afff359baeafb673b3d1d08d65293aefb4efc3082b99bfad3
+  data.tar.gz: ce3695641b050fa395920124859257d2757707cbdda8b8cc42feaa64a75363bc
 SHA512:
-  metadata.gz: e9a2f7bb789161cdd305eeec424d8b60eaf50c0ce6daa6868699c872ed5abf6bd06ba7fb9d5ae6cdb2d9021c837081553b984d29fb67b75c03af46e1f0b36fd2
-  data.tar.gz: 6098f3468240de037f7a39ec5f0a4ea8e431379523bee2da921f5dbe17368ea772d545e41e187341dfb48749168895a3d24d2a89c70e0b10dc18d9fe2656932a
+  metadata.gz: 8b4085c191ebe55c90a272c63ba47c0d54860af42278860f3e30096060a0ebfa34b20a5b81ee57c35327e3f3336617193bacfdab7b76be0361b75d4ebd665f75
+  data.tar.gz: a2fe5a6c2f58534a2a688bca5140927906e4c10035dd1e05a4c1b40686a61dc90e2afa1c5929b5a25041101c9327fbb5e6e2e1c937fe025e433bea21b3e99507

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [5.15.0](https://github.com/shivam091/unit_measurements/compare/v5.14.0...v5.15.0) - 2023-12-01
+
+### What's new
+
+- Added `.define_conversion_methods` method to define conversion helper methods for units.
+
+----------
+
+## [5.14.0](https://github.com/shivam091/unit_measurements/compare/v5.13.0...v5.14.0) - 2023-11-29
+
+### What's new
+
+- Added `.define_numeric_methods` method to define numeric extension methods for units.
+
+----------
+
 ## [5.13.0](https://github.com/shivam091/unit_measurements/compare/v5.12.0...v5.13.0) - 2023-11-27
 
 ### What's new

data/Gemfile.lock

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

data/README.md

@@ -43,11 +43,12 @@ Users are advised to cross-verify conversions for their specific use cases._
 
 ## Minimum Requirements
 
-* Ruby 3.2.2+ (https://www.ruby-lang.org/en/downloads/branches/)
+* Ruby 3.2.2+ ([Download Ruby](https://www.ruby-lang.org/en/downloads/branches/))
 
 ## Installation
 
-If using bundler, first add this line to your application's Gemfile:
+To use `unit_measurements` in your Rails application, add the
+following line to your Gemfile:
 
 ```ruby
 gem "unit_measurements"
@@ -269,8 +270,7 @@ UnitMeasurements::Length.units_for("metric")
 **Finding units within the unit group:**
 
 You can use `#unit_for` or `#unit_for!` (aliased as `#[]`) methods to find units
-within the unit group. `#unit_for!` method returns an error if a unit is not present
-in the unit group.
+within the unit group. `#unit_for!` method returns an error if a unit system is not defined within the unit group.
 
 ```ruby
 UnitMeasurements::Length.unit_for("m")
@@ -482,14 +482,63 @@ Length = UnitMeasurements::Length
 Volume = UnitMeasurements::Volume
 ```
 
+## Extras
+
+### Numeric methods
+
+The `.define_numeric_methods` method allows you to define numeric methods that help you to initialize measurements in a
+manner similar to how `ActiveSupport::Duration` objects are created in Rails, providing a familiar syntax and functionality.
+
+To define numeric methods for specific units within the unit group, use
+the following syntax:
+
+```ruby
+UnitMeasurements::Length.define_numeric_methods("metre", "foot", "inch")
+```
+
+This will enable the usage of these units as methods to instantiate and use measurements:
+
+```ruby
+# Initialize a measurement
+1.m                 #=> 1 m
+5.feet              #=> 5 ft
+10.inches           #=> 10 in
+
+# Usage
+## Equality comparison
+1.foot == 12.inches #=> true
+## Arithmetic operation
+1.ft + 12.in        #=> 2.0 ft
+```
+
+### Conversion methods
+
+The `.define_conversion_methods` method allows you to define conversion methods that
+help you to easily convert measurements to a different unit.
+
+To define conversion methods for specific units within the unit group, use the following syntax:
+
+```ruby
+UnitMeasurements::Length.define_conversion_methods("metre", "foot", "inch")
+```
+
+This will enable you to convert units as:
+
+```ruby
+UnitMeasurements::Length.new(1, "ft").in_inches #=> 12.0 in
+12.in.in_foot                                   #=> 1.0 ft
+```
+
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
+Contributions to this project are welcomed! To contribute:
+
+1. Fork this repository
+2. Create a new branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am "Add some feature"`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+4. Push the changes to your branch (`git push origin my-new-feature`)
+5. Create new **Pull Request**
 
 ## License
 
-Copyright 2023 [Harshal V. LADHE]((https://shivam091.github.io)), Released under the [MIT License](http://opensource.org/licenses/MIT).
+Copyright 2023 [Harshal V. LADHE](https://shivam091.github.io), Released under the [MIT License](http://opensource.org/licenses/MIT).

data/lib/unit_measurements/base.rb

@@ -151,6 +151,9 @@ module UnitMeasurements
 end
 
 # The following requires load various components of the unit measurements library.
+require "unit_measurements/extras/numeric_methods"
+require "unit_measurements/extras/conversion_methods"
+
 require "unit_measurements/configuration"
 require "unit_measurements/cache"
 require "unit_measurements/unit_group_builder"

data/lib/unit_measurements/extras/conversion_methods.rb

@@ -0,0 +1,87 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  # This module provides functionality to define conversion methods for a list
+  # of units within a unit group. If units are empty, it defaults to defining
+  # methods for all units in the unit group. These methods allow easy conversion
+  # between different units within a given unit group.
+  #
+  # This module is included in the +Measurement+ class to allow defining conversion
+  # methods for specified units.
+  #
+  # @see Measurement
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 5.15.0
+  module ConversionMethods
+    # @scope class
+    # Defines conversion methods for specified +units+ within the unit group.
+    # If +units+ are empty, it defaults to defining methods for all units within
+    # the unit group.
+    #
+    # @example Define conversion methods for metres, centimetres, and millimetres:
+    #   UnitMeasurements::Length.define_conversion_methods("metres", :cm, :mm)
+    #
+    # @example Define conversion methods for all units within the unit group:
+    #   UnitMeasurements::Length.define_conversion_methods
+    #
+    # @param [Array<String|Symbol>, optional] units
+    #   An array of units' names for which conversion methods need to be defined.
+    #   If empty, methods will be defined for all units within the unit group.
+    #
+    # @return [Array<Unit>]
+    #   An array of units for which the conversion methods were defined.
+    #
+    # @note
+    #   This method defines a conversion methods specifically for units that contain
+    #   alphabetic characters in their names.
+    #
+    # @see .define_conversion_method_for
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.15.0
+    def define_conversion_methods(*units)
+      unit_group = self
+      units = units.empty? ? unit_group.units : units
+
+      units.inject([]) do |units, unit|
+        units << define_conversion_method_for(unit, unit_group)
+      end
+    end
+
+    private
+
+    # @private
+    # @scope class
+    # Defines conversion methods for a specific +unit+ within a +unit_group+.
+    # These methods are defined dynamically using +define_method+.
+    #
+    # @param [String|Symbol|Unit] unit
+    #   The unit (or its name) for which the conversion methods need to be defined.
+    # @param [UnitGroup] unit_group The unit group to which the unit belongs.
+    #
+    # @return [Unit]
+    #   The unit instance for which the conversion methods were defined.
+    #
+    # @see .define_conversion_methods
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.15.0
+    def define_conversion_method_for(unit, unit_group)
+      unit = unit.is_a?(Unit) ? unit : unit_group.unit_for!(unit)
+
+      unit.names.each do |method_name|
+        # Check if the name contains alphabetic characters
+        next unless method_name =~ /^[a-zA-Z]+$/
+
+        define_method("in_#{method_name}") do |use_cache: false|
+          convert_to(unit, use_cache: use_cache)
+        end
+        alias_method "to_#{method_name}", "in_#{method_name}"
+        alias_method "as_#{method_name}", "in_#{method_name}"
+      end
+
+      unit
+    end
+  end
+end

data/lib/unit_measurements/extras/numeric_methods.rb

@@ -0,0 +1,85 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  # This module provides methods to define +Numeric+ methods for a list of units
+  # within a unit group. If units are empty, it defaults to defining methods for
+  # all units in the unit group.
+  #
+  # This module is included in the +Measurement+ class to allow defining numeric
+  # methods for specified units.
+  #
+  # @see Measurement
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 5.14.0
+  module NumericMethods
+    # @scope class
+    # Defines +Numeric+ methods for specified +units+ within the unit group. If
+    # +units+ are empty, it defaults to defining methods for all units within
+    # the unit group.
+    #
+    # @example Define numeric methods for metres, centimetres, and millimetres:
+    #   UnitMeasurements::Length.define_numeric_methods("metres", :cm, :mm)
+    #
+    # @example Define numeric methods for all units within the unit group:
+    #   UnitMeasurements::Length.define_numeric_methods
+    #
+    # @param [Array<String|Symbol>, optional] units
+    #   An array of units' names for which numeric methods need to be defined.
+    #   If empty, methods will be defined for all units within the unit group.
+    #
+    # @return [Array<Unit>] An array of units for which numeric methods were defined.
+    #
+    # @note
+    #   This method defines a numeric methods specifically for units that contain
+    #   alphabetic characters in their names.
+    #
+    # @see .define_numeric_method_for
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.14.0
+    def define_numeric_methods(*units)
+      unit_group = self
+      units = units.empty? ? unit_group.units : units
+
+      units.inject([]) do |units, unit|
+        units << define_numeric_method_for(unit, unit_group)
+      end
+    end
+
+    private
+
+    # @private
+    # @scope class
+    # Defines a numeric method for a specific +unit+ within a +unit_group+. The
+    # method is defined dynamically using +define_method+ and associates the unit
+    # with the numeric value.
+    #
+    # @param [String|Symbol|Unit] unit
+    #   The unit (or its name) for which the numeric method needs to be defined.
+    # @param [UnitGroup] unit_group The unit group to which the unit belongs.
+    #
+    # @return [Unit] The unit instance for which the method was defined.
+    #
+    # @see .define_numeric_methods
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.14.0
+    def define_numeric_method_for(unit, unit_group)
+      unit = unit.is_a?(Unit) ? unit : unit_group.unit_for!(unit)
+
+      unit.names.each do |method_name|
+        # Check if the name contains alphabetic characters
+        next unless method_name =~ /^[a-zA-Z]+$/
+
+        Numeric.define_method(method_name) do
+          unit_group.new(self, unit)
+        end
+      end
+
+      unit
+    end
+  end
+end

data/lib/unit_measurements/measurement.rb

@@ -23,6 +23,7 @@ module UnitMeasurements
   # @see Conversion
   # @see Formatter
   # @see Math
+  # @see NumericMethods
   # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
   # @since 1.0.0
   class Measurement
@@ -32,6 +33,9 @@ module UnitMeasurements
     include Formatter
     include Math
 
+    extend NumericMethods
+    extend ConversionMethods
+
     # Regular expression to match conversion strings.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]

data/lib/unit_measurements/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 5.13.0
+  version: 5.15.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-27 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,6 +118,8 @@ files:
 - lib/unit_measurements/errors/primitive_unit_already_set_error.rb
 - lib/unit_measurements/errors/unit_already_defined_error.rb
 - lib/unit_measurements/errors/unit_error.rb
+- lib/unit_measurements/extras/conversion_methods.rb
+- lib/unit_measurements/extras/numeric_methods.rb
 - lib/unit_measurements/formatter.rb
 - lib/unit_measurements/math.rb
 - lib/unit_measurements/measurement.rb