DefaultWhere

default_where set default params process for where query in ActiveRecord

It's a wise decision to use default_where with default_form to replace ransack

使用说明

语法概览

  • 等于：key: value
  • 范围：key-gte: value,
  • 排序：key-asc: 1, key-desc: 2
  • 排除：key-not: value #### 对于postgresql 数据库
  • 包含任一值：key-any: value

Normal equal params

  • Params: ruby # rails 4 and later, default_where does nothing params = { role_id: 1, age: 20 } User.default_where(params)

Equal params with association

  • params ```ruby User.belongs_to :role params = { name: 'dhh', 'role.id': 2 }

you can use any table name or reference name

params = { name: 'dhh', 'roles.id': 2 }

* Before use `default_where`
```ruby
User.includes(:student).where(name: params[:name], role: {id: params[:'role.id']})
  • After Use default_where ruby User.default_where(params)

Range params

  • params ruby params = { 'role_id-lte': 2 }
  • Before use default_where ruby User.where('role_id >= ?', params[:'role_id-lte'])
  • After use default_where ruby User.default_where(params)

Auto remove blank params by default, no need write query with if else

  • params ruby params = { age: '', role_id: 1 }
  • Before use default_where ruby users = User.where(role_id: params[:role_id]) users = users.where(age: params[:age]) if params[:age]
  • After use default_where ```ruby User.default_where(params)

### allow
you can control which blank value can use

```ruby
{
  name: nil,
  allow: { name: nil }
}

OR

params = {
  or: { 
    'users.email-not': 'qin',
    'name': 'qin'
  }
}

Auto call strip for string

  • params ruby params= { name: ' dhh ' }
  • Before use default_where ruby User.where(name: params[:name].strip)
  • After use default_where ```ruby User.default_where(params)

also can control whether use strip

{ name: ' qin', strip: { name: false } }


### Order params
* Params
```ruby
params = { 'age-asc': '1', 'last_login_at-asc': '2' }
  • Before use default_where ruby User.order(age: :asc, last_login_at: :asc)
  • After use default_where ruby User.default_where(params)

For Postgresql

  • support JSONB filter，just use like this: column_name/json_key, just notice jsonb all value is string type; ruby # before Order.where("extra->>'maintain_id' = :key", key: id.to_s) # after Order.default_where('extra/maintain_id': id.to_s)

A sample with all params above

  • Params ruby { name: 'dhh', 'role.id': 2, 'age-lte': 2, 'age-asc': '1', 'last_login_at-asc': '2', or: { name: 'dhh', email: 'dhh' }, allow: { name: nil } }
  • Before use default_where ruby User.includes(:role).where(name: params[:name], 'roles.id': params[:'role.id']).order(age: :asc, last_login_at: :asc)
  • After use default_where ruby User.default_where(params)

许可证

遵循 MIT 协议