searchkon 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3a98b95fd101cdff626be2a58c06db08136f252913bea0951de36291efc6f2
-  data.tar.gz: 38a365ea4287172a83922d2cc44ba1a4cb4182be2376f0d0164ba09b7c27f936
+  metadata.gz: eb893a4d3dc86aa19c3da94c49e4fcb2746931308710ba6a165b5a39290a8cb4
+  data.tar.gz: 18eec74102de5b1ae4d5f07a965f682871f7bdfbff793f1ddf7ced1ea35a7c43
 SHA512:
-  metadata.gz: 973e2e6d10e9b0186487013ca5fa3ffc941875cd02f0a523703e2586cbf031394e8affb182405d4cd6456fb8e7a2d4f34387be5f97c1df3f4f413bb2e67914f8
-  data.tar.gz: 1d225347ce400fe97012cc29f91beb753d0c0b5a3e39147553faa152170b359a35df88466cf88499a082f5ae641f1e0a7f7b81baaba7f3c46998b738a83b3794
+  metadata.gz: d11d1b0d6c13e55e4239f641c8fa65fa2378a2d856ca43d8f2ea09321dac83876258206ca5ee5791ce147a7be8e87acfba768c003116705bc1248b43f941d044
+  data.tar.gz: f09f8209e58b8be30119cc4da86b0e9e9c785e4c2a03f4df3626d5847e341bef6a8aad772133a00337386f415838d04a3c23b1dedd51388252f7c3b59862e274

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/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, @model.searchable_columns)
+        valid_params = validate_params(params[:filters], @model.searchable_columns)
         create_filters valid_params
         @res
       end

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.0'
   s.date        = '2020-05-24'
   s.summary     = "Search Command"
   s.description = "make search easy"
-  s.authors     = ["Majid Imanzade"]
+  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,114 @@
+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
+      {
+        filters: {
+          id: 1,
+          title: 'foobar'
+        }
+      }
+    end
+
+    let (:simple_range_params) do
+      {
+        filters: {
+          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)'
+        }
+      }
+    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 = { filters: { '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] } }
+      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 } }
+      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 = {
+        filters: {
+          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 = {
+        filters: {
+          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 = {
+        filters: {
+          '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.0
 platform: ruby
 authors:
 - Majid Imanzade
+- Amin Samadzade
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -52,6 +53,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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: make search easy
 email: majidimanzade1@gmail.com
 executables: []
@@ -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: {}