search_cop 1.0.9 → 1.2.1

data/test/search_cop_test.rb

@@ -1,41 +1,40 @@
-
-require File.expand_path("../test_helper", __FILE__)
+require File.expand_path("test_helper", __dir__)
 
 class SearchCopTest < SearchCop::TestCase
   def test_scope_before
-    expected = create(:product, :stock => 1, :title => "Title")
-    rejected = create(:product, :stock => 0, :title => "Title")
+    expected = create(:product, stock: 1, title: "Title")
+    rejected = create(:product, stock: 0, title: "Title")
 
-    results = Product.where(:stock => 1).search("Title")
+    results = Product.where(stock: 1).search("Title")
 
     assert_includes results, expected
     refute_includes results, rejected
   end
 
   def test_scope_after
-    expected = create(:product, :stock => 1, :title => "Title")
-    rejected = create(:product, :stock => 0, :title => "Title")
+    expected = create(:product, stock: 1, title: "Title")
+    rejected = create(:product, stock: 0, title: "Title")
 
-    results = Product.search("Title").where(:stock => 1)
+    results = Product.search("Title").where(stock: 1)
 
     assert_includes results, expected
     refute_includes results, rejected
   end
 
   def test_scope
-    expected = create(:product, :stock => 1, :title => "Title")
-    rejected = create(:product, :stock => 0, :title => "Title")
+    expected = create(:product, stock: 1, title: "Title")
+    rejected = create(:product, stock: 0, title: "Title")
 
-    results = with_scope(Product.search_scopes[:search], lambda { where :stock => 1 }) { Product.search("title: Title") }
+    results = with_scope(Product.search_scopes[:search], -> { where stock: 1 }) { Product.search("title: Title") }
 
     assert_includes results, expected
     refute_includes results, rejected
   end
 
   def test_multi_associations
-    product = create(:product, :comments => [
-      create(:comment, :title => "Title1", :message => "Message1"),
-      create(:comment, :title => "Title2", :message => "Message2")
+    product = create(:product, comments: [
+      create(:comment, title: "Title1", message: "Message1"),
+      create(:comment, title: "Title2", message: "Message2")
     ])
 
     assert_includes Product.search("comment: Title1 comment: Message1"), product
@@ -43,8 +42,8 @@ class SearchCopTest < SearchCop::TestCase
   end
 
   def test_single_association
-    expected = create(:comment, :user => create(:user, :username => "Expected"))
-    rejected = create(:comment, :user => create(:user, :username => "Rejected"))
+    expected = create(:comment, user: create(:user, username: "Expected"))
+    rejected = create(:comment, user: create(:user, username: "Rejected"))
 
     results = Comment.search("user: Expected")
 
@@ -53,8 +52,8 @@ class SearchCopTest < SearchCop::TestCase
   end
 
   def test_deep_associations
-    expected = create(:product, :comments => [create(:comment, :user => create(:user, :username => "Expected"))])
-    rejected = create(:product, :comments => [create(:comment, :user => create(:user, :username => "Rejected"))])
+    expected = create(:product, comments: [create(:comment, user: create(:user, username: "Expected"))])
+    rejected = create(:product, comments: [create(:comment, user: create(:user, username: "Rejected"))])
 
     results = Product.search("user: Expected")
 
@@ -62,16 +61,25 @@ class SearchCopTest < SearchCop::TestCase
     refute_includes results, rejected
   end
 
+  def test_inherited_model
+    expected = create(:available_product, comments: [create(:comment, user: create(:user, username: "Expected"))])
+    rejected = create(:available_product, comments: [create(:comment, user: create(:user, username: "Rejected"))])
+
+    results = AvailableProduct.search("user: Expected")
+    assert_includes results, expected
+    refute_includes results, rejected
+  end
+
   def test_multiple
-    product = create(:product, :comments => [create(:comment, :title => "Title", :message => "Message")])
+    product = create(:product, comments: [create(:comment, title: "Title", message: "Message")])
 
     assert_includes Product.search("comment: Title"), product
     assert_includes Product.search("comment: Message"), product
   end
 
   def test_default
-    product1 = create(:product, :title => "Expected")
-    product2 = create(:product, :description => "Expected")
+    product1 = create(:product, title: "Expected")
+    product2 = create(:product, description: "Expected")
 
     results = Product.search("Expected")
 
@@ -80,11 +88,11 @@ class SearchCopTest < SearchCop::TestCase
   end
 
   def test_custom_default_enabled
-    product1 = create(:product, :title => "Expected")
-    product2 = create(:product, :description => "Expected")
-    product3 = create(:product, :brand => "Expected")
+    product1 = create(:product, title: "Expected")
+    product2 = create(:product, description: "Expected")
+    product3 = create(:product, brand: "Expected")
 
-    results = with_options(Product.search_scopes[:search], :primary, :default => true) { Product.search "Expected" }
+    results = with_options(Product.search_scopes[:search], :primary, default: true) { Product.search "Expected" }
 
     assert_includes results, product1
     assert_includes results, product2
@@ -92,32 +100,32 @@ class SearchCopTest < SearchCop::TestCase
   end
 
   def test_custom_default_disabled
-    product1 = create(:product, :brand => "Expected")
-    product2 = create(:product, :notice => "Expected")
+    product1 = create(:product, brand: "Expected")
+    product2 = create(:product, notice: "Expected")
 
-    results = with_options(Product.search_scopes[:search], :notice, :default => false) { Product.search "Expected" }
+    results = with_options(Product.search_scopes[:search], :notice, default: false) { Product.search "Expected" }
 
     assert_includes results, product1
     refute_includes results, product2
   end
 
   def test_count
-    create_list :product, 2, :title => "Expected"
+    create_list :product, 2, title: "Expected"
 
     assert_equal 2, Product.search("Expected").count
   end
 
   def test_default_attributes_true
-    with_options(Product.search_scopes[:search], :title, :default => true) do
-      with_options(Product.search_scopes[:search], :description, :default => true) do
+    with_options(Product.search_scopes[:search], :title, default: true) do
+      with_options(Product.search_scopes[:search], :description, default: true) do
         assert_equal ["title", "description"], Product.search_scopes[:search].reflection.default_attributes.keys
       end
     end
   end
 
   def test_default_attributes_fales
-    with_options(Product.search_scopes[:search], :title, :default => false) do
-      with_options(Product.search_scopes[:search], :description, :default => false) do
+    with_options(Product.search_scopes[:search], :title, default: false) do
+      with_options(Product.search_scopes[:search], :description, default: false) do
         assert_equal Product.search_scopes[:search].reflection.attributes.keys - ["title", "description"], Product.search_scopes[:search].reflection.default_attributes.keys
       end
     end
@@ -133,8 +141,6 @@ class SearchCopTest < SearchCop::TestCase
   end
 
   def test_not_adding_search_to_object
-    Product
-    assert_equal false, Object.respond_to?(:search)
+    refute Object.respond_to?(:search)
   end
 end
-

data/test/string_test.rb

@@ -1,16 +1,15 @@
-
-require File.expand_path("../test_helper", __FILE__)
+require File.expand_path("test_helper", __dir__)
 
 class StringTest < SearchCop::TestCase
   def test_anywhere
-    product = create(:product, :title => "Expected title")
+    product = create(:product, title: "Expected title")
 
     assert_includes Product.search("Expected"), product
     refute_includes Product.search("Rejected"), product
   end
 
   def test_anywhere_quoted
-    product = create(:product, :title => "Expected title")
+    product = create(:product, title: "Expected title")
 
     assert_includes Product.search("'Expected title'"), product
     assert_includes Product.search('"Expected title"'), product
@@ -20,75 +19,124 @@ class StringTest < SearchCop::TestCase
   end
 
   def test_multiple
-    product = create(:product, :comments => [create(:comment, :title => "Expected title", :message => "Expected message")])
+    product = create(:product, comments: [create(:comment, title: "Expected title", message: "Expected message")])
 
     assert_includes Product.search("Expected"), product
     refute_includes Product.search("Rejected"), product
   end
 
   def test_includes
-    product = create(:product, :title => "Expected")
+    product = create(:product, title: "Expected")
 
     assert_includes Product.search("title: Expected"), product
     refute_includes Product.search("title: Rejected"), product
   end
 
+  def test_query_string_wildcards
+    product1 = create(:product, brand: "First brand")
+    product2 = create(:product, brand: "Second brand")
+
+    assert_equal Product.search("brand: First*"), [product1]
+    assert_equal Product.search("brand: br*nd"), []
+    assert_equal Product.search("brand: brand*"), []
+    assert_equal Product.search("brand: *brand*").to_set, [product1, product2].to_set
+    assert_equal Product.search("brand: *brand").to_set, [product1, product2].to_set
+  end
+
+  def test_query_string_wildcard_escaping
+    product1 = create(:product, brand: "som% brand")
+    product2 = create(:product, brand: "som_ brand")
+    product3 = create(:product, brand: "som\\ brand")
+    _product4 = create(:product, brand: "some brand")
+
+    assert_equal Product.search("brand: som% brand"), [product1]
+    assert_equal Product.search("brand: som_ brand"), [product2]
+    assert_equal Product.search("brand: som\\ brand"), [product3]
+  end
+
+  def test_query_string_wildcards_with_left_wildcard_false
+    product = create(:product, brand: "Some brand")
+
+    with_options(Product.search_scopes[:search], :brand, left_wildcard: false) do
+      refute_includes Product.search("brand: *brand"), product
+      assert_includes Product.search("brand: Some"), product
+    end
+  end
+
+  def test_query_string_wildcards_with_right_wildcard_false
+    product = create(:product, brand: "Some brand")
+
+    with_options(Product.search_scopes[:search], :brand, right_wildcard: false) do
+      refute_includes Product.search("brand: Some*"), product
+      assert_includes Product.search("brand: brand"), product
+    end
+  end
+
   def test_includes_with_left_wildcard
-    product = create(:product, :title => "Some title")
+    product = create(:product, brand: "Some brand")
+
+    assert_includes Product.search("brand: brand"), product
+  end
 
-    assert_includes Product.search("title: Title"), product
+  def test_includes_with_left_wildcard_false
+    expected = create(:product, brand: "Brand")
+    rejected = create(:product, brand: "Rejected brand")
+
+    results = with_options(Product.search_scopes[:search], :brand, left_wildcard: false) { Product.search "brand: Brand" }
+
+    assert_includes results, expected
+    refute_includes results, rejected
   end
 
-  def test_includes_without_left_wildcard
-    expected = create(:product, :brand => "Brand")
-    rejected = create(:product, :brand => "Rejected brand")
+  def test_includes_with_right_wildcard_false
+    expected = create(:product, brand: "Brand")
+    rejected = create(:product, brand: "Brand rejected")
 
-    results = with_options(Product.search_scopes[:search], :brand, :left_wildcard => false) { Product.search "brand: Brand" }
+    results = with_options(Product.search_scopes[:search], :brand, right_wildcard: false) { Product.search "brand: Brand" }
 
     assert_includes results, expected
     refute_includes results, rejected
   end
 
   def test_equals
-    product = create(:product, :title => "Expected title")
+    product = create(:product, title: "Expected title")
 
     assert_includes Product.search("title = 'Expected title'"), product
     refute_includes Product.search("title = Expected"), product
   end
 
   def test_equals_not
-    product = create(:product, :title => "Expected")
+    product = create(:product, title: "Expected")
 
     assert_includes Product.search("title != Rejected"), product
     refute_includes Product.search("title != Expected"), product
   end
 
   def test_greater
-    product = create(:product, :title => "Title B")
+    product = create(:product, title: "Title B")
 
     assert_includes Product.search("title > 'Title A'"), product
     refute_includes Product.search("title > 'Title B'"), product
   end
 
   def test_greater_equals
-    product = create(:product, :title => "Title A")
+    product = create(:product, title: "Title A")
 
     assert_includes Product.search("title >= 'Title A'"), product
     refute_includes Product.search("title >= 'Title B'"), product
   end
 
   def test_less
-    product = create(:product, :title => "Title A")
+    product = create(:product, title: "Title A")
 
     assert_includes Product.search("title < 'Title B'"), product
     refute_includes Product.search("title < 'Title A'"), product
   end
 
   def test_less_or_greater
-    product = create(:product, :title => "Title B")
+    product = create(:product, title: "Title B")
 
     assert_includes Product.search("title <= 'Title B'"), product
     refute_includes Product.search("title <= 'Title A'"), product
   end
 end
-

data/test/test_helper.rb

@@ -1,4 +1,3 @@
-
 require "search_cop"
 
 begin
@@ -13,12 +12,12 @@ end
 
 require "minitest/autorun"
 require "active_record"
-require "factory_girl"
+require "factory_bot"
 require "yaml"
 
 DATABASE = ENV["DATABASE"] || "sqlite"
 
-ActiveRecord::Base.establish_connection YAML.load_file(File.expand_path("../database.yml", __FILE__))[DATABASE]
+ActiveRecord::Base.establish_connection YAML.load_file(File.expand_path("database.yml", __dir__))[DATABASE]
 
 class User < ActiveRecord::Base; end
 
@@ -28,7 +27,7 @@ class Comment < ActiveRecord::Base
   belongs_to :user
 
   search_scope :search do
-    attributes :user => "user.username"
+    attributes user: "user.username"
     attributes :title, :message
   end
 end
@@ -38,19 +37,19 @@ class Product < ActiveRecord::Base
 
   search_scope :search do
     attributes :title, :description, :brand, :notice, :stock, :price, :created_at, :created_on, :available
-    attributes :comment => ["comments.title", "comments.message"], :user => ["users.username", "users_products.username"]
-    attributes :primary => [:title, :description]
+    attributes comment: ["comments.title", "comments.message"], user: ["users.username", "users_products.username"]
+    attributes primary: [:title, :description]
 
-    aliases :users_products => :user
+    aliases users_products: :user
 
     if DATABASE != "sqlite"
-      options :title, :type => :fulltext, coalesce:  true
-      options :description, :type => :fulltext, coalesce: true
-      options :comment, :type => :fulltext, coalesce: true
+      options :title, type: :fulltext, coalesce: true
+      options :description, type: :fulltext, coalesce: true
+      options :comment, type: :fulltext, coalesce: true
     end
 
     if DATABASE == "postgres"
-      options :title, :dictionary => "english"
+      options :title, dictionary: "english"
     end
 
     generator :custom_eq do |column_name, raw_value|
@@ -62,22 +61,34 @@ class Product < ActiveRecord::Base
     scope { joins "LEFT OUTER JOIN users users_products ON users_products.id = products.user_id" }
 
     attributes :title, :description
-    attributes :user => "users_products.username"
+    attributes user: "users_products.username"
+
+    options :title, default: true
+    aliases users_products: User
+  end
 
-    options :title, :default => true
-    aliases :users_products => User
+  search_scope :search_multi_columns do
+    attributes all: [:title, :description]
   end
 
   has_many :comments
-  has_many :users, :through => :comments
+  has_many :users, through: :comments
 
   belongs_to :user
 end
 
-FactoryGirl.define do
+class AvailableProduct < Product
+  default_scope { where(available: true) }
+end
+
+FactoryBot.define do
   factory :product do
   end
 
+  factory :available_product do
+    available { true }
+  end
+
   factory :comment do
   end
 
@@ -122,7 +133,7 @@ if DATABASE == "mysql"
 end
 
 class SearchCop::TestCase
-  include FactoryGirl::Syntax::Methods
+  include FactoryBot::Syntax::Methods
 
   def teardown
     Product.delete_all
@@ -169,4 +180,3 @@ class SearchCop::TestCase
     ActiveRecord::Base.connection.quote object
   end
 end
-

data/test/visitor_test.rb

@@ -1,5 +1,4 @@
-
-require File.expand_path("../test_helper", __FILE__)
+require File.expand_path("test_helper", __dir__)
 
 class VisitorTest < SearchCop::TestCase
   def test_and
@@ -53,8 +52,8 @@ class VisitorTest < SearchCop::TestCase
   def test_matches
     node = SearchCopGrammar::Attributes::String.new(Product, "products", "notice").matches("Notice")
 
-    assert_equal("(#{quote_table_name "products"}.#{quote_column_name "notice"} IS NOT NULL AND #{quote_table_name "products"}.#{quote_column_name "notice"} LIKE #{quote "%Notice%"})", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] != "postgres"
-    assert_equal("(#{quote_table_name "products"}.#{quote_column_name "notice"} IS NOT NULL AND #{quote_table_name "products"}.#{quote_column_name "notice"} ILIKE #{quote "%Notice%"})", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] == "postgres"
+    assert_equal("(#{quote_table_name "products"}.#{quote_column_name "notice"} IS NOT NULL AND #{quote_table_name "products"}.#{quote_column_name "notice"} LIKE #{quote "%Notice%"} ESCAPE #{quote "\\"})", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] != "postgres"
+    assert_equal("(#{quote_table_name "products"}.#{quote_column_name "notice"} IS NOT NULL AND #{quote_table_name "products"}.#{quote_column_name "notice"} ILIKE #{quote "%Notice%"} ESCAPE #{quote "\\"})", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] == "postgres"
   end
 
   def test_not
@@ -99,7 +98,7 @@ class VisitorTest < SearchCop::TestCase
   end
 
   def test_generator
-    generator = ->(column_name, value) do
+    generator = lambda do |column_name, value|
       "#{column_name} = #{quote value}"
     end
     node = SearchCopGrammar::Attributes::Collection.new(SearchCop::QueryInfo.new(Product, Product.search_scopes[:search]), "title").generator(generator, "value").optimize!
@@ -107,4 +106,3 @@ class VisitorTest < SearchCop::TestCase
     assert_equal "#{quote_table_name "products"}.#{quote_column_name "title"} = 'value'", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_cop
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.2.1
 platform: ruby
 authors:
 - Benjamin Vetter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
-- Appraisals
+- ".rubocop.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -125,14 +125,14 @@ files:
 - MIGRATION.md
 - README.md
 - Rakefile
-- gemfiles/3.2.gemfile
-- gemfiles/4.0.gemfile
-- gemfiles/4.1.gemfile
-- gemfiles/4.2.gemfile
-- gemfiles/5.0.gemfile
+- docker-compose.yml
+- gemfiles/rails5.gemfile
+- gemfiles/rails6.gemfile
+- gemfiles/rails7.gemfile
 - lib/search_cop.rb
 - lib/search_cop/grammar_parser.rb
 - lib/search_cop/hash_parser.rb
+- lib/search_cop/helpers.rb
 - lib/search_cop/query_builder.rb
 - lib/search_cop/query_info.rb
 - lib/search_cop/search_scope.rb
@@ -151,6 +151,7 @@ files:
 - test/database.yml
 - test/date_test.rb
 - test/datetime_test.rb
+- test/default_operator_test.rb
 - test/error_test.rb
 - test/float_test.rb
 - test/fulltext_test.rb
@@ -167,7 +168,7 @@ homepage: https://github.com/mrkamel/search_cop
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -182,27 +183,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Easily perform complex search engine like fulltext queries on your ActiveRecord
   models
-test_files:
-- test/and_test.rb
-- test/boolean_test.rb
-- test/database.yml
-- test/date_test.rb
-- test/datetime_test.rb
-- test/error_test.rb
-- test/float_test.rb
-- test/fulltext_test.rb
-- test/hash_test.rb
-- test/integer_test.rb
-- test/not_test.rb
-- test/or_test.rb
-- test/scope_test.rb
-- test/search_cop_test.rb
-- test/string_test.rb
-- test/test_helper.rb
-- test/visitor_test.rb
+test_files: []