graphql-extras 0.2.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0eea726ab643425fcc8b63f518a757a132549b2f4d7bc15fa9be79ac2cf830
-  data.tar.gz: '08847c52f2c42c505e8201147c3826adebf21f33919385d4985cb6f334300493'
+  metadata.gz: 1ad1e3740a8a7ef06a6dad31a459153a121e254824225bf1a12c2718a59a699f
+  data.tar.gz: 36ce81c3f1f0888924668ccef5bde169958e45a97837cc669d94a416edc573de
 SHA512:
-  metadata.gz: 41487444c67cba8707b0fc8bea877bcb9ad659f6d3732e2a28a79823d451ba20bf7ccb32a9d3c3e739dd8ba6237423c661f70fe3bf0a7a543bdae870e3ef1091
-  data.tar.gz: 3c2557eefb6bcd90f68a09ac019fa967743c0cd89a23f0bdce1708363daf26877d53a975aa11057bde08d9b0b3f4bc8e3d18989f61083648cd6bef90448cb256
+  metadata.gz: ba8b4d40badcfba328280f397f8fb7ab7f42ce5257478c0482e48c4f0abf533f4b170d51f507caf6378ed6239d51460b4fe0f4623a6cfb93e0b565bbbf81a80d
+  data.tar.gz: de3c6a7f726b0b9ca1311906c1c3d05c0896fe8ba1b64d9d059cc0b7c5d82c227ae7ec17611b999b666201b97818daea30d2f996fda5f9d9fefa849d00ec9fc2

data/.github/workflows/build.yml

@@ -0,0 +1,25 @@
+name: Build
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Install packages
+        run: sudo apt-get install libsqlite3-dev
+
+      - name: Install bundler
+        run: gem install bundler
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Test
+        run: bundle exec rspec

data/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Install packages
+        run: sudo apt-get install libsqlite3-dev
+
+      - name: Install bundler
+        run: gem install bundler
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Test
+        run: bundle exec rspec
+
+      - name: Set version
+        run: perl -pi -e "s/0\.0\.0/${GITHUB_REF:11}/" lib/graphql/extras/version.rb
+
+      - name: Publish
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_TOKEN}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          RUBYGEMS_TOKEN: ${{ secrets.RUBYGEMS_TOKEN }}

data/README.md

