graphql-eager_load 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a51028f140032e8b436a06fa19ad0d5fe1ad5e16ac2f0881acabaa3738e287bc
+  data.tar.gz: cb1cf7507e675e881699e679d6a9f248ce1a7bcd0697e6f1d90020325b1482cd
+SHA512:
+  metadata.gz: 29058b322738f586de82e832722625fa5c1c09ce7716cc2377cfe30b1a7e0dbf21655221d9977135f683938241a1b2141632d6ded7affe4dd86e82c1db1c6ee0
+  data.tar.gz: 1ca0c090115b58c18bd01826c20f93c6019e53bba375ff970b3b8406223b16c2b2b4a3b57b1314620fbc099d692784924bc154dfd75a3f114c265cdc294b758a

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+on: [push]
+
+name: Test
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.7.x'
+          bundler-cache: true
+
+      - name: Cache bundled gems
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+
+      - name: Install Ruby gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install
+
+      - name: Run Rspec
+        run: |
+          bundle exec rspec

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+spec/internal/db/database.sqlite3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - bin/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-eager-load.gemspec
+gemspec
+
+gem 'graphql'
+
+group :test, :development do
+  gem 'combustion'
+  gem 'rails'
+  gem 'rake'
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rspec'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -0,0 +1,202 @@
+PATH
+  remote: .
+  specs:
+    graphql-eager_load (0.2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      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.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.2)
+      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)
+    combustion (1.3.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    graphql (1.11.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.6.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.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.2)
+      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.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.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.9.3)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
+    ruby-progressbar (1.10.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      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.7)
+      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.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  combustion
+  graphql
+  graphql-eager_load!
+  rails
+  rake
+  rspec
+  rspec-rails
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1 @@
+Copyright (c) 2020 HOVER Inc.

data/README.md

