graphql_rails 2.3.0 → 3.0.0

data/lib/graphql_rails/model/find_or_build_graphql_type_class.rb

@@ -9,11 +9,13 @@ module GraphqlRails
 
       include ::GraphqlRails::Service
 
-      def initialize(name:, type_name:, description: nil)
+      def initialize(name:, type_name:, parent_class:, description: nil, implements: [])
         @name = name
         @type_name = type_name
         @description = description
         @new_class = false
+        @parent_class = parent_class
+        @implements = implements
       end
 
       def klass
@@ -27,15 +29,17 @@ module GraphqlRails
       private
 
       attr_accessor :new_class
-      attr_reader :name, :type_name, :description
+      attr_reader :name, :type_name, :description, :parent_class, :implements
 
       def build_graphql_type_klass
         graphql_type_name = name
         graphql_type_description = description
+        interfaces = implements
 
-        graphql_type_klass = Class.new(GraphqlRails::Types::ObjectType) do
+        graphql_type_klass = Class.new(parent_class) do
           graphql_name(graphql_type_name)
           description(graphql_type_description)
+          interfaces.each { |interface| implements(interface) }
         end
 
         self.new_class = true

data/lib/graphql_rails/model/input.rb

@@ -6,7 +6,7 @@ module GraphqlRails
     class Input
       require 'graphql_rails/concerns/chainable_options'
       require 'graphql_rails/model/configurable'
-      require 'graphql_rails/model/build_graphql_input_type'
+      require 'graphql_rails/model/find_or_build_graphql_input_type'
 
       include Configurable
 
@@ -18,8 +18,8 @@ module GraphqlRails
       end
 
       def graphql_input_type
-        @graphql_input_type ||= BuildGraphqlInputType.call(
-          name: name, description: description, attributes: attributes
+        @graphql_input_type ||= FindOrBuildGraphqlInputType.call(
+          name: name, description: description, attributes: attributes, type_name: type_name
         )
       end
 

data/lib/graphql_rails/router/event_route.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'route'
+
+module GraphqlRails
+  class Router
+    # stores subscription type graphql action info
+    class EventRoute
+      attr_reader :name, :module_name, :subscription_class, :groups, :scope_names
+
+      def initialize(name, subscription_class: nil, groups: nil, scope_names: [], **options)
+        @name = name.to_s.camelize(:lower)
+        @module_name = options[:module].to_s
+        @groups = groups
+        @subscription_class = subscription_class
+        @scope_names = scope_names
+      end
+
+      def show_in_group?(group_name)
+        return true if groups.nil? || groups.empty?
+
+        groups.include?(group_name&.to_sym)
+      end
+
+      def field_options
+        { subscription: subscription }
+      end
+
+      def subscription
+        if subscription_class.present?
+          subscription_class.is_a?(String) ? Object.const_get(subscription_class) : subscription_class
+        else
+          klass_name = ['subscriptions/', name.underscore, 'subscription'].join('_').camelize
+
+          Object.const_get(klass_name)
+        end
+      end
+
+      def mutation?
+        false
+      end
+
+      def query?
+        false
+      end
+
+      def event?
+        true
+      end
+    end
+  end
+end

data/lib/graphql_rails/router/mutation_route.rb

@@ -14,7 +14,7 @@ module GraphqlRails
         true
       end
 
-      def subscription?
+      def event?
         false
       end
     end

data/lib/graphql_rails/router/query_route.rb

@@ -14,7 +14,7 @@ module GraphqlRails
         false
       end
 
-      def subscription?
+      def event?
         false
       end
     end

data/lib/graphql_rails/router/resource_routes_builder.rb

@@ -28,10 +28,6 @@ module GraphqlRails
         routes << build_mutation(*args, **kwargs)
       end
 
-      def subscription(*args, **kwargs)
-        routes << build_subscription(*args, **kwargs)
-      end
-
       private
 
       attr_reader :autogenerated_action_names, :name, :options
@@ -66,10 +62,6 @@ module GraphqlRails
         build_route(QueryRoute, *args, **kwargs)
       end
 
-      def build_subscription(*args, **kwargs)
-        build_route(SubscriptionRoute, *args, **kwargs)
-      end
-
       # rubocop:disable Metrics/ParameterLists
       def build_route(builder, action, prefix: action, suffix: false, on: :member, **custom_options)
         if suffix == true

data/lib/graphql_rails/router/route.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../controller/build_controller_action_resolver'
+require 'graphql_rails/controller/action'
 
 module GraphqlRails
   class Router
@@ -38,7 +39,7 @@ module GraphqlRails
         if function
           { function: function }
         else
-          { resolver: resolver }
+          { resolver: resolver, extras: [:lookahead], **resolver_options }
         end
       end
 
@@ -47,7 +48,16 @@ module GraphqlRails
       attr_reader :function
 
       def resolver
-        @resolver ||= Controller::BuildControllerActionResolver.call(route: self)
+        @resolver ||= Controller::BuildControllerActionResolver.call(action: action)
+      end
+
+      def action
+        @action ||= Controller::Action.new(self).tap(&:return_type)
+      end
+
+      def resolver_options
+        action_config = action.action_config
+        action_config.pagination_options || {}
       end
     end
   end

data/lib/graphql_rails/router/schema_builder.rb

@@ -7,12 +7,12 @@ module GraphqlRails
       require_relative './plain_cursor_encoder'
       require_relative './build_schema_action_type'
 
-      attr_reader :queries, :mutations, :subscriptions, :raw_actions
+      attr_reader :queries, :mutations, :events, :raw_actions
 
-      def initialize(queries:, mutations:, subscriptions:, raw_actions:, group: nil)
+      def initialize(queries:, mutations:, events:, raw_actions:, group: nil)
         @queries = queries
         @mutations = mutations
-        @subscriptions = subscriptions
+        @events = events
         @raw_actions = raw_actions
         @group = group
       end
@@ -20,26 +20,31 @@ module GraphqlRails
       def call
         query_type = build_group_type('Query', queries)
         mutation_type = build_group_type('Mutation', mutations)
-        subscription_type = build_group_type('Subscription', subscriptions)
-        raw = raw_actions
+        subscription_type = build_group_type('Subscription', events)
 
+        define_schema_class(query_type, mutation_type, subscription_type, raw_actions)
+      end
+
+      private
+
+      attr_reader :group
+
+      # rubocop:disable Metrics/MethodLength
+      def define_schema_class(query_type, mutation_type, subscription_type, raw)
         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]) }
+          raw.each { |action| send(action[:name], *action[:args], **action[:kwargs], &action[:block]) }
 
           query(query_type) if query_type
           mutation(mutation_type) if mutation_type
           subscription(subscription_type) if subscription_type
         end
       end
-
-      private
-
-      attr_reader :group
+      # rubocop:enable Metrics/MethodLength
 
       def build_group_type(type_name, routes)
         group_name = group

data/lib/graphql_rails/router.rb

@@ -5,7 +5,7 @@ require 'active_support/core_ext/string/inflections'
 require 'graphql_rails/router/schema_builder'
 require 'graphql_rails/router/mutation_route'
 require 'graphql_rails/router/query_route'
-require 'graphql_rails/router/subscription_route'
+require 'graphql_rails/router/event_route'
 require 'graphql_rails/router/resource_routes_builder'
 
 module GraphqlRails
@@ -63,13 +63,13 @@ module GraphqlRails
       routes << build_route(MutationRoute, name, **options)
     end
 
-    def subscription(name, **options)
-      routes << build_route(SubscriptionRoute, name, **options)
+    def event(name, **options)
+      routes << build_route(EventRoute, name, **options)
     end
 
     RAW_ACTION_NAMES.each do |action_name|
-      define_method(action_name) do |*args, &block|
-        add_raw_action(action_name, *args, &block)
+      define_method(action_name) do |*args, **kwargs, &block|
+        add_raw_action(action_name, *args, **kwargs, &block)
       end
     end
 
@@ -77,7 +77,7 @@ module GraphqlRails
       @graphql_schema[group&.to_sym] ||= SchemaBuilder.new(
         queries: routes.select(&:query?),
         mutations: routes.select(&:mutation?),
-        subscriptions: routes.select(&:subscription?),
+        events: routes.select(&:event?),
         raw_actions: raw_graphql_actions,
         group: group
       ).call
@@ -110,8 +110,8 @@ module GraphqlRails
       { module_name: module_name, group_names: group_names, scope_names: scope_names }
     end
 
-    def add_raw_action(name, *args, &block)
-      raw_graphql_actions << { name: name, args: args, block: block }
+    def add_raw_action(name, *args, **kwargs, &block)
+      raw_graphql_actions << { name: name, args: args, kwargs: kwargs, block: block }
     end
 
     def build_route(route_builder, name, **options)

data/lib/graphql_rails/rspec_controller_helpers.rb

@@ -46,6 +46,14 @@ module GraphqlRails
         !success?
       end
 
+      def controller
+        request.controller
+      end
+
+      def action_name
+        request.action_name
+      end
+
       private
 
       attr_reader :request
@@ -94,15 +102,21 @@ module GraphqlRails
 
     # controller request object more suitable for testing
     class Request < GraphqlRails::Controller::Request
-      def initialize(params, context)
-        super(nil, params, context)
+      attr_reader :controller, :action_name
+
+      def initialize(params, context, controller: nil, action_name: nil)
+        inputs = params || {}
+        inputs = inputs.merge(lookahead: ::GraphQL::Execution::Lookahead::NullLookahead.new)
+        @controller = controller
+        @action_name = action_name
+        super(nil, inputs, context)
       end
     end
 
     def query(query_name, params: {}, context: {})
       schema_builder = SingleControllerSchemaBuilder.new(described_class)
       context_object = FakeContext.new(values: context, schema: schema_builder.call)
-      request = Request.new(params, context_object)
+      request = Request.new(params, context_object, controller: described_class, action_name: query_name)
       described_class.new(request).call(query_name)
 
       @response = Response.new(request)

data/lib/graphql_rails/types/hidable_by_group.rb

