search_cop 1.2.3 → 1.3.0

data/test/search_cop_test.rb

@@ -1,166 +0,0 @@
-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")
-
-    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")
-
-    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")
-
-    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")
-    ])
-
-    assert_includes Product.search("comment: Title1 comment: Message1"), product
-    assert_includes Product.search("comment: Title2 comment: Message2"), product
-  end
-
-  def test_single_association
-    expected = create(:comment, user: create(:user, username: "Expected"))
-    rejected = create(:comment, user: create(:user, username: "Rejected"))
-
-    results = Comment.search("user: Expected")
-
-    assert_includes results, expected
-    refute_includes results, rejected
-  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"))])
-
-    results = Product.search("user: Expected")
-
-    assert_includes results, expected
-    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_namespaced_model
-    expected = create(:blog_post, title: "Expected")
-    rejected = create(:blog_post, title: "Rejected")
-
-    results = Blog::Post.search("Expected")
-
-    assert_includes results, expected
-    refute_includes results, rejected
-  end
-
-  def test_namespaced_model_with_associations
-    expected = create(:blog_post, user: create(:user, username: "Expected"))
-    rejected = create(:blog_post, user: create(:user, username: "Rejected"))
-
-    results = Blog::Post.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")])
-
-    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")
-
-    results = Product.search("Expected")
-
-    assert_includes results, product1
-    assert_includes results, product2
-  end
-
-  def test_custom_default_enabled
-    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" }
-
-    assert_includes results, product1
-    assert_includes results, product2
-    refute_includes results, product3
-  end
-
-  def test_custom_default_disabled
-    product1 = create(:product, brand: "Expected")
-    product2 = create(:product, notice: "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"
-
-    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
-        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
-        assert_equal Product.search_scopes[:search].reflection.attributes.keys - ["title", "description"], Product.search_scopes[:search].reflection.default_attributes.keys
-      end
-    end
-  end
-
-  def test_search_reflection
-    assert_not_nil Product.search_reflection(:search)
-    assert_not_nil Product.search_reflection(:user_search)
-  end
-
-  def test_blank
-    assert_equal Product.all, Product.search("")
-  end
-
-  def test_not_adding_search_to_object
-    refute Object.respond_to?(:search)
-  end
-end

data/test/string_test.rb

@@ -1,142 +0,0 @@
-require File.expand_path("test_helper", __dir__)
-
-class StringTest < SearchCop::TestCase
-  def test_anywhere
-    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")
-
-    assert_includes Product.search("'Expected title'"), product
-    assert_includes Product.search('"Expected title"'), product
-
-    refute_includes Product.search("'Rejected title'"), product
-    refute_includes Product.search('"Rejected title"'), product
-  end
-
-  def test_multiple
-    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")
-
-    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, brand: "Some brand")
-
-    assert_includes Product.search("brand: brand"), product
-  end
-
-  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_with_right_wildcard_false
-    expected = create(:product, brand: "Brand")
-    rejected = create(:product, brand: "Brand rejected")
-
-    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")
-
-    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")
-
-    assert_includes Product.search("title != Rejected"), product
-    refute_includes Product.search("title != Expected"), product
-  end
-
-  def test_greater
-    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")
-
-    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")
-
-    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")
-
-    assert_includes Product.search("title <= 'Title B'"), product
-    refute_includes Product.search("title <= 'Title A'"), product
-  end
-end

data/test/test_helper.rb

