search_object_graphql 0.3.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b313f4a7e0d42b0031ef92926b593961b3f6bd1210819199cf8ed4c3cd0f2f52
-  data.tar.gz: dfeac9c067eff2bd9a8442e27d414761aa4c3947d6aa22c7765219a87afd4d2a
+  metadata.gz: 9f509887b8c20f3fde861d5dc9cb0588a5d69c167a42d7348f3839ef34ed007b
+  data.tar.gz: '08124c03eb5127693e68fd3c191aceab436eab0463bfe82151d82207acb13ef4'
 SHA512:
-  metadata.gz: 2f61fb7c1878d1a648fae5a0a7e629d1509e63755d36705821c5a2e820347fe4ebf7a2e33ce7e87f8d12a20e81701e69b4baafbcab842a7ae3f8625b6d861a8f
-  data.tar.gz: 3adcb65a0767ed0d7458e099a0e594bcb7a08d6bae0592f75fefa0a09060d2a0dbb9bdf54e1ce7f00cb998882375bfe7dc83f5c4dfcb95b64e4c7607fd510dbd
+  metadata.gz: a76bdb08d7b81f1ca59787ae1895fb3bef3befa60c6086204b63fdc01441f0e819e293f14aa8abcac611f6ed9455b3fc556672cb2f980c21b1a699c124297514
+  data.tar.gz: 3dd7bdfea7fec0148d3d39db9eab1c340f1b05779b6137f71468e2fdb1ee9cb90a98339dc400f984a9f548f4ec7e3527a5d1e8cb71396e22bded52544a07047b

data/.rubocop.yml

@@ -49,3 +49,9 @@ RSpec/ExampleLength:
 # Disables "Too many expectations."
 RSpec/MultipleExpectations:
   Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 rvm:
-  - 2.4.1
   - 2.5.2
   - 2.6.0
+  - 2.7.1
+  - 3.0.0
 script:
   - bundle exec rubocop
   - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## Version 1.0.1
