SearchObject 다운로드 - SearchObject 소스 코드 다운로드

검색객체

검색 개체 구축을 위한 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 메소드에 전달되는 플러그인을 지원합니다.

플러그인은 SearchObject.module 에 포함된 일반 Ruby 모듈입니다. 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

기여

포크해
기능 브랜치를 생성합니다( git checkout -b my-new-feature ).
변경 사항 커밋( git commit -am 'Add some feature' )
브랜치로 푸시( git push origin my-new-feature )
테스트 실행( rake )
새로운 Pull Request 생성

저자

Radoslav Stankov - 제작자 - RStankov

이 프로젝트에 참여한 기여자 목록도 참조하세요.

특허

MIT 라이센스

확장하다

SearchObject

검색객체

설치

변경 내역

용법

예

플러그인

페이지 매김 플러그인

열거형 플러그인

모델 플러그인

GraphQL 플러그인

정렬 플러그인

팁과 요령

결과 바로가기

범위를 인수로 전달하기

Nil 옵션 처리

기본 옵션 블록

옵션 블록에서 인스턴스 방법 사용

직접 발송을 위한 인스턴스 방법 사용

활성 레코드가 필요하지 않습니다

덮어쓰기 방법

기본 모듈 추출

기여

저자

특허

waymo open dataset

SmartTube

Sunamu

viptools for eslam

MySchedule.py

VITAident

chat.petals.dev

GPT Prompt Templates

GPTyped

waymo open dataset

SmartTube

Sunamu

waymo open dataset

termwind

wp functions