@@ -1,205 +0,0 @@
-require "search_cop"
-
-begin
-  require "minitest"
-
-  class SearchCop::TestCase < MiniTest::Test; end
-rescue LoadError
-  require "minitest/unit"
-
-  class SearchCop::TestCase < MiniTest::Unit::TestCase; end
-end
-
-require "minitest/autorun"
-require "active_record"
-require "factory_bot"
-require "yaml"
-
-DATABASE = ENV["DATABASE"] || "sqlite"
-
-ActiveRecord::Base.establish_connection YAML.load_file(File.expand_path("database.yml", __dir__))[DATABASE]
-
-class User < ActiveRecord::Base; end
-
-class Comment < ActiveRecord::Base
-  include SearchCop
-
-  belongs_to :user
-
-  search_scope :search do
-    attributes user: "user.username"
-    attributes :title, :message
-  end
-end
-
-class Product < ActiveRecord::Base
-  include SearchCop
-
-  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]
-
-    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
-    end
-
-    if DATABASE == "postgres"
-      options :title, dictionary: "english"
-    end
-
-    generator :custom_eq do |column_name, raw_value|
-      "#{column_name} = #{quote raw_value}"
-    end
-  end
-
-  search_scope :user_search do
-    scope { joins "LEFT OUTER JOIN users users_products ON users_products.id = products.user_id" }
-
-    attributes :title, :description
-    attributes user: "users_products.username"
-
-    options :title, default: true
-    aliases users_products: User
-  end
-
-  search_scope :search_multi_columns do
-    attributes all: [:title, :description]
-  end
-
-  has_many :comments
-  has_many :users, through: :comments
-
-  belongs_to :user
-end
-
-module Blog
-  class Post < ActiveRecord::Base
-    include SearchCop
-
-    belongs_to :user
-
-    search_scope :search do
-      attributes :title, :content
-      attributes user: ["user.username"]
-    end
-  end
-end
-
-class AvailableProduct < Product
-  default_scope { where(available: true) }
-end
-
-FactoryBot.define do
-  factory :product do
-  end
-
-  factory :blog_post, class: Blog::Post do
-  end
-
-  factory :available_product do
-    available { true }
-  end
-
-  factory :comment do
-  end
-
-  factory :user do
-  end
-end
-
-ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS products"
-ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS posts"
-ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS comments"
-ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS users"
-
-ActiveRecord::Base.connection.create_table :products do |t|
-  t.references :user
-  t.string :title
-  t.text :description
-  t.integer :stock
-  t.float :price
-  t.datetime :created_at
-  t.date :created_on
-  t.boolean :available
-  t.string :brand
-  t.string :notice
-end
-
-ActiveRecord::Base.connection.create_table :posts do |t|
-  t.references :user
-  t.string :title
-  t.text :content
-end
-
-ActiveRecord::Base.connection.create_table :comments do |t|
-  t.references :product
-  t.references :user
-  t.string :title
-  t.text :message
-end
-
-ActiveRecord::Base.connection.create_table :users do |t|
-  t.string :username
-end
-
-if DATABASE == "mysql"
-  ActiveRecord::Base.connection.execute "ALTER TABLE products ENGINE=MyISAM"
-  ActiveRecord::Base.connection.execute "ALTER TABLE products ADD FULLTEXT INDEX(title), ADD FULLTEXT INDEX(description), ADD FULLTEXT INDEX(title, description)"
-
-  ActiveRecord::Base.connection.execute "ALTER TABLE comments ENGINE=MyISAM"
-  ActiveRecord::Base.connection.execute "ALTER TABLE comments ADD FULLTEXT INDEX(title, message)"
-end
-
-class SearchCop::TestCase
-  include FactoryBot::Syntax::Methods
-
-  def teardown
-    Product.delete_all
-    Comment.delete_all
-  end
-
-  def with_options(scope, key, options = {})
-    opts = scope.reflection.options[key.to_s] || {}
-
-    scope.reflection.options[key.to_s] = opts.merge(options)
-
-    yield
-  ensure
-    scope.reflection.options[key.to_s] = opts
-  end
-
-  def with_scope(scope, blk)
-    orig = scope.reflection.scope
-
-    scope.reflection.scope = blk
-
-    yield
-  ensure
-    scope.reflection.scope = orig
-  end
-
-  def assert_not_nil(value)
-    assert value
-  end
-
-  def assert_nothing_raised
-    yield
-  end
-
-  def quote_table_name(name)
-    ActiveRecord::Base.connection.quote_table_name name
-  end
-
-  def quote_column_name(name)
-    ActiveRecord::Base.connection.quote_column_name name
-  end
-
-  def quote(object)
-    ActiveRecord::Base.connection.quote object
-  end
-end

data/test/visitor_test.rb

