search_object_graphql 0.1 → 1.0.0

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Types
+  module BaseInterface
+    include GraphQL::Schema::Interface
+  end
+end

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

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

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

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

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

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

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

@@ -1,8 +1,9 @@
-Types::CategoryType = GraphQL::ObjectType.define do
-  name 'Category'
+# frozen_string_literal: true
 
-  field :id, !types.ID
-  field :name, !types.String
-
-  connection :posts, Types::PostType.connection_type, function: Resolvers::PostSearch
+module Types
+  class CategoryType < BaseObject
+    field :id, ID, null: false
+    field :name, String, null: false
+    field :posts, resolver: Resolvers::PostSearch
+  end
 end

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

@@ -1,6 +1,5 @@
-Types::DateTimeType = GraphQL::ScalarType.define do
-  name 'DateTime'
+# frozen_string_literal: true
 
-  coerce_input ->(value, _ctx) { Time.zone.parse(value) }
-  coerce_result ->(value, _ctx) { value.utc.iso8601 }
+module Types
+  DateTimeType = GraphQL::Types::ISO8601DateTime
 end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Types
+  class MutationType < Types::BaseObject
+  end
+end

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

@@ -1,13 +1,15 @@
-Types::PostType = GraphQL::ObjectType.define do
-  name 'Post'
+# frozen_string_literal: true
 
-  field :id, !types.ID
-  field :title, !types.String
-  field :body, !types.String
-  field :category, !Types::CategoryType
-  field :viewsCount, !types.Int, property: :views_count
-  field :likesCount, !types.Int, property: :likes_count
-  field :commentsCount, !types.Int, property: :comments_count
-  field :isPublished, !types.Boolean, property: :published?
-  field :publishedAt, !Types::DateTimeType, property: :published_at
+module Types
+  class PostType < BaseObject
+    field :id, ID, null: false
+    field :title, String, null: false
+    field :body, String, null: false
+    field :category, CategoryType, null: false
+    field :views_count, Int, null: false
+    field :likes_count, Int, null: false
+    field :comments_count, Int, null: false
+    field :is_published, Boolean, null: false, method: :published?
+    field :published_at, DateTimeType, null: false
+  end
 end

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

@@ -1,7 +1,8 @@
-Types::QueryType = GraphQL::ObjectType.define do
-  name 'Query'
+# frozen_string_literal: true
 
-  connection :categories, Types::CategoryType.connection_type, function: Resolvers::CategorySearch
-
-  connection :posts, Types::PostType.connection_type, function: Resolvers::PostSearch
+module Types
+  class QueryType < Types::BaseObject
+    field :categories, resolver: Resolvers::CategorySearch
+    field :posts, resolver: Resolvers::PostSearch
+  end
 end

data/example/app/models/application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 end

data/example/app/models/category.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Category < ApplicationRecord
   validates :name, presence: true, uniqueness: true
 

data/example/app/models/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Post < ApplicationRecord
   validates :title, presence: true, uniqueness: true
   validates :body, presence: true

data/example/bin/bundle

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 load Gem.bin_path('bundler', 'bundle')

data/example/bin/rails

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 APP_PATH = File.expand_path('../config/application', __dir__)
 require_relative '../config/boot'
 require 'rails/commands'

data/example/bin/rake

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

data/example/bin/setup

@@ -1,10 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'pathname'
 require 'fileutils'
-include FileUtils
+include FileUtils # rubocop:disable Style/MixinUsage
 
 # path to your application root.
-APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+APP_ROOT = Pathname.new File.expand_path('..', __dir__)
 
 def system!(*args)
   system(*args) || abort("\n== Command #{args} failed ==")

data/example/bin/update

@@ -1,10 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'pathname'
 require 'fileutils'
-include FileUtils
+include FileUtils # rubocop:disable Style/MixinUsage
 
 # path to your application root.
-APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+APP_ROOT = Pathname.new File.expand_path('..', __dir__)
 
 def system!(*args)
   system(*args) || abort("\n== Command #{args} failed ==")

data/example/config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is used by Rack-based servers to start the application.
 
 require_relative 'config/environment'

data/example/config/application.rb

@@ -3,7 +3,7 @@ require_relative 'boot'
 require "rails"
 # Pick the frameworks you want:
 require "active_model/railtie"
-# require "active_job/railtie"
+require "active_job/railtie"
 require "active_record/railtie"
 require "action_controller/railtie"
 # require "action_mailer/railtie"

data/example/db/migrate/20170507175133_create_demo_tables.rb

@@ -7,7 +7,7 @@ class CreateDemoTables < ActiveRecord::Migration[5.1]
     end
 
     create_table :posts do |t|
-      t.references :category, foreign_key: true
+      t.references :category
       t.string :title, null: false
       t.index :title, unique: true
       t.string :body, null: false

data/example/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20170507175133) do
+ActiveRecord::Schema.define(version: 2017_05_07_175133) do
 
   create_table "categories", force: :cascade do |t|
     t.string "name", null: false

data/lib/search_object/plugin/graphql.rb

@@ -1,26 +1,43 @@
+# frozen_string_literal: true
+
 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.extend ClassMethods
       end
 
       attr_reader :object, :context
 
-      def initialize(filters: {}, object: nil, context: {}, scope: nil)
+      def initialize(filters: {}, object: nil, context: {}, scope: nil, field: nil)
         @object = object
         @context = context
 
-        super filters: filters, scope: scope
+        super filters: filters, scope: scope, field: field
+      end
+
+      # NOTE(rstankov): GraphQL::Schema::Resolver interface
+      # Documentation - http://graphql-ruby.org/fields/resolvers.html#using-resolver
+      def resolve_with_support(args = {})
+        self.params = args.to_h
+        results
       end
 
       module ClassMethods
         def option(name, options = {}, &block)
-          argument = Helper.build_argument(name, options)
-          arguments[argument.name] = argument
+          type = options.fetch(:type) { raise MissingTypeDefinitionError, name }
+          options[:enum] = type.values.map { |value, enum_value| enum_value.value || value } if type.respond_to?(:values)
 
-          options[:enum] = argument.type.values.keys if argument.type.is_a? GraphQL::EnumType
+          argument(
+            name.to_s,
+            options[:type],
+            required: options[:required] || false,
+            description: options[:description],
+            camelize: options[:camelize]
+          )
 
           super(name, options, &block)
         end
@@ -28,35 +45,11 @@ module SearchObject
         def types
           GraphQL::Define::TypeDefiner.instance
         end
+      end
 
-        # NOTE(rstankov): GraphQL::Function interface
-        # Documentation - https://rmosolgo.github.io/graphql-ruby/schema/code_reuse#functions
-        def call(object, args, context)
-          new(filters: args.to_h, object: object, context: context).results
-        end
-
-        def arguments
-          config[:args] ||= {}
-        end
-
-        def type(value = :default, &block)
-          return config[:type] if value == :default && !block_given?
-          config[:type] = block_given? ? GraphQL::ObjectType.define(&block) : value
-        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
-          config[:description] = value
-        end
-
-        def deprecation_reason(value = :default)
-          return config[:deprecation_reason] if value == :default
-          config[:deprecation_reason] = value
+      class NotIncludedInResolverError < ArgumentError
+        def initialize(base)
+          super "#{base.name} should inherit from GraphQL::Schema::Resolver. Current ancestors #{base.ancestors}"
         end
       end
 
@@ -65,20 +58,6 @@ module SearchObject
           super "GraphQL type has to passed as :type to '#{name}' option"
         end
       end