+
+* __[feature]__ Added `argument_options` to `options` (@wuz)
+
+## Version 1.0.1
+
+* __[fix]__ `camelize` defaults to false when not specified (@haines)
+
+## Version 1.0.0
+
+* __[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)
+
 ## Version 0.3.1
 
 * __[fix]__ Support for GraphQL gem version v1.9.16 (@ardinusawan)

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 }
@@ -116,12 +116,26 @@ class PostResolver
 end
 ```
 
+### Additional Argument Options
+
+Sometimes you need to pass additional options to the graphql argument method.
+
+```ruby
+class PostResolver < GraphQL::Schema::Resolver
+  include SearchObject.module(:graphql)
+
+  scope { Post.all }
+
+  option(:published, type: types.Boolean, argument_options: { pundit_role: :read }) { |scope, value| value ? scope.published : scope.unpublished }
+end
+```
+
 ### Accessing Parent Object
 
 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 +182,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 +195,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/base_argument.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Types
+  class BaseArgument < GraphQL::Schema::Argument
+    def initialize(*args, permission: true, **kwargs, &block)
+      super(*args, **kwargs, &block)
+
+      raise GraphQL::ExecutionError, 'No permission' unless permission
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Types
+  class BaseField < GraphQL::Schema::Field
+    argument_class Types::BaseArgument
+  end
+end

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

@@ -2,5 +2,6 @@
 
 module Types
   class BaseObject < GraphQL::Schema::Object
+    field_class Types::BaseField
   end
 end

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/version.rb

@@ -3,7 +3,7 @@
 module SearchObject
   module Plugin
     module Graphql
-      VERSION = '0.3.1'
+      VERSION = '1.0.2'
     end
   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,111 +27,32 @@ module SearchObject
       end
 
       module ClassMethods
-        KEYS = %i[type default description required].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?
+          argument_options = options[:argument_options] || {}
 
-          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
+          argument_options[:required] = options[:required] || false
 
-          config[:description] = value
-        end
+          argument_options[:camelize] = options[:camelize] if options.include?(:camelize)
+          argument_options[:default_value] = options[:default] if options.include?(:default)
+          argument_options[:description] = options[:description] if options.include?(:description)
 
-        def deprecation_reason(value = :default)
-          return config[:deprecation_reason] if value == :default
+          argument(name.to_s, type, **argument_options)
 
-          config[:deprecation_reason] = value
-        end
+          options[:enum] = type.values.map { |value, enum_value| enum_value.value || value } if type.respond_to?(:values)
 
-        # 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)|
-              name = name.to_s.split('_').map(&:capitalize).join
-              name[0] = name[0].downcase
-
-              acc[name] = ::GraphQL::Schema::Argument.new(
-                name: name.to_s,
-                type: options.fetch(:type) { raise MissingTypeDefinitionError, name },
-                description: options[:description],
-                required: !!options[:required],
-                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/spec/search_object/plugin/graphql_spec.rb

@@ -17,7 +17,20 @@ end
 
 describe SearchObject::Plugin::Graphql do
   def define_schema(&block)
+    argument_type = Class.new(GraphQL::Schema::Argument) do
+      def initialize(*args, permission: true, **kwargs, &block)
+        super(*args, **kwargs, &block)
+
+        raise 'No permission' unless permission
+      end
+    end
+
+    field_type = Class.new(GraphQL::Schema::Field) do
+      argument_class argument_type
+    end
+
     query_type = Class.new(GraphQL::Schema::Object) do
+      field_class field_type
       graphql_name 'Query'
 
       instance_eval(&block)
@@ -31,7 +44,16 @@ describe SearchObject::Plugin::Graphql do
   end
 
   def define_search_class(&block)
-    Class.new do
+    argument_type = Class.new(GraphQL::Schema::Argument) do
+      def initialize(*args, permission: true, **kwargs, &block)
+        super(*args, **kwargs, &block)
+
+        raise 'No permission' unless permission
+      end
+    end
+
+    Class.new(GraphQL::Schema::Resolver) do
+      argument_class argument_type
       include SearchObject.module(:graphql)
 
       scope { [] }
@@ -52,6 +74,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 +90,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 +108,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 +164,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 +196,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'
@@ -314,6 +239,42 @@ describe SearchObject::Plugin::Graphql do
       )
     end
 
+    it 'sets default_value on the argument' do
+      schema = define_search_class_and_return_schema do
+        type PostType, null: true
+
+        option('option', type: types.String, default: 'default') { [] }
+      end
+
+      result = schema.execute <<~GRAPHQL
+        {
+          __type(name: "Query") {
+            name
+            fields {
+              args {
+                name
+                defaultValue
+              }
+            }
+          }
+        }
+      GRAPHQL
+
+      expect(result).to eq(
+        'data' => {
+          '__type' => {
+            'name' => 'Query',
+            'fields' => [{
+              'args' => [{
+                'name' => 'option',
+                'defaultValue' => '"default"'
+              }]
+            }]
+          }
+        }
+      )
+    end
+
     it 'accepts "required"' do
       schema = define_search_class_and_return_schema do
         option(:id, type: types.String, required: true) do |_scope, value|
@@ -326,9 +287,29 @@ describe SearchObject::Plugin::Graphql do
       expect(result['errors'][0]['message']).to eq("Field 'posts' is missing required arguments: id")
     end
 
+    it 'accepts "argument_options"' do
+      argument_options = {
+        permission: true
+      }
+      schema = define_search_class_and_return_schema do
+        option(:id, type: types.String, argument_options: argument_options) do |_scope, value|
+          [Post.new(value)]
+        end
+      end
+
+      result = schema.execute '{ posts(id: "2") { id } }'
+
+      expect(result).to eq(
+        'data' => {
+          'posts' => [Post.new('2').to_json]
+        }
+      )
+
+    end
+
     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
@@ -362,6 +343,74 @@ describe SearchObject::Plugin::Graphql do
       )
     end
 
+    it 'accepts camelize' do
+      schema = define_search_class_and_return_schema do
+        type PostType, null: true
+
+        option('option_field', type: types.String, camelize: false)
+      end
+
+      result = schema.execute <<-SQL
+        {
+          __type(name: "Query") {
+            name
+            fields {
+              args {
+                name
+              }
+            }
+          }
+        }
+      SQL
+
+      expect(result.to_h).to eq(
+        'data' => {
+          '__type' => {
+            'name' => 'Query',
+            'fields' => [{
+              'args' => [{
+                'name' => 'option_field'
+              }]
+            }]
+          }
+        }
+      )
+    end
+
+    it 'does not override the default camelize option' do
+      schema = define_search_class_and_return_schema do
+        type PostType, null: true
+
+        option('option_field', type: types.String)
+      end
+
+      result = schema.execute <<~GRAPHQL
+        {
+          __type(name: "Query") {
+            name
+            fields {
+              args {
+                name
+              }
+            }
+          }
+        }
+      GRAPHQL
+
+      expect(result.to_h).to eq(
+        'data' => {
+          '__type' => {
+            'name' => 'Query',
+            'fields' => [{
+              'args' => [{
+                'name' => 'optionField'
+              }]
+            }]
+          }
+        }
+      )
+    end
+
     it 'raises error when no type is given' do
       expect { define_search_class { option :name } }.to raise_error described_class::MissingTypeDefinitionError
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_object_graphql
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Radoslav Stankov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -134,12 +134,15 @@ 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
 - example/app/graphql/schema.rb
 - example/app/graphql/types/.keep
+- example/app/graphql/types/base_argument.rb
 - example/app/graphql/types/base_enum.rb
+- example/app/graphql/types/base_field.rb
 - example/app/graphql/types/base_input_object.rb
 - example/app/graphql/types/base_interface.rb
 - example/app/graphql/types/base_object.rb
@@ -189,7 +192,7 @@ homepage: https://github.com/RStankov/SearchObjectGraphQL
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -205,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Maps search objects to GraphQL resolvers
 test_files: