attr_searchable 0.0.2 → 0.0.3

data/README.md

@@ -104,28 +104,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, which is btw. usually ok for small data sets and a small
-amount of regular queries. Contrary, when you search for
-`Book.search("title=Potter")` indices can and will be used. Moreover, other
-indices (on price, stock, etc) will of course be used by your RDBMS when you
-search for `Book.search("stock > 0")`, etc.
-
-Regarding the `LIKE` penalty, the easiest way to make them use indices is
-to remove the left wildcard. AttrSearchble supports this via:
-
-```ruby
-class Book < ActiveRecord::Base
-  # ...
-
-  attr_searchable_options, :title, :left_wildcard => false
-
-  # ...
-end
-```
-
-However, this is often not desirable. 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. 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:
 
 ```ruby
 class Book < ActiveRecord::Base
@@ -148,7 +129,7 @@ Book.search("Harry Potter")
 ```
 
 Obviously, theses queries won't always return the same results as wildcard
-`LIKE` queries, because we search for words instead of substrings. However,
+`LIKE` queries, because we search for words instead of sub-strings. However,
 fulltext indices will usually of course provide better performance.
 
 Moreover, the query above is not yet perfect. To improve it even more,
@@ -229,6 +210,14 @@ attr_searchable_options :title, :dictionary => "english"
 For more details about PostgreSQL fulltext indices visit
 [http://www.postgresql.org/docs/9.3/static/textsearch.html](http://www.postgresql.org/docs/9.3/static/textsearch.html)
 
+## Other indices
+
+In case you expose non-fulltext attributes to search queries (price, stock,
+etc.), the respective queries, like `Book.search("stock > 0")`, will profit
+from from the usual non-fulltext indices. Thus, you should add a usual index on
+every column you expose to search queries plus a fulltext index for every
+fulltext attribute.
+
 ## Associations
 
 If you specify searchable attributes from another model, like
@@ -237,14 +226,32 @@ If you specify searchable attributes from another model, like
 class Book < ActiveRecord::Base
   # ...
 
+  belongs_to :author
+
   attr_searchable :author => "author.name"
 
   # ...
 end
 ```
 
-AttrSearchable will by default `eager_load` these associations, when you
-perform `Book.search(...)`. If you don't want that or need to perform special
+AttrSearchable will by default `eager_load` the referenced associations, when
+you perform `Book.search(...)`. Assocations of associations can thus as well be
+referenced and used:
+
+```ruby
+class Book < ActiveRecord::Base
+  # ...
+
+  has_many :comments
+  has_many :users, :through => :comments
+
+  attr_searchable :user => "users.username"
+
+  # ...
+end
+```
+
+If you don't want the automatic `eager_load` or need to perform special
 operations, define a `search_scope` within your model:
 
 ```ruby
@@ -333,9 +340,11 @@ Thus, if you use fulltext indices, you better avoid chaining.
 
 ## Debugging
 
-AttrSearchable conveniently hides certain errors, like parse errors, and
-instead returns an empty relation. However, if you need to debug certain
-cases, use `Model#unsafe_search`, which will raise them.
+When using `Model#search`, AttrSearchable conveniently prevents certain
+exceptions from being raised in case the query string passed to it is invalid
+(parse errors, incompatible datatype errors, etc). Instead, `Model#search`
+returns an empty relation. However, if you need to debug certain cases, use
+`Model#unsafe_search`, which will raise them.
 
 ```ruby
 Book.unsafe_search("stock: None") # => raise AttrSearchable::IncompatibleDatatype
@@ -348,3 +357,17 @@ Book.unsafe_search("stock: None") # => raise AttrSearchable::IncompatibleDatatyp
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Changelog
+
+Version 0.0.3:
+
+* belongs_to association fixes
+
+Version 0.0.2:
+
+* Arel abstraction layer added
+* count() queries resulting in "Cannot visit AttrSearchableGrammar::Nodes..." fixed
+* Better error messages
+* Model#unsafe_search added
+

data/lib/attr_searchable.rb

@@ -53,9 +53,9 @@ module AttrSearchable
     def attr_searchable_hash(hash)
       hash.each do |key, value|
         self.searchable_attributes[key.to_s] = Array(value).collect do |column|
-          table, attribute = column.to_s =~ /\./ ? column.to_s.split(".") : [name, column]
+          table, attribute = column.to_s =~ /\./ ? column.to_s.split(".") : [name.tableize, column]
 
-          "#{table.tableize}.#{attribute}"
+          "#{table}.#{attribute}"
         end
       end
     end

data/lib/attr_searchable/version.rb

@@ -1,3 +1,3 @@
 module AttrSearchable
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/attr_searchable_test.rb

@@ -2,7 +2,7 @@
 require File.expand_path("../test_helper", __FILE__)
 
 class AttrSearchableTest < AttrSearchable::TestCase
-  def test_associations
+  def test_multi_associations
     product = create(:product, :comments => [
       create(:comment, :title => "Title1", :message => "Message1"),
       create(:comment, :title => "Title2", :message => "Message2")
@@ -12,6 +12,26 @@ class AttrSearchableTest < AttrSearchable::TestCase
     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_multiple
     product = create(:product, :comments => [create(:comment, :title => "Title", :message => "Message")])
 

data/test/test_helper.rb

@@ -20,13 +20,22 @@ DATABASE = ENV["DATABASE"] || "sqlite"
 
 ActiveRecord::Base.establish_connection YAML.load_file(File.expand_path("../database.yml", __FILE__))[DATABASE]
 
-class Comment < ActiveRecord::Base; end
+class User < ActiveRecord::Base; end
+
+class Comment < ActiveRecord::Base
+  include AttrSearchable
+
+  belongs_to :user
+
+  attr_searchable :user => "user.username"
+  attr_searchable :title, :message
+end
 
 class Product < ActiveRecord::Base
   include AttrSearchable
 
   attr_searchable :title, :description, :brand, :stock, :price, :created_at, :available
-  attr_searchable :comment => ["comments.title", "comments.message"]
+  attr_searchable :comment => ["comments.title", "comments.message"], :user => "users.username"
 
   attr_searchable :primary => [:title, :description]
 
@@ -41,6 +50,7 @@ class Product < ActiveRecord::Base
   end
 
   has_many :comments
+  has_many :users, :through => :comments
 end
 
 FactoryGirl.define do
@@ -49,10 +59,14 @@ FactoryGirl.define do
 
   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 comments"
+ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS users"
 
 ActiveRecord::Base.connection.create_table :products do |t|
   t.string :title
@@ -66,10 +80,15 @@ 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)"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_searchable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-21 00:00:00.000000000 Z
+date: 2014-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop