search_object_graphql 0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 20d420d2ee1dd08bdfe48da2c5e1e3ba0a3a8233
-  data.tar.gz: 57a5009d415d6fad948001d18d428676dbd1471c
+SHA256:
+  metadata.gz: 49fd6817f69aa33a15ce7cc2e768bd239020c3f7f6b6e385e1f12d3c9d5c30ff
+  data.tar.gz: c6c4a8d82f1d5afa85519a1e8aee726b321495b2305e63fa0d5e986db75066fb
 SHA512:
-  metadata.gz: d25a679fad52b5605c5720a774f2bee6d273abc369dbfd90cc48a75793d7fd3cc6359092406d178aecd0ae97fdb6e2f938f891b764b2ebfb26c47bf99fc63605
-  data.tar.gz: f7d5f5e368c50e3bc274b8d665c83ca975f1093e55a7059c906f17e93a40388c097d51ce7288b99394b3d8268913bfe0ea1ef1d2a611bedaa0e7df9380160f5f
+  metadata.gz: a71588bac7cc2fba645d1e4007bfeed111749c0016d4a2de7e832990ff33f37e1656c08a47fd3a52f18664e594bbefee3939d1412aa3fc5d679dd9c3d875d533
+  data.tar.gz: 4c9bfd49332eafbd37b10be48bc58c65bfffa0546dc7c394a7b77e3e146769ee77083f39bbd40f101302ad7ffb967d8b7e0054b6512c35febdcedc0e00c94855

data/.rubocop.yml

@@ -7,15 +7,15 @@ AllCops:
     - search_object.gemspec
 
 # Disables "Line is too long"
-LineLength:
+Metrics/LineLength:
   Enabled: false
 
 # Disables Module has too many lines
-ModuleLength:
+Metrics/ModuleLength:
   Enabled: false
 
 # Disables "Missing top-level class documentation comment"
-Documentation:
+Style/Documentation:
   Enabled: false
 
 # Disables "Use each_with_object instead of inject"
@@ -26,10 +26,22 @@ Style/EachWithObject:
 Style/CollectionMethods:
   Enabled: false
 
+# Disables "Avoid the use of double negation (!!)."
+Style/DoubleNegation:
+  Enabled: false
+
 # Disables "Block has too many lines."
 Metrics/BlockLength:
   Enabled: false
 
+# Disables "Assignment Branch Condition size for field_options is too high."
+Metrics/AbcSize:
+  Enabled: false
+
+# Disables "Method has too many line."
+Metrics/MethodLength:
+  Enabled: false
+
 # Disables "Example has too many lines."
 RSpec/ExampleLength:
   Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.2

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-  - 2.2
-  - 2.3.0
+  - 2.4.1
+  - 2.5.2
+  - 2.6.0
 script:
   - bundle exec rubocop
   - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # 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)
+
+## Version 0.3.1
+
+* __[fix]__ Support for GraphQL gem version v1.9.16 (@ardinusawan)
+
+## Version 0.3
+
+* __[feature]__ Allow passing `required` key to option definition (@vfonic)
+* __[fix]__ Support for GraphQL gem enums (@Postmodum37)
+
+## Version 0.2
+
+* Added support for GraphQL::Schema::Resolver (@rstankov)
+* Added support for GraphQL 1.8 class API (@rstankov)
+
 ## Version 0.1
 
 * Initial release (@rstankov)

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in search_object.gemspec

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/search_object_graphql.svg)](http://badge.fury.io/rb/search_object_graphql)
 [![Code Climate](https://codeclimate.com/github/RStankov/SearchObjectGraphQL.svg)](https://codeclimate.com/github/RStankov/SearchObjectGraphQL)
 [![Build Status](https://secure.travis-ci.org/RStankov/SearchObjectGraphQL.svg)](http://travis-ci.org/RStankov/SearchObjectGraphQL)
 [![Code coverage](https://coveralls.io/repos/RStankov/SearchObjectGraphQL/badge.svg?branch=master#2)](https://coveralls.io/r/RStankov/SearchObjectGraphQL)
@@ -19,13 +20,15 @@
   * [Accessing Parent Object](#accessing-parent-object)
   * [Enums Support](#enums-support)
   * [Relay Support](#relay-support)
+* [Contributing](#contributing)
+* [License](#license)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'search_object'
+gem 'search_object_graphql'
 ```
 
 And then execute:
@@ -34,7 +37,15 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install search_object
+    $ gem install search_object_graphql
+
+
+**Require manually in your project**
+
+```ruby
+require 'search_object'
+require 'search_object/plugin/graphql'
+```
 
 ## Dependencies
 
@@ -46,22 +57,22 @@ Or install it yourself as:
 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
+  type [PostType], null: false
 
   scope { Post.all }
 
-  option(:name, type: types.String)       { |scope, value| scope.where name: value }
-  option(:published, type: types.Boolean) { |scope, value| value ? scope.published : scope.unpublished }
+  option(:name, type: String)       { |scope, value| scope.where name: value }
+  option(:published, type: Boolean) { |scope, value| value ? scope.published : scope.unpublished }
 end
 ```
 
-Then you can just use `PostResolver` as [GraphQL::Function](https://rmosolgo.github.io/graphql-ruby/schema/code_reuse#functions):
+Then you can just use `PostResolver` as [GraphQL::Schema::Resolver](https://graphql-ruby.org/fields/resolvers.html):
 
 ```ruby
-field :posts, function: PostResolver
+field :posts, resolver: PostResolver
 ```
 
 Options are exposed as arguments in the GraphQL query:
@@ -78,32 +89,12 @@ You can find example of most important features and plugins - [here](https://git
 
 ## Features
 
-### Custom Types
-
-Custom types can be define inside the search object:
-
-```ruby
-class PostResolver
-  include SearchObject.module(:graphql)
-
-  type do
-    name 'Custom Type'
-
-    field :id, !types.ID
-    field :title, !types.String
-    field :body, !types.String
-  end
-
-  # ...
-end
-```
-
 ### Documentation
 
 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'
@@ -116,7 +107,7 @@ end
 ### Default Values
 
 ```ruby
-class PostResolver
+class PostResolver < GraphQL::Schema::Resolver
   include SearchObject.module(:graphql)
 
   scope { Post.all }
@@ -130,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
@@ -174,10 +165,20 @@ end
 
 ### Relay Support
 
-Search objects can be used as [Relay Connections](https://rmosolgo.github.io/graphql-ruby/relay/connections):
+Search objects can be used as [Relay Connections](https://graphql-ruby.org/relay/connections.html):
+
+```ruby
+class PostResolver < GraphQL::Schema::Resolver
+  include SearchObject.module(:graphql)
+
+  type PostType.connection_type, null: false
+
+  # ...
+end
+```
 
 ```ruby
-connection :posts, Types::PostType.connection_type, function: Resolvers::PostSearch
+field :posts, resolver: PostResolver
 ```
 
 ## Contributing

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -5,4 +7,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

data/example/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.5.1

data/example/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) do |repo_name|
@@ -5,7 +7,7 @@ git_source(:github) do |repo_name|
   "https://github.com/#{repo_name}.git"
 end
 
-gem 'rails', '~> 5.1.0'
+gem 'rails', '~> 5.2.0'
 
 gem 'graphql'
 gem 'puma', '~> 3.7'

data/example/README.md

@@ -16,9 +16,9 @@ This is example application showing, one of the possible usages of ```SearchObje
 ```
 gem install bundler
 bundle install
-rake db:create
-rake db:migrate
-rake db:seed
+rails db:create
+rails db:migrate
+rails db:seed
 
 rails server
 ```

data/example/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 

data/example/app/controllers/application_controller.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::API
 end

data/example/app/controllers/graphql_controller.rb

@@ -1,29 +1,33 @@
+# frozen_string_literal: true
+
 class GraphqlController < ApplicationController
   def execute
-    render json: Schema.execute(query, variables: variables, context: context)
+    result = Schema.execute(params[:query],
+                            variables: ensure_hash(params[:variables]),
+                            context: {},
+                            operation_name: params[:operationName])
+    render json: result
+  rescue StandardError => e
+    raise e unless Rails.env.development?
+
+    handle_error_in_development e
   end
 
   private
 
-  def query
-    params[:query]
-  end
-
-  def variables
-    ensure_hash(params[:variables])
+  def ensure_hash(ambiguous_param)
+    case ambiguous_param
+    when String then ambiguous_param.present? ? ensure_hash(JSON.parse(ambiguous_param)) : {}
+    when Hash, ActionController::Parameters then ambiguous_param
+    when nil then {}
+    else raise ArgumentError, "Unexpected parameter: #{ambiguous_param}"
+    end
   end
 
-  def context
-    {}
-  end
+  def handle_error_in_development(error)
+    logger.error error.message
+    logger.error error.backtrace.join("\n")
 
-  # Handle form data, JSON body, or a blank value
-  def ensure_hash(params)
-    case params
-    when String then params.present? ? ensure_hash(JSON.parse(params)) : {}
-    when Hash, ActionController::Parameters then params
-    when nil then {}
-    else raise ArgumentError, "Unexpected parameter: #{params}"
-    end
+    render json: { error: { message: error.message, backtrace: error.backtrace }, data: {} }, status: 500
   end
 end

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,5 +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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Resolvers
   class CategorySearch < Resolvers::BaseSearchResolver
-    type Types::CategoryType
+    type Types::CategoryType.connection_type, null: false
     description 'Lists categories'
 
-    OrderEnum = GraphQL::EnumType.define do
-      name 'CategoryOrder'
+    class OrderEnum < Types::BaseEnum
+      graphql_name 'CategoryOrder'
 
       value 'RECENT'
       value 'NAME'

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Resolvers
   class PostSearch < Resolvers::BaseSearchResolver
-    type Types::PostType
+    type Types::PostType.connection_type, null: false
     description 'Lists posts'
 
-    OrderEnum = GraphQL::EnumType.define do
-      name 'PostOrder'
+    class OrderEnum < Types::BaseEnum
+      graphql_name 'PostOrder'
 
       value 'RECENT'
       value 'VIEWS'
@@ -51,7 +53,7 @@ module Resolvers
     end
 
     def apply_order_with_recent(scope)
-      scope.order 'published_at IS NOT NULL, published_at DESC'
+      scope.order Arel.sql('published_at IS NOT NULL'), published_at: :desc
     end
 
     def apply_order_with_views(scope)

data/example/app/graphql/schema.rb

@@ -1,3 +1,5 @@
-Schema = GraphQL::Schema.define do
+# frozen_string_literal: true
+
+class Schema < GraphQL::Schema
   query Types::QueryType
 end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Types
+  class BaseEnum < GraphQL::Schema::Enum
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Types
+  class BaseInputObject < GraphQL::Schema::InputObject
+  end
+end