wicked-focused 0.2.0 → 0.2.1

data/README.md

@@ -114,6 +114,12 @@ class AfterSignupController
     steps :confirm_password, :confirm_profile, :find_friends
   end    
 
+  wizard_action :show do
+    wizard do
+      render_wizard
+    end
+  end  
+
   wizard_action :update do
     wizard do
       @user = current_user
@@ -149,7 +155,7 @@ In the controller if you find that you want to skip a step, you can do it simply
 
 ```ruby
 
-  wizard_action :show do
+  show_wizard do
     wizard do
       @user = current_user
       case step
@@ -180,11 +186,19 @@ Created the Focused Controller action base class, from which any Wizard Action c
 
 `wizard_action name, &block` 
 
-Creates a Focused Controller action class inheriting from the base action class of the controller. The block contains the class definition. 
+Creates a Focused Controller action class inheriting from the base action class of the controller. The block contains the class definition. The wizard actions are `show` and `update`. To further abstract this, the shorthand macros: `show_wizard &block` and `update_wizard &block` are also available.
+
+`wizard &block`
+
+Creates a `#run` method as "required" by a Focused Controller action class. 
+
+The run method generated also:
 
-`wizard`
+* calls `super()` which calls `setup_wizard`
+* auto-handles redirects to first or last step (*)
+* skips step (*)
 
-Creates a `#run` method as "required" by a Focused Controller action class. The run method generated calls super which calls `setup_wizard` and also auto-handles redirects.
+(*) if params indicate this is requested behavior
 
 *View/URL Helpers*
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/wicked/action.rb

@@ -24,6 +24,7 @@ module Wicked
       def wizard &block
         define_method :run do
           wizard_redirect and return if super()
+          skip_step if skip_step?
           instance_eval &block
         end
       end

data/lib/wicked/controller/concerns/steps.rb

@@ -44,7 +44,7 @@ module Wicked::Controller::Concerns::Steps
   end
 
   module ClassMethods
-    attr_reader :wizard_steps
+    attr_reader :wizard_steps, :skip_steps
 
     def steps(*args)
       options = args.last.is_a?(Hash) ? callbacks.pop : {}
@@ -54,6 +54,11 @@ module Wicked::Controller::Concerns::Steps
         self.steps = steps
       end
     end
+
+    def allow_skip_for(*args)
+      @skip_steps = args
+    end
+    alias :optional_steps :allow_skip_for
   end
 
   def steps=(wizard_steps)
@@ -66,6 +71,13 @@ module Wicked::Controller::Concerns::Steps
   alias :wizard_steps :steps
   alias :steps_list   :steps
 
+  def skip_step?
+    return false unless params[:skip_step]
+    skip_steps = self.class.superclass.skip_steps
+    return true if skip_steps.blank?
+    skip_steps.include? step.to_sym
+  end
+
   def previous_step(current_step = nil)
     return previous_step if current_step == nil
     index =  steps.index(current_step)

data/lib/wicked/wizard.rb

@@ -21,6 +21,14 @@ module Wicked
       def wizard_action action, &block
         focused_action action, "#{self.name}::Action".constantize, &block
       end
+
+      def show_wizard &block
+        focused_action :show, "#{self.name}::Action".constantize, &block
+      end
+
+      def update_wizard &block
+        focused_action :update, "#{self.name}::Action".constantize, &block
+      end
     end
   end
 end

data/test/dummy/app/controllers/bar_controller.rb

@@ -9,10 +9,15 @@ module BarController
   
   wizard_action :show do
     wizard do
-      skip_step if params[:skip_step]
+      # skip_step if skip_step?
       render_wizard
     end
   end
 
-  focused_action :update
+  wizard_action :update do
+    wizard do
+      # update code here!
+      render_wizard
+    end
+  end    
 end

data/test/dummy/app/controllers/foo_controller.rb

@@ -5,15 +5,23 @@ module FooController
     include Wicked::Action
 
     steps :first, :second, :last_step
+
+    # alias: allow_skip_for
+    optional_steps :first
   end
   include Wicked::Wizard  
 
   wizard_action :show do
     wizard do
-      skip_step if params[:skip_step]
+      # skip_step if skip_step?
       render_wizard
     end
   end
 
-  wizard_action :update
+  wizard_action :update do
+    wizard do
+      # update code here!
+      render_wizard
+    end
+  end    
 end

data/test/dummy/app/controllers/jump_controller.rb

@@ -10,7 +10,7 @@ module JumpController
 
   wizard_action :show do
     wizard do
-      skip_step if params[:skip_step]
+      # skip_step if skip_step?
       jump_to :last_step if params[:jump_to]
       if params[:resource]
         value = params[:resource][:save] == 'true'
@@ -22,5 +22,10 @@ module JumpController
     end
   end
 
-  wizard_action :update
+  wizard_action :update do
+    wizard do
+      # update code here!
+      render_wizard
+    end
+  end    
 end

data/test/dummy/app/controllers/steps_controller.rb

@@ -14,5 +14,10 @@ module StepPositionsController
     end
   end
 
-  wizard_action :update
+  wizard_action :update do
+    wizard do
+      # update code here!
+      render_wizard
+    end
+  end    
 end

data/test/integration/navigation_test.rb

@@ -25,6 +25,12 @@ class InheritNavigationTest < ActiveSupport::IntegrationCase
     assert has_content?('second')
   end
 
+  test 'not allowed to skip second' do
+    step = :second
+    visit(foo_path(step.to_s, :skip_step => 'true'))
+    assert has_content?('second')
+  end    
+
   test 'invalid step' do
     step = :notastep
     assert_raise(ActionView::MissingTemplate) do

data/wicked-focused.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wicked-focused"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kristianmandrup", "schneems"]
-  s.date = "2012-08-06"
+  s.date = "2012-08-07"
   s.description = "Rails engine for producing Focused Controller based wizards"
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wicked-focused
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -254,7 +254,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 446861709014674562
+      hash: 315033251613805856
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: