Merge pull request #185 from kbrock/delegate_type

Require type for delegation

Author: jrafanie

lib/active_record/virtual_attributes/virtual_delegates.rb

@@ -18,11 +18,7 @@ module ClassMethods
         # Definition
         #
 
-        def virtual_delegate(*methods, to:, type: nil, prefix: nil, allow_nil: nil, default: nil, **options) # rubocop:disable Naming/MethodParameterName
-          unless 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, **options) # rubocop:disable Naming/MethodParameterName
           to = to.to_s
           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'
@@ -54,15 +50,15 @@ def virtual_delegate(*methods, to:, type: nil, prefix: nil, allow_nil: nil, defa
         # @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)
+        # @option options :type [Symbol|ActiveModel::Type::Value] type for the attribute
         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 = options[:type]
           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)
@@ -85,6 +81,7 @@ def define_delegate(method_name, method, to: nil, allow_nil: nil, default: nil)
           # 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})

spec/db/models.rb

@@ -1,4 +1,4 @@
-class VirtualTotalTestBase < ActiveRecord::Base  # rubocop:disable Rails/ApplicationRecord
+class VirtualTotalTestBase < ActiveRecord::Base # rubocop:disable Rails/ApplicationRecord
   self.abstract_class = true
 
   include VirtualFields

spec/support/with_test_class.rb

@@ -13,7 +13,7 @@
 #
 RSpec.shared_context 'with test_class', :with_test_class do
   before do
-    class TestClassBase < ActiveRecord::Base
+    class TestClassBase < ActiveRecord::Base # rubocop:disable Rails/ApplicationRecord
       self.abstract_class = true
 
       include VirtualFields

spec/virtual_attributes_spec.rb

@@ -7,8 +7,8 @@
     end
 
     context ".virtual_column" do
-      it "with invalid parameters" do
-        expect { TestClass.virtual_column :vcol1 }.to raise_error(ArgumentError)
+      it "expects a :type parameter" do
+        expect { TestClass.virtual_column :vcol1 }.to raise_error(ArgumentError, /missing keyword: :type/)
       end
 
       it "with symbol name" do
@@ -208,7 +208,7 @@
     end
 
     context "add_virtual_reflection integration" do
-      it "with invalid parameters" do
+      it "expects an association name" do
         expect { TestClass.virtual_has_one }.to raise_error(ArgumentError)
       end
 
@@ -218,17 +218,17 @@
         expect(TestClass.virtual_reflection(:vref1).name).to eq(:vref1)
       end
 
-      it("with has_one macro") do
+      it "with has_one macro" do
         TestClass.virtual_has_one(:vref1)
         expect(TestClass.virtual_reflection(:vref1).macro).to eq(:has_one)
       end
 
-      it("with has_many macro") do
+      it "with has_many macro" do
         TestClass.virtual_has_many(:vref1)
         expect(TestClass.virtual_reflection(:vref1).macro).to eq(:has_many)
       end
 
-      it("with belongs_to macro") do
+      it "with belongs_to macro" do
         TestClass.virtual_belongs_to(:vref1)
         expect(TestClass.virtual_reflection(:vref1).macro).to eq(:belongs_to)
       end

spec/virtual_delegates_spec.rb

@@ -40,14 +40,15 @@
   context "invalid" do
     it "expects a ':to' for delegation" do
       expect do
-        TestClass.virtual_delegate :col1
+        TestClass.virtual_delegate :col1, :type => :integer
       end.to raise_error(ArgumentError, /missing keyword: :to/)
     end
 
     it "expects a ':type' for delegation" do
-      expect(ActiveRecord::VirtualAttributes.deprecator).to receive(:warn).with(/type/, anything)
-      TestClass.virtual_delegate :col1, :to => :ref1
-      TestClass.new
+      expect do
+        TestClass.virtual_delegate :col1, :to => :ref1
+        TestClass.new
+      end.to raise_error(ArgumentError, /missing keyword: :type/)
     end
 
     it "only allows 1 method when delegating to a specific method" do