Download do SearchObjectGraphQL - Download do código-fonte SearchObjectGraphQL

SearchObjectGraphQL

Outro código-fonte

1.0.0

Baixar

SearchObject::Plugin::GraphQL

Plug-in SearchObject para GraphQL Ruby.

Instalação

Adicione esta linha ao Gemfile da sua aplicação:

 gem 'search_object_graphql'

E então execute:

 $ bundle

Ou instale você mesmo como:

 $ gem install search_object_graphql

Exigir manualmente em seu projeto

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

Dependências

SearchObject >= 1.2
Graphql >= 1,5

Registro de alterações

As alterações estão disponíveis em CHANGELOG.md

Uso

Basta incluir o SearchObject.module e definir suas opções de pesquisa e seus 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

Então você pode simplesmente usar PostResolver como GraphQL::Schema::Resolver:

 field :posts , resolver : PostResolver

As opções são expostas como argumentos na consulta GraphQL:

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

Exemplo

Você pode encontrar exemplos dos recursos e plug-ins mais importantes - aqui.

Características

Documentação

O próprio objeto de pesquisa pode ser documentado, bem como suas opções:

 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 padrão

 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

Opções Adicionais de Argumento

Às vezes você precisa passar opções adicionais para o 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

Acessando o objeto pai

Às vezes você deseja definir o escopo das postagens com base no objeto pai, ele pode ser acessado como propriedade object :

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

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

  # ...
end

Se você precisar do contexto GraphQL, ele poderá ser acessado como context .

Suporte a enumerações

 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

Suporte de relé

Objetos de pesquisa podem ser usados como conexões de retransmissão:

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

  type PostType . connection_type , null : false

  # ...
end