composite_unit_measurements 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4450805d84ddd3b1cc972d152d187f44cbb1624d87dfece055c6db82ae70d20
-  data.tar.gz: 621ccd8a46402e7592dd93c8bf0683e414714e3f3fb67f1f4837cceabe96e5ab
+  metadata.gz: c25131e598e9fb02e3b569eeb45df0f39b254d5d85ab7e60ee729365b70c59cc
+  data.tar.gz: c659dea44b220217466355182589a808a098d1d654efbc664f55e6556198422f
 SHA512:
-  metadata.gz: 56937734d56198b02eb4c51c9b446558ec31a69bc123489ec371d8f36e7758efda6cf8d50ea85e947e57cf72f003e795a7897d850ff5a228f7505dc53b2aea36
-  data.tar.gz: d1e8a2129c276a186c8dd8bd7bf4cf5b29e2ff46c9dcff98b6928fba858b5d64441645c905ba273fd82bf547f43d14d1b0b25d2342d2219869d8d0a9b2a4d606
+  metadata.gz: ca73e1e52c1c40b08f95ce7196bdb5c290dbe4d955c8c9c80affc6210b5657cb05a013e5352467412a8139cb1ef927914b96cd59843565fb30462ba4ce77419f
+  data.tar.gz: 7528d84b11c1eeb86eea5b5683e581513695b816662669711fa8a567a9fba1c7b4f505d19dd250c6b1175c5e9bdea896f5f483e0096c35b38a591aa7477124fa

data/CHANGELOG.md

@@ -1,4 +1,23 @@
-## 0.2.0 - 2023-11-17
+## [0.4.0](https://github.com/shivam091/composite_unit_measurements/compare/v0.2.0...v0.3.0) - 2023-11-30
+
+### What's new
+
+- Added ability to parse `litre-millilitre` volume measurements.
+- Updated readme with parsing examples.
+
+-----------
+
+## [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.4.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 `composite_unit_measurements` 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` in your Rails application, add the
+following line to your Gemfile:
 
 ```ruby
 gem "composite_unit_measurements"
@@ -39,63 +40,81 @@ Or otherwise simply install it yourself as:
 
 ## Usage
 
-Each packaged parser includes the `#parse` method to parse composite measurements.
-You can use an appropriate parser to parse measurements. The final result of `#parse`
+Each packaged parser includes the `.parse` method to parse composite measurements.
+You can use an appropriate parser to these measurements and the final result of
 is returned in the leftmost unit of your measurement.
 
+The result of each parser method returns an instance of measurement on which we can
+perform any functionality offered by `unit_measurements`.
+
 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 km 500 m") #=> 5.5 km
+```
+
+**Parsing weight measurements:**
+
+```ruby
+CompositeUnitMeasurements::Weight.parse("4 kg 500 g") # 4.5 kg
+```
+
+**Parsing time measurements:**
 
 ```ruby
-CompositeUnitMeasurements::Length.parse("5 feet 6 inches")
-#=> 5.5 ft
-CompositeUnitMeasurements::Weight.parse("8 pound 12 ounce")
-#=> 8.75 lb
-CompositeUnitMeasurements::Time.parse("12:60:60,60")
-#=> 13.0166666833333333666667 h
+CompositeUnitMeasurements::Time.parse("3 h 45 min") #=> 3.75 hr
 ```
 
-Each parser has capability to parse `real`, `rational`, `scientific`, and `complex` numbers.
+**Parsing volume measurements:**
 
 ```ruby
