find_or_redirect 0.0.0 → 0.1.0

data/README.rdoc

@@ -1,6 +1,114 @@
 = find_or_redirect
 
-Description goes here.
+Find or Redirect helps you refactor out model finding code in your controllers.
+
+== Installation
+
+Enable gemcutter, then just:
+
+  gem install find_or_redirect
+
+== Usage
+
+This is a common pattern in rails:
+
+  class ModelsController < ApplicationController
+    def show
+      @model = Model.find(params[:id])
+    end
+
+    def destroy
+      @model = Model.find(params[:id])
+      @model.destroy
+    end  
+  end
+
+Not so dry! Also, this throws exceptions if the model can't be found. Find or Redirect improves on that by using "find_by_id" and catching a miss with a redirection and friendly flash[:error] message.
+
+
+It's like you did this:
+
+  class ModelsController < ApplicationController
+    before_filter :find_model
+    def show
+    end
+
+    def destroy
+      @model.destroy
+    end  
+
+    private
+
+    def find_model
+      @model = Model.find_by_id(params[:id])
+      unless @model
+        redirect_to :action => :index
+        flash[:error] = "Invalid model id"
+        return false
+      end
+    end
+  end
+
+But it gets repetitive doing that in all your controllers, and it's certainly not DRY.
+
+So how about:
+
+  class ModelsController
+    find_or_redirect :only => [ :show, :destroy ]
+
+    def show
+    end
+    
+    def destroy
+      @model.destroy
+    end
+  end
+
+The class variable is inferred from the controller name. All options passed to find_or_redirect are automatically passed along to the before_filter created, so you can use :only and :except.
+
+=== Additional Options
+
+==== redirect_to
+  
+Redirect to a path other than this controller's index
+
+  find_or_redirect :redirect_to => "root_path"
+
+==== name
+
+Specify the name of the variable to set
+
+  find_or_redirect :name => "something_else"
+
+  def destroy
+    @something_else.destroy
+  end
+
+==== finder
+
+Find the model in a different fashion (helpful when the controller name doesn't match the finder, or if you want to use multiple find_or_redirects)
+
+  class ParentsController
+    # this automatically finds the parent
+    find_or_redirect
+    # now we'll find the child from the parent's children and param
+    find_or_redirect(
+      :name => "child"
+      :finder => "@parent.children.find_by_id(params[:child_id])"
+    )
+    # and grab the tag the user requested
+    find_or_redirect(
+      :name => "tag",
+      :finder => "Tag.find_by_slug(params[:tag])"
+    )
+
+    def update_child_tag
+      @child.tag = @tag
+      @child.save!
+      @parent.last_tag = @tag
+      @parent.save!
+    end
+  end
 
 == Note on Patches/Pull Requests
  

data/lib/find_or_redirect.rb

@@ -5,16 +5,16 @@ module FindOrRedirect
   
   module ClassMethods
     def find_or_redirect(opts = {})
-      klass = controller_name.classify
-      instance = controller_name.singularize
-      redirect_target = opts.delete(:redirect_to) || ":action => :index"
-      finder = opts.delete(:finder) || klass
+      instance = (opts[:name] || controller_name).singularize
+      redirect_target = opts[:redirect_to] || ":action => :index"
+      klass = (opts[:name] || controller_name).classify
+      finder = opts[:finder] || "#{klass}.find_by_id(params[:id])"
       
       class_eval <<-RUBYSRC
         before_filter :find_#{ instance }_or_redirect, #{ opts.inspect }
         private
         def find_#{ instance }_or_redirect
-          @#{ instance } = #{ finder }.find_by_id params[:id]
+          @#{ instance } = #{ finder }
           unless @#{ instance }
             redirect_to #{ redirect_target }
             flash[:error] = "Invalid #{ klass } ID"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: find_or_redirect
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Nick Gauthier