unit_measurements 1.6.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daf31532333a9d280d948318fe94079cfb5a8d341f6756a5c64b42843142c80f
-  data.tar.gz: 88a85aed303c4c5209330bdcf14b1ee5696e40b0e815b6b570a60ac6fd4b6db5
+  metadata.gz: 8601bdbb7fb37856840869d267729adefddbf714ab6696376d6165252f9531f3
+  data.tar.gz: 33c504c31db58c752ecb4b587112ae2df4b0af6c0e1efd957af1202e635e3622
 SHA512:
-  metadata.gz: 60febdff329999f4aeedb36fbb8aa70eccf1ab8feecc34c4318daca4949b2df16034a285ce8ac5bee2c99e59f991fe52f456154dba5ae1c945bdf6e732f2ed55
-  data.tar.gz: 8152670ce01518dac56686ccc17f51e5c3b898f6ec90710d9a5ebb66089fa234351a70a0a91a9b9e1adf02cfb0966df3490b02f625aa639239c63440d515e960
+  metadata.gz: 119bd53409c40aac1242b0721e3737e65231a2e243e1e0151ede230b5b2f76358679a63a0b9fc66c8ec8bf5fda9b9395a8539c8ad2f6fd08933edc8717ffaa6d
+  data.tar.gz: 3a5ed9b00ec6e5abee27bc8fd653e5c8c069ad18c5c5cac2c4dbcba519f1c72cbd574243f8c5e955fb4a896a737434b376395b2b4a46e114e40b473292fe04b8

data/CHANGELOG.md

@@ -1,6 +1,24 @@
+## [2.1.0](https://github.com/shivam091/unit_measurements/compare/v1.7.0...v2.1.0) - 2023-08-21
+
+### What's new
+
+- Added unit group for `time` units.
+- Added unit group for `amount of substance` units.
+
+----------
+
+## [1.7.0](https://github.com/shivam091/unit_measurements/compare/v1.6.0...v1.7.0) - 2023-08-20
+
+### What's new
+
+- Added support to convert the measurements to other numeric types viz.,
+  `Integer`, `BigDecimal`, `Rational`, `Complex`, and `Float`.
+
+----------
+
 ## [1.6.0](https://github.com/shivam091/unit_measurements/compare/v1.5.1...v1.6.0) - 2023-08-19
 
-## What's new
+### What's new
 
 - Added support to perform mathematical operations on the measurements.
 
@@ -67,10 +85,10 @@
 
 ----------
 
-## [0.1.0] - 2023-09-13
+## 0.1.0 - 2023-09-13
 
 ### Initial release
 
 -----------
 
-## [Unreleased]
+### Unreleased

data/Gemfile.lock

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

data/README.md

