unit_measurements 4.9.0 → 4.11.0

data/lib/unit_measurements/unit.rb

@@ -5,9 +5,54 @@
 require "set"
 
 module UnitMeasurements
+  # The +UnitMeasurements::Unit+ class represents a unit of measurement and
+  # provides methods to interact with its properties and conversion factors.
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.0.0
   class Unit
-    attr_reader :name, :value, :aliases, :system, :unit_group
+    # The name of the unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    attr_reader :name
 
+    # The conversion value of the unit. It can be a numeric value or a string in
+    # the form of a number followed by a unit name (e.g., “10 m”).
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    attr_reader :value
+
+    # A set of alternative names for the unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    attr_reader :aliases
+
+    # The system to which the unit belongs (e.g., “metric”, “imperial”).
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 4.0.0
+    attr_reader :system
+
+    # The unit group to which the unit belongs.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    attr_reader :unit_group
+
+    # Initializes a new +Unit+ instance.
+    #
+    # @param [String|Symbol] name The name of the unit.
+    # @param [String|Numeric] value The conversion value of the unit.
+    # @param [Array<String|Symbol>] aliases Alternative names for the unit.
+    # @param [String|Symbol|NilClass] system The system to which the unit belongs.
+    # @param [UnitGroup|NilClass] unit_group The unit group to which the unit belongs.
+    #
+    # @see UnitGroup
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def initialize(name, value:, aliases:, system:, unit_group: nil)
       @name = name.to_s.freeze
       @value = value
@@ -16,6 +61,19 @@ module UnitMeasurements
       @unit_group = unit_group
     end
 
+    # Returns a new +Unit+ instance with specified attributes.
+    #
+    # @param [String|Symbol] name The new name of the unit.
+    # @param [String|Numeric] value The new conversion value of the unit.
+    # @param [Set<String>] aliases New alternative names for the unit.
+    # @param [String|Symbol|NilClass] system The new system to which the unit belongs.
+    # @param [UnitGroup|NilClass] unit_group The new unit group to which the unit belongs.
+    #
+    # @return [Unit] A new unit with specified parameters.
+    #
+    # @see UnitGroup
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def with(name: nil, value: nil, aliases: nil, system: nil, unit_group: nil)
       self.class.new(
         (name || self.name),
@@ -26,19 +84,58 @@ module UnitMeasurements
       )
     end
 
+    # Returns an array containing the name of the unit and its aliases, sorted
+    # alphabetically.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(1, "m").unit.names
+    #   => ["m", "meter", "meters", "metre", "metres"]
+    #
+    # @return [Array<String>] An array of unit names.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def names
       (aliases + [name]).sort.freeze
     end
 
+    # Returns the name of the unit as a string.
+    #
+    # @example
+    #   UnitMeasurements::Length.new(1, "m").unit.to_s
+    #   => "m"
+    #
+    # @return [String] The name of the unit.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def to_s
       name
     end
 
+    # Returns an object representation of the unit, including its aliases if present.
+    #
+    # @return [Object] An object representation of the +unit+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def inspect
       aliases = "(#{@aliases.join(", ")})" if @aliases.any?
       "#<#{self.class.name}: #{name} #{aliases}>"
     end
 
+    # Calculates the conversion factor for the unit. This method is recursively
+    # invoked to calculate the conversion factor of the unit, if unit conversion
+    # +value+ is specified with respect to the other unit.
+    #
+    # This method uses +parse_value+ method to extract the conversion value and
+    # the unit.
+    #
+    # @return [Numeric] The conversion factor as a numeric value.
+    #
+    # @see #parse_value
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def conversion_factor
       return value if value.is_a?(Numeric)
 
@@ -50,6 +147,10 @@ module UnitMeasurements
 
     private
 
+    # Decimal prefixes for SI units.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     SI_DECIMAL_PREFIXES = [
       ["q",  %w(quecto),    1e-30],
       ["r",  %w(ronto),     1e-27],
@@ -77,6 +178,32 @@ module UnitMeasurements
       ["Q",  %w(quetta),    1e+30]
     ].map(&:freeze).freeze
 
+    # Parses tokens and returns a +conversion value+ and the +unit+.
+    #
+    # This method is used internally to parse the conversion value of the unit
+    # while calculating the conversion factor. It handles cases where the value
+    # can be provided as a string or an array containing a number and a unit.
+    #
+    # For example, if the value is provided as a string in the form of "10 m",
+    # it will be parsed to return 10.0 as the conversion value and "m" as the
+    # unit.
+    #
+    # This method returns conversion value in +rational+ number to avoid precision
+    # errors and frozen string of unit name.
+    #
+    # @param [String|Array] tokens
+    #   The value to be parsed. It can be either a string or an array containing
+    #   a number and a unit.
+    #
+    # @return [Array<Numeric, String>] The array of conversion value and the unit.
+    #
+    # @raise [BaseError]
+    #   if +tokens+ is not an instance of +Array+ or +String+, or +tokens+ array
+    #   contains more than two elements.
+    #
+    # @see #conversion_factor
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.2.0
     def parse_value(tokens)
       case tokens
       when String

data/lib/unit_measurements/unit_group.rb

@@ -3,18 +3,89 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
+  # The +UnitMeasurements::UnitGroup+ class provides a collection of units with
+  # methods to retrieve units by name, check if a unit is defined, and much more.
+  #
+  # It serves as a container for organizing and working with units within the
+  # unit group.
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.0.0
   class UnitGroup
-    attr_reader :primitive, :units
+    # The primitive unit of the unit group.
+    #
+    # @example
+    #   UnitMeasurements::Length.primitive
+    #   => #<UnitMeasurements::Unit: m (meter, meters, metre, metres)>
+    #
+    # @return [Unit] The primitive unit of the unit group.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    attr_reader :primitive
 
+    # An array of units within the unit group.
+    #
+    # @example
+    #   UnitMeasurements::Length.units
+    #   => [#<UnitMeasurements::Unit: m (meter, meters, metre, metres)>, ...]
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    attr_reader :units
+
+    # Initializes a new +UnitGroup+ instance.
+    #
+    # @param [String|Symbol, optional] primitive The name of the primitive unit.
+    # @param [Array<Unit>] units An array of +Unit+ instances.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def initialize(primitive, units)
       @units = units.map { |unit| unit.with(unit_group: self) }
       @primitive = unit_for!(primitive) if primitive
     end
 
+    # Returns the unit instance for a given unit name. It returns +nil+ if unit
+    # is not defined within the unit group.
+    #
+    # @example
+    #   UnitMeasurements::Length.unit_for("m")
+    #   => #<UnitMeasurements::Unit: m (meter, meters, metre, metres)>
+    #
+    #   UnitMeasurements::Length.unit_for("z")
+    #   => nil
+    #
+    # @param [String|Symbol] name The name of the unit.
+    #
+    # @return [Unit|NilClass] A +Unit+ instance or +nil+ if the unit is not found.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def unit_for(name)
       unit_name_to_unit(name)
     end
 
+    # This method works same as +unit_for+ but it raises +UnitError+ if the
+    # unit is not defined within the unit group.
+    #
+    # @example
+    #   UnitMeasurements::Length.unit_for!("m")
+    #   => #<UnitMeasurements::Unit: m (meter, meters, metre, metres)>
+    #
+    #   UnitMeasurements::Length.unit_for!("z")
+    #   => Invalid unit: 'z'. (UnitMeasurements::UnitError)
+    #
+    # @param [String|Symbol] name The name of the unit to look for.
+    #
+    # @return [Unit] A +Unit+ instance.
+    #
+    # @raise [UnitError] If the unit is not found.
+    #
+    # @see #unit_for
+    # @see UnitError
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def unit_for!(name)
       unit = unit_for(name)
       raise UnitError, name unless unit
@@ -23,32 +94,110 @@ module UnitMeasurements
     end
     alias_method :[], :unit_for!
 
-    def unit_with_name_and_aliases
-      units.each_with_object({}) do |unit, hash|
-        unit.names.each { |name| hash[name.to_s] = unit }
-      end
-    end
-
+    # Returns an array of names of all the units defined within the unit group,
+    # sorted alphabetically.
+    #
+    # @example
+    #   UnitMeasurements::Length.unit_names
+    #   => ["ft", "in", "m", "mi", "yd"]
+    #
+    # @return [Array<String>] An array of unit names.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def unit_names
       units.map(&:name).sort
     end
 
+    # Returns an array of names and aliases of all the units defined within the
+    # unit group, sorted alphabetically.
+    #
+    # @example
+    #   UnitMeasurements::Length.unit_names_with_aliases
+    #   => ["\"", "'", "feet", "foot", "ft", "in", "inch", "inches", "m", "meter", "meters", "metre", "metres", "mi", "mile", "miles", "yard", "yards", "yd"]
+    #
+    # @return [Array<String>] An array of unit names and aliases.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def unit_names_with_aliases
       units.flat_map(&:names).sort
     end
 
-    def unit_name_to_unit(name)
-      unit_with_name_and_aliases[name.to_s]
-    end
-
+    # Checks if a unit with a given name is defined within the unit group.
+    #
+    # @example
+    #   UnitMeasurements::Length.defined?("m")
+    #   => true
+    #
+    #   UnitMeasurements::Length.defined?("metre")
+    #   => false
+    #
+    # @param [String|Symbol] name The name of the unit to look for.
+    #
+    # @return [TrueClass|FalseClass] +true+
+    #   if the unit is defined, +false+ otherwise.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def defined?(name)
       unit = unit_for(name)
 
       unit ? unit.name == name.to_s : false
     end
 
+    # Checks if a given name corresponds to a defined unit or an alias of any
+    # defined unit.
+    #
+    # @example
+    #   UnitMeasurements::Length.unit_or_alias?("m")
+    #   => true
+    #
+    #   UnitMeasurements::Length.unit_or_alias?("metre")
+    #   => true
+    #
+    # @param [String|Symbol] name The name or alias of the unit to look for.
+    #
+    # @return [TrueClass|FalseClass] +true+
+    #   if the name corresponds to a unit or alias, +false+ otherwise.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def unit_or_alias?(name)
       !!unit_for(name)
     end
+
+    private
+
+    # @private
+    # Returns a hash where keys are unit names (including aliases) and values
+    # are corresponding +Unit+ instances.
+    #
+    # @example
+    #   UnitMeasurements::Length.unit_with_name_and_aliases
+    #   => {"m"=>#<UnitMeasurements::Unit: m (meter, meters, metre, metres)>, ...}
+    #
+    # @return [Hash] A hash containing unit +names+ as keys and +Unit+ objects as values.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    def unit_with_name_and_aliases
+      units.each_with_object({}) do |unit, hash|
+        unit.names.each { |name| hash[name.to_s] = unit }
+      end
+    end
+
+    # @private
+    # Returns the +Unit+ instance for a given unit name.
+    #
+    # @param [String|Symbol] name The name of the unit.
+    #
+    # @return [Unit|NilClass] A +Unit+ instance or +nil+ if the unit is not found.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    def unit_name_to_unit(name)
+      unit_with_name_and_aliases[name.to_s]
+    end
   end
 end

data/lib/unit_measurements/unit_group_builder.rb

@@ -3,25 +3,101 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
+  # The +UnitMeasurements::UnitGroupBuilder+ class provides a flexible and
+  # configurable way to define units and create unit groups with specific systems
+  # and primitive unit.
+  #
+  # It provides methods like +primitive+, +system+, +unit+, and +si_unit+ to define
+  # units and their conversions within the unit group.
+  #
+  # @see UnitGroup
+  # @see PrimitiveUnitAlreadySetError
+  # @see UnitAlreadyDefinedError
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.0.0
   class UnitGroupBuilder
+    # An array to store the units defined using the builder.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     attr_reader :units
 
+    # Initializes a new +UnitGroupBuilder+ instance.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def initialize
       @units = []
     end
 
+    # Defines a +unit+ and adds it to the list of units.
+    #
+    # @example
+    #   unit "in", value: "25.4 mm", aliases: ['"', "inch", "inches"]
+    #
+    # @param [String|Symbol] name The name of the unit.
+    # @param [Numeric|String] value The conversion value of the unit.
+    # @param [Array<String|Symbol>, optional] aliases An array of alternative names for the unit.
+    #
+    # @return [Unit] An instance of +Unit+.
+    #
+    # @see #build_unit
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def unit(name, value: 1.0, aliases: [])
       @units << build_unit(name, value: value, aliases: aliases)
     end
 
+    # Builds a set of +SI units+ and adds them to the list of units. This method
+    # defines unit defined using +name+ along with all the SI prefixes.
+    #
+    # @example
+    #   si_unit "m", aliases: ["meter", "metre", "meters", "metres"]
+    #
+    # @param [String|Symbol] name The name of the unit.
+    # @param [Numeric|String] value The conversion value of the unit.
+    # @param [Array<String|Symbol>, optional] aliases An array of alternative names for the unit.
+    #
+    # @return [Array<Unit>] An array of +Unit+ instances.
+    #
+    # @see #build_si_units
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def si_unit(name, value: 1.0, aliases: [])
       @units += build_si_units(name, value: value, aliases: aliases)
     end
 
+    # Constructs and returns a +UnitGroup+ object based on the units defined
+    # using the builder.
+    #
+    # @return [UnitGroup]
+    #   An instance of +UnitGroup+ containing units and their conversions.
+    #
+    # @see UnitGroup
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def build
       UnitGroup.new(@primitive, @units)
     end
 
+    # Defines the +unit system+ within the unit group and evaluates the provided
+    # block in the context of the builder.
+    #
+    # This method is used to group multiple units within the certain unit system,
+    # viz., metric, imperial, etc.
+    #
+    # @example Defining an imperial system with inches and feet:
+    #   system :imperial do
+    #     unit "in", value: "25.4 mm", aliases: ['"', "inch", "inches"]
+    #     unit "ft", value: "12 in", aliases: ["'", "foot", "feet"]
+    #   end
+    #
+    # @param [String|Symbol] system_name
+    #   The name of the unit system in which the units are to be grouped.
+    # @param block A block of code to be executed in the context of the builder.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 4.0.0
     def system(system_name, &block)
       @system = system_name
       instance_eval(&block) if block_given?
@@ -29,6 +105,20 @@ module UnitMeasurements
       @system = nil
     end
 
+    # Sets the +primitive+ unit for the unit group. It raises +PrimitiveUnitAlreadySetError+
+    # if the primitive unit has already been set for the unit group.
+    #
+    # @example
+    #   primitive "m"
+    #
+    # @param [String|Symbol] primitive The name of the primitive unit.
+    #
+    # @raise [PrimitiveUnitAlreadySetError]
+    #   If the primitive unit has already been set for the unit group.
+    #
+    # @see PrimitiveUnitAlreadySetError
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 4.0.0
     def primitive(primitive)
       raise PrimitiveUnitAlreadySetError if @primitive
 
@@ -37,6 +127,20 @@ module UnitMeasurements
 
     private
 
+    # @private
+    # Builds an array of +Unit+ instances with one instance of +Unit+ with name
+    # +name+ along with all SI prefixed +Unit+ instances for it.
+    #
+    # @param [String|Symbol] name The name of the unit.
+    # @param [Numeric|String] value The conversion value of the unit.
+    # @param [Array<String|Symbol>, optional] aliases
+    #   An array of alternative names for the unit.
+    #
+    # @return [Array<Unit>] An array of +Unit+ instances.
+    #
+    # @see #build_unit
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def build_si_units(name, value:, aliases:)
       si_units = [build_unit(name, value: value, aliases: aliases)]
 
@@ -50,6 +154,19 @@ module UnitMeasurements
       si_units
     end
 
+    # @private
+    # Builds an instance of +Unit+ with name +name+, and specified conversion
+    # value, and alternate names.
+    #
+    # @param [String|Symbol] name The name of the unit.
+    # @param [Numeric|String] value The conversion value of the unit.
+    # @param [Array<String|Symbol>, optional] aliases
+    #   An array of alternative names for the unit.
+    #
+    # @return [Unit] An instance of +Unit+.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def build_unit(name, value:, aliases:)
       unit = Unit.new(name, value: value, aliases: aliases, system: @system)
       check_for_duplicate_unit_names!(unit)
@@ -57,6 +174,22 @@ module UnitMeasurements
       unit
     end
 
