search_object_graphql 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49fd6817f69aa33a15ce7cc2e768bd239020c3f7f6b6e385e1f12d3c9d5c30ff
-  data.tar.gz: c6c4a8d82f1d5afa85519a1e8aee726b321495b2305e63fa0d5e986db75066fb
+  metadata.gz: 4743546d8933b7412977b5b2736eca71fd8950ef016ca5e4f766a73e7f75d0dd
+  data.tar.gz: a9772b5cb3cfda0e8cbc334a68d24d919b964e81af00be8696a91b3bc0d60947
 SHA512:
-  metadata.gz: a71588bac7cc2fba645d1e4007bfeed111749c0016d4a2de7e832990ff33f37e1656c08a47fd3a52f18664e594bbefee3939d1412aa3fc5d679dd9c3d875d533
-  data.tar.gz: 4c9bfd49332eafbd37b10be48bc58c65bfffa0546dc7c394a7b77e3e146769ee77083f39bbd40f101302ad7ffb967d8b7e0054b6512c35febdcedc0e00c94855
+  metadata.gz: 5c1400ac1875e40b26a1ef4c8e5180e2324cc5e671b715e61172f5dd51cce443fce19dfaa92d5783791a3d8cc06de9c6d1a238b2f9e9c3158aab35cee21c58d6
+  data.tar.gz: ff5bd7c05cc45cd815a8682423dee031ea720d7c3da766a8aa19e9df1d52d9013592ed4bf58255c218ab9dc0e8c1c0c2a6fd95c91e7961f04f346fe0f3a2bf1f

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,6 +1,18 @@
 # Changelog
 
-## Version 1.0.0 (unreleased)
+## Version 1.0.2
+
+* __[fix]__ Support GraphQL 2.0 gem (@rstankov)
+
+## 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)

data/README.md

@@ -99,8 +99,8 @@ class PostResolver < GraphQL::Schema::Resolver
 
   description 'Lists all posts'
 
-  option(:name, type: types.String, description: 'Fuzzy name matching') { ... }
-  option(:published, type: types.Boolean, description: 'Find published/unpublished') { ... }
+  option(:name, type: String, description: 'Fuzzy name matching') { ... }
+  option(:published, type: Boolean, description: 'Find published/unpublished') { ... }
 end
 ```
 
@@ -112,7 +112,21 @@ class PostResolver < GraphQL::Schema::Resolver
 
   scope { Post.all }
 
-  option(:published, type: types.Boolean, default: true) { |scope, value| value ? scope.published : scope.unpublished }
+  option(:published, type: Boolean, default: true) { |scope, value| value ? scope.published : scope.unpublished }
+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: Boolean, argument_options: { pundit_role: :read }) { |scope, value| value ? scope.published : scope.unpublished }
 end
 ```
 

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

@@ -14,8 +14,8 @@ module Resolvers
 
     scope { Category.all }
 
-    option :id, type: types.String, with: :apply_id_filter
-    option :name, type: types.String, with: :apply_name_filter
+    option :id, type: String, with: :apply_id_filter
+    option :name, type: String, with: :apply_name_filter
     option :order, type: OrderEnum, default: 'RECENT'
 
     def apply_id_filter(scope, value)

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

@@ -16,12 +16,12 @@ module Resolvers
 
     scope { object.respond_to?(:posts) ? object.posts : Post.all }
 
-    option :id, type: types.String, with: :apply_id_filter
-    option :title, type: types.String, with: :apply_title_filter
-    option :body, type: types.String, with: :apply_body_filter
-    option :categoryId, type: types.String, with: :apply_category_id_filter
-    option :categoryName, type: types.String, with: :apply_category_name_filter
-    option :published, type: types.Boolean, with: :apply_published_filter
+    option :id, type: String, with: :apply_id_filter
+    option :title, type: String, with: :apply_title_filter
+    option :body, type: String, with: :apply_body_filter
+    option :categoryId, type: String, with: :apply_category_id_filter
+    option :categoryName, type: String, with: :apply_category_name_filter
+    option :published, type: Boolean, with: :apply_published_filter
     option :order, type: OrderEnum, default: 'RECENT'
 
     def apply_id_filter(scope, value)

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/lib/search_object/plugin/graphql/version.rb

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

data/lib/search_object/plugin/graphql.rb

@@ -29,19 +29,23 @@ module SearchObject
       module ClassMethods
         def option(name, options = {}, &block)
           type = options.fetch(:type) { raise MissingTypeDefinitionError, name }
-          options[:enum] = type.values.map { |value, enum_value| enum_value.value || value } if type.respond_to?(:values)
 
-          argument(
-            name.to_s,
-            options[:type],
-            required: options[:required] || false,
-            description: options[:description],
-            camelize: options[:camelize]
-          )
+          argument_options = options[:argument_options] || {}
+
+          argument_options[:required] = options[:required] || false
+
+          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)
+
+          argument(name.to_s, type, **argument_options)
+
+          options[:enum] = type.values.map { |value, enum_value| enum_value.value || value } if type.respond_to?(:values)
 
           super(name, options, &block)
         end
 
+        # NOTE(rstankov): This is removed in GraphQL 2.0.0
         def types
           GraphQL::Define::TypeDefiner.instance
         end

data/search_object_graphql.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'graphql', '~> 1.8'
+  spec.add_dependency 'graphql', '> 1.8'
   spec.add_dependency 'search_object', '~> 1.2.2'
 
   spec.add_development_dependency 'coveralls'

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)
+    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 { [] }
@@ -70,7 +92,7 @@ describe SearchObject::Plugin::Graphql do
 
       type [post_type], null: 1
 
-      option(:id, type: !types.ID) { |scope, value| scope.select { |p| p.id == value } }
+      option(:id, type: GraphQL::Types::ID) { |scope, value| scope.select { |p| p.id == value } }
     end
 
     schema = define_schema do
@@ -203,7 +225,7 @@ describe SearchObject::Plugin::Graphql do
 
     it 'accepts default type' do
       schema = define_search_class_and_return_schema do
-        option(:id, type: types.String, default: 'default') do |_scope, value|
+        option(:id, type: String, default: 'default') do |_scope, value|
           [Post.new(value)]
         end
       end
@@ -217,9 +239,45 @@ 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: 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|
+        option(:id, type: String, required: true) do |_scope, value|
           [Post.new(value)]
         end
       end
@@ -229,11 +287,30 @@ 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: 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, null: true
 
-        option('option', type: types.String, description: 'what this argument does') { [] }
+        option('option', type: String, description: 'what this argument does') { [] }
       end
 
       result = schema.execute <<-SQL
@@ -269,7 +346,7 @@ describe SearchObject::Plugin::Graphql do
       schema = define_search_class_and_return_schema do
         type PostType, null: true
 
-        option('option_field', type: types.String, camelize: false)
+        option('option_field', type: String, camelize: false)
       end
 
       result = schema.execute <<-SQL
@@ -299,6 +376,40 @@ describe SearchObject::Plugin::Graphql do
       )
     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: 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,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: search_object_graphql
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Radoslav Stankov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
@@ -140,7 +140,9 @@ files:
 - 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
@@ -190,7 +192,7 @@ homepage: https://github.com/RStankov/SearchObjectGraphQL
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -206,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: