batch-loader-active-record 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20d915e2884c4153776b3acac5c148360e66209b
-  data.tar.gz: 7580228d4074580c688d5561ad4a3c69e599738e
+  metadata.gz: 677a8d4077a4cb32b88a1622cf0ff134b8ee496f
+  data.tar.gz: 1379446245d1cfda4b6e24b533ea6cbf10dde8ea
 SHA512:
-  metadata.gz: 923e068adecf32ee7df60441628672ec324898ba36d5c29f866042d8ec4e6af692b19a0fa9b8c483dfdeee04066d7cf455f22c279023dd10adc997a8fa867e40
-  data.tar.gz: f505bc5a8cfff63725a04b756f8f022c6bc95543ae734a6c8fe49e86169fb6ec18655122954cef56b5724b4ae5fe8a3079bbebc13e10bc5732bcd6cfc2fec8d7
+  metadata.gz: 4d4084ac2f43f85b4a1cb67cd7ed122b23ed79af1f62abb6a61afe9c09ef094f4b5934541799417d0e81f32e2d0b330c0d5b708fc5baed3f4136242efec357b1
+  data.tar.gz: 5fb6c5f42f3144b2b65af518efb714f372f2b48270dead47fa0892616daceca53e4d5a7c91b23095ea25a57a3b72977659154e02df7448f39a0e08622490131e

data/CHANGELOG.md

@@ -4,6 +4,10 @@ Unreleased
 
 * none
 
+v0.4.0
+
+* support `has_and_belongs_to` associations
+
 v0.3.1
 
 * allow to decouple declaring the assocation with Active Record DSL and generate a lazy association accessor with `association_accessor`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    batch-loader-active-record (0.3.1)
+    batch-loader-active-record (0.4.0)
       activerecord (>= 4.2.0, < 5.2.0)
       activesupport (>= 4.2.0, < 5.2.0)
       batch-loader (~> 1.2.0)

data/README.md

@@ -21,6 +21,7 @@ It is also possible to use one of the macros below in replacement of the origina
 * `belongs_to_lazy`
 * `has_one_lazy`
 * `has_many_lazy`
+* `has_and_belongs_to_many_lazy`
 
 As soon as your lazy association accessor needs to do more than fetch all records of an association (using a scope or not), you're going to want to directly use the batch-loader gem. For more details on N+1 queries read the [batch-loader gem README](https://github.com/exAspArk/batch-loader/#why).
 
@@ -133,7 +134,7 @@ end
 
 class PhoneNumber < ActiveRecord::Base
   belongs_to :contact
-  scope :active, -> { where(enabled: true) }
+  scope :enabled, -> { where(enabled: true) }
 end
 ```
 
@@ -143,10 +144,10 @@ This time we want the list of phone numbers for a collection of contacts.
 contacts.map(&:phone_numbers_lazy).flatten
 ```
 
-It is also possible to apply scopes and conditions to a lazy has_many association. For instance if we want to only fetch active phone numbers in the example above, you would specify the scope like so:
+It is also possible to apply scopes and conditions to a lazy has_many association. For instance if we want to only fetch enabled phone numbers in the example above, you would specify the scope like so:
 
 ```ruby
-contacts.map { |contact| contact.phone_numbers_lazy(PhoneNumber.active) }.flatten
+contacts.map { |contact| contact.phone_numbers_lazy(PhoneNumber.enabled) }.flatten
 ```
 
 
@@ -194,6 +195,28 @@ INNER JOIN agents ON agents.ID = phones.agent_id
 WHERE (agents. ID IN(4212, 265, 2309))
 ```
 
+### Has And Belongs To Many ###
+
+Consider the following data model:
+
+```ruby
+class User < ActiveRecord::Base
+  include BatchLoaderActiveRecord
+  has_and_belongs_to_many :roles
+  association_accessor :roles
+end
+
+class Role < ActiveRecord::Base
+  has_and_belongs_to_many :users
+end
+```
+
+This time we want the list of roles for a collection of users.
+
+```ruby
+users.map(&:roles_lazy).flatten
+```
+
 
 ## Development
 

data/lib/batch_loader_active_record.rb

@@ -10,13 +10,6 @@ module BatchLoaderActiveRecord
   end
 
   module ClassMethods
-    def belongs_to_lazy(*args)
-      belongs_to(*args).tap do |reflections|
-        manager = AssociationManager.new(model: self, reflection: reflections.values.last)
-        define_method(manager.accessor_name) { manager.belongs_to_batch_loader(self) }
-      end
-    end
-
     def association_accessor(name)
       reflection = reflect_on_association(name) or raise "Can't find association #{name.inspect}"
       manager = AssociationManager.new(model: self, reflection: reflection)
@@ -29,11 +22,22 @@ module BatchLoaderActiveRecord
         define_method(manager.accessor_name) do |instance_scope = nil|
           manager.has_many_to_batch_loader(self, instance_scope)
         end
+      when :has_and_belongs_to_many
+        define_method(manager.accessor_name) do |instance_scope = nil|
+          manager.has_and_belongs_to_many_to_batch_loader(self, instance_scope)
+        end
       else
         raise NotImplementedError, "association kind #{reflection.macro.inspect} is not yet supported"
       end
     end
 
+    def belongs_to_lazy(*args)
+      belongs_to(*args).tap do |reflections|
+        manager = AssociationManager.new(model: self, reflection: reflections.values.last)
+        define_method(manager.accessor_name) { manager.belongs_to_batch_loader(self) }
+      end
+    end
+
     def has_one_lazy(*args)
       has_one(*args).tap do |reflections|
         manager = AssociationManager.new(model: self, reflection: reflections.values.last)
@@ -49,5 +53,14 @@ module BatchLoaderActiveRecord
         end
       end
     end
+
+    def has_and_belongs_to_many_lazy(*args)
+      has_and_belongs_to_many(*args).tap do |reflections|
+        manager = AssociationManager.new(model: self, reflection: reflect_on_all_associations.last)
+        define_method(manager.accessor_name) do |instance_scope = nil|
+          manager.has_and_belongs_to_many_to_batch_loader(self, instance_scope)
+        end
+      end
+    end
   end
 end

data/lib/batch_loader_active_record/association_manager.rb

@@ -31,11 +31,7 @@ module BatchLoaderActiveRecord
       custom_key = batch_key
       custom_key += [instance_scope.to_sql.hash] unless instance_scope.nil?
       BatchLoader.for(instance.id).batch(default_value: [], key: custom_key) do |model_ids, loader|
-        relation = if instance_scope.nil?
-          target_scope
-        else
-          target_scope.instance_eval { instance_scope }
-        end
+        relation = relation_with_scope(instance_scope)
         if reflection.through_reflection?
           instances = fetch_for_model_ids(model_ids, relation: relation)
           instances.each do |instance|
@@ -49,8 +45,29 @@ module BatchLoaderActiveRecord
       end
     end
 
+    def has_and_belongs_to_many_to_batch_loader(instance, instance_scope)
+      BatchLoader.for(instance.id).batch(default_value: [], key: batch_key) do |model_ids, loader|
+        instance_id_path = "#{reflection.join_table}.#{reflection.foreign_key}"
+        relation_with_scope(instance_scope)
+          .joins(habtm_join(reflection))
+          .where("#{reflection.join_table}.#{reflection.foreign_key} IN (?)", model_ids)
+          .select("#{target_scope.table_name}.*, #{instance_id_path} AS _instance_id")
+          .each do |instance|
+            loader.call(instance.public_send(:_instance_id)) { |value| value << instance }
+          end
+      end
+    end
+
     private
 
+    def relation_with_scope(instance_scope)
+      if instance_scope.nil?
+        target_scope
+      else
+        target_scope.instance_eval { instance_scope }
+      end
+    end
+
     def target_scope
       @target_scope ||= if reflection.scope.nil?
         reflection.klass
@@ -115,5 +132,13 @@ module BatchLoaderActiveRecord
       end
       "#{model_class.table_name}.#{id_column}"
     end
+
+    def habtm_join(reflection)
+      <<~SQL
+        INNER JOIN #{reflection.join_table}
+                ON #{reflection.join_table}.#{reflection.association_foreign_key} =
+                   #{reflection.klass.table_name}.#{reflection.active_record.primary_key}
+      SQL
+    end
   end
 end

data/lib/batch_loader_active_record/version.rb

@@ -1,3 +1,3 @@
 module BatchLoaderActiveRecord
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch-loader-active-record
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - mathieul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-26 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: batch-loader