@@ -221,26 +221,24 @@ Exceptons : 44: search_conditions.each_with_index do |search_condition, index| 45: keyword_name = "keyword_#{index}".to_sym 46: conditions << case search_condition.last -47: # Still thinking about this one -48: # when :integer: integer_conditions(keyword_name, search_condition.first) -49: -50: when :like: like_condition(keyword_name, search_condition.first) -51: when :not: not_like_condition(keyword_name, search_condition.first) -52: -53: when :or: or_condition(keyword_name, search_condition.first) -54: -55: when :less_than_date: less_than_date(keyword_name, search_condition.first) -56: when :less_than_or_equal_to_date: less_than_or_equal_to_date(keyword_name, search_condition.first) -57: when :as_of_date: as_of_date(keyword_name, search_condition.first) -58: when :greater_than_date: greater_than_date(keyword_name, search_condition.first) -59: when :greater_than_or_equal_to_date: greater_than_or_equal_to_date(keyword_name, search_condition.first) -60: -61: when :between_dates: between_dates(keyword_name, search_condition.first) -62: end -63: end -64: -65: [conditions.compact.join(' AND '), @query_params] -66: end +47: # :like also handles integers +48: when :like then like_condition(keyword_name, search_condition.first) +49: when :not then not_like_condition(keyword_name, search_condition.first) +50: +51: when :or then or_condition(keyword_name, search_condition.first) +52: +53: when :less_than_date then less_than_date(keyword_name, search_condition.first) +54: when :less_than_or_equal_to_date then less_than_or_equal_to_date(keyword_name, search_condition.first) +55: when :as_of_date then as_of_date(keyword_name, search_condition.first) +56: when :greater_than_date then greater_than_date(keyword_name, search_condition.first) +57: when :greater_than_or_equal_to_date then greater_than_or_equal_to_date(keyword_name, search_condition.first) +58: +59: when :between_dates then between_dates(keyword_name, search_condition.first) +60: end +61: end +62: +63: [conditions.compact.join(' AND '), @query_params] +64: end </pre> </div> </div> classes/ScopedSearch/QueryConditionsBuilder.html @@ -256,7 +256,7 @@ Build the conditions tree based on the tokens found. 69: end 70: end 71: end -72: +72: 73: return conditions_tree 74: end </pre> classes/ScopedSearch/QueryLanguageParser.html @@ -1 +1 @@ -Thu, 29 Jan 2009 06:38:42 +0100 +Thu, 18 Jun 2009 19:42:19 +0200 created.rid @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Thu Jan 29 06:36:25 +0100 2009</td> + <td>Sun Feb 01 10:38:19 +0100 2009</td> </tr> </table> </div> @@ -71,24 +71,42 @@ <div id="description"> <h1>scoped_search</h1> -This simple plugin will make it easy to search your ActiveRecord models. -Searching is performed using a query string, which should be passed to the -named_scope search_for that uses SQL %LIKE% conditions for searching -(ILIKE for Postgres). You can specify what fields should be used for -searching. +The scoped_search Rails plugin makes it easy to search your +ActiveRecord models. Searching is performed using a query string, which +should be passed to the named_scope search_for that uses SQL +<tt>LIKE %keyword%</tt> conditions for searching (ILIKE for Postgres). You +can specify what fields should be used for searching. <h2>Installing</h2> + +The recommended method to enable scoped_search in your project is adding +the scoped_search gem to your environment. Add the following code to your +Rails configuration in <tt>config/environment.rb</tt>: + +<pre> + Rails::Initializer.run do |config| + ... + config.gem 'wvanbergen-scoped_search', :lib => 'scoped_search', + source => 'http://gems.github.com/' + end +</pre> + +Run <tt>sudo rake gems:install</tt> to install the gem. + + +Another alternative is to install scoped_search as a Rails plugin: + <pre> - gem install wvanbergen-scoped_search -s http://gems.github.com + script/plugin install git://github.com/wvanbergen/scoped_search.git </pre> <h2>Usage</h2> First, you have to specify in what columns should be searched: <pre> - class User < ActiveRecord::Base - searchable_on :first_name, :last_name - end + class User < ActiveRecord::Base + searchable_on :first_name, :last_name + end </pre> Now, the search_for scope is available for queries. You should pass @@ -96,7 +114,7 @@ a query string to the scope. This can be empty or nil, in which case all no search conditions are set (and all records will be returned). <pre> - User.search_for(params[:q]).each { |project| ... } + User.search_for(params[:q]).each { |project| ... } </pre> You can also search on associate models. This works with belongs_to, @@ -105,56 +123,57 @@ You can also search on associate models. This works with belongs_to, created_at, updated_at) <pre> - class User < ActiveRecord::Base - has_many: notes - searchable_on :first_name, :last_name, :notes_title, :notes_content - end + class User < ActiveRecord::Base + has_many: notes + searchable_on :first_name, :last_name, :notes_title, :notes_content + end </pre> The search query language is simple. It supports these constructs: <ul> -<li>words: some search keywords +<li>words: <tt>some search keywords</tt> </li> -<li>phrases: "a single search phrase" +<li>phrases: <tt>"a single search phrase"</tt> </li> -<li>negation: "look for this" -"but do not look for this -phrase and this" -word +<li>negation: <tt>"look for this" -"but do not look for +this phrase and this" -word</tt> </li> -<li>OR words/phrases: word/phrase OR word/phrase. Example: "Hello -World" OR "Hello Moon" +<li>OR words/phrases: word/phrase OR word/phrase. Example: +<tt>"Hello World" OR "Hello Moon"</tt> </li> <li>dates: mm/dd/yyyy, dd/mm/yyyy, yyyy/mm/dd, yyyy-mm-dd </li> <li>date ranges: > date, >= date, < date, <= date, date TO -date. Examples: > mm/dd/yyyy, < yyyy-mm-dd +date. Examples: <tt>> 30/05/1983</tt>, <tt>< 2009-01-30</tt> </li> </ul> -This functionality is build on named_scope. The searchable_on statement -creates a named_scope search_for. Because of this, you can actually -chain the call with other scopes. For example, this can be very useful if -you only want to search in projects that are accessible by a given user. +This functionality is build on <tt>named_scope</tt>. The searchable_on +statement creates a named_scope search_for. Because of this, you can +actually chain the call with other scopes. For example, this can be very +useful if you only want to search in projects that are accessible by a +given user. <pre> - class Project < ActiveRecord::Base - searchable_on :name, :description - named_scope :accessible_by, lambda { |user| ... } - end + class Project < ActiveRecord::Base + searchable_on :name, :description + named_scope :accessible_by, lambda { |user| ... } + end - # using chained named_scopes and will_paginate - Project.accessible_by(current_user).search_for(params[:q]).paginate(:page => params[:page], :include => :tasks) + # using chained named_scopes and will_paginate + Project.accessible_by(current_user).search_for(params[:q]).paginate(:page => params[:page], :include => :tasks) </pre> <h2>Additional resources</h2> <ul> <li>Source code: <a -href="http://github.com/wvanbergen/scoped_search">github.com/wvanbergen/scoped_search</a> +href="http://github.com/wvanbergen/scoped_search/tree/master">github.com/wvanbergen/scoped_search/tree/master</a> </li> <li>Project wiki: <a @@ -166,14 +185,16 @@ href="http://wvanbergen.github.com/scoped_search">wvanbergen.github.com/scoped_s </li> <li>wvanbergen‘s blog posts: <a -href="http://techblog.floorplanner.com/tag/scoped_search">techblog.floorplanner.com/tag/scoped_search</a>/ +href="http://techblog.floorplanner.com/tag/scoped_search">techblog.floorplanner.com/tag/scoped_search</a> </li> </ul> <h2>License</h2> -This plugin is released under the MIT license. Please contact (willem AT -vanbergen DOT org) if you have any suggestions or remarks. +This plugin is released under the MIT license. Please contact weshays (<a +href="http://github.com/weshays">github.com/weshays</a>) or wvanbergen (<a +href="http://github.com/wvanbergen">github.com/wvanbergen</a>) for any +questions. </div> files/README_rdoc.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Thu Jan 29 06:36:13 +0100 2009</td> + <td>Thu Jun 18 19:40:58 +0200 2009</td> </tr> </table> </div> files/lib/scoped_search/query_conditions_builder_rb.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Thu Jan 29 06:36:13 +0100 2009</td> + <td>Wed Feb 25 08:25:46 +0100 2009</td> </tr> </table> </div> files/lib/scoped_search/query_language_parser_rb.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Thu Jan 29 06:36:13 +0100 2009</td> + <td>Wed Feb 25 08:25:35 +0100 2009</td> </tr> </table> </div> files/lib/scoped_search/reg_tokens_rb.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Thu Jan 29 06:36:13 +0100 2009</td> + <td>Wed Feb 25 08:25:35 +0100 2009</td> </tr> </table> </div> files/lib/scoped_search_rb.html @@ -20,9 +20,7 @@ <div id="index"> <h1 class="section-bar">Files</h1> <div id="index-entries"> - <a href="files/CHANGELOG_rdoc.html">CHANGELOG.rdoc</a> <a href="files/README_rdoc.html">README.rdoc</a> - <a href="files/TODO_rdoc.html">TODO.rdoc</a> <a href="files/lib/scoped_search_rb.html">lib/scoped_search.rb</a> <a href="files/lib/scoped_search/query_conditions_builder_rb.html">lib/scoped_search/query_conditions_builder.rb</a> <a href="files/lib/scoped_search/query_language_parser_rb.html">lib/scoped_search/query_language_parser.rb</a> fr_file_index.html 704685658c4ed36d8c00381b2a3237c81d90e59a Willem van Bergen willem@vanbergen.org http://github.com/wvanbergen/scoped_search/commit/1c626dcc3bb2648a64f875331f3e4049de11ef31 1c626dcc3bb2648a64f875331f3e4049de11ef31

2009-06-18T10:42:25-07:00

Publishing newest RDoc documentation for scoped_search 9cab174ea80a26d030bd56515b97583c11694717 Willem van Bergen willem@vanbergen.org