Skip to content

Refactor Side Load of ZendeskAPI::Association Into A Separate Object #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Refactor Side Load of ZendeskAPI::Association Into A Separate Object #555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db43388
Refactor side load
Aug 21, 2023
6fd2ba6
Refactor side_load into a separate class
Aug 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 3 additions & 57 deletions lib/zendesk_api/association.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
require 'zendesk_api/association_side_load'
require 'zendesk_api/helpers'

module ZendeskAPI
Expand Down Expand Up @@ -75,18 +76,8 @@ def generate_path(*args)

# Tries to place side loads onto given resources.
def side_load(resources, side_loads)
key = "#{options.name}_id"
plural_key = "#{Inflection.singular options.name.to_s}_ids"

resources.each do |resource|
if resource.key?(plural_key) # Grab associations from child_ids field on resource
side_load_from_child_ids(resource, side_loads, plural_key)
elsif resource.key?(key) || options.singular
side_load_from_child_or_parent_id(resource, side_loads, key)
else # Grab associations from parent_id field from multiple child resources
side_load_from_parent_id(resource, side_loads, key)
end
end
SideLoad.instance_variable_set '@options', options
SideLoad.side_load(resources, side_loads)
end

private
Expand All @@ -96,51 +87,6 @@ def ignorable_namespace_strings
ZendeskAPI::DataNamespace.descendants.map { |klass| klass.to_s.split('::') }.flatten.uniq
end

def _side_load(resource, side_loads)
side_loads.map! do |side_load|
resource.send(:wrap_resource, side_load, options)
end

ZendeskAPI::Collection.new(resource.client, options[:class]).tap do |collection|
collection.replace(side_loads)
end
end

def side_load_from_parent_id(resource, side_loads, key)
key = "#{resource.class.singular_resource_name}_id"

resource.send("#{options.name}=", _side_load(resource, side_loads.select {|side_load|
side_load[key] == resource.id
}))
end

def side_load_from_child_ids(resource, side_loads, plural_key)
ids = resource.send(plural_key)

resource.send("#{options.name}=", _side_load(resource, side_loads.select {|side_load|
ids.include?(side_load[options.include_key])
}))
end

def side_load_from_child_or_parent_id(resource, side_loads, key)
# Either grab association from child_id field on resource or parent_id on child resource
if resource.key?(key)
id = resource.send(key)
include_key = options.include_key
else
id = resource.id
include_key = "#{resource.class.singular_resource_name}_id"
end

return unless id

side_load = side_loads.detect do |side_load|
id == side_load[include_key]
end

resource.send("#{options.name}=", side_load) if side_load
end

def build_parent_namespace(parent_class, instance, options, original_options)
path = @options.path

Expand Down
69 changes: 69 additions & 0 deletions lib/zendesk_api/association_side_load.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
module ZendeskAPI
class SideLoad
class << self
attr_reader :options

def side_load(resources, side_loads)
key = "#{options.name}_id"
plural_key = "#{Inflection.singular options.name.to_s}_ids"

resources.each do |resource|
if resource.key?(plural_key) # Grab associations from child_ids field on resource
side_load_from_child_ids(resource, side_loads, plural_key)
elsif resource.key?(key) || options.singular
side_load_from_child_or_parent_id(resource, side_loads, key)
else # Grab associations from parent_id field from multiple child resources
side_load_from_parent_id(resource, side_loads, key)
end
end
end

private

def _side_load(resource, side_loads)
side_loads.map! do |side_load|
resource.send(:wrap_resource, side_load, options)
end

ZendeskAPI::Collection.new(resource.client, options[:class]).tap do |collection|
collection.replace(side_loads)
end
end

def side_load_from_parent_id(resource, side_loads, key)
key = "#{resource.class.singular_resource_name}_id"

resource.send("#{options.name}=", _side_load(resource, side_loads.select { |side_load|
side_load[key] == resource.id
}))
end

def side_load_from_child_ids(resource, side_loads, plural_key)
ids = resource.send(plural_key)

resource.send("#{options.name}=", _side_load(resource, side_loads.select { |side_load|
ids.include?(side_load[options.include_key])
}))
end

def side_load_from_child_or_parent_id(resource, side_loads, key)
# Either grab association from child_id field on resource or parent_id on child resource
if resource.key?(key)
id = resource.send(key)
include_key = options.include_key
else
id = resource.id
include_key = "#{resource.class.singular_resource_name}_id"
end

return unless id

side_load = side_loads.detect do |side_load|
id == side_load[include_key]
end

resource.send("#{options.name}=", side_load) if side_load
end
end
end
end