graphql_rails 2.2.0 → 2.4.0

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

@@ -6,15 +6,16 @@ module GraphqlRails
   class Router
     # Generic class for any type graphql action. Should not be used directly
     class Route
-      attr_reader :name, :module_name, :on, :relative_path, :groups
+      attr_reader :name, :module_name, :on, :relative_path, :groups, :scope_names
 
-      def initialize(name, to: '', on:, groups: nil, **options)
+      def initialize(name, on:, to: '', groups: nil, scope_names: [], **options) # rubocop:disable Metrics/ParameterLists
         @name = name.to_s.camelize(:lower)
         @module_name = options[:module].to_s
         @function = options[:function]
         @groups = groups
         @relative_path = to
         @on = on.to_sym
+        @scope_names = scope_names
       end
 
       def path
@@ -37,7 +38,7 @@ module GraphqlRails
         if function
           { function: function }
         else
-          { resolver: resolver }
+          { resolver: resolver, extras: [:lookahead] }
         end
       end
 

data/lib/graphql_rails/router/schema_builder.rb

@@ -5,13 +5,14 @@ module GraphqlRails
     # builds GraphQL::Schema based on previously defined grahiti data
     class SchemaBuilder
       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
@@ -19,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
@@ -49,23 +55,9 @@ module GraphqlRails
           .uniq(&:name)
           .reverse
 
-        return if group_routes.empty?
-
-        build_type(type_name, group_routes)
-      end
+        return if group_routes.empty? && type_name != 'Query'
 
-      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
-
-          def self.inspect
-            "#{GraphQL::Schema::Object}(#{graphql_name})"
-          end
-        end
+        BuildSchemaActionType.call(type_name: type_name, routes: group_routes)
       end
     end
   end

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
@@ -21,9 +21,10 @@ module GraphqlRails
       end
     end
 
-    attr_reader :routes, :namespace_name, :raw_graphql_actions
+    attr_reader :routes, :namespace_name, :raw_graphql_actions, :scope_names
 
-    def initialize(module_name: '', group_names: [])
+    def initialize(module_name: '', group_names: [], scope_names: [])
+      @scope_names = scope_names
       @module_name = module_name
       @group_names = group_names
       @routes ||= Set.new
@@ -37,13 +38,16 @@ module GraphqlRails
       routes.merge(scoped_router.routes)
     end
 
-    def scope(**options, &block)
-      full_module_name = [module_name, options[:module]].reject(&:empty?).join('/')
-      scoped_router = router_with(module_name: full_module_name)
+    def scope(new_scope_name = nil, **options, &block)
+      scoped_router = router_with_scope_params(new_scope_name, **options)
       scoped_router.instance_eval(&block)
       routes.merge(scoped_router.routes)
     end
 
+    def namespace(namespace_name, &block)
+      scope(path: namespace_name, module: namespace_name, &block)
+    end
+
     def resources(name, **options, &block)
       builder_options = full_route_options(options)
       routes_builder = ResourceRoutesBuilder.new(name, **builder_options)
@@ -59,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
 
@@ -73,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
@@ -87,15 +91,27 @@ module GraphqlRails
 
     attr_reader :module_name, :group_names
 
+    def router_with_scope_params(new_scope_name, **options)
+      new_scope_name ||= options[:path]
+
+      full_module_name = [module_name, options[:module]].select(&:present?).join('/')
+      full_scope_names = [*scope_names, new_scope_name].select(&:present?)
+
+      router_with(module_name: full_module_name, scope_names: full_scope_names)
+    end
+
     def router_with(new_router_options = {})
-      default_options = { module_name: module_name, group_names: group_names }
-      full_options = default_options.merge(new_router_options)
+      full_options = default_router_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 }
+    def default_router_options
+      { module_name: module_name, group_names: group_names, scope_names: scope_names }
+    end
+
+    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)
@@ -111,7 +127,7 @@ module GraphqlRails
     end
 
     def default_route_options
-      { module: module_name, on: :member }
+      { module: module_name, on: :member, scope_names: scope_names }
     end
   end
 end

data/lib/graphql_rails/rspec_controller_helpers.rb

@@ -95,7 +95,9 @@ module GraphqlRails
     # controller request object more suitable for testing
     class Request < GraphqlRails::Controller::Request
       def initialize(params, context)
-        super(nil, params, context)
+        inputs = params || {}
+        inputs = inputs.merge(lookahead: ::GraphQL::Execution::Lookahead::NullLookahead.new)
+        super(nil, inputs, context)
       end
     end
 

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.2.0'
+  VERSION = '2.4.0'
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: graphql_rails
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Povilas Jurčys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2023-07-25 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.0.21
   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.0.21
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +150,6 @@ files:
 - 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
@@ -210,23 +203,24 @@ 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
 - lib/graphql_rails/query_runner.rb
 - 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 +228,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
@@ -255,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Rails style structure for GraphQL API.

data/docs/getting_started/quick_start.md

@@ -1,62 +0,0 @@
-# Quick Start
-
-## Generate initial code
-
-```bash
-bundle exec rails g graphql_rails:install
-```
-
-## Define GraphQL schema as RoR routes
-
-```ruby
-# 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
-
-  # if you want custom queries or mutation
-  query 'searchLogs', to: 'logs#search' # redirects request to LogsController
-  mutation 'changeUserPassword', to: 'users#change_password'
-end
-```
-
-## Define your Graphql model
-
-```ruby
-class User # works with any class including ActiveRecord
-  include GraphqlRails::Model
-
-  graphql do |c|
-    # most common attributes, like :id, :name, :title has default type, so you don't have to specify it (but you can!)
-    c.attribute :id
-
-    c.attribute :email, :string
-    c.attribute :surname, :string
-  end
-end
-```
-
-## Define controller
-
-```ruby
-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
-
-  def change_user_password
-    user = User.find(params[:id])
-    user.update!(password: params[:password])
-
-    # returned value needs to have all methods defined in model `graphql do` part
-    user # or SomeDecorator.new(user)
-  end
-
-  action(:search).permit(search_fields!: SearchFieldsInput) # you can specify your own input fields
-  def search
-  end
-end
-```
-
-Congrats, you are done!

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