graphql-preload 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 412060a07e4a7640f360fd987b130eff199b5abb
+  data.tar.gz: 7ee60048595cd21c4f3a3b75e7eb60acba2c2633
+SHA512:
+  metadata.gz: c4d07b403576d3ac174cf54d864ffc28e0549735625f43addc80ce4f6e7a4b32d98078d29c34acd3ddbbb45c8b46123ba6594680782a7786c8a3ab33b47de28d
+  data.tar.gz: cabf3cb48477c1f66ece36283817fd6af855e1eeb8305cdb685471f60ddd15be25627e43e91f0794da163a4a3146c48ed099287a33dc98f6424e3078ca80d22c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.yardopts

@@ -0,0 +1,2 @@
+lib/**/*.rb - README.md
+--embed-mixin DSL

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-preload.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Grand Rounds
+
+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,56 @@
+# Graphql::Preload
+
+Provides a DSL for the [`graphql` gem](https://github.com/rmosolgo/graphql-ruby) that allows ActiveRecord associations to be preloaded in field definitions. Based on a [gist](https://gist.github.com/theorygeek/a1a59a2bf9c59e4b3706ac68d12c8434) by @theorygeek.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-preload'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-preload
+
+## Usage
+
+First, enable preloading in your `GraphQL::Schema`:
+
+    Schema = GraphQL::Schema.define do
+      use GraphQL::Batch
+
+      enable_preloading
+    end
+
+Call `preload` when defining your field:
+
+    PostType = GraphQL::ObjectType.define do
+      name 'Post'
+
+      field :comments, !types[!CommentType] do
+        # Post.includes(:comments)
+        preload :comments
+
+        resolve ->(obj, args, ctx) { obj.comments }
+      end
+    end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ConsultingMD/graphql-preload.
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'graphql/preload'
+require 'pry'
+
+Pry.start

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/graphql-preload.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/preload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql-preload'
+  spec.version       = GraphQL::Preload::VERSION
+  spec.authors       = ['Ryan Foster, Etienne Tripier']
+  spec.email         = ['etienne.tripier@grandrounds.com']
+
+  spec.summary       = 'Preload ActiveRecord associations with graphql-batch'
+  spec.homepage      = 'https://github.com/ConsultingMD/graphql-preload'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_runtime_dependency 'activerecord', '>= 3.2', '<= 5'
+  spec.add_runtime_dependency 'graphql', '>= 1.5', '< 2'
+  spec.add_runtime_dependency 'graphql-batch', '~> 0.3'
+  spec.add_runtime_dependency 'promise.rb', '~> 0.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/lib/graphql/preload.rb

@@ -0,0 +1,25 @@
+require 'graphql'
+require 'graphql/batch'
+require 'promise.rb'
+
+GraphQL::Field.accepts_definitions(
+  preload: ->(type, *args) do
+    type.metadata[:preload] ||= []
+    type.metadata[:preload].concat(args)
+  end
+)
+
+GraphQL::Schema.accepts_definitions(
+  enable_preloading: ->(schema) do
+    schema.instrument(:field, GraphQL::Preload::Instrument.new)
+  end
+)
+
+module GraphQL
+  # Provides a GraphQL::Field definition to preload ActiveRecord::Associations
+  module Preload
+    autoload :Instrument, 'graphql/preload/instrument'
+    autoload :Loader, 'graphql/preload/loader'
+    autoload :VERSION, 'graphql/preload/version'
+  end
+end

data/lib/graphql/preload/instrument.rb

@@ -0,0 +1,64 @@
+module GraphQL
+  module Preload
+    # Provides an instrument for the GraphQL::Field :preload definition
+    class Instrument
+      def instrument(_type, field)
+        return field unless field.metadata.include?(:preload)
+
+        old_resolver = field.resolve_proc
+        new_resolver = ->(obj, args, ctx) do
+          return old_resolver.call(obj, args, ctx) unless obj
+
+          preload(obj, field.metadata[:preload]).then do
+            old_resolver.call(obj, args, ctx)
+          end
+        end
+
+        field.redefine do
+          resolve(new_resolver)
+        end
+      end
+
+      private def preload(record, associations)
+        return preload_single_association(record, associations) if associations.is_a?(Symbol)
+
+        promises = []
+
+        Array.wrap(associations).each do |association|
+          case association
+          when Symbol
+            promises << preload_single_association(record, association)
+          when Array
+            association.each do |sub_association|
+              promises << preload(record, sub_association)
+            end
+          when Hash
+            association.each do |sub_association, property|
+              promises << preload_single_association(record, sub_association).then do
+                associated_records = record.public_send(sub_association)
+
+                case associated_records
+                when ActiveRecord::Base
+                  preload(associated_records, property)
+                else
+                  Promise.all(
+                    Array.wrap(associated_records).map do |associated_record|
+                      preload(associated_record, property)
+                    end
+                  )
+                end
+              end
+            end
+          end
+        end
+
+        Promise.all(promises)
+      end
+
+      private def preload_single_association(record, association)
+        return Promise.resolve(record) if record.association(association).loaded?
+        GraphQL::Preload::Loader.for(record.class, association).load(record)
+      end
+    end
+  end
+end

data/lib/graphql/preload/loader.rb

@@ -0,0 +1,51 @@
+module GraphQL
+  module Preload
+    # Preloads ActiveRecord::Associations when called from the Preload::Instrument
+    class Loader < GraphQL::Batch::Loader
+      attr_reader :association, :model
+
+      def initialize(model, association)
+        @association = association
+        @model = model
+
+        validate_association
+      end
+
+      def load(record)
+        unless record.is_a?(model)
+          raise TypeError, "loader for #{model.name} can't load associations for #{record.class.name} objects"
+        end
+
+        if record.association(association).loaded?
+          Promise.resolve(record)
+        else
+          super
+        end
+      end
+
+      def perform(records)
+        if ActiveRecord::VERSION::MAJOR > 3
+          ActiveRecord::Associations::Preloader.new.preload(records, association)
+        else
+          ActiveRecord::Associations::Preloader.new(records, association).run
+        end
+
+        records.each { |record| fulfill(record, record) }
+      end
+
+      private def validate_association
+        unless association.is_a?(Symbol)
+          raise ArgumentError, 'association must be a Symbol object'
+        end
+
+        unless model < ActiveRecord::Base
+          raise ArgumentError, 'model must be an ActiveRecord::Base descendant'
+        end
+
+        return if model.reflect_on_association(association)
+
+        raise TypeError, "association :#{association} does not exist on #{model.name}"
+      end
+    end
+  end
+end

data/lib/graphql/preload/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  module Preload
+    VERSION = '1.0.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: graphql-preload
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Ryan Foster, Etienne Tripier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: graphql-batch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: promise.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- etienne.tripier@grandrounds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-preload.gemspec
+- lib/graphql/preload.rb
+- lib/graphql/preload/instrument.rb
+- lib/graphql/preload/loader.rb
+- lib/graphql/preload/version.rb
+homepage: https://github.com/ConsultingMD/graphql-preload
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Preload ActiveRecord associations with graphql-batch
+test_files: []