unit_measurements_us_complete 5.17.0

data/lib/unit_measurements/arithmetic.rb

@@ -0,0 +1,225 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  # The +UnitMeasurements::Arithmetic+ mixin module provides methods for
+  # performing arithmetic operations (addition, subtraction, multiplication,
+  # division, etc) on measurements of the same unit group. In case the
+  # measurements represents different units, the left hand side takes precedence
+  # while performing the arithmetic operation on them.
+  #
+  # This module is included in the +Measurement+ class to allow arithmetic
+  # operations on the measurements.
+  #
+  # @see Measurement
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.4.0
+  module Arithmetic
+    extend Forwardable
+
+    # Methods delegated from the Numeric.
+    def_delegators :@quantity, :zero?, :positive?, :negative?, :finite?, :infinite?
+
+    # Adds the quantity of the other measurement or a numeric value to the
+    # quantity of the current measurement.
+    #
+    # @param [Numeric|Measurement] other
+    #   The value to be added. It can be a numeric value or another measurement.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(1, "km") + UnitMeasurements::Length.new(1, "m")
+    #   => 1.001 km
+    #
+    #   UnitMeasurements::Length.new(1, "km") + 4.5
+    #   => 5.5 km
+    #
+    # @return [Measurement] A new +Measurement+ instance with the combined quantity.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.4.0
+    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.
+    #
+    # @param [Numeric|Measurement] other
+    #   The value to be subtracted. It can be a numeric value or another measurement.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(1, "km") - UnitMeasurements::Length.new(2, "in")
+    #   => 0.9999492 km
+    #
+    #   UnitMeasurements::Length.new(2, "km") - 1e+2
+    #   => -98.0 km
+    #
+    # @return [Measurement] A new +Measurement+ instance with the subtracted quantity.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.4.0
+    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.
+    #
+    # @param [Numeric|Measurement] other
+    #   The value to be multiplied. It can be a numeric value or another measurement.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(2, "km") * UnitMeasurements::Length.new(3, "in")
+    #   => 0.0001524 km
+    #
+    #   UnitMeasurements::Length.new(2, "km") * 2+2i
+    #   => 4+2i km
+    #
+    # @return [Measurement] A new +Measurement+ instance with the multiplied quantity.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.4.0
+    def *(other)
+      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.
+    #
+    # @param [Numeric|Measurement] other
+    #   The value to be divided. It can be a numeric value or another measurement.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(4, "km") / UnitMeasurements::Length.new(2, "km")
+    #   => 2 km
+    #
+    #   UnitMeasurements::Length.new(2, "km") / 2
+    #   => 1 km
+    #
+    # @return [Measurement] A new +Measurement+ instance with the divided quantity.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.4.0
+    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.
+    #
+    # When +other+ is an instance of +Measurement+, the quantity to raise
+    # is calculated by converting the +other+ measurement to the unit of the +current+
+    # measurement, and then the quantity of the +current+ measurement is raised to
+    # the converted quantity.
+    #
+    # @param [Numeric|Measurement] other
+    #   The value to be raised. It can be a numeric value or another measurement.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(2, "km") ** UnitMeasurements::Length.new(3, "m")
+    #   => 1.00208160507963279 km
+    #
+    #   UnitMeasurements::Length.new(2, "km") ** 3
+    #   => 8 km
+    #
+    #   UnitMeasurements::Length.new(8, "km") ** 1/3r
+    #   => 2 km
+    #
+    # @return [Measurement] A new +Measurement+ instance with the raised quantity.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.1.0
+    def **(other)
+      arithmetic_operation(other, :**)
+    end
+    alias_method :pow, :**
+    alias_method :^, :**
+
+    # Negates the quantity of the measurement.
+    #
+    # @example
+    #   -UnitMeasurements::Length.new(2, "km")
+    #   => -2 km
+    #
+    #   -UnitMeasurements::Length.new(-2, "km")
+    #   => 2 km
+    #
+    # @return [Measurement] A new +Measurement+ instance with the negated quantity.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.1.0
+    def -@
+      self.class.new(-self.quantity, self.unit)
+    end
+    alias_method :inverse, :-@
+    alias_method :negate, :-@
+
+    # Checks whether the quantity of the measurement is nonzero.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(2, "km").nonzero?
+    #   => true
+    #
+    #   UnitMeasurements::Length.new(0, "km").nonzero?
+    #   => false
+    #
+    # @return [TrueClass|FalseClass]
+    #   +true+ if the quantity is nonzero otherwise it returns +false+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.1.0
+    def nonzero?
+      quantity.nonzero? ? true : false
+    end
+
+    private
+
+    # @private
+    # Coerces a numeric value or another measurement for arithmetic operations.
+    #
+    # @param [Numeric|Measurement] other
+    #   The value to be coerced. It can be a numeric value or another measurement.
+    #
+    # @return [Array<Measurement>] An array containing the coerced values.
+    #
+    # @raise [TypeError]
+    #   If the coercion is not possible due to incompatible types.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.4.0
+    def coerce(other)
+      case other
+      when Numeric    then [self.class.new(other, self.unit), self]
+      when self.class then [other, self]
+      else                 raise TypeError, "Cannot coerce #{other.class} to #{self.class}"
+      end
+    end
+
+    # @private
+    # Performs an arithmetic operation (addition, subtraction, multiplication,
+    # or division) on the current measurement and another numeric value.
+    #
+    # @param [Numeric|Measurement] other
+    #   The value to be used in the arithmetic operation. It can be a numeric value
+    #   or another measurement.
+    # @param [Symbol] operator The operator to be used for the operation.
+    #
+    # @return [Measurement]
+    #   A new +Measurement+ instance with the result of the arithmetic operation.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.4.0
+    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
+end

data/lib/unit_measurements/base.rb

@@ -0,0 +1,177 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+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.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.3.0
+    attr_writer :configuration
+
+    # Creates a new unit group based on the provided +block+ of instructions.
+    #
+    # The +build+ method allows you to define and create a custom unit group with
+    # units and their conversions. It takes a block of instructions as an argument,
+    # which is evaluated by an instance of +UnitGroupBuilder+.
+    #
+    # Within the +block+, you can use various methods provided by +UnitGroupBuilder+
+    # to define units, group them into unit system, and set primitive unit of
+    # the unit group. These methods include +primitive+, +system+, +si_unit+,
+    # and +unit+.
+    #
+    # The resulting unit group is encapsulated in a new subclass of +Measurement+.
+    # This subclass will have access to the defined units and their conversions
+    # through the +unit_group+ class attribute.
+    #
+    # This method provides a powerful way to create specialized unit groups tailored
+    # to specific measurement domains.
+    #
+    # @example
+    #   UnitMeasurements.build do
+    #     primitive "m"
+    #
+    #     system :metric do
+    #       si_unit "m", aliases: ["meter", "metre", "meters", "metres"]
+    #     end
+    #
+    #     system :imperial do
+    #       unit "in", value: "25.4 mm", aliases: ['"', "inch", "inches"]
+    #     end
+    #
+    #     cache "length.json"
+    #   end
+    #
+    # @yield [builder]
+    #   A block that defines the units to be added to the unit group.
+    #   The block takes a {UnitGroupBuilder} instance as a parameter.
+    #
+    # @yieldparam builder [UnitGroupBuilder]
+    #   The {UnitGroupBuilder} instance to define units within the unit group.
+    #
+    # @yieldreturn [UnitGroup]
+    #   Returns an instance of {UnitGroup} containing the units and their conversions
+    #   defined within the block.
+    #
+    # @return [Class]
+    #   A new subclass of +Measurement+ with the defined units and conversions.
+    #
+    # @see Unit
+    # @see UnitGroup
+    # @see UnitGroupBuilder
+    # @see Measurement
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    def build(&block)
+      builder = UnitGroupBuilder.new
+      builder.instance_eval(&block)
+
+      Class.new(Measurement) do
+        class << self
+          attr_reader :unit_group
+        end
+
+        @unit_group = builder.build
+      end
+    end
+
+    # Returns an instance of +Configuration+ with the values of desired configurable
+    # options of +*unit_measurements*+. If instance is not present, it initializes
+    # a new instance of {Configuration}.
+    #
+    # @return [Configuration] An instance of +Configuration+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.3.0
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Reset the configuration to its default state.
+    #
+    # @example
+    #   UnitMeasurements.reset
+    #
+    # @return [Configuration] A new +Configuration+ object.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.3.0
+    def reset
+      @configuration = Configuration.new
+    end
+
+    # Configures options of the +*UnitMeasurements*+ module using a block. It
+    # yields the current +Configuration+ instance for updating default values of
+    # options by new values specified within a block.
+    #
+    # @example
+    #   UnitMeasurements.configure do |config|
+    #     config.use_cache = false
+    #   end
+    #
+    # @yield [configuration] The current +Configuration+ instance.
+    #
+    # @yieldparam [Configuration] configuration
+    #   An instance of +Configuration+ with the new values of options.
+    #
+    # @yieldreturn [Configuration] The updated +Configuration+ instance.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.3.0
+    def configure
+      yield configuration
+    end
+  end
+end
+
+# The following requires load various components of the unit measurements library.
+require "unit_measurements/extras/numeric_methods"
+require "unit_measurements/extras/conversion_methods"
+
+require "unit_measurements/configuration"
+require "unit_measurements/cache"
+require "unit_measurements/unit_group_builder"
+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"
+require "unit_measurements/formatter"
+require "unit_measurements/measurement"
+
+require "unit_measurements/errors/unit_error"
+require "unit_measurements/errors/parse_error"
+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/cache.rb

