search_cop 1.0.6 → 1.2.0

data/Rakefile

@@ -6,4 +6,3 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end
-

data/docker-compose.yml

@@ -0,0 +1,18 @@
+
+version: '2' 
+services:
+  mysql:
+    image: percona:5.7
+    environment:
+      - MYSQL_ALLOW_EMPTY_PASSWORD=yes
+      - MYSQL_ROOT_PASSWORD=
+    ports:
+      - 3306:3306
+  postgres:
+    image: postgres:9.6.6
+    environment:
+      POSTGRES_DB: search_cop
+      POSTGRES_USER: search_cop
+      POSTGRES_PASSWORD: secret
+    ports:
+      - 5432:5432

data/gemfiles/rails5.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1"
+
+platforms :ruby do
+  gem "mysql2"
+  gem "pg"
+  gem "sqlite3"
+end
+
+gemspec path: "../"

data/gemfiles/rails6.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0"
+
+platforms :ruby do
+  gem "mysql2"
+  gem "pg"
+  gem "sqlite3"
+end
+
+gemspec path: "../"

data/lib/search_cop.rb

@@ -1,5 +1,5 @@
-
 require "search_cop/version"
+require "search_cop/helpers"
 require "search_cop/search_scope"
 require "search_cop/query_info"
 require "search_cop/query_builder"
@@ -8,21 +8,24 @@ require "search_cop/hash_parser"
 require "search_cop/visitors"
 
 module SearchCop
-  class SpecificationError < StandardError; end
+  class Error < StandardError; end
+
+  class SpecificationError < Error; end
   class UnknownAttribute < SpecificationError; end
+  class UnknownDefaultOperator < SpecificationError; end
 
-  class RuntimeError < StandardError; end
+  class RuntimeError < Error; end
   class UnknownColumn < RuntimeError; end
   class NoSearchableAttributes < RuntimeError; end
   class IncompatibleDatatype < RuntimeError; end
   class ParseError < RuntimeError; end
 
   module Parser
-    def self.parse(query, query_info)
+    def self.parse(query, query_info, query_options = {})
       if query.is_a?(Hash)
-        SearchCop::HashParser.new(query_info).parse(query)
+        SearchCop::HashParser.new(query_info).parse(query, query_options)
       else
-        SearchCop::GrammarParser.new(query_info).parse(query)
+        SearchCop::GrammarParser.new(query_info).parse(query, query_options)
       end
     end
   end
@@ -41,24 +44,24 @@ module SearchCop
       search_scopes[name] = SearchScope.new(name, self)
       search_scopes[name].instance_exec(&block)
 
-      self.class.send(:define_method, name) { |query| search_cop query, name }
-      self.class.send(:define_method, "unsafe_#{name}") { |query| unsafe_search_cop query, name }
+      send(:define_singleton_method, name) { |query, query_options = {}| search_cop(query, name, query_options) }
+      send(:define_singleton_method, "unsafe_#{name}") { |query, query_options = {}| unsafe_search_cop(query, name, query_options) }
     end
 
     def search_reflection(scope_name)
       search_scopes[scope_name].reflection
     end
 
-    def search_cop(query, scope_name)
-      unsafe_search_cop query, scope_name
+    def search_cop(query, scope_name, query_options)
+      unsafe_search_cop(query, scope_name, query_options)
     rescue SearchCop::RuntimeError
       respond_to?(:none) ? none : where("1 = 0")
     end
 
-    def unsafe_search_cop(query, scope_name)
+    def unsafe_search_cop(query, scope_name, query_options)
       return respond_to?(:scoped) ? scoped : all if query.blank?
 
-      query_builder = QueryBuilder.new(self, query, search_scopes[scope_name])
+      query_builder = QueryBuilder.new(self, query, search_scopes[scope_name], query_options)
 
       scope = instance_exec(&search_scopes[scope_name].reflection.scope) if search_scopes[scope_name].reflection.scope
       scope ||= eager_load(query_builder.associations) if query_builder.associations.any?
