pluckers 1.0.0

data/lib/pluckers/features/active_record_4_1/has_one_reflections.rb

@@ -0,0 +1,17 @@
+require_relative '../base/has_one_reflections'
+
+module Pluckers
+  module Features
+    module HasOneReflections
+
+      def active_record_has_one_reflection? reflection
+        reflection.is_a?(ActiveRecord::Reflection::AssociationReflection) &&
+        (reflection.macro == :has_one)
+      end
+
+      include Pluckers::Features::Base::HasOneReflections
+
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_1/has_one_through_reflections.rb

@@ -0,0 +1,17 @@
+require_relative '../base/has_one_through_reflections'
+
+module Pluckers
+  module Features
+    module HasOneThroughReflections
+
+      def active_record_has_one_through_reflection? reflection
+        reflection.is_a?(ActiveRecord::Reflection::ThroughReflection) &&
+        (reflection.macro == :has_one)
+      end
+
+      include Pluckers::Features::Base::HasOneThroughReflections
+
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_1/pluck.rb

@@ -0,0 +1,11 @@
+require_relative '../base/pluck'
+
+module Pluckers
+  module Features
+    module Pluck
+
+      include Pluckers::Features::Base::Pluck
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_1/renaming.rb

@@ -0,0 +1,11 @@
+require_relative '../base/renaming'
+
+module Pluckers
+  module Features
+    module Renaming
+
+      include Pluckers::Features::Base::Renaming
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_1/simple_attributes.rb

@@ -0,0 +1,11 @@
+require_relative '../base/simple_attributes'
+
+module Pluckers
+  module Features
+    module SimpleAttributes
+
+      include Pluckers::Features::Base::SimpleAttributes
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_1.rb

@@ -0,0 +1,10 @@
+require_relative 'active_record_4_1/simple_attributes'
+require_relative 'active_record_4_1/belongs_to_reflections'
+require_relative 'active_record_4_1/has_many_reflections'
+require_relative 'active_record_4_1/has_many_through_reflections'
+require_relative 'active_record_4_1/has_and_belongs_to_many_reflections'
+require_relative 'active_record_4_1/has_one_reflections'
+require_relative 'active_record_4_1/has_one_through_reflections'
+require_relative 'active_record_4_1/renaming'
+require_relative 'active_record_4_1/globalize'
+require_relative 'active_record_4_1/pluck'

data/lib/pluckers/features/active_record_4_2/belongs_to_reflections.rb

@@ -0,0 +1,15 @@
+require_relative '../base/belongs_to_reflections'
+
+module Pluckers
+  module Features
+    module BelongsToReflections
+
+      def active_record_belongs_to_reflection? reflection
+        reflection.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+      end
+
+      include Pluckers::Features::Base::BelongsToReflections
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2/globalize.rb

@@ -0,0 +1,11 @@
+require_relative '../base/globalize'
+
+module Pluckers
+  module Features
+    module Globalize
+
+      include Pluckers::Features::Base::Globalize
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2/has_and_belongs_to_many_reflections.rb

@@ -0,0 +1,39 @@
+require_relative '../base/has_and_belongs_to_many_reflections'
+
+module Pluckers
+  module Features
+    module HasAndBelongsToManyReflections
+
+      def active_record_has_and_belongs_to_many_reflection? reflection
+        reflection.is_a? ActiveRecord::Reflection::HasAndBelongsToManyReflection
+      end
+
+      def has_and_belongs_to_many_ids klass_reflection
+
+        # First,  we get the the join table
+        join_table = Arel::Table.new(klass_reflection.join_table)
+
+        # And now, the foreign_keys.
+        # In our example with BlogPost and Category they would be:
+        # model_foreign_key = blog_post_id
+        # related_model_foreign_key = category_id
+        model_foreign_key = klass_reflection.foreign_key
+        related_model_foreign_key = klass_reflection.association_foreign_key
+
+        # Now we query the join table so we get the two ids
+        ids_query = join_table.where(
+            join_table[model_foreign_key].in(@results.map{|_, r| r[:id] })
+          ).project(
+            join_table[related_model_foreign_key],
+            join_table[model_foreign_key]
+          )
+
+        join_results = ActiveRecord::Base.connection.execute(ids_query.to_sql)
+
+      end
+
+      include Pluckers::Features::Base::HasAndBelongsToManyReflections
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2/has_many_reflections.rb

