unit_measurements 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4606afee8a816cd36066634a4d6e8e23448548eb51d90d984c5230996f4e12c
-  data.tar.gz: ab4a36000579a4c3aa33f766a883bbd80c3fc1a485dcef6b12725316154db094
+  metadata.gz: aac3030ed1c46bb4bdfe831bc9bedb29ad2a8b0e28595ba4726b2a3ff5e24791
+  data.tar.gz: 9179c7b41ef7e84b6864ef98ccb45210ab34b2488830aa3de5552659b7f39039
 SHA512:
-  metadata.gz: ffb38111aa3c731166a453fd9f217a2a49a6bffc1db9962c8853af470dcdbf998d51834db785fe5863d2d3d8738cd86ac87d9a1f17ecd98990230683734774e6
-  data.tar.gz: c5e40fbf843746bac311e1e33071dc41b9b936551760f9aa488acd708b54b2ce8c6e26fb83d197f466acda14788f94fc67fd5013d0c5179116be2914f5e5bd25
+  metadata.gz: 5435fba092be97c1c8407b917857c1990db07d1aa1729653ecf14519d98dcec2a4c5e5ad0c4997586eb2f72b17d1099506068aa99eb592ee35ddd8da4a2f8ba7
+  data.tar.gz: 5938944868b729168d49d1f5e7e888029931bb17237fd72c66980bf6b47d7fe58f8eefdd94f1927652d9b5d1e3e480e8df746f5c7607995390ea7caeec186634

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [1.5.1](https://github.com/shivam091/unit_measurements/compare/v1.5.0...v1.5.1) - 2023-08-18
+
+### What's updated
+
+- Added extra blank line between method code and last code statement (considered as return).
+
+----------
+
+## [1.5.0](https://github.com/shivam091/unit_measurements/compare/v1.4.0...v1.5.0) - 2023-08-18
+
+### What's fixed
+
+- Fixed precision in `Measurement#quantity` method.
+
+----------
+
 ## [1.4.0](https://github.com/shivam091/unit_measurements/compare/v1.3.0...v1.4.0) - 2023-08-17
 
 ### What's new

data/Gemfile.lock

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

data/README.md

@@ -79,14 +79,14 @@ You can use `#convert_to` as:
 
 ```ruby
 UnitMeasurements::Weight.new(1, :kg).convert_to(:g)
-#=> 1000 g
+#=> 1000.0 g
 ```
 
 If you want to modify measurement object itself, you can use `#convert_to!` method as:
 
 ```ruby
 UnitMeasurements::Weight.new(1, :kg).convert_to!(:g)
-#=> 1000 g
+#=> 1000.0 g
 ```
 
 You can also chain call of `#convert_to` and `#convert_to!` methods as:
@@ -100,18 +100,18 @@ UnitMeasurements::Weight.new(1, :kg).convert_to(:g).convert_to(:t).convert_to!(:
 
 ```ruby
 UnitMeasurements::Weight.parse("1 kg")
-#=> 1 kg
+#=> 1.0 kg
 ```
 
 **Parse string that mentions quantity, source unit, and target unit:**
 
 ```ruby
 UnitMeasurements::Weight.parse("1 kg to g")
-#=> 1000 g
+#=> 1000.0 g
 UnitMeasurements::Weight.parse("1 kg as g")
-#=> 1000 g
+#=> 1000.0 g
 UnitMeasurements::Weight.parse("1 kg in g")
-#=> 1000 g
+#=> 1000.0 g
 ```
 
 **Parse rational numbers, source unit, and (or) target unit:**
@@ -144,58 +144,58 @@ UnitMeasurements::Weight.parse("2+3i kg to g")
 
 ```ruby
 UnitMeasurements::Weight.new(BigDecimal(2), :kg).convert_to(:g)
-#=> 2000 g
+#=> 2000.0 g
 UnitMeasurements::Weight.new(0.2e1, :kg).convert_to(:g)
-#=> 2000 g
+#=> 2000.0 g
 UnitMeasurements::Weight.parse("0.2e1 kg").convert_to(:g)
-#=> 2000 g
+#=> 2000.0 g
 UnitMeasurements::Weight.parse("0.2e1 kg to g")
-#=> 2000 g
+#=> 2000.0 g
 ```
 
 **Parse ratios, source unit, and (or) target unit:**
 
 ```ruby
 UnitMeasurements::Weight.new("1:2", :kg).convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("1:2 kg").convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("1:2 kg to g")
-#=> 500 g
+#=> 500.0 g
 ```
 
 **Parse fractional notations, source unit, and (or) target unit:**
 
 ```ruby
 UnitMeasurements::Weight.new("1/2", :kg).convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("1/2 kg").convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("1/2 kg to g")
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.new("½", :kg).convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("½ kg").convert_to(:g)
-#=> 500 g
+#=> 500.0 g
 UnitMeasurements::Weight.parse("½ kg to g")
-#=> 500 g
+#=> 500.0 g
 ```
 
 **Parse mixed fractional notations, source unit, and (or) target unit:**
 
 ```ruby
 UnitMeasurements::Weight.new("2 1/2", :kg).convert_to(:g)
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.parse("2 1/2 kg").convert_to(:g)
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.parse("2 1/2 kg to g")
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.new("2 ½", :kg).convert_to(:g)
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.parse("2 ½ kg").convert_to(:g)
-#=> 2500 g
+#=> 2500.0 g
 UnitMeasurements::Weight.parse("2 ½ kg to g")
-#=> 2500 g
+#=> 2500.0 g
 ```
 
 Supported special characters for fractional notations are `¼`, `½`, `¾`, `⅓`, `⅔`, `⅕`, `⅖`, `⅗`, `⅘`, `⅙`, `⅚`, `⅐`, `⅛`, `⅜`, `⅝`, `⅞`, `⅑`, `⅒`, `↉`, `⁄`.
@@ -204,17 +204,17 @@ Supported special characters for fractional notations are `¼`, `½`, `¾`, `⅓
 
 ```ruby
 UnitMeasurements::Weight.new("2e+2", :kg).convert_to(:g)
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.parse("2e² kg").convert_to(:g)
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.parse("2e+2 kg to g")
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.new("2e⁺²", :kg).convert_to(:g)
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.parse("2e⁺2 kg").convert_to(:g)
-#=> 200000 g
+#=> 200000.0 g
 UnitMeasurements::Weight.parse("2e⁻² kg to g")
-#=> 20 g
+#=> 20.0 g
 ```
 
 Supported special characters for exponents are `⁰`, `¹`, `²`, `³`, `⁴`, `⁵`, `⁶`, `⁷`, `⁸`, `⁹`, `⁺`, `⁻`.
@@ -236,9 +236,9 @@ UnitMeasurements::Weight.parse("2 kg").to(:st).format("%.4<quantity>f")
 **Extract the unit and the quantity from measurement:**
 
 ```ruby
-weight = UnitMeasurements::Weight.new(1.0, :kg)
+weight = UnitMeasurements::Weight.new(1, :kg)
 weight.quantity
-#=> 0.1e1
+#=> 1
 weight.unit
 #=> #<UnitMeasurements::Unit: kg (kilogram, kilogramme, kilogrammes, kilograms)>
 ```
@@ -307,7 +307,6 @@ UnitMeasurements::Weight.unit_or_alias?(:gramme)
 
 You have ability to compare the measurements with the same or different units within the same unit group.
 For example, comparing weight with weight will work, comparing a weight with a area would fail.
-Allowed comparisons are `==`, `!=`, `>`, `>=`, `<`, and `<=`.
 
 ```ruby
 UnitMeasurements::Weight.new(1, "kg") == UnitMeasurements::Weight.new(1, :kg)
@@ -320,12 +319,16 @@ UnitMeasurements::Weight.parse("1 kg") <= UnitMeasurements::Weight.parse("0.5 kg
 #=> false
 UnitMeasurements::Weight.parse("1 kg") >= UnitMeasurements::Weight.parse("0.5 kg")
 #=> true
+UnitMeasurements::Length.new(1, :ft).between?(UnitMeasurements::Length.new(12, :in), UnitMeasurements::Length.new(24, :in))
+#=> true
+UnitMeasurements::Length.new(1, :ft).clamp(UnitMeasurements::Length.new(13, :in), UnitMeasurements::Length.new(24, :in))
+#=> 13 in
 ```
 
 ### Arithmetic
 
-You have the ability to perform arithmetic operations on measurements with the same or
-different units within the same unit group. You can perform arithmetic operations on
+You have ability to perform arithmetic operations on measurements with the same or
+different units within a same unit group. You can perform arithmetic operations on
 measurement by either other compatible measurement or number.
 
 **Methods:**

data/lib/unit_measurements/arithmetic.rb

@@ -68,6 +68,7 @@ module UnitMeasurements
 
     def arithmetic_operation(other, operator)
       other, _ = coerce(other)
+
       self.class.new(self.quantity.public_send(operator, other.convert_to(self.unit).quantity), self.unit)
     end
   end

data/lib/unit_measurements/errors/parse_error.rb

@@ -8,6 +8,7 @@ module UnitMeasurements
 
     def initialize(string)
       @string = string
+
       super("Unable to parse: '#{string}'.")
     end
   end

data/lib/unit_measurements/errors/unit_already_defined_error.rb

@@ -8,6 +8,7 @@ module UnitMeasurements
 
     def initialize(unit)
       @unit = unit
+
       super("Unit already defined: '#{unit}'.")
     end
   end

data/lib/unit_measurements/errors/unit_error.rb

@@ -8,6 +8,7 @@ module UnitMeasurements
 
     def initialize(unit)
       @unit = unit
+
       super("Invalid unit: '#{unit}'.")
     end
   end

data/lib/unit_measurements/formatter.rb

@@ -22,6 +22,7 @@ module UnitMeasurements
     # @return [String]
     def format(format = nil)
       kwargs = {quantity: quantity, unit: unit.to_s}
+
       (format || DEFAULT_FORMAT) % kwargs
     end
   end

data/lib/unit_measurements/measurement.rb

@@ -26,6 +26,7 @@ module UnitMeasurements
       return self if target_unit == unit
 
       conversion_factor = (unit.conversion_factor / target_unit.conversion_factor)
+
       self.class.new((quantity * conversion_factor), target_unit)
     end
     alias_method :to, :convert_to
@@ -33,6 +34,7 @@ module UnitMeasurements
     def convert_to!(target_unit)
       measurement = convert_to(target_unit)
       @quantity, @unit = measurement.quantity, measurement.unit
+
       self
     end
     alias_method :to!, :convert_to!
@@ -44,7 +46,16 @@ module UnitMeasurements
     end
 
     def to_s
-      "#{humanized_quantity} #{unit.to_s}"
+      "#{quantity} #{unit}"
+    end
+
+    def quantity
+      case @quantity
+      when Rational
+        @quantity.denominator == 1 ? @quantity.numerator : @quantity
+      else
+        @quantity
+      end
     end
 
     class << self
@@ -61,6 +72,7 @@ module UnitMeasurements
       def parse(input)
         input = Normalizer.normalize(input)
         source, target = input.match(CONVERSION_STRING_REGEXP)&.captures
+
         target ? _parse(source).convert_to(target) : _parse(source)
       end
 
@@ -68,6 +80,7 @@ module UnitMeasurements
 
       def _parse(string)
         quantity, unit = Parser.parse(string)
+
         new(quantity, unit)
       end
     end
@@ -83,6 +96,7 @@ module UnitMeasurements
       when String
         quantity = Normalizer.normalize(quantity)
         quantity, _ = Parser.parse(quantity)
+
         quantity
       else
         quantity
@@ -92,15 +106,5 @@ module UnitMeasurements
     def unit_from_unit_or_name!(value)
       value.is_a?(Unit) ? value : self.class.unit_group.unit_for!(value)
     end
-
-    def humanized_quantity
-      case quantity
-      when Complex
-        quantity
-      when Numeric
-        num = quantity.to_r
-        num.denominator == 1 ? num.numerator.to_s : num.to_f.to_s
-      end
-    end
   end
 end

data/lib/unit_measurements/unit_group_builder.rb

@@ -37,17 +37,20 @@ module UnitMeasurements
         end
         si_units << build_unit("#{short_prefix}#{name}", value: "#{multiplier} #{name}", aliases: si_aliases)
       end
+
       si_units
     end
 
     def build_unit(name, value:, aliases:)
       unit = Unit.new(name, value: value, aliases: aliases)
       check_for_duplicate_unit_names!(unit)
+
       unit
     end
 
     def check_for_duplicate_unit_names!(unit)
       names = @units.flat_map(&:names)
+
       if names.any? { |name| unit.names.include?(name) }
         raise UnitAlreadyDefinedError.new(unit.name)
       end

data/lib/unit_measurements/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-17 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport