Module: Pluckers::Features::Base::BelongsToReflections

Included in:
Pluckers::Features::BelongsToReflections
Defined in:
lib/pluckers/features/base/belongs_to_reflections.rb

Overview

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!!

Instance Method Summary collapse

Instance Method Details

#build_results ⇒ Object

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.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/pluckers/features/base/belongs_to_reflections.rb', line 78

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

#configure_query ⇒ Object

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.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/pluckers/features/base/belongs_to_reflections.rb', line 41

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