+    # @private
+    # Checks for duplicate unit names within the list of units.
+    #
+    # This method ensures that there are no duplicate unit names within the list
+    # of units. If a duplicate name is found, it raises a +UnitAlreadyDefinedError+.
+    #
+    # This method is used internally by the +UnitGroupBuilder+ class to build units
+    # and handle unit definitions.
+    #
+    # @param [Unit] unit The unit to be checked.
+    #
+    # @raise [UnitAlreadyDefinedError]
+    #   If the unit name is already defined in the list of units.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
     def check_for_duplicate_unit_names!(unit)
       names = @units.flat_map(&:names)
 

data/lib/unit_measurements/unit_groups/length.rb

@@ -13,6 +13,17 @@ UnitMeasurements::Length = UnitMeasurements.build do
     unit "in", value: "25.4 mm", aliases: ['"', "inch", "inches"]
     unit "ft", value: "12 in", aliases: ["'", "foot", "feet"]
     unit "yd", value: "3 ft", aliases: ["yard", "yards"]
-    unit "mi", value: "1760 yd", aliases: ["mile", "miles"]
+    unit "mi", value: "1760 yd", aliases: ["mile", "miles", "statute mile", "international mile"]
+    unit "ch", value: "22 yd", aliases: ["chain", "chains"]
+    unit "th", value: "1/1000 in", aliases: ["thou", "thousandth of an inch"]
+    unit "ftm", value: "6 ft", aliases: ["fathom", "fathoms"]
+    unit "fur", value: "220 yd", aliases: ["furlong", "furlongs"]
+    unit "nmi", value: "1852 m", aliases: ["NMI", "M", "NM", "nautical mile", "nautical miles"]
+    unit "rod", value: "16 1/2 ft", aliases: ["rods", "perch", "pole", "lug"]
+  end
+
+  system :astronomical do
+    unit "au", value: "149597870700 m", aliases: ["astronomical unit", "astronomical units"]
+    unit "pc", value: [Rational(648000, Math::PI), "au"], aliases: ["parsec", "parsecs"]
   end
 end

data/lib/unit_measurements/unit_groups/weight.rb

@@ -10,5 +10,27 @@ UnitMeasurements::Weight = UnitMeasurements.build do
 
     unit "q", value: "100 kg", aliases: ["quintal", "quintals"]
     unit "t", value: "1000 kg", aliases: ["tonne", "tonnes", "metric tonne", "metric tonnes"]
+    unit "ct", value: "200 mg", aliases: ["carat", "carats"]
+    unit "Da", value: "1.660538921e-27 kg", aliases: ["dalton", "daltons"]
+  end
+
+  system :imperial do
+    unit "lb", value: [Rational(45_359_237, 1e+8), "kg"], aliases: ["lbs", "lbm", "pound-mass", "pound", "pounds", "#"]
+    unit "st", value: "14 lb", aliases: ["stone", "stones"]
+    unit "oz", value: [Rational(1, 16), "lb"], aliases: ["ounce", "ounces"]
+  end
+
+  system :troy_weight do
+    unit "gr", value: [Rational(1, 7000), "lb"], aliases: ["grain", "grains"]
+    unit "ozt", value: "480 gr", aliases: ["troy ounce", "troy ounces"]
+    unit "dwt", value: [Rational(1, 20), "ozt"], aliases: ["pennyweight", "pennyweights"]
+  end
+
+  system :avoirdupois do
+    unit "dr", value: [Rational(1, 16), "oz"], aliases: ["dram", "drams"]
+  end
+
+  system :foot_pound_second do
+    unit "slug", value: "32.1740 lb", aliases: ["slugs"]
   end
 end

data/lib/unit_measurements/version.rb

@@ -3,5 +3,6 @@
 # -*- warn_indent: true -*-
 
 module UnitMeasurements
-  VERSION = "4.9.0"
+  # Current stable version.
+  VERSION = "4.11.0"
 end

data/lib/unit_measurements.rb

@@ -2,7 +2,23 @@
 # -*- 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
 

data/unit_measurements.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["documentation_uri"] = "https://shivam091.github.io/unit_measurements"
   spec.metadata["source_code_uri"] = "https://github.com/shivam091/unit_measurements"
   spec.metadata["changelog_uri"] = "https://github.com/shivam091/unit_measurements/blob/main/CHANGELOG.md"
   spec.metadata["bug_tracker_uri"] = "https://github.com/shivam091/unit_measurements/issues"