Class: Graphiti::Sideload

Inherits:
Object show all
Defined in:
lib/graphiti/sideload.rb

Direct Known Subclasses

BelongsTo, HasMany

Defined Under Namespace

Classes: BelongsTo, HasMany, HasOne, ManyToMany, PolymorphicBelongsTo

Constant Summary collapse

HOOK_ACTIONS = 
[:save, :create, :update, :destroy, :disassociate]
TYPES = 
[:has_many, :belongs_to, :has_one, :many_to_many]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, opts) ⇒ Sideload

Returns a new instance of Sideload.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/graphiti/sideload.rb', line 20

def initialize(name, opts)
  @name = name
  validate_options!(opts)
  translate_deprecated_options!(opts)
  @parent_resource_class = opts[:parent_resource]
  @resource_class_name = opts[:resource]
  @primary_key = opts[:primary_key]
  @foreign_key = opts[:foreign_key]
  @type = opts[:type]
  @base_scope = opts[:base_scope]
  @readable = opts[:readable]
  @writable = opts[:writable]
  @as = opts[:as]
  @link = opts[:link]
  @single = opts[:single]
  @remote = opts[:remote]
  apply_belongs_to_many_filter if type == :many_to_many

  @description = opts[:description]

  # polymorphic has_many
  @polymorphic_as = opts[:polymorphic_as]
  # polymorphic_belongs_to-specific
  @group_name = opts[:group_name]
  @polymorphic_child = opts[:polymorphic_child]
  @parent = opts[:parent]
  @render_resource_ids = opts[:resource_ids]

  if polymorphic_child?
    parent.resource.polymorphic << resource_class
  end

  if remote?
    @resource_class = create_remote_resource
  end
end

Instance Attribute Details

#group_name ⇒ Object (readonly)

Returns the value of attribute group_name.



6
7
8
 
# File 'lib/graphiti/sideload.rb', line 6

def group_name
  @group_name
end

#link ⇒ Object (readonly)

Returns the value of attribute link.



6
7
8
 
# File 'lib/graphiti/sideload.rb', line 6

def link
  @link
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



6
7
8
 
# File 'lib/graphiti/sideload.rb', line 6

def name
  @name
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



6
7
8
 
# File 'lib/graphiti/sideload.rb', line 6

def parent
  @parent
end

#parent_resource_class ⇒ Object (readonly)

Returns the value of attribute parent_resource_class.



6
7
8
 
# File 'lib/graphiti/sideload.rb', line 6

def parent_resource_class
  @parent_resource_class
end

#polymorphic_as ⇒ Object (readonly)

Returns the value of attribute polymorphic_as.



6
7
8
 
# File 'lib/graphiti/sideload.rb', line 6

def polymorphic_as
  @polymorphic_as
end

Class Method Details

.after_save(only: [], except: [], &blk) ⇒ Object 



355
356
357
358
359
360
361
362
 
# File 'lib/graphiti/sideload.rb', line 355

def self.after_save(only: [], except: [], &blk)
  actions = HOOK_ACTIONS - except
  actions = only & actions
  actions = [:save] if only.empty? && except.empty?
  actions.each do |a|
    hooks[:"after_#{a}"] << blk
  end
end

.assign(&blk) ⇒ Object 



61
62
63
 
# File 'lib/graphiti/sideload.rb', line 61

def self.assign(&blk)
  self.assign_proc = blk
end

.assign_each(&blk) ⇒ Object 



65
66
67
 
# File 'lib/graphiti/sideload.rb', line 65

def self.assign_each(&blk)
  self.assign_each_proc = blk
end

.hooks ⇒ Object 



364
365
366
367
368
369
370
371
 
# File 'lib/graphiti/sideload.rb', line 364

def self.hooks
  @hooks ||= {}.tap do |h|
    HOOK_ACTIONS.each do |a|
      h[:"after_#{a}"] = []
      h[:"before_#{a}"] = []
    end
  end
end

.link(&blk) ⇒ Object 



77
78
79
 
# File 'lib/graphiti/sideload.rb', line 77

def self.link(&blk)
  self.link_proc = blk
end

.params(&blk) ⇒ Object 



69
70
71
 
# File 'lib/graphiti/sideload.rb', line 69

def self.params(&blk)
  self.params_proc = blk
end

.pre_load(&blk) ⇒ Object 



73
74
75
 
