wizard_controller 0.1.7 → 0.1.8

data/History.txt

@@ -1,2 +1,3 @@
+20100129: 0.1.8 Midwire added the direct_step action, and supporting 'direct_step_path' method, to allow handling of navigating to a step directly instead of always using next and previous.
 20091102: 0.1.5 Changed session variable that stores redirect information, to avoid conflicts.
 20090925: Packaged as Gem

data/README.rdoc

@@ -3,46 +3,48 @@
 Wizard controller provides a base class (Inheriting from ActionController::Base)
 that provides a DSL for quickly making Wizards.
 
-In order for this to work, you need to have this standard route present:
-
-  map.connect ':controller/:action/:id'
-  
 VERY IMPORTANT!!! DONT OVERRIDE INDEX!
 Doing so will break all functionality. WizardController works by defining an 
 "index" method that does all the work.  To start a wizard, go to the "index" method.
 
 === Setup and Configuration
 
-Add the gem configuration to your config/environment.rb
+Add the following gem configuration to <tt>config/environment.rb</tt>
 
   config.gem "wizard_controller"
 
+Ensure the following is present in <tt>config/routes.rb</tt>
+
+  map.connect ':controller/:action/:id'
+  
+... or explicitly map the routes you want to use.
+
 === Example Controller
 
   class ExampleController < Codeprimate::Wizard::Base
     # Define the method names of the wixard steps
     define_steps :page_one, :page_two, :page_three
-    
+
     # Specify where the Wizard should redirect upon completion.
     set_finish_path "http://www.example.com/go_here_when_done.html"
-    
+
 
     # Ensure "index" is not defined!
     # def index
     # end
-    
+
     def start
       # Create a "safe"  index method for this controller, and handle it appropriately
     end
-    
+
     def foobar
       # You can define whatever actions you want.  WizardController doesnt get in the way.
     end
-    
+
     def page_one
       # This is a regular action method. Create indiviual views for action methods.
     end
-    
+
     def process_page_one
       # Place logic to handle any output from page one here.
       # No view will be shown for this 
@@ -51,24 +53,24 @@ Add the gem configuration to your config/environment.rb
       # Return false if you want to return to the page_one view
       return true
     end  
-    
+
     def page_two
       # Let's say this action/view is merely informative.
       # We will not supply a process method, and the user will always be able
       # to go to the next step
     end
-    
+
     def page_three
       # Just another step method here
     end
-    
+
     def process_page_three
       # Since this is the last step, if this process method returns true
       # the user will be redirected to the URL specified in the 
       # "set_finish_path" declaration at the beginning of the Controller definition
     end
   end
-  
+
 === View Helper Methods
 
 * <tt>step_number()</tt>: Current step index.
@@ -77,11 +79,6 @@ Add the gem configuration to your config/environment.rb
 * <tt>wizard_path()</tt>: Wizard index path.  <b>THIS SHOULD BE THE ACTION PATH OF ALL FORMS/VIEWS WITH A "process" action.</b>
 * <tt>next_step_path()</tt>: URL to the next step.
 * <tt>previous_step_path()</tt>: URL to the previous step.
+* <tt>direct_step_path()</tt>: URL to a direct step. Example for step 3: <code>direct_step_path(:id=>3)</code>.  User will stay on the current step if they have not completed the one they are requesting.
 * <tt>reset_wizard_path()</tt>: URL to reset the Wizard.
-* <tt>abort_wizard_path()</tt>: URL to abort the Wizard.
-
-
-
-  
-  
-  
+* <tt>abort_wizard_path()</tt>: URL to abort the Wizard.

data/lib/wizard_controller.rb

@@ -1,24 +1,22 @@
-module Codeprimate
-	VERSION = "0.1.7"
-  
+module Codeprimate  
   # = Wizard Controller
   # 
   # Wizard controller provides a base class (Inheriting from ActionController::Base)
   # that provides a DSL for quickly making Wizards.
   # 
-  # In order for this to work, you need to have this standard route present:
-  # 
-  #   map.connect ':controller/:action/:id'
-  # 
   # VERY IMPORTANT!!! DONT OVERRIDE INDEX!
   # Doing so will break all functionality. WizardController works by defining an 
   # "index" method that does all the work.  To start a wizard, go to the "index" method.
   # 
   # === Setup and Configuration
   # 
-  # Add the gem configuration to your config/environment.rb
+  # Add the following gem configuration to <tt>config/environment.rb</tt>
   # 
   #   config.gem "wizard_controller"
+  #
+  # Ensure the following is present in <tt>config/routes.rb</tt>
+  # 
+  #   map.connect ':controller/:action/:id'
   # 
   # === Example Controller
   # 
@@ -83,6 +81,7 @@ module Codeprimate
   # * <tt>reset_wizard_path()</tt>: URL to reset the Wizard.
   # * <tt>abort_wizard_path()</tt>: URL to abort the Wizard.
   module Wizard
+    VERSION = "0.1.7"
 
     class Base < ApplicationController
       before_filter :restrict_access, :init_wizard_session
@@ -151,6 +150,17 @@ module Codeprimate
         redirect_to :action => :index
       end
 
+      # Internal.
+      def direct_step
+        step = params[:id].to_i
+        if step_completed(step)
+          set_current_wizard_step([1, step].max)
+        else
+          flash[:error] ||= self.class.wizard_default_error
+        end
+        redirect_to :action => :index
+      end
+
       # Public action to reset the wizard
       def reset
         reset_wizard
@@ -199,7 +209,7 @@ module Codeprimate
       end
 
       def restrict_access
-        ['index', 'next_step', 'previous_step', 'reset'].include?(params[:action])
+        ['index', 'next_step', 'previous_step', 'direct_step', 'reset'].include?(params[:action])
       end
 
       def execute_method(m=current_wizard_step_method)
@@ -234,9 +244,14 @@ module Codeprimate
         url_for(:controller => self.controller_name, :action => :previous_step)
       end
 
+      helper_method :direct_step_path
+      def direct_step_path(step)
+        url_for(:controller => self.controller_name, :action => :direct_step, :id => step)
+      end
+
       helper_method :step_completed
-      def step_completed
-        session[:wizard][self.class.to_s][:completed][current_wizard_step] == true
+      def step_completed(direct_step = current_wizard_step)
+        session[:wizard][self.class.to_s][:completed][direct_step] == true
       end
 
       helper_method :wizard_path
@@ -273,7 +288,7 @@ module Codeprimate
       def decr_step
         set_current_wizard_step([1, (current_wizard_step - 1)].max)
       end
-
+      
       def current_wizard_step_method
         self.class.wizard_steps[(current_wizard_step - 1)]
       end

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: wizard_controller
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Patrick Morgan
+- Midwire
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-11-02 00:00:00 -06:00
+date: 2010-02-02 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
 description: Wizard Controller is an inheritable class to ease the creation of Wizards
-email: patrick.morgan@masterwebdesign.net
+email: patrick.morgan@masterwebdesign.net midwire@midwire.com
 executables: []
 
 extensions: []
@@ -22,7 +23,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
 - README.rdoc
 - History.txt
 - lib/wizard_controller.rb

data/README

@@ -1,3 +0,0 @@
-Wizard Controller
-
-Make your controller inherit from this class.