search_scope 0.1.9 → 0.2.1

data/Manifest

@@ -4,3 +4,4 @@ lib/search_scope.rb
 Manifest
 Rakefile
 README
+search_scope.tmproj

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('search_scope', '0.1.9') do |p|
+Echoe.new('search_scope', '0.2.1') do |p|
   p.description    = "Simplify searching a model by defining custom named_scopes."
   p.project        = 'search-scope'
   p.url            = "http://rubyforge.org/projects/search-scope"

data/lib/search_scope.rb

@@ -7,6 +7,102 @@ module SearchScope
     end
   end
 
+  
+  # filter_scope :author_gender, lambda { |value| { :conditions => ["authors.gender = ?", value], :include => {:authorships => :author} } } do 
+  #   filter_option :male, :label => 'Male Authors'
+  #   filter_option :female, :label => 'Female Authors'
+  #   filter_option :unspecified, :scope => :unspecified_author_gender
+  # end
+  
+
+  class FilterScopeOption
+    #options can supply a value to fill in for their filter_scope, or a separate scope (symbol for a named_scope) or conditions/include to use instead.
+    attr_reader :key, :value, :label, :scope
+    def initialize(key, value, label, scope=nil)
+      label ||= key.to_s.titleize
+      value ||= key
+      value = value.to_s if value.is_a? Symbol
+      @key, @value, @label, @scope = key, value, label, scope
+    end
+  end
+
+  class FilterScope
+    attr_reader :name, :label, :filter_options, :filter_option_keys
+    def initialize(name, label, options={}, &block)
+      label ||= name.to_s.titleize
+      @name, @label = name, label
+      @filter_options = HashWithIndifferentAccess.new
+      @filter_option_keys = []
+      @omit_from_ui = true if options.delete(:omit_from_ui)
+      #eval the block so that filter options can be initialized. Should only have calls to filter_option
+      instance_eval(&block)
+    end
+    
+    def omit_from_ui?
+      @omit_from_ui ? true : false
+    end
+
+    def filter_option(name, options={})
+      name = name.to_s
+      raise "Already defined a filter_option (#{name.inspect}) for filter_scope (#{self.name})}" if filter_option_keys.include? name
+      @filter_options_ordered = nil
+      filter_option_keys << name
+      filter_options[name] = FilterScopeOption.new(name, options[:value], options[:label], options[:scope])
+    end
+    
+    def filter_options_ordered
+      return @filter_options_ordered if @filter_options_ordered
+      @filter_options_ordered = []
+      filter_option_keys.each do |key|
+        @filter_options_ordered << filter_options[key]
+      end
+      @filter_options_ordered
+    end
+    
+    def key
+      @key ||= "filter_#{name}".intern
+    end
+
+    def params_key
+      @params_key ||= key.to_s
+    end
+    
+    def selected_option_for(params)
+      selected_option_key = params[self.params_key]
+      self.filter_options[selected_option_key]
+    end
+    
+  end
+
+  #filter scope blocks are not passed through to named_scope. Instead they are eval'd for filter_options.
+  def filter_scope(name, proc, options={}, &block)
+    proc, options = nil, proc if proc.is_a?(Hash)
+    #default the search to a LIKE search if nothing is given
+    label = options.delete(:label)
+    #setup standard filters
+    if proc
+      #do nothing, it's custom
+    elsif options.blank?
+      proc = lambda { |term| { :conditions => ["#{table_name}.#{name} LIKE ?", "%#{term}%"] } }
+    elsif options.is_a?(Hash) && options[:search_type]
+      case options[:search_type]
+      when :exact_match
+        proc = lambda { |term| { :conditions => ["#{table_name}.#{name} = ?", term] } }
+      else
+        raise "unknown search_type for filter_scope: (#{name} - #{options[:search_type]})"
+      end
+    end
+    raise "Already defined a filter_scope with name: #{name.inspect}" if filter_scope_keys.include? name
+    @filter_scopes_ordered = nil
+    
+    scope = FilterScope.new name, label, :omit_from_ui => options.delete(:omit_from_ui), &block
+
+    filter_scope_keys << scope.key
+    filter_scopes[scope.key] = scope
+
+    named_scope(scope.key, proc || options)
+  end
+
   def sort_search_by(name, options={})
     options[:label] ||= name.to_s.titleize
     if options[:order].blank?
@@ -22,8 +118,6 @@ module SearchScope
     end
     options[:order], options[:reverse] = options[:reverse], options[:order] if options[:reverse_orders]
     
-    # puts "***(#{self.name}).sort_search_by :#{name}, #{options.inspect}"
-    
     raise "you must supply a Symbol for a name to new_sortable_by (#{name.inspect})" unless name.is_a? Symbol
     return if sort_choices_hash.keys.include? name.to_s
     #the first sort added becomes the default sorting for all searches
@@ -34,7 +128,7 @@ module SearchScope
     sort_choices << sort_choices_hash[name]
   end
   
-  def search_scope(name, options = {}, &block)
+  def search_scope(name, options={}, &block)
     #default the search to a LIKE search if nothing is given
     if options.blank?
       options = lambda { |term| { :conditions => ["#{table_name}.#{name} LIKE ?", "%#{term}%"] } }
@@ -56,7 +150,11 @@ module SearchScope
   def search_scope_keys
     @search_scope_keys ||= []
   end
-  
+
+  def filter_scope_keys
+    @filter_scope_keys ||= []
+  end
+
   def default_sort_choice
     @default_sort_choice
   end
@@ -74,6 +172,49 @@ module SearchScope
     @quick_search_scopes ||= []
   end
 
+  def filter_scopes
+    @filter_scopes ||= HashWithIndifferentAccess.new
+  end
+  
+  def filter_scopes_ordered
+    return @filter_scopes_ordered if @filter_scopes_ordered
+    @filter_scopes_ordered = []
+    filter_scope_keys.each do |key|
+      @filter_scopes_ordered << filter_scopes[key]
+    end
+    @filter_scopes_ordered
+  end
+
+  def active_filter_scopes_for(params, options={}, &block)
+    active_filter_scopes = [] unless block
+    filter_scopes_ordered.each do |filter_scope|
+      selected_option = filter_scope.selected_option_for(params)
+      if selected_option
+        if block
+          yield filter_scope, selected_option
+        else 
+          active_filter_scopes << [filter_scope, selected_option]
+        end
+      end
+    end
+    block ? nil : active_filter_scopes
+  end
+
+  def inactive_filter_scopes_for(params, options={}, &block)
+    inactive_filter_scopes = [] unless block
+    filter_scopes_ordered.each do |filter_scope|
+      selected_option = filter_scope.selected_option_for(params)
+      unless selected_option
+        if block
+          yield filter_scope
+        else 
+          inactive_filter_scopes << filter_scope
+        end
+      end
+    end
+    block ? nil : inactive_filter_scopes
+  end
+
   def sort_search_by_options(sort_by, reverse=nil)
     if reverse.nil? || reverse.empty?
       reverse = false
@@ -110,15 +251,15 @@ module SearchScope
     end
     scopes
   end
-  
-  def get_named_scope_from_object(object, scope, *args)
-    scope = object.send(scope, *args)
-  end
 
-  def get_search_scope_from_object(object, scope, *args)
-    scope_name = "search_#{scope}".intern 
+  def get_named_scope_from_object(object, scope_name, *args)
     scope = object.send(scope_name, *args)
   end
+
+  def get_search_scope_from_object(object, scope_name, *args)
+    scope_name = "search_#{scope_name}".intern 
+    get_named_scope_from_object object, scope_name, *args
+  end
   
   def quick_search_scope_options(quick_search_terms, split_terms)
     conditions = []
@@ -151,11 +292,26 @@ module SearchScope
     {:conditions => conditions_sql, :include => includes}
   end
   
+  def extract_filter_params(params)
+    filter_params = {}
+    params.keys.each do |key|
+      key = key.to_s#.intern
+      filter_params[key] = params.delete key if filter_scope_keys.include? key.intern
+    end
+    filter_params
+  end
+  
   #this searches by chaining all of the named_scopes (search_scopes) that were included in the params
   def search(params={})
+    params = params.clone
+    #this lets you do a quick_search like: Book.search('foo')  instead of Book.search(:quick_search => 'foo')
+    params = {:quick_search => params} unless params.kind_of? Hash
     params.reverse_merge! :split_terms => true
     paginate = params.delete :paginate
     aggregate_scope = self
+    
+    filter_params = extract_filter_params params
+    
     search_scopes(params).each do |scope|
       if scope.is_a? Symbol
         # aggregate_scope = aggregate_scope.send(scope)
@@ -167,6 +323,24 @@ module SearchScope
         raise "unsupported type for search scope: #{scope.inspect}"
       end
     end
+
+    filter_params.each do |filter_scope_key, filter_option_key|
+      filter_scope_key = filter_scope_key.intern unless filter_scope_key.is_a? Symbol
+      filter_option_key = filter_option_key.intern unless filter_option_key.blank? || filter_option_key.is_a?(Symbol)
+      next if filter_option_key.blank?
+      
+      filter_scope = filter_scopes[filter_scope_key]
+      filter_option = filter_scope.filter_options[filter_option_key]
+
+      raise "search_scope: No filter option found with key: #{filter_option_key.inspect}" unless filter_option
+      
+      if filter_option.scope
+        aggregate_scope = get_named_scope_from_object(aggregate_scope, filter_option.scope)
+      else
+        aggregate_scope = get_named_scope_from_object(aggregate_scope, filter_scope_key, filter_option.value)
+      end
+    end
+
     #TODO add filter_scopes here as well
     aggregate_scope = aggregate_named_scope(aggregate_scope, params)
     

data/search_scope.gemspec

@@ -2,26 +2,25 @@
 
 Gem::Specification.new do |s|
   s.name = %q{search_scope}
-  s.version = "0.1.9"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Owens"]
-  s.date = %q{2009-01-23}
+  s.date = %q{2009-07-24}
   s.description = %q{Simplify searching a model by defining custom named_scopes.}
   s.email = %q{ryan@infoether.com}
   s.extra_rdoc_files = ["CHANGELOG", "lib/search_scope.rb", "README"]
-  s.files = ["CHANGELOG", "init.rb", "lib/search_scope.rb", "Manifest", "Rakefile", "README", "search_scope.gemspec"]
-  s.has_rdoc = true
+  s.files = ["CHANGELOG", "init.rb", "lib/search_scope.rb", "Manifest", "Rakefile", "README", "search_scope.tmproj", "search_scope.gemspec"]
   s.homepage = %q{http://rubyforge.org/projects/search-scope}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Search_scope", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{search-scope}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.3}
   s.summary = %q{Simplify searching a model by defining custom named_scopes.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else

data/search_scope.tmproj

@@ -0,0 +1,145 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>currentDocument</key>
+	<string>search_scope_notes.txt</string>
+	<key>documents</key>
+	<array>
+		<dict>
+			<key>expanded</key>
+			<true/>
+			<key>name</key>
+			<string>search_scope</string>
+			<key>regexFolderFilter</key>
+			<string>!.*/(\coverage|\.svn|\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<key>sourceDirectory</key>
+			<string></string>
+		</dict>
+	</array>
+	<key>fileHierarchyDrawerWidth</key>
+	<integer>370</integer>
+	<key>metaData</key>
+	<dict>
+		<key>README</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>0</integer>
+			</dict>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>0</integer>
+		</dict>
+		<key>Rakefile</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>15</integer>
+			</dict>
+			<key>columnSelection</key>
+			<false/>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>0</integer>
+			<key>selectFrom</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>0</integer>
+			</dict>
+			<key>selectTo</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>15</integer>
+			</dict>
+		</dict>
+		<key>lib/search_scope.rb</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>378</integer>
+			</dict>
+			<key>columnSelection</key>
+			<false/>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>211</integer>
+			<key>selectFrom</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>384</integer>
+			</dict>
+			<key>selectTo</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>378</integer>
+			</dict>
+		</dict>
+		<key>search_scope_notes.txt</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>47</integer>
+			</dict>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>36</integer>
+		</dict>
+	</dict>
+	<key>openDocuments</key>
+	<array>
+		<string>lib/search_scope.rb</string>
+		<string>search_scope_notes.txt</string>
+		<string>README</string>
+		<string>Rakefile</string>
+	</array>
+	<key>showFileHierarchyDrawer</key>
+	<false/>
+	<key>showFileHierarchyPanel</key>
+	<true/>
+	<key>treeState</key>
+	<dict>
+		<key>search_scope</key>
+		<dict>
+			<key>isExpanded</key>
+			<true/>
+			<key>subItems</key>
+			<dict>
+				<key>lib</key>
+				<dict>
+					<key>isExpanded</key>
+					<true/>
+					<key>subItems</key>
+					<dict/>
+				</dict>
+			</dict>
+		</dict>
+	</dict>
+	<key>windowFrame</key>
+	<string>{{-1920, -58}, {1920, 1200}}</string>
+</dict>
+</plist>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: search_scope
 version: !ruby/object:Gem::Version 
-  version: 0.1.9
+  version: 0.2.1
 platform: ruby
 authors: 
 - Ryan Owens
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-23 00:00:00 -05:00
+date: 2009-07-24 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -30,9 +30,12 @@ files:
 - Manifest
 - Rakefile
 - README
+- search_scope.tmproj
 - search_scope.gemspec
 has_rdoc: true
 homepage: http://rubyforge.org/projects/search-scope
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -58,9 +61,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: search-scope
-rubygems_version: 1.3.1
+rubygems_version: 1.3.3
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Simplify searching a model by defining custom named_scopes.
 test_files: []