graphql 0.16.0 → 2.0.15

data/lib/graphql.rb

@@ -1,71 +1,116 @@
+# frozen_string_literal: true
+require "delegate"
 require "json"
 require "set"
 require "singleton"
 require "forwardable"
 
 module GraphQL
+  # forwards-compat for argument handling
+  module Ruby2Keywords
+    if RUBY_VERSION < "2.7"
+      def ruby2_keywords(*)
+      end
+    end
+  end
+
   class Error < StandardError
   end
 
-  class ParseError < Error
-    attr_reader :line, :col, :query
-    def initialize(message, line, col, query)
+  # This error is raised when GraphQL-Ruby encounters a situation
+  # that it *thought* would never happen. Please report this bug!
+  class InvariantError < Error
+    def initialize(message)
+      message += "
+
+This is probably a bug in GraphQL-Ruby, please report this error on GitHub: https://github.com/rmosolgo/graphql-ruby/issues/new?template=bug_report.md"
       super(message)
-      @line = line
-      @col = col
-      @query = query
     end
   end
 
-  # Turn a query string into an AST
-  # @param [String] a GraphQL query string
+  class RequiredImplementationMissingError < Error
+  end
+
+  class << self
+    def default_parser
+      @default_parser ||= GraphQL::Language::Parser
+    end
+
+    attr_writer :default_parser
+  end
+
+  # Turn a query string or schema definition into an AST
+  # @param graphql_string [String] a GraphQL query string or schema definition
+  # @return [GraphQL::Language::Nodes::Document]
+  def self.parse(graphql_string, tracer: GraphQL::Tracing::NullTracer)
+    parse_with_racc(graphql_string, tracer: tracer)
+  end
+
+  # Read the contents of `filename` and parse them as GraphQL
+  # @param filename [String] Path to a `.graphql` file containing IDL or query
   # @return [GraphQL::Language::Nodes::Document]
-  def self.parse(query_string)
-    parse_with_racc(query_string)
+  def self.parse_file(filename)
+    content = File.read(filename)
+    parse_with_racc(content, filename: filename)
+  end
+
+  def self.parse_with_racc(string, filename: nil, tracer: GraphQL::Tracing::NullTracer)
+    GraphQL::Language::Parser.parse(string, filename: filename, tracer: tracer)
   end
 
-  def self.parse_with_racc(string)
-    GraphQL::Language::Parser.parse(string)
+  # @return [Array<GraphQL::Language::Token>]
+  def self.scan(graphql_string)
+    scan_with_ragel(graphql_string)
+  end
+
+  def self.scan_with_ragel(graphql_string)
+    GraphQL::Language::Lexer.tokenize(graphql_string)
   end
 end
 
 # Order matters for these:
 
 require "graphql/execution_error"
-require "graphql/define"
-require "graphql/base_type"
-require "graphql/object_type"
-
-require "graphql/enum_type"
-require "graphql/input_object_type"
-require "graphql/interface_type"
-require "graphql/list_type"
-require "graphql/non_null_type"
-require "graphql/union_type"
-
-require "graphql/argument"
-require "graphql/field"
+require "graphql/runtime_type_error"
+require "graphql/unresolved_type_error"
+require "graphql/invalid_null_error"
+require "graphql/analysis_error"
+require "graphql/coercion_error"
+require "graphql/invalid_name_error"
+require "graphql/integer_decoding_error"
+require "graphql/integer_encoding_error"
+require "graphql/string_encoding_error"
+require "graphql/date_encoding_error"
 require "graphql/type_kinds"
+require "graphql/name_validator"
+require "graphql/language"
 
-require "graphql/scalar_type"
-require "graphql/boolean_type"
-require "graphql/float_type"
-require "graphql/id_type"
-require "graphql/int_type"
-require "graphql/string_type"
-require "graphql/directive"
+require_relative "./graphql/railtie" if defined? Rails::Railtie
 
-require "graphql/introspection"
-require "graphql/language"
 require "graphql/analysis"
+require "graphql/tracing"
+require "graphql/dig"
+require "graphql/execution"
+require "graphql/pagination"
 require "graphql/schema"
-require "graphql/schema/printer"
-
-# Order does not matter for these:
-
-require "graphql/analysis_error"
-require "graphql/invalid_null_error"
 require "graphql/query"
-require "graphql/internal_representation"
+require "graphql/types"
+require "graphql/dataloader"
+require "graphql/filter"
 require "graphql/static_validation"
+require "graphql/execution"
+require "graphql/schema/built_in_types"
+require "graphql/schema/loader"
+require "graphql/schema/printer"
+require "graphql/introspection"
+require "graphql/relay"
+
 require "graphql/version"
