unit_measurements 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286c6438c249edf7fe0872a2ad8956f42cb5150819885e8bebe353a7955c97c9
-  data.tar.gz: 1e82f6cf7ec7dc4f51670be13980cc30ccfe56583fb2b94622f12614d9a0c91e
+  metadata.gz: 24b2504d7feb77f54138260f7e0947bd86e00225dbe3c6d9e575da3050a24eeb
+  data.tar.gz: 7d9b84113fbf2a2cd5ca1c5a46467296b15f1bf1016c1775b854098245998cee
 SHA512:
-  metadata.gz: 5353470b9101426b12d5fd34474d41fe04de2e4ef8286dd42c78605f01f35116f62341626299708f5ea0cc53613977437876b906d7fd79d91888ed9f1221a6e9
-  data.tar.gz: 7bda4b4f0598d53e2b3cf933da8d8485d8052ca6172d772bbaf55aa4400542782c62b99d583d0109ef5af2a7ed3504eb4991eb06b5a5f9cbcdcc4f87575ac919
+  metadata.gz: b5fc7c6e1b2b580fcd5477941e239e8d06a79416b90a7c36145f8d50d32c40c7430b83273038b2974ec51df90673e46672207f8d8ae975c31e99b3612cd3b446
+  data.tar.gz: 7730a9813366e4b36dbf98873a575cf89a33963ee998da6c84d7e6b5fd7c7f5c197530e23f1acaeb2a44e339667f9665d7e3bc62c5164579df06765e01426d85

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.1.0](https://github.com/shivam091/unit_measurements/compare/v1.0.0...v1.1.0) - 2023-08-14
+
+### What's new
+
+- Added `#format` method to format quantity of the measurement.
+
+----------
+
 ## [1.0.0](https://github.com/shivam091/unit_measurements/compare/v0.1.0...v1.0.0) - 2023-09-14
 
 ### What's new

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unit_measurements (1.0.0)
+    unit_measurements (1.1.0)
       activesupport (~> 7.0)
 
 GEM

data/README.md

@@ -219,6 +219,20 @@ UnitMeasurements::Weight.parse("2e⁻² kg to g")
 
 Supported special characters for exponents are `⁰`, `¹`, `²`, `³`, `⁴`, `⁵`, `⁶`, `⁷`, `⁸`, `⁹`, `⁺`, `⁻`.
 
+**Formatting measurement:**
+
+If you want to format measurement to certain format, you can use `#format` method.
+If format is not specified, it defaults to `"%.2<value>f %<unit>s"`.
+
+```ruby
+UnitMeasurements::Weight.parse("2 kg").to(:st).format
+#=> "0.31 st"
+UnitMeasurements::Weight.parse("2 kg").to(:st).format("%.4<quantity>f %<unit>s")
+#=> "0.3149 st"
+UnitMeasurements::Weight.parse("2 kg").to(:st).format("%.4<quantity>f")
+#=> "0.3149"
+```
+
 **Extract the unit and the quantity from measurement:**
 
 ```ruby

data/lib/unit_measurements/base.rb

@@ -27,6 +27,7 @@ require "unit_measurements/unit"
 require "unit_measurements/unit_group"
 require "unit_measurements/normalizer"
 require "unit_measurements/parser"
+require "unit_measurements/formatter"
 require "unit_measurements/measurement"
 
 require "unit_measurements/errors/unit_error"

data/lib/unit_measurements/errors/parse_error.rb

@@ -3,7 +3,7 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
-  class ParseError < StandardError
+  class ParseError < BaseError
     attr_reader :string
 
     def initialize(string)

data/lib/unit_measurements/errors/unit_already_defined_error.rb

@@ -3,7 +3,7 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
-  class UnitAlreadyDefinedError < StandardError
+  class UnitAlreadyDefinedError < BaseError
     attr_reader :unit
 
     def initialize(unit)

data/lib/unit_measurements/errors/unit_error.rb

@@ -3,7 +3,7 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
-  class UnitError < StandardError
+  class UnitError < BaseError
     attr_reader :unit
 
     def initialize(unit)

data/lib/unit_measurements/formatter.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  module Formatter
+    # The default format for formatting measurements.
+    DEFAULT_FORMAT = "%.2<quantity>f %<unit>s".freeze
+
+    # Formats measurement to certain formatted string specified by +format+.
+    # If +format+ is not specified, it uses +DEFAULT_FORMAT+ for
+    # formatting the measurement
+    #
+    # @example
+    #   UnitMeasurements::Weight.parse("2 kg").to(:st).format
+    #   => "0.31 st"
+    #   UnitMeasurements::Weight.parse("2 kg").to(:st).format("%.4<quantity>f %<unit>s")
+    #   => "0.3149 st"
+    #
+    # @param [String] format
+    #
+    # @return [String]
+    def format(format = nil)
+      kwargs = {quantity: quantity, unit: unit.to_s}
+      (format || DEFAULT_FORMAT) % kwargs
+    end
+  end
+end

data/lib/unit_measurements/measurement.rb

@@ -4,13 +4,14 @@
 
 module UnitMeasurements
   class Measurement
+    include Formatter
     CONVERSION_STRING_REGEXP = /(.+?)\s?(?:\s+(?:in|to|as)\s+(.+)|\z)/i.freeze
 
     attr_reader :quantity, :unit
 
     def initialize(quantity, unit)
-      raise ArgumentError, "Quantity cannot be blank." if quantity.blank?
-      raise ArgumentError, "Unit cannot be blank." if unit.blank?
+      raise BaseError, "Quantity cannot be blank." if quantity.blank?
+      raise BaseError, "Unit cannot be blank." if unit.blank?
 
       @quantity = convert_quantity(quantity)
       @unit = unit_from_unit_or_name!(unit)

data/lib/unit_measurements/version.rb

@@ -3,5 +3,5 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/unit_measurements.rb

@@ -2,6 +2,10 @@
 # -*- frozen_string_literal: true -*-
 # -*- warn_indent: true -*-
 
+module UnitMeasurements
+  class BaseError < StandardError; end
+end
+
 require "unit_measurements/base"
 
 require "unit_measurements/unit_groups/all"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Harshal LADHE
@@ -107,6 +107,7 @@ files:
 - lib/unit_measurements/errors/parse_error.rb
 - lib/unit_measurements/errors/unit_already_defined_error.rb
 - lib/unit_measurements/errors/unit_error.rb
+- lib/unit_measurements/formatter.rb
 - lib/unit_measurements/measurement.rb
 - lib/unit_measurements/normalizer.rb
 - lib/unit_measurements/parser.rb