wicked 0.1.6 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.0 (07/27/2012)
+
+* Make step configuration an instance level config instead of class.
+* [#25] current_step?, past_step?, future_step?, next_step? & previous_step? step helper methods to be used in the view(thanks @ahorner)
+# [#28] accept options to `render_wizard` (@nata79)
+
 ## 0.1.6 (06/02/2012)
 
 * remove `WizardController#_reset_invocation_response`

data/README.md

@@ -6,7 +6,7 @@ Use wicked to make your Rails controllers into step-by-step wizards. To see Wick
 
 ## Why
 
-Many times I'm left wanting a RESTful way to display a step by step process that may or not be associated with a resource. Wicked gives the flexibility to do what I want while hiding all the really scary stuff you shouldn't do in a controller to make this possible. At it's core Wicked is a RESTful(ish) state machine, but you don't need to know that, just use it.
+Many times I'm left wanting a RESTful way to display a step by step process that may or not be associated with a resource. Wicked gives the flexibility to do what I want while hiding all the really nasty stuff you shouldn't do in a controller to make this possible. At it's core Wicked is a RESTful(ish) state machine, but you don't need to know that, just use it.
 
 ## Install
 
@@ -20,7 +20,7 @@ Then run `bundle install` and you're ready to start
 
 ## Quicklinks
 
-* Deal with validation in a Wizard using [Partial Validation of Active Record Objects](https://github.com/schneems/wicked/wiki/Partial-Validation-of-Active-Record-Objects)
+* Build an object step-by-step using [Partial Validation of Active Record Objects](https://github.com/schneems/wicked/wiki/Partial-Validation-of-Active-Record-Objects)
 * [Show Current Wizard Progress to User](https://github.com/schneems/wicked/wiki/Show-Current-Wizard-Progress-to-User)
 * [Example App](https://github.com/schneems/wicked_example)
 * [Screencast](http://schneems.com/post/18437886598/wizard-ify-your-rails-controllers-with-wicked)
@@ -180,7 +180,6 @@ View/URL Helpers
 Controller Tidbits:
 
 ```ruby
-
   steps  :first, :second       # Sets the order of steps
   step                         # Gets symbol of current step
   next_step                    # Gets symbol of next step
@@ -189,16 +188,6 @@ Controller Tidbits:
   render_wizard(@user)         # Shows next_step if @user.save, otherwise renders current step
 ```
 
-Testing with RSpec
-
-```ruby
-  # Test find_friends block of show action
-  get :show, :id => :find_friends
-
-  # Test find_friends block of update action
-  put :update, {'id' => 'find_friends', "user" => {"id"=>@user.id.to_s}}
-
-```
 
 Finally:
 
@@ -213,6 +202,31 @@ Don't forget to create your named views
       # ...
 ```
 
+
+# Finish Wizard Path
+
+You can specify the url that your user goes to by over-riding the `finish_wizard_path` in your wizard controller.
+
+
+```
+  def finish_wizard_path
+    user_path(current_user)
+  end
+```
+
+
+Testing with RSpec
+
+```ruby
+  # Test find_friends block of show action
+  get :show, :id => :find_friends
+
+  # Test find_friends block of update action
+  put :update, {'id' => 'find_friends', "user" => { "id" => @user.id.to_s }}
+```
+
+
+
 ## About
 
 Please poke around the source code, if you see easier ways to get a Rails controller do do what I want, let me know.

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.2.0

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

@@ -2,13 +2,13 @@ module Wicked::Controller::Concerns::RenderRedirect
   extend ActiveSupport::Concern
 
 
-  def render_wizard(resource = nil)
+  def render_wizard(resource = nil, options = {})
     process_resource!(resource)
 
     if @skip_to
-      redirect_to wizard_path @skip_to
+      redirect_to wizard_path(@skip_to), options
     else
-      render_step @step
+      render_step @step, options
     end
   end
 
@@ -22,11 +22,11 @@ module Wicked::Controller::Concerns::RenderRedirect
     end
   end
 
-  def render_step(the_step)
+  def render_step(the_step, options = {})
     if the_step.nil? || the_step == :finish
-      redirect_to_finish_wizard
+      redirect_to_finish_wizard options
     else
-      render the_step
+      render the_step, options
     end
   end
 
@@ -43,8 +43,8 @@ module Wicked::Controller::Concerns::RenderRedirect
     '/'
   end
 
-  def redirect_to_finish_wizard
-    redirect_to finish_wizard_path
+  def redirect_to_finish_wizard(options = nil)
+    redirect_to finish_wizard_path, options
   end
 
 end

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

@@ -13,19 +13,52 @@ module Wicked::Controller::Concerns::Steps
     @step
   end
 
+  # will return true if step passed in is the currently rendered step
+  def current_step?(step_name)
+    return false if step_name.nil? || step.nil?
+    step == step_name
+  end
+
+  # will return true if the step passed in has already been executed by the wizard
+  def past_step?(step_name)
+    return false if steps.index(step).nil? || steps.index(step_name).nil?
+    steps.index(step) > steps.index(step_name)
+  end
+
+  # will return true if the step passed in has already been executed by the wizard
+  def future_step?(step_name)
+    return false if steps.index(step).nil? || steps.index(step_name).nil?
+    steps.index(step) < steps.index(step_name)
+  end
+
+  # will return true if the last step is the step passed in
+  def previous_step?(step_name)
+    return false if steps.index(step).nil? || steps.index(step_name).nil?
+    steps.index(step) - 1  == steps.index(step_name)
+  end
+
+  # will return true if the next step is the step passed in
+  def next_step?(step_name)
+    return false if steps.index(step).nil? || steps.index(step_name).nil?
+    steps.index(step) + 1  == steps.index(step_name)
+  end
+
   module ClassMethods
-    def steps=(steps)
-      @wizard_steps = steps
+    def steps(*args)
+      options = args.last.is_a?(Hash) ? callbacks.pop : {}
+      steps   = args
+      prepend_before_filter(options) do
+        self.steps = steps
+      end
     end
+  end
 
-    def steps(*steps_to_set)
-      @wizard_steps = steps_to_set unless steps_to_set.blank?
-      @wizard_steps
-    end
+  def steps=(wizard_steps)
+    @wizard_steps = wizard_steps
   end
 
   def steps
-    self.class.steps
+    @wizard_steps
   end
   alias :wizard_steps :steps
   alias :steps_list   :steps

data/lib/wicked/wizard.rb

@@ -9,7 +9,10 @@ module Wicked
 
     included do
       # Give our Views helper methods!
-      helper_method :wizard_path, :next_wizard_path, :previous_wizard_path, :step, :wizard_steps
+      helper_method :wizard_path,     :next_wizard_path, :previous_wizard_path,
+                    :step,            :wizard_steps,     :current_step?,
+                    :past_step?,      :future_step?,     :previous_step?,
+                    :next_step?
       # Set @step and @next_step variables
       before_filter :setup_wizard
     end

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

@@ -0,0 +1,13 @@
+## This controller uses includes
+
+class StepPositionsController < ApplicationController
+  include Wicked::Wizard
+  steps :first, :second, :last_step
+
+  def show
+    render_wizard
+  end
+
+  def update
+  end
+end

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

@@ -1,6 +1,5 @@
 first
 
-
 <%= link_to 'last', wizard_path(:last_step) %>
 <%= link_to 'current', wizard_path %>
 <%= link_to 'skip', next_wizard_path %>

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

@@ -0,0 +1,9 @@
+<% wizard_steps.each do |s| %>
+  <p>
+    <%= "#{s} step is the current step"    if current_step?(s)  %><br />
+    <%= "#{s} step is a past step"         if past_step?(s) %><br />
+    <%= "#{s} step is a future step"       if future_step?(s)   %><br />
+    <%= "#{s} step was the previous step"  if previous_step?(s)     %><br />
+    <%= "#{s} step is the next step"       if next_step?(s)     %><br />
+  </p>
+<% end %>

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

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

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

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

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

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

data/test/dummy/config/routes.rb

@@ -2,6 +2,7 @@ Dummy::Application.routes.draw do
   resources :foo
   resources :bar
   resources :jump
+  resources :step_positions
 
   # The priority is based upon order of creation:
   # first created -> highest priority.

data/test/integration/steps_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class StepPositionsTest < ActiveSupport::IntegrationCase
+
+  test 'on first' do
+    step = :first
+    visit(step_position_path(step))
+    assert has_content?('first step is the current step')   # current_step?
+    assert true                                             # past_step?
+    assert has_content?('last_step step is a future step')  # future_step?
+    assert has_content?('second step is a future step')     # future_step?
+    assert true                                             # previous_step?
+    assert has_content?('second step is the next step')     # next_step?
+  end
+
+  test 'on second' do
+    step = :second
+    visit(step_position_path(step))
+    assert has_content?('second step is the current step')  # current_step?
+    assert has_content?('first step is a past step')        # past_step?
+    assert has_content?('last_step step is a future step')  # future_step?
+    assert has_content?('first step was the previous step') # previous_step?
+    assert has_content?('last_step step is the next step')  # next_step?
+  end
+
+end
+
+  # current_step?
+  # past_step?
+  # future_step?
+  # previous_step?
+  # next_step?

data/wicked.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wicked"
-  s.version = "0.1.6"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["schneems"]
-  s.date = "2012-06-02"
+  s.date = "2012-07-27"
   s.description = "Wicked is a Rails engine for producing easy wizard controllers"
   s.email = "richard.schneeman@gmail.com"
   s.extra_rdoc_files = [
@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
     "test/dummy/app/controllers/bar_controller.rb",
     "test/dummy/app/controllers/foo_controller.rb",
     "test/dummy/app/controllers/jump_controller.rb",
+    "test/dummy/app/controllers/steps_controller.rb",
     "test/dummy/app/helpers/application_helper.rb",
     "test/dummy/app/models/bar.rb",
     "test/dummy/app/views/bar/first.html.erb",
@@ -49,6 +50,10 @@ Gem::Specification.new do |s|
     "test/dummy/app/views/jump/last_step.html.erb",
     "test/dummy/app/views/jump/second.html.erb",
     "test/dummy/app/views/layouts/application.html.erb",
+    "test/dummy/app/views/step_positions/_step_position.html.erb",
+    "test/dummy/app/views/step_positions/first.html.erb",
+    "test/dummy/app/views/step_positions/last_step.html.erb",
+    "test/dummy/app/views/step_positions/second.html.erb",
     "test/dummy/config.ru",
     "test/dummy/config/application.rb",
     "test/dummy/config/boot.rb",
@@ -80,6 +85,7 @@ Gem::Specification.new do |s|
     "test/integration/helpers_test.rb",
     "test/integration/jump_test.rb",
     "test/integration/navigation_test.rb",
+    "test/integration/steps_test.rb",
     "test/support/integration_case.rb",
     "test/test_helper.rb",
     "test/wicked_test.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wicked
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-02 00:00:00.000000000Z
+date: 2012-07-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70351864816900 !ruby/object:Gem::Requirement
+  requirement: &70254091223080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70351864816900
+  version_requirements: *70254091223080
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70351864816420 !ruby/object:Gem::Requirement
+  requirement: &70254091222500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70351864816420
+  version_requirements: *70254091222500
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70351864815860 !ruby/object:Gem::Requirement
+  requirement: &70254091221900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70351864815860
+  version_requirements: *70254091221900
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70351864815340 !ruby/object:Gem::Requirement
+  requirement: &70254091221420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70351864815340
+  version_requirements: *70254091221420
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70351864814820 !ruby/object:Gem::Requirement
+  requirement: &70254091139260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70351864814820
+  version_requirements: *70254091139260
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70351864814340 !ruby/object:Gem::Requirement
+  requirement: &70254091138740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *70351864814340
+  version_requirements: *70254091138740
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70351864813820 !ruby/object:Gem::Requirement
+  requirement: &70254091138220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70351864813820
+  version_requirements: *70254091138220
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &70351864813300 !ruby/object:Gem::Requirement
+  requirement: &70254091137620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70351864813300
+  version_requirements: *70254091137620
 description: Wicked is a Rails engine for producing easy wizard controllers
 email: richard.schneeman@gmail.com
 executables: []
@@ -127,6 +127,7 @@ files:
 - test/dummy/app/controllers/bar_controller.rb
 - test/dummy/app/controllers/foo_controller.rb
 - test/dummy/app/controllers/jump_controller.rb
+- test/dummy/app/controllers/steps_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/bar.rb
 - test/dummy/app/views/bar/first.html.erb
@@ -139,6 +140,10 @@ files:
 - test/dummy/app/views/jump/last_step.html.erb
 - test/dummy/app/views/jump/second.html.erb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/step_positions/_step_position.html.erb
+- test/dummy/app/views/step_positions/first.html.erb
+- test/dummy/app/views/step_positions/last_step.html.erb
+- test/dummy/app/views/step_positions/second.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
@@ -170,6 +175,7 @@ files:
 - test/integration/helpers_test.rb
 - test/integration/jump_test.rb
 - test/integration/navigation_test.rb
+- test/integration/steps_test.rb
 - test/support/integration_case.rb
 - test/test_helper.rb
 - test/wicked_test.rb
@@ -189,7 +195,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1992748704531741576
+      hash: 3200335910919771555
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: