search_cop 1.1.0 → 1.2.0

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,4 +1,3 @@
-
 module SearchCop
   class QueryBuilder
     attr_accessor :query_info, :scope, :sql
@@ -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,4 +1,3 @@
-
 module SearchCop
   class Reflection
     attr_accessor :attributes, :options, :aliases, :scope, :generators
@@ -11,11 +10,11 @@ module SearchCop
     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
 
@@ -64,4 +63,3 @@ module SearchCop
     end
   end
 end
-

data/lib/search_cop/version.rb

@@ -1,3 +1,3 @@
 module SearchCop
-  VERSION = "1.1.0"
+  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(" ")
@@ -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,7 +1,8 @@
-
 module SearchCop
   module Visitors
     module Postgres
+      # rubocop:disable Naming/MethodName
+
       class FulltextQuery < Visitor
         def visit_SearchCopGrammar_Nodes_MatchesFulltextNot(node)
           "!'#{node.right.gsub(/[\s&|!:'"]+/, " ")}'"
@@ -21,7 +22,7 @@ module SearchCop
       end
 
       def visit_SearchCopGrammar_Nodes_Matches(node)
-        "(#{visit node.left} IS NOT NULL AND #{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)
@@ -41,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,7 +1,8 @@
-
 module SearchCop
   module Visitors
     class Visitor
+      # rubocop:disable Naming/MethodName
+
       attr_accessor :connection
 
       def initialize(connection)
@@ -48,7 +49,7 @@ module SearchCop
       end
 
       def visit_SearchCopGrammar_Nodes_Matches(node)
-        "(#{visit node.left} IS NOT NULL AND #{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)
@@ -95,7 +96,8 @@ module SearchCop
       alias :visit_Fixnum :quote
       alias :visit_Symbol :quote
       alias :visit_Integer :quote
+
+      # rubocop:enable Naming/MethodName
     end
   end
 end
-

data/lib/search_cop_grammar.rb

@@ -1,4 +1,3 @@
-
 require "search_cop_grammar/attributes"
 require "search_cop_grammar/nodes"
 
@@ -19,7 +18,7 @@ module SearchCopGrammar
     end
 
     def elements
-      super.select { |element| element.class != Treetop::Runtime::SyntaxNode }
+      super.reject { |element| element.instance_of?(Treetop::Runtime::SyntaxNode) }
     end
 
     def collection_for(key)
@@ -153,4 +152,3 @@ module SearchCopGrammar
 
   class Value < BaseNode; end
 end
-

data/lib/search_cop_grammar/attributes.rb

@@ -1,4 +1,3 @@
-
 require "treetop"
 
 module SearchCopGrammar
@@ -28,9 +27,9 @@ module SearchCopGrammar
       end
 
       [:eq, :not_eq, :lt, :lteq, :gt, :gteq].each do |method|
-         define_method method do |value|
-           attributes.collect! { |attribute| attribute.send method, value }.inject(:or)
-         end
+        define_method method do |value|
+          attributes.collect! { |attribute| attribute.send method, value }.inject(:or)
+        end
       end
 
       def generator(generator, value)
@@ -137,7 +136,7 @@ module SearchCopGrammar
         false
       end
 
-      { :eq => "Equality", :not_eq => "NotEqual", :lt => "LessThan", :lteq => "LessThanOrEqual", :gt => "GreaterThan", :gteq => "GreaterThanOrEqual", :matches => "Matches" }.each do |method, class_name|
+      { eq: "Equality", not_eq: "NotEqual", lt: "LessThan", lteq: "LessThanOrEqual", gt: "GreaterThan", gteq: "GreaterThanOrEqual", matches: "Matches" }.each do |method, class_name|
         define_method method do |value|
           raise(SearchCop::IncompatibleDatatype, "Incompatible datatype for #{value}") unless compatible?(value)
 
@@ -146,19 +145,32 @@ module SearchCopGrammar
       end
 
       def method_missing(name, *args, &block)
-        @attribute.send(name, *args, &block)
+        if @attribute.respond_to?(name)
+          @attribute.send(name, *args, &block)
+        else
+          super
+        end
       end
 
-      def respond_to?(*args)
-        super(*args) || @attribute.respond_to?(*args)
+      def respond_to_missing?(*args)
+        @attribute.respond_to?(*args) || super
       end
     end
 
     class String < Base
       def matches_value(value)
-        return value.gsub(/\*/, "%") if (options[:left_wildcard] != false && value.strip =~ /^[^*]+\*$|^\*[^*]+$/) || value.strip =~ /^[^*]+\*$/
+        res = value.gsub(/[%_\\]/) { |char| "\\#{char}" }
 
-        options[:left_wildcard] != false ? "%#{value}%" : "#{value}%"
+        if value.strip =~ /^\*|\*$/
+          res = res.gsub(/^\*/, "%") if options[:left_wildcard] != false
+          res = res.gsub(/\*$/, "%") if options[:right_wildcard] != false
+
+          return res
+        end
+
+        res = "%#{res}" if options[:left_wildcard] != false
+        res = "#{res}%" if options[:right_wildcard] != false
+        res
       end
 
       def matches(value)
