graphql_rails 2.1.0 → 2.3.0

data/lib/graphql_rails/router/schema_builder.rb

@@ -5,12 +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, :raw_actions
+      attr_reader :queries, :mutations, :subscriptions, :raw_actions
 
-      def initialize(queries:, mutations:, raw_actions:, group: nil)
+      def initialize(queries:, mutations:, subscriptions:, raw_actions:, group: nil)
         @queries = queries
         @mutations = mutations
+        @subscriptions = subscriptions
         @raw_actions = raw_actions
         @group = group
       end
@@ -18,6 +20,7 @@ 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
 
         Class.new(GraphQL::Schema) do
@@ -30,6 +33,7 @@ module GraphqlRails
 
           query(query_type) if query_type
           mutation(mutation_type) if mutation_type
+          subscription(subscription_type) if subscription_type
         end
       end
 
@@ -39,24 +43,16 @@ module GraphqlRails
 
       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?
+        group_routes =
+          routes
+          .select { |route| route.show_in_group?(group_name) }
+          .reverse
+          .uniq(&:name)
+          .reverse
 
-        build_type(type_name, group_routes)
-      end
-
-      def build_type(type_name, group_routes)
-        Class.new(GraphQL::Schema::Object) do
-          graphql_name(type_name)
+        return if group_routes.empty? && type_name != 'Query'
 
-          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/subscription_route.rb

@@ -0,0 +1,22 @@
+# 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

data/lib/graphql_rails/router.rb

@@ -5,6 +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/resource_routes_builder'
 
 module GraphqlRails
@@ -20,13 +21,15 @@ 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
       @raw_graphql_actions ||= []
+      @graphql_schema = {}
     end
 
     def group(*group_names, &block)
@@ -35,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)
@@ -57,6 +63,10 @@ module GraphqlRails
       routes << build_route(MutationRoute, name, **options)
     end
 
+    def subscription(name, **options)
+      routes << build_route(SubscriptionRoute, name, **options)
+    end
+
     RAW_ACTION_NAMES.each do |action_name|
       define_method(action_name) do |*args, &block|
         add_raw_action(action_name, *args, &block)
@@ -64,30 +74,42 @@ module GraphqlRails
     end
 
     def graphql_schema(group = nil)
-      @graphql_schema ||= {}
       @graphql_schema[group&.to_sym] ||= SchemaBuilder.new(
         queries: routes.select(&:query?),
         mutations: routes.select(&:mutation?),
+        subscriptions: routes.select(&:subscription?),
         raw_actions: raw_graphql_actions,
         group: group
       ).call
     end
 
     def reload_schema
-      @graphql_schema = nil
+      @graphql_schema.clear
     end
 
     private
 
     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 default_router_options
+      { 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 }
     end
@@ -105,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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_rails
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Povilas Jurčys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -156,7 +156,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
@@ -220,12 +219,14 @@ files:
 - 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/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
@@ -254,7 +255,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!