unit_measurements-rails 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5315caeda4fd8354ecf8f0ee7f50778725827ce96a176f0c5164270a81e08fca
-  data.tar.gz: d5e6ad2b8f041e6fe0a43cd9f2f52b9339a9383cc99ee124155b8ef18c1dcc43
+  metadata.gz: cf20e075bf5db7bd8a33f60eb2e14493aa4ed985defd4a3f49b020498a66ec6b
+  data.tar.gz: df3f2e54ed849cab6b0b6e7221e57bc74c11480053136aba222f6f91b3c43410
 SHA512:
-  metadata.gz: 4e6a3b59d61493150ff20625a1a800864094e91d2378f7c3a9b12a43fd4319283aadc6d64d893e42566d910095e7bd9b2151b52b14b3f3f9a91c7b011ae60276
-  data.tar.gz: d3e835f26dbaff425180d40e309dadb8d474001829d80e89998d020d847091e985fcde5f16b8e41937ffd4e4ae8caca71c156d04b680bd1cb527a703592e9cfd
+  metadata.gz: 4a59d3f2cd7a3d7f716aa68ba88ff3c19ae29aade038c6aa1258a5eeef77c6fc44634e3c66167b8e9e499865c51b15861f0122e3cb6b226d1414daa8cb18af14
+  data.tar.gz: 3c722fab2b67d36ae090aef75a01222e5bbecf937c9a2322c03832a4960e0304975d9a347eef5178ea94cc5ae184f5055f97436e37a5702a1ded9b5cbebd5cc2

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [1.3.0](https://github.com/shivam091/unit_measurements-rails/compare/v1.2.0...v1.3.0) - 2023-11-22
+
+### What's new
+
+- Raise `BaseError` if already measured attribute.
+- Added wrapper for defining `density` measured attributes.
+- Added wrapper for defining `temperature` measured attributes.
+- Added wrapper for defining `time` measured attributes.
+
+-----------
+
 ## [1.2.0](https://github.com/shivam091/unit_measurements-rails/compare/v1.1.0...v1.2.0) - 2023-11-20
 
 ### What's new

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unit_measurements-rails (1.2.0)
+    unit_measurements-rails (1.3.0)
       activemodel (>= 7)
       activerecord (>= 7)
       railties (>= 7)

data/lib/unit_measurements/rails/active_record.rb

@@ -60,6 +60,8 @@ module UnitMeasurements
         options[:unit_group] = unit_group
 
         measured_attrs.map(&:to_s).each do |measured_attr|
+          raise BaseError, "The field '#{measured_attr}' has already been measured." if measured_attributes.key?(measured_attr)
+
           quantity_attr = options[:quantity_attribute_name]&.to_s || "#{measured_attr}_quantity"
           unit_attr = options[:unit_attribute_name]&.to_s || "#{measured_attr}_unit"
 

data/lib/unit_measurements/rails/unit_groups/all.rb

@@ -2,7 +2,10 @@
 # -*- frozen_string_literal: true -*-
 # -*- warn_indent: true -*-
 
+require_relative "area"
+require_relative "density"
 require_relative "length"
-require_relative "weight"
+require_relative "temperature"
+require_relative "time"
 require_relative "volume"
-require_relative "area"
+require_relative "weight"

data/lib/unit_measurements/rails/unit_groups/area.rb

@@ -16,7 +16,7 @@ module UnitMeasurements::Rails::ActiveRecord::Area
   #
   # 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.
+  # names along with their options.
   #
   # @param [Array<String|Symbol>] measured_attrs
   #   An array of the names of area-measured attributes.

data/lib/unit_measurements/rails/unit_groups/density.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+# The +UnitMeasurements::Rails::ActiveRecord::Density+ module provides a convenient
+# way to define density-measured attributes in +ActiveRecord+ models.
+#
+# It acts as a wrapper for the +measured+ method, simplifying the definition of
+# density-measured attributes without directly invoking the +measured+ method.
+#
+# @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+# @since 1.3.0
+module UnitMeasurements::Rails::ActiveRecord::Density
+  # @!scope class
+  # Defines _density-measured_ attributes in the +ActiveRecord+ model.
+  #
+  # This method serves as a wrapper around the +measured+ method and allows easy
+  # definition of density-measured attributes by accepting an array of attribute
+  # names along with their options.
+  #
+  # @param [Array<String|Symbol>] measured_attrs
+  #   An array of the names of density-measured attributes.
+  # @param [Hash] options A customizable set of options
+  # @option options [String|Symbol] :quantity_attribute_name The name of the quantity attribute.
+  # @option options [String|Symbol] :unit_attribute_name The name of the unit attribute.
+  #
+  # @example Define single density-measured attribute:
+  #   class Substance < ActiveRecord::Base
+  #     measured_density :total_density
+  #   end
+  #
+  # @example Define multiple density-measured attributes:
+  #   class Substance < ActiveRecord::Base
+  #     measured_density :internal_density, :external_density
+  #   end
+  #
+  # @return [void]
+  #
+  # @see .measured
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.3.0
+  def measured_density(*measured_attrs, **options)
+    measured(UnitMeasurements::Density, *measured_attrs, **options)
+  end
+end
+
+# ActiveSupport hook to extend ActiveRecord with the `UnitMeasurements::Rails::ActiveRecord::Density` module.
+ActiveSupport.on_load(:active_record) do
+  ::ActiveRecord::Base.send(:extend, UnitMeasurements::Rails::ActiveRecord::Density)
+end

data/lib/unit_measurements/rails/unit_groups/length.rb

@@ -16,7 +16,7 @@ module UnitMeasurements::Rails::ActiveRecord::Length
   #
   # This method serves as a wrapper around the +measured+ method and allows easy
   # definition of length-measured attributes by accepting an array of attribute
-  # names.
+  # names along with their options.
   #
   # @param [Array<String|Symbol>] measured_attrs
   #   An array of the names of length-measured attributes.

data/lib/unit_measurements/rails/unit_groups/temperature.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+# The +UnitMeasurements::Rails::ActiveRecord::Temperature+ module provides a convenient
+# way to define temperature-measured attributes in +ActiveRecord+ models.
+#
+# It acts as a wrapper for the +measured+ method, simplifying the definition of
+# temperature-measured attributes without directly invoking the +measured+ method.
+#
+# @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+# @since 1.3.0
+module UnitMeasurements::Rails::ActiveRecord::Temperature
+  # @!scope class
+  # Defines _temperature-measured_ attributes in the +ActiveRecord+ model.
+  #
+  # This method serves as a wrapper around the +measured+ method and allows easy
+  # definition of temperature-measured attributes by accepting an array of attribute
+  # names along with their options.
+  #
+  # @param [Array<String|Symbol>] measured_attrs
+  #   An array of the names of temperature-measured attributes.
+  # @param [Hash] options A customizable set of options
+  # @option options [String|Symbol] :quantity_attribute_name The name of the quantity attribute.
+  # @option options [String|Symbol] :unit_attribute_name The name of the unit attribute.
+  #
+  # @example Define single temperature-measured attribute:
+  #   class WeatherReport < ActiveRecord::Base
+  #     measured_temperature :average_temperature
+  #   end
+  #
+  # @example Define multiple temperature-measured attributes:
+  #   class WeatherReport < ActiveRecord::Base
+  #     measured_temperature :day_temperature, :night_temperature
+  #   end
+  #
+  # @return [void]
+  #
+  # @see .measured
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.3.0
+  def measured_temperature(*measured_attrs, **options)
+    measured(UnitMeasurements::Temperature, *measured_attrs, **options)
+  end
+end
+
+# ActiveSupport hook to extend ActiveRecord with the `UnitMeasurements::Rails::ActiveRecord::Temperature` module.
+ActiveSupport.on_load(:active_record) do
+  ::ActiveRecord::Base.send(:extend, UnitMeasurements::Rails::ActiveRecord::Temperature)
+end

data/lib/unit_measurements/rails/unit_groups/time.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+# The +UnitMeasurements::Rails::ActiveRecord::Time+ module provides a convenient
+# way to define time-measured attributes in +ActiveRecord+ models.
+#
+# It acts as a wrapper for the +measured+ method, simplifying the definition of
+# time-measured attributes without directly invoking the +measured+ method.
+#
+# @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+# @since 1.3.0
+module UnitMeasurements::Rails::ActiveRecord::Time
+  # @!scope class
+  # Defines _time-measured_ attributes in the +ActiveRecord+ model.
+  #
+  # This method serves as a wrapper around the +measured+ method and allows easy
+  # definition of time-measured attributes by accepting an array of attribute
+  # names along with their options.
+  #
+  # @param [Array<String|Symbol>] measured_attrs
+  #   An array of the names of time-measured attributes.
+  # @param [Hash] options A customizable set of options
+  # @option options [String|Symbol] :quantity_attribute_name The name of the quantity attribute.
+  # @option options [String|Symbol] :unit_attribute_name The name of the unit attribute.
+  #
+  # @example Define single time-measured attribute:
+  #   class ProjectTimeline < ActiveRecord::Base
+  #     measured_time :duration
+  #   end
+  #
+  # @example Define multiple time-measured attributes:
+  #   class ProjectTimeline < ActiveRecord::Base
+  #     measured_time :setup_time, :processing_time
+  #   end
+  #
+  # @return [void]
+  #
+  # @see .measured
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.3.0
+  def measured_time(*measured_attrs, **options)
+    measured(UnitMeasurements::Time, *measured_attrs, **options)
+  end
+end
+
+# ActiveSupport hook to extend ActiveRecord with the `UnitMeasurements::Rails::ActiveRecord::Time` module.
+ActiveSupport.on_load(:active_record) do
+  ::ActiveRecord::Base.send(:extend, UnitMeasurements::Rails::ActiveRecord::Time)
+end

data/lib/unit_measurements/rails/unit_groups/volume.rb

@@ -16,7 +16,7 @@ module UnitMeasurements::Rails::ActiveRecord::Volume
   #
   # 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.
+  # names along with their options.
   #
   # @param [Array<String|Symbol>] measured_attrs
   #   An array of the names of volume-measured attributes.

data/lib/unit_measurements/rails/unit_groups/weight.rb

@@ -16,7 +16,7 @@ module UnitMeasurements::Rails::ActiveRecord::Weight
   #
   # 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.
+  # names along with their options.
   #
   # @param [Array<String|Symbol>] measured_attrs
   #   An array of the names of weight-measured attributes.

data/lib/unit_measurements/rails/version.rb

@@ -5,6 +5,6 @@
 module UnitMeasurements
   module Rails
     # Current stable version.
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -170,7 +170,10 @@ files:
 - lib/unit_measurements/rails/railtie.rb
 - lib/unit_measurements/rails/unit_groups/all.rb
 - lib/unit_measurements/rails/unit_groups/area.rb
+- lib/unit_measurements/rails/unit_groups/density.rb
 - lib/unit_measurements/rails/unit_groups/length.rb
+- lib/unit_measurements/rails/unit_groups/temperature.rb
+- lib/unit_measurements/rails/unit_groups/time.rb
 - lib/unit_measurements/rails/unit_groups/volume.rb
 - lib/unit_measurements/rails/unit_groups/weight.rb
 - lib/unit_measurements/rails/version.rb