Module: UnitMeasurements::Rails::ActiveRecord::Area

Defined in:
lib/unit_measurements/rails/unit_groups/area.rb

Overview

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

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

Author:

Since:

  • 1.1.0

Class Method Summary collapse

Class Method Details

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

This method returns an undefined value.

Defines area-measured attributes in the ActiveRecord model.

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

Examples:

Define single area-measured attribute:

class Land < ActiveRecord::Base
  measured_area :total_area
end

Define multiple area-measured attributes:

class Land < ActiveRecord::Base
  measured_area :carpet_area, :buildup_area
end

Parameters:

  • measured_attrs (Array<String|Symbol>) —

    An array of the names of area-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:

Author:

Since:

  • 1.1.0



42
43
44
 
# File 'lib/unit_measurements/rails/unit_groups/area.rb', line 42

def measured_area(*measured_attrs, **options)
  measured(UnitMeasurements::Area, *measured_attrs, **options)
end