search_cop 1.1.0 → 1.2.0

data/test/integer_test.rb

@@ -1,58 +1,57 @@
-
-require File.expand_path("../test_helper", __FILE__)
+require File.expand_path("test_helper", __dir__)
 
 class IntegerTest < SearchCop::TestCase
   def test_anywhere
-    product = create(:product, :stock => 1)
+    product = create(:product, stock: 1)
 
     assert_includes Product.search("1"), product
     refute_includes Product.search("0"), product
   end
 
   def test_includes
-    product = create(:product, :stock => 1)
+    product = create(:product, stock: 1)
 
     assert_includes Product.search("stock: 1"), product
     refute_includes Product.search("stock: 10"), product
   end
 
   def test_equals
-    product = create(:product, :stock => 1)
+    product = create(:product, stock: 1)
 
     assert_includes Product.search("stock = 1"), product
     refute_includes Product.search("stock = 0"), product
   end
 
   def test_equals_not
-    product = create(:product, :stock => 1)
+    product = create(:product, stock: 1)
 
     assert_includes Product.search("stock != 0"), product
     refute_includes Product.search("stock != 1"), product
   end
 
   def test_greater
-    product = create(:product, :stock => 1)
+    product = create(:product, stock: 1)
 
     assert_includes Product.search("stock > 0"), product
     refute_includes Product.search("stock < 1"), product
   end
 
   def test_greater_equals
-    product = create(:product, :stock => 1)
+    product = create(:product, stock: 1)
 
     assert_includes Product.search("stock >= 1"), product
     refute_includes Product.search("stock >= 2"), product
   end
 
   def test_less
-    product = create(:product, :stock => 1)
+    product = create(:product, stock: 1)
 
     assert_includes Product.search("stock < 2"), product
     refute_includes Product.search("stock < 1"), product
   end
 
   def test_less_equals
-    product = create(:product, :stock => 1)
+    product = create(:product, stock: 1)
 
     assert_includes Product.search("stock <= 1"), product
     refute_includes Product.search("stock <= 0"), product
@@ -64,4 +63,3 @@ class IntegerTest < SearchCop::TestCase
     end
   end
 end
-

data/test/not_test.rb

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

data/test/or_test.rb

@@ -1,11 +1,10 @@
-
-require File.expand_path("../test_helper", __FILE__)
+require File.expand_path("test_helper", __dir__)
 
 class OrTest < SearchCop::TestCase
   def test_or_string
-    product1 = create(:product, :title => "Title1")
-    product2 = create(:product, :title => "Title2")
-    product3 = create(:product, :title => "Title3")
+    product1 = create(:product, title: "Title1")
+    product2 = create(:product, title: "Title2")
+    product3 = create(:product, title: "Title3")
 
     results = Product.search("title: Title1 OR title: Title2")
 
@@ -15,15 +14,14 @@ class OrTest < SearchCop::TestCase
   end
 
   def test_or_hash
-    product1 = create(:product, :title => "Title1")
-    product2 = create(:product, :title => "Title2")
-    product3 = create(:product, :title => "Title3")
+    product1 = create(:product, title: "Title1")
+    product2 = create(:product, title: "Title2")
+    product3 = create(:product, title: "Title3")
 
-    results = Product.search(:or => [{:title => "Title1"}, {:title => "Title2"}])
+    results = Product.search(or: [{ title: "Title1" }, { title: "Title2" }])
 
     assert_includes results, product1
     assert_includes results, product2
     refute_includes results, product3
   end
 end
-

data/test/scope_test.rb

@@ -1,10 +1,9 @@
-
-require File.expand_path("../test_helper", __FILE__)
+require File.expand_path("test_helper", __dir__)
 
 class ScopeTest < SearchCop::TestCase
   def test_scope_name
-    expected = create(:product, :title => "Expected")
-    rejected = create(:product, :notice => "Expected")
+    expected = create(:product, title: "Expected")
+    rejected = create(:product, notice: "Expected")
 
     results = Product.user_search("Expected")
 
@@ -13,8 +12,8 @@ class ScopeTest < SearchCop::TestCase
   end
 
   def test_options
-    expected = create(:product, :title => "Expected")
-    rejected = create(:product, :description => "Expected")
+    expected = create(:product, title: "Expected")
+    rejected = create(:product, description: "Expected")
 
     results = Product.user_search("Expected")
 
@@ -23,8 +22,8 @@ class ScopeTest < SearchCop::TestCase
   end
 
   def test_custom_scope
-    expected = create(:product, :user => create(:user, :username => "Expected"))
-    rejected = create(:product, :user => create(:user, :username => "Rejected"))
+    expected = create(:product, user: create(:user, username: "Expected"))
+    rejected = create(:product, user: create(:user, username: "Rejected"))
 
     results = Product.user_search("user: Expected")
 
@@ -33,8 +32,8 @@ class ScopeTest < SearchCop::TestCase
   end
 
   def test_aliases_with_association
-    expected = create(:product, :user => create(:user, :username => "Expected"))
-    rejected = create(:product, :user => create(:user, :username => "Rejected"))
+    expected = create(:product, user: create(:user, username: "Expected"))
+    rejected = create(:product, user: create(:user, username: "Rejected"))
 
     results = Product.search("user: Expected")
 
@@ -43,8 +42,8 @@ class ScopeTest < SearchCop::TestCase
   end
 
   def test_aliases_with_model
-    expected = create(:product, :user => create(:user, :username => "Expected"))
-    rejected = create(:product, :user => create(:user, :username => "Rejected"))
+    expected = create(:product, user: create(:user, username: "Expected"))
+    rejected = create(:product, user: create(:user, username: "Rejected"))
 
     results = Product.user_search("user: Expected")
 
@@ -52,4 +51,3 @@ class ScopeTest < SearchCop::TestCase
     refute_includes results, rejected
   end
 end
-

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")
 
@@ -63,15 +62,15 @@ class SearchCopTest < SearchCop::TestCase
   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 +79,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 +91,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
@@ -136,4 +135,3 @@ class SearchCopTest < SearchCop::TestCase
     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
-