SearchObjectGraphQL

SearchObject::Plugin::GraphQL

SearchObject-Plugin für GraphQL Ruby.

Installation

Fügen Sie diese Zeile zur Gemfile Ihrer Anwendung hinzu:

 gem 'search_object_graphql'

Und dann ausführen:

 $ bundle

Oder installieren Sie es selbst als:

 $ gem install search_object_graphql

Manuell in Ihrem Projekt erforderlich

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

Abhängigkeiten

• SearchObject >= 1.2
• Graphql >= 1,5

Änderungsprotokoll

Änderungen sind in CHANGELOG.md verfügbar

Verwendung

Fügen Sie einfach das SearchObject.module ein und definieren Sie Ihre Suchoptionen und deren Typen:

 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

Dann können Sie PostResolver einfach als GraphQL::Schema::Resolver verwenden:

 field :posts , resolver : PostResolver

Optionen werden als Argumente in der GraphQL-Abfrage bereitgestellt:

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

Beispiel

Beispiele für die wichtigsten Funktionen und Plugins finden Sie hier.

Merkmale

Dokumentation

Das Suchobjekt selbst sowie seine Optionen können dokumentiert werden:

 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

Standardwerte

 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

Zusätzliche Argumentoptionen

Manchmal müssen Sie zusätzliche Optionen an die Argumentmethode graphql übergeben.

 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

Zugriff auf übergeordnetes Objekt

Manchmal möchten Sie den Umfang von Beiträgen basierend auf dem übergeordneten Objekt festlegen. Darauf kann über object zugegriffen werden:

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

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

  # ...
end

Wenn Sie GraphQL-Kontext benötigen, ist dieser als context zugänglich.

Enums-Unterstützung

 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-Unterstützung

Suchobjekte können als Relay-Verbindungen verwendet werden:

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

  type PostType . connection_type , null : false

  # ...
end 

 field :posts , resolver : PostResolver 

Laufende Tests

Stellen Sie sicher, dass alle Abhängigkeiten mit bundle install installiert sind

 rake

Freigeben

 rake release

Mitwirken

1. Gabel es
2. Erstellen Sie Ihren Feature-Zweig ( git checkout -b my-new-feature )
3. Übernehmen Sie Ihre Änderungen ( git commit -am 'Add some feature' )
4. Zum Zweig pushen ( git push origin my-new-feature )
5. Führen Sie die Tests durch ( rake )
6. Erstellen Sie eine neue Pull-Anfrage

Autoren

• Radoslav Stankov – Schöpfer – RStankov

Siehe auch die Liste der Mitwirkenden, die an diesem Projekt teilgenommen haben.

Lizenz

MIT-Lizenz