# File 'lib/graphiti/sideload.rb', line 73

def self.pre_load(&blk)
  self.pre_load_proc = blk
end

.scope(&blk) ⇒ Object 



57
58
59
 
# File 'lib/graphiti/sideload.rb', line 57

def self.scope(&blk)
  self.scope_proc = blk
end

Instance Method Details

#assign(parents, children) ⇒ Object 



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/graphiti/sideload.rb', line 310

def assign(parents, children)
  track_associated = type == :has_one
  associated = [] if track_associated
  if performant_assign?
    map = child_map(children)
  end

  parents.each do |parent|
    relevant_children = if performant_assign?
      children_for(parent, map) || []
    else
      fire_assign_each(parent, children)
    end

    if relevant_children.is_a?(Array)
      associated |= relevant_children if track_associated
      associate_all(parent, relevant_children)
    else
      associated << relevant_children if track_associated && relevant_children
      associate(parent, relevant_children)
    end
  end
  children.replace(associated) if track_associated
end

#assign_each(parent, children) ⇒ Object 



232
233
234
 
# File 'lib/graphiti/sideload.rb', line 232

def assign_each(parent, children)
  raise "Override #assign_each in subclass"
end

#associate(parent, child) ⇒ Object 



386
387
388
 
# File 'lib/graphiti/sideload.rb', line 386

def associate(parent, child)
  parent_resource.associate(parent, child, association_name, type)
end

#associate_all(parent, children) ⇒ Object 



382
383
384
 
# File 'lib/graphiti/sideload.rb', line 382

def associate_all(parent, children)
  parent_resource.associate_all(parent, children, association_name, type)
end

#association_name ⇒ Object 



219
220
221
 
# File 'lib/graphiti/sideload.rb', line 219

def association_name
  @as || name
end

#base_scope ⇒ Object 



249
250
251
252
253
254
255
 
# File 'lib/graphiti/sideload.rb', line 249

def base_scope
  if @base_scope
    @base_scope.respond_to?(:call) ? @base_scope.call : @base_scope
  else
    resource.base_scope
  end
end

#build_resource_proxy(parents, query, graph_parent) ⇒ Object 



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/graphiti/sideload.rb', line 257

def build_resource_proxy(parents, query, graph_parent)
  params = nil
  opts = nil
  proxy = nil

  with_error_handling Errors::SideloadParamsError do
    params = load_params(parents, query)
    params_proc&.call(params, parents, context)
    return [] if blank_query?(params)

    opts = load_options(parents, query)
    opts[:sideload] = self
    opts[:parent] = graph_parent
  end

  with_error_handling(Errors::SideloadQueryBuildingError) do
    scope = base_scope
    scope[:foreign_key] = foreign_key if remote?
    proxy = resource.class._all(params, opts, scope)
    pre_load_proc&.call(proxy, parents)
  end

  proxy
end

#clear_resources ⇒ Object

See https://github.com/graphiti-api/graphiti/issues/186



305
306
307
308
 
# File 'lib/graphiti/sideload.rb', line 305

def clear_resources
  @resource = nil
  @parent_resource = nil
end

#create_remote_resource ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/graphiti/sideload.rb', line 81

def create_remote_resource
  remote_url = @remote
  klass = Class.new(Graphiti::Resource) {
    self.adapter = Graphiti::Adapters::GraphitiAPI
    self.model = OpenStruct
    self.remote = remote_url
    self.validate_endpoints = false
  }
  name = "#{parent_resource_class.name}.#{@name}.remote"
  klass.class_eval("def self.name;'#{name}';end", __FILE__, __LINE__)
  klass
end

#customized_base_scope? ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/graphiti/sideload.rb', line 135

def customized_base_scope?
  !!@base_scope
end

#default_render_resource_ids? ⇒ Boolean

Returns:

  • (Boolean) 


165
166
167
 
# File 'lib/graphiti/sideload.rb', line 165

def default_render_resource_ids?
  false
end

#description ⇒ Object 



244
245
246
247
 
# File 'lib/graphiti/sideload.rb', line 244

def description
  return @description if @description.present?
  parent_resource_class.resolve_i18n_field_description(name, field_type: :relationships)
end

#disassociate(parent, child) ⇒ Object 



390
391
392
 
# File 'lib/graphiti/sideload.rb', line 390

def disassociate(parent, child)
  parent_resource.disassociate(parent, child, association_name, type)
end

#errors ⇒ Object 



94
95
96
 
# File 'lib/graphiti/sideload.rb', line 94

def errors
  @errors ||= []
end

#fire_hooks!(parent, objects, method) ⇒ Object 



373
374
375
376
377
378
379
380
 
# File 'lib/graphiti/sideload.rb', line 373

def fire_hooks!(parent, objects, method)
  return unless self.class.hooks

  all = self.class.hooks[:"after_#{method}"] + self.class.hooks[:after_save]
  all.compact.each do |hook|
    resource.instance_exec(parent, objects, &hook)
  end
end

#foreign_key ⇒ Object 



215
216
217
 
# File 'lib/graphiti/sideload.rb', line 215

def foreign_key
  @foreign_key ||= infer_foreign_key
end

#future_resolve(parents, query, graph_parent) ⇒ Object 



343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/graphiti/sideload.rb', line 343

def future_resolve(parents, query, graph_parent)
  assert_singular!(parents)

  if self.class.scope_proc
    build_sideload_scope(parents, query, graph_parent).future_resolve do |sideload_results|
      fire_assign(parents, sideload_results)
    end
  else
    future_load(parents, query, graph_parent)
  end
end

#guarded? ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/graphiti/sideload.rb', line 110

def guarded?
  dynamic_flag?(@readable) || dynamic_flag?(@writable)
end

#ids_for_parents(parents) ⇒ Object 



394
395
396
397
398
399
 
# File 'lib/graphiti/sideload.rb', line 394

def ids_for_parents(parents)
  parent_ids = parents.map(&primary_key)
  parent_ids.compact!
  parent_ids.uniq!
  parent_ids
end

#infer_foreign_key ⇒ Object

Override in subclass



289
290
291
292
293
294
 
# File 'lib/graphiti/sideload.rb', line 289

def infer_foreign_key
  model = parent_resource_class.model
  namespace = namespace_for(model)
  model_name = model.name.gsub("#{namespace}::", "")
  :"#{model_name.underscore}_id"
end

#link? ⇒ Boolean

Returns:

  • (Boolean) 


169
170
171
172
173
174
175
176
177
 
# File 'lib/graphiti/sideload.rb', line 169

def link?
  return true if link_proc

  if @link.nil?
    !!@parent_resource_class.autolink
  else
    !!@link
  end
end

#link_extra_fields ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/graphiti/sideload.rb', line 183

def link_extra_fields
  return unless context&.respond_to?(:params)

  extra_fields_name = [association_name, resource.type].find { |param|
    context.params.dig(:extra_fields, param)
  }

  if extra_fields_name
    extra_fields = context.params.dig(:extra_fields, extra_fields_name)
    {resource.type => extra_fields}
  end
end

#link_filter(parents) ⇒ Object 



179
180
181
 
# File 'lib/graphiti/sideload.rb', line 179

def link_filter(parents)
  base_filter(parents)
end

#load(parents, query, graph_parent) ⇒ Object 



282
283
284
285
286
 
# File 'lib/graphiti/sideload.rb', line 282

def load(parents, query, graph_parent)
  return build_resource_proxy(parents, query, graph_parent).to_a unless Graphiti.config.concurrency

  future_load(parents, query, graph_parent).value!
end

#load_params(parents, query) ⇒ Object 



240
241
242
 
# File 'lib/graphiti/sideload.rb', line 240

def load_params(parents, query)
  raise "Override #load_params in subclass"
end

#non_default_options ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/graphiti/sideload.rb', line 122

def non_default_options
  options = {}
  options[:as] = association_name if @as
  options[:primary_key] = primary_key unless primary_key == :id
  options[:single] = true if single?
  options[:remote] = @remote if remote?
  options[:link] = @link unless @link.nil?
  options[:readable] = @readable unless @readable.nil? || @readable == true
  options[:writable] = @writable unless @writable.nil? || @writable == true
  options[:resource_ids] = @render_resource_ids unless @render_resource_ids.nil?
  options
end

#parent_resource ⇒ Object 



300
301
302
 
# File 'lib/graphiti/sideload.rb', line 300

def parent_resource
  @parent_resource ||= parent_resource_class.new
end

#performant_assign? ⇒ Boolean

Returns:

  • (Boolean) 


401
402
403
 