@@ -6,10 +6,11 @@ module GraphqlRails
   module Types
     # Add visibility option based on groups
     module HidableByGroup
-      def initialize(*args, groups: [], **kwargs, &block)
+      def initialize(*args, groups: [], hidden_in_groups: [], **kwargs, &block)
         super(*args, **kwargs, &block)
 
-        @groups = groups.map(&:to_s)
+        @hidden_in_groups = hidden_in_groups.map(&:to_s)
+        @groups = groups.map(&:to_s) - @hidden_in_groups
       end
 
       def visible?(context)
@@ -22,10 +23,29 @@ module GraphqlRails
         @groups
       end
 
+      def hidden_in_groups
+        @hidden_in_groups
+      end
+
       def visible_in_context_group?(context)
+        group = context_graphql_group(context)
+
+        return true if no_visibility_configuration?(group)
+        return groups.include?(group) unless groups.empty?
+
+        !hidden_in_groups.include?(group)
+      end
+
+      def no_visibility_configuration?(group)
+        return true if group.nil?
+
+        groups.empty? && hidden_in_groups.empty?
+      end
+
+      def context_graphql_group(context)
         group = context[:graphql_group] || context['graphql_group']
 
-        group.nil? || groups.empty? || groups.include?(group.to_s)
+        group.nil? ? nil : group.to_s
       end
     end
   end

data/lib/graphql_rails/types/input_object_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'graphql_rails/types/argument_type'
+
+module GraphqlRails
+  module Types
+    # Base graphql type class for all GraphqlRails models
+    class InputObjectType < GraphQL::Schema::InputObject
+      argument_class(GraphqlRails::Types::ArgumentType)
+
+      def self.inspect
+        "#{GraphQL::Schema::InputObject}(#{graphql_name})"
+      end
+    end
+  end
+end

data/lib/graphql_rails/version.rb

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

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: graphql_rails
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Povilas Jurčys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-25 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.4
+        version: 2.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.4
+        version: 2.1.7
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +184,7 @@ files:
 - 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/handle_controller_error.rb
 - lib/graphql_rails/controller/log_controller_action.rb
 - lib/graphql_rails/controller/request.rb
 - lib/graphql_rails/controller/request/format_errors.rb
@@ -209,10 +204,10 @@ files:
 - 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/find_or_build_graphql_input_type.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
@@ -220,13 +215,13 @@ files:
 - lib/graphql_rails/railtie.rb
 - lib/graphql_rails/router.rb
 - lib/graphql_rails/router/build_schema_action_type.rb
+- lib/graphql_rails/router/event_route.rb
 - lib/graphql_rails/router/mutation_route.rb
 - lib/graphql_rails/router/plain_cursor_encoder.rb
 - lib/graphql_rails/router/query_route.rb
 - lib/graphql_rails/router/resource_routes_builder.rb
 - lib/graphql_rails/router/route.rb
 - lib/graphql_rails/router/schema_builder.rb
-- lib/graphql_rails/router/subscription_route.rb
 - lib/graphql_rails/rspec_controller_helpers.rb
 - lib/graphql_rails/tasks/dump_graphql_schema.rb
 - lib/graphql_rails/tasks/dump_graphql_schemas.rb
@@ -234,6 +229,7 @@ files:
 - lib/graphql_rails/types/argument_type.rb
 - lib/graphql_rails/types/field_type.rb
 - lib/graphql_rails/types/hidable_by_group.rb
+- lib/graphql_rails/types/input_object_type.rb
 - lib/graphql_rails/types/object_type.rb
 - lib/graphql_rails/version.rb
 homepage: https://github.com/samesystem/graphql_rails

data/lib/graphql_rails/model/build_graphql_input_type.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'graphql_rails/types/argument_type'
-require 'graphql_rails/concerns/service'
-
-module GraphqlRails
-  module Model
-    # stores information about model specific config, like attributes and types
-    class BuildGraphqlInputType
-      include ::GraphqlRails::Service
-
-      def initialize(name:, description: nil, attributes:)
-        @name = name
-        @attributes = attributes
-        @description = description
-      end
-
-      def call
-        type_name = name
-        type_description = description
-        type_attributes = attributes
-
-        Class.new(GraphQL::Schema::InputObject) do
-          argument_class(GraphqlRails::Types::ArgumentType)
-          graphql_name(type_name)
-          description(type_description)
-
-          type_attributes.each_value do |type_attribute|
-            argument(*type_attribute.input_argument_args, **type_attribute.input_argument_options)
-          end
-
-          def self.inspect
-            "#{GraphQL::Schema::InputObject}(#{graphql_name})"
-          end
-        end
-      end
-
-      private
-
-      attr_reader :model_configuration, :attributes, :name, :description
-    end
-  end
-end

data/lib/graphql_rails/router/subscription_route.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'route'
-
-module GraphqlRails
-  class Router
-    # stores subscription type graphql action info
-    class SubscriptionRoute < Route
-      def query?
-        false
-      end
-
-      def mutation?
-        false
-      end
-
-      def subscription?
-        true
-      end
-    end
-  end
-end