unit_measurements-rails 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8df42aea1bd4eeeb476acbf102accaa55c206886b581df3f70e055accae95d41
-  data.tar.gz: 8f1d81756ce2844917278e2c16f49665be362a427c3c1af3c00d8cc834b96f2b
+  metadata.gz: 02e353f4bcd5f1cad16b7bebee4a1d46dc226ece9768ffc6f08a05bc62448cab
+  data.tar.gz: f2d6ab2245a058aef8552669085b3086c682653cb1647f799af3a98c8e4b84c8
 SHA512:
-  metadata.gz: e36f8d160d0644c4c66bd5723cdabef25db28ca5cae522dff70cb4299ea59c942d5190d0badc2374456b59db07dca09ac4f7c51bb22f8be261f67c932322cc79
-  data.tar.gz: 8285500f4713be2467e28cb6a2e39605478babf072935a2a93f6de01dfe3338010fed463a094828f425d76a4c8c48124c09b68f1cdbb9ff9f13f3abbad2e5cb7
+  metadata.gz: 30f7dccc1823251bafb0dea416bca202c2870b1031e393c845d8f708ea27862eead58392fb6740455cb918785302fb614834bd0b7c05db8f3abc13211432bda4
+  data.tar.gz: 2c74e56f900a0d540359ce69ccf25afa232eea4a1a00ca39b8546877dd00d7cd40b1f9976fe5b6998da8f2f986a9b5b4872ec0112c4feb97dde547fbe263fd99

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [1.6.0](https://github.com/shivam091/unit_measurements-rails/compare/v1.5.0...v1.6.0) - 2023-12-10
+
+### What's new
+
+- Added tests for `measured_*` methods.
+
+-----------
+
+## [1.5.0](https://github.com/shivam091/unit_measurements-rails/compare/v1.4.0...v1.5.0) - 2023-11-27
+
+### What's new
+
+- Raise error when columns for measurement attribute don't exist in DB.
+
+-----------
+
 ## [1.4.0](https://github.com/shivam091/unit_measurements-rails/compare/v1.3.0...v1.4.0) - 2023-11-25
 
 ### What's updated

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unit_measurements-rails (1.4.0)
+    unit_measurements-rails (1.6.0)
       activemodel (>= 7)
       activerecord (>= 7)
       railties (>= 7)
@@ -163,7 +163,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    sqlite3 (1.6.8-x86_64-linux)
+    sqlite3 (1.6.9-x86_64-linux)
     thor (1.3.0)
     timeout (0.4.1)
     tzinfo (2.0.6)
@@ -184,7 +184,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   simplecov (~> 0.21, >= 0.21.2)
-  sqlite3 (~> 1.6)
+  sqlite3 (~> 1.6.9)
   unit_measurements-rails!
 
 BUNDLED WITH

data/README.md

@@ -14,7 +14,7 @@ A Rails adaptor that encapsulate measurements and their units in Ruby on Rails.
 ## Introduction
 
 This gem is designed as a Rails integration for the [unit_measurements](https://github.com/shivam091/unit_measurements) gem.
-It provides an `ActiveRecord` adapter for persisting and retrieving measurements along with their units, simplifying complex
+It provides an `ActiveRecord` adapter for persisting and retrieving measurement quantity along with its unit, simplifying complex
 measurement handling within your Rails applications.
 
 ## Minimum Requirements
@@ -42,8 +42,8 @@ Or otherwise simply install it yourself as:
 
 ### ActiveRecord
 
-This gem provides an ActiveRecord integration allowing you to declare measurement attributes with their
-corresponding units in your database schema:
+This gem provides an ActiveRecord integration allowing you to declare measurement
+attributes along with their corresponding units in your database schema:
 
 ```ruby
 class CreateCubes < ActiveRecord::Migration[7.0]
@@ -76,6 +76,9 @@ cube.length_unit       #=> "ft"
 cube.length            #=> 5.0 ft
 ```
 
+Attribute accessor names are expected to have the `_quantity` and `_unit` suffix,
+and be `DECIMAL` and `VARCHAR` types, respectively, and defaults values are accepted.
+
 You can specify multiple measurement attributes simultaneously:
 
 ```ruby
@@ -84,28 +87,36 @@ class Cube < ActiveRecord::Base
 end
 ```
 
-Attribute names are expected to have the `_quantity` and `_unit` suffix, and be
-`DECIMAL` and `VARCHAR` types, respectively, and defaults values are accepted.
-
-You can customize the model's quantity and unit accessors by specifying them in the
-`quantity_attribute_name` and `unit_attribute_name` options, respectively.
+You can customize the quantity and unit accessors of the measurement attribute by
+specifying them in the `quantity_attribute_name` and `unit_attribute_name` options,
+respectively.
 
 ```ruby
 class CubeWithCustomAccessor < ActiveRecord::Base
-  measured_length :length, unit_attribute_name: :length_uom
-  measured_length :width, quantity_attribute_name: :width_value
+  measured UnitMeasurements::Length, :length, :width, :height, unit_attribute_name: :size_uom
+  measured UnitMeasurements::Weight, :weight, quantity_attribute_name: :width_quantity
 end
 ```
 
 For a more streamlined approach, predefined methods are available for commonly used
-types like `length`, `weight`, `area`, `volume`, etc.:
+types:
+
+| # | Unit group | Method name |
+| :- | :---------- | :----------- |
+| 1 | Length or distance | measured_length |
+| 2 | Weight or mass | measured_weight |
+| 3 | Time or duration | measured_time |
+| 4 | Temperature | measured_temperature |
+| 5 | Area | measured_area |
+| 6 | Volume | measured_volume |
+| 7 | Density | measured_density |
 
 ```ruby
-class Package < ActiveRecord::Base
+class CubeWithPredefinedMethods < ActiveRecord::Base
   measured_length :size
-  measured_area :carpet_area
-  measured_volume :total_volume
-  measured_weight :item_weight, :package_weight
+  measured_volume :volume
+  measured_weight :weight
+  measured_density :density
 end
 ```
 
@@ -121,4 +132,4 @@ Contributions to this project are welcomed! To contribute:
 
 ## License
 
-Copyright 2023 [Harshal V. LADHE]((https://shivam091.github.io)), Released under the [MIT License](http://opensource.org/licenses/MIT).
+Copyright 2023 [Harshal V. LADHE](https://shivam091.github.io), Released under the [MIT License](http://opensource.org/licenses/MIT).

data/lib/unit_measurements/rails/active_record.rb

@@ -140,6 +140,8 @@ module UnitMeasurements
       # @since 1.0.0
       def define_reader_for_measured_attr(measured_attr, quantity_attr, unit_attr, unit_group)
         define_method(measured_attr) do
+          column_exists?(quantity_attr) && column_exists?(unit_attr)
+
           quantity, unit = public_send(quantity_attr), public_send(unit_attr)
 
           begin
@@ -165,6 +167,8 @@ module UnitMeasurements
       # @since 1.0.0
       def define_writer_for_measured_attr(measured_attr, quantity_attr, unit_attr, unit_group)
         define_method("#{measured_attr}=") do |measurement|
+          column_exists?(quantity_attr) && column_exists?(unit_attr)
+
           if measurement.is_a?(unit_group)
             public_send("#{quantity_attr}=", measurement.quantity)
             public_send("#{unit_attr}=", measurement.unit.name)
@@ -187,6 +191,8 @@ module UnitMeasurements
       # @since 1.0.0
       def redefine_quantity_writer(quantity_attr)
         redefine_method("#{quantity_attr}=") do |quantity|
+          column_exists?(quantity_attr)
+
           quantity = BigDecimal(quantity, Float::DIG) if quantity.is_a?(String)
           if quantity
             db_column_props = self.column_for_attribute(quantity_attr)
@@ -212,6 +218,8 @@ module UnitMeasurements
       # @since 1.0.0
       def redefine_unit_writer(unit_attr, unit_group)
         redefine_method("#{unit_attr}=") do |unit|
+          column_exists?(unit_attr)
+
           unit_name = unit_group.unit_for(unit).try!(:name)
           write_attribute(unit_attr, (unit_name || unit))
         end

data/lib/unit_measurements/rails/base.rb

@@ -33,6 +33,7 @@ module UnitMeasurements
   end
 end
 
+require "unit_measurements/rails/helpers"
 require "unit_measurements/rails/active_record"
 
 require "unit_measurements/rails/railtie" if defined?(Rails)

data/lib/unit_measurements/rails/helpers.rb

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module UnitMeasurements
+  module Rails
+    # The +UnitMeasurements::Rails::Helpers+ module provides helper methods for
+    # handling +ActiveRecord+ models in the context of unit measurements.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.5.0
+    module Helpers
+      # Checks the existence of a +column_name+ within the database table
+      # associated with the +ActiveRecord+ model.
+      #
+      # @param [String] column_name The name of the column to check for existence.
+      #
+      # @raise [ArgumentError]
+      #   If the specified column does not exist in the database table.
+      #
+      # @example Check if the +height_quantity+ column exists in the database table:
+      #   column_exists?("height_quantity")
+      #
+      # @return [void]
+      #
+      # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+      # @since 1.5.0
+      def column_exists?(column_name)
+        unless self.class.column_names.include?(column_name)
+          raise ArgumentError, "Column '#{column_name}' does not exist in the database for table '#{self.class.table_name}'."
+        end
+      end
+    end
+  end
+end
+
+# ActiveSupport hook to include ActiveRecord with the `UnitMeasurements::Rails::Helpers`
+# module.
+ActiveSupport.on_load(:active_record) do
+  ::ActiveRecord::Base.send(:include, UnitMeasurements::Rails::Helpers)
+end

data/lib/unit_measurements/rails/version.rb

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

data/unit_measurements-rails.gemspec

@@ -43,7 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", "~> 0.21", ">= 0.21.2"
   spec.add_development_dependency "byebug", "~> 11"
-  spec.add_development_dependency "sqlite3", "~> 1.6"
+  spec.add_development_dependency "sqlite3", "~> 1.6.9"
 
   spec.required_ruby_version = ">= 3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_measurements-rails
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-25 00:00:00.000000000 Z
+date: 2023-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.9
 description: A Rails adaptor that encapsulate measurements and their units in Ruby
   on Rails.
 email:
@@ -167,6 +167,7 @@ files:
 - lib/unit_measurements-rails.rb
 - lib/unit_measurements/rails/active_record.rb
 - lib/unit_measurements/rails/base.rb
+- lib/unit_measurements/rails/helpers.rb
 - lib/unit_measurements/rails/railtie.rb
 - lib/unit_measurements/rails/unit_groups/all.rb
 - lib/unit_measurements/rails/unit_groups/area.rb