search_object_graphql 0.1

data/spec/search_object/plugin/graphql_spec.rb

@@ -0,0 +1,288 @@
+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
+  end
+
+  PostType = GraphQL::ObjectType.define do
+    name 'Post'
+
+    field :id, !types.ID
+  end
+
+  def define_schema(&block)
+    query_type = GraphQL::ObjectType.define do
+      name 'Query'
+
+      instance_eval(&block)
+    end
+
+    GraphQL::Schema.define do
+      query query_type
+
+      max_complexity 1000
+    end
+  end
+
+  def define_search_class(&block)
+    Class.new do
+      include SearchObject.module(:graphql)
+
+      scope { [] }
+
+      instance_eval(&block) if block_given?
+    end
+  end
+
+  def define_search_class_and_return_schema(&block)
+    search_object = define_search_class(&block)
+
+    define_schema do
+      if search_object.type.nil?
+        field :posts, types[PostType], function: search_object
+      else
+        field :posts, function: search_object
+      end
+    end
+  end
+
+  it 'can be used as GraphQL::Function' do
+    schema = define_search_class_and_return_schema do
+      scope { [Post.new('1'), Post.new('2'), Post.new('3')] }
+
+      option(:id, type: !types.ID) { |scope, value| scope.select { |p| p.id == value } }
+    end
+
+    result = schema.execute '{ posts(id: "2") { id } }'
+
+    expect(result).to eq(
+      'data' => {
+        'posts' => [Post.new('2').to_json]
+      }
+    )
+  end
+
+  it 'can access to parent object' do
+    search_object = define_search_class do
+      scope { object.posts }
+    end
+
+    parent_type = GraphQL::ObjectType.define do
+      name 'ParentType'
+
+      field :posts, types[PostType], function: search_object
+    end
+
+    schema = define_schema do
+      field :parent, parent_type do
+        resolve ->(_obj, _args, _ctx) { OpenStruct.new posts: [Post.new('from_parent')] }
+      end
+    end
+
+    result = schema.execute '{ parent { posts { id }  } }'
+
+    expect(result).to eq(
+      'data' => {
+        'parent' => {
+          'posts' => [Post.new('from_parent').to_json]
+        }
+      }
+    )
+  end
+
+  it 'can access to context object' do
+    schema = define_search_class_and_return_schema do
+      scope { [Post.new(context[:value])] }
+    end
+
+    result = schema.execute('{ posts { id } }', context: { value: 'context' })
+
+    expect(result).to eq(
+      'data' => {
+        'posts' => [Post.new('context').to_json]
+      }
+    )
+  end
+
+  it 'can define complexity' do
+    schema = define_search_class_and_return_schema do
+      complexity 10_000
+    end
+
+    result = schema.execute '{ posts { id } }'
+
+    expect(result).to eq(
+      'errors' => [{
+        'message' => 'Query has complexity of 10001, which exceeds max complexity of 1000'
+      }]
+    )
+  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
+
+      description 'Test description'
+    end
+
+    result = schema.execute <<-SQL
+      {
+        __type(name: "Query") {
+          name
+          fields {
+            name
+            deprecationReason
+            type {
+              name
+              fields {
+                name
+              }
+            }
+          }
+        }
+      }
+    SQL
+
+    expect(result).to eq(
+      'data' => {
+        '__type' => {
+          'name' => 'Query',
+          'fields' => [{
+            'name' => 'posts',
+            'deprecationReason' => nil,
+            'type' => {
+              'name' => 'Test',
+              'fields' => [{
+                'name' => 'title'
+              }]
+            }
+          }]
+        }
+      }
+    )
+  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
+
+    result = schema.execute <<-QUERY
+      {
+        __type(name: "Query") {
+          name
+          fields {
+            name
+          }
+        }
+      }
+    QUERY
+
+    expect(result).to eq(
+      'data' => {
+        '__type' => {
+          'name' => 'Query',
+          'fields' => []
+        }
+      }
+    )
+  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'
+
+          value 'PRICE'
+          value 'DATE'
+        end
+
+        option(:order, type: enum_type)
+
+        define_method(:apply_order_with_price) do |_scope|
+          [Post.new('price')]
+        end
+
+        define_method(:apply_order_with_date) do |_scope|
+          [Post.new('date')]
+        end
+      end
+
+      result = schema.execute '{ posts(order: PRICE) { id } }'
+
+      expect(result).to eq(
+        'data' => {
+          'posts' => [Post.new('price').to_json]
+        }
+      )
+    end
+
+    it 'accepts default type' do
+      schema = define_search_class_and_return_schema do
+        option(:id, type: types.String, default: 'default') do |_scope, value|
+          [Post.new(value)]
+        end
+      end
+
+      result = schema.execute '{ posts { id } }'
+
+      expect(result).to eq(
+        'data' => {
+          'posts' => [Post.new('default').to_json]
+        }
+      )
+    end
+
+    it 'accepts description' do
+      schema = define_search_class_and_return_schema do
+        type PostType
+
+        option('option', type: types.String, description: 'what this argument does') { [] }
+      end
+
+      result = schema.execute <<-SQL
+        {
+          __type(name: "Query") {
+            name
+            fields {
+              args {
+                name
+                description
+              }
+            }
+          }
+        }
+      SQL
+
+      expect(result).to eq(
+        'data' => {
+          '__type' => {
+            'name' => 'Query',
+            'fields' => [{
+              'args' => [{
+                'name' => 'option',
+                'description' => 'what this argument does'
+              }]
+            }]
+          }
+        }
+      )
+    end
+
+    it 'raises error when no type is given' do
+      expect { define_search_class { option :name } }.to raise_error described_class::MissingTypeDefinitionError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'search_object'
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+end

