unit_measurements 2.6.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d98e7586a633b58cedcc99e781acb073c11ff72d76fdc38fef41e8c8d845d80
-  data.tar.gz: 5021c9cb06916cad76a1882694dbea4a363cd26b5378d2429ad1ba4d4ad7b6ef
+  metadata.gz: b48c60ef57c1c3c3da286747f91effb58b512a5c827c1867ca6266446ff25722
+  data.tar.gz: 68e0a02544ba31a167ba99ebe94ba44e10876a3fb8922a65bae740becb770d22
 SHA512:
-  metadata.gz: 5bcc7575bd131b9287278e49e65c6718545d0d5361ca66a0c2a5100ad3aa9ca6b319eaac4eac47cd068b11ef0a325592ad99b1758eb2d00e3cd56b5ae5284867
-  data.tar.gz: ec28a588d149670874e64a136159e26beecc0ef01b154657d6c0b72ef940dac9aa9b37991a5392b9f4c18395c07d4d65036e74a48f254844e8f1441493be927e
+  metadata.gz: bef997801950b327b2665be18acb6836598606a28860945a7486dfd50afb5583e43b0fee050c50e3955272c88de6cf933131c9fa6e0e760e4ced83a59d68b164
+  data.tar.gz: '09c708ffbc5fa6f74dd30e5b0feee871826b15508bdec4de5c84b75246712a0379d5266f1685defa6fb6b161ef3d14b25f28422fb70c8e3c0f3e13b775612b5b'

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [3.0.0](https://github.com/shivam091/unit_measurements/compare/v2.6.2...v3.0.0) - 2023-08-25
+
+### What's new
+
+- Added method `Measurement.name` to get humanized name of the unit group.
+- Raised `BaseError` in `Measurement.unit_group`.
+- Added aliases `in`, `as`, `in!`, `as` for `convert_to` and `convert_to!` methods.
+
+### What's changed
+
+- Moved LICENSE to markdown file.
+- Replaced `$LOAD_PATH` by shorthand `$:`
+- Replaced `base` method by `unit`.
+
+----------
+
 ## [2.6.2](https://github.com/shivam091/unit_measurements/compare/v2.6.1...v2.6.2) - 2023-08-25
 
 ### What's changed

data/Gemfile.lock

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

data/{LICENSE → LICENSE.md}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Harshal LADHE
+**Copyright (c) 2023 Harshal LADHE**
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -72,8 +72,9 @@ UnitMeasurements::Weight.new(1, :kg)
 **Converting to other units:**
 
 This gem allows you to convert among units of same unit group.
-You can convert measurement to other unit using `#convert_to` (aliased as `#to`)
-or `#convert_to!` (aliased as `#to!`) methods.
+You can convert measurement to other unit using `#convert_to`
+(aliased as `#to`, `#in`, and `as`) or `#convert_to!`
+(aliased as `#to!`, `#in!`, and `as!`) methods.
 
 You can use `#convert_to` as:
 
@@ -243,6 +244,13 @@ weight.unit
 #=> #<UnitMeasurements::Unit: kg (kilogram, kilogramme, kilogrammes, kilograms)>
 ```
 
+**See humanized name of the unit group:**
+
+```ruby
+UnitMeasurements::Weight.name
+#=> weight
+```
+
 **See all units of the unit group:**
 
 ```ruby
@@ -467,31 +475,23 @@ gem "unit_measurements", require: ["unit_measurements/base", "unit_measurements/
 ### Building new unit groups
 
 This library provides simpler way to build your own unit groups. To build new unit group,
-use `UnitMeasurements.build` in order to define base units and conversion units within it:
+use `UnitMeasurements.build` in order to define units within it:
 
-If you build unit using `base` method, base unit automatically gets set for the unit group.
+If the unit is supporting [si prefixes](#si-units-support), you can use `si_unit` method to build it.
+If you build unit using `si_unit`, the unit will be added along with all SI prefixes for it.
 
 ```ruby
 UnitMeasurements::Time = UnitMeasurements.build do
-  # Add a base unit to the group.
-  base :s, aliases: [:second, :seconds]
-
-  # Add other units to the group, along with their conversion multipliers against
-  # base unit.
-  unit :min, value: 60.0, aliases: [:minute, :minutes]
+  unit :s, aliases: [:second, :seconds]
 
-  # You can also specify conversion string if it's converted against a unit other
-  # than the unit group's base unit.
-  unit :h, value: "60 min", aliases: [:hour, :hours]
+  # Add units to the group, along with their conversion multipliers.
+  unit :min, value: "60 s", aliases: [:hour, :hours]
 
   # You can also specify unit value as an array.
-  unit :d, value: [24, :h], aliases: [:day, :days]
+  unit :h, value: [60, :min], aliases: [:day, :days]
 end
 ```
 
-If the unit is supporting [si prefixes](#si-units-support), you can use `si_unit` method to build it.
-If you build unit using `si_unit`, Base unit is automatically added to the group along with all SI prefixes for it.
-
 ```ruby
 UnitMeasurements::Time = UnitMeasurements.build do
   # Add a SI unit to the unit group
@@ -501,7 +501,7 @@ UnitMeasurements::Time = UnitMeasurements.build do
 end
 ```
 
-All units allow aliases, as long as they are unique. Unit symbol can be used to
+All units allow aliases, as long as they are unique. Unit names can be used to
 define the unit as long as it is unique. All unit names are case sensitive.
 
 ### Namespaces

data/lib/unit_measurements/measurement.rb

@@ -32,6 +32,8 @@ module UnitMeasurements
       self.class.new((quantity * conversion_factor), target_unit)
     end
     alias_method :to, :convert_to
+    alias_method :in, :convert_to
+    alias_method :as, :convert_to
 
     def convert_to!(target_unit)
       measurement = convert_to(target_unit)
@@ -40,6 +42,8 @@ module UnitMeasurements
       self
     end
     alias_method :to!, :convert_to!
+    alias_method :in!, :convert_to!
+    alias_method :as!, :convert_to!
 
     def inspect(dump: false)
       return super() if dump
@@ -64,7 +68,7 @@ module UnitMeasurements
       extend Forwardable
 
       def unit_group
-        raise "`Measurement` does not have a `unit_group` object. You cannot directly use `Measurement`. Instead, build a new unit group by calling `UnitMeasurements.build`."
+        raise BaseError, "`Measurement` does not have a `unit_group` object. You cannot directly use `Measurement`. Instead, build a new unit group by calling `UnitMeasurements.build`."
       end
 
       def_delegators :unit_group, :units, :unit_names, :unit_with_name_and_aliases,
@@ -78,6 +82,10 @@ module UnitMeasurements
         target ? _parse(source).convert_to(target) : _parse(source)
       end
 
+      def name
+        to_s.split("::").last.underscore.humanize.downcase
+      end
+
       private
 
       def _parse(string)

data/lib/unit_measurements/unit_group_builder.rb

@@ -10,10 +10,6 @@ module UnitMeasurements
       @units = []
     end
 
-    def base(name, aliases: [])
-      @units << build_unit(name, value: 1.0, aliases: aliases)
-    end
-
     def unit(name, value: 1.0, aliases: [])
       @units << build_unit(name, value: value, aliases: aliases)
     end

data/lib/unit_measurements/unit_groups/area.rb

@@ -3,7 +3,7 @@
 # -*- warn_indent: true -*-
 
 UnitMeasurements::Area = UnitMeasurements.build do
-  base :m², aliases: [:"m^2", :"sq m", :"square meter", :"square meters", :"square metre", :"square metres"]
+  unit :m², aliases: [:"m^2", :"sq m", :"square meter", :"square meters", :"square metre", :"square metres"]
 
   unit :km², value: "1e+6 m²", aliases: [:"km^2", :"sq km", :"square kilometer", :"square kilometers", :"square kilometre", :"square kilometres"]
   unit :in², value: "0.00064516 m²", aliases: [:"in^2", :"sq in", :"square inch", :"square inches"]

data/lib/unit_measurements/unit_groups/density.rb

@@ -3,7 +3,7 @@
 # -*- warn_indent: true -*-
 
 UnitMeasurements::Density = UnitMeasurements.build do
-  base :"g/m³", aliases: [:"g/m^3", :"g·m⁻³", :"gram per cubic meter", :"grams per cubic meter", :"gramme per cubic metre", :"grammes per cubic metre"]
+  unit :"g/m³", aliases: [:"g/m^3", :"g·m⁻³", :"gram per cubic meter", :"grams per cubic meter", :"gramme per cubic metre", :"grammes per cubic metre"]
 
   unit :"g/l", value: "1 kg/m³", aliases: [:"g·l⁻¹", :"gram per liter", :"grams per liter", :"gramme per litre", :"grammes per litre"]
   unit :"g/ml", value: "1000 g/l", aliases: [:"g·ml⁻¹", :"gram per milliliter", :"grams per milliliter", :"gramme per millilitre", :"grammes per millilitre"]

data/lib/unit_measurements/unit_groups/quantity.rb

@@ -3,7 +3,7 @@
 # -*- warn_indent: true -*-
 
 UnitMeasurements::Quantity = UnitMeasurements.build do
-  base :pc, aliases: [:pcs, :piece, :pieces]
+  unit :pc, aliases: [:pcs, :piece, :pieces]
 
   unit :pr, value: "2 pc", aliases: [:pair, :pairs]
   unit :dz, value: "6 pr", aliases: [:doz, :dozen, :dozens]

data/lib/unit_measurements/version.rb

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

data/unit_measurements.gemspec

@@ -3,7 +3,7 @@
 # -*- warn_indent: true -*-
 
 lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.unshift(lib) unless $:.include?(lib)
 
 require "unit_measurements/version"
 

data/units.md

@@ -4,8 +4,7 @@ As there are lots of units bundled with `unit_measurements`, we recommend you to
 bundled units before converting your measurements.
 
 **Notes:**
-1. Base unit for each unit group is highlighted.
-2. Unit names suffixed with `*` support all [SI prefixes](README.md#si-units-support).
+1. Unit names suffixed with `*` support all [SI prefixes](README.md#si-units-support).
 
 Below are the units which are bundled in the unit_measurements.
 
@@ -15,7 +14,7 @@ These units are defined in `UnitMeasurements::Length`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **m\*** | **meter, metre, meters, metres** |
+| 1 | m* | meter, metre, meters, metres |
 | 2 | in | ", inch, inches |
 | 3 | ft | ', foot, feet |
 | 4 | yd | yard, yards |
@@ -27,7 +26,7 @@ These units are defined in `UnitMeasurements::Weight`.
 
 | # | Name | Aliases |
 |--|--|--|
-| **1** | **g\*** | **gram, grams, gramme, grammes** |
+| 1 | g* | gram, grams, gramme, grammes |
 | 2 | q | quintal, quintals |
 | 3 | t | tonne, tonnes, metric tonne, metric tonnes |
 
@@ -37,7 +36,7 @@ These units are defined in `UnitMeasurements::Time`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **s\*** | **sec, second, seconds** |
+| 1 | s* | sec, second, seconds |
 | 2 | h | hr, hour, hours |
 | 3 | d | day, days |
 | 4 | wk | week, weeks |
@@ -55,7 +54,7 @@ These units are defined in `UnitMeasurements::AmountOfSubstance`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **mol\*** | **mole, moles** |
+| 1 | mol* | mole, moles |
 | 2 | NA | avogadro constant |
 
 ## 5. Electric current
@@ -64,7 +63,7 @@ These units are defined in `UnitMeasurements::ElectricCurrent`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **A\*** | **amp, ampere, amperes** |
+| 1 | A* | amp, ampere, amperes |
 | 2 | abA | abampere, abamperes |
 | 3 | Bi | biot, biots |
 | 4 | statA | statampere, statamperes |
@@ -75,7 +74,7 @@ These units are defined in `UnitMeasurements::LuminousIntensity`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **cd\*** | **candela, candelas** |
+| 1 | cd* | candela, candelas |
 | 2 | hk | hefnerkerze |
 
 ## 7. Temperature
@@ -84,7 +83,7 @@ These units are defined in `UnitMeasurements::Temperature`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **K\*** | **kelvin, kelvins** |
+| 1 | K* | kelvin, kelvins |
 | 2 | °R | R, °Ra, Ra, rankine |
 
 ## 8. Area
@@ -93,7 +92,7 @@ These units are defined in `UnitMeasurements::Area`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **m²** | **m^2, sq m, square meter, square meters, square metre, square metres** |
+| 1 | m² | m^2, sq m, square meter, square meters, square metre, square metres |
 | 2 | km² | km^2, sq km, square kilometer, square kilometers, square kilometre, square kilometres |
 | 3 | in² | in^2, sq in, square inch, square inches |
 | 4 | ft² | ft^2, sq ft, square foot, square feet |
@@ -106,7 +105,7 @@ These units are defined in `UnitMeasurements::Volume`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **l\*** | **liter, litre, liters, litres** |
+| 1 | l* | liter, litre, liters, litres |
 | 2 | m³ | m^3, cu m, cubic meter, cubic meters, cubic metre, cubic metres |
 | 3 | mm³ | mm^3, cu mm, cubic millimeter, cubic millimeters, cubic millimetre, cubic millimetres |
 | 4 | cm³ | cm^3, cu cm, cubic centimeter, cubic centimeters, cubic centimetre, cubic centimetres |
@@ -123,7 +122,7 @@ These units are defined in `UnitMeasurements::Density`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **g/m³** | **g/m^3, g·m⁻³, gram per cubic meter, grams per cubic meter, gramme per cubic metre, grammes per cubic metre** |
+| 1 | g/m³ | g/m^3, g·m⁻³, gram per cubic meter, grams per cubic meter, gramme per cubic metre, grammes per cubic metre |
 | 2 | kg/m³ | kg/m^3, kg·m⁻³, kilogram per cubic meter, kilograms per cubic meter, kilogramme per cubic metre, kilogrammes per cubic metre |
 | 3 | g/l | g·l⁻¹, gram per liter, grams per liter, gramme per litre, grammes per litre |
 | 4 | g/ml | g·ml⁻¹, gram per milliliter, grams per milliliter, gramme per millilitre, grammes per millilitre |
@@ -135,7 +134,7 @@ These units are defined in `UnitMeasurements::Quantity`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **pc** | **pcs, piece, pieces** |
+| 1 | pc | pcs, piece, pieces |
 | 2 | pr | pair, pairs |
 | 3 | gr | gross, grosses |
 | 4 | dz | doz, dozen, dozens |
@@ -147,7 +146,7 @@ These units are defined in `UnitMeasurements::SoundLevel`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **B\*** | **bel, bels** |
+| 1 | B* | bel, bels |
 | 2 | Np | neper, nepers |
 
 ## 13. Plane angle
@@ -156,7 +155,7 @@ These units are defined in `UnitMeasurements::PlaneAngle`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **rad\*** | **radian, radians** |
+| 1 | rad* | radian, radians |
 | 2 | deg | °, degree, degrees |
 | 3 | gon | ᵍ, grad, gradian, gradians |
 | 4 | cir | circle, circles |
@@ -172,7 +171,7 @@ These units are defined in `UnitMeasurements::SolidAngle`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **sr\*** | **steradian, steradians** |
+| 1 | sr* | steradian, steradians |
 | 2 | sp | spat, spats |
 | 3 | deg² | (°)², sq °, square degree, square degrees |
 | 4 | arcmin² | (′)², sq ′, square arcminute, square arcminutes |
@@ -184,7 +183,7 @@ These units are defined in `UnitMeasurements::Force`.
 
 | # | Name | Aliases |
 |:--|:--|:--|
-| **1** | **N\*** | **newton, newtons** |
+| 1 | N* | newton, newtons |
 | 2 | tf | tonne-force |
 | 3 | dyn | dyne, dynes |
 | 4 | kgf | kilogram-force, kilogramme-force |

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Harshal LADHE
@@ -99,7 +99,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/unit_measurements.rb