search_cop 1.1.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf37a33f6c9998a09a09817fe5f14024947a1f83ed63682c066dcf35c385ac57
-  data.tar.gz: 36df6f6110f2126240702636d93c0ed54322794ff5f558fa6dcb27484c3b2b28
+  metadata.gz: ebdc7756338ed85d56d22c0e350930651f3776f75bcf027f27a95a994b7e3955
+  data.tar.gz: 9f56f6e8b3fb01533ce3e938cd9fb32476970789baf6e6d9a0752e21c125f71d
 SHA512:
-  metadata.gz: 4c5233ee11b096ec18e1a53f1e76a6dbb0880a99de9ac41ec836993f317612cf728d81a1332c3f7bfeb42766cb7e28e388061d85cabec8355e7c32e969468761
-  data.tar.gz: f766262804751519e3566ea80af0358dba148540883d74b5947804e70876ae90555dcb539032f5e59ff1d64fb03b6b10e293e487842b47eeea31246c14a69024
+  metadata.gz: c570e77317b1b19d28edb11e9b8d3fe34c08d81f0ddf929efd043da51bda078c60139bc4f27c5e62c31c0fbd5a1b8e21245ec8aae03ebcc2b163d0f5e7570e22
+  data.tar.gz: 3d1b6708a2c114271ea733fd245f73ed5be1c577d2140d2a46107dd81a082e5ac9111a8e06151aa185b31c490af1d7f2feb5fd9b7527661b525faa4c48d724f9

data/.github/workflows/test.yml

@@ -0,0 +1,50 @@
+name: test
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
+        rails: ["rails5", "rails6", "rails7"]
+        database: ["sqlite", "postgres", "mysql"]
+        exclude:
+          - ruby: "3.0"
+            rails: "rails5"
+          - ruby: "3.1"
+            rails: "rails5"
+          - ruby: "2.6"
+            rails: "rails7"
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: search_cop
+          POSTGRES_PASSWORD: secret
+          POSTGRES_DB: search_cop
+        ports:
+          - 5432:5432
+      mysql:
+        image: mysql
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+          MYSQL_ROOT_PASSWORD: ""
+          MYSQL_DATABASE: search_cop
+        ports:
+          - 3306:3306
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: test
+        env:
+          DATABASE: ${{ matrix.database }}
+        run: |
+          gem install bundler
+          bundle config set --local gemfile "gemfiles/${{ matrix.rails }}.gemfile"
+          bundle config set --local path "../vendor/bundle"
+          bundle install
+          bundle exec rake test
+          bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,134 @@
+AllCops:
+  NewCops: enable
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Style/FetchEnvVar:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/CaseLikeIf:
+  Enabled: false
+
+Style/RedundantArgument:
+  Enabled: false
+
+Lint/EmptyBlock:
+  Enabled: false
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Lint/RedundantRequireStatement:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  EnforcedStyle: use_english_names
+
+Security/Eval:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Alias:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/ClassLength:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Layout/RescueEnsureAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Naming/ConstantName:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false

data/CHANGELOG.md

@@ -1,15 +1,29 @@
 
 # Changelog
 
+Version 1.2.2:
+
+* Fix table name for namespaced models #70
+
+Version 1.2.1:
+
+* Fix use of `table_name` to work with inherited models
+* Fix linter, add ruby 3 and rails 7 to ci pipeline
+
 Version 1.2.0:
 
+* Added support for disabling the right wildcard
+* Fixed escaping of wildcard chars (`_`, `%`)
+
+Version 1.1.0:
+
 * Adds customizable default operator to concatenate conditions (#49)
 * Make the postgis adapter use the postgres extensions
 
 Version 1.0.9:
 
-* Use [:blank:] instead of \s for space (#46)
-* Updated SearchCop::Visitors::Visitor to check the connection's adapter_name when extending. (#47)
+* Use `[:blank:]` instead of `\s` for space (#46)
+* Updated `SearchCop::Visitors::Visitor` to check the connection's `adapter_name` when extending. (#47)
 * Fix for negative numeric values
 * allow searching for relative dates, like hours, days, weeks, months or years ago
 
@@ -19,8 +33,8 @@ Version 1.0.8:
 
 Version 1.0.7:
 
-* Bugfix regarding NOT queries in fulltext mode #32
-* Safely handle NULL values for match queries
+* Bugfix regarding `NOT` queries in fulltext mode #32
+* Safely handle `NULL` values for match queries
 * Added coalesce option
 
 Version 1.0.6:
@@ -58,7 +72,7 @@ Version 1.0.0:
 
 Version 0.0.5:
 
-* Supporting :default => false
+* Supporting `:default => false`
 * Datetime/Date greater operator fix
 * Use reflection to find associated models
 * Providing reflection
@@ -67,16 +81,16 @@ Version 0.0.4:
 
 * Fixed date attributes
 * Fail softly for mixed datatype attributes
-* Support custom table, class and alias names via attr_searchable_alias
+* Support custom table, class and alias names via `attr_searchable_alias`
 
 Version 0.0.3:
 
-* belongs_to association fixes
+* `belongs_to` association fixes
 
 Version 0.0.2:
 
 * Arel abstraction layer added
-* count() queries resulting in "Cannot visit AttrSearchableGrammar::Nodes..." fixed
+* `count()` queries resulting in "Cannot visit AttrSearchableGrammar::Nodes..." fixed
 * Better error messages
-* Model#unsafe_search added
+* `Model#unsafe_search` added
 

data/Gemfile

@@ -1,11 +1,10 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in search_cop.gemspec
 gemspec
 
 platforms :ruby do
-  gem 'sqlite3'
-  gem 'mysql2'
-  gem 'pg'
+  gem "mysql2"
+  gem "pg"
+  gem "sqlite3"
 end
-

data/README.md

@@ -1,6 +1,6 @@
 # SearchCop
 
-[![Build Status](https://secure.travis-ci.org/mrkamel/search_cop.png?branch=master)](http://travis-ci.org/mrkamel/search_cop)
+[![Build Status](https://github.com/mrkamel/search_cop/workflows/test/badge.svg?branch=master)](https://github.com/mrkamel/search_cop/actions?query=workflow%3Atest)
 [![Code Climate](https://codeclimate.com/github/mrkamel/search_cop.png)](https://codeclimate.com/github/mrkamel/search_cop)
 [![Gem Version](https://badge.fury.io/rb/search_cop.svg)](http://badge.fury.io/rb/search_cop)
 
@@ -329,6 +329,16 @@ User.search("admin")
 # ... WHERE users.username LIKE 'admin%'
 ```
 
+Similarly, you can disable the right wildcard as well:
+
+```ruby
+search_scope :search do
+  attributes :username
+
+  options :username, right_wildcard: false
+end
+```
+
 ## Default operator
 
 When you define multiple fields on a search scope, SearcCop will use

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

@@ -8,4 +8,11 @@ services:
       - 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/{5.1.gemfile → rails5.gemfile}

@@ -5,9 +5,9 @@ source "https://rubygems.org"
 gem "activerecord", "~> 5.1"
 
 platforms :ruby do
-  gem "sqlite3"
   gem "mysql2"
   gem "pg"
+  gem "sqlite3"
 end
 
-gemspec :path => "../"
+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/gemfiles/rails7.gemfile

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

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
@@ -20,4 +19,3 @@ module SearchCop
     end
   end
 end
-

data/lib/search_cop/hash_parser.rb

@@ -1,4 +1,3 @@
-
 class SearchCop::HashParser
   attr_reader :query_info
 
@@ -6,25 +5,25 @@ class SearchCop::HashParser
     @query_info = query_info
   end
 
-  def parse(hash)
-    default_operator = SearchCop::Helpers.sanitize_default_operator(hash, true)
+  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 default_operator
+    res.inject(default_operator)
   end
 
   private
@@ -35,14 +34,15 @@ class SearchCop::HashParser
     if value.is_a?(Hash)
       raise(SearchCop::ParseError, "Unknown operator #{value.keys.first}") unless collection.valid_operator?(value.keys.first)
 
-      if generator = collection.generator_for(value.keys.first)
-        collection.generator generator, value.values.first
+      generator = collection.generator_for(value.keys.first)
+
+      if generator
+        collection.generator(generator, value.values.first)
       else
-        collection.send value.keys.first, value.values.first.to_s
+        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,4 +1,3 @@
-
 module SearchCop
   class QueryBuilder
     attr_accessor :query_info, :scope, :sql
@@ -13,7 +12,7 @@ module SearchCop
     end
 
     def associations
-      all_associations - [query_info.model.name.tableize.to_sym]
+      all_associations - [query_info.model.table_name.to_sym]
     end
 
     private
@@ -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
 
@@ -56,7 +55,7 @@ module SearchCop
     def attributes_hash(hash)
       hash.each do |key, value|
         reflection.attributes[key.to_s] = Array(value).collect do |column|
-          table, attribute = column.to_s =~ /\./ ? column.to_s.split(".") : [model.name.tableize, column]
+          table, attribute = column.to_s =~ /\./ ? column.to_s.split(".") : [model.table_name, column]
 
           "#{table}.#{attribute}"
         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.2"
 end

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/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.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"
@@ -23,7 +23,7 @@ module SearchCop
   module Parser
     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, query_options)
       end
@@ -44,8 +44,8 @@ module SearchCop
       search_scopes[name] = SearchScope.new(name, self)
       search_scopes[name].instance_exec(&block)
 
-      self.send(:define_singleton_method, name) { |query, query_options={}| search_cop query, name, query_options }
-      self.send(:define_singleton_method, "unsafe_#{name}") { |query, query_options={}| unsafe_search_cop query, name, query_options }
+      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)
@@ -53,7 +53,7 @@ module SearchCop
     end
 
     def search_cop(query, scope_name, query_options)
-      unsafe_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
@@ -69,22 +69,4 @@ module SearchCop
       (scope || self).where(query_builder.sql)
     end
   end
-
-  module Helpers
-    def self.sanitize_default_operator(hash, delete_hash_option=false)
-      default_operator = :and
-      if hash.member?(:default_operator)
-        unless [:and, :or].include?(hash[:default_operator])
-          raise(SearchCop::UnknownDefaultOperator, "Unknown default operator value #{hash[:default_operator]}")
-        end
-
-        default_operator = hash[:default_operator]
-      end
-
-      hash.delete(:default_operator) if delete_hash_option
-
-      default_operator
-    end
-  end
 end
-