scoped_search 2.3.1 → 2.3.3

data/README.rdoc

@@ -5,27 +5,28 @@ models. Searching is performed using a query string, which should be passed to
 the named_scope <tt>search_for</tt>. Based on a definition in what fields to
 look, it will build query conditions and return those as a named scope.
 
-Scoped search is great if you want to offer a simple search box to your users
-and build a query based on the search string they enter. If you want to build a
-more complex search form with multiple fields, searchlogic (see
-http://github.com/binarylogic/searchlogic) may be a good choice for you.
+Scoped search is great if you want to offer a simple yet powerful search box to your users
+and build a query based on the search string they enter. It comes with a built-in search syntax
+auto-completer and a value auto-completer. It also comes with a set of helpers that makes it easy
+to create a clean web UI with sorting and an ajax auto-completer.
+
+== Preview
+A demo application using the scoped search can be found here: http://github.com/abenari/scoped_search_demo_app
+A running version of the demo application can be found here: http://scope-search-demo.heroku.com
 
 == Installing
+For a Rails 3 application add the following line in your Gemfile, and run <tt>bundle install</tt>:
+
+  gem "scoped_search"
 
-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>, and run <tt>rake
-gems:install</tt> to install the gem.:
+For Rails 2 Add the following code to your Rails configuration in <tt>config/environment.rb</tt>,
+and run <tt>rake gems:install</tt> to install the gem.:
 
   Rails::Initializer.run do |config|
     ...
     config.gem 'scoped_search'
   end
 
-Alternatively, install scoped search as a Rails plugin (*deprecated*):
-
-  script/plugin install git://github.com/wvanbergen/scoped_search.git
-
 == Usage
 
 Scoped search requires you to define the fields you want to search in:
@@ -119,6 +120,7 @@ For more info, see the the project wiki: http://github.com/wvanbergen/scoped_sea
 * Issue tracker: http://github.com/wvanbergen/scoped_search/issues
 * RDoc documentation: http://rdoc.info/projects/wvanbergen/scoped_search
 * wvanbergen's blog posts: http://techblog.floorplanner.com/tag/scoped_search
+* abenari's blog: http://scopedsearch.wordpress.com/
 
 == License
 

data/lib/scoped_search/auto_complete_builder.rb

@@ -16,18 +16,19 @@ module ScopedSearch
 
     # This method will parse the query string and build  suggestion list using the
     # search query.
-    def self.auto_complete(definition, query)
+    def self.auto_complete(definition, query, options = {})
       return [] if (query.nil? or definition.nil? or !definition.respond_to?(:fields))
 
-      new(definition, query).build_autocomplete_options
+      new(definition, query, options).build_autocomplete_options
     end
 
     # Initializes the instance by setting the relevant parameters
-    def initialize(definition, query)
+    def initialize(definition, query, options)
       @definition = definition
       @ast        = ScopedSearch::QueryLanguage::Compiler.parse(query)
       @query      = query
       @tokens     = tokenize
+      @options    = options
     end
 
     # Test the validity of the current query and suggest possible completion
@@ -191,7 +192,13 @@ module ScopedSearch
 
       opts = value_conditions(field.field, val)
       opts.merge!(:limit => 20, :select => "DISTINCT #{field.field}")
-      return field.klass.all(opts).map(&field.field).compact.map{|v| v.to_s =~ /\s+/ ? "\"#{v}\"" : v}
+
+      return completer_scope(field.klass).all(opts).map(&field.field).compact.map{|v| v.to_s =~ /\s+/ ? "\"#{v}\"" : v}
+    end
+
+    def completer_scope(klass)
+      return klass unless klass.respond_to?(:completer_scope)
+      klass.completer_scope(@options)
     end
 
     # set value completer
@@ -230,7 +237,7 @@ module ScopedSearch
       else
         opts.merge!(key_opts)
       end
-      return field.klass.all(opts.merge(:limit => 20)).map(&field.field).compact.map{|v| v.to_s =~ /\s+/ ? "\"#{v}\"" : v}
+      return completer_scope(field.klass).all(opts.merge(:limit => 20)).map(&field.field).compact.map{|v| v.to_s =~ /\s+/ ? "\"#{v}\"" : v}
     end
 
     #this method returns conditions for selecting completion from partial value

data/lib/scoped_search/definition.rb

@@ -250,8 +250,8 @@ end
 # Registers the complete_for method within the class that is used for searching.
  def register_complete_for! # :nodoc
 @klass.class_eval do
-  def self.complete_for (query)
-    search_options = ScopedSearch::AutoCompleteBuilder.auto_complete(@scoped_search , query)
+  def self.complete_for (query, options = {})
+    search_options = ScopedSearch::AutoCompleteBuilder.auto_complete(@scoped_search , query, options)
     search_options
     end
   end

data/lib/scoped_search/query_builder.rb

@@ -206,7 +206,7 @@ module ScopedSearch
       elsif field.set?
         return set_test(field, operator, value, &block)
       else
-        value = value.to_i if field.numerical?
+        value = value.to_i if field.offset
         yield(:parameter, value)
         return "#{field.to_sql(operator, &block)} #{self.sql_operator(operator, field)} ?"
       end

data/lib/scoped_search/rails_helper.rb

@@ -200,7 +200,7 @@ module ScopedSearch
     # In your controller, you'll need to define an action called
     # auto_complete_method to respond the JQuery calls,
     def auto_complete_field_tag_jquery(method, val,tag_options = {}, completion_options = {})
-      url = url_for(:action => "auto_complete_#{method}")
+      url = url_for(:action => "auto_complete_#{method}", :filter => completion_options[:filter])
       options = tag_options.merge(:class => "auto_complete_input")
       text_field_tag(method, val, options) + auto_complete_clear_value_button(method) +
           auto_complete_field_jquery(method, url, completion_options)

data/lib/scoped_search.rb

@@ -14,7 +14,7 @@ module ScopedSearch
 
   # The current scoped_search version. Do not change thisvalue by hand,
   # because it will be updated automatically by the gem release script.
-  VERSION = "2.3.1"
+  VERSION = "2.3.3"
 
   # The ClassMethods module will be included into the ActiveRecord::Base class
   # to add the <tt>ActiveRecord::Base.scoped_search</tt> method and the

data/scoped_search.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
   
   # Do not change the version and date fields by hand. This will be done
   # automatically by the gem release script.
-  s.version = "2.3.1"
-  s.date    = "2011-06-22"
+  s.version = "2.3.3"
+  s.date    = "2011-09-06"
 
   s.summary = "Easily search you ActiveRecord models with a simple query language using a named scope."
   s.description = <<-EOS

data/spec/integration/ordinal_querying_spec.rb

@@ -9,8 +9,8 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
     before(:all) do
       ScopedSearch::RSpec::Database.establish_named_connection(db)
 
-      @class = ScopedSearch::RSpec::Database.create_model(:int => :integer, :timestamp => :datetime, :date => :date, :unindexed => :integer) do |klass|
-        klass.scoped_search :on => [:int, :timestamp]
+      @class = ScopedSearch::RSpec::Database.create_model(:int => :integer, :dec => :decimal ,:timestamp => :datetime, :date => :date, :unindexed => :integer) do |klass|
+        klass.scoped_search :on => [:int, :dec, :timestamp]
         klass.scoped_search :on => :date, :only_explicit => true
       end
     end
@@ -23,7 +23,7 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
     context 'querying numerical fields' do
 
       before(:all) do
-        @record = @class.create!(:int =>  9)
+        @record = @class.create!(:int =>  9, :dec => 1.23)
       end
 
       after(:all) do
@@ -34,6 +34,10 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         @class.search_for('9').should have(1).item
       end
 
+      it "should find the record with an exact decimal match" do
+        @class.search_for('1.23').should have(1).item
+      end
+
       it "should find the record with an exact integer match with an explicit operator" do
         @class.search_for('= 9').should have(1).item
       end

data/spec/lib/database.rb

@@ -37,7 +37,8 @@ module ScopedSearch::RSpec::Database
     table_name = "model_#{rand}".gsub(/\./, '')
     ActiveRecord::Migration.create_table(table_name) do |t|
       fields.each do |name, field_type|
-        t.send(field_type.to_s.gsub(/^unindexed_/, '').to_sym, name)
+        options = (field_type == :decimal) ? { :scale => 2, :precision => 10 } : {}
+        t.send(field_type.to_s.gsub(/^unindexed_/, '').to_sym, name, options)
       end
     end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scoped_search
 version: !ruby/object:Gem::Version 
+  hash: 5
   prerelease: false
   segments: 
   - 2
   - 3
-  - 1
-  version: 2.3.1
+  - 3
+  version: 2.3.3
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-22 00:00:00 -04:00
+date: 2011-09-06 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,6 +27,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 2
         - 1
@@ -41,6 +43,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 2
         - 0
@@ -55,6 +58,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -127,6 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -135,6 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"