data/spec/spec_helper_active_record.rb

@@ -0,0 +1,29 @@
+require_relative 'spec_helper'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :products, force: true do |t|
+    t.string :name
+    t.integer :category_id
+    t.integer :price
+
+    t.timestamps null: true
+  end
+
+  create_table :categories, force: true do |t|
+    t.string :name
+
+    t.timestamps null: true
+  end
+end
+
+class Product < ActiveRecord::Base
+  belongs_to :category
+end
+
+class Category < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: search_object_graphql
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Radoslav Stankov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: search_object
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Search Object plugin to working with GraphQL
+email:
+- rstankov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".projections.json"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/.gitignore
+- example/.ruby-version
+- example/Gemfile
+- example/README.md
+- example/Rakefile
+- example/app/controllers/application_controller.rb
+- example/app/controllers/graphql_controller.rb
+- example/app/graphql/resolvers/base_search_resolver.rb
+- example/app/graphql/resolvers/category_search.rb
+- example/app/graphql/resolvers/post_search.rb
+- example/app/graphql/schema.rb
+- example/app/graphql/types/.keep
+- example/app/graphql/types/category_type.rb
+- example/app/graphql/types/date_time_type.rb
+- example/app/graphql/types/post_type.rb
+- example/app/graphql/types/query_type.rb
+- example/app/models/application_record.rb
+- example/app/models/category.rb
+- example/app/models/post.rb
+- example/bin/bundle
+- example/bin/rails
+- example/bin/rake
+- example/bin/setup
+- example/bin/update
+- example/config.ru
+- example/config/application.rb
+- example/config/boot.rb
+- example/config/cable.yml
+- example/config/database.yml
+- example/config/environment.rb
+- example/config/environments/development.rb
+- example/config/environments/production.rb
+- example/config/environments/test.rb
+- example/config/initializers/wrap_parameters.rb
+- example/config/puma.rb
+- example/config/routes.rb
+- example/config/secrets.yml
+- example/config/spring.rb
+- example/db/migrate/20170507175133_create_demo_tables.rb
+- example/db/schema.rb
+- example/db/seeds.rb
+- example/log/.keep
+- example/public/robots.txt
+- example/vendor/.keep
+- lib/search_object/plugin/graphql.rb
+- lib/search_object/plugin/graphql/version.rb
+- search_object_graphql.gemspec
+- spec/search_object/plugin/graphql_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helper_active_record.rb
+homepage: https://github.com/RStankov/SearchObjectGraphQL
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Maps search objects to GraphQL resolvers
+test_files:
+- spec/search_object/plugin/graphql_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helper_active_record.rb