Module: UnitMeasurements::Rails::ActiveRecord::Weight

Defined in:

lib/unit_measurements/rails/unit_groups/weight.rb

Overview

The UnitMeasurements::Rails::ActiveRecord::Weight module provides a convenient way to define weight-measured attributes in ActiveRecord models.

It acts as a wrapper for the measured method, simplifying the definition of weight-measured attributes without directly invoking the measured method.

Author:

• Harshal V. Ladhe

Since:

• 1.1.0

Class Method Summary

• .measured_weight(*measured_attrs, **options) ⇒ void

  Defines weight-measured attributes in the ActiveRecord model.

Class Method Details

.measured_weight(*measured_attrs, **options) ⇒ void

This method returns an undefined value.

Defines weight-measured attributes in the ActiveRecord model.

This method serves as a wrapper around the measured method and allows easy definition of weight-measured attributes by accepting an array of attribute names along with their options.

Examples:

Define single weight-measured attribute:

class Package < ActiveRecord::Base
  measured_weight :total_weight
end

Define multiple weight-measured attributes:

class Package < ActiveRecord::Base
  measured_weight :item_weight, :package_weight
end

Parameters:

• measured_attrs (Array<String|Symbol>) —

  An array of the names of weight-measured attributes.

• options (Hash) —

  A customizable set of options

Options Hash (**options):

• :quantity_attribute_name (String|Symbol) —

  The name of the quantity attribute.

• :unit_attribute_name (String|Symbol) —

  The name of the unit attribute.

See Also:

• UnitMeasurements::Rails::ActiveRecord.measured

Author:

• Harshal V. Ladhe

Since:

• 1.1.0

# File 'lib/unit_measurements/rails/unit_groups/weight.rb', line 42

def measured_weight(*measured_attrs, **options)
  measured(UnitMeasurements::Weight, *measured_attrs, **options)
end