Module: UnitMeasurements::Rails::ActiveRecord::Volume

Defined in:

lib/unit_measurements/rails/unit_groups/volume.rb

Overview

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

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

Author:

• Harshal V. Ladhe

Since:

• 1.1.0

Class Method Summary

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

  Defines volume-measured attributes in the ActiveRecord model.

Class Method Details

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

This method returns an undefined value.

Defines volume-measured attributes in the ActiveRecord model.

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

Examples:

Define single volume-measured attribute:

class Container < ActiveRecord::Base
  measured_volume :total_volume
end

Define multiple volume-measured attributes:

class Container < ActiveRecord::Base
  measured_volume :internal_volume, :external_volume
end

Parameters:

• measured_attrs (Array<String|Symbol>) —

  An array of the names of volume-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/volume.rb', line 42

def measured_volume(*measured_attrs, **options)
  measured(UnitMeasurements::Volume, *measured_attrs, **options)
end