jsonapi-preloadable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1154f9d3a7b5d25aa0e414997f45c0905192163c6e9c8e00f44e381dcd95dbbd
+  data.tar.gz: 42523dbf58be58588b243c03496a00872940d8ecab1b807cb76c27b95ff431be
+SHA512:
+  metadata.gz: da1801edd0e20ffe81d4b531ce5c0b38ff8ba9328a580e88f3c4c007405c94a2512bee5f412ecf021fdc415aac8bb500325ce330e2a1424e1cd647f0f47d3056
+  data.tar.gz: 705061743f776632c191218f05f07d36d4cfe3c4eb2bc68d0d8e31bbb0a0d0b94378621567987283452152964cae4adab8b52d8e377234bc5011a197cbd9399b

data/lib/jsonapi-preloadable.rb

@@ -0,0 +1,63 @@
+module Preloadable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  class PreloadableAttributeConfig
+    attr_writer :attrs, :defaults
+
+    def attrs
+      @attrs ||= {}
+    end
+
+    def defaults
+      @defaults ||= Set.new
+    end
+
+    def add(*args)
+      if args.size == 1
+        # plain declaration
+        # config.add relationship: :nested
+        options = args.first
+        attrs[options.keys.first] = options
+      else
+        # aliased declaration
+        # config.add :alias, relationship: :nested
+        key, value = args
+        attrs[key] = value
+      end
+    end
+
+    def preload(*keys)
+      keys = [keys] if keys.instance_of?(Symbol)
+      defaults.merge(keys)
+    end
+  end
+
+  module ClassMethods
+    def preloadable_config
+      @preloadable_config ||= PreloadableAttributeConfig.new
+    end
+
+    def preloadable(&block)
+      block.call(preloadable_config)
+    end
+
+    def records(options = {})
+      attrs = preloadable_config.defaults.dup
+
+      context_args = options.dig(:context, :preload)
+      if context_args.present?
+        attrs.merge(context_args.split(",").map(&:to_sym))
+      end
+
+      return super if attrs.empty?
+
+      includable = preloadable_config.attrs.map do |key, value|
+        value if attrs.include?(key)
+      end.compact
+
+      super.includes(includable)
+    end
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-preloadable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arturo Puente
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-18 00:00:00.000000000 Z
+dependencies: []
+description: Handles ActiveRecord chained relationship preloading in JSONAPI:Resources
+email: arturopuentevc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jsonapi-preloadable.rb
+homepage: https://github.com/arturopuente/jsonapi-preloadable
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Handles ActiveRecord chained relationship preloading in JSONAPI:Resources
+test_files: []