-CompositeUnitMeasurements::Length.parse("1+2i ft 12 in")
-#=> 2.0+2.0i ft
-CompositeUnitMeasurements::Length.parse("1.5 ft 12e2 in")
-#=> 101.5 ft
-CompositeUnitMeasurements::Length.parse("1 1/2 ft 1+2i in")
-#=> 1.5833333333333333+0.16666666666666669i ft
-CompositeUnitMeasurements::Length.parse("2 ft 1+2i in")
-#=> 2.0833333333333335+0.16666666666666669i ft
-CompositeUnitMeasurements::Length.parse("1e-2 ft 1+2i in")
-#=> 0.09333333333333334+0.16666666666666669i ft
+CompositeUnitMeasurements::Volume.parse("2 l 250 ml") #=> 2.25 l
+```
+
+### 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")    #=> 2.0+2.0i ft
+CompositeUnitMeasurements::Length.parse("1.5 ft 12e2 in")   #=> 101.5 ft
+CompositeUnitMeasurements::Length.parse("1 1/2 ft 1+2i in") #=> 1.5833333333333333+0.16666666666666669i ft
+CompositeUnitMeasurements::Length.parse("2 ft 1+2i in")     #=> 2.0833333333333335+0.16666666666666669i ft
+CompositeUnitMeasurements::Length.parse("1e-2 ft 1+2i in")  #=> 0.09333333333333334+0.16666666666666669i ft
 ```
 
 ## 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**
+- metre-centimetre (6 m 50 cm)
+- kilometre-metre (5 km 500 m)
 - foot-inch (5 ft 6 in)
 
-**2. Unitify::CompositeMeasurements::Weight**
+**2. CompositeUnitMeasurements::Weight**
+- kilogramme-gramme (4 kg 500 g)
 - pound-ounce (8 lb 12 oz)
 - stone-pound (2 st 6 lb)
 
-**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
+**4. CompositeUnitMeasurements::Volume**
+- litre-millilitre (2 l 250 ml)
 