@@ -0,0 +1,173 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  # The +UnitMeasurements::Cache+ class manages caching of conversion factors
+  # between different units within a unit group. It provides methods to retrieve,
+  # set, and clear cached conversion factors.
+  #
+  # Cached conversion factors are stored in JSON file on the file system.
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 5.2.0
+  class Cache
+    # The directory path where cache files are stored.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    CACHE_DIRECTORY = File.expand_path(File.join("..", "..", "cache"), __dir__).freeze
+
+    # Stores cached conversion factors between different units within a unit
+    # group.
+    #
+    # @return [Hash] The cached conversion factors.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    attr_reader :cached_data
+
+    # Initializes a new +Cache+ instance for a specific unit group.
+    #
+    # Initialization first ensures existence of the cache directory. If the cache
+    # directory does not exist, it gets created.
+    #
+    # @param [UnitGroup] unit_group The unit group associated with the cache.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    def initialize(unit_group)
+      ensure_cache_directory_exists
+      @cache_file = build_cache_file_path(unit_group)
+      @cached_data ||= load_cache
+    end
+
+    # Retrieves the conversion factor between source and target units from the
+    # cache.
+    #
+    # @param [String] source_unit The source unit name.
+    # @param [String] target_unit The target unit name.
+    #
+    # @return [Numeric|NilClass]
+    #   The conversion factor, or +nil+ if not found in the cache.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    def get(source_unit, target_unit)
+      cached_data.dig(source_unit, target_unit)
+    end
+
+    # Sets the conversion factor between source and target units in the cache.
+    #
+    # @param [String] source_unit The source unit name.
+    # @param [String] target_unit The target unit name.
+    # @param [Numeric] conversion_factor The conversion factor.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    def set(source_unit, target_unit, conversion_factor)
+      cached_data[source_unit] ||= {}
+      cached_data[source_unit][target_unit] = conversion_factor
+
+      store_cache
+    end
+
+    # Clears the entire cache.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    def clear_cache
+      @cached_data = {}
+      store_cache
+    end
+
+    private
+
+    # @private
+    # Loads the cache from the cache file.
+    #
+    # @return [Hash] The loaded cache data.
+    #
+    # @raise [Errno::ENOENT] If the cache file does not exist.
+    # @raise [Errno::EACCES]
+    #   If the cache file cannot be accessed due to insufficient permissions.
+    # @raise [JSON::ParserError] If there's an error parsing the cache file.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    def load_cache
+      return {} unless File.exist?(@cache_file)
+
+      begin
+        File.open(@cache_file, "r") { |file| JSON.load(file.read) }
+      rescue Errno::ENOENT, Errno::EACCES, JSON::ParserError => e
+        puts "Error loading cache"
+        {}
+      end
+    end
+
+    # @private
+    # Stores the current cache data to the cache file. +cached_data+ is stored in
+    # prettier form.
+    #
+    # @raise [Errno::ENOENT] If the cache file does not exist.
+    # @raise [Errno::EACCES]
+    #   If the cache file cannot be accessed due to insufficient permissions.
+    # @raise [Errno::ENOSPC]
+    #   If there's not enough space to write to the cache file.
+    # @raise [JSON::GeneratorError] If there's an error generating JSON data.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    def store_cache
+      begin
+        File.open(@cache_file, "w") do |file|
+          file.write(JSON.pretty_generate(cached_data))
+        end
+      rescue Errno::ENOENT, Errno::EACCES, Errno::ENOSPC, JSON::GeneratorError => e
+        puts "Error saving cache: #{e.message}"
+      end
+    end
+
+    # @private
+    # Ensures that the cache directory exists. If the cache directory does not
+    # exist, it gets created.
+    #
+    # @raise [Errno::EEXIST] If the cache directory already exists.
+    # @raise [Errno::EACCES]
+    #   If the cache directory cannot be accessed due to insufficient permissions.
+    # @raise [Errno::ENOSPC]
+    #   If there's not enough space to create the cache directory.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    def ensure_cache_directory_exists
+      begin
+        Dir.mkdir(CACHE_DIRECTORY) unless Dir.exist?(CACHE_DIRECTORY)
+      rescue Errno::EACCES, Errno::ENOSPC => e
+        puts "Error creating cache directory: #{e.message}"
+      end
+    end
+
+    # @private
+    # Builds and returns an absolute path of the cache file.
+    #
+    # This method first checks if the cache file name is specified for the unit
+    # group. If yes, it builds absolute path of the cache file using specified
+    # cache file name. If not, it builds file name from of the name of the unit
+    # group. This file name is then used to build absolute path of the cache file.
+    #
+    # @param [UnitGroup] unit_group The unit group associated with the cache.
+    #
+    # @return [String] An absolute path of the cache file.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.2.0
+    def build_cache_file_path(unit_group)
+      cache_file_name = unit_group.cache_file || unit_group.to_s.split("::").last.underscore
+      cache_file_name = File.basename(cache_file_name, ".json") + ".json"
+
+      Pathname.new(File.join(CACHE_DIRECTORY, cache_file_name)).cleanpath
+    end
+  end
+end

