wicked 1.0.3 → 2.0.0

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

@@ -1,51 +1,63 @@
 module Wicked::Controller::Concerns::RenderRedirect
   extend ActiveSupport::Concern
 
-
-  def render_wizard(resource = nil, options = {})
-    process_resource!(resource)
+  def render_wizard(resource = nil, options = {}, params = {})
+    process_resource!(resource, options)
 
     if @skip_to
-      redirect_to wizard_path(@skip_to), options
+      url_params = (@wicked_redirect_params || {}).merge(params)
+      redirect_to wizard_path(@skip_to, url_params), options
     else
-      render_step wizard_value(step), options
+      render_step(wizard_value(step), options, params)
     end
   end
 
-  def process_resource!(resource)
-    if resource
-      if resource.save
-        @skip_to ||= @next_step
-      else
-        @skip_to = nil
-      end
+  def process_resource!(resource, options = {})
+    return unless resource
+
+    if options[:context]
+      did_save = resource.save(context: options[:context])
+    else
+      did_save = resource.save
+    end
+
+    if did_save
+      @skip_to ||= @next_step
+    else
+      @skip_to = nil
+      # Do not override user-provided status for render
+      options[:status] ||= :unprocessable_entity
     end
   end
 
-  def render_step(the_step, options = {})
+  def render_step(the_step, options = {}, params = {})
     if the_step.nil? || the_step.to_s == Wicked::FINISH_STEP
-      redirect_to_finish_wizard options
+      redirect_to_finish_wizard options, params
     else
       render the_step, options
     end
   end
 
-  def redirect_to_next(next_step, options = {})
+  def redirect_to_next(next_step, options = {}, params = {})
     if next_step.nil?
-      redirect_to_finish_wizard(options)
+      redirect_to_finish_wizard(options, params)
     else
-      redirect_to wizard_path(next_step), options
+      redirect_to wizard_path(next_step, params), options
     end
   end
 
   # TODO redirect to resource if one is passed to render_wizard
-  def finish_wizard_path
-    '/'
+  def finish_wizard_path(params = {})
+    url = '/'
+    url = "#{url}?#{params.to_query}" unless params.blank?
+    url
   end
 
-  def redirect_to_finish_wizard(options = {})
-    Rails.logger.debug("Wizard has finished, redirecting to finish_wizard_path: #{finish_wizard_path.inspect}")
-    redirect_to finish_wizard_path, options
+  def redirect_to_finish_wizard(options = {}, params = {})
+    wicked_final_redirect_path = method(:finish_wizard_path).arity == 1 ? finish_wizard_path(params) : finish_wizard_path
+    Rails.logger.debug("Wizard has finished, redirecting to finish_wizard_path: #{wicked_final_redirect_path.inspect}")
+    # flash.keep is required for Rails 3 where a flash message is lost on a second redirect.
+    flash.keep
+    redirect_to wicked_final_redirect_path, options
   end
 end
-

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

@@ -3,12 +3,14 @@ module Wicked::Controller::Concerns::Steps
 
   extend ActiveSupport::Concern
 
-  def jump_to(goto_step)
-    @skip_to = goto_step
+  def jump_to(goto_step, options = {})
+    @skip_to                = goto_step
+    @wicked_redirect_params = options
   end
 
-  def skip_step
-    @skip_to = @next_step
+  def skip_step(options = {})
+    @skip_to                = @next_step
+    @wicked_redirect_params = options
   end
 
   def step
@@ -50,8 +52,8 @@ module Wicked::Controller::Concerns::Steps
       options = args.extract_options!
       steps   = args
       check_protected!(steps)
-      prepend_before_filter(options) do
-        self.steps = steps
+      prepend_before_action(options) do
+        self.steps = steps.dup
       end
     end
 
@@ -79,31 +81,24 @@ module Wicked::Controller::Concerns::Steps
     index =  steps.index(current_step)
     step  =  steps.at(index - 1) if index.present? && index != 0
     step ||= steps.first
-    step
   end
 
-
   def next_step(current_step = nil)
     return @next_step if current_step.nil?
     index = steps.index(current_step)
     step  = steps.at(index + 1) if index.present?
     step  ||= Wicked::FINISH_STEP
-    step
   end
 
-  private
-
-  def step_index_for(step_name)
+  private def step_index_for(step_name)
     steps.index(step_name)
   end
 
-  def current_step_index
+  private def current_step_index
     step_index_for(step)
   end
 
-  def current_and_given_step_exists?(step_name)
-    return false if current_step_index.nil? || steps.index(step_name).nil?
-    return true
+  private def current_and_given_step_exists?(step_name)
+    current_step_index.present? && steps.index(step_name).present?
   end
 end
-

data/lib/wicked/version.rb

@@ -0,0 +1,3 @@
+module Wicked
+  VERSION = "2.0.0"
+end

data/lib/wicked/wizard/translated.rb

@@ -5,8 +5,8 @@ module Wicked
       include Wicked::Wizard
 
       included do
-        skip_before_filter :setup_wizard
-        before_filter      :setup_wizard_translated
+        skip_before_action :setup_wizard
+        before_action :setup_wizard_translated
 
         helper_method      :wizard_translate, :wizard_value
       end
@@ -57,7 +57,6 @@ module Wicked
       end
 
 
-      private
       # sets up a translated wizard controller
       # translations are expected under the 'wicked' namespace
       #
@@ -74,12 +73,10 @@ module Wicked
       #
       #     steps "wicked.first", "wicked.second"
       #
-      def setup_wizard_translated
+      private def setup_wizard_translated
         self.steps = wizard_translations.keys     # must come before setting previous/next steps
         setup_wizard
       end
-      public
     end
   end
 end
-

data/lib/wicked/wizard.rb

@@ -3,14 +3,18 @@ module Wicked
     extend ActiveSupport::Concern
 
     class InvalidStepError < RuntimeError
-      def initialize
-        super "The requested step did not match any steps defined for this controller."
+      attr_accessor :step
+
+      def initialize(step = nil)
+        self.step = step
+
+        super "The requested step did not match any steps defined for this controller: #{step.inspect}"
       end
     end
 
     class UndefinedStepsError < RuntimeError
       def initialize
-        super "No step definitions have been supplied; if setting via `before_filter`, use `prepend_before_filter`"
+        super "No step definitions have been supplied; if setting via `before_action`, use `prepend_before_action`"
       end
     end
 
@@ -20,19 +24,19 @@ module Wicked
     include Wicked::Controller::Concerns::Steps
 
     included do
+      include Wicked::Controller::Concerns::Action
       # Give our Views helper methods!
-      helper_method :wizard_path,     :next_wizard_path, :previous_wizard_path,
-                    :step,            :wizard_steps,     :current_step?,
-                    :past_step?,      :future_step?,     :previous_step?,
-                    :next_step?
+      helper_method :wizard_path, :wizard_url, :next_wizard_path, :next_wizard_url, :previous_wizard_path,
+                    :previous_wizard_url, :step, :wizard_steps, :current_step?, :past_step?, :future_step?,
+                    :next_step?,  :previous_step?
+
       # Set @step and @next_step variables
-      before_filter :setup_wizard
+      before_action :initialize_wicked_variables, :setup_wizard
     end
 
     # forward to first step with whatever params are provided
     def index
-      query_string = "?#{request.query_parameters.to_query}" if request.query_parameters.any?
-      redirect_to "#{ wizard_path(steps.first) }#{ query_string || '' }"
+      redirect_to wizard_path(steps.first, request.query_parameters)
     end
 
     # returns the canonical value for a step name, needed for translation support
@@ -40,43 +44,44 @@ module Wicked
       step_name
     end
 
-    private
+    private def initialize_wicked_variables
+      @skip_to = nil
+      @wicked_redirect_params = nil
+    end
 
-    def check_redirect_to_first_last!(step)
+    private def check_redirect_to_first_last!(step)
       redirect_to wizard_path(steps.first) if step.to_s == Wicked::FIRST_STEP
       redirect_to wizard_path(steps.last)  if step.to_s == Wicked::LAST_STEP
     end
 
