graphql-eager_loader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4310412bb795a5c7f8361aea24e5354a1b5b776738f9e94047f64c8f54aa008
+  data.tar.gz: 06673a81f83d39de76f9a61760c1d53c1984ab77f23be2e2f33c97aed7cff40e
+SHA512:
+  metadata.gz: 80fc6c5f93c1731537004f33c9eaa39b1e2d807042ff54d5dfb4be6b1639f43e4d1a8885b4ff93db5e64cbd774735521dd3ec8324a8b7132bf710a23acec5731
+  data.tar.gz: 4483b2f95611ad2ecdc26d042e9226a6e42deef850cdc395c0056bdfa211c8e741c57011e9aff19d10bd8432a1870e250d34c6ad3e3b7f16004b9759e0ff3f48

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Viktor Fonic
+
+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,63 @@
+# Graphql::EagerLoader
+
+Eager-load your Active Record associations automagically.
+
+## Usage
+
+Call this method like this:
+
+```ruby
+Graphql::EagerLoader::LookaheadLoader.call(Project, lookahead)
+```
+
+Here's a full example with 'graphql' field:
+
+```ruby
+field :projects, Types::ProjectType, null: true, extras: [:lookahead]
+def projects(lookahead:)
+  Graphql::EagerLoader::LookaheadLoader.call(Project, lookahead).all # or: .where(published: true)
+end
+```
+
+This method allows you to add additional functionality while eager loading app's models.
+For example you can do stuff like (notice the location of `.all` below):
+
+```ruby
+field :projects, Types::ProjectType, null: true, extras: [:lookahead]
+def projects(lookahead:)
+  Graphql::EagerLoader::LookaheadLoader.call(Project, lookahead) do |eager_loaded_model, associations|
+    associations.values.each do |association|
+      if association.instance_of?(ActiveRecord::Reflection::HasManyReflection)
+        eager_loaded_model = eager_loaded_model.merge(association.klass.where(published: true))
+      end
+    end
+    eager_loaded_model
+  end.all
+end
+```
+
+## Installation
+
+```ruby
+gem 'graphql-eager_loader'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Contributing
+
+Contributions welcome!
+
+## Special Thanks
+
+Thank you to [@colinjfw](https://github.com/colinjfw) for the great [GraphQL-Api](https://github.com/colinjfw/graphql-api) gem that inspired this.
+
+Thank you to [@rmosolgo](https://github.com/rmosolgo) for the incredible [GraphQL](https://github.com/rmosolgo/graphql-ruby) gem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+# 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    = 'Graphql::EagerLoader'
+  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 << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+require 'stylecheck/rake_tasks'

data/lib/graphql/eager_loader.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'graphql/eager_loader/engine'
+require 'graphql/eager_loader/lookahead_loader'
+
+module Graphql
+  module EagerLoader
+  end
+end

data/lib/graphql/eager_loader/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+require 'action_dispatch/railtie'
+
+module Graphql
+  module EagerLoader
+    class Engine < ::Rails::Engine
+      engine_name 'graphql-eager_loader'
+      isolate_namespace Graphql::EagerLoader
+    end
+  end
+end

data/lib/graphql/eager_loader/lookahead_loader.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Graphql::EagerLoader
+  class LookaheadLoader
+    # Call this method like this:
+    # Graphql::EagerLoader::LookaheadLoader.call(Project, lookahead)
+    #
+    # Here's a full example with 'graphql' field:
+    #
+    # field :projects, Types::ProjectType, null: true, extras: [:lookahead]
+    # def projects(lookahead:)
+    #   Graphql::EagerLoader::LookaheadLoader.call(Project, lookahead).all # or: .where(published: true)
+    # end
+    def self.call(model_class, lookahead, &block)
+      associations = self.associations(model_class, lookahead)
+      eager_load_associations(model_class, associations, &block)
+    end
+
+    def self.associations(model_class, lookahead)
+      self.selections(lookahead).map(&:name).map(&:to_s).map do |selection|
+        model_class.reflections.find do |name, _association|
+          name == selection
+        end
+      end.compact.to_h
+    end
+
+    def self.selections(lookahead)
+      selection_names = lookahead.selections.map(&:name)
+      if selection_names == %i[edges nodes] || selection_names == [:nodes]
+        lookahead.selections.find { |lookahead| lookahead.name == :nodes }.selections
+      else
+        lookahead.selections
+      end
+    end
+
+    # This method allows you to add additional functionality while eager loading app's models.
+    # For example you can do stuff like (notice the location of `.all` below):
+    #
+    # field :projects, Types::ProjectType, null: true, extras: [:lookahead]
+    # def projects(lookahead:)
+    #   Graphql::EagerLoader::LookaheadLoader.call(Project, lookahead) do |eager_loaded_model, associations|
+    #     associations.values.each do |association|
+    #       if association.instance_of?(ActiveRecord::Reflection::HasManyReflection)
+    #         eager_loaded_model = eager_loaded_model.merge(association.klass.where(published: true))
+    #       end
+    #     end
+    #     eager_loaded_model
+    #   end.all
+    # end
+    def self.eager_load_associations(model_class, associations, &block)
+      return model_class if associations.blank?
+
+      eager_loaded_model = model_class.eager_load(*associations.keys)
+
+      eager_loaded_model = yield eager_loaded_model, associations if block_given?
+
+      eager_loaded_model
+    end
+  end
+end

data/lib/graphql/eager_loader/version.rb

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

data/lib/tasks/graphql/eager_loader_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :graphql_eager_loader do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: graphql-eager_loader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Viktor Fonic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.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: 
+email:
+- viktor.fonic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/graphql/eager_loader.rb
+- lib/graphql/eager_loader/engine.rb
+- lib/graphql/eager_loader/lookahead_loader.rb
+- lib/graphql/eager_loader/version.rb
+- lib/tasks/graphql/eager_loader_tasks.rake
+homepage: https://github.com/vfonic/graphql-eager_loader
+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.4
+signing_key: 
+specification_version: 4
+summary: Eager load Active Record relationships in your GraphQL queries
+test_files: []