composite_unit_measurements 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4450805d84ddd3b1cc972d152d187f44cbb1624d87dfece055c6db82ae70d20
-  data.tar.gz: 621ccd8a46402e7592dd93c8bf0683e414714e3f3fb67f1f4837cceabe96e5ab
+  metadata.gz: cd67813e0e00bce4c907e7076ec4a62994570585875da38dfa72bc968b3c0c20
+  data.tar.gz: c9de7ccfd6e0ede94d8cd5976174a1a60ed4f4cf3566bc613349a211ea9e4309
 SHA512:
-  metadata.gz: 56937734d56198b02eb4c51c9b446558ec31a69bc123489ec371d8f36e7758efda6cf8d50ea85e947e57cf72f003e795a7897d850ff5a228f7505dc53b2aea36
-  data.tar.gz: d1e8a2129c276a186c8dd8bd7bf4cf5b29e2ff46c9dcff98b6928fba858b5d64441645c905ba273fd82bf547f43d14d1b0b25d2342d2219869d8d0a9b2a4d606
+  metadata.gz: 7291bb98bb1e404be485f5f89de9f7594a7093f89cb98c4fd27310051804bfd22ea891acdfffed137ed466b0d9e778d6034439561dffe5e1e5b8b354093044b0
+  data.tar.gz: d86f50e73b9044cd8248bf49454c8c036a99b0bd2577fe21554b2c52ff14d1951bf19a11c388b9c0ddfed1670a1d315b054cda0d191909b1ae29cdc8793bf1e9

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## 0.2.0 - 2023-11-17
+## [0.3.0](https://github.com/shivam091/composite_unit_measurements/compare/v0.2.0...v0.3.0) - 2023-11-27
+
+### What's new
+
+- Added ability to parse `kilometre-metre` and `metre-centimetre` length measurements.
+- Added ability to parse `hour-minute` time measurement.
+- Added ability to parse `kilogramme-gramme` weight measurement.
+
+-----------
+
+## [0.2.0](https://github.com/shivam091/composite_unit_measurements/compare/v0.1.0...v0.2.0) - 2023-11-17
 
 ### What's new
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    composite_unit_measurements (0.2.0)
+    composite_unit_measurements (0.3.0)
       activesupport (~> 7.0)
       unit_measurements (~> 5)
 

data/README.md

@@ -1,6 +1,6 @@
 # Composite Unit Measurements
 