@@ -0,0 +1,55 @@
+# Graphql::EagerLoad
+
+This gem traverses your graphql query looking for fields on types that match
+associations on those types. For each field found to be an association, this
+gem adds those associations to an [ActiveRecord::QueryMethods#includes](https://api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html#method-i-includes) hash. That hash can then be used to
+eager load the associations of records returned in your graphql resolver.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-eager_load'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+```ruby
+module Resolvers
+  class Users < Resolvers::Base
+    eager_load_model ::User
+
+    type Types::User.connection_type, null: false
+
+    def resolve
+      User.active.includes(associations_to_eager_load)
+    end
+  end
+end
+```
+
+The `.eager_load_model` and `#associations_to_eager_load` methods are provided by this gem.
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bundle exec bin/console` for an interactive prompt that will allow you to experiment.
+
+To release a new version:
+
+- Update the version number in `version.rb`
+- Make a PR with your changes and the version number increment
+- After the PR is merged, make the new release https://github.com/hoverinc/graphql-eager-load/releases
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hoverinc/graphql-eager-load.
+
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'graphql/eager_load'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/graphql-eager-load.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/graphql/eager_load/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql-eager_load'
+  spec.version       = Graphql::EagerLoad::VERSION
+  spec.authors       = ['Elise Wood']
+  spec.email         = ['elise@hover.to']
+
+  spec.summary       = 'Generate ActiveRecord eager loading options from GraphQL Queries.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/hoverinc/graphql-eager-load'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata['allowed_push_host'] = 'github.com/hoverinc/graphql-eager-load'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hoverinc/graphql-eager-load'
+  spec.metadata['changelog_uri'] = 'https://github.com/hoverinc/graphql-eager-load/commits'
+
+  # 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']
+end

data/lib/graphql/eager_load.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'graphql'
+require 'graphql/eager_load/version'
+require 'graphql/eager_load/builder'
+require 'graphql/eager_load/resolver'
+
+GraphQL::Schema::Resolver.include Graphql::EagerLoad::Resolver

data/lib/graphql/eager_load/builder.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Graphql
+  module EagerLoad
+    #
+    # Given
+    #   - An initial set of includes, a hash
+    #   - GraphQL query selections
+    #   - The model corresponding to the type returned by a GraphQL resolver
+    #
+    # This module will iterate and recurse into the selctions to find out if
+    # any of the fields requested for a given type corresponds to an
+    # association on the ActiveRecord model associated with the field's type.
+    #
+    #
+    # For example given this query
+    #
+    # salesOpportunities() {
+    #   soldEstimateGroup {
+    #     estimates {
+    #      lineItems
+    #     }
+    #   }
+    # }
+    #
+    # We'd return this "includes" hash
+    #
+    # {sold_estimate_group: {estimates: {line_items: {}}}}
+    #
+    # And our resolver will use it like `scope.includes(includes)` to
+    # prevent N+1s
+    #
+    class Builder
+      def self.call(selections:, model:)
+        selections.each.with_object({}) do |selection, includes|
+          builder = new(selection: selection, model: model)
+
+          if builder.association?
+            hash = builder.includes
+            hash[:blob] ||= {} if builder.active_storage_attachment?
+            includes[builder.association_name] = hash
+          else
+            includes.merge!(builder.includes)
+          end
+        end
+      end
+
+      def initialize(selection:, model:)
+        @selection = selection
+        @model = model
+      end
+
+      def includes
+        self.class.call(selections: selection.selections, model: includes_model)
+      end
+
+      def association?
+        association.present?
+      end
+
+      def association_name
+        association.name
+      end
+
+      def active_storage_attachment?
+        model.reflect_on_attachment(field_name).present?
+      end
+
+      private
+
+      attr_reader :selection, :model
+
+      def includes_model
+        return ActiveStorage::Attachment if active_storage_attachment?
+
+        association&.klass || model
+      end
+
+      def association
+        return if use_custom_method?
+        return model.reflect_on_association("#{field_name}_attachment") if active_storage_attachment?
+
+        model.reflect_on_association(field_name)
+      end
+
+      def use_custom_method?
+        custom_method_defined? && !ignore_custom_method?
+      end
+
+      def ignore_custom_method?
+        return false unless field_owner.respond_to?(:allow_include_builder_fields)
+
+        field_owner.allow_include_builder_fields&.include?(field_name.to_sym)
+      end
+
+      def custom_method_defined?
+        field_owner.instance_methods.include?(field_name)
+      end
+
+      def field_owner
+        selection.field.owner
+      end
+
+      def field_name
+        selection.name
+      end
+    end
+  end
+end

data/lib/graphql/eager_load/resolver.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Graphql
+  module EagerLoad
+    # Automatically included in any subclasses of Resolvers::Base
+    module Resolver
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+
+      def associations_to_include
+        graphql_eager_load_options(model: self.class.class_variable_get(:@@eager_load_model))
+      end
+
+      def graphql_eager_load_options(selections: context.query.lookahead.selections, model:)
+        Builder.call(selections: selections, model: model)
+      end
+
+      # specify the ActiveRecord model that corresponds to the top level type
+      # in the graphql query for this resolver.
+      module ClassMethods
+        def eager_load_model(model)
+          # rubocop:disable Style/ClassVars
+          class_variable_set(:@@eager_load_model, model)
+          # rubocop:enable Style/ClassVars
+        end
+      end
+    end
+  end
+end

data/lib/graphql/eager_load/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Graphql
+  module EagerLoad
+    VERSION = '0.2.2'
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: graphql-eager_load
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Elise Wood
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-11 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email:
+- elise@hover.to
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.ru
+- graphql-eager-load.gemspec
+- lib/graphql/eager_load.rb
+- lib/graphql/eager_load/builder.rb
+- lib/graphql/eager_load/resolver.rb
+- lib/graphql/eager_load/version.rb
+homepage: https://github.com/hoverinc/graphql-eager-load
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hoverinc/graphql-eager-load
+  source_code_uri: https://github.com/hoverinc/graphql-eager-load
+  changelog_uri: https://github.com/hoverinc/graphql-eager-load/commits
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generate ActiveRecord eager loading options from GraphQL Queries.
+test_files: []