pelargir-finder_filter 0.5

data/CHANGELOG

@@ -0,0 +1,9 @@
+8/27/08 - Support for from_param [Mike Gunderloy]
+
+8/15/08 - Support for nested resources. [Matthew Bass]
+
+8/14/08 - Optional before filter prepending. [Steve Mohapi-Banks]
+
+8/9/08 - Defaulting class name to controller name. [Kevin Smith]
+
+8/8/08 - Initial import. [Matthew Bass]

data/README

@@ -0,0 +1,140 @@
+= Synthesis
+
+An easy way to add common finders to your Rails controllers.
+
+== Installation
+
+Install the gem directly:
+
+  gem sources -a http://gems.github.com (you only have to do this once)
+  sudo gem install pelargir-finder_filter
+  
+Or install the gem in your Rails project:
+  
+  gem sources -a http://gems.github.com
+  script/plugin install pelargir-finder_filter
+
+Or clone the project:
+
+  git clone git://github.com/pelargir/finder_filter.git
+
+== Usage
+
+finder_filter is intended to replace one-off before filters that you might
+commonly write in your Rails controllers. For example:
+
+  class UsersController < ActionController::Base
+    before_filter :find_user, :only => [:show, :edit]
+    
+    def show
+      # do something with @user
+    end
+    
+    def edit
+      # do something with @user
+    end
+    
+    def find_user
+      @user = User.find(params[:id)
+    end
+  end
+
+finder_filter reduces this pattern to a single line:
+
+  class UsersController < ActionController::Base
+    finder_filter :only => [:show, :edit]
+    
+    def show; end
+    def edit; end
+  end
+  
+Or, if you want to specify the model to find:
+
+  class UsersController < ActionController::Base
+    finder_filter :person, :only => [:show, :edit]
+    
+    def show; end
+    def edit; end
+  end
+
+To find based on a column other than ID:
+
+  finder_filter :user, :by => :name
+    # equivalent to:
+    #   @user = User.find_by_name(params[:id])
+
+To find based on a param other than ID:
+
+  finder_filter :user, :param => :permalink
+    # equivalent to:
+    #   @user = User.find(params[:permalink])
+
+You can specify that prepend_before_filter is used:
+
+	finder_filter :user, :only => [:show, :edit], :prepend => true
+		# generates:
+		#		prepend_before_filter :find_user, :only => [:show, :edit]
+
+The standard Rails :only and :except options can also be used:
+
+  before_filter :find_user, :only => [:show, :edit]
+  before_filter :find_user, :except => [:index]
+
+== Resource Nesting
+
+If your controller is a nested resource, you might want the find
+to be performed on the parent model. For example:
+
+  class PostsController < ActionController::Base
+    before_filter :find_post
+
+    def find_post
+      @topic = Topic.find(params[:topic_id])
+      @post = @topic.posts.find(params[:id])
+    end
+  end
+  
+This can be easily handled using finder_filter:
+
+  finder_filter :nested => :topic
+
+Nested resources will only do a find on the parent model if the parent id is supplied.
+This allows you to handle routing setups like this:
+
+map.resources :posts
+map.resources :topics do |topic|
+  topic.resources :posts
+end
+
+With this setup, both /posts/1 and /topics/1/posts/2 will be valid URLs, and will do the 
+right thing if you include 
+
+finder_filter :nested => :topic
+
+in your Posts controller.
+
+== from_param
+
+If you have Michael Bleigh's from_param (http://github.com/mbleigh/from_param/tree/master)
+installed, finder_filter will work transparently with it. This gives you the dual benefit
+of SEO-friendly URLs and DRY controller code.
+
+== Tests
+
+To run the tests, you must have the mocha, test-spec, and sqlite3 gems installed.
+
+  rake test
+
+== Dependencies
+
+actionpack > 2.0.1
+
+== Author
+
+  Matthew Bass
+    email: pelargir at gmail dot com
+    blog: http://matthewbass.com
+
+== Contributors
+
+Kevin Smith, Steve Mohapi-Banks

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+task :default => :test
+
+Rake::TestTask.new('test') do |t|
+  t.pattern = 'test/*_test.rb'
+end

data/finder_filter.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name     = "finder_filter"
+  s.version  = "0.5"
+  s.date     = "2008-08-14"
+  s.summary  = "An easy way to add common finders to your Rails controllers."
+  s.email    = "pelargir@gmail.com"
+  s.homepage = "http://github.com/pelargir/finder_filter"
+  s.description = "An easy way to add common finders to your Rails controllers."
+  s.has_rdoc = true
+  s.authors  = ["Matthew Bass"]
+  s.files    = [
+    "CHANGELOG",
+		"README", 
+		"Rakefile", 
+		"finder_filter.gemspec", 
+		"lib/finder_filter.rb",
+		"test/test_helper.rb",
+		"test/finder_filter_test.rb"
+		]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+  s.add_dependency("actionpack", ["> 2.0.1"])
+  s.add_dependency("sqlite3-ruby", ["> 1.2.1"])
+end

data/lib/finder_filter.rb

@@ -0,0 +1,46 @@
+module FinderFilter
+  def finder_filter(*args)
+    options = args.extract_options!
+    name = args.empty? ? controller_name.singularize : args.first
+    by, nested = options.delete(:by), options.delete(:nested)
+    param = options.delete(:param) || :id
+    prepend = options.delete(:prepend) || false
+    
+    filter_method = prepend ? :prepend_before_filter : :before_filter
+    send(filter_method, "find_#{name}".intern, options)
+    
+    define_method "find_#{name}" do
+      klass = name.to_s.classify.constantize
+      if nested && params.include?("#{nested}_id")
+        nested_klass = nested.to_s.classify.constantize
+        nested_param = "#{nested}_id".intern
+        
+        if nested_klass.method_defined? :param_column
+          nested_item = nested_klass.from_param(params[nested_param])
+        else
+          nested_item = by ? nested_klass.send("find_by_#{by}", params[nested_param]) : nested_klass.find(params[nested_param])
+        end
+        if klass.method_defined? :param_column
+          item = nested_item.send(name.to_s.pluralize).from_param(params[param])
+        else
+          item = by ? nested_item.send(name.to_s.pluralize).send("find_by_#{by}", params[param]) : nested_item.send(name.to_s.pluralize).find(params[param])
+        end
+        instance_variable_set("@#{nested}", nested_item)
+      else
+        if klass.method_defined? :param_column
+          item = klass.from_param(params[param])
+        else
+          item = by ? klass.send("find_by_#{by}", params[param]) : klass.find(params[param])
+        end
+      end
+      if item.nil?
+        flash[:error] = "The requested #{name} does not exist."
+        index_path = nested ? send("#{nested}_path", nested_item) : send("#{name.to_s.pluralize}_path")
+        redirect_to index_path
+      end
+      instance_variable_set("@#{name}", item)
+    end
+  end
+end
+
+ActionController::Base.extend FinderFilter

data/test/finder_filter_test.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class TestController < ActionController::Base; extend FinderFilter; end
+class TestsController < ActionController::Base; extend FinderFilter; end
+
+describe FinderFilter do
+  before { @controller = TestController }
+  
+  it "should assign before filter when model specified" do
+    @controller.expects(:before_filter).with(:"find_foo", {})
+    @controller.finder_filter :foo
+  end
+
+  it "should assign before filter when model not specified" do
+    @controller.expects(:before_filter).with(:"find_test", {})
+    @controller.finder_filter
+  end
+
+  it "should assign before filter when model not specified and controller name is plural" do
+    controller = TestsController
+    controller.expects(:before_filter).with(:"find_test", {})
+    controller.finder_filter
+  end
+
+  it "should assign before filter when options are specified" do
+    @controller.expects(:before_filter).with(:"find_test", {})
+    @controller.finder_filter :by => :permalink, :param => :name
+  end
+
+  it "should assign before filter with options" do
+    @controller.expects(:before_filter).with(:"find_test", :only => [:show, :edit])
+    @controller.finder_filter :only => [:show, :edit]
+  end
+  
+  it "should assign prepend before filter when prepend option specified" do
+    @controller.expects(:prepend_before_filter).with(:"find_test", {})
+    @controller.finder_filter :prepend => true
+  end
+  
+  it "should assign prepend before filter when prepend option specified with only option" do
+    @controller.expects(:prepend_before_filter).with(:"find_test", :only => [:show, :edit])
+    @controller.finder_filter :only => [:show, :edit], :prepend => true
+  end
+  
+  it "should assign prepend before filter when prepend option specified with multiple options" do
+    @controller.expects(:prepend_before_filter).with(:"find_test", :only => [:show, :edit])
+    @controller.finder_filter :only => [:show, :edit], :prepend => true, :by => "name"
+  end
+  
+  it "should define method when model specified" do
+    @controller.expects(:define_method).with("find_foo")
+    @controller.finder_filter :foo
+  end
+
+  it "should define method when model not specified" do
+    @controller.expects(:define_method).with("find_test")
+    @controller.finder_filter
+  end
+
+  it "should define method when model not specified and controller name is plural" do
+    controller = TestsController
+    controller.expects(:define_method).with("find_test")
+    controller.finder_filter
+  end
+
+  it "should define method when options are specified" do
+    @controller.expects(:define_method).with("find_test")
+    @controller.finder_filter :by => :permalink, :param => :name
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/spec'
+require 'mocha'
+require 'action_controller'
+require 'active_record'
+require 'sqlite3'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/finder_filter')
+
+# connect to the database (sqlite in this case)
+ActiveRecord::Base.establish_connection({
+      :adapter => 'sqlite3', 
+      :dbfile => File.expand_path(File.dirname(__FILE__) + '/../db/test.sqlite')
+})

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: pelargir-finder_filter
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- Matthew Bass
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: 
+description: An easy way to add common finders to your Rails controllers.
+email: pelargir@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- CHANGELOG
+- README
+- Rakefile
+- finder_filter.gemspec
+- lib/finder_filter.rb
+- test/test_helper.rb
+- test/finder_filter_test.rb
+has_rdoc: true
+homepage: http://github.com/pelargir/finder_filter
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An easy way to add common finders to your Rails controllers.
+test_files: []
+