deferring 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b06d2014bec77285df7d494e04b1aceae86e4ce9b147f0916002db02e1e79cba
-  data.tar.gz: d89af52998b5d67de9f29cf971a5f68f1ce9339e340f3170c9c0cbd6c4df1713
+  metadata.gz: 35b9b80d6c94a8b980f80cd953565bcf7cf2f8a207de3880904286e617ed30a0
+  data.tar.gz: f78c5caa4d9c1a5a446ac504c839bebf21e29a059e57e5739de4ef5842106b63
 SHA512:
-  metadata.gz: 3fd88c4d8a0c1be57f6b4ac674faf39bc1a152117a86d719aa6e2727cd93b916d547404e66c5e67f636aeb209918a0dcbcf78db256704ff3e45c0f9951c592ca
-  data.tar.gz: 15ac8fa0e41d23af97a1ac35ac0e29c429e1287bc83fa6cf7148437070a57a6bd8a36fa49910bc5d8ee4288d2ca20c091ac7289b63b210e2c13d4db4997453a8
+  metadata.gz: af8785f36ce8551ba95a9f7dab9d28fdfc8cd46bc6a427bddc70007985225ce3edd23daf1c1cdd21f5102d1c3bef0d2a0ae2598752b0fa38318225235db8a9e4
+  data.tar.gz: 549c445412012809bdbe613dd028395acc22ef4dc5e26fc803fc2db5734a2f7b26fc4c134693c6fae5147e6bb7d83d7b4afde8eed25719ef57ea47af3232c4d5

data/gemfiles/rails_42.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    deferring (0.6.1)
+    deferring (0.7.0)
       activerecord (>= 4.2)
 
 GEM

data/gemfiles/rails_50.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    deferring (0.6.1)
+    deferring (0.7.0)
       activerecord (>= 4.2)
 
 GEM

data/gemfiles/rails_51.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    deferring (0.6.1)
+    deferring (0.7.0)
       activerecord (>= 4.2)
 
 GEM

data/gemfiles/rails_52.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    deferring (0.6.1)
+    deferring (0.7.0)
       activerecord (>= 4.2)
 
 GEM

data/gemfiles/rails_60.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    deferring (0.6.1)
+    deferring (0.7.0)
       activerecord (>= 4.2)
 
 GEM

data/lib/deferring/deferred_association.rb

@@ -26,14 +26,14 @@ module Deferring
     alias_method :pretty_inspect, :inspect
 
     delegate :to_s, :to_a, :inspect, :==, # methods undefined by SimpleDelegator
-             :is_a?, :as_json, to: :objects
+             :as_json, to: :objects
 
     def each(&block)
       objects.each(&block)
     end
 
     # TODO: Add explanation about :first/:last loaded? problem.
-    [:first, :last].each do |method|
+    [:first, :last, :empty?, :size].each do |method|
       define_method method do
         unless objects_loaded?
           original_association.send(method)
@@ -46,7 +46,7 @@ module Deferring
     # Delegates methods from Ruby's Array module to the object in the deferred
     # association.
     delegate :[]=, :[], :clear, :select!, :reject!, :flatten, :flatten!, :sort!,
-             :keep_if, :delete_if, :sort_by!, :empty?, :size, :length,
+             :keep_if, :delete_if, :sort_by!, :length,
              :each_index,
              to: :objects
 
@@ -58,6 +58,14 @@ module Deferring
       original_association.find(*args)
     end
 
+    # Delegates Ruby's Enumerable#count method to the original association.
+    #
+    # The delegation has to be explicit in this case, because the inclusion of
+    # Enumerable also defines the count-method on DeferredAssociation.
+    def count(*args)
+      original_association.count(*args)
+    end
+
     # Delegates Ruby's Enumerable#select method to the original association when
     # no block has been given. Rails' select-method does not accept a block, so
     # we know that in that case the select-method has to be called on our

data/lib/deferring/version.rb

@@ -1,3 +1,3 @@
 module Deferring
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

