RubyGems - graphql_rails - Versions diffs - 0.8.0 → 1.2.2 - Mend

graphql_rails 0.8.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (75) hide show

checksums.yaml +4 -4
data/.hound.yml +1 -0
data/.rubocop.yml +3 -3
data/.ruby-version +1 -1
data/.travis.yml +2 -2
data/CHANGELOG.md +31 -0
data/Gemfile +3 -2
data/Gemfile.lock +147 -124
data/docs/README.md +24 -8
data/docs/_sidebar.md +3 -0
data/docs/components/controller.md +194 -21
data/docs/components/model.md +193 -5
data/docs/components/routes.md +28 -0
data/docs/getting_started/quick_start.md +10 -3
data/docs/index.html +1 -1
data/docs/other_tools/query_runner.md +49 -0
data/docs/other_tools/schema_dump.md +29 -0
data/docs/testing/testing.md +3 -1
data/graphql_rails.gemspec +5 -5
data/lib/generators/graphql_rails/install_generator.rb +50 -0
data/lib/generators/graphql_rails/templates/example_users_controller.erb +19 -0
data/lib/generators/graphql_rails/templates/graphql_application_controller.erb +8 -0
data/lib/generators/graphql_rails/templates/graphql_controller.erb +20 -0
data/lib/generators/graphql_rails/templates/graphql_router.erb +19 -0
data/lib/generators/graphql_rails/templates/graphql_router_spec.erb +21 -0
data/lib/graphql_rails.rb +2 -0
data/lib/graphql_rails/attributes/attributable.rb +20 -21
data/lib/graphql_rails/attributes/attribute.rb +41 -4
data/lib/graphql_rails/attributes/attribute_name_parser.rb +4 -4
data/lib/graphql_rails/attributes/input_attribute.rb +24 -10
data/lib/graphql_rails/attributes/input_type_parser.rb +24 -46
data/lib/graphql_rails/attributes/type_parseable.rb +132 -0
data/lib/graphql_rails/attributes/type_parser.rb +58 -54
data/lib/graphql_rails/concerns/service.rb +19 -0
data/lib/graphql_rails/controller.rb +26 -22
data/lib/graphql_rails/controller/action.rb +12 -67
data/lib/graphql_rails/controller/action_configuration.rb +70 -34
data/lib/graphql_rails/controller/build_controller_action_resolver.rb +52 -0
data/lib/graphql_rails/controller/build_controller_action_resolver/controller_action_resolver.rb +28 -0
data/lib/graphql_rails/controller/configuration.rb +56 -5
data/lib/graphql_rails/controller/log_controller_action.rb +11 -6
data/lib/graphql_rails/controller/request.rb +29 -8
data/lib/graphql_rails/controller/request/format_errors.rb +58 -0
data/lib/graphql_rails/decorator/relation_decorator.rb +1 -5
data/lib/graphql_rails/errors/custom_execution_error.rb +22 -0
data/lib/graphql_rails/errors/execution_error.rb +6 -7
data/lib/graphql_rails/errors/system_error.rb +14 -0
data/lib/graphql_rails/errors/validation_error.rb +1 -5
data/lib/graphql_rails/input_configurable.rb +47 -0
data/lib/graphql_rails/model.rb +19 -4
data/lib/graphql_rails/model/add_fields_to_graphql_type.rb +45 -0
data/lib/graphql_rails/model/build_connection_type.rb +52 -0
data/lib/graphql_rails/model/{configuration → build_connection_type}/count_items.rb +5 -5
data/lib/graphql_rails/model/build_enum_type.rb +39 -10
data/lib/graphql_rails/model/build_graphql_input_type.rb +8 -4
data/lib/graphql_rails/model/call_graphql_model_method.rb +72 -0
data/lib/graphql_rails/model/configurable.rb +6 -2
data/lib/graphql_rails/model/configuration.rb +11 -10
data/lib/graphql_rails/model/find_or_build_graphql_type.rb +64 -0
data/lib/graphql_rails/model/find_or_build_graphql_type_class.rb +46 -0
data/lib/graphql_rails/model/input.rb +10 -6
data/lib/graphql_rails/query_runner.rb +68 -0
data/lib/graphql_rails/railtie.rb +10 -0
data/lib/graphql_rails/router.rb +40 -13
data/lib/graphql_rails/router/resource_routes_builder.rb +10 -9
data/lib/graphql_rails/router/route.rb +21 -6
data/lib/graphql_rails/router/schema_builder.rb +30 -11
data/lib/graphql_rails/rspec_controller_helpers.rb +6 -4
data/lib/graphql_rails/tasks/dump_graphql_schema.rb +57 -0
data/lib/graphql_rails/tasks/schema.rake +14 -0
data/lib/graphql_rails/version.rb +1 -1
metadata +48 -21
data/lib/graphql_rails/controller/controller_function.rb +0 -50
data/lib/graphql_rails/controller/format_results.rb +0 -36
data/lib/graphql_rails/model/build_graphql_type.rb +0 -37

data/docs/components/routes.md CHANGED Viewed

@@ -99,3 +99,31 @@ MyGraphqlSchema = GraphqlRails::Router.draw do
   mutation :logIn, to: 'sessions#login' # this will trigger ::SessionsController
 end
 ```
+## _group_
+You can have multiple routers / schemas. In order to add resources or query only to specific schema, you need wrap it with `group` method, like this:
+```ruby
+GraphqlRouter = GraphqlRails::Router.draw do
+  resources :users # goes to all routers
+  group :mobile, :internal do
+    resources :admin_users # goes to `mobile` and `internal` schemas
+  end
+  query :runTesting, to: 'testing#run', group: :testing # goes to `testing` schema
+end
+```
+In order to call specific schema you can call it using `QueryRunner` in your RoR controller:
+```ruby
+class InternalController < ApplicationController
+  def execute
+    GraphqlRails::QueryRunner.new(group: :internal, params: params)
+  end
+end
+```
+If you want to access raw graphql schema, you can call `GraphqlRouter.graphql_schema(:mobile)`

data/docs/getting_started/quick_start.md CHANGED Viewed

@@ -1,10 +1,17 @@
 # Quick Start
+## Generate initial code
+```bash
+bundle exec rails g graphql_rails:install
+```
 ## Define GraphQL schema as RoR routes
 ```ruby
-MyGraphqlSchema = GraphqlRails::Router.draw do
-  # will create createUser, updateUser, deleteUser mutations and user, users queries.
+# config/graphql/routes.rb
+GraphqlRails::Router.draw do
+  # will create createUser, updateUser, destroyUser mutations and user, users queries.
   # expects that UsersController class exist
   resources :users
@@ -33,7 +40,7 @@ end
 ## Define controller
 ```ruby
-class UsersController < GraphqlRails::Controller
+class UsersController < ApplicationGraphqlController
   # graphql requires to describe which attributes controller action accepts and which returns
   action(:change_user_password)
     .permit(:password!, :id!) # Bang (!) indicates that attribute is required

data/docs/index.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8">
-  <title>Document</title>
+  <title>GraphqlRails</title>
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
   <meta name="description" content="Description">
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">

data/docs/other_tools/query_runner.md ADDED Viewed

@@ -0,0 +1,49 @@
+# Query Runner
+`GraphqlRails::QueryRunner` is a helper class which let's you graphql queries in RoR controller without worrying about parsing details. Here is an example how to use it:
+```ruby
+class MyRailsClass < ApplicationController
+  def execute
+    graphql_result = GraphqlRails::QueryRunner.call(
+      params: params, router: GraphqlRouter
+    )
+    render json: graphql_result
+  end
+end
+```
+## Executing grouped schema
+If you have multiple schemas (read [routes section](components/routes) on how to do that) and you want to render group specific schema, you need to provide group name, like this:
+```ruby
+class MyRailsClass < ApplicationController
+  def execute
+    graphql_result = GraphqlRails::QueryRunner.call(
+      group: :internal, # <- custom group name. Can by anything
+      params: params, router: GraphqlRouter
+    )
+    render json: graphql_result
+  end
+end
+```
+## Providing graphql-ruby options
+All graphql-ruby options are also supported, like [execution options](https://graphql-ruby.org/queries/executing_queries.html) or [visibility options](https://graphql-ruby.org/schema/limiting_visibility.html):
+```ruby
+class MyRailsClass < ApplicationController
+  def execute
+    graphql_result = GraphqlRails::QueryRunner.call(
+      validate: true, # <- graphql-ruby option
+      params: params, router: GraphqlRouter
+    )
+    render json: graphql_result
+  end
+end
+```

data/docs/other_tools/schema_dump.md ADDED Viewed

@@ -0,0 +1,29 @@
+# Schema Dump
+GraphqlRails includes rake task to allow creating schema snapshots easier:
+```bash
+rake graphql_rails:schema:dump
+```
+## Dumping non default schema
+You can have multiple graphql schemas. Read more about this in [routes section](components/routes). In order to generate schema for one of groups, provide optional `name` argument:
+```bash
+rake graphql_rails:schema:dump['your_group_name']
+```
+or using env variable `SCHEMA_GROUP_NAME`:
+```bash
+SCHEMA_GROUP_NAME=your_group_name rake graphql_rails:schema:dump
+```
+## Dumping schema in to non default path
+By default schema will be dumped to `spec/fixtures/graphql_schema.graphql` path. If you want different schema path, add `GRAPHQL_SCHEMA_DUMP_PATH` env variable, like this:
+```bash
+GRAPHQL_SCHEMA_DUMP_PATH='path/to/my/schema.graphql' rake graphql_rails:schema:dump
+```

data/docs/testing/testing.md CHANGED Viewed

@@ -28,11 +28,13 @@ There are 3 helper methods:
 ```ruby
 class MyGraphqlController