@@ -67,4 +70,3 @@ module SearchCop
     end
   end
 end
-

data/lib/search_cop/grammar_parser.rb

@@ -1,8 +1,7 @@
-
 require "search_cop_grammar"
 require "treetop"
 
-Treetop.load File.expand_path("../../search_cop_grammar.treetop", __FILE__)
+Treetop.load File.expand_path("../search_cop_grammar.treetop", __dir__)
 
 module SearchCop
   class GrammarParser
@@ -12,11 +11,11 @@ module SearchCop
       @query_info = query_info
     end
 
-    def parse(string)
+    def parse(string, query_options)
       node = SearchCopGrammarParser.new.parse(string) || raise(ParseError)
       node.query_info = query_info
+      node.query_options = query_options
       node.evaluate
     end
   end
 end
-

data/lib/search_cop/hash_parser.rb

@@ -1,4 +1,3 @@
-
 class SearchCop::HashParser
   attr_reader :query_info
 
@@ -6,23 +5,25 @@ class SearchCop::HashParser
     @query_info = query_info
   end
 
-  def parse(hash)
+  def parse(hash, query_options = {})
+    default_operator = SearchCop::Helpers.sanitize_default_operator(query_options)
+
     res = hash.collect do |key, value|
       case key
-        when :and
-          value.collect { |val| parse val }.inject(:and)
-        when :or
-          value.collect { |val| parse val }.inject(:or)
-        when :not
-          parse(value).not
-        when :query
-          SearchCop::Parser.parse value, query_info
-        else
-          parse_attribute key, value
+      when :and
+        value.collect { |val| parse val }.inject(:and)
+      when :or
+        value.collect { |val| parse val }.inject(:or)
+      when :not
+        parse(value).not
+      when :query
+        SearchCop::Parser.parse(value, query_info)
+      else
+        parse_attribute(key, value)
       end
     end
 
-    res.inject :and
+    res.inject(default_operator)
   end
 
   private
@@ -31,12 +32,17 @@ class SearchCop::HashParser
     collection = SearchCopGrammar::Attributes::Collection.new(query_info, key.to_s)
 
     if value.is_a?(Hash)
-      raise(SearchCop::ParseError, "Unknown operator #{value.keys.first}") unless [:matches, :eq, :not_eq, :gt, :gteq, :lt, :lteq].include?(value.keys.first)
+      raise(SearchCop::ParseError, "Unknown operator #{value.keys.first}") unless collection.valid_operator?(value.keys.first)
+
+      generator = collection.generator_for(value.keys.first)
 
-      collection.send value.keys.first, value.values.first.to_s
+      if generator
+        collection.generator(generator, value.values.first)
+      else
+        collection.send(value.keys.first, value.values.first.to_s)
+      end
     else
-      collection.send :matches, value.to_s
+      collection.send(:matches, value.to_s)
     end
   end
 end
-

data/lib/search_cop/helpers.rb

@@ -0,0 +1,15 @@
+module SearchCop
+  module Helpers
+    def self.sanitize_default_operator(query_options)
+      return "and" unless query_options.key?(:default_operator)
+
+      default_operator = query_options[:default_operator].to_s.downcase
+
+      unless ["and", "or"].include?(default_operator)
+        raise(SearchCop::UnknownDefaultOperator, "Unknown default operator value #{default_operator}")
+      end
+
+      default_operator
+    end
+  end
+end

data/lib/search_cop/query_builder.rb

@@ -1,13 +1,12 @@
-
 module SearchCop
   class QueryBuilder
     attr_accessor :query_info, :scope, :sql
 
-    def initialize(model, query, scope)
+    def initialize(model, query, scope, query_options)
       self.scope = scope
       self.query_info = QueryInfo.new(model, scope)
 
-      arel = SearchCop::Parser.parse(query, query_info).optimize!
+      arel = SearchCop::Parser.parse(query, query_info, query_options).optimize!
 
       self.sql = SearchCop::Visitors::Visitor.new(model.connection).visit(arel)
     end
@@ -32,4 +31,3 @@ module SearchCop
     end
   end
 end