@@ -1,108 +0,0 @@
-require File.expand_path("test_helper", __dir__)
-
-class VisitorTest < SearchCop::TestCase
-  def test_and
-    node = SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").gt(0).and(SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").lt(2))
-
-    assert_equal "(#{quote_table_name "products"}.#{quote_column_name "stock"} > 0 AND #{quote_table_name "products"}.#{quote_column_name "stock"} < 2)", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-
-  def test_or
-    node = SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").gt(0).or(SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").lt(2))
-
-    assert_equal "(#{quote_table_name "products"}.#{quote_column_name "stock"} > 0 OR #{quote_table_name "products"}.#{quote_column_name "stock"} < 2)", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-
-  def test_greater_than
-    node = SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").gt(1)
-
-    assert_equal "#{quote_table_name "products"}.#{quote_column_name "stock"} > 1", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-
-  def test_greater_than_or_equal
-    node = SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").gteq(1)
-
-    assert_equal "#{quote_table_name "products"}.#{quote_column_name "stock"} >= 1", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-
-  def test_less_than
-    node = SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").lt(1)
-
-    assert_equal "#{quote_table_name "products"}.#{quote_column_name "stock"} < 1", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-
-  def test_less_than_or_equal
-    node = SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").lteq(1)
-
-    assert_equal "#{quote_table_name "products"}.#{quote_column_name "stock"} <= 1", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-
-  def test_equality
-    node = SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").eq(1)
-
-    assert_equal "#{quote_table_name "products"}.#{quote_column_name "stock"} = 1", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-
-  def test_not_equal
-    node = SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").not_eq(1)
-
-    assert_equal "#{quote_table_name "products"}.#{quote_column_name "stock"} != 1", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-
-  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%"} 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
-    node = SearchCopGrammar::Attributes::Integer.new(Product, "products", "stock").eq(1).not
-
-    assert_equal "NOT (#{quote_table_name "products"}.#{quote_column_name "stock"} = 1)", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-
-  def test_attribute
-    # Already tested
-  end
-
-  def test_quote
-    assert_equal quote("Test"), SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit("Test")
-  end
-
-  def test_fulltext
-    node = SearchCopGrammar::Attributes::Collection.new(SearchCop::QueryInfo.new(Product, Product.search_scopes[:search]), "title").matches("Query").optimize!
-
-    assert_equal("MATCH(`products`.`title`) AGAINST('Query' IN BOOLEAN MODE)", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] == "mysql"
-    assert_equal("to_tsvector('english', COALESCE(\"products\".\"title\", '')) @@ to_tsquery('english', '''Query''')", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] == "postgres"
-  end
-
-  def test_fulltext_and
-    query1 = SearchCopGrammar::Attributes::Collection.new(SearchCop::QueryInfo.new(Product, Product.search_scopes[:search]), "title").matches("Query1")
-    query2 = SearchCopGrammar::Attributes::Collection.new(SearchCop::QueryInfo.new(Product, Product.search_scopes[:search]), "title").matches("Query2")
-
-    node = query1.and(query2).optimize!
-
-    assert_equal("(MATCH(`products`.`title`) AGAINST('+Query1 +Query2' IN BOOLEAN MODE))", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] == "mysql"
-    assert_equal("(to_tsvector('english', COALESCE(\"products\".\"title\", '')) @@ to_tsquery('english', '(''Query1'') & (''Query2'')'))", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] == "postgres"
-  end
-
-  def test_fulltext_or
-    query1 = SearchCopGrammar::Attributes::Collection.new(SearchCop::QueryInfo.new(Product, Product.search_scopes[:search]), "title").matches("Query1")
-    query2 = SearchCopGrammar::Attributes::Collection.new(SearchCop::QueryInfo.new(Product, Product.search_scopes[:search]), "title").matches("Query2")
-
-    node = query1.or(query2).optimize!
-
-    assert_equal("(MATCH(`products`.`title`) AGAINST('(Query1) (Query2)' IN BOOLEAN MODE))", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] == "mysql"
-    assert_equal("(to_tsvector('english', COALESCE(\"products\".\"title\", '')) @@ to_tsquery('english', '(''Query1'') | (''Query2'')'))", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)) if ENV["DATABASE"] == "postgres"
-  end
-
-  def test_generator
-    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!
-
-    assert_equal "#{quote_table_name "products"}.#{quote_column_name "title"} = 'value'", SearchCop::Visitors::Visitor.new(ActiveRecord::Base.connection).visit(node)
-  end
-end