@@ -1,7 +1,30 @@
-# GraphQL::Extras [![Build Status](https://travis-ci.org/rzane/graphql-extras.svg?branch=master)](https://travis-ci.org/rzane/graphql-extras)
+<h1 align="center">GraphQL::Extras</h1>
+
+<div align="center">
+
+![Build](https://github.com/rzane/graphql-extras/workflows/Build/badge.svg)
+![Version](https://img.shields.io/gem/v/graphql-extras)
+
+</div>
 
 A collection of utilities for building GraphQL APIs.
 
+**Table of Contents**
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [GraphQL::Extras::Controller](#graphqlextrascontroller)
+  - [GraphQL::Extras::Preload](#graphqlextraspreload)
+  - [GraphQL::Extras::PreloadSource](#graphqlextraspreloadsource)
+  - [GraphQL::Extras::Types](#graphqlextrastypes)
+    - [Date](#date)
+    - [DateTime](#datetime)
+    - [Decimal](#decimal)
+    - [Upload](#upload)
+  - [GraphQL::Extras::Test](#graphqlextrastest)
+- [Development](#development)
+- [Contributing](#contributing)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,34 +53,44 @@ class GraphqlController < ApplicationController
 end
 ```
 
-### GraphQL::Extras::Batch::AssociationLoader
+### GraphQL::Extras::Preload
 
-This is a subclass of [`GraphQL::Batch::Loader`](https://github.com/Shopify/graphql-batch) that performs eager loading of Active Record associations.
+This allows you to preload associations before resolving fields.
 
 ```ruby
-loader = GraphQL::Extras::Batch::AssociationLoader.for(:blog)
-loader.load(Post.first)
-loader.load_many(Post.all)
-```
-
-### GraphQL::Extras::Batch::Resolvers
+class Schema < GraphQL::Schema
+  use GraphQL::Dataloader
+end
 
-This includes a set of convenience methods for query batching.
+class BaseField < GraphQL::Schema::Field
+  prepend GraphQL::Extras::Preload
+end
 
-```ruby
-class Post < GraphQL::Schema::Object
-  include GraphQL::Extras::Batch::Resolver
+class BaseObject < GraphQL::Schema::Object
+  field_class BaseField
+end
 
-  field :blog, BlogType, resolve: association(:blog), null: false
-  field :comments, [CommentType], resolve: association(:comments, preload: { comments: :user }), null: false
-  field :blog_title, String, null: false
+class PostType < BaseObject
+  field :author, AuthorType, preload: :author, null: false
+  field :author_posts, [PostType], preload: {author: :posts}, null: false
+  field :depends_on_author, Integer, preload: :author, null: false
 
-  def blog_title
-    association(object, :blog).then(&:title)
+  def author_posts
+    object.author.posts
   end
 end
 ```
 
+### GraphQL::Extras::PreloadSource
+
+This is a subclass of [`GraphQL::Dataloader::Source`](https://graphql-ruby.org/dataloader/overview.html) that performs eager loading of Active Record associations.
+
+```ruby
+loader = dataloader.with(GraphQL::Extras::PreloadSource, :blog)
+loader.load(Post.first)
+loader.load_many(Post.all)
+```
+
 ### GraphQL::Extras::Types
 
 In your base classes, you should include the `GraphQL::Extras::Types`.
@@ -88,7 +121,7 @@ This scalar takes a `DateTime` and transmits it as a string, using ISO 8601 form
 field :created_at, DateTime, required: true
 ```
 
-*Note: This is just an alias for the `ISO8601DateTime` type that is included in the `graphql` gem.*
+_Note: This is just an alias for the `ISO8601DateTime` type that is included in the `graphql` gem._
 
 #### Decimal
 
@@ -119,36 +152,44 @@ Take note of the correspondence between the value `"image"` and the additional H
 
 See [apollo-link-upload](https://github.com/rzane/apollo-link-upload) for the client-side implementation.
 
-### RSpec integration
+### GraphQL::Extras::Test
+
+This module makes it really easy to test your schema.
 
-Add the following to your `rails_helper.rb` (or `spec_helper.rb`).
+First, create a test schema:
 
 ```ruby
-require "graphql/extras/rspec"
+# spec/support/test_schema.rb
+require "graphql/extras/test"
+
+class TestSchema < GraphQL::Extras::Test::Schema
+  configure schema: Schema, queries: "spec/**/*.graphql"
+end
 ```
 
 Now, you can run tests like so:
 
 ```ruby
+require "support/test_schema"
+
 RSpec.describe "hello" do
   let(:context) { { name: "Ray" } }
-  let(:schema)  { use_schema(Schema, context: context) }
-  let(:queries) { graphql_fixture("hello.graphql") }
+  let(:schema)  { TestSchema.new(context) }
 
   it "allows easily executing queries" do
-    result = schema.execute(queries.hello)
+    query = schema.hello
 
-    expect(result).to be_successful_query
-    expect(result['data']['hello']).to eq("world")
+    expect(query).to be_successful
+    expect(query.data["hello"]).to eq("world")
   end
-end
-```
 
-The `graphql_fixture` method assumes that your queries live in `spec/fixtures/graphql`. You can change this assumption with the following configuration:
+  it "parses errors" do
+    query = schema.kaboom
 
-```ruby
-RSpec.configure do |config|
-  config.graphql_fixture_path = '/path/to/queries'
+    expect(query).not_to be_successful
+    expect(query.errors[0].message).to eq("Invalid")
+    expect(query.errors[0].code).to eq("VALIDATION_ERROR")
+  end
 end
 ```
 

data/graphql-extras.gemspec

@@ -10,10 +10,10 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Utiltities for building GraphQL APIs.}
   spec.description   = %q{A set of modules and types for buildign GraphQL APIs.}
-  spec.homepage      = "https://github.com/promptworks/graphql-extras"
+  spec.homepage      = "https://github.com/rzane/graphql-extras"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/promptworks/graphql-extras"
+  spec.metadata["source_code_uri"] = "https://github.com/rzane/graphql-extras"
 
   # 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.
@@ -25,13 +25,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.2"
-  spec.add_dependency "graphql", "~> 1.9"
-  spec.add_dependency "graphql-batch", "~> 0.4"
+  spec.add_dependency "graphql", "~> 1.12"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.8"
+  spec.add_development_dependency "rspec-rails", "~> 4.0"
   spec.add_development_dependency "actionpack", ">= 5.2"
   spec.add_development_dependency "activerecord", ">= 5.2"
   spec.add_development_dependency "sqlite3", "~> 1.4"

data/lib/graphql/extras.rb

@@ -1,7 +1,7 @@
 require "graphql/extras/version"
 require "graphql/extras/types"
 require "graphql/extras/controller"
-require "graphql/extras/batch"
+require "graphql/extras/preload"
 
 module GraphQL
   module Extras

data/lib/graphql/extras/preload.rb

@@ -0,0 +1,33 @@
+module GraphQL
+  module Extras
+    class PreloadSource < GraphQL::Dataloader::Source
+      def initialize(preload)
+        @preload = preload
+      end
+
+      def fetch(records)
+        preloader = ActiveRecord::Associations::Preloader.new
+        preloader.preload(records, @preload)
+        records
+      end
+    end
+
+    module Preload
+      # @override
+      def initialize(*args, preload: nil, **opts, &block)
+        @preload = preload
+        super(*args, **opts, &block)
+      end
+
+      # @override
+      def resolve(object, args, context)
+        if @preload
+          loader = context.dataloader.with(PreloadSource, @preload)
+          loader.load(object.object)
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/graphql/extras/test.rb

@@ -0,0 +1 @@
+require "graphql/extras/test/schema"

data/lib/graphql/extras/test/loader.rb

@@ -0,0 +1,59 @@
+module GraphQL
+  module Extras
+    module Test
+      class Loader
+        FragmentNotFoundError = Class.new(StandardError)
+
+        attr_reader :fragments
+        attr_reader :operations
+
+        def initialize
+          @fragments = {}
+          @operations = {}
+        end
+
+        def load(path)
+          document = ::GraphQL.parse_file(path)
+          document.definitions.each do |node|
+            case node
+            when Nodes::FragmentDefinition
+              fragments[node.name] = node
+            when Nodes::OperationDefinition
+              operations[node.name] = node
+            end
+          end
+        end
+
+        def print(operation)
+          printer = ::GraphQL::Language::Printer.new
+          nodes = [operation, *resolve_fragments(operation)]
+          nodes.map { |node| printer.print(node) }.join("\n")
+        end
+
+        private
+
+        Nodes = ::GraphQL::Language::Nodes
+
+        # Recursively iterate through the node's fields and find
+        # resolve all of the fragment definitions that are needed.
+        def resolve_fragments(node)
+          node.selections.flat_map do |field|
+            case field
+            when Nodes::FragmentSpread
+              fragment = fetch_fragment!(field.name)
+              [fragment, *resolve_fragments(fragment)]
+            else
+              resolve_fragments(field)
+            end
+          end
+        end
+
+        def fetch_fragment!(name)
+          fragments.fetch(name) do
+            raise FragmentNotFoundError, "Fragment `#{name}` is not defined"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/extras/test/response.rb

@@ -0,0 +1,37 @@
+module GraphQL
+  module Extras
+    module Test
+      class Response
+        attr_reader :data
+        attr_reader :errors
+
+        def initialize(payload)
+          @data = payload["data"]
+          @errors = payload.fetch("errors", []).map do |error|
+            Error.new(error)
+          end
+        end
+
+        def successful?
+          errors.empty?
+        end
+
+        class Error
+          attr_reader :message
+          attr_reader :extensions
+          attr_reader :code
+          attr_reader :path
+          attr_reader :locations
+
+          def initialize(payload)
+            @message = payload["message"]
+            @path = payload["path"]
+            @locations = payload["locations"]
+            @extensions = payload["extensions"]
+            @code = payload.dig("extensions", "code")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/extras/test/schema.rb

@@ -0,0 +1,57 @@
+require "securerandom"
+require "active_support/inflector"
+require "active_support/core_ext/hash"
+require "graphql/extras/test/loader"
+require "graphql/extras/test/response"
+
+module GraphQL
+  module Extras
+    module Test
+      class Schema
+        def self.configure(schema:, queries:)
+          loader = Loader.new
+
+          Dir.glob(queries) do |path|
+            loader.load(path)
+          end
+
+          loader.operations.each do |name, operation|
+            query = loader.print(operation)
+
+            define_method(name.underscore) do |variables = {}|
+              __execute(schema, query, variables)
+            end
+          end
+        end
+
+        def initialize(context = {})
+          @context = context
+        end
+
+        private
+
+        def __execute(schema, query, variables)
+          uploads = {}
+
+          variables = variables.deep_transform_keys do |key|
+            key.to_s.camelize(:lower)
+          end
+
+          variables = variables.deep_transform_values do |value|
+            if value.respond_to? :tempfile
+              id = SecureRandom.uuid
+              uploads[id] = value
+              id
+            else
+              value
+            end
+          end
+
+          context = @context.merge(uploads: uploads)
+          result = schema.execute(query, variables: variables, context: context)
+          Response.new(result.to_h)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/extras/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Extras
-    VERSION = "0.2.5"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-extras
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Ray Zane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,28 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: graphql-batch
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -157,9 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -167,16 +154,19 @@ files:
 - bin/setup
 - graphql-extras.gemspec
 - lib/graphql/extras.rb
-- lib/graphql/extras/batch.rb
 - lib/graphql/extras/controller.rb
-- lib/graphql/extras/rspec.rb
+- lib/graphql/extras/preload.rb
+- lib/graphql/extras/test.rb
+- lib/graphql/extras/test/loader.rb
+- lib/graphql/extras/test/response.rb
+- lib/graphql/extras/test/schema.rb
 - lib/graphql/extras/types.rb
 - lib/graphql/extras/version.rb
-homepage: https://github.com/promptworks/graphql-extras
+homepage: https://github.com/rzane/graphql-extras
 licenses: []
 metadata:
-  homepage_uri: https://github.com/promptworks/graphql-extras
-  source_code_uri: https://github.com/promptworks/graphql-extras
+  homepage_uri: https://github.com/rzane/graphql-extras
+  source_code_uri: https://github.com/rzane/graphql-extras
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -192,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Utiltities for building GraphQL APIs.

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.2

data/lib/graphql/extras/batch.rb

@@ -1,47 +0,0 @@
-require "graphql/batch"
-
-module GraphQL
-  module Extras
-    module Batch
-      class AssociationLoader < GraphQL::Batch::Loader
-        def initialize(name, preload: name)
-          @name = name
-          @preload = preload
-        end
-
-        def cache_key(record)
-          record.object_id
-        end
-
-        def perform(records)
-          preloader = ActiveRecord::Associations::Preloader.new
-          preloader.preload(records, @preload)
-
-          records.each do |record|
-            fulfill(record, record.public_send(@name))
-          end
-        end
-      end
-
-      module Resolvers
-        def self.included(base)
-          base.extend ClassMethods
-        end
-
-        module ClassMethods
-          def association(name)
-            lambda do |record, _args, _ctx|
-              loader = AssociationLoader.for(name)
-              loader.load(record)
-            end
-          end
-        end
-
-        def association(record, name)
-          loader = AssociationLoader.for(name)
-          loader.load(record)
-        end
-      end
-    end
-  end
-end

data/lib/graphql/extras/rspec.rb

@@ -1,133 +0,0 @@
-require "yaml"
-require "active_support/inflector"
-require "active_support/core_ext/hash"
-
-module GraphQL
-  module Extras
-    module RSpec
-      class Queries
-        def add(key, value)
-          define_singleton_method(key) { value }
-        end
-      end
-
-      class Schema
-        def initialize(schema, context: {})
-          @schema = schema
-          @context = context
-        end
-
-        def execute(query, variables = {})
-          variables = deep_camelize_keys(variables)
-          variables, uploads = extract_uploads(variables)
-          context = @context.merge(uploads: uploads)
-
-          result = @schema.execute(query, variables: variables, context: context)
-          result.to_h
-        end
-
-        private
-
-        def extract_uploads(variables)
-          uploads = {}
-          variables = deep_transform_values(variables) { |value|
-            if upload?(value)
-              SecureRandom.hex.tap { |key| uploads.merge!(key => value) }
-            else
-              value
-            end
-          }
-
-          [variables, uploads]
-        end
-
-        def deep_camelize_keys(variables)
-          variables.deep_transform_keys { |key| key.to_s.camelize(:lower) }
-        end
-
-        def deep_transform_values(data, &block)
-          case data
-          when Array
-            data.map { |v| deep_transform_values(v, &block) }
-          when Hash
-            data.transform_values { |v| deep_transform_values(v, &block) }
-          else
-            yield data
-          end
-        end
-
-        def upload?(value)
-          value.respond_to?(:tempfile) && value.respond_to?(:original_filename)
-        end
-      end
-
-      class Parser
-        include ::GraphQL::Language
-
-        def initialize(document)
-          @operations = document.definitions
-            .grep(Nodes::OperationDefinition)
-
-          @fragments = document.definitions
-            .grep(Nodes::FragmentDefinition)
-            .reduce({}) { |acc, f| acc.merge(f.name => f) }
-        end
-
-        def parse
-          queries = Queries.new
-          printer = Printer.new
-
-          @operations.each do |op|
-            nodes = [op, *find_fragments(op)]
-            nodes = nodes.map { |node| printer.print(node) }
-            queries.add op.name.underscore, nodes.join
-          end
-
-          queries
-        end
-
-        private
-
-        def find_fragments(node)
-          node.selections.flat_map do |field|
-            if field.is_a? Nodes::FragmentSpread
-              fragment = @fragments.fetch(field.name)
-              [fragment, *find_fragments(fragment)]
-            else
-              find_fragments(field)
-            end
-          end
-        end
-      end
-
-      def graphql_fixture(filename)
-        root = ::RSpec.configuration.graphql_fixture_path
-        file = File.join(root, filename)
-        document = ::GraphQL.parse_file(file)
-        parser = Parser.new(document)
-        parser.parse
-      end
-
-      def use_schema(*args)
-        Schema.new(*args)
-      end
-    end
-  end
-end
-
-RSpec::Matchers.define :be_successful_query do
-  match do |result|
-    result['errors'].nil?
-  end
-
-  failure_message do |result|
-    errors = result['errors'].map(&:deep_stringify_keys)
-    message = "expected query to be successful, but encountered errors:\n"
-    message + errors.to_yaml.lines.drop(1).join.indent(2)
-  end
-end
-
-RSpec.configure do |config|
-  config.add_setting :graphql_fixture_path, default: "spec/fixtures/graphql"
-  config.include GraphQL::Extras::RSpec, type: :graphql
-end