-

data/lib/search_cop/query_info.rb

@@ -1,4 +1,3 @@
-
 module SearchCop
   class QueryInfo
     attr_accessor :model, :scope, :references
@@ -10,4 +9,3 @@ module SearchCop
     end
   end
 end
-

data/lib/search_cop/search_scope.rb

@@ -1,20 +1,20 @@
-
 module SearchCop
   class Reflection
-    attr_accessor :attributes, :options, :aliases, :scope
+    attr_accessor :attributes, :options, :aliases, :scope, :generators
 
     def initialize
       self.attributes = {}
       self.options = {}
       self.aliases = {}
+      self.generators = {}
     end
 
     def default_attributes
-      keys = options.select { |key, value| value[:default] == true }.keys
+      keys = options.select { |_key, value| value[:default] == true }.keys
       keys = attributes.keys.reject { |key| options[key] && options[key][:default] == false } if keys.empty?
       keys = keys.to_set
 
-      attributes.select { |key, value| keys.include? key }
+      attributes.select { |key, _value| keys.include? key }
     end
   end
 
@@ -46,6 +46,10 @@ module SearchCop
       reflection.scope = block
     end
 
+    def generator(name, &block)
+      reflection.generators[name] = block
+    end
+
     private
 
     def attributes_hash(hash)
@@ -59,4 +63,3 @@ module SearchCop
     end
   end
 end
-

data/lib/search_cop/version.rb

@@ -1,3 +1,3 @@
 module SearchCop
-  VERSION = "1.0.6"
+  VERSION = "1.2.0"
 end

data/lib/search_cop/visitors.rb

@@ -1,5 +1,3 @@
-
 require "search_cop/visitors/visitor"
 require "search_cop/visitors/mysql"
 require "search_cop/visitors/postgres"
-

data/lib/search_cop/visitors/mysql.rb

@@ -1,7 +1,8 @@
-
 module SearchCop
   module Visitors
     module Mysql
+      # rubocop:disable Naming/MethodName
+
       class FulltextQuery < Visitor
         def visit_SearchCopGrammar_Nodes_MatchesFulltextNot(node)
           node.right.split(/[\s+'"<>()~-]+/).collect { |word| "-#{word}" }.join(" ")
@@ -14,11 +15,11 @@ module SearchCop
         end
 
         def visit_SearchCopGrammar_Nodes_And_Fulltext(node)
-          res = node.nodes.collect do |node|
-            if node.is_a?(SearchCopGrammar::Nodes::MatchesFulltextNot)
-              visit node
+          res = node.nodes.collect do |child_node|
+            if child_node.is_a?(SearchCopGrammar::Nodes::MatchesFulltextNot)
+              visit child_node
             else
-              node.nodes.size > 1 ? "+(#{visit node})" : "+#{visit node}"
+              child_node.nodes.size > 1 ? "+(#{visit child_node})" : "+#{visit child_node}"
             end
           end
 
@@ -26,7 +27,7 @@ module SearchCop
         end
 
         def visit_SearchCopGrammar_Nodes_Or_Fulltext(node)
-          node.nodes.collect { |node| "(#{visit node})" }.join(" ")
+          node.nodes.collect { |child_node| "(#{visit child_node})" }.join(" ")
         end
       end
 
@@ -38,6 +39,7 @@ module SearchCop
         "MATCH(#{visit node.collection}) AGAINST(#{visit FulltextQuery.new(connection).visit(node.node)} IN BOOLEAN MODE)"
       end
     end
+
+    # rubocop:enable Naming/MethodName
   end
 end
-

data/lib/search_cop/visitors/postgres.rb

@@ -1,31 +1,40 @@
-
 module SearchCop
   module Visitors
     module Postgres
+      # rubocop:disable Naming/MethodName
+
       class FulltextQuery < Visitor
         def visit_SearchCopGrammar_Nodes_MatchesFulltextNot(node)
-          "!'#{node.right.gsub /[\s&|!:'"]+/, " "}'"
+          "!'#{node.right.gsub(/[\s&|!:'"]+/, " ")}'"
         end
 
         def visit_SearchCopGrammar_Nodes_MatchesFulltext(node)
-          "'#{node.right.gsub /[\s&|!:'"]+/, " "}'"
+          "'#{node.right.gsub(/[\s&|!:'"]+/, " ")}'"
         end
 
         def visit_SearchCopGrammar_Nodes_And_Fulltext(node)
-          node.nodes.collect { |node| "(#{visit node})" }.join(" & ")
+          node.nodes.collect { |child_node| "(#{visit child_node})" }.join(" & ")
         end
 
         def visit_SearchCopGrammar_Nodes_Or_Fulltext(node)
-          node.nodes.collect { |node| "(#{visit node})" }.join(" | ")
+          node.nodes.collect { |child_node| "(#{visit child_node})" }.join(" | ")
         end
       end
 
       def visit_SearchCopGrammar_Nodes_Matches(node)
-        "#{visit node.left} ILIKE #{visit node.right}"
+        "(#{visit node.left} IS NOT NULL AND #{visit node.left} ILIKE #{visit node.right} ESCAPE #{visit "\\"})"
       end
 
       def visit_SearchCopGrammar_Attributes_Collection(node)
-        node.attributes.collect { |attribute| visit attribute }.join(" || ' ' || ")
+        res = node.attributes.collect do |attribute|
+          if attribute.options[:coalesce]
+            "COALESCE(#{visit attribute}, '')"
+          else
+            visit attribute
+          end
+        end
+
+        res.join(" || ' ' || ")
       end
 
       def visit_SearchCopGrammar_Nodes_FulltextExpression(node)
@@ -33,7 +42,8 @@ module SearchCop
 
         "to_tsvector(#{visit dictionary}, #{visit node.collection}) @@ to_tsquery(#{visit dictionary}, #{visit FulltextQuery.new(connection).visit(node.node)})"
       end
+
+      # rubocop:enable Naming/MethodName
     end
   end
 end
-

data/lib/search_cop/visitors/visitor.rb

@@ -1,18 +1,19 @@
-
 module SearchCop
   module Visitors
     class Visitor
+      # rubocop:disable Naming/MethodName
+
       attr_accessor :connection
 
       def initialize(connection)
         @connection = connection
 
-        extend(SearchCop::Visitors::Mysql) if @connection.class.name =~ /mysql/i
-        extend(SearchCop::Visitors::Postgres) if @connection.class.name =~ /postgres/i
+        extend(SearchCop::Visitors::Mysql) if @connection.adapter_name =~ /mysql/i
+        extend(SearchCop::Visitors::Postgres) if @connection.adapter_name =~ /postgres|postgis/i
       end
 
       def visit(visit_node = node)
-        send "visit_#{visit_node.class.name.gsub /::/, "_"}", visit_node
+        send "visit_#{visit_node.class.name.gsub(/::/, "_")}", visit_node
       end
 
       def visit_SearchCopGrammar_Nodes_And(node)
@@ -48,13 +49,17 @@ module SearchCop
       end
 
       def visit_SearchCopGrammar_Nodes_Matches(node)
-        "#{visit node.left} LIKE #{visit node.right}"
+        "(#{visit node.left} IS NOT NULL AND #{visit node.left} LIKE #{visit node.right} ESCAPE #{visit "\\"})"
       end
 
       def visit_SearchCopGrammar_Nodes_Not(node)
         "NOT (#{visit node.object})"
       end
 
+      def visit_SearchCopGrammar_Nodes_Generator(node)
+        instance_exec visit(node.left), node.right[:value], &node.right[:generator]
+      end
+
       def quote_table_name(name)
         connection.quote_table_name name
       end
@@ -90,7 +95,9 @@ module SearchCop
       alias :visit_Float :quote
       alias :visit_Fixnum :quote
       alias :visit_Symbol :quote
+      alias :visit_Integer :quote
+
+      # rubocop:enable Naming/MethodName
     end
   end
 end
-