+  action(:create_user).permit(:full_name, :email).returns(User)
+  action(:index).returns('String')
   def index
     "Called from index: #{params[:message]}"
   end
-  action(:create_user).permit(:full_name, :email)
   def create_user
     User.create!(params)
   end

data/graphql_rails.gemspec CHANGED Viewed

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Povilas Jurčys']
   spec.email         = ['po.jurcys@gmail.com']
-  spec.summary       = %q{GraphQL server and client for rails}
+  spec.summary       = %q{Rails style structure for GraphQL API.}
   spec.homepage      = 'https://github.com/samesystem/graphql_rails'
   spec.license       = 'MIT'
@@ -20,13 +20,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.add_dependency 'graphql', '~> 1'
+  spec.add_dependency 'graphql', '~> 1.12', '>= 1.12.4'
   spec.add_dependency 'activesupport', '>= 4'
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rails', '~> 5'
+  spec.add_development_dependency 'rails', '~> 6'
 end

data/lib/generators/graphql_rails/install_generator.rb ADDED Viewed

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module GraphqlRails
+  # no-doc
+  module Generators
+    require 'rails/generators/base'
+    # Add GraphQL to a Rails app with `rails g graphql_rails:install`.
+    #
+    # Setup a folder structure for GraphQL:
+    #
+    # ```
+    # - app/
+    #   - controllers
+    #     - graphql_controller.rb
+    #     - graphql
+    #       - graphql_application_controller.rb
+    #   - graphql
+    #     - graphql_router.rb
+    # ```
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Install GraphqlRails folder structure and boilerplate code'
+      source_root File.expand_path('../templates', __FILE__) # rubocop:disable Style/ExpandPathArguments
+      def create_folder_structure
+        empty_directory('app/controllers')
+        template('graphql_controller.erb', 'app/controllers/graphql_controller.rb')
+        empty_directory('app/controllers/graphql')
+        template('graphql_application_controller.erb', 'app/controllers/graphql/graphql_application_controller.rb')
+        template('example_users_controller.erb', 'app/controllers/graphql/example_users_controller.rb')
+        application do
+          "config.autoload_paths << 'app/graphql'"
+        end
+        empty_directory('app/graphql')
+        template('graphql_router.erb', 'app/graphql/graphql_router.rb')
+        route('post "/graphql", to: "graphql#execute"')
+        if File.directory?('spec') # rubocop:disable Style/GuardClause
+          empty_directory('spec/graphql')
+          template('graphql_router_spec.erb', 'spec/app/graphql/graphql_router_spec.rb')
+        end
+      end
+    end
+  end
+end

data/lib/generators/graphql_rails/templates/example_users_controller.erb ADDED Viewed

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Graphql
+  # base class of all GraphqlControllers
+  class ExampleUsersController < GraphqlApplicationController
+    model('String')
+    action(:show).permit(id: :ID!).returns_single
+    action(:update).permit(id: :ID!).returns_single
+    def show
+      'this is example show action. Remove it and write something real'
+    end
+    def update
+      'this is example update action. Remove it and write something real'
+    end
+  end
+end

data/lib/generators/graphql_rails/templates/graphql_application_controller.erb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Graphql
+  # base class of all GraphqlControllers
+  class GraphqlApplicationController < GraphqlRails::Controller
+    # TODO: add app specific customizations here
+  end
+end

data/lib/generators/graphql_rails/templates/graphql_controller.erb ADDED Viewed

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+class GraphqlController < ApplicationController
+  skip_before_action :verify_authenticity_token, only: :execute
+  def execute
+    render json: GraphqlRails::QueryRunner.call(
+      params: params,
+      context: graphql_context
+    )
+  end
+  private
+  # data defined here will be accessible via `grapqhl_request.context`
+  # in GraphqlRails::Controller instances
+  def graphql_context
+    {}
+  end
+end

data/lib/generators/graphql_rails/templates/graphql_router.erb ADDED Viewed

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+GraphqlRouter = GraphqlRails::Router.draw do
+  scope module: :graphql do
+    # this will create all CRUD actions for Graphql::UsersController:
+    #   resources :users
+    #
+    # If you want non-CRUD custom actions, you can define them like this:
+    #   query :find_something, to: 'controller_name#action_name'
+    #   mutation :change_something, to: 'controller_name#action_name'
+    # or you can include them in resources part:
+    #   resources :users do
+    #     query :find_one, on: :member
+    #     query :find_many, on: :collection
+    #   end
+    resources :example_users, only: %i[show update]
+  end
+end