@@ -0,0 +1,15 @@
+require_relative '../base/has_many_reflections'
+
+module Pluckers
+  module Features
+    module HasManyReflections
+
+      def active_record_has_many_reflection? reflection
+        reflection.is_a? ActiveRecord::Reflection::HasManyReflection
+      end
+
+      include Pluckers::Features::Base::HasManyReflections
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2/has_many_through_reflections.rb

@@ -0,0 +1,17 @@
+require_relative '../base/has_many_through_reflections'
+
+module Pluckers
+  module Features
+    module HasManyThroughReflections
+
+      def active_record_has_many_through_reflection? reflection
+        reflection.is_a?(ActiveRecord::Reflection::ThroughReflection) &&
+        reflection.delegate_reflection.is_a?(ActiveRecord::Reflection::HasManyReflection)
+      end
+
+      include Pluckers::Features::Base::HasManyThroughReflections
+
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2/has_one_reflections.rb

@@ -0,0 +1,16 @@
+require_relative '../base/has_one_reflections'
+
+module Pluckers
+  module Features
+    module HasOneReflections
+
+      def active_record_has_one_reflection? reflection
+        reflection.is_a? ActiveRecord::Reflection::HasOneReflection
+      end
+
+      include Pluckers::Features::Base::HasOneReflections
+
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2/has_one_through_reflections.rb

@@ -0,0 +1,17 @@
+require_relative '../base/has_one_through_reflections'
+
+module Pluckers
+  module Features
+    module HasOneThroughReflections
+
+      def active_record_has_one_through_reflection? reflection
+        reflection.is_a?(ActiveRecord::Reflection::ThroughReflection) &&
+        reflection.delegate_reflection.is_a?(ActiveRecord::Reflection::HasOneReflection)
+      end
+
+      include Pluckers::Features::Base::HasOneThroughReflections
+
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2/pluck.rb

@@ -0,0 +1,11 @@
+require_relative '../base/pluck'
+
+module Pluckers
+  module Features
+    module Pluck
+
+      include Pluckers::Features::Base::Pluck
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2/renaming.rb

@@ -0,0 +1,11 @@
+require_relative '../base/renaming'
+
+module Pluckers
+  module Features
+    module Renaming
+
+      include Pluckers::Features::Base::Renaming
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2/simple_attributes.rb

@@ -0,0 +1,11 @@
+require_relative '../base/simple_attributes'
+
+module Pluckers
+  module Features
+    module SimpleAttributes
+
+      include Pluckers::Features::Base::SimpleAttributes
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_4_2.rb

@@ -0,0 +1,10 @@
+require_relative 'active_record_4_2/simple_attributes'
+require_relative 'active_record_4_2/belongs_to_reflections'
+require_relative 'active_record_4_2/has_many_reflections'
+require_relative 'active_record_4_2/has_many_through_reflections'
+require_relative 'active_record_4_2/has_and_belongs_to_many_reflections'
+require_relative 'active_record_4_2/has_one_reflections'
+require_relative 'active_record_4_2/has_one_through_reflections'
+require_relative 'active_record_4_2/renaming'
+require_relative 'active_record_4_2/globalize'
+require_relative 'active_record_4_2/pluck'

data/lib/pluckers/features/active_record_5_0/belongs_to_reflections.rb

@@ -0,0 +1,15 @@
+require_relative '../base/belongs_to_reflections'
+
+module Pluckers
+  module Features
+    module BelongsToReflections
+
+      def active_record_belongs_to_reflection? reflection
+        reflection.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+      end
+
+      include Pluckers::Features::Base::BelongsToReflections
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0/globalize.rb

@@ -0,0 +1,11 @@
+require_relative '../base/globalize'
+
+module Pluckers
+  module Features
+    module Globalize
+
+      include Pluckers::Features::Base::Globalize
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0/has_and_belongs_to_many_reflections.rb

@@ -0,0 +1,39 @@
+require_relative '../base/has_and_belongs_to_many_reflections'
+
+module Pluckers
+  module Features
+    module HasAndBelongsToManyReflections
+
+      def active_record_has_and_belongs_to_many_reflection? reflection
+        reflection.is_a? ActiveRecord::Reflection::HasAndBelongsToManyReflection
+      end
+
+      def has_and_belongs_to_many_ids klass_reflection
+
+        # First,  we get the the join table
+        join_table = Arel::Table.new(klass_reflection.join_table)
+
+        # And now, the foreign_keys.
+        # In our example with BlogPost and Category they would be:
+        # model_foreign_key = blog_post_id
+        # related_model_foreign_key = category_id
+        model_foreign_key = klass_reflection.foreign_key
+        related_model_foreign_key = klass_reflection.association_foreign_key
+
+        # Now we query the join table so we get the two ids
+        ids_query = join_table.where(
+            join_table[model_foreign_key].in(@results.map{|_, r| Arel::Nodes::Quoted.new(r[:id]) })
+          ).project(
+            join_table[related_model_foreign_key],
+            join_table[model_foreign_key]
+          )
+
+        join_results = ActiveRecord::Base.connection.execute(ids_query.to_sql)
+
+      end
+
+      include Pluckers::Features::Base::HasAndBelongsToManyReflections
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0/has_many_reflections.rb

@@ -0,0 +1,15 @@
+require_relative '../base/has_many_reflections'
+
+module Pluckers
+  module Features
+    module HasManyReflections
+
+      def active_record_has_many_reflection? reflection
+        reflection.is_a? ActiveRecord::Reflection::HasManyReflection
+      end
+
+      include Pluckers::Features::Base::HasManyReflections
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0/has_many_through_reflections.rb

@@ -0,0 +1,17 @@
+require_relative '../base/has_many_through_reflections'
+
+module Pluckers
+  module Features
+    module HasManyThroughReflections
+
+      def active_record_has_many_through_reflection? reflection
+        reflection.is_a?(ActiveRecord::Reflection::ThroughReflection) &&
+        reflection.delegate_reflection.is_a?(ActiveRecord::Reflection::HasManyReflection)
+      end
+
+      include Pluckers::Features::Base::HasManyThroughReflections
+
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0/has_one_reflections.rb

@@ -0,0 +1,16 @@
+require_relative '../base/has_one_reflections'
+
+module Pluckers
+  module Features
+    module HasOneReflections
+
+      def active_record_has_one_reflection? reflection
+        reflection.is_a? ActiveRecord::Reflection::HasOneReflection
+      end
+
+      include Pluckers::Features::Base::HasOneReflections
+
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0/has_one_through_reflections.rb

@@ -0,0 +1,17 @@
+require_relative '../base/has_one_through_reflections'
+
+module Pluckers
+  module Features
+    module HasOneThroughReflections
+
+      def active_record_has_one_through_reflection? reflection
+        reflection.is_a?(ActiveRecord::Reflection::ThroughReflection) &&
+        reflection.delegate_reflection.is_a?(ActiveRecord::Reflection::HasOneReflection)
+      end
+
+      include Pluckers::Features::Base::HasOneThroughReflections
+
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0/pluck.rb

@@ -0,0 +1,11 @@
+require_relative '../base/pluck'
+
+module Pluckers
+  module Features
+    module Pluck
+
+      include Pluckers::Features::Base::Pluck
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0/renaming.rb

@@ -0,0 +1,11 @@
+require_relative '../base/renaming'
+
+module Pluckers
+  module Features
+    module Renaming
+
+      include Pluckers::Features::Base::Renaming
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0/simple_attributes.rb

@@ -0,0 +1,11 @@
+require_relative '../base/simple_attributes'
+
+module Pluckers
+  module Features
+    module SimpleAttributes
+
+      include Pluckers::Features::Base::SimpleAttributes
+
+    end
+  end
+end

data/lib/pluckers/features/active_record_5_0.rb

@@ -0,0 +1,10 @@
+require_relative 'active_record_5_0/simple_attributes'
+require_relative 'active_record_5_0/belongs_to_reflections'
+require_relative 'active_record_5_0/has_many_reflections'
+require_relative 'active_record_5_0/has_many_through_reflections'
+require_relative 'active_record_5_0/has_and_belongs_to_many_reflections'
+require_relative 'active_record_5_0/has_one_reflections'
+require_relative 'active_record_5_0/has_one_through_reflections'
+require_relative 'active_record_5_0/renaming'
+require_relative 'active_record_5_0/globalize'
+require_relative 'active_record_5_0/pluck'

data/lib/pluckers/features/base/belongs_to_reflections.rb

@@ -0,0 +1,131 @@
+module Pluckers
+  ##
+  # This module groups diferent modules that will configure and build the
+  # results for a specific kind of information (attributes, translations,
+  # relations...)
+  #
+  # All this modules will have two methods, one for configuration (e.g, attributes
+  # to be included in the real pluck) and one for building the final results
+  module Features
+
+    module Base
+
+      ##
+      # This module implements plucking belongs_to relationships in a recursive
+      # way.
+      #
+      # The options used in this feature are:
+      #
+      #  * reflections: A hash of the reflections we will pluck recursively. The
+      #    key of this hash will be the name of the reflection and the value is
+      #    another hash of options.
+      #
+      #    - scope: You can limit the scope of the objects plucked. E.g, you
+      #      could use Author.active instead of Author.all. Notice that .all is
+      #      the default.
+      #
+      #    - plucker: You can use a custom plucker instead of Pluckers::Base in
+      #      case you want any specific logic. Pluckers::Base is the default one.
+      #
+      #    - Any other option will be passed to the plucker, so you can send any
+      #      other regular option such as attributes, custom ones or even more
+      #      reflections. Recursivity FTW!!
+      #
+      module BelongsToReflections
+
+
+        ##
+        # Here we obtain the belongs_to reflections to include in the pluck
+        # operation and also include the relation foreign key in the attributes to
+        # pluck for this model.
+        def configure_query
+          super
+
+          pluck_reflections = @options[:reflections] || {}
+
+          return if pluck_reflections.blank?
+
+          @belongs_to_reflections = { }
+
+          # We iterate through the class reflections passed as options
+          @klass_reflections.slice(*pluck_reflections.keys).
+          # And select those that are BelongsTo
+            select{|_, r| active_record_belongs_to_reflection?(r) }.
+          # And store them in the belongs_to_reflection hash that will be used later
+            each do |name, reflection|
+              name = name.to_sym
+              @belongs_to_reflections[name] = pluck_reflections[name]
+            end
+
+          # First thing we do is to include the foreign key in the attributes to
+          # pluck array, so the base plucker plucks them
+          @belongs_to_reflections.each do |name, _|
+            foreign_key_name = @klass_reflections[name].foreign_key
+            @attributes_to_pluck << {
+              name: foreign_key_name.to_sym,
+              sql: foreign_key_name
+            }
+          end
+
+        end
+
+        ##
+        # In this method we get the reflections and for each one creates and
+        # executes a new plucker.
+        #
+        # This pluck gives the whole process a recursive character and options
+        # for that plucker may be passed in the options hash.
+        def build_results
+          super
+
+          return if @belongs_to_reflections.blank?
+          # For each reflection
+          @belongs_to_reflections.each do |name, reflection|
+            # As an example we will imagine that we are plucking BlogPosts and
+            # this relation is the Author
+
+            # We get the meta information about the reflection
+            klass_reflection = @klass_reflections[name]
+
+            # initialize some options such as the plucker or the scope of the pluck
+            scope = reflection[:scope] || klass_reflection.klass.send(all_method)
+            plucker = reflection[:plucker] || Pluckers::Base
+
+            reflection_primary_key = klass_reflection.active_record_primary_key.to_sym
+            reflection_foreign_key = klass_reflection.foreign_key.to_sym
+            # And now we create the plucker. Notice that we add a where to the
+            # scope, so we filter the records to pluck as we only get those with
+            # an id in the set of the foreign keys of the records already
+            # plucked by the base plucker
+            #
+            # In our Example we would be doing something like
+            # Author.all.where(id: author_ids)
+            reflection_plucker = plucker.new scope.where(
+                reflection_primary_key => @results.map{|_, r| r[reflection_foreign_key] }.compact
+              ),
+              reflection
+
+
+            # We initialize so we return a nil if there are no record related
+            @results.each do |_,result|
+              result[name] = nil
+            end
+
+            # And now pluck the related class and process the results
+            reflection_plucker.pluck.each do |r|
+              # For each related result (Author) we search those records
+              # (BlogPost) that are related (post.author_id == author.id) and
+              # insert them in the relationship attributes
+              @results.each do |_,result|
+                if result[reflection_foreign_key] == r[reflection_primary_key]
+                  result[name] = r
+                end
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end