tkh_search 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9c13ad8f8bddb6d3311a81e0683b7099da3266b
-  data.tar.gz: e62e6ff23763187aab3bcf9c541a83cb3be30e04
+  metadata.gz: f841b1c6de3922288a8b195e26bdf5eae7ff36a1
+  data.tar.gz: f6c22d243a74e9ce7d2a9c73f3770e094bd7fa91
 SHA512:
-  metadata.gz: e89dfc96b69c2073d471b6dcfe577bf13b105dd33ad5b4bbc1cd5a22585a55eb884f7825b854fa018dd20f8abf62e47eaf2dabdc924b14c254611c8173f23db0
-  data.tar.gz: 3696b630bc4c8dd5e326f5f0a603e4083b1600d7ed5ba9f896b21c0a75f901cfaa94b3edcdb19bd82c7a483f2f045dacfd75f05a8e4fed0a9a5d53f3737b85eb
+  metadata.gz: e7b51e786aeee4008a5b3887a6edc1bf9c7796c3fd773846d1c467840a6edf41e0b1b010e4e76e16002d39c3dd5c1e366e80c660dd33cf958662029faeb3ab2a
+  data.tar.gz: 1be653cc71a1ec89da1bf45ed56d1f7a8e43aaaba423ccc61a9c75c1e6d0be00cf463599f003909ebae55fe1768e004ebf30fecb0c9da086727f031aca46db41

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# TKH Search
+
+
+
+## 0.0.3
+
+* Added this changelog file.
+* Did a bit of eager loading during searches but the algorithm is still VERY slow. Serious ptimization is in the works.
+* Search results work when model has title attribute but no name attribute.
+* Improved the readme file a bit.
+
+
+## 0.0.2
+
+* Changed a model name to debug Constant name conflict
+
+
+## 0.0.1
+
+* Initial release with basic indexing and search

data/README.md

@@ -1,6 +1,6 @@
 # TkhSearch
 
-This is a simple Rails gem search engine. It uses the local database for reverse indexing and to log search queries. Multi-model searches are supported.
+This is a simple Rails gem full text search engine. It uses the local database for reverse indexing and to log search queries. Multi-model searches are supported.
 
 
 ## Installation
@@ -19,6 +19,10 @@ Install initializer and migrations:
 
     $ rake tkh_search:install
 
+Or, upon updating the gem:
+
+    $ rake tkh_search:update
+
 Run the migrations:
 
     $ rake db:migrate
@@ -29,8 +33,11 @@ Run the migrations:
 In any model you want to index and search, copy/paste and customize the following code:
 
 ```ruby
-tkh_searchable
+tkh_searchable # for after_save re-indexing hooks
 def self.tkh_search_indexable_fields
+  # The key is the attribute name, the value is the desired strength.
+  # By the way, your model needs a title or a name attribute. Real or virtual.
+  # Necessary to display result links
   indexable_fields = {
     title: 8,
     description: 3,
@@ -47,7 +54,7 @@ To index a model's records, use the _'reverse_indexing'_ class method. Example:
 ModelName.reverse_indexing
 ```
 
-Having configured all the models you wish to index in your search engine, you can index them all by first setting up the initializer.
+Having configured all the models you wish to index in your search engine, you can index them all at once by first setting up the initializer.
 
 ```ruby
 TkhSearch::TkhSearchable.indexable_models = %w( Page Post Event WhateverYouWant )
@@ -55,6 +62,10 @@ TkhSearch::TkhSearchable.indexable_models = %w( Page Post Event WhateverYouWant
 
 and secondly, by pointing your browser to: /index_all_models
 
+#### What about new and updated records?
+
+Any single record will be indexed upon saving.
+
 
 ## Searching your site
 

data/app/controllers/search_controller.rb

@@ -7,7 +7,7 @@ class SearchController < ApplicationController
     token = SecureRandom.base64
     search_terms = []
     @query.split.each do |query_word|
-      search_terms << TkhSearchTerm.find_by( word: query_word )
+      search_terms << TkhSearchTerm.includes(:tkh_search_instances).find_by( word: query_word )
     end
     if search_terms.any?
       search_terms.each do |search_term|

data/app/views/search/_search_results.html.erb

@@ -2,9 +2,16 @@
   <% if search_results.any? %>
     <% search_results.each do |result| %>
       <% record = (Kernel.const_get result.model_name).find(result.model_record_id) %>
+      <% if defined? record.name %>
+        <% link_label = record.name %>
+      <% elsif defined? record.title %>
+        <% link_label = record.title %>
+      <% else %>
+        <% link_label = 'no title or name' %>
+      <% end %>
       <%= content_tag :li,
         "<span class='sr-model-name'>#{result.model_name}</span> -
-        <span class='sr-model-name'>#{link_to record.name, record}</span> -
+        <span class='sr-record-link'>#{link_to link_label, record}</span> -
         <span class='sr-rating'>#{result.rating}</span>
         ".html_safe
       %>

data/lib/tkh_search/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tkh_search
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Swami Atma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-07 00:00:00.000000000 Z
+date: 2014-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md