-    def setup_step_from(the_step)
+    private def setup_step_from(the_step)
       return if steps.nil?
 
       the_step ||= steps.first
       check_redirect_to_first_last!(the_step)
 
       valid_steps = steps + self.class::PROTECTED_STEPS
-      the_step = valid_steps.detect { |stp| stp.to_s == the_step }
+      resolved_step = valid_steps.detect { |stp| stp.to_s == the_step }
 
-      raise InvalidStepError if the_step.nil?
-      the_step
+      raise InvalidStepError.new(the_step) if resolved_step.nil?
+      resolved_step
     end
 
-    def check_steps!
+    private def check_steps!
       raise UndefinedStepsError if steps.nil?
     end
 
-    def set_previous_next(step)
-      @previous_step = previous_step(@step)
-      @next_step     = next_step(@step)
+    private def set_previous_next(step)
+      @previous_step = previous_step(step)
+      @next_step     = next_step(step)
     end
 
-    def setup_wizard
+    private def setup_wizard
       check_steps!
       return if params[:id].nil?
 
       @step = setup_step_from(params[:id])
       set_previous_next(@step)
     end
-    public
   end
 end
-

data/{app/controllers → lib}/wicked/wizard_controller.rb

@@ -32,7 +32,6 @@ class Wicked::WizardController < ApplicationController
   #     @user.update_attributes(params[:user])
   #   end
   #   sign_in(@user, :bypass => true) # needed for devise
-  #   render_wizard
+  #   render_wizard @user
   # end
 end
-

data/lib/wicked.rb

@@ -13,6 +13,7 @@ module Wicked
   end
   module Wizard
   end
+  autoload :WizardController, "wicked/wizard_controller"
 end
 
 class WickedError < StandardError; end
@@ -21,7 +22,7 @@ class WickedProtectedStepError < WickedError; end
 require 'wicked/controller/concerns/render_redirect'
 require 'wicked/controller/concerns/steps'
 require 'wicked/controller/concerns/path'
+require 'wicked/controller/concerns/action'
 require 'wicked/wizard'
 require 'wicked/wizard/translated'
 require 'wicked/engine'
-

data/test/controllers/bar_controller_test.rb

@@ -1,13 +1,14 @@
 require 'test_helper'
 
-class BarControllerTest < ActionController::TestCase
+class BarControllerTest < WickedControllerTestCase
+
   test 'index redirects to the first step' do
     get :index
     assert_redirected_to bar_path(:first)
   end
 
   test 'index redirects to the first step, preserving query args' do
-    get :index, :some => 'arguments', :were => 'passed'
+    get :index, params: { :some => 'arguments', :were => 'passed' }
     assert_redirected_to bar_path(:first, :some => 'arguments', :were => 'passed')
   end
 end

data/test/controllers/status_codes_controller_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class StatusCodesControllerTest < WickedControllerTestCase
+  test 'returns successful status code for show' do
+    get :show, params: { id: 'good' }
+    assert_response(:success)
+  end
+
+  test 'returns correct status code for successfuly update' do
+    put :update, params: { id: 'good' }
+    assert_response(:redirect)
+  end
+
+  test 'returns correct status code for failed update' do
+    put :update, params: { id: 'bad' }
+    assert_response(:unprocessable_entity)
+  end
+end

data/test/controllers/updates_controller_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class UpdatesControllerTest < WickedControllerTestCase
+  test 'redirect from first step to second step' do
+    put :update, params: {:id => 'first'}
+    assert_redirected_to update_path(:second)
+    assert_equal 'Thing was updated from step first.', flash[:notice]
+  end
+
+  test 'redirect from second step to final step' do
+    put :update, params: {:id => 'second'}
+    assert_redirected_to update_path(:last_step)
+    assert_equal 'Thing was updated from step second.', flash[:notice]
+  end
+
+  test 'redirect from last_step to root path' do
+    put :update, params: {:id => 'last_step'}
+    assert_redirected_to update_path(:wicked_finish)
+    assert_equal 'Thing was updated from step last_step.', flash[:notice]
+  end
+
+  test 'redirect from wicked_finish to root path' do
+    get :show, params: {:id => Wicked::FINISH_STEP}, flash: {:notice => "flash from last_step"}
+    assert_redirected_to updates_path
+    assert_equal 'flash from last_step', flash[:notice]
+  end
+end

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

