Project

searchkon

0.0
No commit activity in last 3 years
No release in over 3 years
searchkonmajidimanzade/searchkonHomepageDocumentationSource CodeBug TrackerWiki
Advanced activerecord search/filter command
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
8,764
Stars
4
Forks
0
Watchers
3
 Releases
Current version
1.0.3
Total releases
6
First release
2020-05-24
Latest release
2020-05-24
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-06-02
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
rake
>= 0
rspec
>= 0
sqlite3
>= 0

Runtime

activerecord
>= 0
activesupport
>= 0
 Project Readme

Searchkon

Searchkon is Advanced active record search(filter) command that makes easy to search throw models and their relationships.

Introduction

Lets say we want to return a list of products filtered by multiple parameters. our request contain below parameters:

{
  title: 'foobar',
  id: [1, 2, 3, 4],
  created_at: '(2012-12-21..2019-12-21)'
  categories.name: 'mobile'
}

Filter above parameters with Searchkon gem:

Searchkon::QueryBuilder.filter('Product', filters)

Getting Start

Add Searchkon to your Gemfile:

gem 'searchkon'

Searchable columns

at the first we should determine witch columns of model can be filter in Searchkon

class Product < ActiveRecord::Base

  has_many :coupons
  has_many :payments

  def self.searchable_columns
    {
      like: ['title', 'coupons.code'],
      exact: [
        'created_at',
        'coupons.title', ## relational filter on coupons table
        'payments.id', ## relational filter on payments table
        'id'
      ]
    }
  end
end

like: if you add specific column in your like scope, your query will be like below sql.

select * from products where title like %foo%

exact: Searchkon create query using equal operation.

select * from products where created_at = foo

Simple where query

params =  {
  id: 1,
  title: 'foobar'
}
Searchkon::QueryBuilder.filter('Product', params)

sql result:

SELECT "products".* FROM "products" WHERE (products.title like '%foobar%') AND "products"."id" = 1

Search Range

params = {
  id: '(1..10)',
  created_at: '(2012-12-21..2019-12-21)'
}

sql result:

SELECT "products".* FROM "products" WHERE (products.title like '%foobar%') AND "products"."id" = 1

Search in relational table

params = {
 'coupons.id': [1,4,8] 
}

sql result:

SELECT "products".* FROM "products" INNER JOIN "coupons" ON "coupons"."product_id" = "products"."id" WHERE "coupons"."id" IN (1, 4, 8)

Invalid Column in query

if your filter parameters contain invalid column name, Searchkon skip it and create query without that column.

invalid_mock_params = {
  id: 1,
  foo: 'foobar'
}
Searchkon::QueryBuilder.filter('Product', invalid_mock_params)

sql result:

SELECT "products".* FROM "products" WHERE "products"."id" = 1