midas-g_named_scope_filters 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0 2009-03-12
+
+* Initial release (ported from plugin)

data/Manifest.txt

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,7 @@
+
+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.
+
+

data/README.rdoc

@@ -0,0 +1,102 @@
+= g_named_scope_filters
+
+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.
+
+
+== FEATURES
+
+* Generates unordered list of links that will filter based on defined named scopes in an ActiveRecord model
+
+
+== PLANNED FEATURES
+
+* Automatically use all named scopes defined in model if :only or :except options are not used
+* Obey the :except option if :only option not present
+
+
+== REQUIREMENTS:
+
+* Rails >= 2.2.0
+* Guilded >= 0.0.8 (http://github.com/midas/guilded/tree/master)
+
+
+== INSTALL:
+
+  sudo gem install midas-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'
+
+
+== 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
+
+View:
+  <%= g_named_scope_filters Item, :only => [:recent, :inactive], :scoped_by => @account, :include_count => true, 
+        :id => 'item_filters' %>
+
+You currently must use the :only option to specify which named scopes to use.  It is planned to use all named scopes if
+:only or :except are not present, however it is not yet implemented.
+
+Results in:
+
+  <ul id="doc-filters" class="filters">
+    <li>
+      <a class="selected" href="/accounts/2/items">
+        All
+        <span>2</span>
+      </a>
+    </li>
+    <li>
+      <a class="" href="/accounts/2/items?filter=recent">
+				Recent
+        <span>1</span>
+      </a>
+    </li>
+    <li>
+      <a class="" href="/accounts/2/items?filter=inactive">
+				Inactive
+        <span>0</span>
+      </a>
+    </li>
+  </ul>
+	
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 C. Jason Harrelson (midas)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,30 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/g_named_scope_filters'
+
+# 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'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/g_named_scope_filters.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{g_named_scope_filters}
+  s.version = "1.0.0"
+
+  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-03-12}
+  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.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}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<newgem>, [">= 1.2.3"])
+      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"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.2.3"])
+      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"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.2.3"])
+    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"])
+  end
+end

data/lib/g_named_scope_filters.rb

@@ -0,0 +1,12 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'g_named_scope_filters/view_helpers'
+
+module GNamedScopeFilters
+  VERSION = '1.0.0'
+end
+
+if defined?( ActionView::Base )
+  ActionView::Base.send( :include, GNamedScopeFilters::ViewHelpers ) unless ActionView::Base.include?( GNamedScopeFilters::ViewHelpers )
+end

data/lib/g_named_scope_filters/view_helpers.rb

@@ -0,0 +1,145 @@
+module GNamedScopeFilters
+  module ViewHelpers
+    
+    # Guilded component.  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 a list or table.
+    # 
+    # *parameters*
+    # :ar_obj_col_or_class:: The ActiveRecord object, collection or class to make the filters from.  Warning:
+    #   if you use anything but the class and the collection or object comes up nil or empty, then you will 
+    #   not have filters renderred.  The prefferred way is to use the class unless you cannot due to dynamic reasons.
+    #   
+    # *options*
+    # :id:: (Required) This will be the id of the ul returned that wraps the filters.
+    # :class:: This will be the id of the ul returned that wraps the filters.  Defaults to 'filters.'
+    # :selected_class:: This will be the class that is used to show whih filter is selected.  Defaults to 'selected.'
+    # :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.
+    # :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
+    #   users_path to account_users_path, unless you overrode the path helper with :list_path_helper.
+    # :list_path_helper:: This is a string or symbol for the list path helper to use.  You will need to override
+    #   if your object is namespaced.
+    # :polymorphic:: A string representing the name of the type to use if the current type is just a polymorphic 
+    #   association table, etc.  For instance
+    #
+    def g_named_scope_filters( ar_obj_col_or_class, *args )
+      options = args.extract_options!
+      options.merge! :class => "filters" unless options.include?( :class )
+      options.merge! :selected_class => "selected" unless options.include?( :selected_class )
+      options.merge! :exclude_css => true, :exclude_js => true 
+
+      if options[:only]
+        if options[:only].is_a?( String ) || options[:only].is_a?( Symbol )
+          filters = Array.new << options[:only]
+        else
+          filters = options[:only]
+        end
+      end
+      options[:filters] = filters
+
+      scoped_by = options.delete( :scoped_by )
+      polymorphic_type = options.delete( :polymorphic_type ).to_s if options.has_key?( :polymorphic_type )
+      polymorphic_as = options.delete( :polymorphic_as ).to_s if options.has_key?( :polymorphic_as )
+
+      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 )
+
+      # Resolve the class of the ActiveRecord descendant type
+      if ar_obj_col_or_class.is_a?( Array )
+        return '' if ar_obj_col_or_class.empty?
+        klass = ar_obj_col_or_class[0].class
+      elsif ar_obj_col_or_class.is_a?( Class )
+        klass = ar_obj_col_or_class
+      elsif ar_obj_col_or_class.is_a?( ActiveRecord::Base )
+        klass = ar_obj_col_or_class.class
+      else
+        throw 'You must provide either an ActiveRecord object, collection or type in order to generate filters.'
+      end
+
+      if options[:list_path_helper]
+        list_path_helper = options[:list_path_helper].to_s
+      elsif scoped_by
+        list_path_helper = "#{scoped_by.class.to_s.underscore}_#{klass.to_s.tableize}_path"
+      else
+        list_path_helper = "#{klass.to_s.tableize}_path"
+      end
+
+      html = ''
+
+      return html if filters.empty?
+
+      html << "<ul id=\"#{options[:id].to_s}\" class=\"#{options[:class].to_s}\">"
+
+      # Handle the all filter
+      link_text = "All"
+
+      if options[:include_count]
+        if 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
+          link_text << " <span>#{klass.count}</span>" 
+        end
+      end
+
+      filter_options = {}
+      filter_options.merge!( :order => params[:order] ) if params[:order]
+
+      html << "<li>"
+      html << link_to( link_text, @controller.send( list_path_helper, filter_options ), 
+                :class => "#{params[:filter].nil? ? options[:selected_class] : ''}" )
+
+      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 scoped_by
+
+            scoped_finder = klass.to_s.tableize if scoped_finder.nil? || scoped_finder.empty?
+
+            if polymorphic_type
+
+              # If there is a named scope finder defined on the root klass that can get the 
+              # polymorpic assocaited objects, the use it
+              if klass.respond_to?( poly_scoped_finder )
+                link_text << " <span>#{scoped_by.send( scoped_finder.to_sym ).send( poly_scoped_finder.to_sym ).send( filter.to_sym ).count}</span>"
+              else #otherwise, just use a AR's find
+                link_text << " <span>#{scoped_by.send( scoped_finder.to_sym ).send( filter.to_sym ).find(:all, :conditions => { "#{polymorphic_as}_type".to_sym => polymorphic_type } ).size}</span>"
+              end
+
+            else
+              link_text << " <span>#{scoped_by.send( scoped_finder.to_sym ).send( filter.to_sym ).count}</span>"
+            end
+
+          else
+            link_text << " <span>#{klass.send( filter.to_sym ).count}</span>"
+          end
+
+        end
+
+        filter_options.merge!( :filter => filter )
+
+        html << "<li>"
+        html << link_to( link_text, @controller.send( list_path_helper, filter_options ), 
+                :class => "#{params[:filter] == filter.to_s ? options[:selected_class] : ''}" )
+        html << "</li>"
+      end
+
+      html << "</ul>"
+      html
+    end
+    
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/g_named_scope_filters.rb'}"
+puts "Loading g_named_scope_filters gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/g_named_scope_filters_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'g_named_scope_filters'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: midas-g_named_scope_filters
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- C. Jason Harrelson (midas)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: midas-guilded
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.6
+    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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+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
+has_rdoc: true
+homepage: http://github.com/midas/g_named_scope_filters/tree/master
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: g_named_scope_filters
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: This is an unordered list of filters that use named scopes within an ActiveRecord model to filter a list
+test_files: []
+