-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"
-```
+### Specifing parsers
 
-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,12 +125,14 @@ 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
 
-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/composite_unit_measurements/base.rb

@@ -54,4 +54,7 @@ module CompositeUnitMeasurements
 
   # Matches any number, including scientific, complex, rational, and real numbers.
   ANY_NUMBER = /(?<number>#{SCIENTIFIC_NUMBER}|#{COMPLEX_NUMBER}|#{RATIONAL_NUMBER}|#{REAL_NUMBER})/.freeze
+
+  private_constant :REAL_NUMBER, :RATIONAL_NUMBER, :SCIENTIFIC_NUMBER, :COMPLEX_NUMBER,
+                   :ANY_NUMBER
 end

data/lib/composite_unit_measurements/length.rb

@@ -14,9 +14,17 @@ module CompositeUnitMeasurements
     class << self
       # Parses a given +string+ into a +UnitMeasurements::Length+ object.
       #
+      # @example Parse 'metre-centimetre' measurement:
+      #   CompositeUnitMeasurements::Length.parse("6 m 50 cm") #=> 6.5 m
+      # @example Parse 'kilometre-metre' measurement:
+      #   CompositeUnitMeasurements::Length.parse("5 km 500 m") #=> 5.5 km
+      # @example Parse 'foot-inch' measurement:
+      #   CompositeUnitMeasurements::Length.parse("5 ft 6 in") #=> 5.5 ft
+      #
       # @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,15 +32,18 @@ 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
 
       private
 
       # @private
-      # Parses a +string+ representing a length in the format of +foot-inch+.
+      # Parses a +string+ representing a length in the format of +foot-inch+
+      # into a +UnitMeasurements::Length+ object.
       #
       # @param [String] string
       #   The string representing length measurement in the format of *foot-inch*.
@@ -46,12 +57,50 @@ 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
-    end
 
-    private
+      # @private
+      # Parses a +string+ representing a length in the format of +metre-centimetre+
+      # into a +UnitMeasurements::Length+ object.
+      #
+      # @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+
+      # into a +UnitMeasurements::Length+ object.
+      #
+      # @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
 
     # Regex pattern for aliases of +foot+ unit.
     #
@@ -65,10 +114,43 @@ 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
+
+    private_constant :FOOT_ALIASES, :INCH_ALIASES, :METRE_ALIASES, :CENTIMETRE_ALIASES,
+                     :KILOMETRE_ALIASES, :FOOT_INCH, :KILOMETRE_METRE, :METRE_CENTIMETRE
   end
 end

data/lib/composite_unit_measurements/time.rb

@@ -14,6 +14,12 @@ module CompositeUnitMeasurements
     class << self
       # Parses a given +string+ into a +UnitMeasurements::Time+ object.
       #
+      # @example Parse 'hour-minute' measurement:
+      #   CompositeUnitMeasurements::Time.parse("3 h 45 min") #=> 3.75 h
+      # @example Parse 'duration':
+      #   CompositeUnitMeasurements::Time.parse("12:60:3600,360000000") #=> 14.1 h
+      #   CompositeUnitMeasurements::Time.parse("12:60:3600") #=> 14.0 h
+      #
       # @param [String] string The string to parse for time measurement.
       # @return [UnitMeasurements::Time]
       #   Returns a UnitMeasurements::Time object if parsing is successful.
@@ -24,16 +30,38 @@ 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+
+      # into a +UnitMeasurements::Time+ object.
+      #
+      # @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+.
+      # +hour:minute:second,microsecond+ or +hour:minute:second+ into a
+      # +UnitMeasurements::Time+ object.
       #
       # @param [String] string The string representing time duration.
       # @return [UnitMeasurements::Time]
@@ -55,7 +83,23 @@ module CompositeUnitMeasurements
       end
     end
 
-    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+.
@@ -63,5 +107,7 @@ module CompositeUnitMeasurements
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 0.2.0
     DURATION = /\A(?<hour>#{REAL_NUMBER}):(?<min>#{REAL_NUMBER}):(?:(?<sec>#{REAL_NUMBER}))?(?:,(?<msec>#{REAL_NUMBER}))?\z/.freeze
+
+    private_constant :HOUR_ALIASES, :MINUTE_ALIASES, :HOUR_MINUTE, :DURATION
   end
 end

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.4.0"
 end

data/lib/composite_unit_measurements/volume.rb

@@ -0,0 +1,79 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+require "unit_measurements/unit_groups/volume"
+
+module CompositeUnitMeasurements
+  # A parser handling +volume+ measurements, particularly for composite units
+  # like +litre-millilitre+, +gallon-quart+, +quart-pint+, etc.
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 0.4.0
+  class Volume
+    class << self
+      # Parses a given +string+ into a +UnitMeasurements::Volume+ object.
+      #
+      # @example Parse 'litre-millilitre' measurement:
+      #   CompositeUnitMeasurements::Volume.parse("2 l 250 ml") #=> 2.25 l
+      #
+      # @param [String] string The string to parse for volume measurement.
+      # @return [UnitMeasurements::Volume]
+      #   Returns a UnitMeasurements::Volume object if parsing is successful.
+      #
+      # @raise [UnitMeasurements::ParseError]
+      #   If the string does not match any known format.
+      #
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.4.0
+      def parse(string)
+        case string
+        when LITRE_MILLILITRE then parse_litre_millilitre(string)
+        else                       raise UnitMeasurements::ParseError, string
+        end
+      end
+
+      private
+
+      # @private
+      # Parses a +string+ representing a volume in the format of +litre-millilitre+
+      # into a +UnitMeasurements::Volume+ object.
+      #
+      # @param [String] string
+      #   The string representing volume measurement in the format of *litre-millilitre*.
+      # @return [UnitMeasurements::Volume]
+      #   Returns a UnitMeasurements::Volume object if parsing is successful.
+      #
+      # @see LITRE_MILLILITRE
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.4.0
+      def parse_litre_millilitre(string)
+        litre, millilitre = string.match(LITRE_MILLILITRE)&.captures
+
+        if litre && millilitre
+          UnitMeasurements::Volume.new(litre, "l") + UnitMeasurements::Volume.new(millilitre, "ml")
+        end
+      end
+    end
+
+    # Regex pattern for aliases of +litre+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.4.0
+    LITRE_ALIASES = /(?:l|L|liter(?:s)?|litre(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +millilitre+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.4.0
+    MILLILITRE_ALIASES = /(?:ml|mL|milliliter(?:s)?|millilitre(?:s)?)/.freeze
+
+    # Regex pattern for parsing a volume measurement in the format of +litre-millilitre+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.4.0
+    LITRE_MILLILITRE = /\A#{ANY_NUMBER}\s*#{LITRE_ALIASES}\s*#{ANY_NUMBER}\s*#{MILLILITRE_ALIASES}\z/.freeze
+
+    private_constant :LITRE_MILLILITRE, :LITRE_ALIASES, :MILLILITRE_ALIASES
+  end
+end

data/lib/composite_unit_measurements/weight.rb

@@ -6,7 +6,7 @@ require "unit_measurements/unit_groups/weight"
 
 module CompositeUnitMeasurements
   # A parser handling +weight+ measurements, particularly for composite units
-  # like +pound-ounce+, +stone-pound+, +kilogramme-gramme+, etc.
+  # like +kilogramme-gramme+, +pound-ounce+, +stone-pound+ etc.
   #
   # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
   # @since 0.2.0
@@ -14,6 +14,13 @@ module CompositeUnitMeasurements
     class << self
       # Parses a given +string+ into a +UnitMeasurements::Weight+ object.
       #
+      # @example Parse 'kilogramme-gramme' measurement:
+      #   CompositeUnitMeasurements::Weight.parse("4 kg 500 g") #=> 4.5 kg
+      # @example Parse 'pound-ounce' measurement:
+      #   CompositeUnitMeasurements::Weight.parse("8 lb 12 oz") #=> 8.75 lb
+      # @example Parse 'stone-pound' measurement:
+      #   CompositeUnitMeasurements::Weight.parse("2 st 6 lb") #=> 2.428571428571429 st
+      #
       # @param [String] string The string to parse for weight measurement.
       # @return [UnitMeasurements::Weight]
       #   Returns a UnitMeasurements::Weight object if parsing is successful.
@@ -24,16 +31,18 @@ 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
 
       private
 
       # @private
-      # Parses a +string+ representing a weight in the format of +pound-ounce+.
+      # Parses a +string+ representing a weight in the format of +pound-ounce+
+      # into a +UnitMeasurements::Weight+ object.
       #
       # @param [String] string
       #   The string representing weight measurement in the format of *pound-ounce*.
@@ -47,12 +56,13 @@ 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
 
       # @private
-      # Parses a +string+ representing a weight in the format of +stone-pound+.
+      # Parses a +string+ representing a weight in the format of +stone-pound+
+      # into a +UnitMeasurements::Weight+ object.
       #
       # @param [String] string
       #   The string representing weight measurement in the format of *stone-pound*.
@@ -66,41 +76,80 @@ 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
-    end
 
-    private
+      # @private
+      # Parses a +string+ representing a weight in the format of +kilogramme-gramme+
+      # into a +UnitMeasurements::Weight+ object.
+      #
+      # @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
 
     # Regex pattern for aliases of +pound+ unit.
     #
     # @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
+
+    private_constant :KILOGRAMME_GRAMME, :POUND_ALIASES, :OUNCE_ALIASES, :STONE_ALIASES ,
+                     :GRAMME_ALIASES, :KILOGRAMME_ALIASES, :POUND_OUNCE, :STONE_POUND
   end
 end

data/lib/composite_unit_measurements.rb

@@ -7,3 +7,4 @@ require "composite_unit_measurements/base"
 require "composite_unit_measurements/length"
 require "composite_unit_measurements/time"
 require "composite_unit_measurements/weight"
+require "composite_unit_measurements/volume"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composite_unit_measurements
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-17 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -124,6 +124,7 @@ files:
 - lib/composite_unit_measurements/length.rb
 - lib/composite_unit_measurements/time.rb
 - lib/composite_unit_measurements/version.rb
+- lib/composite_unit_measurements/volume.rb
 - lib/composite_unit_measurements/weight.rb
 homepage: https://github.com/shivam091/composite_unit_measurements
 licenses: