activerecord-virtual_attributes 7.1.1 → 7.2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26048751ad2fe218660a4b62fa6c89d6467e7d33404c463154a041cf638ff43c
-  data.tar.gz: 8c2302076104393e4e4eac994e854a951ee6c0588b3fbfefc6c95f3d8d905861
+  metadata.gz: ef69f0683d1cf4b95da626b2407fe42fcd2e6564053bcb424ea8c867365e6c94
+  data.tar.gz: 28d0d1506872044eae2cb1d9e84cd0044e9dae43f849facabd44024c9f1ed676
 SHA512:
-  metadata.gz: 34b460bb1293c44743f26c0b91d62d857f53158022f2777ffb29f97a2279b6a9bbd3d19e4cd83dafaee035061093da669da4ac2bb749f1524258ae5db8d5577c
-  data.tar.gz: 2b7876b8d6f5c0eeafaf2f2f7740943ead1cc25b0c211ee84e44365609d86c659c328103c432d0c01184d1c09f13f2af5226c9d05614ac7c875392e503ae981a
+  metadata.gz: 2c26a6ea644c42aa0317bcf3848f31ae79d49a86f80fa2c0832642652c9195171f52fe23b52789544fd7045efbb51a398d911e39fc2f4645e2e88a2945fa1555
+  data.tar.gz: 3d59e61f9b22e9037237c1e1f8e8be91ee36dc165c54a101bf742f4a5b88cc9da6b0a13fef44dbe18dda4f0af299028179e5e37c001e7f3419f6cd988679e044

data/CHANGELOG.md

@@ -4,6 +4,16 @@ The versioning of this gem follows ActiveRecord versioning, and does not follow
 
 ## [Unreleased]
 
+## [7.2.0.0] - 2025-06-25
+
+* virtual_delegate requires type [#185](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/185)
+* Rails 7.2 support [#187](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/187)
+
+## [7.1.2] - 2025-06-20
+
+* Introduce virtual_has_many :through [#191](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/191)
+* Use kwargs for virtual_delegate and virtual_column [#190](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/190)
+
 ## [7.1.1] - 2025-06-18
 
 * Deprecate virtual_delegate without a type [#188](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/188)
@@ -115,7 +125,9 @@ The versioning of this gem follows ActiveRecord versioning, and does not follow
 * Initial Release
 * Extracted from ManageIQ/manageiq
 
-[Unreleased]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v7.1.1...HEAD
+[Unreleased]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v7.2.0.0...HEAD
+[7.2.0.0]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v7.1.2...v7.2.0.0
+[7.1.2]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v7.1.1...v7.1.2
 [7.1.1]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v7.1.0...v7.1.1
 [7.1.0]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v7.0.0...v7.1.0
 [7.0.0]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v6.1.2...v7.0.0

data/Gemfile

@@ -2,9 +2,4 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~>7.1.5"
-gem "mysql2"
-gem "pg"
-gem "sqlite3", "< 2"
-
 gemspec

data/activerecord-virtual_attributes.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activerecord", "~> 7.1", ">=7.1.5.1"
+  spec.add_runtime_dependency "activerecord", "~> 7.2.2", ">=7.2.2.1"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "database_cleaner-active_record", "~> 2.1"
@@ -40,5 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", ">= 0.21.2"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "sqlite3", "< 2"
 end

data/lib/active_record/virtual_attributes/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module VirtualAttributes
-    VERSION = "7.1.1".freeze
+    VERSION = "7.2.0.0".freeze
   end
 end

data/lib/active_record/virtual_attributes/virtual_arel.rb

@@ -111,10 +111,9 @@ module ActiveRecord
         private
 
         def define_virtual_arel(name, arel) # :nodoc:
-          self._virtual_arel = _virtual_arel.merge(name => arel)
+          self._virtual_arel = _virtual_arel.merge(name.to_s => arel) unless arel.nil?
         end
       end
     end
   end
 end
-

data/lib/active_record/virtual_attributes/virtual_delegates.rb

@@ -9,80 +9,38 @@ module ActiveRecord
     module VirtualDelegates
       extend ActiveSupport::Concern
 
-      included do
-        class_attribute :virtual_delegates_to_define, :instance_accessor => false, :default => {}
-      end
-
       module ClassMethods
         #
         # Definition
         #
 
-        def virtual_delegate(*methods)
-          options = methods.extract_options!
-          unless (to = options[:to])
-            raise ArgumentError, 'Delegation needs an association. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, to: :greeter).'
-          end
-
-          unless options[:type]
-            ActiveRecord::VirtualAttributes.deprecator.warn("Calling virtual_delegate without :type is now deprecated", caller)
-          end
-
+        def virtual_delegate(*methods, to:, type:, prefix: nil, allow_nil: nil, default: nil, uses: nil, **options) # rubocop:disable Naming/MethodParameterName
           to = to.to_s
-          if to.include?(".") && methods.size > 1
-            raise ArgumentError, 'Delegation only supports specifying a method name when defining a single virtual method'
+          if to.include?(".") && (methods.size > 1 || prefix)
+            raise ArgumentError, 'Delegation only supports specifying a target method name when defining a single virtual method with no prefix'
           end
 
           if to.count(".") > 1
-            raise ArgumentError, 'Delegation needs a single association. Supply an option hash with a :to key with only 1 period (e.g. delegate :hello, to: "greeter.greeting")'
+            raise ArgumentError, 'Delegation needs a single association. Supply keyword :to with only 1 period (e.g. delegate :hello, to: "greeter.greeting")'
           end
 
-          allow_nil = options[:allow_nil]
-          default = options[:default]
-
           # put method entry per method name.
           # This better supports reloading of the class and changing the definitions
           methods.each do |method|
-            method_prefix = virtual_delegate_name_prefix(options[:prefix], to)
-            method_name = "#{method_prefix}#{method}"
-            if to.include?(".") # to => "target.method"
-              to, method = to.split(".").map(&:to_sym)
-              options[:to] = to
+            method_name, to, method = determine_method_names(method, to, prefix)
+            unless (to_ref = reflection_with_virtual(to))
+              raise ArgumentError, "Delegation needs an association. Association #{to} does not exist"
             end
 
             define_delegate(method_name, method, :to => to, :allow_nil => allow_nil, :default => default)
-
-            self.virtual_delegates_to_define =
-              virtual_delegates_to_define.merge(method_name => [method, options])
+            virtual_attribute(method_name, type, :uses => (uses || to), :arel => virtual_delegate_arel(method, to_ref), **options)
           end
         end
 
         private
 
-        # define virtual_attribute for delegates
-        #
-        # this is called at schema load time (and not at class definition time)
-        #
-        # @param  method_name [Symbol] name of the attribute on the source class to be defined
-        # @param  col [Symbol] name of the attribute on the associated class to be referenced
-        # @option options :to [Symbol] name of the association from the source class to be referenced
-        # @option options :arel [Proc] (optional and not common)
-        # @option options :uses [Array|Symbol|Hash] sql includes hash. (default: to)
-        def define_virtual_delegate(method_name, col, options)
-          unless (to = options[:to]) && (to_ref = reflection_with_virtual(to.to_s))
-            raise ArgumentError, 'Delegation needs an association. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, to: :greeter).'
-          end
-
-          col = col.to_s
-          type = options[:type] || to_ref.klass.type_for_attribute(col)
-          type = ActiveRecord::Type.lookup(type) if type.kind_of?(Symbol)
-          raise "unknown attribute #{to}##{col} referenced in #{name}" unless type
-
-          arel = virtual_delegate_arel(col, to_ref)
-          define_virtual_attribute(method_name, type, :uses => (options[:uses] || to), :arel => arel)
-        end
-
         # see activesupport module/delegation.rb
+        # rubocop:disable Style/TernaryParentheses
         def define_delegate(method_name, method, to: nil, allow_nil: nil, default: nil) # rubocop:disable Naming/MethodParameterName
           location = caller_locations(2, 1).first
           file, line = location.path, location.lineno
@@ -98,6 +56,7 @@ module ActiveRecord
           # On the other hand it could be that the target has side-effects,
           # whereas conceptually, from the user point of view, the delegator should
           # be doing one call.
+          # NOTE: This is based upon ActiveSupport 6.0 delegate.rb, but we added has_attribute? and default
           if allow_nil
             method_def = <<-METHOD
               def #{method_name}(#{definition})
@@ -128,9 +87,27 @@ module ActiveRecord
           method_def = method_def.split("\n").map(&:strip).join(';')
           module_eval(method_def, file, line)
         end
+        # rubocop:enable Style/TernaryParentheses
+
+        # Sometimes the `to` contains the column name target.column, split it up to the source method_name and target column
+        # If `to` does specify the column name, `to` becomes the target (i.e.: association)
+        #
+        # @param column [Symbol|String] the name of the column
+        # @param to [Symbol|String]
+        # @param prefix [Boolean|Nil|Symbol]
+        # @return [Symbol, Symbol, Symbol] method_name, relation, relation's column name
+        def determine_method_names(column, to, prefix) # rubocop:disable Naming/MethodParameterName
+          method_name = column = column.to_sym
+
+          tos = to.to_s
+          if tos.include?(".") # to => "target.method"
+            to, column = tos.split(".").map(&:to_sym)
+          end
+
+          method_prefix = "#{prefix == true ? to : prefix}_" if prefix
+          method_name = "#{method_prefix}#{method_name}".to_sym
 
-        def virtual_delegate_name_prefix(prefix, to) # rubocop:disable Naming/MethodParameterName
-          "#{prefix == true ? to : prefix}_" if prefix
+          [method_name, to.to_sym, column]
         end
 
         # @param col [String] attribute name

data/lib/active_record/virtual_attributes/virtual_fields.rb

@@ -143,7 +143,7 @@ module ActiveRecord
 
   module Associations
     class Preloader
-      prepend(Module.new {
+      prepend(Module.new do
         # preloader is called with virtual attributes - need to resolve
         def call
           # Possibly overkill since all records probably have the same class and associations
@@ -152,8 +152,12 @@ module ActiveRecord
 
           # convert the includes with virtual attributes to includes with proper associations
           records_by_assoc = records.group_by { |rec| assoc_cache[rec.class] }
-          # if these are the same includes, then do the preloader work
-          return super if records_by_assoc.size == 1 && records_by_assoc.keys.first == associations
+          # If the association were already translated, then short circuit / do the standard preloader work.
+          # When replace_virtual_fields removes the outer array, match that too.
+          if records_by_assoc.size == 1 &&
+            (associations == records_by_assoc.keys.first || associations == [records_by_assoc.keys.first])
+            return super
+          end
 
           # for each of the associations, run a preloader
           records_by_assoc.each do |klass_associations, klass_records|
@@ -165,13 +169,14 @@ module ActiveRecord
             end
           end
         end
-      })
+      end)
 
       class Branch
-        prepend(Module.new {
+        prepend(Module.new do
           # from branched.rb 7.0
           # not going to modify rails code for rubocops
           # rubocop:disable Lint/AmbiguousOperatorPrecedence
+          # rubocop:disable Layout/EmptyLineAfterGuardClause
           def grouped_records
             h = {}
             polymorphic_parent = !root? && parent.polymorphic?
@@ -186,9 +191,11 @@ module ActiveRecord
             end
             h
           end
+          # rubocop:enable Layout/EmptyLineAfterGuardClause
           # rubocop:enable Lint/AmbiguousOperatorPrecedence
 
           # branched.rb 7.0
+          # rubocop:disable Style/MultilineBlockChain
           def preloaders_for_reflection(reflection, reflection_records)
             reflection_records.group_by do |record|
               # begin virtual_attributes changes
@@ -209,13 +216,14 @@ module ActiveRecord
               preloader_for(reflection).new(rhs_klass, rs, reflection, scope, reflection_scope, associate_by_default)
             end
           end
-        })
+        end)
+        # rubocop:enable Style/MultilineBlockChain
       end
     end
   end
 
   class Relation
-    include(Module.new {
+    include(Module.new do
       # From ActiveRecord::QueryMethods (rails 5.2 - 6.1)
       def build_select(arel)
         if select_values.any?
@@ -246,6 +254,6 @@ module ActiveRecord
         associations = klass.replace_virtual_fields(associations) || {}
         super
       end
-    })
+    end)
   end
 end

data/lib/active_record/virtual_attributes/virtual_includes.rb

@@ -25,7 +25,7 @@ module ActiveRecord
         private
 
         def define_virtual_include(name, uses)
-          self._virtual_includes = _virtual_includes.merge(name => uses)
+          self._virtual_includes = _virtual_includes.merge(name.to_s => uses) unless uses.nil?
         end
       end
     end

data/lib/active_record/virtual_attributes/virtual_reflections.rb

@@ -5,31 +5,28 @@ module ActiveRecord
       include ActiveRecord::VirtualAttributes::VirtualIncludes
 
       module ClassMethods
-
         #
         # Definition
         #
 
-        def virtual_has_one(name, options = {})
-          uses = options.delete(:uses)
+        def virtual_has_one(name, uses: nil, **options)
           reflection = ActiveRecord::Associations::Builder::HasOne.build(self, name, nil, options)
-          add_virtual_reflection(reflection, name, uses, options)
+          add_virtual_reflection(reflection, name, uses)
         end
 
-        def virtual_has_many(name, options = {})
+        def virtual_has_many(name, uses: nil, source: name, through: nil, **options)
           define_method(:"#{name.to_s.singularize}_ids") do
             records = send(name)
             records.respond_to?(:ids) ? records.ids : records.collect(&:id)
           end
-          uses = options.delete(:uses)
+          define_delegate(name, source, :to => through, :allow_nil => true, :default => []) if through
           reflection = ActiveRecord::Associations::Builder::HasMany.build(self, name, nil, options)
-          add_virtual_reflection(reflection, name, uses, options)
+          add_virtual_reflection(reflection, name, uses)
         end
 
-        def virtual_belongs_to(name, options = {})
-          uses = options.delete(:uses)
+        def virtual_belongs_to(name, uses: nil, **options)
           reflection = ActiveRecord::Associations::Builder::BelongsTo.build(self, name, nil, options)
-          add_virtual_reflection(reflection, name, uses, options)
+          add_virtual_reflection(reflection, name, uses)
         end
 
         def virtual_reflection?(name)
@@ -95,7 +92,7 @@ module ActiveRecord
 
         private
 
-        def add_virtual_reflection(reflection, name, uses, _options)
+        def add_virtual_reflection(reflection, name, uses)
           raise ArgumentError, "macro must be specified" unless reflection
 
           reset_virtual_reflection_information

data/lib/active_record/virtual_attributes.rb

@@ -52,19 +52,19 @@ module ActiveRecord
       #
 
       # Compatibility method: `virtual_attribute` is a more accurate name
-      def virtual_column(name, **options)
-        type = options.delete(:type)
-        raise ArgumentError, "missing :type attribute" unless type
-
+      def virtual_column(name, type:, **options)
         virtual_attribute(name, type, **options)
       end
 
-      def virtual_attribute(name, type, **options)
+      def virtual_attribute(name, type, uses: nil, arel: nil, **options)
         name = name.to_s
         reload_schema_from_cache
 
         self.virtual_attributes_to_define =
           virtual_attributes_to_define.merge(name => [type, options])
+
+        define_virtual_include(name, uses)
+        define_virtual_arel(name, arel)
       end
 
       #
@@ -87,27 +87,18 @@ module ActiveRecord
         end
       end
 
-      private
-
-      def load_schema!
-        super
-
-        virtual_attributes_to_define.each do |name, (type, options)|
-          type = type.call if type.respond_to?(:call)
-          type = ActiveRecord::Type.lookup(type, **options.except(:uses, :arel)) if type.kind_of?(Symbol)
-
-          define_virtual_attribute(name, type, **options.slice(:uses, :arel))
-        end
-
-        virtual_delegates_to_define.each do |method_name, (method, options)|
-          define_virtual_delegate(method_name, method, options)
+      def attribute_types
+        @attribute_types || super.tap do |hash|
+          virtual_attributes_to_define.each do |name, (type, options)|
+            type = type.call if type.respond_to?(:call)
+            type = ActiveRecord::Type.lookup(type, **options) if type.kind_of?(Symbol)
+            hash[name] = type
+          end
         end
       end
 
-      def define_virtual_attribute(name, cast_type, uses: nil, arel: nil)
-        attribute_types[name] = cast_type
-        define_virtual_include(name, uses) if uses
-        define_virtual_arel(name, arel) if arel
+      def define_virtual_attribute(name, cast_type)
+        attribute_types[name.to_s] = cast_type
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-virtual_attributes
 version: !ruby/object:Gem::Version
-  version: 7.1.1
+  version: 7.2.0.0
 platform: ruby
 authors:
 - Keenan Brock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-17 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 7.2.2
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.5.1
+        version: 7.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 7.2.2
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.5.1
+        version: 7.2.2.1
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -160,16 +160,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 description: Define attributes in arel
 email:
 - keenan@thebrocks.net