composite_unit_measurements 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c25131e598e9fb02e3b569eeb45df0f39b254d5d85ab7e60ee729365b70c59cc
-  data.tar.gz: c659dea44b220217466355182589a808a098d1d654efbc664f55e6556198422f
+  metadata.gz: 66b4aa8b083b2ce04d0b18a00eda81ca826aa514e66adcf15c6d909fca23bf7b
+  data.tar.gz: d8482df4c187ecc55f03b0e192f732f4708b8a3c102576f6575a48410098f72b
 SHA512:
-  metadata.gz: ca73e1e52c1c40b08f95ce7196bdb5c290dbe4d955c8c9c80affc6210b5657cb05a013e5352467412a8139cb1ef927914b96cd59843565fb30462ba4ce77419f
-  data.tar.gz: 7528d84b11c1eeb86eea5b5683e581513695b816662669711fa8a567a9fba1c7b4f505d19dd250c6b1175c5e9bdea896f5f483e0096c35b38a591aa7477124fa
+  metadata.gz: 40bdb5fe245ad06dc61527cf0a2f70d76a122d118bdb50b3ec2ad2276d38fe881fc4c2a5b803904bc8c6c1df4447e2bd0de399280b2c35425c1c18439faef134
+  data.tar.gz: d33a783ce26f8d28d6a9668915c6664a1526924449b792d619df0c270bc1a4472be69b337d6696d80249ec61d6485988f3fb13b516b043545594902cd2ba67ea

data/CHANGELOG.md

@@ -1,8 +1,17 @@
-## [0.4.0](https://github.com/shivam091/composite_unit_measurements/compare/v0.2.0...v0.3.0) - 2023-11-30
+## [0.5.0](https://github.com/shivam091/composite_unit_measurements/compare/v0.4.0...v0.5.0) - 2023-12-10
 
 ### What's new
 
-- Added ability to parse `litre-millilitre` volume measurements.
+- Added ability to parse `mile-yard` length measurement.
+- Added ability to parse `minute-second`, `week-day`, and `month-day` time measurements.
+
+-----------
+
+## [0.4.0](https://github.com/shivam091/composite_unit_measurements/compare/v0.3.0...v0.4.0) - 2023-12-08
+
+### What's new
+
+- Added ability to parse `litre-millilitre` volume measurement.
 - Updated readme with parsing examples.
 
 -----------

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,6 @@
 # Composite Unit Measurements
 
