graphql_preload_queries 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e487e7903d2626761868cfce9a2aa368eeb8efbfa7a930eb00988b80c0ed331
+  data.tar.gz: cbdff09086c7530c1a0015c3294ed897bb21fd5621fb46a62acb452543d503db
+SHA512:
+  metadata.gz: 2ced151a4c528db0b2bb29f5be1d8fe6aa4d316344510503682dccb1937760b92953ac1b2825e01d5397c751f618967a85bb9f518951a7127f0525f882412517
+  data.tar.gz: b8c4a168788b2288955e941e3b5a806a125de2fe52c19fdf58956fba84c30c80e3e7e6e43e79fb285e38e7dbba590616b767d4617a7ec1869ca102d8708e41cb

data/.generators

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Reorder generators
+2. Remove generators
+3. Add installed generators
+To add new installed generators automatically delete this file and reload the project.
+--><GeneratorsGroup><Generator name="controller" /><Generator name="integration_test" /><Generator name="mailer" /><Generator name="migration" /><Generator name="model" /><Generator name="observer" /><Generator name="plugin" /><Generator name="resource" /><Generator name="scaffold" /><Generator name="session_migration" /></GeneratorsGroup></Settings>

data/.github/workflows/ruby.yml

@@ -0,0 +1,48 @@
+name: Graphql Preload Queries
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    name: Tests and Code Style
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6]
+        rails: [6]
+        include:
+          - ruby: 2.7
+            rails: 6
+        exclude: # rails 6 requires ruby >= 2.5
+          - ruby: 2.4
+            rails: 6
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install sqlite3
+        run: sudo apt-get install libsqlite3-dev
+
+      - name: Install bundler
+        env:
+          GEMFILE_PATH: gemfiles/Gemfile_${{ matrix.rails }}
+          RAILS_V: ${{ matrix.rails }}
+        run: |
+          rm -f Gemfile.lock && rm -f Gemfile
+          cp $GEMFILE_PATH ./Gemfile
+          bundler_v='2.1.4'
+          if [ $RAILS_V = "4" ]; then bundler_v="1.16.6"; fi
+          gem install bundler -v "~> $bundler_v"
+          bundle _${bundler_v}_ install --jobs 4 --retry 3
+      - name: Tests (rspec)
+        run: |
+          bundle exec rspec
+      - name: Code style (Rubocop)
+        run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/db/*.sqlite3-*
+test/dummy/log/*.log
+test/dummy/storage/
+test/dummy/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+# This is the configuration used to check the rubocop source code.
+
+require: rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.4
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in graphql_preload_queries.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,194 @@
+PATH
+  remote: .
+  specs:
+    graphql_preload_queries (0.1.0)
+      graphql
+      rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activestorage (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    database_cleaner (1.8.5)
+    database_cleaner-active_record (1.8.0)
+      activerecord
+      database_cleaner (~> 1.8.0)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    graphql (1.11.6)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.7.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.4)
+      actioncable (= 6.0.3.4)
+      actionmailbox (= 6.0.3.4)
+      actionmailer (= 6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actiontext (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (4.0.1)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.9)
+      rspec-expectations (~> 3.9)
+      rspec-mocks (~> 3.9)
+      rspec-support (~> 3.9)
+    rspec-support (3.10.0)
+    rubocop (1.4.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (2.0.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.10.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner-active_record
+  graphql_preload_queries!
+  rspec-rails
+  rubocop
+  rubocop-rspec
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# GraphqlPreloadQueries (In progress)
+This gem helps to define all possible preloads for graphql data results and avoid the common problem "N+1 Queries". 
+
+## Usage
+  * Preloads in query results
+    ```ruby
+      # queries/articles.rb
+      def articles
+        resolve_preloads(Article.all, { allComments: :comments })
+      end
+    ```
+    When articles query is performed and:
+    * The query includes "allComments", then ```:comments``` will automatically be preloaded  
+    * The query does not include "allComments", then ```:comments``` is not preloaded  
+    
+  * Preloads in mutation results
+    ```ruby
+      # mutations/articles/approve.rb
+      def resolve
+        affected_articles = Article.where(id: [1,2,3])
+        res = resolve_preloads(affected_articles, { allComments: :comments })
+        { articles => res }
+      end
+    ```
+    When approve mutation is performed and:
+    * The result articles query includes "allComments", then ```:comments``` will automatically be preloaded  
+    * The result articles query does not include "allComments", then ```:comments``` is not preloaded
+    
+  * Preloads in ObjectTypes
+    ```ruby
+      # types/article_type.rb
+      module Types
+        class ArticleType < Types::BaseObject
+          preload_field :allComments, [Types::CommentType], preload: { owner: :author }, null: false
+        end
+      end
+    ```
+    When any query is retrieving an article data and:
+    * The query includes ```owner``` inside ```allComments```, then ```:author``` will automatically be preloaded inside "allComments" query  
+    * The query does not include ```owner```, then ```:author``` is not preloaded
+    This field is exactly the same as the graphql field, except that this field expects for "preload" setting which contains all configurations for preloading
+    
+  Complex preload settings    
+  ```ruby
+    # category query
+    {
+      'posts' =>
+        [:posts, # :posts preload key will be used when: { posts { id ... } }
+          {
+            'authors|allAuthors' => [:author, { # :author key will be used when: { posts { allAuthors { id ... } } } 
+              address: :address # :address key will be used when: { posts { allAuthors { address { id ... } } } }
+            }],
+            history: :versions # :versions key will be used when: { posts { history { ... } } }
+          }
+        ],
+      'disabledPosts' => ['category_disabled_posts.post', { # :category_disabled_posts.post key will be used when: { disabledPosts { ... } }
+        authors: :authors # :authors key will be used when: { disabledPosts { authors { ... } } }
+      }]
+    }
+  ```
+  * ```authors|allAuthors``` means that the preload will be added if "authors" or "allAuthors" is present in the query
+  * ```category_disabled_posts.post``` means an inner preload, sample: ```posts.preload({ category_disabled_posts: :post })```
+    
+### Important: 
+  Is needed to omit "extra" params auto provided by Graphql when using custom resolver (only in case not using params), sample:
+  ```ruby
+    # types/post_type.rb
+    preload_field :allComments, [Types::CommentType], preload: { owner: :author }, null: false
+    def allComments(_omit_gql_params) # custom method resolver that omits non used params
+      object.allComments
+    end
+  ```
+    
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql_preload_queries'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install graphql_preload_queries
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/owen2345/graphql_preload_queries. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GraphqlPreloadQueries'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/bin/rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/graphql_preload_queries/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/initializers/add_mutation_resolver.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# preload resolver for mutations
+Rails.application.config.to_prepare do
+  GraphQL::Schema::Mutation.class_eval do
+    # Add corresponding preloads to mutation results
+    # @param key (sym) key of the query
+    # @param data (ActiveCollection)
+    # @param preload_config (Same as Field: field[:preload])
+    def resolve_preloads(key, data, preload_config)
+      node = find_node(key)
+      return data unless node
+
+      # relay support (TODO: add support to skip when not using relay)
+      node = node.selections.first if %w[nodes edges].include?(node.selections.first.name)
+      GraphqlPreloadQueries::Extensions::Preload.resolve_preloads(data, node, preload_config)
+    end
+
+    private
+
+    def find_node(key)
+      main_node = context.query.document.definitions.first.selections.first
+      main_node.selections.find { |node_i| node_i.name == key.to_s }
+    end
+  end
+end

data/config/initializers/add_preload_field.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'graphql_preload_queries/extensions/preload'
+
+Rails.application.config.to_prepare do
+  # Custom preload field for Object types
+  Types::BaseObject.class_eval do
+    # @param key field[:key]
+    # @param type field[:type]
+    # @param settings field[:settings] ++ { preload: {} }
+    #   preload: (Hash) { allPosts: [:posts, { author: :author }] }
+    #   ==> <cat1>.preload(posts: :author) // if author and posts are in query
+    #   ==> <cat1>.preload(:posts) // if only author is in the query
+    #   ==> <cat1>.preload() // if both of them are not in the query
+    # TODO: ability to merge extensions + extras
+    def self.preload_field(key, type, settings = {})
+      klass = GraphqlPreloadQueries::Extensions::Preload
+      custom_attrs = {
+        extras: [:ast_node],
+        extensions: [klass => settings.delete(:preload)]
+      }
+      field key, type, settings.merge(custom_attrs)
+
+      # Fix: omit non expected "extras" param auto provided by graphql
+      define_method(key) { |_omit_non_used_args| object.send(key) } unless method_defined? key
+    end
+  end
+end

data/config/initializers/add_query_resolver.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# preload resolver for queries
+Rails.application.config.to_prepare do
+  Types::QueryType.class_eval do
+    # Add corresponding preloads to query results
+    #   Note: key is automatically calculated based on method name
+    # @param data (ActiveCollection)
+    # @param preload_config (Same as Field: field[:preload])
+    def resolve_preloads(data, preload_config)
+      node = find_node(caller[0][/`.*'/][1..-2])
+      return data unless node
+
+      # relay support (TODO: add support to skip when not using relay)
+      node = node.selections.first if %w[nodes edges].include?(node.selections.first.name)
+      GraphqlPreloadQueries::Extensions::Preload.resolve_preloads(data, node, preload_config)
+    end
+
+    private
+
+    def find_node(key)
+      main_node = context.query.document.definitions.first
+      main_node.selections.find { |node_i| node_i.name == key.to_s }
+    end
+  end
+end

data/gemfiles/Gemfile_4

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4'
+
+# Specify your gem's dependencies in pub_sub_model_sync.gemspec
+gemspec

data/gemfiles/Gemfile_5

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5'
+
+# Specify your gem's dependencies in pub_sub_model_sync.gemspec
+gemspec

data/gemfiles/Gemfile_6

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 6'
+
+# Specify your gem's dependencies in pub_sub_model_sync.gemspec
+gemspec

data/graphql_preload_queries.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require_relative 'lib/graphql_preload_queries/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql_preload_queries'
+  spec.version       = GraphqlPreloadQueries::VERSION
+  spec.authors       = ['owen2345']
+  spec.email         = ['owenperedo@gmail.com']
+
+  spec.summary       = 'Permit to avoid N+1 queries problem when using graphql queries'
+  spec.description   = 'Permit to avoid N+1 queries problem when using graphql queries'
+  spec.homepage      = 'https://github.com/owen2345/graphql_preload_queries'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  # spec.metadata["allowed_push_host"] = ""
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'graphql'
+  spec.add_dependency 'rails'
+  spec.add_development_dependency 'database_cleaner-active_record'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/graphql_preload_queries.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'graphql_preload_queries/engine'
+require 'graphql'
+require 'graphql_preload_queries/extensions/preload'
+
+module GraphqlPreloadQueries
+end

data/lib/graphql_preload_queries/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GraphqlPreloadQueries
+  class Engine < ::Rails::Engine
+    isolate_namespace GraphqlPreloadQueries
+  end
+end

data/lib/graphql_preload_queries/extensions/preload.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# TODO: add generic resolver
+
+module GraphqlPreloadQueries
+  module Extensions
+    class Preload < GraphQL::Schema::FieldExtension
+      # extension to add eager loading when a field was already processed
+      def resolve(object:, arguments:, **_rest)
+        klass = GraphqlPreloadQueries::Extensions::Preload
+        res = yield(object, arguments)
+        return res unless res
+
+        klass.resolve_preloads(res, arguments[:ast_node], (options || {}))
+      end
+
+      class << self
+        # Add all the corresponding preloads to the collection
+        # @param data (ActiveCollection)
+        # @return @data with preloads configured
+        # Sample: resolve_preloads(Category.all, { allPosts: :posts })
+        def resolve_preloads(data, query_node, preload_config)
+          apply_preloads(data, filter_preloads(query_node, preload_config))
+        end
+
+        def apply_preloads(collection, preloads)
+          collection.eager_load(preloads)
+        end
+
+        # find all configured preloads inside a node
+        def filter_preloads(node, preload_conf, root = nested_hash)
+          preload_conf.map do |key, sub_preload_conf|
+            filter_preload(node, key, sub_preload_conf, root)
+          end
+          root
+        end
+
+        private
+
+        # find preloads under a specific key
+        def filter_preload(node, key, preload_conf, root)
+          sub_node = node.selections.find do |node_i|
+            key.to_s.split('|').include?(node_i.name.to_s)
+          end
+
+          multiple_preload = preload_conf.is_a?(Array)
+          return unless sub_node
+          return add_preload_key(root, preload_conf, []) unless multiple_preload
+
+          child_root = nested_hash
+          filter_preloads(sub_node, preload_conf[1], child_root)
+          add_preload_key(root, preload_conf[0], child_root.presence || [])
+        end
+
+        # parse nested preload key and add it to the tree
+        # Sample: parent_preload: "categories.users"
+        #         ==> { categories: { users: [res here] } }
+        def add_preload_key(root, key, value)
+          key_path = key.to_s.split('.').map(&:to_sym)
+          root.dig(*key_path)
+          *path, last = key_path
+          path.inject(root, :fetch)[last] = value
+        end
+
+        def nested_hash
+          Hash.new { |h, k| h[k] = {} }
+        end
+      end
+    end
+  end
+end

data/lib/graphql_preload_queries/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GraphqlPreloadQueries
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: graphql_preload_queries
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- owen2345
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Permit to avoid N+1 queries problem when using graphql queries
+email:
+- owenperedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".generators"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/rails
+- config/initializers/add_mutation_resolver.rb
+- config/initializers/add_preload_field.rb
+- config/initializers/add_query_resolver.rb
+- gemfiles/Gemfile_4
+- gemfiles/Gemfile_5
+- gemfiles/Gemfile_6
+- graphql_preload_queries.gemspec
+- lib/graphql_preload_queries.rb
+- lib/graphql_preload_queries/engine.rb
+- lib/graphql_preload_queries/extensions/preload.rb
+- lib/graphql_preload_queries/version.rb
+homepage: https://github.com/owen2345/graphql_preload_queries
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/owen2345/graphql_preload_queries
+  source_code_uri: https://github.com/owen2345/graphql_preload_queries
+  changelog_uri: https://github.com/owen2345/graphql_preload_queries
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Permit to avoid N+1 queries problem when using graphql queries
+test_files: []