Téléchargement du code source SearchObjectGraphQL - Téléchargement du code source SearchObjectGraphQL

SearchObjectGraphQL

Autre code source

1.0.0

Télécharger

SearchObject :: Plugin :: GraphQL

Plugin SearchObject pour GraphQL Ruby.

Installation

Ajoutez cette ligne au Gemfile de votre application :

 gem 'search_object_graphql'

Et puis exécutez :

 $ bundle

Ou installez-le vous-même en tant que :

 $ gem install search_object_graphql

Exiger manuellement dans votre projet

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

Dépendances

SearchObject >= 1.2
Graphql >= 1,5

Journal des modifications

Les modifications sont disponibles dans CHANGELOG.md

Usage

Incluez simplement le SearchObject.module et définissez vos options de recherche et leurs types :

 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

Ensuite, vous pouvez simplement utiliser PostResolver comme GraphQL::Schema::Resolver :

 field :posts , resolver : PostResolver

Les options sont exposées sous forme d'arguments dans la requête GraphQL :

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

Exemple

Vous pouvez trouver des exemples des fonctionnalités et plugins les plus importants - ici.

Caractéristiques

Documentation

L'objet de recherche lui-même peut être documenté, ainsi que ses options :

 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

Valeurs par défaut

 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

Options d'arguments supplémentaires

Parfois, vous devez transmettre des options supplémentaires à la méthode d'argument 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

Accéder à l'objet parent

Parfois, vous souhaitez étendre les publications en fonction de l'objet parent, celui-ci est accessible en tant que propriété object :

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

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

  # ...
end

Si vous avez besoin d'un contexte GraphQL, il est accessible en tant que context .

Prise en charge des énumérations

 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

Prise en charge des relais

Les objets de recherche peuvent être utilisés comme connexions relais :

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

  type PostType . connection_type , null : false

  # ...
end