unit_measurements 5.11.0 → 5.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca26bc8965c93c692a72e788ab2577f2bad297909372a72d3cc2fec93a45b5bd
-  data.tar.gz: 581d716cb56cf59c89eeb69d01095c4c0c14054006dc6bb0822580e3d6750ffd
+  metadata.gz: e01978467f274548e8cf792d9b7bfe26ab85155a2c099482cb8b4017641ed900
+  data.tar.gz: d09990112a19291527059e822906a802a051541b654babad13e97110c5557dea
 SHA512:
-  metadata.gz: ed994225ecb853f8ce577e0b53a863b0f091980ee33f054b50f69d156ad0a7e393a4a59d962d665aa52fa6cdc077f19f42bc27d0b1d8e7413f359dbde8e6a9fb
-  data.tar.gz: 889e45c784390c89a46079067ca9493253e638b1117ee88c16c5ab2ed60db89a855a11bf487f2a6536b1729a2704983fbfcb5fa60959a2b8eed79dae4957d920
+  metadata.gz: 0faa94f0a962f19134ff58276c6c876a30a81817172039c4261eaa9a15eeb61dd7047f61b96168c2115c4ba40711fee42cb4ceb832c6e6640bd9c8e7e0f4343b
+  data.tar.gz: d9213995299feeb51dda98cc4dbbd3bd76f6c4782a8e04b9612cc7f3134b192c74aa80b027779c1b8c862358a84a8c40469753a086ceb94fd5b5ee2b8d33e973

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## [5.12.0](https://github.com/shivam091/unit_measurements/compare/v5.11.1...v5.12.0) - 2023-11-25
+
+### What's new
+
+- Added `MissingPrimitiveUnitError` error if user tries to convert measurement to
+  the primitive unit but it's not set for the unit group.
+- Aliased `#+` method as `#add`.
+- Aliased `#-` method as `#subtract`.
+- Aliased `#*` method as `#times` and `#multiply`.
+- Aliased `#/` method as `#divide`.
+
+----------
+
+## [5.11.1](https://github.com/shivam091/unit_measurements/compare/v5.11.0...v5.11.1) - 2023-11-16
+
+### What's changed
+
+- Moved `BaseError` to base file for removing uninitialized constant error in reverse dependencies viz.
+[unit_measurements-rails](https://rubygems.org/gems/unit_measurements-rails) and
+[composite_unit_measurements](https://rubygems.org/gems/composite_unit_measurements).
+
+----------
+
 ## [5.11.0](https://github.com/shivam091/unit_measurements/compare/v5.10.0...v5.11.0) - 2023-11-11
 
 ### What's new

data/Gemfile.lock

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

data/lib/unit_measurements/arithmetic.rb

@@ -41,6 +41,7 @@ module UnitMeasurements
     def +(other)
       arithmetic_operation(other, :+)
     end
+    alias_method :add, :+
 
     # Subtracts the quantity of the other measurement or a numeric value from the
     # quantity of the current measurement.
@@ -62,6 +63,7 @@ module UnitMeasurements
     def -(other)
       arithmetic_operation(other, :-)
     end
+    alias_method :subtract, :-
 
     # Multiplies the quantity of the current measurement by the quantity of the
     # other measurement or a numeric value.
@@ -84,6 +86,8 @@ module UnitMeasurements
       arithmetic_operation(other, :*)
     end
     alias_method :scale, :*
+    alias_method :times, :*
+    alias_method :multiply, :*
 
     # Divides the quantity of the current measurement by the quantity of the other
     # measurement or a numeric value.
@@ -105,6 +109,7 @@ module UnitMeasurements
     def /(other)
       arithmetic_operation(other, :/)
     end
+    alias_method :divide, :/
 
     # Raises the quantity of the current measurement to the power of the quantity of
     # the other measurement or numeric value.

data/lib/unit_measurements/base.rb

@@ -5,7 +5,28 @@
 require "active_support/all"
 require "unit_measurements/version"
 
+# The +UnitMeasurements+ module serves as a container for various functionalities
+# related to unit measurements. It provides methods for creating custom unit
+# groups, defining units, performing arithmetic operations,  comparison between
+# measurements, conversions, normalization of input strings, parsing measurements
+# from strings, and more. It is a fundamental part of the unit measurements library.
+#
+# @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+# @since 0.1.0
 module UnitMeasurements
+  # This is the base class for custom errors in the +UnitMeasurements+ module.
+  #
+  # @see UnitError
+  # @see ParseError
+  # @see BlankUnitError
+  # @see BlankQuantityError
+  # @see UnitAlreadyDefinedError
+  # @see MissingPrimitiveUnitError
+  # @see PrimitiveUnitAlreadySetError
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.1.0
+  class BaseError < StandardError; end
+
   class << self
     # Allows setting an instance of +Configuration+ containing values of desired
     # configurable options.
@@ -150,3 +171,4 @@ require "unit_measurements/errors/unit_already_defined_error"
 require "unit_measurements/errors/primitive_unit_already_set_error"
 require "unit_measurements/errors/blank_quantity_error"
 require "unit_measurements/errors/blank_unit_error"
+require "unit_measurements/errors/missing_primitive_unit_error"

data/lib/unit_measurements/errors/missing_primitive_unit_error.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  # The +UnitMeasurements::MissingPrimitiveUnitError+ class represents an error
+  # that occurs when the primitive unit is not set for a unit group.
+  #
+  # This error is raised when a user attempts to convert a measurement to the
+  # primitive unit of a unit group that does not have a primitive unit defined.
+  #
+  # @see BaseError
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 5.12.0
+  class MissingPrimitiveUnitError < BaseError
+    # Initializes a new +MissingPrimitiveUnitError+ instance.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.12.0
+    def initialize
+      super("The primitive unit is not set for the unit group.")
+    end
+  end
+end

data/lib/unit_measurements/measurement.rb

@@ -147,11 +147,17 @@ module UnitMeasurements
     #   A new +Measurement+ instance with the converted +quantity+ and
     #   +target unit+.
     #
+    # @raise [MissingPrimitiveUnitError]
+    #   if primitive unit is not set for the unit group.
+    #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 1.0.0
     def convert_to(target_unit, use_cache: false)
       target_unit = if target_unit.to_s.eql?("primitive")
-        self.class.unit_group.primitive
+        primitive_unit = self.class.primitive
+
+        raise MissingPrimitiveUnitError if primitive_unit.nil?
+        primitive_unit
       else
         unit_from_unit_or_name!(target_unit)
       end
@@ -474,7 +480,7 @@ module UnitMeasurements
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
     # @since 1.0.0
     def unit_from_unit_or_name!(value)
-      value.is_a?(Unit) ? value : self.class.send(:unit_group).unit_for!(value)
+      value.is_a?(Unit) ? value : self.class.unit_for!(value)
     end
 
     # Calculates the conversion factor between the current unit and the target

data/lib/unit_measurements/version.rb

@@ -4,5 +4,5 @@
 
 module UnitMeasurements
   # Current stable version.
-  VERSION = "5.11.0"
+  VERSION = "5.12.0"
 end

data/lib/unit_measurements.rb

@@ -2,26 +2,6 @@
 # -*- frozen_string_literal: true -*-
 # -*- warn_indent: true -*-
 
-# The +UnitMeasurements+ module serves as a container for various functionalities
-# related to unit measurements. It provides methods for creating custom unit
-# groups, defining units, performing arithmetic operations,  comparison between
-# measurements, conversions, normalization of input strings, parsing measurements
-# from strings, and more. It is a fundamental part of the unit measurements library.
-#
-# @author {Harshal V. Ladhe}[https://shivam091.github.io/]
-# @since 0.1.0
-module UnitMeasurements
-  # This is the base class for custom errors in the +UnitMeasurements+ module.
-  #
-  # @see ParseError
-  # @see PrimitiveUnitAlreadySetError
-  # @see UnitAlreadyDefinedError
-  # @see UnitError
-  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
-  # @since 1.1.0
-  class BaseError < StandardError; end
-end
-
 require "unit_measurements/base"
 
 require "unit_measurements/unit_groups/all"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements
 version: !ruby/object:Gem::Version
-  version: 5.11.0
+  version: 5.12.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-11 00:00:00.000000000 Z
+date: 2023-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,6 +113,7 @@ files:
 - lib/unit_measurements/conversion.rb
 - lib/unit_measurements/errors/blank_quantity_error.rb
 - lib/unit_measurements/errors/blank_unit_error.rb
+- lib/unit_measurements/errors/missing_primitive_unit_error.rb
 - lib/unit_measurements/errors/parse_error.rb
 - lib/unit_measurements/errors/primitive_unit_already_set_error.rb
 - lib/unit_measurements/errors/unit_already_defined_error.rb