-A collection of specialized parsers designed for handling composite measurement strings.
+A collection of specialized parsers designed for handling composite measurements.
 
 [![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)
@@ -9,12 +9,13 @@ A collection of specialized parsers designed for handling composite measurement
 [![Test Coverage](https://api.codeclimate.com/v1/badges/94e13b43cdd19e6c462c/test_coverage)](https://codeclimate.com/github/shivam091/composite_unit_measurements/test_coverage)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/shivam091/composite_unit_measurements/blob/main/LICENSE)
 
-**Harshal V. Ladhe, M.Sc. Computer Science.**
+**[Harshal V. Ladhe, Master of Computer Science.](https://shivam091.github.io)**
 
 ## Introduction
 
-The `composite_unit_measurements` gem offers versatile parsers for efficiently parsing
-composite measurement strings. Leveraging the power of the `unit_measurements` gem,
+The `composite_unit_measurements` gem offers versatile parsers for efficiently
+parsing composite measurements. Leveraging the power of the [`unit_measurements`]
+(https://github.com/shivam091/unit_measurements) gem,
 it enables smooth handling of composite measurements in various units.
 
 ## Minimum Requirements
@@ -41,15 +42,15 @@ 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 these measurements and the final result of
-is returned in the leftmost unit of your measurement.
+You can use an appropriate parser to parse measurements and the final result of
+parser 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`.
+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 build supported composite measurements
-using any [unit alias](https://github.com/shivam091/unit_measurements/blob/main/units.md).
+This gem internally uses `unit_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
 
@@ -79,7 +80,8 @@ 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.
+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
@@ -91,12 +93,14 @@ CompositeUnitMeasurements::Length.parse("1e-2 ft 1+2i in")  #=> 0.09333333333333
 
 ## Packaged parsers & supported composite measurements
 
-The `composite_unit_measurements` gem supports parsing various composite measurements, including:
+The `composite_unit_measurements` gem supports parsing various composite measurements,
+including:
 
 **1. CompositeUnitMeasurements::Length**
 - metre-centimetre (6 m 50 cm)
 - kilometre-metre (5 km 500 m)
 - foot-inch (5 ft 6 in)
+- mile-yard (20 mi 220 yd)
 
 **2. CompositeUnitMeasurements::Weight**
 - kilogramme-gramme (4 kg 500 g)
@@ -106,6 +110,9 @@ The `composite_unit_measurements` gem supports parsing various composite measure
 **3. CompositeUnitMeasurements::Time**
 - hour-minute (3 h 45 min)
 - hour-minute-second-microsecond (12:60,3600:360000000)
+- minute-second (10 min 90 s)
+- week-day (8 wk 3 d)
+- month-day (2 mo 60 d)
 
 **4. CompositeUnitMeasurements::Volume**
 - litre-millilitre (2 l 250 ml)

data/lib/composite_unit_measurements/length.rb

@@ -20,6 +20,8 @@ module CompositeUnitMeasurements
       #   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
+      # @example Parse 'mile-yard' measurement:
+      #   CompositeUnitMeasurements::Length.parse("20 mi 220 yd") #=> 20.125 mi
       #
       # @param [String] string The string to parse for length measurement.
       # @return [UnitMeasurements::Length]
@@ -35,6 +37,7 @@ module CompositeUnitMeasurements
         when FOOT_INCH        then parse_foot_inch(string)
         when KILOMETRE_METRE  then parse_kilometre_metre(string)
         when METRE_CENTIMETRE then parse_metre_centimetre(string)
+        when MILE_YARD        then parse_mile_yard(string)
         else                       raise UnitMeasurements::ParseError, string
         end
       end
@@ -100,6 +103,26 @@ module CompositeUnitMeasurements
           UnitMeasurements::Length.new(kilometre, "km") + UnitMeasurements::Length.new(metre, "m")
         end
       end
+
+      # @private
+      # Parses a +string+ representing a length in the format of +mile-yard+
+      # into a +UnitMeasurements::Length+ object.
+      #
+      # @param [String] string
+      #   The string representing length measurement in the format of *mile-yard*.
+      # @return [UnitMeasurements::Length]
+      #   Returns a UnitMeasurements::Length object if parsing is successful.
+      #
+      # @see MILE_YARD
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.5.0
+      def parse_mile_yard(string)
+        mile, yard = string.match(MILE_YARD)&.captures
+
+        if mile && yard
+          UnitMeasurements::Length.new(mile, "mi") + UnitMeasurements::Length.new(yard, "yd")
+        end
+      end
     end
 
     # Regex pattern for aliases of +foot+ unit.
@@ -132,6 +155,18 @@ module CompositeUnitMeasurements
     # @since 0.3.0
     KILOMETRE_ALIASES = /(?:km|kilometer(?:s)?|kilometre(?:s)?)/.freeze
 
+    # Regex pattern for aliases of +mile+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    MILE_ALIASES = /(?:mi|mile(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +yard+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    YARD_ALIASES = /(?:yd|yard(?:s)?)/.freeze
+
     # Regex pattern for parsing a length measurement in the format of +foot-inch+.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
@@ -150,7 +185,14 @@ module CompositeUnitMeasurements
     # @since 0.3.0
     KILOMETRE_METRE = /\A#{ANY_NUMBER}\s*#{KILOMETRE_ALIASES}\s*#{ANY_NUMBER}\s*#{METRE_ALIASES}\z/.freeze
 
+    # Regex pattern for parsing a length measurement in the format of +mile-yard+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    MILE_YARD = /\A#{ANY_NUMBER}\s*#{MILE_ALIASES}\s*#{ANY_NUMBER}\s*#{YARD_ALIASES}\z/.freeze
+
     private_constant :FOOT_ALIASES, :INCH_ALIASES, :METRE_ALIASES, :CENTIMETRE_ALIASES,
-                     :KILOMETRE_ALIASES, :FOOT_INCH, :KILOMETRE_METRE, :METRE_CENTIMETRE
+                     :KILOMETRE_ALIASES, :MILE_ALIASES, :YARD_ALIASES, :MILE_YARD,
+                     :FOOT_INCH, :KILOMETRE_METRE, :METRE_CENTIMETRE
   end
 end

data/lib/composite_unit_measurements/time.rb

@@ -19,6 +19,12 @@ module CompositeUnitMeasurements
       # @example Parse 'duration':
       #   CompositeUnitMeasurements::Time.parse("12:60:3600,360000000") #=> 14.1 h
       #   CompositeUnitMeasurements::Time.parse("12:60:3600") #=> 14.0 h
+      # @example Parse 'minute-second' measurement:
+      #   CompositeUnitMeasurements::Time.parse("10 min 90 s") #=> 11.5 min
+      # @example Parse 'week-day' measurement:
+      #   CompositeUnitMeasurements::Time.parse("8 wk 3 d") #=> 8.428571428571429 wk
+      # @example Parse 'month-day' measurement:
+      #   CompositeUnitMeasurements::Time.parse("2 mo 60 d") #=> 3.97260057797197 mo
       #
       # @param [String] string The string to parse for time measurement.
       # @return [UnitMeasurements::Time]
@@ -30,9 +36,12 @@ module CompositeUnitMeasurements
       # @since 0.2.0
       def parse(string)
         case string
-        when HOUR_MINUTE then parse_hour_minute(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)
+        when MINUTE_SECOND then parse_minute_second(string)
+        when WEEK_DAY      then parse_week_day(string)
+        when MONTH_DAY     then parse_month_day(string)
+        else                    raise UnitMeasurements::ParseError, string
         end
       end
 
@@ -76,10 +85,70 @@ module CompositeUnitMeasurements
         hour, minute, second, microsecond = string.match(DURATION)&.captures
         raise ArgumentError, "Invalid Duration" if [hour, minute, second, microsecond].all?(&:nil?)
 
-        UnitMeasurements::Time.new((hour || 0), :h) +
-          UnitMeasurements::Time.new((minute || 0), :min) +
-          UnitMeasurements::Time.new((second || 0), :s) +
-          UnitMeasurements::Time.new((microsecond || 0), :μs)
+        UnitMeasurements::Time.new((hour || 0), "h") +
+          UnitMeasurements::Time.new((minute || 0), "min") +
+          UnitMeasurements::Time.new((second || 0), "s") +
+          UnitMeasurements::Time.new((microsecond || 0), "μs")
+      end
+
+      # @private
+      # Parses a +string+ representing a time in the format of +minute-second+
+      # into a +UnitMeasurements::Time+ object.
+      #
+      # @param [String] string
+      #   The string representing time measurement in the format of *minute-second*.
+      # @return [UnitMeasurements::Time]
+      #   Returns a UnitMeasurements::Time object if parsing is successful.
+      #
+      # @see MINUTE_SECOND
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.5.0
+      def parse_minute_second(string)
+        minute, second = string.match(MINUTE_SECOND)&.captures
+
+        if minute && second
+          UnitMeasurements::Time.new(minute, "min") + UnitMeasurements::Time.new(second, "s")
+        end
+      end
+
+      # @private
+      # Parses a +string+ representing a time in the format of +week-day+
+      # into a +UnitMeasurements::Time+ object.
+      #
+      # @param [String] string
+      #   The string representing time measurement in the format of *week-day*.
+      # @return [UnitMeasurements::Time]
+      #   Returns a UnitMeasurements::Time object if parsing is successful.
+      #
+      # @see WEEK_DAY
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.5.0
+      def parse_week_day(string)
+        week, day = string.match(WEEK_DAY)&.captures
+
+        if week && day
+          UnitMeasurements::Time.new(week, "wk") + UnitMeasurements::Time.new(day, "d")
+        end
+      end
+
+      # @private
+      # Parses a +string+ representing a time in the format of +month-day+
+      # into a +UnitMeasurements::Time+ object.
+      #
+      # @param [String] string
+      #   The string representing time measurement in the format of *month-day*.
+      # @return [UnitMeasurements::Time]
+      #   Returns a UnitMeasurements::Time object if parsing is successful.
+      #
+      # @see MONTH_DAY
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.5.0
+      def parse_month_day(string)
+        month, day = string.match(MONTH_DAY)&.captures
+
+        if month && day
+          UnitMeasurements::Time.new(month, "mo") + UnitMeasurements::Time.new(day, "d")
+        end
       end
     end
 
@@ -95,6 +164,30 @@ module CompositeUnitMeasurements
     # @since 0.3.0
     MINUTE_ALIASES = /(?:min|minute(?:s)?)/.freeze
 
+    # Regex pattern for aliases of +second+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    SECOND_ALIASES = /(?:s|sec|second(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +day+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    DAY_ALIASES = /(?:d|day(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +week+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    WEEK_ALIASES = /(?:wk|week(?:s)?)/.freeze
+
+    # Regex pattern for aliases of +month+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    MONTH_ALIASES = /(?:mo|month(?:s)?)/.freeze
+
     # Regex pattern for parsing a time measurement in the format of +hour-minute+.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
@@ -108,6 +201,26 @@ module CompositeUnitMeasurements
     # @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
+    # Regex pattern for parsing a time measurement in the format of +minute-second+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    MINUTE_SECOND = /\A#{ANY_NUMBER}\s*#{MINUTE_ALIASES}\s*#{ANY_NUMBER}\s*#{SECOND_ALIASES}\z/.freeze
+
+    # Regex pattern for parsing a time measurement in the format of +week-day+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    WEEK_DAY = /\A#{ANY_NUMBER}\s*#{WEEK_ALIASES}\s*#{ANY_NUMBER}\s*#{DAY_ALIASES}\z/.freeze
+
+    # Regex pattern for parsing a time measurement in the format of +month-day+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.5.0
+    MONTH_DAY = /\A#{ANY_NUMBER}\s#{MONTH_ALIASES}\s*#{ANY_NUMBER}\s*#{DAY_ALIASES}\z/.freeze
+
+    private_constant :HOUR_ALIASES, :MINUTE_ALIASES, :SECOND_ALIASES, :DAY_ALIASES,
+                     :WEEK_ALIASES, :MONTH_ALIASES, :HOUR_MINUTE, :DURATION,
+                     :MINUTE_SECOND, :WEEK_DAY, :MONTH_DAY
   end
 end

data/lib/composite_unit_measurements/version.rb

@@ -25,5 +25,5 @@
 # @since 0.1.0
 module CompositeUnitMeasurements
   # Current stable version
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composite_unit_measurements
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2023-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport