finder_filter 0.5

data/CHANGELOG

@@ -0,0 +1,3 @@
+8/9/08 - Defaulting class name to controller name. [Kevin Smith]
+
+8/8/08 - Initial import. [Matthew Bass]

data/README

@@ -0,0 +1,87 @@
+= Synthesis
+
+An easy way to add common finders to your Rails controllers.
+
+== Installation
+
+  gem sources -a http://gems.github.com (you only have to do this once)
+  sudo gem install pelargir-finder_filter
+
+To use with a Rails 2.1 app, edit the environment.rb file and add an
+entry for the gem to the Rails::Initializer config block.
+
+== 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 :user, :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])
+
+The standard Rails :only and :except options can also be used:
+
+  before_filter :find_user, :only => [:show, :edit]
+  before_filter :find_user, :except => [:index]
+
+== Tests
+
+To run the tests, you must have the mocha and test-spec gems installed.
+
+  rake test
+
+== Dependencies
+
+actionpack > 2.0.1
+mocha > 0.5.6
+test-spec > 0.4.0
+
+== Git
+
+  git://github.com/pelargir/finder_filter.git
+
+== Contributors
+
+Matthew Bass, Kevin Smith

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,23 @@
+Gem::Specification.new do |s|
+  s.name     = "finder_filter"
+  s.version  = "0.5"
+  s.date     = "2008-08-08"
+  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"])
+end

data/lib/finder_filter.rb

@@ -0,0 +1,18 @@
+module FinderFilter
+  def finder_filter(*args)
+    options = args.extract_options!
+    name = args.empty? ? controller_name.singularize : args.first
+    by = options.delete(:by)
+    param = options.delete(:param) || :id
+    
+    before_filter "find_#{name}", options
+    
+    define_method "find_#{name}" do
+      klass = name.to_s.classify.constantize
+      item = by ? klass.send("find_by_#{by}", params[param]) : klass.find(params[param])
+      instance_variable_set("@#{name}", item)
+    end
+  end
+end
+
+ActionController::Base.extend FinderFilter

data/test/finder_filter_test.rb

@@ -0,0 +1,55 @@
+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 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,6 @@
+require 'rubygems'
+require 'test/spec'
+require 'mocha'
+require 'action_controller'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/finder_filter')

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: finder_filter
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- Matthew Bass
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.0.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: []
+