Skip to content

Commit

Permalink
Added option to limit the auto-completer results by adding a complete…
Browse files Browse the repository at this point in the history
…r_scope to the model.

This can be useful when a permission limits for the auto-completer is needed.
  • Loading branch information
abenari committed Aug 1, 2011
1 parent cc222b3 commit b8c6b1c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
17 changes: 12 additions & 5 deletions lib/scoped_search/auto_complete_builder.rb
Expand Up @@ -16,18 +16,19 @@ class AutoCompleteBuilder

# 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
Expand Down Expand Up @@ -191,7 +192,13 @@ def complete_value

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
Expand Down Expand Up @@ -230,7 +237,7 @@ def complete_key_value(field, token, val)
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
Expand Down
4 changes: 2 additions & 2 deletions lib/scoped_search/definition.rb
Expand Up @@ -250,8 +250,8 @@ def register_named_scope! # :nodoc
# 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
Expand Down

0 comments on commit b8c6b1c

Please sign in to comment.