-A set of specialized parsers for dealing with composite measurement strings.
+A collection of specialized parsers designed for handling composite measurement strings.
 
 [![Ruby](https://github.com/shivam091/composite_unit_measurements/actions/workflows/main.yml/badge.svg)](https://github.com/shivam091/composite_unit_measurements/actions/workflows/main.yml)
 [![Gem Version](https://badge.fury.io/rb/composite_unit_measurements.svg)](https://badge.fury.io/rb/composite_unit_measurements)
@@ -13,17 +13,18 @@ A set of specialized parsers for dealing with composite measurement strings.
 
 ## Introduction
 
-The `CompositeUnitMeasurements` gem is a versatile solution tailored for parsing
-composite measurement strings. By harnessing the capabilities of the `unit_measurements`
-gem, it empowers you to seamlessly handle composite measurements in various units.
+The `CompositeUnitMeasurements` gem offers versatile parsers for efficiently parsing
+composite measurement strings. Leveraging the power of the `unit_measurements` gem,
+it enables smooth handling of composite measurements in various units.
 
 ## 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 `composite_unit_measurements-rails` in your Rails application, add the
+following line to your Gemfile:
 
 ```ruby
 gem "composite_unit_measurements"
@@ -44,20 +45,45 @@ You can use an appropriate parser to parse measurements. The final result of `#p
 is returned in the leftmost unit of your measurement.
 
 This gem internally uses [`unit_measurements`](https://github.com/shivam091/unit_measurements)
-to perform conversions and arithmetic operations. You can use any
-[alias of the units](https://github.com/shivam091/unit_measurements/blob/main/units.md)
-to build a supported composite measurements.
+to perform conversions and arithmetic operations. You can build supported composite measurements
+using any [unit alias](https://github.com/shivam091/unit_measurements/blob/main/units.md).
+
+### Examples
+
+**Parsing length measurements:**
 
 ```ruby
-CompositeUnitMeasurements::Length.parse("5 feet 6 inches")
+CompositeUnitMeasurements::Length.parse("5 ft 6 in")
 #=> 5.5 ft
-CompositeUnitMeasurements::Weight.parse("8 pound 12 ounce")
+CompositeUnitMeasurements::Length.parse("6 m 50 cm")
+#=> 6.5 m
+CompositeUnitMeasurements::Length.parse("5 km 500 m")
+#=> 5.5 km
+```
+
+**Parsing weight measurements:**
+
+```ruby
+CompositeUnitMeasurements::Weight.parse("8 lb 12 oz")
 #=> 8.75 lb
-CompositeUnitMeasurements::Time.parse("12:60:60,60")
-#=> 13.0166666833333333666667 h
+CompositeUnitMeasurements::Weight.parse("2 st 6 lb")
+#=> 2.428571428571429 st
+CompositeUnitMeasurements::Weight.parse("2 st 6 lb")
+# 4.5 kg
+```
+
+**Parsing time measurements:**
+
+```ruby
+CompositeUnitMeasurements::Time.parse("3 h 45 min")
+#=> 3.75 hx
+CompositeUnitMeasurements::Time.parse("12:60:3600,360000000")
+#=> 14.1 h
 ```
 
-Each parser has capability to parse `real`, `rational`, `scientific`, and `complex` numbers.
+### Support for numeric types
+
+Each parser can handle various numeric types, including scientific notation, rational numbers, and complex numbers.
 
 ```ruby
 CompositeUnitMeasurements::Length.parse("1+2i ft 12 in")
@@ -74,28 +100,27 @@ CompositeUnitMeasurements::Length.parse("1e-2 ft 1+2i in")
 
 ## Packaged parsers & supported composite measurements
 
-There are tons of composite measurements that are bundled with `composite_unit_measurements`.
+The `composite_unit_measurements` gem supports parsing various composite measurements, including:
 
-**1. Unitify::CompositeMeasurements::Length**
+**1. CompositeUnitMeasurements::Length**
 - foot-inch (5 ft 6 in)
+- metre-centimetre (6 m 50 cm)
+- kilometre-metre (5 km 500 m)
 
-**2. Unitify::CompositeMeasurements::Weight**
+**2. CompositeUnitMeasurements::Weight**
 - pound-ounce (8 lb 12 oz)
 - stone-pound (2 st 6 lb)
+- kilogramme-gramme (4 kg 500 g)
 
-**3. Unitify::CompositeMeasurements::Time**
-- hour-minute-second-microsecond (12:60:60,60)
+**3. CompositeUnitMeasurements::Time**
+- hour-minute (3 h 45 min)
+- hour-minute-second-microsecond (12:60,3600:360000000)
 
 ### Specifing parsers
 
-By default, `composite_unit_measurements` ships with all the packaged parsers and
-this happens automatically when you require the gem in the following manner.
-
-```ruby
-require "composite_unit_measurements"
-```
-
-You can also use parsers in your application as per your need as:
+By default, `composite_unit_measurements` includes all packaged parsers automatically
+when required in your application. However, you can opt to use specific parsers as
+needed:
 
 ```ruby
 require "composite_unit_measurements/base"
@@ -106,11 +131,13 @@ require "composite_unit_measurements/weight"
 
 ## 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
 

data/lib/composite_unit_measurements/length.rb

@@ -17,6 +17,7 @@ module CompositeUnitMeasurements
       # @param [String] string The string to parse for length measurement.
       # @return [UnitMeasurements::Length]
       #   Returns a UnitMeasurements::Length object if parsing is successful.
+      #
       # @raise [UnitMeasurements::ParseError]
       #   If the string does not match any known format.
       #
@@ -24,8 +25,10 @@ module CompositeUnitMeasurements
       # @since 0.2.0
       def parse(string)
         case string
-        when FOOT_INCH then parse_foot_inch(string)
-        else                raise UnitMeasurements::ParseError, string
+        when FOOT_INCH        then parse_foot_inch(string)
+        when KILOMETRE_METRE  then parse_kilometre_metre(string)
+        when METRE_CENTIMETRE then parse_metre_centimetre(string)
+        else                       raise UnitMeasurements::ParseError, string
         end
       end
 
@@ -46,7 +49,45 @@ module CompositeUnitMeasurements
         foot, inch = string.match(FOOT_INCH)&.captures
 
         if foot && inch
-          UnitMeasurements::Length.new(foot, :ft) + UnitMeasurements::Length.new(inch, :in)
+          UnitMeasurements::Length.new(foot, "ft") + UnitMeasurements::Length.new(inch, "in")
+        end
+      end
+
+      # @private
+      # Parses a +string+ representing a length in the format of +metre-centimetre+.
+      #
+      # @param [String] string
+      #   The string representing length measurement in the format of *metre-centimetre*.
+      # @return [UnitMeasurements::Length]
+      #   Returns a UnitMeasurements::Length object if parsing is successful.
+      #
+      # @see METRE_CENTIMETRE
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.3.0
+      def parse_metre_centimetre(string)
+        metre, centimetre = string.match(METRE_CENTIMETRE)&.captures
+
+        if metre && centimetre
+          UnitMeasurements::Length.new(metre, "m") + UnitMeasurements::Length.new(centimetre, "cm")
+        end
+      end
+
+      # @private
+      # Parses a +string+ representing a length in the format of +kilometre-metre+.
+      #
+      # @param [String] string
+      #   The string representing length measurement in the format of *kilometre-metre*.
+      # @return [UnitMeasurements::Length]
+      #   Returns a UnitMeasurements::Length object if parsing is successful.
+      #
+      # @see KILOMETRE_METRE
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.3.0
+      def parse_kilometre_metre(string)
+        kilometre, metre = string.match(KILOMETRE_METRE)&.captures
+
+        if kilometre && metre
+          UnitMeasurements::Length.new(kilometre, "km") + UnitMeasurements::Length.new(metre, "m")
         end
       end
     end
@@ -65,10 +106,40 @@ module CompositeUnitMeasurements
     # @since 0.2.0
     INCH_ALIASES = /(?:"|in|inch(?:es)?)/.freeze
 
+    # Regex pattern for aliases of +metre+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    METRE_ALIASES = /(?:m|meter(?:s)?|metre(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +centimetre+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    CENTIMETRE_ALIASES = /(?:cm|centimeter(?:s)?|centimetre(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +kilometre+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    KILOMETRE_ALIASES = /(?:km|kilometer(?:s)?|kilometre(?:s)?)/.freeze
+
     # Regex pattern for parsing a length measurement in the format of +foot-inch+.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 0.2.0
     FOOT_INCH = /\A#{ANY_NUMBER}\s*#{FOOT_ALIASES}\s*#{ANY_NUMBER}\s*#{INCH_ALIASES}\z/.freeze
+
+    # Regex pattern for parsing a length measurement in the format of +metre-centimetre+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    METRE_CENTIMETRE = /\A#{ANY_NUMBER}\s*#{METRE_ALIASES}\s*#{ANY_NUMBER}\s*#{CENTIMETRE_ALIASES}\z/.freeze
+
+    # Regex pattern for parsing a length measurement in the format of +kilometre-metre+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    KILOMETRE_METRE = /\A#{ANY_NUMBER}\s*#{KILOMETRE_ALIASES}\s*#{ANY_NUMBER}\s*#{METRE_ALIASES}\z/.freeze
   end
 end

data/lib/composite_unit_measurements/time.rb

@@ -24,13 +24,33 @@ module CompositeUnitMeasurements
       # @since 0.2.0
       def parse(string)
         case string
-        when DURATION             then parse_duration(string)
-        else                           raise UnitMeasurements::ParseError, string
+        when HOUR_MINUTE then parse_hour_minute(string)
+        when DURATION    then parse_duration(string)
+        else                  raise UnitMeasurements::ParseError, string
         end
       end
 
       private
 
+      # @private
+      # Parses a +string+ representing a time in the format of +hour-minute+.
+      #
+      # @param [String] string
+      #   The string representing time measurement in the format of *hour-minute*.
+      # @return [UnitMeasurements::Time]
+      #   Returns a UnitMeasurements::Time object if parsing is successful.
+      #
+      # @see HOUR_MINUTE
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.3.0
+      def parse_hour_minute(string)
+        hour, minute = string.match(HOUR_MINUTE)&.captures
+
+        if hour && minute
+          UnitMeasurements::Time.new(hour, "h") + UnitMeasurements::Time.new(minute, "min")
+        end
+      end
+
       # @private
       # Parses a +string+ representing time duration in the format of
       # +hour:minute:second,microsecond+ or +hour:minute:second+.
@@ -57,6 +77,24 @@ module CompositeUnitMeasurements
 
     private
 
+    # Regex pattern for aliases of +hour+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    HOUR_ALIASES = /(?:h|hr|hour(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +minute+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    MINUTE_ALIASES = /(?:min|minute(?:s)?)/.freeze
+
+    # Regex pattern for parsing a time measurement in the format of +hour-minute+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    HOUR_MINUTE = /\A#{ANY_NUMBER}\s*#{HOUR_ALIASES}\s*#{ANY_NUMBER}\s*#{MINUTE_ALIASES}\z/.freeze
+
     # Regex pattern for parsing duration in the format of +hour:minute:second+ or
     # +hour:minute:second,microsecond+.
     #

data/lib/composite_unit_measurements/version.rb

@@ -2,7 +2,28 @@
 # -*- frozen_string_literal: true -*-
 # -*- warn_indent: true -*-
 
+# This module provides parsers and utilities for handling composite unit measurements.
+# It allows parsing and manipulation of various composite measurements for units of
+# +length+, +weight+, +time+ etc.
+#
+# @note
+#   This module serves as a namespace for classes and utilities related to composite
+#   unit measurements. To parse such measurements, refer to individual classes like
+#   {Length}, {Weight}, {Time}, etc. within this module.
+#
+# @example
+#   CompositeUnitMeasurements::Length.parse("5 feet 12 inches")
+#   => 6.0 ft
+#
+#   CompositeUnitMeasurements::Weight.parse("8 lb 12 oz")
+#   => 8.75 lb
+#
+#   CompositeUnitMeasurements::Time.parse("3 h 45 min")
+#   => 3.75 h
+#
+# @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+# @since 0.1.0
 module CompositeUnitMeasurements
   # Current stable version
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/composite_unit_measurements/weight.rb

@@ -24,9 +24,10 @@ module CompositeUnitMeasurements
       # @since 0.2.0
       def parse(string)
         case string
-        when POUND_OUNCE then parse_pound_ounce(string)
-        when STONE_POUND then parse_stone_pound(string)
-        else                  raise UnitMeasurements::ParseError, string
+        when POUND_OUNCE       then parse_pound_ounce(string)
+        when STONE_POUND       then parse_stone_pound(string)
+        when KILOGRAMME_GRAMME then parse_kilogramme_gramme(string)
+        else                        raise UnitMeasurements::ParseError, string
         end
       end
 
@@ -47,7 +48,7 @@ module CompositeUnitMeasurements
         pound, ounce = string.match(POUND_OUNCE)&.captures
 
         if pound && ounce
-          UnitMeasurements::Weight.new(pound, :lb) + UnitMeasurements::Weight.new(ounce, :oz)
+          UnitMeasurements::Weight.new(pound, "lb") + UnitMeasurements::Weight.new(ounce, "oz")
         end
       end
 
@@ -66,7 +67,26 @@ module CompositeUnitMeasurements
         stone, pound = string.match(STONE_POUND)&.captures
 
         if stone && pound
-          UnitMeasurements::Weight.new(stone, :st) + UnitMeasurements::Weight.new(pound, :lb)
+          UnitMeasurements::Weight.new(stone, "st") + UnitMeasurements::Weight.new(pound, "lb")
+        end
+      end
+
+      # @private
+      # Parses a +string+ representing a weight in the format of +kilogramme-gramme+.
+      #
+      # @param [String] string
+      #   The string representing weight measurement in the format of *kilogramme-gramme*.
+      # @return [UnitMeasurements::Weight]
+      #   Returns a UnitMeasurements::Weight object if parsing is successful.
+      #
+      # @see KILOGRAMME_GRAMME
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.3.0
+      def parse_kilogramme_gramme(string)
+        kilogramme, gramme = string.match(KILOGRAMME_GRAMME)&.captures
+
+        if kilogramme && gramme
+          UnitMeasurements::Weight.new(kilogramme, "kg") + UnitMeasurements::Weight.new(gramme, "g")
         end
       end
     end
@@ -77,30 +97,48 @@ module CompositeUnitMeasurements
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 0.2.0
-    POUND_UNITS = /(?:#|lb|lbs|lbm|pound-mass|pound(?:s)?)/.freeze
+    POUND_ALIASES = /(?:#|lb|lbs|lbm|pound-mass|pound(?:s)?)/.freeze
 
     # Regex pattern for aliases of +ounce+ unit.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 0.2.0
-    OUNCE_UNITS = /(?:oz|ounce(?:s)?)/.freeze
+    OUNCE_ALIASES = /(?:oz|ounce(?:s)?)/.freeze
 
     # Regex pattern for aliases of +stone+ unit.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 0.2.0
-    STONE_UNITS = /(?:st|stone(?:s)?)/.freeze
+    STONE_ALIASES = /(?:st|stone(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +gramme+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    GRAMME_ALIASES = /(?:g|gram(?:s)?|gramme(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +kilogramme+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    KILOGRAMME_ALIASES = /(?:kg|kilogram(?:s)?|kilogramme(?:s)?)/.freeze
 
     # Regex pattern for parsing a weight measurement in the format of +pound-ounce+.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 0.2.0
-    POUND_OUNCE = /\A#{ANY_NUMBER}\s*#{POUND_UNITS}\s*#{ANY_NUMBER}\s*#{OUNCE_UNITS}\z/.freeze
+    POUND_OUNCE = /\A#{ANY_NUMBER}\s*#{POUND_ALIASES}\s*#{ANY_NUMBER}\s*#{OUNCE_ALIASES}\z/.freeze
 
     # Regex pattern for parsing a weight measurement in the format of +stone-pound+.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 0.2.0
-    STONE_POUND = /\A#{ANY_NUMBER}\s*#{STONE_UNITS}\s*#{ANY_NUMBER}\s*#{POUND_UNITS}\z/.freeze
+    STONE_POUND = /\A#{ANY_NUMBER}\s*#{STONE_ALIASES}\s*#{ANY_NUMBER}\s*#{POUND_ALIASES}\z/.freeze
+
+    # Regex pattern for parsing a weight measurement in the format of +kilogramme-gramme+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.3.0
+    KILOGRAMME_GRAMME = /\A#{ANY_NUMBER}\s*#{KILOGRAMME_ALIASES}\s*#{ANY_NUMBER}\s*#{GRAMME_ALIASES}\z/.freeze
   end
 end

metadata

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