wizard_controller 0.1.5 → 0.1.6

data/README.rdoc

@@ -1,3 +1,81 @@
-Wizard Controller
+= Wizard Controller
 
-Make your controller inherit from this class.
+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.
+
+=== 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 
+      #
+      # Return true if your logic wants you to go to the next step
+      # 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.
+* <tt>total_steps()</tt>: Total Number of steps in the wizard.
+* <tt>step_completed()</tt>: Returns boolean, whether the step has been completed.
+* <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>reset_wizard_path()</tt>: URL to reset the Wizard.
+* <tt>abort_wizard_path()</tt>: URL to abort the Wizard.
+
+
+
+  
+  
+  

data/lib/wizard_controller.rb

@@ -1,5 +1,5 @@
 module Codeprimate
-	VERSION = "0.1.5"
+	VERSION = "0.1.6"
   
   module Wizard
 
@@ -13,18 +13,26 @@ module Codeprimate
         @wizard_default_error = 'There was a problem processing the last step.'
         attr_accessor :wizard_steps, :finish_path, :abort_path, :wizard_default_error
 
+        # Define steps of the wizard.
+        #
+        # Should be an array of symbols.
         def define_steps(*args)
           self.wizard_steps = args
         end
 
+        # Set the URL that a user is redirected to after finishing the Wizard.
+        #
+        # Should be a string
         def set_finish_path(p)
           self.finish_path = p
         end
 
+        # Set the URL that a user is redirected to after aborting the Wizard.
         def set_abort_path(p)
           self.abort_path = p
         end
 
+        # Set the flash message a user sees when a process_action method returns false
         def set_default_error(e)
           self.wizard_default_error = e
         end
@@ -32,10 +40,7 @@ module Codeprimate
 
       ### PUBLIC ACTIONS
 
-      def set_abort_path(p)
-        self.abort_path = p
-      end
-
+      # Internal.
       def index
         if finished
           handle_finished_wizard
@@ -43,7 +48,8 @@ module Codeprimate
           handle_unfinished_wizard
         end
       end
-
+      
+      # Internal.
       def next_step
         if step_completed
           incr_step
@@ -54,16 +60,21 @@ module Codeprimate
         redirect_to :action => :index
       end
 
+      # Internal.
       def previous_step
         decr_step
         redirect_to :action => :index
       end
 
+      # Public action to reset the wizard
       def reset
         reset_wizard
         redirect_to :action => :index
       end
 
+      # Assign finish path.
+      #
+      # Accepts a string.
       def finish_path=(p)
         unless p.blank?
           session[:finish_path] = p

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wizard_controller
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Patrick Morgan
@@ -54,6 +54,6 @@ rubyforge_project: wizard_controller
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Wizard Controller is an inheritable class to ease the creation of Wizards
+summary: Wizard controller provides a base class (Inheriting from ActionController::Base) that provides a DSL for quickly making Wizards.
 test_files: []