Descarga de SearchObjectGraphQL - Descarga del código fuente SearchObjectGraphQL

SearchObjectGraphQL

Otro código fuente

1.0.0

Descargar

Objeto de búsqueda::Plugin::GraphQL

Complemento SearchObject para GraphQL Ruby.

Instalación

Agregue esta línea al Gemfile de su aplicación:

 gem 'search_object_graphql'

Y luego ejecuta:

 $ bundle

O instálelo usted mismo como:

 $ gem install search_object_graphql

Requerir manualmente en su proyecto

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

Dependencias

SearchObject >= 1.2
Graphql >= 1.5

Registro de cambios

Los cambios están disponibles en CHANGELOG.md

Uso

Simplemente incluya el SearchObject.module y defina sus opciones de búsqueda y sus tipos:

 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

Entonces puedes usar PostResolver como GraphQL::Schema::Resolver:

 field :posts , resolver : PostResolver

Las opciones se exponen como argumentos en la consulta GraphQL:

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

Ejemplo

Puede encontrar ejemplos de las funciones y complementos más importantes aquí.

Características

Documentación

El objeto de búsqueda en sí se puede documentar, así como sus opciones:

 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

Valores predeterminados

 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

Opciones de argumentos adicionales

A veces es necesario pasar opciones adicionales al método de argumento 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

Accediendo al objeto principal

A veces desea delimitar el alcance de las publicaciones según el objeto principal, se puede acceder a él como propiedad object :

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

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

  # ...
end

Si necesita contexto GraphQL, puede acceder a él como context .

Soporte de enumeraciones

 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

Soporte de retransmisión

Los objetos de búsqueda se pueden utilizar como conexiones de retransmisión:

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

  type PostType . connection_type , null : false

  # ...
end