composite_unit_measurements 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e212c20da9787a853fef2791d5f95d0004e5e45225c3809088205a1375b600c
-  data.tar.gz: 8b2c03cfdfba50cc0e13088bbfb8910afd249b98ec4048280441131f47a310f5
+  metadata.gz: e4450805d84ddd3b1cc972d152d187f44cbb1624d87dfece055c6db82ae70d20
+  data.tar.gz: 621ccd8a46402e7592dd93c8bf0683e414714e3f3fb67f1f4837cceabe96e5ab
 SHA512:
-  metadata.gz: c1a6c264037d7db78d70676137d60a1085bb7126034674c6156de7806ef9c76263a8acd8bd4125fa3655d1c6c64c1ccec3bdd04d004dcc93dbd0e4ad6e056c86
-  data.tar.gz: 394309d1a68c9eed5548f446fe3816ae467c7f2f6c4e66428d9957ae1ca5ed376659e4c7ff4fe1adc731cee85a8ea340577d120c65038b312398cf8f10dde6af
+  metadata.gz: 56937734d56198b02eb4c51c9b446558ec31a69bc123489ec371d8f36e7758efda6cf8d50ea85e947e57cf72f003e795a7897d850ff5a228f7505dc53b2aea36
+  data.tar.gz: d1e8a2129c276a186c8dd8bd7bf4cf5b29e2ff46c9dcff98b6928fba858b5d64441645c905ba273fd82bf547f43d14d1b0b25d2342d2219869d8d0a9b2a4d606

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.2.0 - 2023-11-17
+
+### What's new
+
+- Added ability to parse composite measurements containing `real`, `scientific`,
+  `rational`, and `complex` numbers.
+- Added ability to parse `foot-inch` length measurement.
+- Added ability to parse `duration`.
+- Added ability to parse `pound-ounce` and `stone-pound` weight measurement.
+
+-----------
+
 ## 0.1.0 - 2023-11-09
 
 ### Initial release

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    composite_unit_measurements (0.1.0)
+    composite_unit_measurements (0.2.0)
       activesupport (~> 7.0)
       unit_measurements (~> 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.1)
+    activesupport (7.1.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -54,7 +54,7 @@ GEM
     simplecov_json_formatter (0.1.4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unit_measurements (5.8.0)
+    unit_measurements (5.11.1)
       activesupport (~> 7.0)
 
 PLATFORMS

data/README.md

@@ -37,6 +37,73 @@ Or otherwise simply install it yourself as:
 
 `$ gem install composite_unit_measurements`
 
+## 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`
+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.
+
+```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
+```
+
+Each parser has capability to parse `real`, `rational`, `scientific`, 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`.
+
+**1. Unitify::CompositeMeasurements::Length**
+- foot-inch (5 ft 6 in)
+
+**2. Unitify::CompositeMeasurements::Weight**
+- pound-ounce (8 lb 12 oz)
+- stone-pound (2 st 6 lb)
+
+**3. Unitify::CompositeMeasurements::Time**
+- hour-minute-second-microsecond (12:60:60,60)
+
+### 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:
+
+```ruby
+require "composite_unit_measurements/base"
+
+require "composite_unit_measurements/length"
+require "composite_unit_measurements/weight"
+```
+
 ## Contributing
 
 1. Fork it

data/lib/composite_unit_measurements/base.rb

@@ -5,3 +5,53 @@
 require "unit_measurements/base"
 
 require "composite_unit_measurements/version"
+
+module CompositeUnitMeasurements
+  # Matches real numbers in the form of 31, +72, or -12.
+  REAL_NUMBER = /
+    (?:                   # Start of non-capturing group
+      [+-]?               # Optional plus (+) or minus (-) sign
+      \d+                 # One or more digits
+    )                     # End of non-capturing group
+  /x.freeze
+
+  # Matches a rational number in the form of a/b (fractional) or a b/c (mixed fractional).
+  RATIONAL_NUMBER = /
+    (?:                   # Start of optional non-capturing group
+      [+-]?               # Optional plus (+) or minus (-) sign
+      \d+                 # One or more digits
+      \s+                 # One or more whitespace
+    )?                    # End of optional non-capturing group
+    (                     # Start of capturing group for the fraction
+      (\d+)               # Capture the numerator (one or more digits)
+      \/                  # Match the forward slash, indicating division
+      (\d+)               # Capture the denominator (one or more digits)
+    )                     # End of capturing group for the fraction
+  /x.freeze
+
+  # Matches a scientific number in various formats like 1.23E+4 or -5.67e-8.
+  SCIENTIFIC_NUMBER = /
+    (?:                   # Start of non-capturing group
+      [+-]?               # Optional plus (+) or minus (-) sign
+      \d*                 # Zero or more digits (integer part)
+      \.?                 # Optional decimal point
+      \d+                 # One or more digits (fractional part)
+      (?:                 # Start of non-capturing group for exponent part
+        [Ee]              # Match 'E' or 'e' for exponentiation
+        [+-]?             # Optional plus (+) or minus (-) sign for exponent
+        \d+               # One or more digits (exponent value)
+      )?                  # End of non-capturing group of exponent part (optional)
+    )                     # End of non-capturing group
+  /x.freeze
+
+  # Matches complex numbers in the form of a+bi, where both 'a' and 'b' can be
+  # in scientific notation. It captures the real and imaginary parts.
+  COMPLEX_NUMBER = /
+    #{SCIENTIFIC_NUMBER}  # Pattern for scientific number
+    #{SCIENTIFIC_NUMBER}  # Pattern for scientific number
+    i                     # Match the letter 'i' (the imaginary unit)
+  /x.freeze
+
+  # Matches any number, including scientific, complex, rational, and real numbers.
+  ANY_NUMBER = /(?<number>#{SCIENTIFIC_NUMBER}|#{COMPLEX_NUMBER}|#{RATIONAL_NUMBER}|#{REAL_NUMBER})/.freeze
+end

data/lib/composite_unit_measurements/length.rb

@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+require "unit_measurements/unit_groups/length"
+
+module CompositeUnitMeasurements
+  # A parser handling +length+ measurements, particularly for composite units
+  # like +foot-inch+, +kilometre-metre+, +mile-yard+, etc.
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 0.2.0
+  class Length
+    class << self
+      # Parses a given +string+ into a +UnitMeasurements::Length+ object.
+      #
+      # @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.
+      #
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.2.0
+      def parse(string)
+        case string
+        when FOOT_INCH then parse_foot_inch(string)
+        else                raise UnitMeasurements::ParseError, string
+        end
+      end
+
+      private
+
+      # @private
+      # Parses a +string+ representing a length in the format of +foot-inch+.
+      #
+      # @param [String] string
+      #   The string representing length measurement in the format of *foot-inch*.
+      # @return [UnitMeasurements::Length]
+      #   Returns a UnitMeasurements::Length object if parsing is successful.
+      #
+      # @see FOOT_INCH
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.2.0
+      def parse_foot_inch(string)
+        foot, inch = string.match(FOOT_INCH)&.captures
+
+        if foot && inch
+          UnitMeasurements::Length.new(foot, :ft) + UnitMeasurements::Length.new(inch, :in)
+        end
+      end
+    end
+
+    private
+
+    # Regex pattern for aliases of +foot+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.2.0
+    FOOT_ALIASES = /(?:'|ft|foot|feet)/.freeze
+
+    # Regex pattern for aliases of +inch+ unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 0.2.0
+    INCH_ALIASES = /(?:"|in|inch(?:es)?)/.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
+  end
+end

data/lib/composite_unit_measurements/time.rb

@@ -0,0 +1,67 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+require "unit_measurements/unit_groups/time"
+
+module CompositeUnitMeasurements
+  # A parser handling +time+ measurements, particularly for composite units
+  # like +hour:minute:second,microsecond+, +minute-second+, +hour-minute+, etc.
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 0.2.0
+  class Time
+    class << self
+      # Parses a given +string+ into a +UnitMeasurements::Time+ object.
+      #
+      # @param [String] string The string to parse for time measurement.
+      # @return [UnitMeasurements::Time]
+      #   Returns a UnitMeasurements::Time 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.2.0
+      def parse(string)
+        case string
+        when DURATION             then parse_duration(string)
+        else                           raise UnitMeasurements::ParseError, string
+        end
+      end
+
+      private
+
+      # @private
+      # Parses a +string+ representing time duration in the format of
+      # +hour:minute:second,microsecond+ or +hour:minute:second+.
+      #
+      # @param [String] string The string representing time duration.
+      # @return [UnitMeasurements::Time]
+      #   Returns a UnitMeasurements::Time object if parsing is successful.
+      # @raise [ArgumentError]
+      #   Raises an ArgumentError for an invalid duration format.
+      #
+      # @see DURATION
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.2.0
+      def parse_duration(string)
+        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)
+      end
+    end
+
+    private
+
+    # Regex pattern for parsing duration in the format of +hour:minute:second+ or
+    # +hour:minute:second,microsecond+.
+    #
+    # @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
+  end
+end

data/lib/composite_unit_measurements/version.rb

@@ -3,5 +3,6 @@
 # -*- warn_indent: true -*-
 
 module CompositeUnitMeasurements
-  VERSION = "0.1.0"
+  # Current stable version
+  VERSION = "0.2.0"
 end

data/lib/composite_unit_measurements/weight.rb

@@ -0,0 +1,106 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+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.
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 0.2.0
+  class Weight
+    class << self
+      # Parses a given +string+ into a +UnitMeasurements::Weight+ object.
+      #
+      # @param [String] string The string to parse for weight measurement.
+      # @return [UnitMeasurements::Weight]
+      #   Returns a UnitMeasurements::Weight 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.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
+        end
+      end
+
+      private
+
+      # @private
+      # Parses a +string+ representing a weight in the format of +pound-ounce+.
+      #
+      # @param [String] string
+      #   The string representing weight measurement in the format of *pound-ounce*.
+      # @return [UnitMeasurements::Weight]
+      #   Returns a UnitMeasurements::Weight object if parsing is successful.
+      #
+      # @see POUND_OUNCE
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.2.0
+      def parse_pound_ounce(string)
+        pound, ounce = string.match(POUND_OUNCE)&.captures
+
+        if pound && ounce
+          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+.
+      #
+      # @param [String] string
+      #   The string representing weight measurement in the format of *stone-pound*.
+      # @return [UnitMeasurements::Weight]
+      #   Returns a UnitMeasurements::Weight object if parsing is successful.
+      #
+      # @see STONE_POUND
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 0.2.0
+      def parse_stone_pound(string)
+        stone, pound = string.match(STONE_POUND)&.captures
+
+        if stone && pound
+          UnitMeasurements::Weight.new(stone, :st) + UnitMeasurements::Weight.new(pound, :lb)
+        end
+      end
+    end
+
+    private
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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
+  end
+end

data/lib/composite_unit_measurements.rb

@@ -2,8 +2,8 @@
 # -*- frozen_string_literal: true -*-
 # -*- warn_indent: true -*-
 
-require "composite_unit_measurements/version"
+require "composite_unit_measurements/base"
 
-module CompositeUnitMeasurements
-  class Error < StandardError; end
-end
+require "composite_unit_measurements/length"
+require "composite_unit_measurements/time"
+require "composite_unit_measurements/weight"

metadata

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