data/lib/unit_measurements/comparison.rb

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  # The +UnitMeasurements::Comparison+ mixin module is included in measurement
+  # classes to enable comparison operations (e.g., less than, equal to, greater
+  # than, etc.) between two measurements of the same unit group.
+  #
+  # This module is included in the +Measurement+ class to allow comparison of two
+  # measurements.
+  #
+  # @see Measurement
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.3.0
+  module Comparison
+    include Comparable
+
+    # This method is used to compare the quantity of two measurements. It
+    # implements the comparison logic based on the +<=>+ method defined in the
+    # +Comparable+ module.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(1, "km") == UnitMeasurements::Length.new(1, :km)
+    #   => true
+    #
+    #   UnitMeasurements::Length.parse("1 km") == UnitMeasurements::Length.parse("1000 m")
+    #   => true
+    #
+    #   UnitMeasurements::Length.parse("1 km") != UnitMeasurements::Length.parse("1 m")
+    #   => true
+    #
+    #   UnitMeasurements::Length.parse("1 km") < UnitMeasurements::Length.parse("0.5 km")
+    #   => false
+    #
+    #   UnitMeasurements::Length.parse("1 km") > UnitMeasurements::Length.parse("0.5 km")
+    #   => true
+    #
+    #   UnitMeasurements::Length.parse("1 km") <= UnitMeasurements::Length.parse("0.5 km")
+    #   => false
+    #
+    #   UnitMeasurements::Length.parse("1 km") >= UnitMeasurements::Length.parse("0.5 km")
+    #   => true
+    #
+    #   UnitMeasurements::Length.new(1, "ft").between?(UnitMeasurements::Length.new(12, "in"), UnitMeasurements::Length.new(24, "in"))
+    #   => true
+    #
+    # @param [Measurement] object The measurement instance to compare with.
+    #
+    # @return
+    #   +nil+ if the comparison is not possible (e.g., if the +object+ is not of
+    #   the same unit group). A negative integer if +self+ is less than +object+.
+    #   +Zero+ if self is equal to +object+. A positive integer if +self+ is
+    #   greater than +object+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.3.0
+    def <=>(object)
+      return nil unless object.is_a?(self.class)
+
+      quantity <=> object.convert_to(unit.name).quantity
+    end
+  end
+end

data/lib/unit_measurements/configuration.rb

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_stringing_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  # The +UnitMeasurements::Configuration+ class maintains and manages the globally
+  # configurable options of +*unit_measurements*+.
+  #
+  # @note
+  #   This class is responsible for configuring globally configurable options of
+  #   +*unit_measurements*+.
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 5.3.0
+  class Configuration
+    # Get the current value of the +use_cache+ option.
+    #
+    # @note
+    #   This option controls whether caching is enabled for converting measurements.
+    #   Defaults to +false+.
+    #
+    # @return [TrueClass|FalseClass]
+    #   Returns +true+ if caching is enabled, otherwise +false+.
+    #
+    # @see Cache
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.3.0
+    attr_reader :use_cache
+
+    # Initializes a new +Configuration+ instance with default values of configurable
+    # options.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.3.0
+    def initialize
+      self.use_cache = false
+    end
+
+    # Sets a value for the +use_cache+ option.
+    #
+    # It controls whether caching is enabled for converting measurements. When
+    # caching is enabled, previously computed conversion factors are stored for
+    # future use, improving conversion performance.
+    #
+    # @param [TrueClass|FalseClass] use_cache
+    #   +true+ if caching should be used while converting the measurement otherwise
+    #   +false+.
+    #
+    # @return [TrueClass|FalseClass] The updated value of +use_cache+.
+    #
+    # @raise [BaseError] if +use_cache+ is not a boolean value.
+    #
+    # @see Cache
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 5.3.0
+    def use_cache=(use_cache)
+      unless [true, false].include?(use_cache)
+        raise ArgumentError, "Configuration#use_cache= only accepts true or false, but received #{use_cache}"
+      end
+
+      @use_cache = use_cache
+    end
+  end
+end