search_object_graphql 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f509887b8c20f3fde861d5dc9cb0588a5d69c167a42d7348f3839ef34ed007b
-  data.tar.gz: '08124c03eb5127693e68fd3c191aceab436eab0463bfe82151d82207acb13ef4'
+  metadata.gz: 41da46a65689f3f9178a8e4848df69af6e03c97e8afb30560d33bafda1562b2b
+  data.tar.gz: 986e0d43576c42487751cfbc391caca2ec1cf694f6f16c9cb668d6d778570546
 SHA512:
-  metadata.gz: a76bdb08d7b81f1ca59787ae1895fb3bef3befa60c6086204b63fdc01441f0e819e293f14aa8abcac611f6ed9455b3fc556672cb2f980c21b1a699c124297514
-  data.tar.gz: 3dd7bdfea7fec0148d3d39db9eab1c340f1b05779b6137f71468e2fdb1ee9cb90a98339dc400f984a9f548f4ec7e3527a5d1e8cb71396e22bded52544a07047b
+  metadata.gz: f81ce9688f696bc17e0b4fbefdc7b8d2caa8defbebe637d5a45f980cc5ac40c9d065310414d1e96134fe0cc4a08b67a4b7cecfff04d01be293e93e8dccf5b43f
+  data.tar.gz: f0554a519c7248862329c7ce4a39667e167718e3daa5be221c8cbbac4293b35fc18c27a68f7adbb8b2994170207694130e9da8f41f0690680fab54bb9ac3c9e0

data/.ruby-version

@@ -1 +1 @@
-2.6.2
+2.7.6

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # Changelog
 
-## Version 1.0.1
+## Version 1.0.4
+
+* __[feature]__ Added `deprecation_reason` to `option` (@IgrekYY)
+
+## Version 1.0.3
+
+* __[fix]__ Support GraphQL 2.0 gem (@rstankov)
+
+## Version 1.0.2
 
-* __[feature]__ Added `argument_options` to `options` (@wuz)
+* __[feature]__ Added `argument_options` to `option` (@wuz)
 
 ## Version 1.0.1
 

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,7 @@ 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
 ```
 
@@ -126,7 +126,7 @@ class PostResolver < GraphQL::Schema::Resolver
 
   scope { Post.all }
 
-  option(:published, type: types.Boolean, argument_options: { pundit_role: :read }) { |scope, value| value ? scope.published : scope.unpublished }
+  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/lib/search_object/plugin/graphql/version.rb

@@ -3,7 +3,7 @@
 module SearchObject
   module Plugin
     module Graphql
-      VERSION = '1.0.2'
+      VERSION = '1.0.4'
     end
   end
 end

data/lib/search_object/plugin/graphql.rb

@@ -37,6 +37,7 @@ module SearchObject
           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_options[:deprecation_reason] = options[:deprecation_reason] if options.include?(:deprecation_reason)
 
           argument(name.to_s, type, **argument_options)
 
@@ -45,6 +46,7 @@ module SearchObject
           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

@@ -92,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
@@ -225,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
@@ -243,7 +243,7 @@ describe SearchObject::Plugin::Graphql do
       schema = define_search_class_and_return_schema do
         type PostType, null: true
 
-        option('option', type: types.String, default: 'default') { [] }
+        option('option', type: String, default: 'default') { [] }
       end
 
       result = schema.execute <<~GRAPHQL
@@ -277,7 +277,7 @@ describe SearchObject::Plugin::Graphql do
 
     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
@@ -292,7 +292,7 @@ describe SearchObject::Plugin::Graphql do
         permission: true
       }
       schema = define_search_class_and_return_schema do
-        option(:id, type: types.String, argument_options: argument_options) do |_scope, value|
+        option(:id, type: String, argument_options: argument_options) do |_scope, value|
           [Post.new(value)]
         end
       end
@@ -304,14 +304,13 @@ describe SearchObject::Plugin::Graphql do
           '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
@@ -347,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
@@ -381,7 +380,7 @@ describe SearchObject::Plugin::Graphql do
       schema = define_search_class_and_return_schema do
         type PostType, null: true
 
-        option('option_field', type: types.String)
+        option('option_field', type: String)
       end
 
       result = schema.execute <<~GRAPHQL
@@ -411,6 +410,65 @@ describe SearchObject::Plugin::Graphql do
       )
     end
 
+    it 'accepts deprecation_reason' do
+      schema = define_search_class_and_return_schema do
+        type PostType, null: true
+
+        option('option', type: String, deprecation_reason: 'Not in use anymore')
+      end
+
+
+      result = schema.execute <<-SQL
+        {
+          __type(name: "Query") {
+            name
+            fields {
+              args(includeDeprecated: false) {
+                name
+              }
+            }
+          }
+        }
+      SQL
+
+      expect(result.to_h).to eq(
+        'data' => {
+          '__type' => {
+            'name' => 'Query',
+            'fields' => [{
+              'args' => []
+            }]
+          }
+        }
+      )
+
+      result = schema.execute <<-SQL
+        {
+          __type(name: "Query") {
+            name
+            fields {
+              args(includeDeprecated: true) {
+                name
+              }
+            }
+          }
+        }
+      SQL
+
+      expect(result.to_h).to eq(
+        'data' => {
+          '__type' => {
+            'name' => 'Query',
+            'fields' => [{
+              'args' => [{
+                'name' => 'option',
+              }]
+            }]
+          }
+        }
+      )
+    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.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Radoslav Stankov
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2022-10-31 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
@@ -192,7 +192,7 @@ homepage: https://github.com/RStankov/SearchObjectGraphQL
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -207,8 +207,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Maps search objects to GraphQL resolvers
 test_files: