SearchObjectGraphQL

SearchObject::Plugin::GraphQL

GraphQL Ruby 用の SearchObject プラグイン。

インストール

次の行をアプリケーションの Gemfile に追加します。

 gem 'search_object_graphql'

そして、以下を実行します。

 $ bundle

または、次のように自分でインストールします。

 $ gem install search_object_graphql

プロジェクトで手動で要求する

 require 'search_object'
require 'search_object/plugin/graphql' 

依存関係

• SearchObject >= 1.2
• Graphql >= 1.5

変更履歴

変更は CHANGELOG.md で入手できます。

使用法

SearchObject.moduleをインクルードし、検索オプションとそのタイプを定義するだけです。

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  type [ PostType ] , null : false

  scope { Post . all }

  option ( :name , type : String )       { | scope , value | scope . where name : value }
  option ( :published , type : Boolean ) { | scope , value | value ? scope . published : scope . unpublished }
end

次に、 PostResolver GraphQL::Schema::Resolver として使用するだけです。

 field :posts , resolver : PostResolver

オプションは、GraphQL クエリの引数として公開されます。

 posts(name: 'Example') { ... }
posts(published: true) { ... }
posts(published: true, name: 'Example') { ... }

例

最も重要な機能とプラグインの例は、ここで見つけることができます。

特徴

ドキュメント

検索オブジェクト自体とそのオプションを文書化できます。

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  description 'Lists all posts'

  option ( :name , type : String , description : 'Fuzzy name matching' ) { ... }
  option ( :published , type : Boolean , description : 'Find published/unpublished' ) { ... }
end

デフォルト値

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  scope { Post . all }

  option ( :published , type : Boolean , default : true ) { | scope , value | value ? scope . published : scope . unpublished }
end

追加の引数オプション

場合によっては、追加のオプションをgraphql引数メソッドに渡す必要があります。

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  scope { Post . all }

  option ( :published , type : Boolean , argument_options : { pundit_role : :read } ) { | scope , value | value ? scope . published : scope . unpublished }
end

親オブジェクトへのアクセス

場合によっては、親オブジェクトに基づいて投稿のスコープを設定したい場合があります。親オブジェクトにはobjectプロパティとしてアクセスできます。

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  # lists only posts from certain category
  scope { object . posts }

  # ...
end

GraphQL コンテキストが必要な場合は、 contextとしてアクセスできます。

列挙型のサポート

 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

リレーサポート

検索オブジェクトはリレー接続として使用できます。

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  type PostType . connection_type , null : false

  # ...
end 

 field :posts , resolver : PostResolver 

テストの実行

すべての依存関係がbundle installでインストールされていることを確認してください

 rake

リリース

 rake release

貢献する

1. フォークしてみよう
2. 機能ブランチを作成します ( git checkout -b my-new-feature )
3. 変更をコミットします ( git commit -am 'Add some feature' )
4. ブランチにプッシュします ( git push origin my-new-feature )
5. テストを実行する ( rake )
6. 新しいプルリクエストを作成する

著者

• ラドスラフ・スタンコフ-クリエイター- RStankov

このプロジェクトに参加した貢献者のリストもご覧ください。

ライセンス

MITライセンス