@@ -1,7 +1,10 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
-  before_filter :pull_out_locale
-
+  if respond_to? :before_action
+    before_action :pull_out_locale
+  else
+    before_filter :pull_out_locale
+  end
 
   def pull_out_locale
     I18n.locale = params[:locale] if params[:locale].present?

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

@@ -0,0 +1,18 @@
+class DynamicDifferentStepsController < ApplicationController
+  include Wicked::Wizard
+
+  before_action :set_steps
+  before_action :setup_wizard
+
+  def show
+    render_wizard
+  end
+
+
+  private
+  def set_steps
+    self.steps = if params[:steps]
+      params[:steps]
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 class DynamicStepsController < ApplicationController
   include Wicked::Wizard
-  prepend_before_filter :set_steps
+  prepend_before_action :set_steps
 
   def show
     render_wizard

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

@@ -5,8 +5,8 @@ class JumpController < ApplicationController
   steps :first, :second, :last_step
 
   def show
-    skip_step if params[:skip_step]
-    jump_to :last_step if params[:jump_to]
+    skip_step(skip_step_options) if params[:skip_step]
+    jump_to :last_step, skip_step_options if params[:jump_to]
     if params[:resource]
       value = params[:resource][:save] == 'true'
       @bar  = Bar.new(value)
@@ -19,4 +19,11 @@ class JumpController < ApplicationController
   def update
   end
 
+  private
+
+  def skip_step_options
+    options = params[:skip_step_options]
+    options.permit! if options.respond_to? :permitted?
+    options
+  end
 end

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

@@ -17,4 +17,4 @@ class RedirectToNextController < ApplicationController
   def update
   end
 
-end
+end

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

@@ -0,0 +1,39 @@
+class StatusCodesController < ApplicationController
+  include Wicked::Wizard
+
+  class GoodThing
+    def save
+      true
+    end
+  end
+
+  class BadThing
+    def save
+      false
+    end
+  end
+
+  steps :good, :bad
+
+  def index; end
+
+  def show
+    render_wizard
+  end
+
+  def update
+    case step
+    when :good
+      @thing = GoodThing.new
+    when :bad
+      @thing = BadThing.new
+    end
+    render_wizard(@thing, notice: "Thing was updated from step #{step}.")
+  end
+
+  private
+
+  def finish_wizard_path
+    updates_path
+  end
+end

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

@@ -0,0 +1,30 @@
+class UpdateParamsController < ApplicationController
+  include Wicked::Wizard
+
+  class Thing
+    def save
+      true
+    end
+  end
+
+  steps :first, :second, :last_step
+
+  def index
+
+  end
+
+  def show
+    render_wizard(nil, {}, { one: 'two' })
+  end
+
+  def update
+    @thing = Thing.new
+    render_wizard(@thing, { notice: "Thing was updated from step #{step}." }, { one: 'two' })
+  end
+
+  private
+
+  def finish_wizard_path(params)
+    update_params_path(params)
+  end
+end

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

@@ -0,0 +1,30 @@
+class UpdatesController < ApplicationController
+  include Wicked::Wizard
+
+  class Thing
+    def save
+      true
+    end
+  end
+
+  steps :first, :second, :last_step
+
+  def index
+
+  end
+
+  def show
+    render_wizard
+  end
+
+  def update
+    @thing = Thing.new
+    render_wizard(@thing, notice: "Thing was updated from step #{step}.")
+  end
+
+  private
+
+  def finish_wizard_path
+    updates_path
+  end
+end

data/test/dummy/app/views/bar/first.html.erb

@@ -4,4 +4,6 @@ first
 <%= "params[:foo] #{params[:foo]}" %>
 <%= link_to 'last', wizard_path(:last_step) %>
 <%= link_to 'current', wizard_path %>
