graphql_rails 0.6.0 → 1.2.0

data/lib/graphql_rails/router.rb

@@ -11,32 +11,39 @@ module GraphqlRails
   # graphql router that mimics Rails.application.routes
   class Router
     RAW_ACTION_NAMES = %i[
-      rescue_from query_analyzer instrument cursor_encoder default_max_page_size
+      use rescue_from query_analyzer instrument cursor_encoder default_max_page_size
     ].freeze
 
     def self.draw(&block)
-      router = new
-      router.instance_eval(&block)
-      router.graphql_schema
+      new.tap do |router|
+        router.instance_eval(&block)
+      end
     end
 
     attr_reader :routes, :namespace_name, :raw_graphql_actions
 
-    def initialize(module_name: '')
+    def initialize(module_name: '', group_names: [])
       @module_name = module_name
+      @group_names = group_names
       @routes ||= Set.new
       @raw_graphql_actions ||= []
     end
 
+    def group(*group_names, &block)
+      scoped_router = router_with(group_names: group_names)
+      scoped_router.instance_eval(&block)
+      routes.merge(scoped_router.routes)
+    end
+
     def scope(**options, &block)
       full_module_name = [module_name, options[:module]].reject(&:empty?).join('/')
-      scoped_router = self.class.new(module_name: full_module_name)
+      scoped_router = router_with(module_name: full_module_name)
       scoped_router.instance_eval(&block)
       routes.merge(scoped_router.routes)
     end
 
     def resources(name, **options, &block)
-      builder_options = default_route_options.merge(options)
+      builder_options = full_route_options(options)
       routes_builder = ResourceRoutesBuilder.new(name, **builder_options)
       routes_builder.instance_eval(&block) if block
       routes.merge(routes_builder.routes)
@@ -56,25 +63,45 @@ module GraphqlRails
       end
     end
 
-    def graphql_schema
-      SchemaBuilder.new(
+    def graphql_schema(group = nil)
+      @graphql_schema ||= {}
+      @graphql_schema[group&.to_sym] ||= SchemaBuilder.new(
         queries: routes.select(&:query?),
         mutations: routes.select(&:mutation?),
-        raw_actions: raw_graphql_actions
+        raw_actions: raw_graphql_actions,
+        group: group
       ).call
     end
 
+    def reload_schema
+      @graphql_schema = nil
+    end
+
     private
 
-    attr_reader :module_name
+    attr_reader :module_name, :group_names
+
+    def router_with(new_router_options = {})
+      default_options = { module_name: module_name, group_names: group_names }
+      full_options = default_options.merge(new_router_options)
+
+      self.class.new(**full_options)
+    end
 
     def add_raw_action(name, *args, &block)
       raw_graphql_actions << { name: name, args: args, block: block }
     end
 
     def build_route(route_builder, name, **options)
-      route_options = default_route_options.merge(options)
-      route_builder.new(name, route_options)
+      route_builder.new(name, **full_route_options(options))
+    end
+
+    def full_route_options(extra_options)
+      extra_groups = Array(extra_options[:group]) + Array(extra_options[:groups])
+      extra_options = extra_options.except(:group, :groups)
+      groups = (group_names + extra_groups).uniq
+
+      default_route_options.merge(extra_options).merge(groups: groups)
     end
 
     def default_route_options

data/lib/graphql_rails/router/resource_routes_builder.rb

@@ -20,12 +20,12 @@ module GraphqlRails
         @routes ||= initial_routes
       end
 
-      def query(*args)
-        routes << build_query(*args)
+      def query(*args, **kwargs)
+        routes << build_query(*args, **kwargs)
       end
 
-      def mutation(*args)
-        routes << build_mutation(*args)
+      def mutation(*args, **kwargs)
+        routes << build_mutation(*args, **kwargs)
       end
 
       private
@@ -54,19 +54,27 @@ module GraphqlRails
         routes
       end
 
-      def build_mutation(*args)
-        build_route(MutationRoute, *args)
+      def build_mutation(*args, **kwargs)
+        build_route(MutationRoute, *args, **kwargs)
       end
 
-      def build_query(*args)
-        build_route(QueryRoute, *args)
+      def build_query(*args, **kwargs)
+        build_route(QueryRoute, *args, **kwargs)
       end
 
-      def build_route(builder, action, prefix: action, on: :member, **custom_options)
+      # rubocop:disable Metrics/ParameterLists
+      def build_route(builder, action, prefix: action, suffix: false, on: :member, **custom_options)
+        if suffix == true
+          suffix_name = action
+          prefix = ''
+        end
+
         action_options = options.merge(custom_options).merge(on: on)
-        action_name = [prefix, resource_name(on)].reject(&:empty?).join('_')
-        builder.new(action_name, to: "#{name}##{action}", **action_options)
+        controller_method_name = action.to_s.underscore
+        action_name = [prefix, resource_name(on), suffix_name].map(&:to_s).reject(&:empty?).join('_')
+        builder.new(action_name, to: "#{name}##{controller_method_name}", **action_options)
       end
+      # rubocop:enable Metrics/ParameterLists
 
       def initial_action_names(only, except, available)
         alowed_routes = Array(only || available) & available

data/lib/graphql_rails/router/route.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../controller/controller_function'
+require_relative '../controller/build_controller_action_resolver'
 
 module GraphqlRails
   class Router
@@ -8,10 +8,11 @@ module GraphqlRails
     class Route
       attr_reader :name, :module_name, :on, :relative_path
 
-      def initialize(name, to: '', on:, **options)
+      def initialize(name, to: '', on:, groups: nil, **options)
         @name = name.to_s.camelize(:lower)
         @module_name = options[:module].to_s
         @function = options[:function]
+        @groups = groups
         @relative_path = to
         @on = on.to_sym
       end
@@ -26,12 +27,26 @@ module GraphqlRails
         on == :collection
       end
 
-      def member?
-        on == :member
+      def show_in_group?(group_name)
+        return true if groups.nil? || groups.empty?
+
+        groups.include?(group_name&.to_sym)
+      end
+
+      def field_options
+        if function
+          { function: function }
+        else
+          { resolver: resolver }
+        end
       end
 
-      def function
-        @function ||= Controller::ControllerFunction.from_route(self)
+      private
+
+      attr_reader :function, :groups
+
+      def resolver
+        @resolver ||= Controller::BuildControllerActionResolver.call(route: self)
       end
     end
   end

data/lib/graphql_rails/router/schema_builder.rb

@@ -8,34 +8,59 @@ module GraphqlRails
 
       attr_reader :queries, :mutations, :raw_actions
 
-      def initialize(queries:, mutations:, raw_actions:)
+      def initialize(queries:, mutations:, raw_actions:, group: nil)
         @queries = queries
         @mutations = mutations
         @raw_actions = raw_actions
+        @group = group
       end
 
       def call
-        query_type = build_type('Query', queries)
-        mutation_type = build_type('Mutation', mutations)
+        query_type = build_group_type('Query', queries)
+        mutation_type = build_group_type('Mutation', mutations)
         raw = raw_actions
 
-        GraphQL::Schema.define do
+        Class.new(GraphQL::Schema) do
+          connections.add(
+            GraphqlRails::Decorator::RelationDecorator,
+            GraphQL::Pagination::ActiveRecordRelationConnection
+          )
           cursor_encoder(Router::PlainCursorEncoder)
           raw.each { |action| send(action[:name], *action[:args], &action[:block]) }
 
-          query(query_type)
-          mutation(mutation_type)
+          query(query_type) if query_type
+          mutation(mutation_type) if mutation_type
+
+          def self.type_from_ast(*args)
+            type = super
+
+            type.respond_to?(:to_graphql) ? type.to_graphql : type
+          end
         end
       end
 
       private
 
-      def build_type(type_name, routes)
-        GraphQL::ObjectType.define do
-          name type_name
+      attr_reader :group
+
+      def build_group_type(type_name, routes)
+        group_name = group
+        group_routes = routes.select { |route| route.show_in_group?(group_name) }
+        return if group_routes.empty?
+
+        build_type(type_name, group_routes)
+      end
+
+      def build_type(type_name, group_routes)
+        Class.new(GraphQL::Schema::Object) do
+          graphql_name(type_name)
+
+          group_routes.each do |route|
+            field(*route.name, **route.field_options)
+          end
 
-          routes.each do |route|
-            field route.name, function: route.function
+          def self.inspect
+            "#{GraphQL::Schema::Object}(#{graphql_name})"
           end
         end
       end

data/lib/graphql_rails/rspec_controller_helpers.rb

@@ -82,11 +82,13 @@ module GraphqlRails
         action_by_name = config.action_by_name
         controller_path = controller.name.underscore.sub(/_controller\Z/, '')
 
-        Router.draw do
+        router = Router.draw do
           action_by_name.keys.each do |action_name|
-            query("#{action_name}_test", to: "#{controller_path}##{action_name}")
+            query("#{action_name}_test", to: "#{controller_path}##{action_name}", group: :graphql_rspec_helpers)
           end
         end
+
+        router.graphql_schema(:graphql_rspec_helpers)
       end
     end
 
@@ -107,8 +109,8 @@ module GraphqlRails
       @response
     end
 
-    def mutation(*args)
-      query(*args)
+    def mutation(*args, **kwargs)
+      query(*args, **kwargs)
     end
 
     def response

data/lib/graphql_rails/tasks/dump_graphql_schema.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module GraphqlRails
+  # Generates graphql schema dump files
+  class DumpGraphqlSchema
+    require 'graphql_rails/errors/error'
+
+    class MissingGraphqlRouterError < GraphqlRails::Error; end
+
+    attr_reader :name
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(name:)
+      @name = name
+    end
+
+    def call
+      validate
+      File.write(schema_path, schema.to_definition)
+    end
+
+    private
+
+    def validate
+      return if router
+
+      error_message = \
+        'GraphqlRouter is missing. ' \
+        'Run `rails g graphql_rails:install` to build it'
+      raise MissingGraphqlRouterError, error_message
+    end
+
+    def router
+      @router ||= '::GraphqlRouter'.safe_constantize
+    end
+
+    def schema
+      @schema ||= ::GraphqlRouter.graphql_schema(name.presence)
+    end
+
+    def schema_path
+      ENV['GRAPHQL_SCHEMA_DUMP_PATH'] || default_schema_path
+    end
+
+    def default_schema_path
+      schema_folder_path = Rails.root.join('spec', 'fixtures')
+
+      FileUtils.mkdir_p(schema_folder_path)
+      file_name = name.present? ? "graphql_#{name}_schema.graphql" : 'graphql_schema.graphql'
+
+      schema_folder_path.join(file_name)
+    end
+  end
+end

data/lib/graphql_rails/tasks/schema.rake

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'graphql_rails/tasks/dump_graphql_schema'
+
+namespace :graphql_rails do
+  namespace :schema do
+    desc 'Dump GraphQL schema'
+    task(:dump, %i[name] => :environment) do |_, args|
+      default_name = ENV.fetch('SCHEMA_GROUP_NAME', '')
+      args.with_defaults(name: default_name)
+      GraphqlRails::DumpGraphqlSchema.call(name: args.name)
+    end
+  end
+end

data/lib/graphql_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlRails
-  VERSION = '0.6.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Povilas Jurčys
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-04-29 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.4
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +50,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
@@ -108,7 +114,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+description:
 email:
 - po.jurcys@gmail.com
 executables: []
@@ -126,7 +146,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.md
 - Rakefile
 - bin/console
 - bin/setup
@@ -134,38 +153,70 @@ files:
 - docs/README.md
 - docs/_sidebar.md
 - docs/components/controller.md
+- docs/components/decorator.md
 - docs/components/model.md
 - docs/components/routes.md
 - docs/getting_started/quick_start.md
 - docs/getting_started/setup.md
 - docs/index.html
+- docs/logging_and_monitoring/logging_and_monitoring.md
+- docs/other_tools/query_runner.md
+- docs/other_tools/schema_dump.md
 - docs/testing/testing.md
 - graphql_rails.gemspec
+- lib/generators/graphql_rails/install_generator.rb
+- lib/generators/graphql_rails/templates/example_users_controller.erb
+- lib/generators/graphql_rails/templates/graphql_application_controller.erb
+- lib/generators/graphql_rails/templates/graphql_controller.erb
+- lib/generators/graphql_rails/templates/graphql_router.erb
+- lib/generators/graphql_rails/templates/graphql_router_spec.erb
 - lib/graphql_rails.rb
-- lib/graphql_rails/attribute.rb
-- lib/graphql_rails/attribute/attributable.rb
-- lib/graphql_rails/attribute/attribute_name_parser.rb
-- lib/graphql_rails/attribute/type_parser.rb
+- lib/graphql_rails/attributes.rb
+- lib/graphql_rails/attributes/attributable.rb
+- lib/graphql_rails/attributes/attribute.rb
+- lib/graphql_rails/attributes/attribute_name_parser.rb
+- lib/graphql_rails/attributes/input_attribute.rb
+- lib/graphql_rails/attributes/input_type_parser.rb
+- lib/graphql_rails/attributes/type_name_info.rb
+- lib/graphql_rails/attributes/type_parseable.rb
+- lib/graphql_rails/attributes/type_parser.rb
+- lib/graphql_rails/concerns/service.rb
 - lib/graphql_rails/controller.rb
 - lib/graphql_rails/controller/action.rb
 - lib/graphql_rails/controller/action_configuration.rb
 - lib/graphql_rails/controller/action_hook.rb
 - lib/graphql_rails/controller/action_hooks_runner.rb
+- lib/graphql_rails/controller/build_controller_action_resolver.rb
+- lib/graphql_rails/controller/build_controller_action_resolver/controller_action_resolver.rb
 - lib/graphql_rails/controller/configuration.rb
-- lib/graphql_rails/controller/controller_function.rb
-- lib/graphql_rails/controller/format_results.rb
+- lib/graphql_rails/controller/log_controller_action.rb
 - lib/graphql_rails/controller/request.rb
+- lib/graphql_rails/controller/request/format_errors.rb
+- lib/graphql_rails/decorator.rb
+- lib/graphql_rails/decorator/relation_decorator.rb
+- lib/graphql_rails/errors/custom_execution_error.rb
 - lib/graphql_rails/errors/error.rb
 - lib/graphql_rails/errors/execution_error.rb
+- lib/graphql_rails/errors/system_error.rb
 - lib/graphql_rails/errors/validation_error.rb
+- lib/graphql_rails/input_configurable.rb
+- lib/graphql_rails/integrations.rb
+- lib/graphql_rails/integrations/lograge.rb
+- lib/graphql_rails/integrations/sentry.rb
 - lib/graphql_rails/model.rb
+- lib/graphql_rails/model/add_fields_to_graphql_type.rb
+- lib/graphql_rails/model/build_connection_type.rb
+- lib/graphql_rails/model/build_connection_type/count_items.rb
+- lib/graphql_rails/model/build_enum_type.rb
+- lib/graphql_rails/model/build_graphql_input_type.rb
+- lib/graphql_rails/model/call_graphql_model_method.rb
 - lib/graphql_rails/model/configurable.rb
 - lib/graphql_rails/model/configuration.rb
-- lib/graphql_rails/model/configuration/count_items.rb
-- lib/graphql_rails/model/graphql_input_type_builder.rb
-- lib/graphql_rails/model/graphql_type_builder.rb
+- lib/graphql_rails/model/find_or_build_graphql_type.rb
+- lib/graphql_rails/model/find_or_build_graphql_type_class.rb
 - lib/graphql_rails/model/input.rb
-- lib/graphql_rails/model/input_attribute.rb
+- lib/graphql_rails/query_runner.rb
+- lib/graphql_rails/railtie.rb
 - lib/graphql_rails/router.rb
 - lib/graphql_rails/router/mutation_route.rb
 - lib/graphql_rails/router/plain_cursor_encoder.rb
@@ -174,12 +225,14 @@ files:
 - lib/graphql_rails/router/route.rb
 - lib/graphql_rails/router/schema_builder.rb
 - lib/graphql_rails/rspec_controller_helpers.rb
+- lib/graphql_rails/tasks/dump_graphql_schema.rb
+- lib/graphql_rails/tasks/schema.rake
 - lib/graphql_rails/version.rb
 homepage: https://github.com/samesystem/graphql_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -194,9 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: GraphQL server and client for rails
+summary: Rails style structure for GraphQL API.
 test_files: []