@@ -176,7 +188,7 @@ module SearchCopGrammar
 
     class Float < WithoutMatches
       def compatible?(value)
-        return true if value.to_s =~ /^\-?[0-9]+(\.[0-9]+)?$/
+        return true if value.to_s =~ /^-?[0-9]+(\.[0-9]+)?$/
 
         false
       end
@@ -196,24 +208,24 @@ module SearchCopGrammar
 
     class Datetime < WithoutMatches
       def parse(value)
-        return value .. value unless value.is_a?(::String)
+        return value..value unless value.is_a?(::String)
 
         if value =~ /^[0-9]+ (hour|day|week|month|year)s{0,1} (ago)$/
-          number,period,ago = value.split(' ')
+          number, period, ago = value.split(" ")
           time = number.to_i.send(period.to_sym).send(ago.to_sym)
-          time .. ::Time.now
+          time..::Time.now
         elsif value =~ /^[0-9]{4}$/
-          ::Time.new(value).beginning_of_year .. ::Time.new(value).end_of_year
-        elsif value =~ /^([0-9]{4})(\.|-|\/)([0-9]{1,2})$/
-          ::Time.new($1, $3, 15).beginning_of_month .. ::Time.new($1, $3, 15).end_of_month
-        elsif value =~ /^([0-9]{1,2})(\.|-|\/)([0-9]{4})$/
-          ::Time.new($3, $1, 15).beginning_of_month .. ::Time.new($3, $1, 15).end_of_month
-        elsif value =~ /^[0-9]{4}(\.|-|\/)[0-9]{1,2}(\.|-|\/)[0-9]{1,2}$/ || value =~ /^[0-9]{1,2}(\.|-|\/)[0-9]{1,2}(\.|-|\/)[0-9]{4}$/
+          ::Time.new(value).beginning_of_year..::Time.new(value).end_of_year
+        elsif value =~ %r{^([0-9]{4})(\.|-|/)([0-9]{1,2})$}
+          ::Time.new(Regexp.last_match(1), Regexp.last_match(3), 15).beginning_of_month..::Time.new(Regexp.last_match(1), Regexp.last_match(3), 15).end_of_month
+        elsif value =~ %r{^([0-9]{1,2})(\.|-|/)([0-9]{4})$}
+          ::Time.new(Regexp.last_match(3), Regexp.last_match(1), 15).beginning_of_month..::Time.new(Regexp.last_match(3), Regexp.last_match(1), 15).end_of_month
+        elsif value =~ %r{^[0-9]{4}(\.|-|/)[0-9]{1,2}(\.|-|/)[0-9]{1,2}$} || value =~ %r{^[0-9]{1,2}(\.|-|/)[0-9]{1,2}(\.|-|/)[0-9]{4}$}
           time = ::Time.parse(value)
-          time.beginning_of_day .. time.end_of_day
-        elsif value =~ /[0-9]{4}(\.|-|\/)[0-9]{1,2}(\.|-|\/)[0-9]{1,2}/ || value =~ /[0-9]{1,2}(\.|-|\/)[0-9]{1,2}(\.|-|\/)[0-9]{4}/
+          time.beginning_of_day..time.end_of_day
+        elsif value =~ %r{[0-9]{4}(\.|-|/)[0-9]{1,2}(\.|-|/)[0-9]{1,2}} || value =~ %r{[0-9]{1,2}(\.|-|/)[0-9]{1,2}(\.|-|/)[0-9]{4}}
           time = ::Time.parse(value)
-          time .. time
+          time..time
         else
           raise ArgumentError
         end
@@ -246,21 +258,21 @@ module SearchCopGrammar
 
     class Date < Datetime
       def parse(value)
-        return value .. value unless value.is_a?(::String)
+        return value..value unless value.is_a?(::String)
 
         if value =~ /^[0-9]+ (day|week|month|year)s{0,1} (ago)$/
-          number,period,ago = value.split(' ')
+          number, period, ago = value.split(" ")
           time = number.to_i.send(period.to_sym).send(ago.to_sym)
-          time.to_date .. ::Date.today
+          time.to_date..::Date.today
         elsif value =~ /^[0-9]{4}$/