-<%= link_to 'skip', next_wizard_path %>
+<%= link_to 'current url', wizard_url %>
+<%= link_to 'skip', next_wizard_path %>
+<%= link_to 'next url', next_wizard_url %>

data/test/dummy/app/views/bar/second.html.erb

@@ -1,3 +1,4 @@
 second
 
-<%= link_to 'previous', previous_wizard_path %>
+<%= link_to 'previous', previous_wizard_path %>
+<%= link_to 'previous url', previous_wizard_url %>

data/test/dummy/app/views/dynamic_different_steps/first.html.erb

@@ -0,0 +1,3 @@
+<%= step.inspect %>
+<br />
+<%= wizard_steps.inspect %>

data/test/dummy/app/views/jump/last_step.html.erb

@@ -1 +1,3 @@
-last_step
+last_step
+
+<%= params.inspect %>

data/test/dummy/app/views/jump/second.html.erb

@@ -1 +1,3 @@
-second
+second
+
+<%= params.inspect %>

data/test/dummy/app/views/status_codes/bad.html.erb

@@ -0,0 +1 @@
+bad step

data/test/dummy/app/views/status_codes/good.html.erb

@@ -0,0 +1 @@
+good step

data/test/dummy/app/views/update_params/_step_position.html.erb

@@ -0,0 +1,16 @@
+<% wizard_steps.each do |s| %>
+  <%= s.inspect %>
+  <%= I18n.t("wicked.#{s}") %>
+  <p>
+    <strong><u><%= s.inspect %></u></strong><br />
+    <%= current_step?(s)  ? "#{s} step is the current step"   : "nope" %><br />
+    <%= past_step?(s)     ? "#{s} step is a past step"        : "nope" %><br />
+    <%= future_step?(s)   ? "#{s} step is a future step"      : "nope" %><br />
+    <%= previous_step?(s) ? "#{s} step was the previous step" : "nope" %><br />
+    <%= next_step?(s)     ? "#{s} step is the next step"      : "nope" %><br />
+  </p>
+<% end %>
+
+<%= form_tag update_param_path(step, {one: 'two'}), :method => :put do  %>
+  <%= submit_tag "Next" %>
+<% end %>

data/test/dummy/app/views/update_params/first.html.erb

@@ -0,0 +1 @@
+<%= render 'step_position' %>

data/test/dummy/app/views/update_params/index.html.erb

@@ -0,0 +1 @@
+Index page.

data/test/dummy/app/views/update_params/last_step.html.erb

@@ -0,0 +1 @@
+<%= render 'step_position' %>

data/test/dummy/app/views/update_params/second.html.erb

@@ -0,0 +1 @@
+<%= render 'step_position' %>

data/test/dummy/app/views/updates/_step_position.html.erb

@@ -0,0 +1,16 @@
+<% wizard_steps.each do |s| %>
+  <%= s.inspect %>
+  <%= I18n.t("wicked.#{s}") %>
+  <p>
+    <strong><u><%= s.inspect %></u></strong><br />
+    <%= current_step?(s)  ? "#{s} step is the current step"   : "nope" %><br />
+    <%= past_step?(s)     ? "#{s} step is a past step"        : "nope" %><br />
+    <%= future_step?(s)   ? "#{s} step is a future step"      : "nope" %><br />
+    <%= previous_step?(s) ? "#{s} step was the previous step" : "nope" %><br />
+    <%= next_step?(s)     ? "#{s} step is the next step"      : "nope" %><br />
+  </p>
+<% end %>
+
+<%= form_tag update_path(step, {one: 'two'}), :method => :put do  %>
+  <%= submit_tag "Next" %>
+<% end %>

data/test/dummy/app/views/updates/first.html.erb

@@ -0,0 +1 @@
+<%= render 'step_position' %>

data/test/dummy/app/views/updates/index.html.erb

@@ -0,0 +1 @@
+Index page.

data/test/dummy/app/views/updates/last_step.html.erb

@@ -0,0 +1 @@
+<%= render 'step_position' %>

data/test/dummy/app/views/updates/second.html.erb

@@ -0,0 +1 @@
+<%= render 'step_position' %>