attr_searchable 0.0.4 → 0.0.5

data/README.md

@@ -106,9 +106,9 @@ AttrSearchable will use `LIKE '%...%'` queries. Unfortunately, unless you
 create a [trigram index](http://www.postgresql.org/docs/9.1/static/pgtrgm.html)
 (postgres only), theses queries can not use SQL indices, such that every row
 needs to be scanned by your RDBMS when you search for `Book.search("Harry
-Potter")` or similar. Therefore, AttrSearchable can exploit the fulltext index
-capabilities of MySQL and PostgreSQL. To use already existing fulltext indices,
-simply tell AttrSearchable to use them via:
+Potter")` or similar. To avoid the penalty of `LIKE` queries, AttrSearchable
+can exploit the fulltext index capabilities of MySQL and PostgreSQL. To use
+already existing fulltext indices, simply tell AttrSearchable to use them via:
 
 ```ruby
 class Book < ActiveRecord::Base
@@ -142,13 +142,17 @@ to search in, such that AttrSearchable must no longer search within all fields:
 
 ```ruby
 attr_searchable :all => [:author, :title]
+
 attr_searchable_options :all, :type => :fulltext, :default => true
+
+# Use :default => true to explicitly enable fields as default fields (whitelist approach)
+# Use :default => false to explicitly disable fields as default fields (blacklist approach)
 ```
 
 Now AttrSearchable can optimize the following, not yet optimal query:
 
 ```ruby
-BookSearch("Rowling OR Tolkien stock > 1")
+Book.search("Rowling OR Tolkien stock > 1")
 # MySQL: ... WHERE ((MATCH(books.author) AGAINST('+Rowling' IN BOOLEAN MODE) OR MATCH(books.title) AGAINST('+Rowling' IN BOOLEAN MODE)) OR (MATCH(books.author) AGAINST('+Tolkien' IN BOOLEAN MODE) OR MATCH(books.title) AGAINST('+Tolkien' IN BOOLEAN MODE))) AND books.stock > 1
 # PostgreSQL: ... WHERE ((to_tsvector('simple', books.author) @@ to_tsquery('simple', 'Rowling') OR to_tsvector('simple', books.title) @@ to_tsquery('simple', 'Rowling')) OR (to_tsvector('simple', books.author) @@ to_tsquery('simple', 'Tolkien') OR to_tsvector('simple', books.title) @@ to_tsquery('simple', 'Tolkien'))) AND books.stock > 1
 ```
@@ -156,7 +160,7 @@ BookSearch("Rowling OR Tolkien stock > 1")
 to the following, more performant query:
 
 ```ruby
-BookSearch("Rowling OR Tolkien stock > 1")
+Book.search("Rowling OR Tolkien stock > 1")
 # MySQL: ... WHERE MATCH(books.author, books.title) AGAINST('Rowling Tolkien' IN BOOLEAN MODE) AND books.stock > 1
 # PostgreSQL: ... WHERE to_tsvector('simple', books.author || ' ' || books.title) @@ to_tsquery('simple', 'Rowling | Tokien') and books.stock > 1
 ```
@@ -166,7 +170,7 @@ tries to minimize the fultext constraints within a query, namely `MATCH()
 AGAINST()` for MySQL and `to_tsvector() @@ to_tsquery()` for PostgreSQL.
 
 ```ruby
-BookSearch("(Rowling -Potter) OR Tolkien")
+Book.search("(Rowling -Potter) OR Tolkien")
 # MySQL: ... WHERE MATCH(books.author, books.title) AGAINST('(+Rowling -Potter) Tolkien' IN BOOLEAN MODE)
 # PostgreSQL: ... WHERE to_tsvector('simple', books.author || ' ' || books.title) @@ to_tsquery('simple', '(Rowling & !Potter) | Tolkien')
 ```
@@ -412,6 +416,31 @@ returns an empty relation. However, if you need to debug certain cases, use
 Book.unsafe_search("stock: None") # => raise AttrSearchable::IncompatibleDatatype
 ```
 
+## Reflection
+
+AttrSearchable provides reflective methods, namely `#searchable_attributes`,
+`#default_searchable_attributes`, `#searchable_attribute_options` and
+`#searchable_attribute_aliases`. You can use these methods to e.g. provide an
+individual search help widget for your models, that lists the attributes to
+search in as well as the default ones, etc.
+
+```ruby
+class Product < ActiveRecord::Base
+  include AttrSearchable
+
+  attr_searchable :title, :description
+  attr_searchable_options :title, :default => true
+end
+
+Product.searchable_attributes
+# {"title" => ["products.title"], "description" => ["products.description"]}
+
+Product.default_searchable_attributes
+# {"title" => ["products.title"]}
+
+# ...
+```
+
 ## Contributing
 
 1. Fork it
@@ -422,6 +451,13 @@ Book.unsafe_search("stock: None") # => raise AttrSearchable::IncompatibleDatatyp
 
 ## Changelog
 
+Version 0.0.5:
+
+* Supporting :default => false
+* Datetime/Date greater operator fix
+* Use reflection to find associated models
+* Providing reflection
+
 Version 0.0.4:
 
 * Fixed date attributes

data/attr_searchable.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = AttrSearchable::VERSION
   spec.authors       = ["Benjamin Vetter"]
   spec.email         = ["vetter@flakks.com"]
-  spec.description   = %q{Search-engine like fulltext query support for ActiveRecord}
-  spec.summary       = %q{Easily perform complex search-engine like fulltext queries on your ActiveRecord models}
+  spec.description   = %q{Search engine like fulltext query support for ActiveRecord}
+  spec.summary       = %q{Easily perform complex search engine like fulltext queries on your ActiveRecord models}
   spec.homepage      = "https://github.com/mrkamel/attr_searchable"
   spec.license       = "MIT"
 

data/lib/attr_searchable.rb

@@ -73,6 +73,14 @@ module AttrSearchable
       end
     end
 
+    def default_searchable_attributes
+      keys = searchable_attribute_options.select { |key, value| value[:default] == true }.keys
+      keys = searchable_attributes.keys.reject { |key| searchable_attribute_options[key] && searchable_attribute_options[key][:default] == false } if keys.empty?
+      keys = keys.to_set
+
+      searchable_attributes.select { |key, value| keys.include? key }
+    end
+
     def search(query)
       unsafe_search query
     rescue AttrSearchable::RuntimeError

data/lib/attr_searchable/version.rb

@@ -1,3 +1,3 @@
 module AttrSearchable
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/attr_searchable_grammar.rb

@@ -84,10 +84,7 @@ module AttrSearchableGrammar
 
   class AnywhereExpression < BaseNode
     def evaluate
-      keys = model.searchable_attribute_options.select { |key, value| value[:default] == true }.keys
-      keys = model.searchable_attributes.keys if keys.empty?
-
-      queries = keys.collect { |key| collection_for key }.select { |collection| collection.compatible? text_value }.collect { |collection| collection.matches text_value }
+      queries = model.default_searchable_attributes.keys.collect { |key| collection_for key }.select { |collection| collection.compatible? text_value }.collect { |collection| collection.matches text_value }
 
       raise AttrSearchable::NoSearchableAttributes if queries.empty?
 

data/lib/attr_searchable_grammar/attributes.rb

@@ -59,7 +59,7 @@ module AttrSearchableGrammar
         klass = model.searchable_attribute_aliases[table]
         klass ||= table
 
-        klass.classify.constantize
+        model.reflections[klass.to_sym] ? model.reflections[klass.to_sym].klass : klass.classify.constantize
       end
 
       def alias_for(table)
@@ -182,6 +182,10 @@ module AttrSearchableGrammar
         between(parse(value)).not
       end
 
+      def gt(value)
+        super parse(value).last
+      end
+
       def between(range)
         gteq(range.first).and(lteq(range.last))
       end

data/test/attr_searchable_test.rb

@@ -49,7 +49,7 @@ class AttrSearchableTest < AttrSearchable::TestCase
     assert_includes results, product2
   end
 
-  def test_custom_default
+  def test_custom_default_enabled
     product1 = create(:product, :title => "Expected")
     product2 = create(:product, :description => "Expected")
     product3 = create(:product, :brand => "Expected")
@@ -61,10 +61,36 @@ class AttrSearchableTest < AttrSearchable::TestCase
     refute_includes results, product3
   end
 
+  def test_custom_default_disabled
+    product1 = create(:product, :brand => "Expected")
+    product2 = create(:product, :notice => "Expected")
+
+    results = with_attr_searchable_options(Product, :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_searchable_attributes_true
+    with_attr_searchable_options(Product, :title, :default => true) do
+      with_attr_searchable_options(Product, :description, :default => true) do
+        assert_equal ["title", "description"], Product.default_searchable_attributes.keys
+      end
+    end
+  end
+
+  def test_default_searchable_attributes_false
+    with_attr_searchable_options(Product, :title, :default => false) do
+      with_attr_searchable_options(Product, :description, :default => false) do
+        assert_equal Product.searchable_attributes.keys - ["title", "description"], Product.default_searchable_attributes.keys
+      end
+    end
+  end
 end
 

data/test/date_test.rb

@@ -41,8 +41,8 @@ class DateTest < AttrSearchable::TestCase
   def test_greater
     product = create(:product, :created_on => Date.parse("2014-05-01"))
 
-    assert_includes Product.search("created_on < 2014-05-02"), product
-    refute_includes Product.search("created_on < 2014-05-01"), product
+    assert_includes Product.search("created_on > 2014-04-01"), product
+    refute_includes Product.search("created_on > 2014-05-01"), product
   end
 
   def test_greater_equals

data/test/datetime_test.rb

@@ -42,8 +42,8 @@ class DatetimeTest < AttrSearchable::TestCase
   def test_greater
     product = 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
+    assert_includes Product.search("created_at > 2014-04-01"), product
+    refute_includes Product.search("created_at > 2014-05-01"), product
   end
 
   def test_greater_equals

data/test/test_helper.rb

@@ -34,7 +34,7 @@ end
 class Product < ActiveRecord::Base
   include AttrSearchable
 
-  attr_searchable :title, :description, :brand, :stock, :price, :created_at, :created_on, :available
+  attr_searchable :title, :description, :brand, :notice, :stock, :price, :created_at, :created_on, :available
   attr_searchable :comment => ["comments.title", "comments.message"], :user => ["users.username", "users_products.username"]
   attr_searchable :primary => [:title, :description]
 
@@ -81,6 +81,7 @@ ActiveRecord::Base.connection.create_table :products do |t|
   t.date :created_on
   t.boolean :available
   t.string :brand
+  t.string :notice
 end
 
 ActiveRecord::Base.connection.create_table :comments do |t|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_searchable
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-05 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -123,7 +123,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Search-engine like fulltext query support for ActiveRecord
+description: Search engine like fulltext query support for ActiveRecord
 email:
 - vetter@flakks.com
 executables: []
@@ -189,7 +189,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Easily perform complex search-engine like fulltext queries on your ActiveRecord
+summary: Easily perform complex search engine like fulltext queries on your ActiveRecord
   models
 test_files:
 - test/and_test.rb