g_named_scope_filters 1.0.4 → 1.0.5

data/History.txt

@@ -1,3 +1,9 @@
+== 1.0.5 2009-11-19
+
+* Added options to control 'All' filter display, parameter and label.
+* Added option to control filter param key name.
+
+
 == 1.0.4 2009-10-11
 
 * Added ability to pass in record counts for the filters to override the control's way of calculating 

data/README.rdoc

@@ -5,9 +5,9 @@ http://github.com/midas/g_named_scope_filters/tree/master
 
 == DESCRIPTION:
 
-This is an unordered list of filters that use named scopes within an ActiveRecord model
-to filter a list.  It is not tied to a table or list specifically as it simply manipulates the url, resulting 
-in a manipulation of any collection (list, table, etc.) it may be coupled with.
+A UI component that generates an unordered list of filters that use named scopes within an ActiveRecord model to filter 
+a list.  It is not tied to a table or list specifically as it simply manipulates the url, resulting  in a manipulation of 
+any collection (list, table, etc.) it may be coupled with.
 
 
 == FEATURES
@@ -24,27 +24,33 @@ in a manipulation of any collection (list, table, etc.) it may be coupled with.
 == REQUIREMENTS:
 
 * Rails >= 2.2.0
-* Guilded >= 0.0.8 (http://github.com/midas/guilded/tree/master)
+* Guilded >= 1.0.0 (http://github.com/midas/guilded/tree/master)
 
 
 == INSTALL:
 
-  sudo gem install midas-g_named_scope_filters
+Update your RubyGem sources to include gemcutter if it is not already:
+
+  gem sources -a http://gemcutter.org
+
+Install:
+
+  sudo gem install g_named_scope_filters
 
 In your Rails environment.rb file:
 
-  config.gem 'midas-g_named_scope_filters', :version => '1.0.0', :lib => 'g_named_scope_filters', :source => 'http://gems.github.com'
+  config.gem 'g_named_scope_filters', :version => '1.0.5', :source => 'http://gems.github.com'
 
 	
 == USAGE:
 
 Model:
 
-	class Item < ActiveRecord::Base
-		named_scope :recent, lambda { { :conditions => [ "date_of_offense BETWEEN ? AND ?", 
-	    31.days.ago.utc, Time.zone.now.end_of_day.utc ] } }
-		named_scope :inactive, :conditions => { :is_active => false }
-	end
+  class Item < ActiveRecord::Base
+    named_scope :recent, lambda { { :conditions => [ "date_of_offense BETWEEN ? AND ?", 
+      31.days.ago.utc, Time.zone.now.end_of_day.utc ] } }
+    named_scope :inactive, :conditions => { :is_active => false }
+  end
 
 View:
   <%= g_named_scope_filters Item, :only => [:recent, :inactive], :scoped_by => @account, :include_count => true, 
@@ -64,13 +70,13 @@ Results in:
     </li>
     <li>
       <a class="" href="/accounts/2/items?filter=recent">
-				Recent
+        Recent
         <span>1</span>
       </a>
     </li>
     <li>
       <a class="" href="/accounts/2/items?filter=inactive">
-				Inactive
+        Inactive
         <span>0</span>
       </a>
     </li>
@@ -86,6 +92,8 @@ The hash should contain symbols and integers representing the filter name and th
 
   { :all => 4, :recent => 2, :inactive => 2 }
 
+Check the documentation for the g_named_scope_filter method in ViewHelpers module for more options.
+
 	
 == LICENSE:
 

data/Rakefile

@@ -1,30 +1,51 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/g_named_scope_filters'
+require 'rubygems'
+require 'rake'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('g_named_scope_filters', GNamedScopeFilters::VERSION) do |p|
-  p.developer('C. Jason Harrelson (midas)', 'jason@lookforwardenterprises.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  p.rubyforge_name       = p.name # TODO this is default value
-  # p.extra_deps         = [
-  #   ['activesupport','>= 2.0.2'],
-  # ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"],
-    ['rails', ">= 2.2.0"],
-    ['midas-guilded', ">=0.0.6"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "g_named_scope_filters"
+    gem.summary = %Q{A UI component that generates an unordered list of filters that use named scopes within an ActiveRecord model to filter a list.}
+    gem.description = %Q{A UI component that generates an unordered list of filters that use named scopes within an ActiveRecord model to filter a list.  It is not tied to a table or list specifically as it simply manipulates the url, resulting  in a manipulation of any collection (list, table, etc.) it may be coupled with.}
+    gem.email = "jason@lookforwardenterprises.com"
+    gem.homepage = "http://github.com/midas/g_named_scope_filters"
+    gem.authors = ["C. Jason Harrelson (midas)"]
+    gem.add_development_dependency "rspec", ">=1.2.8"
+    gem.add_dependency 'rails', ">= 2.2.0"
+    gem.add_dependency 'guilded', ">=1.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
 
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "test #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.5

data/g_named_scope_filters.gemspec

@@ -1,44 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{g_named_scope_filters}
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["C. Jason Harrelson (midas)"]
-  s.date = %q{2009-10-11}
-  s.description = %q{This is an unordered list of filters that use named scopes within an ActiveRecord model to filter a list.  It is not tied to a table or list specifically as it simply manipulates the url, resulting  in a manipulation of any collection (list, table, etc.) it may be coupled with.}
-  s.email = ["jason@lookforwardenterprises.com"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
-  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "g_named_scope_filters.gemspec", "lib/g_named_scope_filters.rb", "lib/g_named_scope_filters/view_helpers.rb", "script/console", "script/destroy", "script/generate", "spec/g_named_scope_filters_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/midas/g_named_scope_filters/tree/master}
-  s.post_install_message = %q{PostInstall.txt}
-  s.rdoc_options = ["--main", "README.rdoc"]
+  s.date = %q{2009-11-19}
+  s.description = %q{A UI component that generates an unordered list of filters that use named scopes within an ActiveRecord model to filter a list.  It is not tied to a table or list specifically as it simply manipulates the url, resulting  in a manipulation of any collection (list, table, etc.) it may be coupled with.}
+  s.email = %q{jason@lookforwardenterprises.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "History.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "g_named_scope_filters.gemspec",
+     "lib/g_named_scope_filters.rb",
+     "lib/g_named_scope_filters/view_helpers.rb",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "spec/g_named_scope_filters_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/rspec.rake"
+  ]
+  s.homepage = %q{http://github.com/midas/g_named_scope_filters}
+  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{g_named_scope_filters}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{This is an unordered list of filters that use named scopes within an ActiveRecord model to filter a list}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A UI component that generates an unordered list of filters that use named scopes within an ActiveRecord model to filter a list.}
+  s.test_files = [
+    "spec/g_named_scope_filters_spec.rb",
+     "spec/spec_helper.rb"
+  ]
 
   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
-      s.add_development_dependency(%q<newgem>, [">= 1.3.0"])
-      s.add_development_dependency(%q<rails>, [">= 2.2.0"])
-      s.add_development_dependency(%q<midas-guilded>, [">= 0.0.6"])
-      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.8"])
+      s.add_runtime_dependency(%q<rails>, [">= 2.2.0"])
+      s.add_runtime_dependency(%q<guilded>, [">= 1.0.0"])
     else
-      s.add_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.8"])
       s.add_dependency(%q<rails>, [">= 2.2.0"])
-      s.add_dependency(%q<midas-guilded>, [">= 0.0.6"])
-      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+      s.add_dependency(%q<guilded>, [">= 1.0.0"])
     end
   else
-    s.add_dependency(%q<newgem>, [">= 1.3.0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.8"])
     s.add_dependency(%q<rails>, [">= 2.2.0"])
-    s.add_dependency(%q<midas-guilded>, [">= 0.0.6"])
-    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    s.add_dependency(%q<guilded>, [">= 1.0.0"])
   end
 end
+

data/lib/g_named_scope_filters.rb

@@ -4,7 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'g_named_scope_filters/view_helpers'
 
 module GNamedScopeFilters
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end
 
 if defined?( ActionView::Base )

data/lib/g_named_scope_filters/view_helpers.rb

@@ -17,6 +17,12 @@ module GNamedScopeFilters
     # +only+ - This is the filters to include.  Can be an array or string (for one filter).
     # +include_count+ - True if you would like a span created within each filter list item containg the count for
     #   items in that filter.
+    # +record_counts+ - A hash providing teh counts for each filter to override the built in counting funcitonality.
+    # +include_all+ - True if you want the all filter to be renderred, otherwise false.  Defaults to true.
+    # +all_label+ - The text to use for the All filter's label.  Defaults to 'All.'
+    # +all_param+ - The param to pass for the all filter.  Set to :none or false for no filter parameter added to URL 
+    #   when all selected.  Defaults to false.
+    # +filter_param_key+ - The key for the filter param.  Defaults to 'filter.'  ie. &filter=something
     # +scoped_by+ - This is the ActiveRecord object that this list is scoped by.  For instance, if an account
     #   has many users and this is the user list for said acccount, then you would use :scoped_by => @account.
     #   This will scope the user list with filter to that account.  It will also change the path helper from
@@ -45,7 +51,13 @@ module GNamedScopeFilters
       polymorphic_type = options[:polymorphic_type]
       polymorphic_as = options[:polymorphic_as]
       record_counts = options[:record_counts]
-
+      include_all = options[:include_all]
+      include_all = true unless include_all == false
+      all_label = options[:all_label] || 'All'
+      all_param = options[:all_param]
+      all_param = nil if all_param == :none || all_param == false
+      filter_param_key = options[:filter_param_key] || 'filter'
+      
       raise "You must provide the 'polymorphic_as' option if you provide the 'polymorphic_type' option." if polymorphic_type && !polymorphic_as
 
       Guilded::Guilder.instance.add( :named_scope_filters, options )
@@ -70,44 +82,44 @@ module GNamedScopeFilters
       return html if filters.empty?
 
       # Resolve scoped by if it is an array
-      if scoped_by.is_a?( Array )
-        scoped_by = scoped_by.last
-      end
+      scoped_by = scoped_by.last if scoped_by.is_a?( Array )
       
       html << "<ul id=\"#{options[:id].to_s}\" class=\"#{options[:class].to_s}\">"
 
       # Handle the all filter
-      link_text = "All"
-
-      if options[:include_count]
-        if record_counts
-          link_text << " <span>#{record_counts[:all]}</span>"
-        elsif scoped_by   
-          if polymorphic_type
-            poly_scoped_finder = polymorphic_type.to_s.tableize
-            link_text << " <span>#{scoped_by.send( poly_scoped_finder.to_sym ).count}</span>"
+      if include_all
+        link_text = all_label
+
+        if options[:include_count]
+          if record_counts
+            link_text << " <span>#{record_counts[:all]}</span>"
+          elsif scoped_by   
+            if polymorphic_type
+              poly_scoped_finder = polymorphic_type.to_s.tableize
+              link_text << " <span>#{scoped_by.send( poly_scoped_finder.to_sym ).count}</span>"
+            else
+              scoped_finder = klass.to_s.tableize
+              link_text << " <span>#{scoped_by.send( scoped_finder.to_sym ).count}</span>"
+            end
           else
-            scoped_finder = klass.to_s.tableize
-            link_text << " <span>#{scoped_by.send( scoped_finder.to_sym ).count}</span>"
+            link_text << " <span>#{klass.count}</span>" 
           end
-        else
-          link_text << " <span>#{klass.count}</span>" 
         end
-      end
 
-      filter_options = Array.new
-      filter_options.push( :order => params[:order] ) if params[:order]
+        filter_options = []
+        filter_options.push( :order => params[:order] ) if params[:order]
+        filter_options.push( filter_param_key.to_sym => all_param ) if all_param # Send a param for 'All' filter
 
-      html << "<li>"
-      html << link_to( link_text, @controller.send( list_path_helper, *(path_helpers[:index_rest_args] + filter_options) ), 
-                :class => "#{params[:filter].nil? ? options[:selected_class] : ''}" )
+        html << "<li>"
+        html << link_to( link_text, @controller.send( list_path_helper, *(path_helpers[:index_rest_args] + filter_options) ), 
+                  :class => "#{params[:filter] == all_param.to_s ? options[:selected_class] : ''}" )
+      end
 
       filters.each do |filter|
         throw "You must define a named scope of '#{filter.to_s}' in order to render a named scope filter for it" unless klass.respond_to?( filter.to_sym )
         link_text = filter.to_s.humanize
 
         if options[:include_count]
-
           if record_counts
             link_text << " <span>#{record_counts[filter.to_sym]}</span>"
           elsif scoped_by
@@ -127,19 +139,19 @@ module GNamedScopeFilters
           else
             link_text << " <span>#{klass.send( filter.to_sym ).count}</span>"
           end
-
         end
 
+        filter_options = []
         #filter_options.merge!( :filter => filter )
         if filter_options[filter_options.size-1].is_a?( Hash )
-          filter_options[filter_options.size-1].merge!( :filter => filter )
+          filter_options[filter_options.size-1].merge!( filter_param_key.to_sym => filter )
         else
-          filter_options.push( :filter => filter )
+          filter_options.push( filter_param_key.to_sym => filter )
         end
 
         html << "<li>"
         html << link_to( link_text, @controller.send( list_path_helper, *(path_helpers[:index_rest_args] + filter_options) ), 
-                :class => "#{params[:filter] == filter.to_s ? options[:selected_class] : ''}" )
+                  :class => "#{params[:filter] == filter.to_s ? options[:selected_class] : ''}" )
         html << "</li>"
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: g_named_scope_filters
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - C. Jason Harrelson (midas)
@@ -9,22 +9,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-12 00:00:00 -05:00
+date: 2009-11-19 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: newgem
+  name: rspec
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.3.0
+        version: 1.2.8
     version: 
 - !ruby/object:Gem::Dependency 
   name: rails
-  type: :development
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -33,46 +33,28 @@ dependencies:
         version: 2.2.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: midas-guilded
-  type: :development
+  name: guilded
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.6
+        version: 1.0.0
     version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.0
-    version: 
-description: |-
-  This is an unordered list of filters that use named scopes within an ActiveRecord model
-  to filter a list.  It is not tied to a table or list specifically as it simply manipulates the url, resulting 
-  in a manipulation of any collection (list, table, etc.) it may be coupled with.
-email: 
-- jason@lookforwardenterprises.com
+description: A UI component that generates an unordered list of filters that use named scopes within an ActiveRecord model to filter a list.  It is not tied to a table or list specifically as it simply manipulates the url, resulting  in a manipulation of any collection (list, table, etc.) it may be coupled with.
+email: jason@lookforwardenterprises.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
 - README.rdoc
 files: 
 - History.txt
-- Manifest.txt
-- PostInstall.txt
 - README.rdoc
 - Rakefile
+- VERSION
 - g_named_scope_filters.gemspec
 - lib/g_named_scope_filters.rb
 - lib/g_named_scope_filters/view_helpers.rb
@@ -84,13 +66,12 @@ files:
 - spec/spec_helper.rb
 - tasks/rspec.rake
 has_rdoc: true
-homepage: http://github.com/midas/g_named_scope_filters/tree/master
+homepage: http://github.com/midas/g_named_scope_filters
 licenses: []
 
-post_install_message: PostInstall.txt
+post_install_message: 
 rdoc_options: 
-- --main
-- README.rdoc
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -107,10 +88,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: g_named_scope_filters
+rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: This is an unordered list of filters that use named scopes within an ActiveRecord model to filter a list
-test_files: []
-
+summary: A UI component that generates an unordered list of filters that use named scopes within an ActiveRecord model to filter a list.
+test_files: 
+- spec/g_named_scope_filters_spec.rb
+- spec/spec_helper.rb

data/Manifest.txt

@@ -1,15 +0,0 @@
-History.txt
-Manifest.txt
-PostInstall.txt
-README.rdoc
-Rakefile
-g_named_scope_filters.gemspec
-lib/g_named_scope_filters.rb
-lib/g_named_scope_filters/view_helpers.rb
-script/console
-script/destroy
-script/generate
-spec/g_named_scope_filters_spec.rb
-spec/spec.opts
-spec/spec_helper.rb
-tasks/rspec.rake

data/PostInstall.txt

@@ -1,7 +0,0 @@
-
-For more information on g_named_scope_filters, see http://g_named_scope_filters.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
-
-