@@ -369,6 +369,24 @@ UnitMeasurements::Length.new(17.625, :m).ceil
 #=> 18 m
 ```
 
+### Conversions
+
+You can convert measurement quantity directly to other numeric types viz.
+`Integer`, `BigDecimal`, `Rational`, `Complex`, and `Float`.
+
+```ruby
+UnitMeasurements::Weight.new(2.25567, :kg).to_i
+#=> 2 kg
+UnitMeasurements::Weight.new(2.25567, :kg).to_f
+#=> 2.25567 kg
+UnitMeasurements::Weight.new(2.25567, :kg).to_r
+#=> 225567/100000 kg
+UnitMeasurements::Weight.new(2.25567, :kg).to_d
+#=> 2.25567 kg
+UnitMeasurements::Weight.new(2.25567, :kg).to_c
+#=> 2.25567+0i kg
+```
+
 ## Units
 
 The **`UnitMeasurements::Unit`** class is used to represent the units for a measurement.

data/lib/unit_measurements/base.rb

@@ -27,6 +27,7 @@ require "unit_measurements/unit"
 require "unit_measurements/unit_group"
 require "unit_measurements/arithmetic"
 require "unit_measurements/comparison"
+require "unit_measurements/conversion"
 require "unit_measurements/math"
 require "unit_measurements/normalizer"
 require "unit_measurements/parser"

data/lib/unit_measurements/conversion.rb

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  module Conversion
+    # Converts quantity of the measurement to +Integer+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_i
+    #   => 2 kg
+    #
+    # @return [Measurement]
+    def to_i
+      self.class.new(quantity.to_i, unit)
+    end
+
+    # Converts quantity of the measurement to +Float+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_f
+    #   => 2.25567 kg
+    #
+    # @return [Measurement]
+    def to_f
+      self.class.new(quantity.to_f, unit)
+    end
+
+    # Converts quantity of the measurement to +Rational+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_r
+    #   => 225567/100000 kg
+    #
+    # @return [Measurement]
+    def to_r
+      self.class.new(quantity.to_r, unit)
+    end
+
+    # Converts quantity of the measurement to +Complex+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_c
+    #   => 2.25567+0i kg
+    #
+    # @return [Measurement]
+    def to_c
+      self.class.new(quantity.to_c, unit)
+    end
+
+    # Converts quantity of the measurement to +BigDecimal+.
+    #
+    # @example
+    #   UnitMeasurements::Weight.new(2.25567, :kg).to_d
+    #   => 2.25567 kg
+    #
+    # @return [Measurement]
+    def to_d
+      self.class.new(quantity.to_d, unit)
+    end
+  end
+end

data/lib/unit_measurements/measurement.rb

@@ -6,6 +6,7 @@ module UnitMeasurements
   class Measurement
     include Arithmetic
     include Comparison
+    include Conversion
     include Formatter
     include Math
 

data/lib/unit_measurements/unit_groups/all.rb

@@ -2,5 +2,7 @@
 # -*- frozen_string_literal: true -*-
 # -*- warn_indent: true -*-
 
+require_relative "amount_of_substance"
 require_relative "length"
+require_relative "time"
 require_relative "weight"

data/lib/unit_measurements/unit_groups/amount_of_substance.rb

@@ -0,0 +1,9 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+UnitMeasurements::AmountOfSubstance = UnitMeasurements.build do
+  si_unit :mol, aliases: [:mole, :moles]
+
+  unit :NA, value: "1.6605389210322e-24 mol", aliases: [:"avogadro constant"]
+end

data/lib/unit_measurements/unit_groups/time.rb

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+UnitMeasurements::Time = UnitMeasurements.build do
+  si_unit :s, aliases: [:sec, :second, :seconds]
+
+  unit :h, value: "60 min", aliases: [:hr, :hour, :hours]
+  unit :d, value: "24 h", aliases: [:day, :days]
+  unit :wk, value: "7 d", aliases: [:week, :weeks]
+  unit :fn, value: "2 wk", aliases: [:"4tnite", :fortnight, :fortnights]
+  unit :mo, value: "30.4167 d", aliases: [:month, :months]
+  unit :yr, value: "365 d", aliases: [:y, :year, :years]
+  unit :min, value: "60 s", aliases: [:minute, :minutes]
+  unit :qtr, value: "3 mo", aliases: [:quarter, :quarters]
+  unit :dec, value: "10 y", aliases: [:decade, :decades]
+  unit :cent, value: "10 dec", aliases: [:century, :centuries]
+end

data/lib/unit_measurements/version.rb

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

data/units.md

@@ -30,3 +30,30 @@ These units are defined in `UnitMeasurements::Weight`.
 | **1** | **g\*** | **gram, grams, gramme, grammes** |
 | 2 | q | quintal, quintals |
 | 3 | t | tonne, tonnes, metric tonne, metric tonnes |
+
+## 3. Time
+
+These units are defined in `UnitMeasurements::Time`.
+
+| # | Name | Aliases |
+|:--|:--|:--|
+| **1** | **s\*** | **sec, second, seconds** |
+| 2 | h | hr, hour, hours |
+| 3 | d | day, days |
+| 4 | wk | week, weeks |
+| 5 | fn | 4tnite, fortnight, fortnights |
+| 6 | mo | month, months |
+| 7 | yr | y, year, years |
+| 8 | min | minute, minutes |
+| 9 | qtr | quarter, quarters |
+| 10 | dec | decade, decades |
+| 11 | cent | century, centuries |
+
+## 4. Amount of substance
+
+These units are defined in `UnitMeasurements::AmountOfSubstance`.
+
+| # | Symbol | Aliases |
+|:--|:--|:--|
+| **1** | **mol\*** | **mole, moles** |
+| 2 | NA | avogadro constant |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2023-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,6 +106,7 @@ files:
 - lib/unit_measurements/arithmetic.rb
 - lib/unit_measurements/base.rb
 - lib/unit_measurements/comparison.rb
+- lib/unit_measurements/conversion.rb
 - lib/unit_measurements/errors/parse_error.rb
 - lib/unit_measurements/errors/unit_already_defined_error.rb
 - lib/unit_measurements/errors/unit_error.rb
@@ -118,7 +119,9 @@ files:
 - lib/unit_measurements/unit_group.rb
 - lib/unit_measurements/unit_group_builder.rb
 - lib/unit_measurements/unit_groups/all.rb
+- lib/unit_measurements/unit_groups/amount_of_substance.rb
 - lib/unit_measurements/unit_groups/length.rb
+- lib/unit_measurements/unit_groups/time.rb
 - lib/unit_measurements/unit_groups/weight.rb
 - lib/unit_measurements/version.rb
 - unit_measurements.gemspec