sequel-association-filtering 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eebfe24a7a4bc0831e9b5d983f7d49c46f1af66b531b137cbad11d65195c02dd
-  data.tar.gz: 812a28ac539eab752717576a44cd63f4e95d306c9ceeb3830f044227ec6c09db
+  metadata.gz: 04015d9861a0451c0612228e83590c6b503d39b57d5821a12bb624997710bdee
+  data.tar.gz: 79b9cb458dd9e10953e2d711d85706311dd76e27d7c30577d07019c2943d2dad
 SHA512:
-  metadata.gz: d87c8e29c99c922be6411c7f74589b3685781502a38131f7f832465a334ab62cbee3125ba0fe4c844b98d496d1c0ef49cba6091c1f96c0268a0b46bc75f665d6
-  data.tar.gz: 00155ca49d9f3f01d8b4cf7385f81bb8e72e0acb8ec2db436ee3ae74468cb606cab343ac52e62120a65b4f5c129eaa3cb3a1ea6212fdd9f30520372cc3173087
+  metadata.gz: 80bdf2c8f73d0a705c14b133b477a5cff075d81f576871fa1fb50d43336149c91d2e0d1e2a189b8acc68d7471c6cff924f1de13a604448fe750ffc622f6119b9
+  data.tar.gz: e33f89d68b1425958ea34941d9eae7c5a0b245b02a0c154b47f80e2c8621eebbb15e7937c4cb9f6eb20e664c179c79bd8d5b97e70dd3cdc1ef847d60afb76611

data/lib/sequel/plugins/association_filtering.rb

@@ -24,15 +24,17 @@ module Sequel
         def association_filter(
           association_name,
           invert: false,
-          at_least: nil,
-          at_most: nil,
-          exactly: nil
+          **extra
         )
-          case [at_least, at_most, exactly].compact.length
+          having_args = extra.slice(:at_least, :at_most, :exactly)
+
+          case having_args.length
           when 0
-            filtering_by_count = false
+            # No-op
           when 1
-            filtering_by_count = true
+            having_arg   = having_args.keys[0]
+            having_value = having_args.values[0]
+            raise Error, ":#{having_arg} must be an Integer if present" unless having_value.is_a?(Integer)
           else
             raise Error, "cannot pass more than one of :at_least, :at_most, and :exactly"
           end
@@ -42,24 +44,30 @@ module Sequel
               raise Error, "association #{association_name} not found on model #{model}"
             end
 
-          ds = _association_filter_dataset(reflection, group_by_remote: filtering_by_count)
+          ds = _association_filter_dataset(reflection, group_by_remote: !!having_arg)
           ds = yield(ds) if block_given?
 
-          if filtering_by_count
-            ds =
-              ds.having(
-                case
-                when at_least then COUNT_STAR >= at_least
-                when at_most  then COUNT_STAR <= at_most
-                when exactly  then COUNT_STAR =~ exactly
-                else raise Error, ""
-                end
-              )
-          end
+          cache_key =
+            _association_filter_cache_key(
+              reflection: reflection,
+              extra: :"#{invert}_#{having_arg}_#{having_value}",
+            )
 
-          cond = ds.exists
-          cond = Sequel.~(cond) if invert
-          where(cond)
+          ds.send :cached_dataset, cache_key do
+            having_condition =
+              case having_arg
+              when :at_least then COUNT_STAR >= having_value
+              when :at_most  then COUNT_STAR <= having_value
+              when :exactly  then COUNT_STAR =~ having_value
+              when nil       then nil
+              else raise Error, "Unexpected argument: #{having_arg.inspect}"
+              end
+
+            ds = ds.having(having_condition) if having_condition
+            cond = ds.exists
+            cond = Sequel.~(cond) if invert
+            where(cond)
+          end
         end
 
         def association_exclude(association_name, &block)
@@ -72,7 +80,7 @@ module Sequel
           cache_key =
             _association_filter_cache_key(
               reflection: reflection,
-              extra: (:group_by_remote if group_by_remote)
+              extra: :"association_#{group_by_remote}"
             )
 
           ds = reflection.associated_dataset
@@ -103,11 +111,8 @@ module Sequel
                 inject{|a,b| Sequel.&(a, b)}
               ).select(1)
 
