searchkon 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88eb069f595c640f36cabb535500611af50509f2fab77923aa9b561a2578ac80
-  data.tar.gz: a31155092c7389fcb575cdf0852193f5188944b13c701df96c9ed36febd02c73
+  metadata.gz: c48b564308ba6cfc2179d89383d7ae2602655466a7468631413a0a0472ad6aea
+  data.tar.gz: cc8ae626d7cc7861c678c650c4cca4a256e2e35d728eddf8945ac25eb78aaabb
 SHA512:
-  metadata.gz: a3d4ee299428ad17cc626873cf2646cf7d23af6d051e86f73c58422f4113cf0782996a3ea3d37ab8f92bf3994b3052a5319a80a9b22ebbb9369742bfe99fc1cb
-  data.tar.gz: bba440bf57a4777937fc62f127cb6c995aca00e5e515186719555b364db26352398a25005c2cc2e548d29b2d1fc779de18a75691d6b91cb9c467ef9504c70c4d
+  metadata.gz: 2c04327ac3103a5c5a2498434a6d44b078ec12f6f6d8cef9ad0e425ab644a1a0569d6feabe810f6a3756704ba42d3ead3ae29abbade24423183d6cc6b67291e3
+  data.tar.gz: 6a836a104d4110d1423aa2da85a86b8bb4343d2003217a313745ada708e771ed02143f7da9bb1e295012d4c2078e59998bb79d37031f0aa1811a2226dd44dc31

data/README.md

@@ -1 +1,153 @@
-Hello
+# 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:
+
+```
+      {
+        filters: {
+          title: 'foobar',
+          id: [1, 2, 3, 4],
+          created_at: '(2012-12-21..2019-12-21)'
+          categories.name: 'mobile'
+        }
+      }
+
+```
+
+Filter above parameters with Searchkon gem:
+
+```rb
+Searchkon::QueryBuilder.filter('Product', filters)
+```
+
+## Getting Start
+
+
+Add Searchkon to your Gemfile:
+```sh
+gem 'searchkon'
+```
+
+### Searchable columns
+
+at the first we should determine witch columns of model can be filter in Searchkon
+
+```rb
+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
+
+```
+
+
+<b> like: </b> if you add specific column in your like scope, your query will be like below sql.
+```sql
+select * from products where title like %foo%
+```
+
+<b>exact:</b> Searchkon create query using equal operation.
+
+```sql
+select * from products where created_at = foo
+```
+
+### Simple where query
+
+<b>Important: </b> Searchkon just accept filters key, you can add your filterable columns in filter key.
+
+
+```rb
+     params =  {
+        filters: {
+          id: 1,
+          title: 'foobar'
+        }
+     }
+```
+
+```rb
+Searchkon::QueryBuilder.filter('Product', params)
+```
+
+sql result:
+```sql
+SELECT "products".* FROM "products" WHERE (products.title like '%foobar%') AND "products"."id" = 1
+```
+
+### Search Range
+
+```rb
+     params = {
+        filters: {
+          id: '(1..10)',
+          created_at: '(2012-12-21..2019-12-21)'
+        }
+      }
+```
+
+sql result:
+
+```sql
+SELECT "products".* FROM "products" WHERE (products.title like '%foobar%') AND "products"."id" = 1
+```
+
+
+### Search in relational table
+
+
+```rb
+     params = {
+		{ 
+          filters: { 'coupons.id': [1,4,8] }
+        }
+      }
+```
+
+sql result:
+
+```sql
+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.
+
+```rb
+     invalid_mock_params = {
+        filters: {
+          id: 1,
+          foo: 'foobar'
+        }
+      }
+```
+
+```rb
+Searchkon::QueryBuilder.filter('Product', invalid_mock_params)
+```
+
+sql result:
+
+
+```sql
+SELECT "products".* FROM "products" WHERE "products"."id" = 1
+```

data/lib/searchkon/query_builder.rb

@@ -7,7 +7,7 @@ module Searchkon
       def filter model, params = {}
         @model = model.constantize
         @res = @model.all
-        valid_params = validate_params(params[:filters], @model.searchable_columns)
+        valid_params = validate_params(params, @model.searchable_columns)
         create_filters valid_params
         @res
       end

data/searchkon.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'searchkon'
-  s.version     = '1.0.1'
+  s.version     = '1.0.2'
   s.date        = '2020-05-24'
   s.summary     = "Search Command"
-  s.description = "Advanced activerecord Search Command, search easily"
+  s.description = "Advanced activerecord Search Command"
   s.authors     = ["Majid Imanzade", 'Amin Samadzade']
   s.email       = 'majidimanzade1@gmail.com'
   s.homepage    = 'https://rubygems.org/gems/searchkon'

data/spec/query_builder_spec.rb

@@ -4,28 +4,22 @@ RSpec.describe Searchkon::QueryBuilder do
   describe 'query builder for filter' do
     let (:simple_where_params) do
       {
-        filters: {
-          id: 1,
-          title: 'foobar'
-        }
+        id: 1,
+        title: 'foobar'
       }
     end
 
     let (:simple_range_params) do
       {
-        filters: {
-          id: '(1..10)',
-          created_at: '(2012-12-21..2019-12-21)'
-        }
+        id: '(1..10)',
+        created_at: '(2012-12-21..2019-12-21)'
       }
     end
 
     let (:range_and_array_where_params) do
       {
-        filters: {
-          id: [1,2,3,4,5],
-          created_at: '(2012-12-21..2019-12-21)'
-        }
+        id: [1,2,3,4,5],
+        created_at: '(2012-12-21..2019-12-21)'
       }
     end
 
@@ -41,21 +35,21 @@ RSpec.describe Searchkon::QueryBuilder do
     end
 
     it 'should return simple where relational query' do
-      relational_params = { filters: { 'coupons.id': 1 } }
+      relational_params = { 'coupons.id': 1 }
       query = "SELECT \"products\".* FROM \"products\" INNER JOIN \"coupons\" ON \"coupons\".\"product_id\" = \"products\".\"id\" WHERE \"coupons\".\"id\" = 1"
 
       expect(Searchkon::QueryBuilder.filter('Product', relational_params).to_sql).to eq query
     end
 
     it 'should return range relational query' do
-      relational_params = { filters: { 'coupons.id': [1,2,3] } }
+      relational_params = { 'coupons.id': [1,2,3] }
       query = "SELECT \"products\".* FROM \"products\" INNER JOIN \"coupons\" ON \"coupons\".\"product_id\" = \"products\".\"id\" WHERE \"coupons\".\"id\" IN (1, 2, 3)"
 
       expect(Searchkon::QueryBuilder.filter('Product', relational_params).to_sql).to eq query
     end
 
     it 'should return simple where relational query with two relations' do
-      relational_params = { filters: { 'coupons.id': 1, 'payments.id': 1 } }
+      relational_params = { 'coupons.id': 1, 'payments.id': 1 }
       query = "SELECT \"products\".* FROM \"products\" INNER JOIN \"coupons\" ON \"coupons\".\"product_id\" = \"products\".\"id\" INNER JOIN \"payments\" ON \"payments\".\"product_id\" = \"products\".\"id\" WHERE \"coupons\".\"id\" = 1 AND \"payments\".\"id\" = 1"
       expect(Searchkon::QueryBuilder.filter('Product', relational_params).to_sql).to eq query
     end
@@ -79,10 +73,8 @@ RSpec.describe Searchkon::QueryBuilder do
     it 'should return all if all filter column not exist' do
       query = "SELECT \"products\".* FROM \"products\""
       invalid_mock_params = {
-        filters: {
-          blah: 1,
-          foo: 'foobar'
-        }
+        blah: 1,
+        foo: 'foobar'
       }
 
       expect(Searchkon::QueryBuilder.filter('Product', invalid_mock_params).to_sql).to eq query
@@ -91,10 +83,8 @@ RSpec.describe Searchkon::QueryBuilder do
     it 'should return query if one filter column not exist' do
       query = "SELECT \"products\".* FROM \"products\" WHERE \"products\".\"id\" = 1"
       some_invalid_mock_params = {
-        filters: {
-          id: 1,
-          foo: 'foobar'
-        }
+        id: 1,
+        foo: 'foobar'
       }
 
       expect(Searchkon::QueryBuilder.filter('Product', some_invalid_mock_params).to_sql).to eq query
@@ -102,10 +92,8 @@ RSpec.describe Searchkon::QueryBuilder do
 
     it 'should return fulltext query if params has fulltext key' do
       query = "SELECT \"products\".* FROM \"products\" INNER JOIN \"coupons\" ON \"coupons\".\"product_id\" = \"products\".\"id\" WHERE (products.title like '%foobar%' or coupons.code like '%foobar%')"
-	   	params = {
-        filters: {
-          'title,coupons.code': 'foobar'
-        }
+      params = {
+        'title,coupons.code': 'foobar'
       }
 
       expect(Searchkon::QueryBuilder.filter('Product', params).to_sql).to eq query

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchkon
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Majid Imanzade
@@ -95,7 +95,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Advanced activerecord Search Command, search easily
+description: Advanced activerecord Search Command
 email: majidimanzade1@gmail.com
 executables: []
 extensions: []