searchkon 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c3a98b95fd101cdff626be2a58c06db08136f252913bea0951de36291efc6f2
+  data.tar.gz: 38a365ea4287172a83922d2cc44ba1a4cb4182be2376f0d0164ba09b7c27f936
+SHA512:
+  metadata.gz: 973e2e6d10e9b0186487013ca5fa3ffc941875cd02f0a523703e2586cbf031394e8affb182405d4cd6456fb8e7a2d4f34387be5f97c1df3f4f413bb2e67914f8
+  data.tar.gz: 1d225347ce400fe97012cc29f91beb753d0c0b5a3e39147553faa152170b359a35df88466cf88499a082f5ae641f1e0a7f7b81baaba7f3c46998b738a83b3794

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+doc/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 majid imanzade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+Hello

data/lib/searchkon.rb

@@ -0,0 +1,4 @@
+require 'searchkon/filterable'
+require 'searchkon/regex_formatter'
+require 'searchkon/searchables'
+require 'searchkon/query_builder'

data/lib/searchkon/filterable.rb

@@ -0,0 +1,60 @@
+module Searchkon
+  module Filterable
+
+    def validate_params filters, model_filterables
+      valid_params = []
+      unless filters.blank?
+        valid_params.concat formatted_simple_params(model_filterables, filters)
+        valid_params.concat formatted_fulltext_params(model_filterables, filters)
+      end
+      valid_params
+    end
+  private
+
+    def formatted_simple_params model_filterables, filters
+      valid_params = []
+      model_filterables.each do |scope, columns|
+        columns.each do |column|
+          value_of_column = filters[column.to_sym]
+
+          value_of_column.reject! { |c| c.blank? } if value_of_column.kind_of?(Array)
+          next if value_of_column.blank?
+          next unless valid_range? value_of_column
+
+          valid_params.push({value: value_of_column, key: column, scope: scope}) if filters.include?(column.to_sym)
+        end
+      end
+      valid_params
+    end
+
+    def valid_range? value
+      if range? value
+        return (date_range?(value) or digit_range?(value))
+      end
+      true
+    end
+
+    def formatted_fulltext_params model_filterables, filters
+      valid_params = []
+      filters.each do |key, value|
+        if key.to_s.include? ','
+          valid_keys = validate_fulltext_keys key, model_filterables
+          valid_params.push({value: value, key: valid_keys, scope: :fulltext}) unless valid_keys.blank?
+        end
+      end
+      valid_params
+    end
+
+    def validate_fulltext_keys keys, model_filterables
+      valid_params = []
+      return if keys.blank?
+
+      keys.to_s.split(',')&.each do |key|
+        valid_params << key if model_filterables[:like].include?(key)
+      end
+
+      return if valid_params.blank?
+      valid_params.join(',')
+    end
+  end
+end

data/lib/searchkon/query_builder.rb

@@ -0,0 +1,83 @@
+module Searchkon
+  class QueryBuilder
+    class << self
+      include Searchkon::Filterable
+      include Searchkon::RegexFormatter
+
+      def filter model, params = {}
+        @model = model.constantize
+        @res = @model.all
+        valid_params = validate_params(params, @model.searchable_columns)
+        create_filters valid_params
+        @res
+      end
+
+      private
+
+        def create_filters valid_params
+          valid_params.each do |filter|
+            if(filter[:scope] == :fulltext)
+              fulltext_query filter[:key], filter[:value]
+            elsif(relational? filter[:key])
+              relation_query filter[:key]
+              where_query filter[:key], filter[:value], filter[:scope]
+            elsif(range? filter[:value])
+              range_query filter[:key], filter[:value]
+            else
+              where_query filter[:key], filter[:value], filter[:scope]
+            end
+          end
+        end
+
+        def fulltext_query key, value
+          query = ""
+          keys = key.to_s.split(',')
+          keys.each do |fulltext_key|
+            relation_query fulltext_key if(relational? fulltext_key)
+            query << " or " unless query.blank?
+            if relational? fulltext_key
+              relations = relation_values fulltext_key
+              table_name = get_relation_table_name relations.relation
+              query << "#{table_name}.#{relations.key} like :value"
+            else
+              query << "#{@model.table_name}.#{fulltext_key} like :value"
+            end
+          end
+          @res = @res.where(query, {value: "%#{value}%"})
+        end
+
+        def where_query key, value, scope
+          exact_query key, value if scope == :exact
+          like_query key, value if scope == :like
+        end
+
+        def like_query key, value
+          if(relational? key)
+            relations = relation_values key
+            table_name = get_relation_table_name relations.relation
+            @res = @res.where("#{table_name}.#{relations.key} like ?", "%#{value}%")
+          else
+            @res = @res.where("#{@model.table_name}.#{key} like ?", "%#{value}%")
+          end
+        end
+
+        def exact_query key, value
+          @res = @res.where(key => value)
+        end
+
+        def range_query key, value
+          range = range_values value
+          @res = @res.where("#{@model.table_name}.#{key} between ? and ?", range.from, range.to)
+        end
+
+        def relation_query key
+          relations = relation_values key
+          @res = @res.joins(relations.relation.to_sym)
+        end
+
+        def get_relation_table_name relation
+          @model.reflect_on_all_associations.detect { |association| association.name == relation.to_sym }.table_name
+        end
+    end
+  end
+end

data/lib/searchkon/regex_formatter.rb

@@ -0,0 +1,40 @@
+module Searchkon
+  module RegexFormatter
+    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})\)/
+
+  def relational? value
+    value.to_s.match RELATIONAL_FORMAT_REGEX
+  end
+
+  def range? value
+    value.to_s.match SIMPLE_RANGE_FORMAT_REGEX
+  end
+
+  def date_range? value
+    value.to_s.match DATE_RANGE_FORMAT_REGEX
+  end
+
+  def digit_range? value
+    value.to_s.match DIGIT_RANGE_FORMAT_REGEX
+  end
+
+  def range_values value
+    struct = Struct.new :from, :to
+    regex_match value, SIMPLE_RANGE_FORMAT_REGEX, struct
+  end
+
+  def relation_values value
+    struct = Struct.new :relation, :key
+    regex_match value, RELATIONAL_FORMAT_REGEX, struct
+  end
+
+  private
+
+    def regex_match value, pattern, struct
+      value.to_s.match(pattern) { |m| struct.new(*m.captures) }
+    end
+  end
+end

data/lib/searchkon/searchables.rb

@@ -0,0 +1,7 @@
+module Searchkon
+  module Searchables
+    def searchable_columns
+      self.column_names
+    end
+  end
+end

data/searchkon.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'searchkon'
+  s.version     = '0.1.1'
+  s.date        = '2020-05-24'
+  s.summary     = "Search Command"
+  s.description = "make search easy"
+  s.authors     = ["Majid Imanzade"]
+  s.email       = 'majidimanzade1@gmail.com'
+  s.homepage    = 'https://rubygems.org/gems/Helliot'
+  s.homepage    = "http://github.com/majidimanzade/Helliot"
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.add_development_dependency("bundler")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec")
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: searchkon
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Majid Imanzade
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rspec
+  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'
+description: make search easy
+email: majidimanzade1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Search Command
+test_files: []