data/spec/lib/deferring_has_many_spec.rb

@@ -359,6 +359,58 @@ RSpec.describe 'deferred has_many associations' do
       people = Person.all
       expect(people[1].issues.loaded?).to be_falsey
     end
+
+    describe 'count' do
+      it 'should not load the association' do
+        person = Person.where(name: 'Bob').first
+        expect(person.issues.count).to eq(2)
+        expect(person.issues.loaded?).to be_falsey
+      end
+
+      it 'should execute a count(*) query, even if the association has already been loaded' do
+        person = Person.where(name: 'Bob').first
+        expect { person.issues.count }.to query(1) { |sql| expect(sql).to include('SELECT COUNT(*) FROM "issues"') }
+        expect { person.issues.to_a }.to query(1)
+        expect(person.issues.loaded?).to be_truthy
+        expect { person.issues.to_a }.to query(0)
+        expect { person.issues.count }.to query(1) { |sql| expect(sql).to include('SELECT COUNT(*) FROM "issues"') }
+      end
+    end
+
+    describe 'size' do
+      it 'should not load the association' do
+        person = Person.where(name: 'Bob').first
+        expect(person.issues.size).to eq(2)
+        expect { person.issues.size }.to query(1) { |sql| expect(sql).to include('SELECT COUNT(*) FROM "issues"') }
+        expect(person.issues.loaded?).to be_falsey
+      end
+
+      it 'should not execute query when the association has already been loaded' do
+        person = Person.where(name: 'Bob').first
+        expect { person.issues.size }.to query(1) { |sql| expect(sql).to include('SELECT COUNT(*) FROM "issues"') }
+        expect { person.issues.to_a }.to query(1)
+        expect(person.issues.loaded?).to be_truthy
+        expect { person.issues.to_a }.to query(0)
+        expect { person.issues.size }.to query(0)
+      end
+    end
+
+    describe 'empty?' do
+      it 'should not load the association' do
+        person = Person.where(name: 'Bob').first
+        expect(person.issues.empty?).to be_falsey
+        expect(person.issues.loaded?).to be_falsey
+      end
+
+      it 'should not execute query when the association has already been loaded' do
+        person = Person.where(name: 'Bob').first
+        expect { person.issues.empty? }.to query(1) { |sql| expect(sql).to include('SELECT 1') }
+        expect { person.issues.to_a }.to query(1)
+        expect(person.issues.loaded?).to be_truthy
+        expect { person.issues.to_a }.to query(0)
+        expect { person.issues.empty? }.to query(0)
+      end
+    end
   end # preloading associations
 
   describe 'active record api' do

data/spec/lib/deferring_nested_attributes_spec.rb

@@ -9,7 +9,6 @@ RSpec.describe 'deferred accepts_nested_attributes' do
     Team.create!(name: 'Database Administration')
     Team.create!(name: 'End-User Support')
     Team.create!(name: 'Operations')
-
   end
 
   let(:bob) { Person.where(name: 'Bob').first }
@@ -48,21 +47,4 @@ RSpec.describe 'deferred accepts_nested_attributes' do
     expect(p.team_ids.sort).to eq([1])
   end
 
-  it '' do
-    issue = Issue.create!(subject: 'Foo', person: bob)
-
-    p = Person.where(name: 'Alice').take
-    p.attributes = {
-      issues_attributes: [
-        { id: issue.id },
-      ]
-    }
-    p.save!
-
-    p.reload
-    expect(p.issues.size).to eq(1)
-
-    bob.reload
-    expect(bob.issues.size).to eq(0)
-  end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'support/models/team'
 require 'support/models/issue'
 require 'support/models/address'
 require 'support/models/non_validated_issue'
+require 'support/matchers/query_matcher'
 
 RSpec.configure do |config|
   config.disable_monkey_patching!
@@ -18,6 +19,8 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 
+  config.include(Deferring::Matchers)
+
   # Rollback all the database changes after each spec, poor man's
   # DatabaseCleaner :-)
   config.around do |example|

data/spec/support/matchers/query_matcher.rb

@@ -0,0 +1,127 @@
+module Deferring
+  module Matchers
+
+    class ArQuery  #:nodoc:
+      cattr_accessor :executed
+
+      @@recording_queries = false
+      def self.recording_queries?
+        @@recording_queries
+      end
+
+      def initialize(expected, &block)
+        @expected = expected
+        @block = block
+      end
+
+      def matches?(given_proc)
+        @eval_block = false
+        @eval_error = nil
+        ArQuery.executed = []
+        @@recording_queries = true
+
+        given_proc.call
+
+        if @expected.is_a?(Integer)
+          @actual = ArQuery.executed.length
+          @matched = @actual == @expected
+        else
+          @actual = ArQuery.executed.detect { |sql| @expected === sql }
+          @matched = !@actual.nil?
+        end
+
+        eval_block if @block && @matched && !negative_expectation?
+
+      ensure
+        ArQuery.executed = nil
+        @@recording_queries = false
+        return @matched && @eval_error.nil?
+      end
+
+      def eval_block
+        @eval_block = true
+        begin
+          @block[ArQuery.executed]
+        rescue => err
+          @eval_error = err
+        end
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      def failure_message
+        if @eval_error
+          @eval_error.message
+        elsif @expected.is_a?(Integer)
+          "expected #{@expected}, got #{@actual}"
+        else
+          "expected to execute a query with pattern #{@expected.inspect}, but it wasn't"
+        end
+      end
+
+      def failure_message_when_negated
+        if @expected.is_a?(Integer)
+          "did not expect #{@expected}"
+        else
+          "did not expect to execute a query with pattern #{@expected.inspect}, but it was executed"
+        end
+      end
+
+      def description
+        if @expected.is_a?(Integer)
+          @expected == 1 ? 'execute 1 query' : "execute #{@expected} queries"
+        else
+          "execute query with pattern #{@expected.inspect}"
+        end
+      end
+
+      def negative_expectation?
+        @negative_expectation ||= !caller.first(3).find { |s| s =~ /should_not/ }.nil?
+      end
+    end
+
+    def query(expected = 1, &block)
+      ArQuery.new(expected, &block)
+    end
+  end
+end
+
+# For Rails 6.0
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLite3
+      module DatabaseStatements
+        [:exec_query, :exec, :execute].each do |method|
+          if respond_to?(method)
+            define_method("#{method}_with_query_record") do |sql, *args|
+              Deferring::Matchers::ArQuery.executed << sql if Deferring::Matchers::ArQuery.recording_queries?
+              send("#{method}_without_query_record", sql, *args)
+            end
+
+            alias_method :"#{method}_without_query_record", method
+            alias_method method, :"#{method}_with_query_record"
+          end
+        end
+      end
+    end
+  end
+end
+
+# For previous versions of Rails
+module ActiveRecord
+  module ConnectionAdapters
+    class SQLite3Adapter
+      [:exec_query, :exec, :execute].each do |method|
+        define_method("#{method}_with_query_record") do |sql, *args|
+          Deferring::Matchers::ArQuery.executed << sql if Deferring::Matchers::ArQuery.recording_queries?
+          send("#{method}_without_query_record", sql, *args)
+        end
+
+        alias_method :"#{method}_without_query_record", method
+        alias_method method, :"#{method}_with_query_record"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deferring
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Robin Roestenburg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -116,6 +116,7 @@ files:
 - spec/lib/deferring_nested_attributes_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
+- spec/support/matchers/query_matcher.rb
 - spec/support/models/address.rb
 - spec/support/models/issue.rb
 - spec/support/models/non_validated_issue.rb
@@ -151,6 +152,7 @@ test_files:
 - spec/lib/deferring_nested_attributes_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
+- spec/support/matchers/query_matcher.rb
 - spec/support/models/address.rb
 - spec/support/models/issue.rb
 - spec/support/models/non_validated_issue.rb