attr_searchable 0.0.1

data/lib/attr_searchable_grammar.rb

@@ -0,0 +1,136 @@
+
+require "attr_searchable_grammar/attributes"
+require "attr_searchable_grammar/nodes"
+
+module AttrSearchableGrammar
+  class BaseNode < Treetop::Runtime::SyntaxNode
+    attr_writer :model
+
+    def model
+      @model || parent.model
+    end
+
+    def to_arel
+      elements.collect(&:to_arel).inject(:and)
+    end
+
+    def elements
+      super.select { |element| element.class != Treetop::Runtime::SyntaxNode }
+    end
+
+    def arel_collection_for(key)
+      raise AttrSearchable::UnknownColumn, "Unknown key: #{key}" if model.searchable_attributes[key].nil?
+
+      Attributes::Collection.new model, key
+    end
+  end
+
+  class OperatorNode < Treetop::Runtime::SyntaxNode
+    def to_arel
+      text_value
+    end
+  end
+
+  class ComplexExpression < BaseNode; end
+  class ParenthesesExpression < BaseNode; end
+
+  class ComparativeExpression < BaseNode
+    def to_arel
+      elements[0].arel_collection.send elements[1].to_arel_method, elements[2].text_value
+    end
+  end
+
+  class IncludesOperator < OperatorNode
+    def to_arel_method
+      :matches
+    end
+  end
+
+  class EqualOperator < OperatorNode
+    def to_arel_method
+      :eq
+    end
+  end
+
+  class UnequalOperator < OperatorNode
+    def to_arel_method
+      :not_eq
+    end
+  end
+
+  class GreaterEqualOperator < OperatorNode
+    def to_arel_method
+      :gteq
+    end
+  end
+
+  class GreaterOperator < OperatorNode
+    def to_arel_method
+      :gt
+    end
+  end
+
+  class LessEqualOperator < OperatorNode
+    def to_arel_method
+      :lteq
+    end
+  end
+
+  class LessOperator < OperatorNode
+    def to_arel_method
+      :lt
+    end
+  end
+
+  class AnywhereExpression < BaseNode
+    def to_arel
+      keys = model.searchable_attribute_options.select { |key, value| value[:default] == true }.keys
+      keys = model.searchable_attributes.keys if keys.empty?
+
+      queries = keys.collect { |key| arel_collection_for key }.select { |attribute| attribute.compatible? text_value }.collect { |attribute| attribute.matches text_value }
+
+      raise AttrSearchable::NoSearchableAttributes unless model.searchable_attributes
+
+      queries.flatten.inject(:or)
+    end
+  end
+
+  class AndExpression < BaseNode
+    def to_arel
+      [elements.first.to_arel, elements.last.to_arel].inject(:and)
+    end
+  end
+
+  class OrExpression < BaseNode
+    def to_arel
+      [elements.first.to_arel, elements.last.to_arel].inject(:or)
+    end
+  end
+
+  class NotExpression < BaseNode
+    def to_arel
+      elements.first.to_arel.not
+    end
+  end
+
+  class Column < BaseNode
+    def arel_collection
+      arel_collection_for text_value
+    end
+  end
+
+  class SingleQuotedValue < BaseNode
+    def text_value
+      super.gsub /^'|'$/, ""
+    end
+  end
+
+  class DoubleQuotedValue < BaseNode
+    def text_value
+      super.gsub /^"|"$/, ""
+    end
+  end
+
+  class Value < BaseNode; end
+end
+

data/lib/attr_searchable_grammar.treetop

@@ -0,0 +1,55 @@
+
+grammar AttrSearchableGrammar
+  rule complex_expression
+    space? (boolean_expression / expression) space? <ComplexExpression>
+  end
+
+  rule boolean_expression
+    and_expression
+  end
+
+  rule and_expression
+    or_expression (space? ('AND' / 'and') space? / space !('OR' / 'or')) complex_expression <AndExpression> / or_expression
+  end
+
+  rule or_expression
+    expression space? ('OR' / 'or') space? (or_expression / expression) <OrExpression> / expression
+  end
+
+  rule expression
+    parentheses_expression / not_expression / comparative_expression / anywhere_expression
+  end
+
+  rule parentheses_expression
+    '(' complex_expression ')' <ParenthesesExpression> 
+  end
+
+  rule not_expression
+    ('NOT' space / 'not' space / '-') (comparative_expression / anywhere_expression) <NotExpression>
+  end
+
+  rule comparative_expression
+    simple_column space? comparison_operator space? value <ComparativeExpression>
+  end
+
+  rule comparison_operator
+    ':' <IncludesOperator> / '=' <EqualOperator> / '!=' <UnequalOperator> / '>=' <GreaterEqualOperator> / '>' <GreaterOperator> / '<=' <LessEqualOperator> / '<' <LessOperator>
+  end
+
+  rule anywhere_expression
+    ("'" ([^\']* <AnywhereExpression>) "'") / ('"' ([^\"]* <AnywhereExpression>) '"') / [^\s()]+ <AnywhereExpression>
+  end
+
+  rule simple_column
+    [a-zA-Z0-9_.]+ <Column>
+  end
+
+  rule value
+    "'" [^\']* "'" <SingleQuotedValue> / '"' [^\"]* '"' <DoubleQuotedValue> / [^\s()]+ <Value>
+  end
+
+  rule space
+    [\s]+
+  end
+end
+

data/test/and_test.rb

@@ -0,0 +1,27 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class AndTest < AttrSearchable::TestCase
+  def test_and_string
+    expected = FactoryGirl.create(:product, :title => "Expected title", :description => "Description")
+    rejected = FactoryGirl.create(:product, :title => "Rejected title", :description => "Description")
+
+    results = Product.search("title: 'Expected title' description: Description")
+
+    assert_includes results, expected
+    refute_includes results, rejected
+
+    assert_equal results, Product.search("title: 'Expected title' AND description: Description")
+  end
+
+  def test_and_hash
+    expected = FactoryGirl.create(:product, :title => "Expected title", :description => "Description")
+    rejected = FactoryGirl.create(:product, :title => "Rejected title", :description => "Description")
+
+    results = Product.search(:and => [{:title => "Expected title"}, {:description => "Description"}])
+
+    assert_includes results, expected
+    refute_includes results, rejected
+  end
+end
+

data/test/attr_searchable_test.rb

@@ -0,0 +1,44 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class AttrSearchableTest < AttrSearchable::TestCase
+  def test_associations
+    product = FactoryGirl.create(:product, :comments => [
+      FactoryGirl.create(:comment, :title => "Title1", :message => "Message1"),
+      FactoryGirl.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_multiple
+    product = FactoryGirl.create(:product, :comments => [FactoryGirl.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 = FactoryGirl.create(:product, :title => "Expected")
+    product2 = FactoryGirl.create(:product, :description => "Expected")
+
+    results = Product.search("Expected")
+
+    assert_includes results, product1
+    assert_includes results, product2
+  end
+
+  def test_custom_default
+    product1 = FactoryGirl.create(:product, :title => "Expected")
+    product2 = FactoryGirl.create(:product, :description => "Expected")
+    product3 = FactoryGirl.create(:product, :brand => "Expected")
+
+    results = with_attr_searchable_options(Product, :primary, :default => true) { Product.search "Expected" }
+
+    assert_includes results, product1
+    assert_includes results, product2
+    refute_includes results, product3
+  end
+end
+

data/test/boolean_test.rb

@@ -0,0 +1,47 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class BooleanTest < AttrSearchable::TestCase
+  def test_mapping
+    product = FactoryGirl.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 = FactoryGirl.create(:product, :available => false)
+
+    assert_includes Product.search("available: 0"), product
+    assert_includes Product.search("available: false"), product
+    assert_includes Product.search("available: no"), product
+  end
+
+  def test_anywhere
+    product = FactoryGirl.create(:product, :available => true)
+
+    assert_includes Product.search("true"), product
+    refute_includes Product.search("false"), product
+  end
+
+  def test_includes
+    product = FactoryGirl.create(:product, :available => true)
+
+    assert_includes Product.search("available: true"), product
+    refute_includes Product.search("available: false"), product
+  end
+
+  def test_equals
+    product = FactoryGirl.create(:product, :available => true)
+
+    assert_includes Product.search("available = true"), product
+    refute_includes Product.search("available = false"), product
+  end
+
+  def test_equals_not
+    product = FactoryGirl.create(:product, :available => false)
+
+    assert_includes Product.search("available != true"), product
+    refute_includes Product.search("available != false"), product
+  end
+end
+

data/test/database.yml

@@ -0,0 +1,17 @@
+
+sqlite:
+  adapter: sqlite3
+  database: ":memory:"
+
+mysql:
+  adapter: mysql2
+  database: attr_searchable
+  username: root
+  encoding: utf8
+
+postgres:
+  adapter: postgresql
+  database: attr_searchable
+  username: postgres
+  encoding: utf8
+

data/test/datetime_test.rb

@@ -0,0 +1,70 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class DatetimeTest < AttrSearchable::TestCase
+  def test_mapping
+    product = FactoryGirl.create(:product, :created_at => Time.parse("2014-05-01 12:30:30"))
+
+    assert_includes Product.search("created_at: 2014"), product
+    assert_includes Product.search("created_at: 2014-05"), product
+    assert_includes Product.search("created_at: 2014-05-01"), product
+    assert_includes Product.search("created_at: '2014-05-01 12:30:30'"), product
+  end
+
+  def test_anywhere
+    product = FactoryGirl.create(:product, :created_at => Time.parse("2014-05-01"))
+
+    assert_includes Product.search("2014-05-01"), product
+    refute_includes Product.search("2014-05-02"), product
+  end
+
+  def test_includes
+    product = FactoryGirl.create(:product, :created_at => Time.parse("2014-05-01"))
+
+    assert_includes Product.search("created_at: 2014-05-01"), product
+    refute_includes Product.search("created_at: 2014-05-02"), product
+  end
+
+  def test_equals
+    product = FactoryGirl.create(:product, :created_at => Time.parse("2014-05-01"))
+
+    assert_includes Product.search("created_at = 2014-05-01"), product
+    refute_includes Product.search("created_at = 2014-05-02"), product
+  end
+
+  def test_equals_not
+    product = FactoryGirl.create(:product, :created_at => Time.parse("2014-05-01"))
+
+    assert_includes Product.search("created_at != 2014-05-02"), product
+    refute_includes Product.search("created_at != 2014-05-01"), product
+  end
+
+  def test_greater
+    product = FactoryGirl.create(:product, :created_at => Time.parse("2014-05-01"))
+
+    assert_includes Product.search("created_at < 2014-05-02"), product
+    refute_includes Product.search("created_at < 2014-05-01"), product
+  end
+
+  def test_greater_equals
+    product = FactoryGirl.create(:product, :created_at => Time.parse("2014-05-01"))
+
+    assert_includes Product.search("created_at >= 2014-05-01"), product
+    refute_includes Product.search("created_at >= 2014-05-02"), product
+  end
+
+  def test_less
+    product = FactoryGirl.create(:product, :created_at => Time.parse("2014-05-01"))
+
+    assert_includes Product.search("created_at < 2014-05-02"), product
+    refute_includes Product.search("created_at < 2014-05-01"), product
+  end
+
+  def test_less_equals
+    product = FactoryGirl.create(:product, :created_at => Time.parse("2014-05-02"))
+
+    assert_includes Product.search("created_at <= 2014-05-02"), product
+    refute_includes Product.search("created_at <= 2014-05-01"), product
+  end
+end
+

data/test/float_test.rb

@@ -0,0 +1,61 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class FloatTest < AttrSearchable::TestCase
+  def test_anywhere
+    product = FactoryGirl.create(:product, :price => 10.5, :created_at => Time.now - 1.day)
+
+    assert_includes Product.search("10.5"), product
+    refute_includes Product.search("11.5"), product
+  end
+
+  def test_includes
+    product = FactoryGirl.create(:product, :price => 10.5)
+
+    assert_includes Product.search("price: 10.5"), product
+    refute_includes Product.search("price: 11.5"), product
+  end
+
+  def test_equals
+    product = FactoryGirl.create(:product, :price => 10.5)
+
+    assert_includes Product.search("price = 10.5"), product
+    refute_includes Product.search("price = 11.5"), product
+  end
+
+  def test_equals_not
+    product = FactoryGirl.create(:product, :price => 10.5)
+
+    assert_includes Product.search("price != 11.5"), product
+    refute_includes Product.search("price != 10.5"), product
+  end
+
+  def test_greater
+    product = FactoryGirl.create(:product, :price => 10.5)
+
+    assert_includes Product.search("price > 10.4"), product
+    refute_includes Product.search("price < 10.5"), product
+  end
+
+  def test_greater_equals
+    product = FactoryGirl.create(:product, :price => 10.5)
+
+    assert_includes Product.search("price >= 10.5"), product
+    refute_includes Product.search("price >= 10.6"), product
+  end
+
+  def test_less
+    product = FactoryGirl.create(:product, :price => 10.5)
+
+    assert_includes Product.search("price < 10.6"), product
+    refute_includes Product.search("price < 10.5"), product
+  end
+
+  def test_less_equals
+    product = FactoryGirl.create(:product, :price => 10.5)
+
+    assert_includes Product.search("price <= 10.5"), product
+    refute_includes Product.search("price <= 10.4"), product
+  end
+end
+

data/test/fulltext_test.rb

@@ -0,0 +1,27 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class FulltextTest < AttrSearchable::TestCase
+  def test_complex
+    product1 = FactoryGirl.create(:product, :title => "word1")
+    product2 = FactoryGirl.create(:product, :title => "word2 word3")
+    product3 = FactoryGirl.create(:product, :title => "word2")
+
+    results = Product.search("title:word1 OR (title:word2 -title:word3)")
+
+    assert_includes results, product1
+    refute_includes results, product2
+    assert_includes results, product3
+  end
+
+  def test_mixed
+    expected = FactoryGirl.create(:product, :title => "Expected title", :stock => 1)
+    rejected = FactoryGirl.create(:product, :title => "Expected title", :stock => 0)
+
+    results = Product.search("title:Expected title:Title stock > 0")
+
+    assert_includes results, expected
+    refute_includes results, rejected
+  end
+end
+

data/test/integer_test.rb

@@ -0,0 +1,61 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class IntegerTest < AttrSearchable::TestCase
+  def test_anywhere
+    product = FactoryGirl.create(:product, :stock => 1)
+
+    assert_includes Product.search("1"), product
+    refute_includes Product.search("0"), product
+  end
+
+  def test_includes
+    product = FactoryGirl.create(:product, :stock => 1)
+
+    assert_includes Product.search("stock: 1"), product
+    refute_includes Product.search("stock: 10"), product
+  end
+
+  def test_equals
+    product = FactoryGirl.create(:product, :stock => 1)
+
+    assert_includes Product.search("stock = 1"), product
+    refute_includes Product.search("stock = 0"), product
+  end
+
+  def test_equals_not
+    product = FactoryGirl.create(:product, :stock => 1)
+
+    assert_includes Product.search("stock != 0"), product
+    refute_includes Product.search("stock != 1"), product
+  end
+
+  def test_greater
+    product = FactoryGirl.create(:product, :stock => 1)
+
+    assert_includes Product.search("stock > 0"), product
+    refute_includes Product.search("stock < 1"), product
+  end
+
+  def test_greater_equals
+    product = FactoryGirl.create(:product, :stock => 1)
+
+    assert_includes Product.search("stock >= 1"), product
+    refute_includes Product.search("stock >= 2"), product
+  end
+
+  def test_less
+    product = FactoryGirl.create(:product, :stock => 1)
+
+    assert_includes Product.search("stock < 2"), product
+    refute_includes Product.search("stock < 1"), product
+  end
+
+  def test_less_equals
+    product = FactoryGirl.create(:product, :stock => 1)
+
+    assert_includes Product.search("stock <= 1"), product
+    refute_includes Product.search("stock <= 0"), product
+  end
+end
+

data/test/not_test.rb

@@ -0,0 +1,27 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class NotTest < AttrSearchable::TestCase
+  def test_not_string
+    expected = FactoryGirl.create(:product, :title => "Expected title")
+    rejected = FactoryGirl.create(:product, :title => "Rejected title")
+
+    results = Product.search("title: Title NOT title: Rejected")
+
+    assert_includes results, expected
+    refute_includes results, rejected
+
+    assert_equal results, Product.search("title: Title -title: Rejected")
+  end
+
+  def test_not_hash
+    expected = FactoryGirl.create(:product, :title => "Expected title")
+    rejected = FactoryGirl.create(:product, :title => "Rejected title")
+
+    results = Product.search(:and => [{:title => "Title"}, {:not => {:title => "Rejected"}}])
+
+    assert_includes results, expected
+    refute_includes results, rejected
+  end
+end
+

data/test/or_test.rb

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

data/test/string_test.rb

@@ -0,0 +1,84 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class StringTest < AttrSearchable::TestCase
+  def test_anywhere
+    product = FactoryGirl.create(:product, :title => "Expected title")
+
+    assert_includes Product.search("Expected"), product
+    refute_includes Product.search("Rejected"), product
+  end
+
+  def test_multiple
+    product = FactoryGirl.create(:product, :comments => [FactoryGirl.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 = FactoryGirl.create(:product, :title => "Expected")
+
+    assert_includes Product.search("title: Expected"), product
+    refute_includes Product.search("title: Rejected"), product
+  end
+
+  def test_includes_with_left_wildcard
+    product = FactoryGirl.create(:product, :title => "Some title")
+
+    assert_includes Product.search("title: Title"), product
+  end
+
+  def test_includes_without_left_wildcard
+    expected = FactoryGirl.create(:product, :brand => "Brand")
+    rejected = FactoryGirl.create(:product, :brand => "Rejected brand")
+
+    results = with_attr_searchable_options(Product, :brand, :left_wildcard => false) { Product.search "brand: Brand" }
+
+    assert_includes results, expected
+    refute_includes results, rejected
+  end
+
+  def test_equals
+    product = FactoryGirl.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 = FactoryGirl.create(:product, :title => "Expected")
+
+    assert_includes Product.search("title != Rejected"), product
+    refute_includes Product.search("title != Expected"), product
+  end
+
+  def test_greater
+    product = FactoryGirl.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 = FactoryGirl.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 = FactoryGirl.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 = FactoryGirl.create(:product, :title => "Title B")
+
+    assert_includes Product.search("title <= 'Title B'"), product
+    refute_includes Product.search("title <= 'Title A'"), product
+  end
+end
+