0xryanz / the_where

TheWhere

the_where set default params process for where query in ActiveRecord

使用说明

语法概览

• 等于：key: value
• 范围：key-gte: value,
• 排序：key-asc: 1, key-desc: 2
• 排除：key-not: value

对于postgresql 数据库

• 包含任一值：key-any: value

Normal equal params

• Params:

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

Equal params with association

• params

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 the_where

User.includes(:student).where(name: params[:name], role: {id: params[:'role.id']})

• After Use the_where

User.the_where(params)

Range params

• params

params = { 'role_id-lte': 2 }

• Before use the_where

User.where('role_id >= ?', params[:'role_id-lte'])

• After use the_where

User.the_where(params)

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

• params

params = { age: '', role_id: 1 }

• Before use the_where

users = User.where(role_id: params[:role_id])
users = users.where(age: params[:age]) if params[:age]

• After use the_where

User.the_where(params)

# also can control which blank value can use
User.the_where(params, { xx: { allow: nil }})

OR

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

Auto call strip for string

• params

params= { name: ' dhh ' }

• Before use the_where

User.where(name: params[:name].strip)

• After use the_where

User.the_where(params)

# also can control whether use strip
User.the_where(params, { strip: false })

Order params

• Params

params = { 'age-asc': '1', 'last_login_at-asc': '2' }

• Before use the_where

User.order(age: :asc, last_login_at: :asc)

• After use the_where

User.the_where(params)

A sample with all params above

• Params

{ name: 'dhh', 'role.id': 2, 'age-lte': 2, 'age-asc': '1', 'last_login_at-asc': '2' }

• Before use the_where

User.includes(:role).where(name: params[:name], 'roles.id': params[:'role.id']).order(age: :asc, last_login_at: :asc)

• After use the_where

User.the_where(params)