-            if group_by_remote
-              result.group_by(*remote_keys)
-            else
-              result
-            end
+            result = result.group_by(*remote_keys) if group_by_remote
+            result
           end
         end
 

data/lib/sequel/plugins/association_filtering/version.rb

@@ -3,7 +3,7 @@
 module Sequel
   module Plugins
     module AssociationFiltering
-      VERSION = '0.0.5'
+      VERSION = '0.0.6'
     end
   end
 end

data/spec/basic_spec.rb

@@ -4,20 +4,43 @@ require 'spec_helper'
 
 class BasicSpec < AssociationFilteringSpecs
   before do
+    drop_tables
+
     DB.create_table :artists do
       primary_key :id
     end
 
+    DB.create_table :albums do
+      primary_key :id
+      foreign_key :artist_id, :artists
+    end
+
     DB.run <<-SQL
       INSERT INTO artists SELECT i FROM generate_series(1, 10) i;
+      INSERT INTO albums (artist_id) SELECT (i % 10) + 1 FROM generate_series(1, 100) i;
     SQL
 
     class Artist < Sequel::Model
+      one_to_many :albums, class: 'BasicSpec::Album'
+    end
+
+    class Album < Sequel::Model
+      many_to_one :artist, class: 'BasicSpec::Artist'
+
+      dataset_module do
+        subset :even_id, Sequel.lit('id % ? = 0', 2)
+      end
     end
   end
 
   after do
-    DB.drop_table? :artists
+    BasicSpec.send(:remove_const, :Artist)
+    BasicSpec.send(:remove_const, :Album)
+    drop_tables
+  end
+
+  def drop_tables
+    DB.drop_table? :albums, :artists
   end
 
   describe "association_filter" do
@@ -31,12 +54,62 @@ class BasicSpec < AssociationFilteringSpecs
     end
 
     it "with more than one of at_least, at_most, or exactly should throw an error" do
+      a, b = [:at_most, :exactly, :at_least].sample(2)
+
       error =
         assert_raises(Sequel::Plugins::AssociationFiltering::Error) do
-          Artist.association_filter(:widgets, at_most: 4, exactly: 5)
+          Artist.association_filter(:widgets, a => 4, b => 5)
         end
 
       assert_equal "cannot pass more than one of :at_least, :at_most, and :exactly", error.message
     end
+
+    it "with an at_least/at_most/exactly that is not an integer should raise an error" do
+      a = [:at_most, :exactly, :at_least].sample
+
+      error =
+        assert_raises(Sequel::Plugins::AssociationFiltering::Error) do
+          Artist.association_filter(:widgets, a => Object.new)
+        end
+
+      assert_equal ":#{a} must be an Integer if present", error.message
+    end
+
+    describe "cached datasets" do
+      let :seen_object_ids do
+        Set.new
+      end
+
+      def assert_cached(*args, &block)
+        ds1, ds2 = Array.new(2, Artist.association_filter(:albums, *args, &block))
+        assert_equal ds1.object_id, ds2.object_id, ds1.sql
+        assert seen_object_ids.add?(ds1.object_id), ds1.sql
+
+        ds1, ds2 = Array.new(2, Artist.association_exclude(:albums, *args, &block))
+        assert_equal ds1.object_id, ds2.object_id, ds1.sql
+        assert seen_object_ids.add?(ds1.object_id), ds1.sql
+      end
+
+      def refute_cached(&block)
+        ds1, ds2 = Array.new(2, &block)
+        refute_equal ds1.object_id, ds2.object_id, ds1.sql
+      end
+
+      it "should be able to return a cached dataset" do
+        assert_cached { Artist.association_filter(:albums) }
+        assert_cached { Artist.association_filter(:albums, &:even_id) }
+
+        assert_cached { Artist.association_filter(:albums, at_least: 2) }
+        assert_cached { Artist.association_filter(:albums, at_least: 3) }
+        assert_cached { Artist.association_filter(:albums, exactly:  2) }
+        assert_cached { Artist.association_filter(:albums, at_most:  2) }
+
+        assert_cached { Artist.association_filter(:albums, at_least: 2, &:even_id) }
+      end
+
+      it "should not cache potentially dynamic datasets" do
+        refute_cached { Artist.association_filter(:albums){|a| a.where(artist_id: 2)} }
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-association-filtering
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Chris Hanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-29 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler