composite_unit_measurements 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66b4aa8b083b2ce04d0b18a00eda81ca826aa514e66adcf15c6d909fca23bf7b
-  data.tar.gz: d8482df4c187ecc55f03b0e192f732f4708b8a3c102576f6575a48410098f72b
+  metadata.gz: 4b3ee724bfce2ea0502643679d1779360a70977d89dc946a855457b982f7b4c9
+  data.tar.gz: 1b971b28b9a8d9d6c72476c9c4bee08de44fc97f9670497245de616f0658872f
 SHA512:
-  metadata.gz: 40bdb5fe245ad06dc61527cf0a2f70d76a122d118bdb50b3ec2ad2276d38fe881fc4c2a5b803904bc8c6c1df4447e2bd0de399280b2c35425c1c18439faef134
-  data.tar.gz: d33a783ce26f8d28d6a9668915c6664a1526924449b792d619df0c270bc1a4472be69b337d6696d80249ec61d6485988f3fb13b516b043545594902cd2ba67ea
+  metadata.gz: 076635ea3ccbcab0c65d0baae50da36351d89c96a88f774cc0f4db579332ace45135f49974756e6f6fff4e8bc92c86fdde7ad19251cac97a82eb9b79ebaa7d64
+  data.tar.gz: 38e4adbd5231dc8d65134178f05548713f42f2709929d33f416ca4f0d1536635d42c1389e669619be193ab0d78df09b8a8908918a4d10683f27be18b4cc13bc8

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.6.0](https://github.com/shivam091/composite_unit_measurements/compare/v0.5.0...v0.6.0) - 2023-12-12
+
+### What's new
+
+- Added support to parse `tonne-kilogramme` weight measurements.
+- Added support to parse `second-millisecond` and `year-month` time measurements.
+
+-----------
+
 ## [0.5.0](https://github.com/shivam091/composite_unit_measurements/compare/v0.4.0...v0.5.0) - 2023-12-10
 
 ### What's new

data/Gemfile.lock

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

data/README.md

@@ -106,6 +106,7 @@ including:
 - kilogramme-gramme (4 kg 500 g)
 - pound-ounce (8 lb 12 oz)
 - stone-pound (2 st 6 lb)
+- tonne-kilogramme (1 t 500 kg)
 
 **3. CompositeUnitMeasurements::Time**
 - hour-minute (3 h 45 min)
@@ -113,6 +114,8 @@ including:
 - minute-second (10 min 90 s)
 - week-day (8 wk 3 d)
 - month-day (2 mo 60 d)
+- second-millisecond (8 s 500 ms)
+- year-month (3 yr 4 mo)
 
 **4. CompositeUnitMeasurements::Volume**
 - litre-millilitre (2 l 250 ml)

data/lib/composite_unit_measurements/time.rb

@@ -25,6 +25,10 @@ module CompositeUnitMeasurements
       #   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
+      # @example Parse 'second-millisecond' measurement:
+      #   CompositeUnitMeasurements::Time.parse("8 s 500 ms") #=> 8.5 s
+      # @example Parse 'year-month' measurement:
+      #   CompositeUnitMeasurements::Time.parse("3 yr 4 mo") #=> 3.333333698630137 yr
       #
       # @param [String] string The string to parse for time measurement.
       # @return [UnitMeasurements::Time]
@@ -36,12 +40,14 @@ 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)
-        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
+        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)
+        when SECOND_MILLISECOND then parse_second_millisecond(string)
+        when YEAR_MONTH         then parse_year_month(string)
+        else                         raise UnitMeasurements::ParseError, string
         end
       end
 
@@ -150,6 +156,46 @@ module CompositeUnitMeasurements
           UnitMeasurements::Time.new(month, "mo") + UnitMeasurements::Time.new(day, "d")
         end
       end
+
+      # @private
+      # Parses a +string+ representing a time in the format of +second-millisecond+
+      # into a +UnitMeasurements::Time+ object.
+      #
+      # @param [String] string
+      #   The string representing time measurement in the format of *second-millisecond*.
+      # @return [UnitMeasurements::Time]
+      #   Returns a UnitMeasurements::Time object if parsing is successful.
+      #
+      # @see SECOND_MILLISECOND
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.6.0
+      def parse_second_millisecond(string)
+        second, millisecond = string.match(SECOND_MILLISECOND)&.captures
+
+        if second && millisecond
+          UnitMeasurements::Time.new(second, "s") + UnitMeasurements::Time.new(millisecond, "ms")
+        end
+      end
+
+      # @private
+      # Parses a +string+ representing a time in the format of +year-month+
+      # into a +UnitMeasurements::Time+ object.
+      #
+      # @param [String] string
+      #   The string representing time measurement in the format of *year-month*.
+      # @return [UnitMeasurements::Time]
+      #   Returns a UnitMeasurements::Time object if parsing is successful.
+      #
+      # @see YEAR_MONTH
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.6.0
+      def parse_year_month(string)
+        year, month = string.match(YEAR_MONTH)&.captures
+
+        if year && month
+          UnitMeasurements::Time.new(year, "yr") + UnitMeasurements::Time.new(month, "mo")
+        end
+      end
     end
 
     # Regex pattern for aliases of +hour+ unit.
@@ -170,6 +216,12 @@ module CompositeUnitMeasurements
     # @since 0.5.0
     SECOND_ALIASES = /(?:s|sec|second(?:s)?)/.freeze
 
+    # Regex pattern for aliases of +millisecond+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.6.0
+    MILLISECOND_ALIASES = /(?:ms|millisec|millisecond(?:s)?)/.freeze
+
     # Regex pattern for aliases of +day+ unit.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
@@ -188,6 +240,12 @@ module CompositeUnitMeasurements
     # @since 0.5.0
     MONTH_ALIASES = /(?:mo|month(?:s)?)/.freeze
 
+    # Regex pattern for aliases of +year+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.6.0
+    YEAR_ALIASES = /(?:y|yr|year(?:s)?)/.freeze
+
     # Regex pattern for parsing a time measurement in the format of +hour-minute+.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
@@ -217,10 +275,23 @@ module CompositeUnitMeasurements
     #
     # @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
+    MONTH_DAY = /\A#{ANY_NUMBER}\s*#{MONTH_ALIASES}\s*#{ANY_NUMBER}\s*#{DAY_ALIASES}\z/.freeze
+
+    # Regex pattern for parsing a time measurement in the format of +second-millisecond+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.6.0
+    SECOND_MILLISECOND = /\A#{ANY_NUMBER}\s*#{SECOND_ALIASES}\s*#{ANY_NUMBER}\s*#{MILLISECOND_ALIASES}\z/.freeze
+
+    # Regex pattern for parsing a time measurement in the format of +year-month.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.6.0
+    YEAR_MONTH = /\A#{ANY_NUMBER}\s*#{YEAR_ALIASES}\s*#{ANY_NUMBER}\s*#{MONTH_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
+                     :WEEK_ALIASES, :MONTH_ALIASES, :YEAR_ALIASES, :MILLISECOND_ALIASES,
+                     :HOUR_MINUTE, :DURATION, :MINUTE_SECOND, :WEEK_DAY, :MONTH_DAY,
+                     :SECOND_MILLISECOND, :YEAR_MONTH
   end
 end

data/lib/composite_unit_measurements/version.rb

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

data/lib/composite_unit_measurements/weight.rb

@@ -14,12 +14,14 @@ 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
+      # @example Parse 'kilogramme-gramme' measurement:
+      #   CompositeUnitMeasurements::Weight.parse("4 kg 500 g") #=> 4.5 kg
+      # @example Parse 'tonne-kilogramme' measurement:
+      #   CompositeUnitMeasurements::Weight.parse("1 t 500 kg") #=> 1.5 t
       #
       # @param [String] string The string to parse for weight measurement.
       # @return [UnitMeasurements::Weight]
@@ -34,6 +36,7 @@ module CompositeUnitMeasurements
         when POUND_OUNCE       then parse_pound_ounce(string)
         when STONE_POUND       then parse_stone_pound(string)
         when KILOGRAMME_GRAMME then parse_kilogramme_gramme(string)
+        when TONNE_KILOGRAMME  then parse_tonne_kilogramme(string)
         else                        raise UnitMeasurements::ParseError, string
         end
       end
@@ -99,6 +102,26 @@ module CompositeUnitMeasurements
           UnitMeasurements::Weight.new(kilogramme, "kg") + UnitMeasurements::Weight.new(gramme, "g")
         end
       end
+
+      # @private
+      # Parses a +string+ representing a weight in the format of +tonne-kilogramme+
+      # into a +UnitMeasurements::Weight+ object.
+      #
+      # @param [String] string
+      #   The string representing weight measurement in the format of *tonne-kilogramme*.
+      # @return [UnitMeasurements::Weight]
+      #   Returns a UnitMeasurements::Weight object if parsing is successful.
+      #
+      # @see TONNE_KILOGRAMME
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.6.0
+      def parse_tonne_kilogramme(string)
+        tonne, kilogramme = string.match(TONNE_KILOGRAMME)&.captures
+
+        if tonne && kilogramme
+          UnitMeasurements::Weight.new(tonne, "t") + UnitMeasurements::Weight.new(kilogramme, "kg")
+        end
+      end
     end
 
     # Regex pattern for aliases of +pound+ unit.
@@ -131,6 +154,12 @@ module CompositeUnitMeasurements
     # @since 0.3.0
     KILOGRAMME_ALIASES = /(?:kg|kilogram(?:s)?|kilogramme(?:s)?)/.freeze
 
+    # Regex pattern for aliases of +tonne+ or +metric tonne+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.6.0
+    TONNE_ALIASES = /(?:t|tonne(?:s)?|metric tonne(?:s)?)/.freeze
+
     # Regex pattern for parsing a weight measurement in the format of +pound-ounce+.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
@@ -149,7 +178,14 @@ module CompositeUnitMeasurements
     # @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
+    # Regex pattern for parsing a weight measurement in the format of +tonne-kilogramme+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.6.0
+    TONNE_KILOGRAMME  = /\A#{ANY_NUMBER}\s*#{TONNE_ALIASES}\s*#{ANY_NUMBER}\s*#{KILOGRAMME_ALIASES}\z/.freeze
+
+    private_constant :POUND_ALIASES, :OUNCE_ALIASES, :STONE_ALIASES, :GRAMME_ALIASES,
+                     :KILOGRAMME_ALIASES, :TONNE_ALIASES, :POUND_OUNCE, :STONE_POUND,
+                     :KILOGRAMME_GRAMME, :TONNE_KILOGRAMME
   end
 end

metadata

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