# File 'lib/graphiti/sideload.rb', line 401

def performant_assign?
  !self.class.assign_each_proc
end

#polymorphic_child? ⇒ Boolean

Returns:

  • (Boolean) 


207
208
209
 
# File 'lib/graphiti/sideload.rb', line 207

def polymorphic_child?
  !!@polymorphic_child
end

#polymorphic_has_many? ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/graphiti/sideload.rb', line 147

def polymorphic_has_many?
  !!@polymorphic_as
end

#polymorphic_has_one? ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/graphiti/sideload.rb', line 143

def polymorphic_has_one?
  !!@polymorphic_as
end

#polymorphic_parent? ⇒ Boolean

Returns:

  • (Boolean) 


203
204
205
 
# File 'lib/graphiti/sideload.rb', line 203

def polymorphic_parent?
  resource.polymorphic?
end

#primary_key ⇒ Object 



211
212
213
 
# File 'lib/graphiti/sideload.rb', line 211

def primary_key
  @primary_key ||= :id
end

#readable? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/graphiti/sideload.rb', line 102

def readable?
  evaluate_flag @readable
end

#readable_guard_name ⇒ Object 



118
119
120
 
# File 'lib/graphiti/sideload.rb', line 118

def readable_guard_name
  @readable.to_sym if @readable.is_a?(Symbol) || @readable.is_a?(String)
end

#readable_guarded? ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/graphiti/sideload.rb', line 114

def readable_guarded?
  dynamic_flag?(@readable)
end

#remote? ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/graphiti/sideload.rb', line 98

def remote?
  !!@remote
end

#render_resource_ids? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
162
163
 
# File 'lib/graphiti/sideload.rb', line 159

def render_resource_ids?
  return !!@render_resource_ids unless @render_resource_ids.nil?

  default_render_resource_ids?
end

#resolve(parents, query, graph_parent) ⇒ Object 



335
336
337
338
339
340
341
 
# File 'lib/graphiti/sideload.rb', line 335

def resolve(parents, query, graph_parent)
  if Graphiti.config.concurrency
    future_resolve(parents, query, graph_parent).value!
  else
    sync_resolve(parents, query, graph_parent)
  end
end

#resource ⇒ Object 



296
297
298
 
# File 'lib/graphiti/sideload.rb', line 296

def resource
  @resource ||= resource_class.new
end

#resource_class ⇒ Object 



223
224
225
226
 
# File 'lib/graphiti/sideload.rb', line 223

def resource_class
  @resource_class ||= (@resource_class_name.is_a?(String) ? @resource_class_name.constantize : @resource_class_name) ||
    infer_resource_class
end

#resource_class_loaded? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


406
407
408
409
410
411
 
# File 'lib/graphiti/sideload.rb', line 406

def resource_class_loaded?
  resource_class
  true
rescue Graphiti::Errors::ResourceNotFound
  false
end

#resource_ids_blocker ⇒ Object 



155
156
157
 
# File 'lib/graphiti/sideload.rb', line 155

def resource_ids_blocker
  :no_foreign_key_on_parent
end

#resource_ids_from_foreign_key? ⇒ Boolean

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/graphiti/sideload.rb', line 151

def resource_ids_from_foreign_key?
  resource_ids_blocker.nil?
end

#scope(parents) ⇒ Object 



228
229
230
 
# File 'lib/graphiti/sideload.rb', line 228

def scope(parents)
  raise "No #scope defined for sideload with name '#{name}'. Make sure to define this in your adapter, or pass a block that defines the scope."
end

#shared_remote? ⇒ Boolean

The parent resource is a remote, AND the sideload is a remote to the same endpoint

Returns:

  • (Boolean) 


198
199
200
201
 
# File 'lib/graphiti/sideload.rb', line 198

def shared_remote?
  resource.remote? &&
    resource.remote_base_url = parent_resource_class.remote_base_url
end

#single? ⇒ Boolean

Returns:

  • (Boolean) 


139
140
141
 
# File 'lib/graphiti/sideload.rb', line 139

def single?
  !!@single
end

#type ⇒ Object 



236
237
238
 
# File 'lib/graphiti/sideload.rb', line 236

def type
  @type || raise("Override #type in subclass. Should be one of #{TYPES.inspect}")
end

#writable? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/graphiti/sideload.rb', line 106

def writable?
  evaluate_flag @writable
end