ホーム>プログラミング関連>その他のソースコード
ダウンロード

検索オブジェクト

検索オブジェクトを構築するための DSL。

検索オブジェクトは初期コレクション (スコープ) から始まり、さまざまなオプションに基づいてフィルタリングできます。

用途:

  • 複雑な検索フォーム（例）
  • 複数のフィルター条件を持つ API エンドポイント
  • GraphQL リゾルバー (例)
  • ...オブジェクトを検索しますか?

インストール

次の行をアプリケーションの Gemfile に追加します。 

 gem 'search_object'

そして、以下を実行します。 

 $ bundle

または、次のように自分でインストールします。 

 $ gem install search_object

変更履歴

変更は CHANGELOG.md で入手できます。

使用法

SearchObject.moduleをインクルードし、検索オプションを定義するだけです。 

 class PostSearch
  include SearchObject . module

  scope { Post . all }

  option ( :name )             { | scope , value | scope . where name : value }
  option ( :created_at )       { | scope , dates | scope . created_after dates }
  option ( :published , false ) { | scope , value | value ? scope . unopened : scope . opened }
end

その後、指定されたスコープを検索するだけです。 

 search = PostSearch . new ( filters : params [ :filters ] )

# accessing search options
search . name                        # => name option
search . created_at                  # => created at option

# accessing results
search . count                       # => number of found results
search . results?                    # => is there any results found
search . results                     # => found results

# params for url generations
search . params                      # => option values
search . params opened : false        # => overwrites the 'opened' option

例

最も重要な機能とプラグインの例は、ここで見つけることができます。

プラグイン

SearchObjectサポート プラグイン。これはSearchObject.moduleメソッドに渡されます。

プラグインは単純な Ruby モジュールであり、 SearchObject.moduleに含まれています。これらはSearchObject::Pluginモジュールの下にあります。

ページネーションプラグイン

プレーンな.limitメソッドと.offsetメソッドを使用する、非常にシンプルなページネーション プラグインです。 

 class ProductSearch
  include SearchObject . module ( :paging )

  scope { Product . all }

  option :name
  option :category_name

  # per page defaults to 10
  per_page 10

  # range of values is also possible
  min_per_page 5
  max_per_page 100
end

search = ProductSearch . new ( filters : params [ :filters ] , page : params [ :page ] , per_page : params [ :per_page ] )

search . page                                                 # => page number
search . per_page                                             # => per page (10)
search . results                                              # => paginated page results

もちろん、より洗練されたページネーションプラグインが必要な場合は、以下を使用できます。 

 include SearchObject . module ( :will_paginate )
include SearchObject . module ( :kaminari )

列挙型プラグイン

事前定義されたオプションを使用してフィルターを提供します。 

 class ProductSearch
  include SearchObject . module ( :enum )

  scope { Product . all }

  option :order , enum : %w( popular date )

  private

  # Gets called when order with 'popular' is given
  def apply_order_with_popular ( scope )
    scope . by_popularity
  end

  # Gets called when order with 'date' is given
  def apply_order_with_date ( scope )
    scope . by_date
  end

  # (optional) Gets called when invalid enum is given
  def handle_invalid_order ( scope , invalid_value )
    scope
  end
end

モデルプラグイン

検索オブジェクトをActiveModelで拡張して、Rails フォームで使用できるようにします。 

 class ProductSearch
  include SearchObject . module ( :model )

  scope { Product . all }

  option :name
  option :category_name
end 
 <%# in some view: %>

<%= form_for ProductSearch.new do |form| %>
  <% form.label :name %>
  <% form.text_field :name %>
  <% form.label :category_name %>
  <% form.text_field :category_name %>
<% end %>

GraphQLプラグイン

別個の gem としてインストールされ、GraphQL で動作するように設計されています。 

 gem 'search_object_graphql'

 class PostResolver
  include SearchObject . module ( :graphql )

  type PostType

  scope { Post . all }

  option ( :name , type : types . String )       { | scope , value | scope . where name : value }
  option ( :published , type : types . Boolean ) { | scope , value | value ? scope . published : scope . unpublished }
end

並べ替えプラグイン

属性と方向を並べ替える際の煩わしさを修正しました。 

 class ProductSearch
  include SearchObject . module ( :sorting )

  scope { Product . all }

  sort_by :name , :price
end

search = ProductSearch . new ( filters : { sort : 'price desc' } )

search . results                                # => Product sorted my price DESC
search . sort_attribute                         # => 'price'
search . sort_direction                         # => 'desc'

# Smart sort checking
search . sort? ( 'price' )                         # => true
search . sort? ( 'price desc' )                    # => true
search . sort? ( 'price asc' )                     # => false

# Helpers for dealing with reversing sort direction
search . reverted_sort_direction                # => 'asc'
search . sort_direction_for ( 'price' )            # => 'asc'
search . sort_direction_for ( 'name' )             # => 'desc'

# Params for sorting links
search . sort_params_for ( 'name' )

ヒントとコツ

結果のショートカット

多くの場合、必要なのは検索結果だけです。 

 ProductSearch . new ( params ) . results == ProductSearch . results ( params )

スコープを引数として渡す

 class ProductSearch
  include SearchObject . module
end

# first arguments is treated as scope (if no scope option is provided)
search = ProductSearch . new ( scope : Product . visible , filters : params [ :f ] )
search . results # => includes only visible products

Nil オプションの処理

 class ProductSearch
  include SearchObject . module

  scope { Product . all }

  # nil values returned from option blocks are ignored
  option ( :sold ) { | scope , value | scope . sold if value }
end

デフォルトのオプションブロック

 class ProductSearch
  include SearchObject . module

  scope { Product . all }

  option :name # automaticly applies => { |scope, value| scope.where name: value unless value.blank? }
end

オプション ブロックでのインスタンス メソッドの使用

 class ProductSearch
  include SearchObject . module

  scope { Product . all }

  option ( :date ) { | scope , value | scope . by_date parse_dates ( value ) }

  private

  def parse_dates ( date_string )
    # some "magic" method to parse dates
  end
end

ストレートディスパッチにインスタンスメソッドを使用する

 class ProductSearch
  include SearchObject . module

  scope { Product . all }

  option :date , with : :parse_dates

  private

  def parse_dates ( scope , value )
    # some "magic" method to parse dates
  end
end

アクティブなレコードは必要ありません

 class ProductSearch
  include SearchObject . module

  scope { RemoteEndpoint . fetch_product_as_hashes }

  option ( :name )     { | scope , value | scope . select { | product | product [ :name ] == value } }
  option ( :category ) { | scope , value | scope . select { | product | product [ :category ] == value } }
end

上書き方法

initializeメソッドを上書きすることで、きめ細かいスコープを設定できます。 

 class ProductSearch
  include SearchObject . module

  option :name
  option :category_name

  def initialize ( user , options = { } )
    super options . merge ( scope : Product . visible_to ( user ) )
  end
end

または、 initializeとfetch_results (結果のフェッチに使用) の両方を上書きすることで、単純なページネーションを追加することもできます。 

 class ProductSearch
  include SearchObject . module

  scope { Product . all }

  option :name
  option :category_name

  attr_reader :page

  def initialize ( filters = { } , page = 0 )
    super filters
    @page = page . to_i . abs
  end

  def fetch_results
    super . paginate page : @page
  end
end

基本モジュールの抽出

アプリケーションの基本的な検索クラスを抽出できます。 

 class BaseSearch
  include SearchObject . module

  # ... options and configuration
end

次に、次のように使用します。 

 class ProductSearch < BaseSearch
 scope { Product }
end

貢献する

  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

このプロジェクトに参加した貢献者のリストもご覧ください。

ライセンス

MITライセンス

拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて