searchkon 0.1.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3a98b95fd101cdff626be2a58c06db08136f252913bea0951de36291efc6f2
-  data.tar.gz: 38a365ea4287172a83922d2cc44ba1a4cb4182be2376f0d0164ba09b7c27f936
+  metadata.gz: 8b03e8feb425ac126b0abc8d2e0684ba41f57a89e36373da2b7bb6e834b30841
+  data.tar.gz: 97bc80799ba817ba658ed2f259e8664c3ede624e419c8e5b317ecf195e8c6ece
 SHA512:
-  metadata.gz: 973e2e6d10e9b0186487013ca5fa3ffc941875cd02f0a523703e2586cbf031394e8affb182405d4cd6456fb8e7a2d4f34387be5f97c1df3f4f413bb2e67914f8
-  data.tar.gz: 1d225347ce400fe97012cc29f91beb753d0c0b5a3e39147553faa152170b359a35df88466cf88499a082f5ae641f1e0a7f7b81baaba7f3c46998b738a83b3794
+  metadata.gz: 1fe13d61e92bf189d2aa96db3f09efa587c4657fe712e870f57dc5340a371f77a016c81d886785c3be67f0ed5810a3b5755a6dfe9d96279d9ab8bc887a217ff5
+  data.tar.gz: b7eeb6ba941a093e1ec77826efe721eab29664147d006dca01a0f7abf877d9047e4e3401d8d72cb37ea88086433a1144db77e4f8e69d26b250b135de3ba56c39

data/Gemfile

@@ -2,3 +2,5 @@
 source "http://rubygems.org"
 
 gemspec
+gem 'activerecord', '~> 5.0', '>= 5.0.0.1'
+gem 'activesupport', '~> 5.0', '>= 5.0.0.1'

data/README.md