-          ::Date.new(value.to_i).beginning_of_year .. ::Date.new(value.to_i).end_of_year
-        elsif value =~ /^([0-9]{4})(\.|-|\/)([0-9]{1,2})$/
-          ::Date.new($1.to_i, $3.to_i, 15).beginning_of_month .. ::Date.new($1.to_i, $3.to_i, 15).end_of_month
-        elsif value =~ /^([0-9]{1,2})(\.|-|\/)([0-9]{4})$/
-          ::Date.new($3.to_i, $1.to_i, 15).beginning_of_month .. ::Date.new($3.to_i, $1.to_i, 15).end_of_month
-        elsif value =~ /[0-9]{4}(\.|-|\/)[0-9]{1,2}(\.|-|\/)[0-9]{1,2}/ || value =~ /[0-9]{1,2}(\.|-|\/)[0-9]{1,2}(\.|-|\/)[0-9]{4}/
+          ::Date.new(value.to_i).beginning_of_year..::Date.new(value.to_i).end_of_year
+        elsif value =~ %r{^([0-9]{4})(\.|-|/)([0-9]{1,2})$}
+          ::Date.new(Regexp.last_match(1).to_i, Regexp.last_match(3).to_i, 15).beginning_of_month..::Date.new(Regexp.last_match(1).to_i, Regexp.last_match(3).to_i, 15).end_of_month
+        elsif value =~ %r{^([0-9]{1,2})(\.|-|/)([0-9]{4})$}
+          ::Date.new(Regexp.last_match(3).to_i, Regexp.last_match(1).to_i, 15).beginning_of_month..::Date.new(Regexp.last_match(3).to_i, Regexp.last_match(1).to_i, 15).end_of_month
+        elsif value =~ %r{[0-9]{4}(\.|-|/)[0-9]{1,2}(\.|-|/)[0-9]{1,2}} || value =~ %r{[0-9]{1,2}(\.|-|/)[0-9]{1,2}(\.|-|/)[0-9]{4}}
           date = ::Date.parse(value)
-          date .. date
+          date..date
         else
           raise ArgumentError
         end
@@ -281,4 +293,3 @@ module SearchCopGrammar
     end
   end
 end
-

data/lib/search_cop_grammar/nodes.rb

@@ -1,4 +1,3 @@
-
 require "treetop"
 
 module SearchCopGrammar
@@ -187,4 +186,3 @@ module SearchCopGrammar
     end
   end
 end
-

data/search_cop.gemspec

@@ -1,28 +1,28 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'search_cop/version'
+require "search_cop/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "search_cop"
   spec.version       = SearchCop::VERSION
   spec.authors       = ["Benjamin Vetter"]
   spec.email         = ["vetter@flakks.com"]
-  spec.description   = %q{Search engine like fulltext query support for ActiveRecord}
-  spec.summary       = %q{Easily perform complex search engine like fulltext queries on your ActiveRecord models}
+  spec.description   = "Search engine like fulltext query support for ActiveRecord"
+  spec.summary       = "Easily perform complex search engine like fulltext queries on your ActiveRecord models"
   spec.homepage      = "https://github.com/mrkamel/search_cop"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_dependency "treetop"
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "activerecord", ">= 3.0.0"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
 end

data/test/and_test.rb

@@ -1,10 +1,9 @@
-
-require File.expand_path("../test_helper", __FILE__)
+require File.expand_path("test_helper", __dir__)
 
 class AndTest < SearchCop::TestCase
   def test_and_string
-    expected = create(:product, :title => "expected title", :description => "Description")
-    rejected = create(:product, :title => "Rejected title", :description => "Description")
+    expected = create(:product, title: "expected title", description: "Description")
+    rejected = create(:product, title: "Rejected title", description: "Description")
 
     results = Product.search("title: 'Expected title' description: Description")
 
@@ -15,13 +14,12 @@ class AndTest < SearchCop::TestCase
   end
 
   def test_and_hash
-    expected = create(:product, :title => "Expected title", :description => "Description")
-    rejected = create(:product, :title => "Rejected title", :description => "Description")
+    expected = create(:product, title: "Expected title", description: "Description")
+    rejected = create(:product, title: "Rejected title", description: "Description")
 
-    results = Product.search(:and => [{:title => "Expected title"}, {:description => "Description"}])
+    results = Product.search(and: [{ title: "Expected title" }, { description: "Description" }])
 
     assert_includes results, expected
     refute_includes results, rejected
   end
 end
-

data/test/boolean_test.rb

@@ -1,15 +1,14 @@
-
-require File.expand_path("../test_helper", __FILE__)
+require File.expand_path("test_helper", __dir__)
 
 class BooleanTest < SearchCop::TestCase
   def test_mapping
-    product = create(:product, :available => true)
+    product = create(:product, available: true)
 
     assert_includes Product.search("available: 1"), product
     assert_includes Product.search("available: true"), product
     assert_includes Product.search("available: yes"), product
 
-    product = create(:product, :available => false)
+    product = create(:product, available: false)
 
     assert_includes Product.search("available: 0"), product
     assert_includes Product.search("available: false"), product
@@ -17,28 +16,28 @@ class BooleanTest < SearchCop::TestCase
   end
 
   def test_anywhere
-    product = create(:product, :available => true)
+    product = create(:product, available: true)
 
     assert_includes Product.search("true"), product
     refute_includes Product.search("false"), product
   end
 
   def test_includes
-    product = create(:product, :available => true)
+    product = create(:product, available: true)
 
     assert_includes Product.search("available: true"), product
     refute_includes Product.search("available: false"), product
   end
 
   def test_equals
-    product = create(:product, :available => true)
+    product = create(:product, available: true)
 
     assert_includes Product.search("available = true"), product
     refute_includes Product.search("available = false"), product
   end
 
   def test_equals_not
-    product = create(:product, :available => false)
+    product = create(:product, available: false)
 
     assert_includes Product.search("available != true"), product
     refute_includes Product.search("available != false"), product
@@ -50,4 +49,3 @@ class BooleanTest < SearchCop::TestCase
     end
   end
 end
-