data/lib/generators/graphql_rails/templates/graphql_router_spec.erb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'rails_helper'
+RSpec.describe GraphqlRouter do
+  subject(:schema) { described_class.graphql_schema }
+  describe '#to_definition' do
+    subject(:to_definition) { schema.to_definition.strip }
+    let(:schema_dump_path) { Rails.root.join('spec', 'fixtures', 'graphql_schema.graphql') }
+    let(:previous_definition) { File.read(schema_dump_path).strip }
+    it 'returns correct structure' do
+      # if you need to update saved_schema, run rake task:
+      #   $ RAILS_ENV=test bin/rake graphql_rails:schema:dump
+      expect(to_definition).to eq(previous_definition)
+    end
+  end
+end

data/lib/graphql_rails.rb CHANGED Viewed

@@ -8,6 +8,8 @@ require 'graphql_rails/router'
 require 'graphql_rails/controller'
 require 'graphql_rails/attributes'
 require 'graphql_rails/decorator'
+require 'graphql_rails/query_runner'
+require 'graphql_rails/railtie' if defined?(Rails)
 # wonders starts here
 module GraphqlRails

data/lib/graphql_rails/attributes/attributable.rb CHANGED Viewed

@@ -21,41 +21,40 @@ module GraphqlRails
       end
       def required?
-        if @required.nil?
-          attribute_name_parser.required? || !initial_type.to_s[/!$/].nil?
-        else
-          @required
-        end
+        return @required unless @required.nil?
+        attribute_name_parser.required? || !initial_type.to_s[/!$/].nil? || initial_type.is_a?(GraphQL::Schema::NonNull)
       end
-      def graphql_model
-        type_parser.graphql_model
+      def required
+        @required = true
+        self
       end
-      def graphql_field_type
-        @graphql_field_type ||= \
-          if required?
-            nullable_type.to_non_null_type
-          else
-            nullable_type
-          end
+      def optional
+        @required = false
+        self
       end
-      protected
+      def graphql_model
+        type_parser.graphql_model
+      end
-      def options
-        {}
+      def optional?
+        !required?
       end
-      def nullable_type
-        type = type_parser.graphql_type
-        type.non_null? ? type.of_type : type
+      def scalar_type?
+        type_parser.raw_graphql_type? || type_parser.core_scalar_type?
       end
       private
       def type_parser
-        @type_parser ||= TypeParser.new(initial_type || attribute_name_parser.graphql_type)
+        @type_parser ||= begin
+          type_for_parser = initial_type || attribute_name_parser.graphql_type
+          TypeParser.new(type_for_parser, paginated: paginated?)
+        end
       end
       def attribute_name_parser

data/lib/graphql_rails/attributes/attribute.rb CHANGED Viewed

@@ -2,20 +2,28 @@
 require 'graphql'
 require 'graphql_rails/attributes/attributable'
+require 'graphql_rails/input_configurable'
 module GraphqlRails
   module Attributes
     # contains info about single graphql attribute
     class Attribute
       include Attributable
+      include InputConfigurable
-      def initialize(name, type = nil, description: nil, property: name, required: nil)
+      attr_reader :attributes
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(name, type = nil, description: nil, property: name, required: nil, options: {})
         @initial_type = type
         @initial_name = name
+        @options = options
         @description = description
         @property = property.to_s
         @required = required
+        @attributes ||= {}
       end
+      # rubocop:enable Metrics/ParameterLists
       def type(new_type = nil)
         return @initial_type if new_type.nil?
@@ -38,13 +46,36 @@ module GraphqlRails
         self
       end
+      def options(new_options = {})
+        return @options if new_options.blank?
+        @options = new_options
+        self
+      end
       def field_args
         [
           field_name,
-          graphql_field_type,
+          type_parser.type_arg,
+          *description
+        ]
+      end
+      def field_options
+        {
+          method: property.to_sym,
+          null: optional?,
+          camelize: camelize?
+        }
+      end
+      def argument_args
+        [
+          field_name,
+          type_parser.type_arg,
           {
-            property: property.to_sym,
-            description: description
+            description: description,
+            required: required?
           }
         ]
       end
@@ -52,6 +83,12 @@ module GraphqlRails
       protected
       attr_reader :initial_type, :initial_name
+      private
+      def camelize?
+        options[:input_format] != :original && options[:attribute_name_format] != :original
+      end
     end
   end
 end