Chris@1464: # Redmine - project management software Chris@1464: # Copyright (C) 2006-2013 Jean-Philippe Lang Chris@1464: # Chris@1464: # This program is free software; you can redistribute it and/or Chris@1464: # modify it under the terms of the GNU General Public License Chris@1464: # as published by the Free Software Foundation; either version 2 Chris@1464: # of the License, or (at your option) any later version. Chris@1464: # Chris@1464: # This program is distributed in the hope that it will be useful, Chris@1464: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@1464: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@1464: # GNU General Public License for more details. Chris@1464: # Chris@1464: # You should have received a copy of the GNU General Public License Chris@1464: # along with this program; if not, write to the Free Software Chris@1464: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@1464: Chris@1464: module Redmine Chris@1464: module Search Chris@1464: Chris@1464: mattr_accessor :available_search_types Chris@1464: Chris@1464: @@available_search_types = [] Chris@1464: Chris@1464: class << self Chris@1464: def map(&block) Chris@1464: yield self Chris@1464: end Chris@1464: Chris@1464: # Registers a search provider Chris@1464: def register(search_type, options={}) Chris@1464: search_type = search_type.to_s Chris@1464: @@available_search_types << search_type unless @@available_search_types.include?(search_type) Chris@1464: end Chris@1464: end Chris@1464: Chris@1464: module Controller Chris@1464: def self.included(base) Chris@1464: base.extend(ClassMethods) Chris@1464: end Chris@1464: Chris@1464: module ClassMethods Chris@1464: @@default_search_scopes = Hash.new {|hash, key| hash[key] = {:default => nil, :actions => {}}} Chris@1464: mattr_accessor :default_search_scopes Chris@1464: Chris@1464: # Set the default search scope for a controller or specific actions Chris@1464: # Examples: Chris@1464: # * search_scope :issues # => sets the search scope to :issues for the whole controller Chris@1464: # * search_scope :issues, :only => :index Chris@1464: # * search_scope :issues, :only => [:index, :show] Chris@1464: def default_search_scope(id, options = {}) Chris@1464: if actions = options[:only] Chris@1464: actions = [] << actions unless actions.is_a?(Array) Chris@1464: actions.each {|a| default_search_scopes[controller_name.to_sym][:actions][a.to_sym] = id.to_s} Chris@1464: else Chris@1464: default_search_scopes[controller_name.to_sym][:default] = id.to_s Chris@1464: end Chris@1464: end Chris@1464: end Chris@1464: Chris@1464: def default_search_scopes Chris@1464: self.class.default_search_scopes Chris@1464: end Chris@1464: Chris@1464: # Returns the default search scope according to the current action Chris@1464: def default_search_scope Chris@1464: @default_search_scope ||= default_search_scopes[controller_name.to_sym][:actions][action_name.to_sym] || Chris@1464: default_search_scopes[controller_name.to_sym][:default] Chris@1464: end Chris@1464: end Chris@1464: end Chris@1464: end