@@ -1 +1,143 @@
-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:
+
+```
+{
+  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 =  {
+  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 = {
+  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 = {
+ '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 = {
+  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/regex_formatter.rb

@@ -1,6 +1,6 @@
 module Searchkon
   module RegexFormatter
-    SIMPLE_RANGE_FORMAT_REGEX = /\((.*)\.\.(.*)\)/
+  SIMPLE_RANGE_FORMAT_REGEX = /\((.*)\.\.(.*)\)/
   RELATIONAL_FORMAT_REGEX = /(.*)\.(.*)/
   DIGIT_RANGE_FORMAT_REGEX = /\((\d*)\.\.(\d*)\)/
   DATE_RANGE_FORMAT_REGEX = /\((\d{4}-\d{1,2}-\d{1,2})\.\.(\d{4}-\d{1,2}-\d{1,2})\)/

data/searchkon.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name        = 'searchkon'
-  s.version     = '0.1.1'
+  s.version     = '1.0.3'
   s.date        = '2020-05-24'
-  s.summary     = "Search Command"
-  s.description = "make search easy"
-  s.authors     = ["Majid Imanzade"]
+  s.summary     = "Advanced activerecord search/filter command"
+  s.description = "Advanced activerecord search/filter command"
+  s.authors     = ["Majid Imanzade", 'Amin Samadzade']
   s.email       = 'majidimanzade1@gmail.com'
-  s.homepage    = 'https://rubygems.org/gems/Helliot'
-  s.homepage    = "http://github.com/majidimanzade/Helliot"
+  s.homepage    = 'https://rubygems.org/gems/searchkon'
+  s.homepage    = "http://github.com/majidimanzade/searchkon"
   s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
@@ -15,4 +15,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency("bundler")
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec")
+  s.add_development_dependency "sqlite3"
+
+  s.add_dependency "activesupport"
+  s.add_dependency "activerecord"
 end

data/spec/filterable_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class DummyClass
+  include Searchkon::RegexFormatter
+  include Searchkon::Filterable
+end
+
+RSpec.describe Searchkon::Filterable do
+  describe 'filterable test' do
+    it 'should return correct filter with scope' do
+      filrtetables = {
+        like: ['name', 'cities.name'],
+        exact: ['cities.id']
+      }
+      filters = {'cities.name,name': 'Don', 'cities.id': 1}
+      result = [{:value=>1, :key => "cities.id", :scope=>:exact},
+       {:value=>"Don", :key=> "cities.name,name", :scope=>:fulltext}]
+
+      dc = DummyClass.new
+
+      expect(dc.validate_params(filters, filrtetables)).to eq result
+    end
+  end
+end

data/spec/models/coupon.rb

@@ -0,0 +1,3 @@
+class Coupon < ActiveRecord::Base
+
+end

data/spec/models/payment.rb

@@ -0,0 +1,3 @@
+class Payment < ActiveRecord::Base
+
+end

data/spec/models/product.rb

@@ -0,0 +1,17 @@
+class Product < ActiveRecord::Base
+
+  has_many :coupons
+  has_many :payments
+
+  def self.searchable_columns
+    {
+      like: ['title', 'coupons.code'],
+      exact: [
+        'created_at',
+        'coupons.id',
+        'payments.id',
+        'id'
+      ]
+    }
+  end
+end

data/spec/query_builder_spec.rb

@@ -0,0 +1,102 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+RSpec.describe Searchkon::QueryBuilder do
+  describe 'query builder for filter' do
+    let (:simple_where_params) do
+      {
+        id: 1,
+        title: 'foobar'
+      }
+    end
+
+    let (:simple_range_params) do
+      {
+        id: '(1..10)',
+        created_at: '(2012-12-21..2019-12-21)'
+      }
+    end
+
+    let (:range_and_array_where_params) do
+      {
+        id: [1,2,3,4,5],
+        created_at: '(2012-12-21..2019-12-21)'
+      }
+    end
+
+    it 'should return simple where query' do
+      query = "SELECT \"products\".* FROM \"products\" WHERE (products.title like '%foobar%') AND \"products\".\"id\" = 1"
+      expect(Searchkon::QueryBuilder.filter('Product', simple_where_params).to_sql).to eq query
+    end
+
+    it 'should return simple range query' do
+      query = "SELECT \"products\".* FROM \"products\" WHERE (products.created_at between '2012-12-21' and '2019-12-21') AND (products.id between '1' and '10')"
+
+      expect(Searchkon::QueryBuilder.filter('Product', simple_range_params).to_sql).to eq query
+    end
+
+    it 'should return simple where relational query' do
+      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 = { '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 = { '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
+
+    it 'should return range query and array where' do
+      query = "SELECT \"products\".* FROM \"products\" WHERE (products.created_at between '2012-12-21' and '2019-12-21') AND \"products\".\"id\" IN (1, 2, 3, 4, 5)"
+
+      expect(Searchkon::QueryBuilder.filter('Product', range_and_array_where_params).to_sql).to eq query
+    end
+
+    it 'should return all if params empty' do
+      query = "SELECT \"products\".* FROM \"products\""
+
+      expect(Searchkon::QueryBuilder.filter('Product', {}).to_sql).to eq query
+    end
+
+    it 'should raise error if model not exist' do
+      expect { Searchkon::QueryBuilder.filter('foobar', simple_where_params) }.to raise_error NameError
+    end
+
+    it 'should return all if all filter column not exist' do
+      query = "SELECT \"products\".* FROM \"products\""
+      invalid_mock_params = {
+        blah: 1,
+        foo: 'foobar'
+      }
+
+      expect(Searchkon::QueryBuilder.filter('Product', invalid_mock_params).to_sql).to eq query
+    end
+
+    it 'should return query if one filter column not exist' do
+      query = "SELECT \"products\".* FROM \"products\" WHERE \"products\".\"id\" = 1"
+      some_invalid_mock_params = {
+        id: 1,
+        foo: 'foobar'
+      }
+
+      expect(Searchkon::QueryBuilder.filter('Product', some_invalid_mock_params).to_sql).to eq query
+    end
+
+    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 = {
+        'title,coupons.code': 'foobar'
+      }
+
+      expect(Searchkon::QueryBuilder.filter('Product', params).to_sql).to eq query
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :products, :force => true do |t|
+    t.string :key
+    t.string :title
+    t.timestamps
+  end
+
+  create_table :coupons, :force => true do |t|
+    t.string :title
+    t.timestamps
+  end
+
+  create_table :payments, :force => true do |t|
+    t.string :title
+    t.timestamps
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'searchkon'
+require 'active_record'
+require 'active_support'
+require 'active_support/core_ext'
+require 'rspec'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+load File.dirname(__FILE__) + '/schema.rb'
+require File.dirname(__FILE__) + '/models/coupon.rb'
+require File.dirname(__FILE__) + '/models/payment.rb'
+require File.dirname(__FILE__) + '/models/product.rb'

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: searchkon
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Majid Imanzade
+- Amin Samadzade
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -52,7 +53,49 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: make search easy
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Advanced activerecord search/filter command
 email: majidimanzade1@gmail.com
 executables: []
 extensions: []
@@ -62,14 +105,20 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- elliot-0.0.1.gem
 - lib/searchkon.rb
 - lib/searchkon/filterable.rb
 - lib/searchkon/query_builder.rb
 - lib/searchkon/regex_formatter.rb
 - lib/searchkon/searchables.rb
 - searchkon.gemspec
-homepage: http://github.com/majidimanzade/Helliot
+- spec/filterable_spec.rb
+- spec/models/coupon.rb
+- spec/models/payment.rb
+- spec/models/product.rb
+- spec/query_builder_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: http://github.com/majidimanzade/searchkon
 licenses:
 - MIT
 metadata: {}
@@ -91,5 +140,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Search Command
+summary: Advanced activerecord search/filter command
 test_files: []