search_object_graphql 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c82b2028e4c0234e7f8109dbe66cb37746efc7c39e17d7e31a02b10f3e975c5e
-  data.tar.gz: b9d2f3bb799b65943fbcd3d777a75e9a1c3348dd7a33b0064212e373f6bd7422
+  metadata.gz: 9f509887b8c20f3fde861d5dc9cb0588a5d69c167a42d7348f3839ef34ed007b
+  data.tar.gz: '08124c03eb5127693e68fd3c191aceab436eab0463bfe82151d82207acb13ef4'
 SHA512:
-  metadata.gz: a321cd52dfab7394ab746afa2b4d288be0a1beeec9eaa4286989fd0d63a4427f3153aa8aec2ebc42431daea0513b2604d6e123512a22e1cd394ef00ed330dc1c
-  data.tar.gz: 0e6a7c3a3a8a3695b4b2797aa0bcb26c5b98d3bd0bc8d91a605d2e26bafe6c58d001eb260d81fcc88d53c0f3b28f945bd6387ce3860bcd48412f781e38c4be1f
+  metadata.gz: a76bdb08d7b81f1ca59787ae1895fb3bef3befa60c6086204b63fdc01441f0e819e293f14aa8abcac611f6ed9455b3fc556672cb2f980c21b1a699c124297514
+  data.tar.gz: 3dd7bdfea7fec0148d3d39db9eab1c340f1b05779b6137f71468e2fdb1ee9cb90a98339dc400f984a9f548f4ec7e3527a5d1e8cb71396e22bded52544a07047b

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## 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

data/README.md

@@ -116,6 +116,20 @@ class PostResolver < GraphQL::Schema::Resolver
 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:

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.1'
+      VERSION = '1.0.2'
     end
   end
 end

data/lib/search_object/plugin/graphql.rb

@@ -30,7 +30,10 @@ module SearchObject
         def option(name, options = {}, &block)
           type = options.fetch(:type) { raise MissingTypeDefinitionError, name }
 
-          argument_options = { required: options[:required] || false }
+          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)

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 { [] }
@@ -265,6 +287,26 @@ 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, null: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_object_graphql
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Radoslav Stankov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -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: