wicked 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11cb28be77c99ea61096702aa91925c6fc5f70a0
-  data.tar.gz: 7bfe552498e8dc0b263b731b88f21afa203ce906
+  metadata.gz: b63f9f8d7d8f8c637a0aadb1efee7dbc2342375e
+  data.tar.gz: 3c318690cd2f9f2f0a5b24fae6ad990351398b60
 SHA512:
-  metadata.gz: f01bf2e83f1a848225a59fa4bf6feb18567c1e14fe116aea9ba69a292a4ca878e35eef48646a013f8a0016c22e5c19a4e474d62c4f62a4ea81b8d5fd17114187
-  data.tar.gz: c3d6640feacdee82c98b7c652fbcca9a0414b8669e9bf52e78fee80518c233266da3e99b66eeaa3f3fff2f630cedc696bec64520bf60d06752dc271f628f2c19
+  metadata.gz: ec7cdb890f429b88a73cf90c057ecbdfd89118a0287f02da5d3c293f3f807e1c9ac364945422a6c4ea9737cdbd77ccc4984a58c3b866251775a380770cd56045
+  data.tar.gz: b7d891997073d41429a7aa45cd6c7ee8b9d76782ddab6915ef1664df2939f5a854e8f094367cc13ff6e3accdb703514fa269753b64eba28f2a11aa54919da882

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Master
 
+## 1.3.2
+
+* Support for params (#222)
+
 ## 1.3.1
 
 * Docs and minor fixes

data/README.md

@@ -397,6 +397,39 @@ end
 
 NOTE: The order of the `before_action` matters, when `setup_wizard` is called it will validate the presence of `self.steps`, you must call your custom step setting code before this point.
 
+## Send params to finish_wizard_path method
+
+If you wish to send parameters to the `finish_wizard_path` method that can be done by adding to your controller the method with the params argument `def finish_wizard_path(params) ... end`.
+
+In order to send the parameters to the method here is an example of the show method:
+
+```ruby
+steps :first_step, :second_step
+
+def show
+  # ...
+  render_wizard(nil, {}, { hello: 'world' })
+end
+
+def update
+  # ...
+  render_wizard(@user, {}, { hello: 'world' })
+end
+
+def finish_wizard_path(params)
+  # here you can access params and that would be equal to { hello: 'world' }
+end
+```
+
+The `wizard_path` and `next_wizard_path` methods also take parameters that can then be accessed or visible in the `show` and `update` actions of the controller. You can use the methods like so:
+
+```ruby
+next_wizard_path({ hello: 'world' })
+wizard_path(nil, { hello: 'world' })
+# the wizard_path with the step specified would look like this
+wizard_path(:wicked_finish, wizard_id: @user.id, hello: 'world')
+```
+
 ## Keywords
 
 There are a few "magical" keywords that will take you to the first step,

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

@@ -2,13 +2,14 @@ module Wicked::Controller::Concerns::RenderRedirect
   extend ActiveSupport::Concern
 
 
-  def render_wizard(resource = nil, options = {})
+  def render_wizard(resource = nil, options = {}, params = {})
     process_resource!(resource)
 
     if @skip_to
-      redirect_to wizard_path(@skip_to, @wicked_redirect_params || {}), 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
 
@@ -22,29 +23,31 @@ module Wicked::Controller::Concerns::RenderRedirect
     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 = {})
-    wicked_final_redirect_path = finish_wizard_path
+  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

data/lib/wicked/version.rb

@@ -1,3 +1,3 @@
 module Wicked
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/lib/wicked/wizard_controller.rb

@@ -32,7 +32,7 @@ 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/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/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

@@ -11,6 +11,6 @@
   </p>
 <% end %>
 
-<%= form_tag update_path(step), :method => :put do  %>
+<%= form_tag update_path(step, {one: 'two'}), :method => :put do  %>
   <%= submit_tag "Next" %>
 <% end %>

data/test/dummy/config/routes.rb

@@ -9,6 +9,7 @@ Dummy::Application.routes.draw do
   resources :redirect_to_next
   resources :redirect_to_finish_flash
   resources :updates
+  resources :update_params
 
   resources :nested do
     resources :builder, :controller => 'nested/builder'

data/test/integration/update_params_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class UpdateParamsTest < ActiveSupport::IntegrationCase
+  test 'on first' do
+    step = :first
+    visit(update_param_path(step))
+
+    click_button("Next")
+    assert_equal page.current_path, update_param_path(:second)
+    assert_has_content?("notice:Thing was updated from step first.")
+
+    click_button("Next")
+    assert_equal page.current_path, update_param_path(:last_step)
+    assert_has_content?("notice:Thing was updated from step second.")
+
+    click_button("Next")
+    assert_equal page.current_url, update_params_url({host: 'www.example.com', one: 'two' })
+    assert_has_content?("notice:Thing was updated from step last_step.")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wicked
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -128,6 +128,7 @@ files:
 - test/dummy/app/controllers/redirect_to_next_controller.rb
 - test/dummy/app/controllers/step_positions_controller.rb
 - test/dummy/app/controllers/string_steps_controller.rb
+- test/dummy/app/controllers/update_params_controller.rb
 - test/dummy/app/controllers/updates_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/bar.rb
@@ -157,6 +158,11 @@ files:
 - test/dummy/app/views/step_positions/last_step.html.erb
 - test/dummy/app/views/step_positions/second.html.erb
 - test/dummy/app/views/string_steps/second.html.erb
+- test/dummy/app/views/update_params/_step_position.html.erb
+- test/dummy/app/views/update_params/first.html.erb
+- test/dummy/app/views/update_params/index.html.erb
+- test/dummy/app/views/update_params/last_step.html.erb
+- test/dummy/app/views/update_params/second.html.erb
 - test/dummy/app/views/updates/_step_position.html.erb
 - test/dummy/app/views/updates/first.html.erb
 - test/dummy/app/views/updates/index.html.erb
@@ -200,6 +206,7 @@ files:
 - test/integration/redirect_to_next_test.rb
 - test/integration/security_test.rb
 - test/integration/steps_test.rb
+- test/integration/update_params_test.rb
 - test/integration/updates_test.rb
 - test/support/integration_case.rb
 - test/support/wicked_controller_test_case.rb
@@ -226,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Use Wicked to turn your controller into a wizard
@@ -246,6 +253,7 @@ test_files:
 - test/dummy/app/controllers/redirect_to_next_controller.rb
 - test/dummy/app/controllers/step_positions_controller.rb
 - test/dummy/app/controllers/string_steps_controller.rb
+- test/dummy/app/controllers/update_params_controller.rb
 - test/dummy/app/controllers/updates_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/bar.rb
@@ -275,6 +283,11 @@ test_files:
 - test/dummy/app/views/step_positions/last_step.html.erb
 - test/dummy/app/views/step_positions/second.html.erb
 - test/dummy/app/views/string_steps/second.html.erb
+- test/dummy/app/views/update_params/_step_position.html.erb
+- test/dummy/app/views/update_params/first.html.erb
+- test/dummy/app/views/update_params/index.html.erb
+- test/dummy/app/views/update_params/last_step.html.erb
+- test/dummy/app/views/update_params/second.html.erb
 - test/dummy/app/views/updates/_step_position.html.erb
 - test/dummy/app/views/updates/first.html.erb
 - test/dummy/app/views/updates/index.html.erb
@@ -318,6 +331,7 @@ test_files:
 - test/integration/redirect_to_next_test.rb
 - test/integration/security_test.rb
 - test/integration/steps_test.rb
+- test/integration/update_params_test.rb
 - test/integration/updates_test.rb
 - test/support/integration_case.rb
 - test/support/wicked_controller_test_case.rb