search_object_graphql 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20d420d2ee1dd08bdfe48da2c5e1e3ba0a3a8233
+  data.tar.gz: 57a5009d415d6fad948001d18d428676dbd1471c
+SHA512:
+  metadata.gz: d25a679fad52b5605c5720a774f2bee6d273abc369dbfd90cc48a75793d7fd3cc6359092406d178aecd0ae97fdb6e2f938f891b764b2ebfb26c47bf99fc63605
+  data.tar.gz: f7d5f5e368c50e3bc274b8d665c83ca975f1093e55a7059c906f17e93a40388c097d51ce7288b99394b3d8268913bfe0ea1ef1d2a611bedaa0e7df9380160f5f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.projections.json

@@ -0,0 +1,8 @@
+{
+  "lib/*.rb": {
+    "alternate": "spec/{}_spec.rb"
+  },
+  "spec/*_spec.rb": {
+    "alternate": "lib/{}.rb"
+  },
+}

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format=documentation

data/.rubocop.yml

@@ -0,0 +1,39 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - example/db/**/*
+    - example/config/**/*
+    - search_object.gemspec
+
+# Disables "Line is too long"
+LineLength:
+  Enabled: false
+
+# Disables Module has too many lines
+ModuleLength:
+  Enabled: false
+
+# Disables "Missing top-level class documentation comment"
+Documentation:
+  Enabled: false
+
+# Disables "Use each_with_object instead of inject"
+Style/EachWithObject:
+  Enabled: false
+
+# Disables "Prefer reduce over inject."
+Style/CollectionMethods:
+  Enabled: false
+
+# Disables "Block has too many lines."
+Metrics/BlockLength:
+  Enabled: false
+
+# Disables "Example has too many lines."
+RSpec/ExampleLength:
+  Enabled: false
+
+# Disables "Too many expectations."
+RSpec/MultipleExpectations:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.3.0
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec
+notifications:
+  email: false
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Version 0.1
+
+* Initial release (@rstankov)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in search_object.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Radoslav Stankov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,194 @@
+[![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)
+
+# SearchObject::Plugin::GraphQL
+
+[SearchObject](https://github.com/RStankov/SearchObject) plugin for [GraphQL Ruby](https://rmosolgo.github.io/graphql-ruby/).
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Dependencies](#dependencies)
+* [Usage](#usage)
+  * [Example](#example)
+* [Features](#features)
+  * [Custom Types](#custom-types)
+  * [Documentation](#documentation)
+  * [Default Values](#default-values)
+  * [Accessing Parent Object](#accessing-parent-object)
+  * [Enums Support](#enums-support)
+  * [Relay Support](#relay-support)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'search_object'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install search_object
+
+## Dependencies
+
+- `SearchObject` >= 1.2
+- `Graphql` >= 1.5
+
+## Usage
+
+Just include the ```SearchObject.module``` and define your search options and their types:
+
+```ruby
+class PostResolver
+  include SearchObject.module(:graphql)
+
+  type PostType
+
+  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 }
+end
+```
+
+Then you can just use `PostResolver` as [GraphQL::Function](https://rmosolgo.github.io/graphql-ruby/schema/code_reuse#functions):
+
+```ruby
+field :posts, function: PostResolver
+```
+
+Options are exposed as arguments in the GraphQL query:
+
+```
+posts(name: 'Example') { ... }
+posts(published: true) { ... }
+posts(published: true, name: 'Example') { ... }
+```
+
+### Example
+
+You can find example of most important features and plugins - [here](https://github.com/RStankov/SearchObjectGraphQL/tree/master/example).
+
+## 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
+  include SearchObject.module(:graphql)
+
+  description 'Lists all posts'
+
+  option(:name, type: types.String, description: 'Fuzzy name matching') { ... }
+  option(:published, type: types.Boolean, description: 'Find published/unpublished') { ... }
+end
+```
+
+### Default Values
+
+```ruby
+class PostResolver
+  include SearchObject.module(:graphql)
+
+  scope { Post.all }
+
+  option(:published, type: types.Boolean, default: true) { |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:
+
+```ruby
+class PostResolver
+  include SearchObject.module(:graphql)
+
+  # lists only posts from certain category
+  scope { object.posts }
+
+  # ...
+end
+```
+
+If you need GraphQL context, it is accessible as `context`.
+
+### Enums Support
+
+```ruby
+class PostSearch
+  include SearchObject.module(:graphql)
+
+  OrderEnum = GraphQL::EnumType.define do
+    name 'PostOrder'
+
+    value 'RECENT'
+    value 'VIEWS'
+    value 'COMMENTS'
+  end
+
+  option :order, type: OrderEnum, default: 'RECENT'
+
+  def apply_order_with_recent(scope)
+    scope.order 'created_at DESC'
+  end
+
+  def apply_order_with_views(scope)
+    scope.order 'views_count DESC'
+  end
+
+  def apply_order_with_comments(scope)
+    scope.order 'comments_count DESC'
+  end
+end
+```
+
+### Relay Support
+
+Search objects can be used as [Relay Connections](https://rmosolgo.github.io/graphql-ruby/relay/connections):
+
+```ruby
+connection :posts, Types::PostType.connection_type, function: Resolvers::PostSearch
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Run the tests (`rake`)
+6. Create new Pull Request
+
+## License
+
+**[MIT License](https://github.com/RStankov/SearchObjectGraphQL/blob/master/LICENSE.txt)**

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/example/.gitignore

@@ -0,0 +1,20 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+.byebug_history

data/example/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/example/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'rails', '~> 5.1.0'
+
+gem 'graphql'
+gem 'puma', '~> 3.7'
+gem 'search_object'
+gem 'sqlite3'
+
+group :development do
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+gem 'graphiql-rails', group: :development

data/example/README.md

@@ -0,0 +1,83 @@
+# SearchObject::Plugin::Graphql Example Rails Application
+
+This is example application showing, one of the possible usages of ```SearchObject::Plugin::Graphql```.
+
+## Interesting Files:
+
+* [Types::QueryType](https://github.com/RStankov/SearchObjectGraphQL/blob/master/example/app/graphql/types/query_type.rb)
+* [Types::CategoryType](https://github.com/RStankov/SearchObjectGraphQL/blob/master/example/app/graphql/types/category_type.rb)
+* [Types::PostType](https://github.com/RStankov/SearchObjectGraphQL/blob/master/example/app/graphql/types/post_type.rb)
+* [Resolvers::BaseSearchResolver](https://github.com/RStankov/SearchObjectGraphQL/blob/master/example/app/graphql/resolvers/base_search_resolver.rb)
+* [Resolvers::CategoryResolver](https://github.com/RStankov/SearchObjectGraphQL/blob/master/example/app/graphql/resolvers/category_search.rb)
+* [Resolvers::PostResolver](https://github.com/RStankov/SearchObjectGraphQL/blob/master/example/app/graphql/resolvers/post_search.rb)
+
+## Installation
+
+```
+gem install bundler
+bundle install
+rake db:create
+rake db:migrate
+rake db:seed
+
+rails server
+```
+
+From there just visit: [localhost:3000/](http://localhost:3000/). This would open [graphiql](https://github.com/graphql/graphiql).
+
+## Sample GraphQL Queries
+
+```
+{
+  categories {
+    edges {
+      node {
+        id
+        name
+        posts(published: false) {
+          edges {
+            node {
+              id
+              title
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+```graphql
+{
+  posts(first: 10, published: true, order: VIEWS) {
+    edges {
+      node {
+        title
+        isPublished
+        viewsCount
+        publishedAt
+      }
+    }
+  }
+}
+```
+
+```graphql
+{
+  posts(first: 10, title: "Example", order: VIEWS) {
+    edges {
+      node {
+        title
+        category {
+          id
+          name
+        }
+        isPublished
+        viewsCount
+        publishedAt
+      }
+    }
+  }
+}
+```