search_object_graphql 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ab34781a81c8808d0b9702dcf9742955e9859c5827461e00e1b1a431f1df216
-  data.tar.gz: b5ed30f8e4b39c36d4fb1e9d28b1f2118a7bfd1507a045fac76286a61e8345ac
+  metadata.gz: 49fd6817f69aa33a15ce7cc2e768bd239020c3f7f6b6e385e1f12d3c9d5c30ff
+  data.tar.gz: c6c4a8d82f1d5afa85519a1e8aee726b321495b2305e63fa0d5e986db75066fb
 SHA512:
-  metadata.gz: 93701d2abfb6a521f6aa199aaaf4a0fee641367a20de4b2806cbaeac45539909289529183590ca924c7329aeb7ce9cf53d3c5b581205208338c0ef8200e97874
-  data.tar.gz: 209b6af6cea55e752c7c76cbdb9769e8af18bed61c124982e58e502f7e10d8136f3a29653875c7b25d876676db0bdb3cb9faa0605132dfca3356a614288255ee
+  metadata.gz: a71588bac7cc2fba645d1e4007bfeed111749c0016d4a2de7e832990ff33f37e1656c08a47fd3a52f18664e594bbefee3939d1412aa3fc5d679dd9c3d875d533
+  data.tar.gz: 4c9bfd49332eafbd37b10be48bc58c65bfffa0546dc7c394a7b77e3e146769ee77083f39bbd40f101302ad7ffb967d8b7e0054b6512c35febdcedc0e00c94855

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Version 1.0.0 (unreleased)
+
+* __[break]__ Removed support for defining types via `type` method (@rstankov)
+* __[break]__ Require `GraphQL::Schema::Resolver` inheritance (@rstankov)
+* __[break]__ Removed support for legacy `GraphQL::Function` (@rstankov)
+* __[break]__ `type` creates type based on `GraphQL::Schema::Object`, not the deprecated `GraphQL::ObjectType.define` (@rstankov)
+
 ## Version 0.3.2
 
 * __[feature]__ Added `camelize` argument to `option`, *`true` by default* (@glenbray)

data/README.md

@@ -57,7 +57,7 @@ require 'search_object/plugin/graphql'
 Just include the ```SearchObject.module``` and define your search options and their types:
 
 ```ruby
-class PostResolver
+class PostResolver < GraphQL::Schema::Resolver
   include SearchObject.module(:graphql)
 
   type [PostType], null: false
@@ -94,7 +94,7 @@ You can find example of most important features and plugins - [here](https://git
 Search object itself can be documented, as well as its options:
 
 ```ruby
-class PostResolver
+class PostResolver < GraphQL::Schema::Resolver
   include SearchObject.module(:graphql)
 
   description 'Lists all posts'
@@ -107,7 +107,7 @@ end
 ### Default Values
 
 ```ruby
-class PostResolver
+class PostResolver < GraphQL::Schema::Resolver
   include SearchObject.module(:graphql)
 
   scope { Post.all }
@@ -121,7 +121,7 @@ end
 Sometimes you want to scope posts based on parent object, it is accessible as `object` property:
 
 ```ruby
-class PostResolver
+class PostResolver < GraphQL::Schema::Resolver
   include SearchObject.module(:graphql)
 
   # lists only posts from certain category
@@ -168,7 +168,7 @@ end
 Search objects can be used as [Relay Connections](https://graphql-ruby.org/relay/connections.html):
 
 ```ruby
-class PostResolver
+class PostResolver < GraphQL::Schema::Resolver
   include SearchObject.module(:graphql)
 
   type PostType.connection_type, null: false
@@ -181,22 +181,6 @@ end
 field :posts, resolver: PostResolver
 ```
 
-### Legacy Function Support
-
-```ruby
-class PostResolver
-  include SearchObject.module(:graphql)
-
-  type [PostType], null: false
-
-  # ...
-end
-```
-
-```ruby
-field :posts, function: PostResolver
-```
-
 ## Contributing
 
 1. Fork it

data/example/app/graphql/resolvers/base_resolver.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Resolvers
+  class BaseResolver < GraphQL::Schema::Resolver
+  end
+end

data/example/app/graphql/resolvers/base_search_resolver.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Resolvers
-  class BaseSearchResolver
+  class BaseSearchResolver < BaseResolver
     include SearchObject.module(:graphql)
 
     def escape_search_term(term)

data/example/app/graphql/resolvers/category_search.rb

@@ -2,7 +2,7 @@
 
 module Resolvers
   class CategorySearch < Resolvers::BaseSearchResolver
-    type Types::CategoryType.connection_type
+    type Types::CategoryType.connection_type, null: false
     description 'Lists categories'
 
     class OrderEnum < Types::BaseEnum

data/example/app/graphql/resolvers/post_search.rb

@@ -2,7 +2,7 @@
 
 module Resolvers
   class PostSearch < Resolvers::BaseSearchResolver
-    type Types::PostType.connection_type
+    type Types::PostType.connection_type, null: false
     description 'Lists posts'
 
     class OrderEnum < Types::BaseEnum

data/example/app/graphql/types/category_type.rb

@@ -4,6 +4,6 @@ module Types
   class CategoryType < BaseObject
     field :id, ID, null: false
     field :name, String, null: false
-    field :posts, function: Resolvers::PostSearch
+    field :posts, resolver: Resolvers::PostSearch
   end
 end

data/example/app/graphql/types/query_type.rb

@@ -2,7 +2,7 @@
 
 module Types
   class QueryType < Types::BaseObject
-    field :categories, function: Resolvers::CategorySearch
+    field :categories, resolver: Resolvers::CategorySearch
     field :posts, resolver: Resolvers::PostSearch
   end
 end

data/lib/search_object/plugin/graphql.rb

@@ -4,8 +4,9 @@ module SearchObject
   module Plugin
     module Graphql
       def self.included(base)
+        raise NotIncludedInResolverError, base unless base.ancestors.include? GraphQL::Schema::Resolver
+
         base.include SearchObject::Plugin::Enum
-        base.include ::GraphQL::Schema::Member::GraphQLTypeNames
         base.extend ClassMethods
       end
 
@@ -26,114 +27,29 @@ module SearchObject
       end
 
       module ClassMethods
-        KEYS = %i[type default description required camelize].freeze
         def option(name, options = {}, &block)
-          config[:arguments] ||= {}
-          config[:arguments][name.to_s] = KEYS.inject({}) do |acc, key|
-            acc[key] = options[key] if options.key?(key)
-            acc
-          end
-
           type = options.fetch(:type) { raise MissingTypeDefinitionError, name }
           options[:enum] = type.values.map { |value, enum_value| enum_value.value || value } if type.respond_to?(:values)
 
-          super(name, options, &block)
-        end
-
-        def type(value = :default, null: true, &block)
-          return config[:type] if value == :default && !block_given?
-
-          config[:type] = block_given? ? GraphQL::ObjectType.define(&block) : value
-          config[:null] = null
-        end
-
-        def complexity(value = :default)
-          return config[:complexity] || 1 if value == :default
-
-          config[:complexity] = value
-        end
-
-        def description(value = :default)
-          return config[:description] if value == :default
-
-          config[:description] = value
-        end
-
-        def deprecation_reason(value = :default)
-          return config[:deprecation_reason] if value == :default
+          argument(
+            name.to_s,
+            options[:type],
+            required: options[:required] || false,
+            description: options[:description],
+            camelize: options[:camelize]
+          )
 
-          config[:deprecation_reason] = value
-        end
-
-        # NOTE(rstankov): GraphQL::Function interface (deprecated in favour of GraphQL::Schema::Resolver)
-        # Documentation - http://graphql-ruby.org/guides
-        def call(object, args, context)
-          new(filters: args.to_h, object: object, context: context).results
+          super(name, options, &block)
         end
 
-        # NOTE(rstankov): Used for GraphQL::Function
         def types
           GraphQL::Define::TypeDefiner.instance
         end
+      end
 
-        # NOTE(rstankov): Used for GraphQL::Function
-        def arguments
-          (config[:arguments] || {}).inject({}) do |acc, (name, options)|
-            argument = GraphQL::Argument.new
-            argument.name = name.to_s
-            argument.type = options.fetch(:type) { raise MissingTypeDefinitionError, name }
-            argument.default_value = options[:default] if options.key? :default
-            argument.description = options[:description] if options.key? :description
-
-            acc[name] = argument
-            acc
-          end
-        end
-
-        # NOTE(rstankov): Used for GraphQL::Schema::Resolver
-        def field_options
-          {
-            type: type,
-            description: description,
-            extras: [],
-            resolver_method: :resolve_with_support,
-            resolver_class: self,
-            deprecation_reason: deprecation_reason,
-            arguments: (config[:arguments] || {}).inject({}) do |acc, (name, options)|
-              if options.fetch(:camelize) { true }
-                name = name.to_s.split('_').map(&:capitalize).join
-                name[0] = name[0].downcase
-              end
-
-              acc[name] = ::GraphQL::Schema::Argument.new(
-                name: name.to_s,
-                type: options.fetch(:type) { raise MissingTypeDefinitionError, name },
-                description: options[:description],
-                required: !!options[:required],
-                camelize: !!options[:camelize],
-                default_value: options.fetch(:default) { ::GraphQL::Schema::Argument::NO_DEFAULT },
-                owner: self
-              )
-              acc
-            end,
-            null: !!config[:null],
-            complexity: complexity
-          }
-        end
-
-        # NOTE(rstankov): Used for GraphQL::Schema::Resolver
-        def visible?(_context)
-          true
-        end
-
-        # NOTE(rstankov): Used for GraphQL::Schema::Resolver
-        def accessible?(_context)
-          true
-        end
-
-        # NOTE(rstankov): Used for GraphQL::Schema::Resolver
-        def authorized?(_object, _context)
-          true
+      class NotIncludedInResolverError < ArgumentError
+        def initialize(base)
+          super "#{base.name} should inherit from GraphQL::Schema::Resolver. Current ancestors #{base.ancestors}"
         end
       end
 

data/lib/search_object/plugin/graphql/version.rb

@@ -3,7 +3,7 @@
 module SearchObject
   module Plugin
     module Graphql
-      VERSION = '0.3.2'
+      VERSION = '1.0.0'
     end
   end
 end

data/spec/search_object/plugin/graphql_spec.rb

@@ -31,7 +31,7 @@ describe SearchObject::Plugin::Graphql do
   end
 
   def define_search_class(&block)
-    Class.new do
+    Class.new(GraphQL::Schema::Resolver) do
       include SearchObject.module(:graphql)
 
       scope { [] }
@@ -52,6 +52,12 @@ describe SearchObject::Plugin::Graphql do
     end
   end
 
+  it 'requires class to inherit from GraphQL::Schema::Resolver' do
+    expect do
+      Class.new { include SearchObject.module(:graphql) }
+    end.to raise_error SearchObject::Plugin::Graphql::NotIncludedInResolverError
+  end
+
   it 'can be used as GraphQL::Schema::Resolver' do
     post_type = Class.new(GraphQL::Schema::Object) do
       graphql_name 'Post'
@@ -62,7 +68,7 @@ describe SearchObject::Plugin::Graphql do
     search_object = define_search_class do
       scope { [Post.new('1'), Post.new('2'), Post.new('3')] }
 
-      type [post_type]
+      type [post_type], null: 1
 
       option(:id, type: !types.ID) { |scope, value| scope.select { |p| p.id == value } }
     end
@@ -80,34 +86,6 @@ describe SearchObject::Plugin::Graphql do
     )
   end
 
