SearchObjectGraphQL

搜索对象::插件::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

另请参阅参与该项目的贡献者列表。

执照

麻省理工学院许可证