json_api_preloader 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b801b1c42dd0c47cc7d8c3960047ebd4bd2d1e1bbfae4dd1f61568162e5326
-  data.tar.gz: 69bbed7dcd7583534ae224ef48d57382d65f0412e27fd0a07acc8a74a55d83fe
+  metadata.gz: d725299c748475bda1ff7a33b4a9a8bda504b611fe9a8934c74194d431f0e9e3
+  data.tar.gz: 8826dec180c6ccceecd7661b467385002fcfa91e40f419063e08a6b9ae57a7fb
 SHA512:
-  metadata.gz: a87a21c9ac91d7d5c8eaa2a13c8dd6628633d2d17b7e367213d9fbe18c8fdb1a19fdcb810045206b3e627834be0ee9768524a0d5195fc9cee696e1a84fd13c33
-  data.tar.gz: 6a33984af2af8b66fb24c0510cd65733011ee0a1f1f8365042f6adbcebaf350506f8ae57d579888418d62a6afb39b9162726413a279a0c41ac6fda9b59b56de2
+  metadata.gz: 637b8914db72bc81f99492b8392c3a3c6526b318779998d6060272c2c032c13702b50972dee14623d48f1e8c0a04b2dee991a0c69c0e1ff5ff440928dca90435
+  data.tar.gz: 5ed82b42166084856533a9603f8eb66a583f5203ea8f8f437b3fb9faa418c60f981055f7a81dca0d7cc8838eac992b20c9c56c4e3b5025eaae6e7a9df2a4d253

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.3)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rubocop (0.75.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rubocop
+
+BUNDLED WITH
+   1.17.2

data/json_api_preloader.gemspec

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name      = 'json_api_preloader'
+  s.version   = '0.0.2'
+  s.authors   = ['Kiryl Karetnikau']
+  s.license   = 'MIT'
+  s.email     = 'kiryl.karetnikau@gmail.com'
+  s.homepage  = 'https://github.com/koryushka/json_api_preloader'
+  s.summary   = 'Preloads associations based on request param `included`'
+  s.files     = `git ls-files -z`.split("\x0")
+end

data/lib/json_api_preloader/associations_builder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JsonApiPreloader
+  class AssociationsBuilder
+    delegate :models, to: ModelsPreloader
+
+    def call
+      models.map do |model_name|
+        {
+          associations: model_name.constantize.reflect_on_all_associations.map { |ac| { ac.name => ac.klass.name } },
+          name: model_name
+        }
+      end
+    end
+  end
+end

data/lib/json_api_preloader/associations_checker.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module JsonApiPreloader
+  class AssociationsChecker
+    def initialize(parent, association)
+      @parent = parent
+      @association = association
+    end
+
+    def call
+      return unless parent_klass_associations.present?
+
+      child_klass_associations&.fetch(association)
+    end
+
+    def self.associations
+      @associations ||= AssociationsBuilder.new.call
+    end
+
+    private
+
+    attr_reader :parent, :association
+
+    def parent_klass_associations
+      @parent_klass_associations ||=
+        self.class.associations.detect { |el| el[:name] == parent }
+    end
+
+    def child_klass_associations
+      @child_klass_associations ||=
+        parent_klass_associations[:associations]
+        .detect { |el| el.key?(association) }
+    end
+  end
+end

data/lib/json_api_preloader/core.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module JsonApiPreloader
+  module Core
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def preload_from_params_for(model_name)
+        class_attribute :preloader_configuration
+
+        self.preloader_configuration = {
+          name: model_name.constantize.name
+        }
+      end
+    end
+
+    private
+
+    def preloaded
+      included = params[:include]
+      return {} unless included.presence
+
+      nested_resources(
+        included: included.split(','),
+        parent: preloader_configuration[:name]
+      )
+    end
+
+    def modify_params(hsh, ary, parent)
+      association = ary.shift
+      return unless association
+
+      new_parent = AssociationsChecker.new(parent, association).call
+      return unless new_parent
+
+      modify_params(hsh[association], ary, new_parent)
+    end
+
+    def nested_resources(included:, parent:)
+      default_hash = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
+      result = included.each_with_object(default_hash) do |param, hash|
+        array = param.split('.').map(&:to_sym)
+        modify_params(hash, array, parent)
+      end
+      result
+    end
+  end
+end

data/lib/json_api_preloader/models_preloader.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module JsonApiPreloader
+  class ModelsPreloader
+    class << self
+      def models
+        @models ||= begin
+          load_models! unless eager_loaded?
+
+          model_names
+        end
+      end
+
+      private
+
+      def eager_loaded?
+        Rails.application.config.eager_load
+      end
+
+      def load_models!
+        Dir[Rails.root.join('app/models/**/*.rb')].sort.each { |f| require f }
+      end
+
+      def model_names
+        ApplicationRecord.descendants.collect(&:name)
+      end
+    end
+  end
+end

data/lib/json_api_preloader.rb

@@ -1,39 +1,6 @@
 # frozen_string_literal: true
 
-module JsonApiPreloader
-  def preload_from_params_for(model_name)
-    class_attribute :preloader_configuration
-    self.preloader_configuration = {
-      name: model_name
-    }
-  end
-
-  private
-
-  def preloaded(key: nil, parent:)
-    included = params[:include]
-    return {} unless included.presence
-
-    nested_resources(included: included.split(','), parent: parent)
-  end
-
-  def modify_params(hsh, ary, parent)
-    association = ary.shift
-    return unless association
-    
-    new_parent = AssociationsChecker.new(parent, association).call
-    return unless new_parent
-
-    modify_params(hsh[association], ary, new_parent)
-  end
-
-
-  def nested_resources(included:, parent:)
-    default_hash = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
-    result = included.each_with_object(default_hash) do |param, hash|
-      array = param.split('.').map(&:to_sym)
-      modify_params(hash, array, parent)
-    end
-    result
-  end
-end
+require 'json_api_preloader/core'
+require 'json_api_preloader/models_preloader'
+require 'json_api_preloader/associations_checker'
+require 'json_api_preloader/associations_builder'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_preloader
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kiryl Karetnikau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: kiryl.karetnikau@gmail.com
@@ -16,9 +16,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - Gemfile
+- Gemfile.lock
+- json_api_preloader.gemspec
 - lib/json_api_preloader.rb
-homepage: 
+- lib/json_api_preloader/associations_builder.rb
+- lib/json_api_preloader/associations_checker.rb
+- lib/json_api_preloader/core.rb
+- lib/json_api_preloader/models_preloader.rb
+homepage: https://github.com/koryushka/json_api_preloader
 licenses:
 - MIT
 metadata: {}