+require "graphql/subscriptions"
+require "graphql/parse_error"
+require "graphql/backtrace"
+
+require "graphql/unauthorized_error"
+require "graphql/unauthorized_field_error"
+require "graphql/load_application_object_failed_error"
+require "graphql/deprecation"

data/readme.md

@@ -1,23 +1,13 @@
-# graphql <img src="https://cloud.githubusercontent.com/assets/2231765/9094460/cb43861e-3b66-11e5-9fbf-71066ff3ab13.png" height=40 alt="graphql-ruby"/>
+# graphql <img src="https://cloud.githubusercontent.com/assets/2231765/9094460/cb43861e-3b66-11e5-9fbf-71066ff3ab13.png" height="40" alt="graphql-ruby"/>
 
-[![Build Status](https://travis-ci.org/rmosolgo/graphql-ruby.svg?branch=master)](https://travis-ci.org/rmosolgo/graphql-ruby)
+[![CI Suite](https://github.com/rmosolgo/graphql-ruby/actions/workflows/ci.yaml/badge.svg)](https://github.com/rmosolgo/graphql-ruby/actions/workflows/ci.yaml)
 [![Gem Version](https://badge.fury.io/rb/graphql.svg)](https://rubygems.org/gems/graphql)
-[![Code Climate](https://codeclimate.com/github/rmosolgo/graphql-ruby/badges/gpa.svg)](https://codeclimate.com/github/rmosolgo/graphql-ruby)
-[![Test Coverage](https://codeclimate.com/github/rmosolgo/graphql-ruby/badges/coverage.svg)](https://codeclimate.com/github/rmosolgo/graphql-ruby)
-[![built with love](https://cloud.githubusercontent.com/assets/2231765/6766607/d07992c6-cfc9-11e4-813f-d9240714dd50.png)](http://rmosolgo.github.io/react-badges/)
 
-A Ruby implementation of [GraphQL](http://graphql.org/).
+A Ruby implementation of [GraphQL](https://graphql.org/).
 
- - Guides
-     - [Introduction](http://www.rubydoc.info/github/rmosolgo/graphql-ruby/file/guides/introduction.md)
-     - [Defining Your Schema](http://www.rubydoc.info/github/rmosolgo/graphql-ruby/file/guides/defining_your_schema.md)
-     - [Executing Queries](http://www.rubydoc.info/github/rmosolgo/graphql-ruby/file/guides/executing_queries.md)
-     - [Testing](http://www.rubydoc.info/github/rmosolgo/graphql-ruby/file/guides/testing.md)
-     - [Code Reuse](http://www.rubydoc.info/github/rmosolgo/graphql-ruby/file/guides/code_reuse.md)
-     - [Security](http://www.rubydoc.info/github/rmosolgo/graphql-ruby/file/guides/security.md)
-
-
- - [API Documentation](http://www.rubydoc.info/github/rmosolgo/graphql-ruby)
+- [Website](https://graphql-ruby.org/)
+- [API Documentation](https://www.rubydoc.info/github/rmosolgo/graphql-ruby)
+- [Newsletter](https://tinyletter.com/graphql-ruby)
 
 ## Installation
 
@@ -32,63 +22,19 @@ gem 'graphql'
 $ bundle install
 ```
 
-## Overview
-
-#### Declare types & build a schema
+## Getting Started
 
-```ruby
-# Declare a type...
-PostType = GraphQL::ObjectType.define do
-  name "Post"
-  description "A blog post"
-
-  field :id, !types.ID
-  field :title, !types.String
-  field :body, !types.String
-  field :comments, types[!CommentType]
-end
-
-# ...and a query root
-QueryType = GraphQL::ObjectType.define do
-  name "Query"
-  description "The query root of this schema"
-
-  field :post do
-    type PostType
-    argument :id, !types.ID
-    resolve -> (obj, args, ctx) { Post.find(args["id"]) }
-  end
-end
-
-# Then create your schema
-Schema = GraphQL::Schema.new(
-  query: QueryType,
-  max_depth: 8,
-)
 ```
-
-#### Execute queries
-
-Execute GraphQL queries on a given schema, from a query string.
-
-```ruby
-result_hash = Schema.execute(query_string)
-# {
-#   "data" => {
-#     "post" => {
-#        "id" => 1,
-#        "title" => "GraphQL is nice"
-#     }
-#   }
-# }
+$ rails generate graphql:install
 ```
 
-#### Use with Relay
+After this, you may need to run `bundle install` again, as by default graphiql-rails is added on installation.
+
+Or, see ["Getting Started"](https://graphql-ruby.org/getting_started.html).
 
-If you're building a backend for [Relay](http://facebook.github.io/relay/), you'll need:
+## Upgrade
 
-- A JSON dump of the schema, which you can get by sending [`GraphQL::Introspection::INTROSPECTION_QUERY`](https://github.com/rmosolgo/graphql-ruby/blob/master/lib/graphql/introspection/introspection_query.rb)
-- Relay-specific helpers for GraphQL like Connections, node fields, and global ids. Here's one example of those: [`graphql-relay`](https://github.com/rmosolgo/graphql-relay-ruby)
+I also sell [GraphQL::Pro](https://graphql.pro) which provides several features on top of the GraphQL runtime, including [Pundit authorization](https://graphql-ruby.org/authorization/pundit_integration), [CanCan authorization](https://graphql-ruby.org/authorization/can_can_integration), [Pusher-based subscriptions](https://graphql-ruby.org/subscriptions/pusher_implementation) and [persisted queries](https://graphql-ruby.org/operation_store/overview). Besides that, Pro customers get email support and an opportunity to support graphql-ruby's development!
 
 ## Goals
 
@@ -98,38 +44,6 @@ If you're building a backend for [Relay](http://facebook.github.io/relay/), you'
 
 ## Getting Involved
 
-- __Say hi & ask questions__ in the [#ruby channel on Slack](https://graphql-slack.herokuapp.com/) or [on Twitter](https://twitter.com/rmosolgo)!
+- __Say hi & ask questions__ in the #graphql-ruby channel on [Discord](https://discord.com/invite/xud7bH9) or [on Twitter](https://twitter.com/rmosolgo)!
 - __Report bugs__ by posting a description, full stack trace, and all relevant code in a  [GitHub issue](https://github.com/rmosolgo/graphql-ruby/issues).
-- __Features & patches__ are welcome! Consider discussing it in an [issue](https://github.com/rmosolgo/graphql-ruby/issues) or in the [#ruby channel on Slack](https://graphql-slack.herokuapp.com/) to make sure we're on the same page.
-- __Run the tests__ with `rake test` or start up guard with `bundle exec guard`.
-
-## Related Projects
-
-### Code
-
-- `graphql-ruby` + Rails demo ([src](https://github.com/rmosolgo/graphql-ruby-demo) / [heroku](http://graphql-ruby-demo.herokuapp.com))
-- [`graphql-batch`](https://github.com/shopify/graphql-batch), a batched query execution strategy
-- [Example Relay support](https://github.com/rmosolgo/graphql-relay-ruby) in Ruby
-- [`graphql-libgraphqlparser`](https://github.com/rmosolgo/graphql-libgraphqlparser), bindings to [libgraphqlparser](https://github.com/graphql/libgraphqlparser), a C-level parser.
-
-### Blog Posts
-
--  Building a blog in GraphQL and Relay on Rails [Introduction](https://medium.com/@gauravtiwari/graphql-and-relay-on-rails-getting-started-955a49d251de), [Part 1]( https://medium.com/@gauravtiwari/graphql-and-relay-on-rails-creating-types-and-schema-b3f9b232ccfc), [Part 2](https://medium.com/@gauravtiwari/graphql-and-relay-on-rails-first-relay-powered-react-component-cb3f9ee95eca)
-- https://medium.com/@khor/relay-facebook-on-rails-8b4af2057152
-- https://blog.jacobwgillespie.com/from-rest-to-graphql-b4e95e94c26b#.4cjtklrwt
-- http://mgiroux.me/2015/getting-started-with-rails-graphql-relay/
-- http://mgiroux.me/2015/uploading-files-using-relay-with-rails/
-
-## To Do
-
-- Accept type name as `type` argument?
-  - Goal: accept `field :post, "Post"` to look up a type named `"Post"` in the schema
-  - Problem: how does a field know which schema to look up the name from?
-  - Problem: how can we load types in Rails without accessing the constant?
-  - Maybe support by third-party library? `type("Post!")` could implement "type_missing", keeps `graphql-ruby` very simple
-- If we eval'd `define { ... }` blocks _lazily_, would that work around all circular dependency issues?
-- `QueryComplexity` improvements:
-  - Better detection of union / interface possibilities? Right now they're summed
-- Type check improvements:
-  - Use catch-all type/field/argument definitions instead of terminating traversal
-  - Reduce ad-hoc traversals?
+- __Start hacking__ with the [Development guide](https://graphql-ruby.org/development).