-  it 'can be used as GraphQL::Function' do
-    post_type = GraphQL::ObjectType.define do
-      name 'Post'
-
-      field :id, !types.ID
-    end
-
-    search_object = define_search_class do
-      scope { [Post.new('1'), Post.new('2'), Post.new('3')] }
-
-      type types[post_type]
-
-      option(:id, type: !types.ID) { |scope, value| scope.select { |p| p.id == value } }
-    end
-
-    schema = define_schema do
-      field :posts, function: search_object
-    end
-
-    result = schema.execute '{ posts(id: "2") { id } }'
-
-    expect(result).to eq(
-      'data' => {
-        'posts' => [Post.new('2').to_json]
-      }
-    )
-  end
-
   it 'can access to parent object' do
     search_object = define_search_class do
       scope { object.posts }
@@ -164,81 +142,6 @@ describe SearchObject::Plugin::Graphql do
     )
   end
 
-  it 'can define a custom type' do
-    schema = define_search_class_and_return_schema do
-      type do
-        name 'Test'
-
-        field :title, types.String
-      end
-
-      description 'Test description'
-    end
-
-    result = schema.execute <<-SQL
-      {
-        __type(name: "Query") {
-          name
-          fields {
-            name
-            deprecationReason
-            type {
-              name
-              fields {
-                name
-              }
-            }
-          }
-        }
-      }
-    SQL
-
-    expect(result).to eq(
-      'data' => {
-        '__type' => {
-          'name' => 'Query',
-          'fields' => [{
-            'name' => 'posts',
-            'deprecationReason' => nil,
-            'type' => {
-              'name' => 'Test',
-              'fields' => [{
-                'name' => 'title'
-              }]
-            }
-          }]
-        }
-      }
-    )
-  end
-
-  it 'can be marked as deprecated' do
-    schema = define_search_class_and_return_schema do
-      type [PostType]
-      deprecation_reason 'Not needed any more'
-    end
-
-    result = schema.execute <<-QUERY
-      {
-        __type(name: "Query") {
-          name
-          fields {
-            name
-          }
-        }
-      }
-    QUERY
-
-    expect(result.to_h).to eq(
-      'data' => {
-        '__type' => {
-          'name' => 'Query',
-          'fields' => []
-        }
-      }
-    )
-  end
-
   describe 'option' do
     it 'converts GraphQL::Schema::Enum to SearchObject enum' do
       schema = define_search_class_and_return_schema do
@@ -271,8 +174,8 @@ describe SearchObject::Plugin::Graphql do
 
     it 'converts GraphQL::EnumType to SearchObject enum' do
       schema = define_search_class_and_return_schema do
-        enum_type = GraphQL::EnumType.define do
-          name 'TestEnum'
+        enum_type = Class.new(GraphQL::Schema::Enum) do
+          graphql_name 'TestEnum'
 
           value 'PRICE'
           value 'DATE'
@@ -328,7 +231,7 @@ describe SearchObject::Plugin::Graphql do
 
     it 'accepts description' do
       schema = define_search_class_and_return_schema do
-        type PostType
+        type PostType, null: true
 
         option('option', type: types.String, description: 'what this argument does') { [] }
       end
@@ -364,7 +267,7 @@ describe SearchObject::Plugin::Graphql do
 
     it 'accepts camelize' do
       schema = define_search_class_and_return_schema do
-        type PostType
+        type PostType, null: true
 
         option('option_field', type: types.String, camelize: false)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_object_graphql
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -134,6 +134,7 @@ files:
 - example/app/controllers/application_controller.rb
 - example/app/controllers/graphql_controller.rb
 - example/app/graphql/mutations/.keep
+- example/app/graphql/resolvers/base_resolver.rb
 - example/app/graphql/resolvers/base_search_resolver.rb
 - example/app/graphql/resolvers/category_search.rb
 - example/app/graphql/resolvers/post_search.rb