-
-      # :api: private
-      module Helper
-        module_function
-
-        def build_argument(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
-          argument
-        end
-      end
     end
   end
 end

data/lib/search_object/plugin/graphql/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SearchObject
   module Plugin
     module Graphql
-      VERSION = '0.1'.freeze
+      VERSION = '1.0.0'
     end
   end
 end

data/search_object_graphql.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'English'
 require 'search_object/plugin/graphql/version'
@@ -19,13 +20,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'search_object', '~> 1.2'
-  spec.add_dependency 'graphql', '~> 1.5'
+  spec.add_dependency 'graphql', '~> 1.8'
+  spec.add_dependency 'search_object', '~> 1.2.2'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'rubocop', '0.46.0'
-  spec.add_development_dependency 'rubocop-rspec', '1.8.0'
   spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rubocop', '0.62.0'
+  spec.add_development_dependency 'rubocop-rspec', '1.31.0'
 end

data/spec/search_object/plugin/graphql_spec.rb

@@ -1,29 +1,29 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'graphql'
 require 'ostruct'
 require 'search_object/plugin/graphql'
 
-describe SearchObject::Plugin::Graphql do
-  Post = Struct.new(:id) do
-    def to_json
-      { 'id' => id }
-    end
+Post = Struct.new(:id) do
+  def to_json(_options = {})
+    { 'id' => id }
   end
+end
 
-  PostType = GraphQL::ObjectType.define do
-    name 'Post'
-
-    field :id, !types.ID
-  end
+class PostType < GraphQL::Schema::Object
+  field :id, ID, null: false
+end
 
+describe SearchObject::Plugin::Graphql do
   def define_schema(&block)
-    query_type = GraphQL::ObjectType.define do
-      name 'Query'
+    query_type = Class.new(GraphQL::Schema::Object) do
+      graphql_name 'Query'
 
       instance_eval(&block)
     end
 
-    GraphQL::Schema.define do
+    Class.new(GraphQL::Schema) do
       query query_type
 
       max_complexity 1000
@@ -31,7 +31,7 @@ describe SearchObject::Plugin::Graphql do
   end
 
   def define_search_class(&block)
-    Class.new do
+    Class.new(GraphQL::Schema::Resolver) do
       include SearchObject.module(:graphql)
 
       scope { [] }
@@ -45,20 +45,38 @@ describe SearchObject::Plugin::Graphql do
 
     define_schema do
       if search_object.type.nil?
-        field :posts, types[PostType], function: search_object
+        field :posts, [PostType], resolver: search_object
       else
-        field :posts, function: search_object
+        field :posts, resolver: search_object
       end
     end
   end
 
-  it 'can be used as GraphQL::Function' do
-    schema = define_search_class_and_return_schema do
+  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'
+
+      field :id, GraphQL::Types::ID, null: false
+    end
+
+    search_object = define_search_class do
       scope { [Post.new('1'), Post.new('2'), Post.new('3')] }
 
+      type [post_type], null: 1
+
       option(:id, type: !types.ID) { |scope, value| scope.select { |p| p.id == value } }
     end
 
+    schema = define_schema do
+      field :posts, resolver: search_object
+    end
+
     result = schema.execute '{ posts(id: "2") { id } }'
 
     expect(result).to eq(
@@ -73,19 +91,19 @@ describe SearchObject::Plugin::Graphql do
       scope { object.posts }
     end
 
-    parent_type = GraphQL::ObjectType.define do
-      name 'ParentType'
+    parent_type = Class.new(GraphQL::Schema::Object) do
+      graphql_name 'Parent'
 
-      field :posts, types[PostType], function: search_object
+      field :posts, [PostType], resolver: search_object
     end
 
     schema = define_schema do
-      field :parent, parent_type do
-        resolve ->(_obj, _args, _ctx) { OpenStruct.new posts: [Post.new('from_parent')] }
-      end
+      field :parent, parent_type, null: false
     end
 
-    result = schema.execute '{ parent { posts { id }  } }'
+    root = OpenStruct.new(parent: OpenStruct.new(posts: [Post.new('from_parent')]))
+
+    result = schema.execute '{ parent { posts { id }  } }', root_value: root
 
     expect(result).to eq(
       'data' => {
@@ -124,86 +142,40 @@ 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
+  describe 'option' do
+    it 'converts GraphQL::Schema::Enum to SearchObject enum' do
+      schema = define_search_class_and_return_schema do
+        enum_type = Class.new(GraphQL::Schema::Enum) do
+          graphql_name 'PostOrder'
 
-      description 'Test description'
-    end
+          value 'PRICE'
+          value 'DATE'
+        end
 
-    result = schema.execute <<-SQL
-      {
-        __type(name: "Query") {
-          name
-          fields {
-            name
-            deprecationReason
-            type {
-              name
-              fields {
-                name
-              }
-            }
-          }
-        }
-      }
-    SQL
+        option(:order, type: enum_type)
 
-    expect(result).to eq(
-      'data' => {
-        '__type' => {
-          'name' => 'Query',
-          'fields' => [{
-            'name' => 'posts',
-            'deprecationReason' => nil,
-            'type' => {
-              'name' => 'Test',
-              'fields' => [{
-                'name' => 'title'
-              }]
-            }
-          }]
-        }
-      }
-    )
-  end
+        define_method(:apply_order_with_price) do |_scope|
+          [Post.new('price')]
+        end
 
-  it 'can be marked as deprecated' do
-    schema = define_search_class_and_return_schema do
-      type types[PostType]
-      deprecation_reason 'Not needed any more'
-    end
+        define_method(:apply_order_with_date) do |_scope|
+          [Post.new('date')]
+        end
+      end
 
-    result = schema.execute <<-QUERY
-      {
-        __type(name: "Query") {
-          name
-          fields {
-            name
-          }
-        }
-      }
-    QUERY
+      result = schema.execute '{ posts(order: PRICE) { id } }'
 
-    expect(result).to eq(
-      'data' => {
-        '__type' => {
-          'name' => 'Query',
-          'fields' => []
+      expect(result).to eq(
+        'data' => {
+          'posts' => [Post.new('price').to_json]
         }
-      }
-    )
-  end
+      )
+    end
 
-  describe 'option' 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'
@@ -245,9 +217,21 @@ describe SearchObject::Plugin::Graphql do
       )
     end
 
+    it 'accepts "required"' do
+      schema = define_search_class_and_return_schema do
+        option(:id, type: types.String, required: true) do |_scope, value|
+          [Post.new(value)]
+        end
+      end
+
+      result = schema.execute '{ posts { id } }'
+
+      expect(result['errors'][0]['message']).to eq("Field 'posts' is missing required arguments: id")
+    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
@@ -281,6 +265,40 @@ 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 'raises error when no type is given' do
       expect { define_search_class { option :name } }.to raise_error described_class::MissingTypeDefinitionError
     end