wicked 0.5.0 → 0.6.0

data/CHANGELOG.md

@@ -1,5 +1,24 @@
+## 0.6.0 (03/20/2013)
+
+* Breaking change: hardcoded internal `finish` keyword changed to
+`wicked_finish`. Can be modified by setting `Wicked::FINISH_STEP`.
+Please use constants from now on instead of relying on the values of the
+strings.
+* [#56] raise error while using reserved keyword
+* Keywords are now configurable as constants `Wicked::FIRST_STEP`,
+`Wicked::LAST_STEP`, and `Wicked::FINISH_STEP`
+
+## 0.5.0 (01/27/2013)
+* [#51] bug fix: while using translations all wizard helpers now return values
+in the same language (in whatever locale is being used). So if a user is
+requesting a controller action in spanish, then `step` will be in
+spanish and all the values inside of `steps` and `next_step` etc. will
+be in spanish. To convert one of these values to a "canonical" wizard
+value (that matches the names of your files) you can use
+`wizard_value(step)` method.
+
 ## 0.4.0
-* User imputs no longer converted to symbol this mitigates risk of DoS
+* User inputs no longer converted to symbol this mitigates risk of DoS
 via symbol table or RAM (symbols are not garbage collected).
 
 ## 0.3.4

data/README.md

@@ -373,6 +373,26 @@ end
 
 Note: Do not pass user submitted params directly into `self.steps` while using the custom or translated urls. The translator calls `to_sym` on steps provided, and if a user is allowed to submit arbitrary symbols, they could flood the take down your production app by filling up the symbol table. So, just don't do it.
 
+## Keywords
+
+There are a few "magical" keywords that will take you to the first step,
+the last step, or the "final" action (the redirect that happens after
+the last step). Prior to version 0.6.0 these were hardcoded strings. Now
+they are constants which means you can access them or change them. They
+are:
+
+```ruby
+Wicked::FIRST_STEP
+Wicked::LAST_STEP
+Wicked::FINISH_STEP
+```
+
+You can build links using these constants
+`after_signup_path(Wicked::LAST_STEP)` which will redirect the user to
+the first step you've specified. This might be useful for redirecting a
+user to a step when you're not already in a Wicked controller. If you
+change the step names, they are expected to be strings (not symbols).
+
 ## 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.5.0
+0.6.0

data/lib/wicked.rb

@@ -1,4 +1,8 @@
 module Wicked
+  FINISH_STEP = "wicked_finish"
+  FIRST_STEP  = "wicked_first"
+  LAST_STEP   = "wicked_last"
+
   module Controller
     module Concerns
     end
@@ -7,9 +11,13 @@ module Wicked
   end
 end
 
+class WickedError < StandardError; end
+class WickedProtectedStepError < WickedError; end
+
 require 'wicked/controller/concerns/render_redirect'
 require 'wicked/controller/concerns/steps'
 require 'wicked/controller/concerns/path'
 require 'wicked/wizard'
 require 'wicked/wizard/translated'
-require 'wicked/engine'
+require 'wicked/engine'
+

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

@@ -28,3 +28,4 @@ module Wicked::Controller::Concerns::Path
     url_for(options)
   end
 end
+

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

@@ -23,7 +23,7 @@ module Wicked::Controller::Concerns::RenderRedirect
   end
 
   def render_step(the_step, options = {})
-    if the_step.nil? || the_step.to_s == 'finish'
+    if the_step.nil? || the_step.to_s == Wicked::FINISH_STEP
       redirect_to_finish_wizard options
     else
       render the_step, options
@@ -46,5 +46,5 @@ module Wicked::Controller::Concerns::RenderRedirect
   def redirect_to_finish_wizard(options = nil)
     redirect_to finish_wizard_path, options
   end
-
 end
+

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

@@ -1,4 +1,6 @@
 module Wicked::Controller::Concerns::Steps
+  PROTECTED_STEPS = [Wicked::FINISH_STEP, Wicked::FIRST_STEP, Wicked::LAST_STEP]
+
   extend ActiveSupport::Concern
 
   def jump_to(goto_step)
@@ -47,10 +49,19 @@ module Wicked::Controller::Concerns::Steps
     def steps(*args)
       options = args.extract_options!
       steps   = args
+      check_protected!(steps)
       prepend_before_filter(options) do
         self.steps = steps
       end
     end
+
+    def check_protected!(wizard_steps)
+      string_steps = wizard_steps.map(&:to_s)
+      if protected_step = PROTECTED_STEPS.detect { |protected| string_steps.include?(protected) }
+        msg = "Protected step detected: '#{protected_step}' is used internally by Wicked please rename your step"
+        raise WickedProtectedStepError, msg
+      end
+    end
   end
 
   def steps=(wizard_steps)
@@ -76,7 +87,7 @@ module Wicked::Controller::Concerns::Steps
     return @next_step if current_step.nil?
     index = steps.index(current_step)
     step  = steps.at(index + 1) if index.present?
-    step  ||= :finish
+    step  ||= Wicked::FINISH_STEP
     step
   end
 
@@ -94,6 +105,5 @@ module Wicked::Controller::Concerns::Steps
     return false if current_step_index.nil? || steps.index(step_name).nil?
     return true
   end
-
-
 end
+

data/lib/wicked/wizard.rb

@@ -34,8 +34,8 @@ module Wicked
     end
 
     def check_redirect_to_first_last!(step)
-      redirect_to wizard_path(steps.first) if step.to_s == 'wizard_first'
-      redirect_to wizard_path(steps.last)  if step.to_s == 'wizard_last'
+      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)

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

@@ -6,6 +6,7 @@ class BarController < ApplicationController
 
   def show
     skip_step if params[:skip_step]
+    flash[:notice] = params[:notice] if params[:notice]
     render_wizard
   end
 

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

@@ -0,0 +1,11 @@
+class StringStepsController < ApplicationController
+  include Wicked::Wizard
+  steps 'first', 'second', 'last_step'
+
+  def show
+    render_wizard
+  end
+
+  def update
+  end
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -8,6 +8,8 @@
 </head>
 <body>
 
+<%= flash.map {|level, msg| "#{level}:#{msg}"}.join("<br />").html_safe %>
+
 <%= yield %>
 
 </body>

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

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

data/test/dummy/config/routes.rb

@@ -4,6 +4,7 @@ Dummy::Application.routes.draw do
   resources :jump
   resources :step_positions
   resources :dynamic_steps
+  resources :string_steps
 
   resources :nested do
     resources :builder, :controller => 'nested/builder'

data/test/integration/navigation_test.rb

@@ -30,12 +30,12 @@ class IncludeNavigationTest < ActiveSupport::IntegrationCase
   end
 
   test 'pointer to first' do
-    visit(bar_path(:wizard_first))
+    visit(bar_path(Wicked::FIRST_STEP))
     assert has_content?('first')
   end
 
   test 'pointer to last' do
-    visit(bar_path(:wizard_last))
+    visit(bar_path(Wicked::LAST_STEP))
     assert has_content?('last_step')
   end
 
@@ -47,10 +47,17 @@ class IncludeNavigationTest < ActiveSupport::IntegrationCase
   end
 
   test 'finish' do
-    step = :finish
+    step = Wicked::FINISH_STEP
     visit(bar_path(step))
     assert has_content?('home')
   end
+
+  test 'finish with flash' do
+    step = Wicked::FINISH_STEP
+    visit bar_path(step, :notice => 'yo')
+    assert has_content?('home')
+    assert has_content?('notice:yo')
+  end
 end
 
 

data/test/integration/steps_test.rb

@@ -23,6 +23,14 @@ class StepPositionsTest < ActiveSupport::IntegrationCase
     assert has_content?('last_step step is the next step')  # next_step?
   end
 
+  test 'string-based steps' do
+    visit(string_step_path('second'))
+    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?

data/test/wicked_test.rb

@@ -4,4 +4,15 @@ class WickedTest < ActiveSupport::TestCase
   test "truth" do
     assert_kind_of Module, Wicked
   end
+
+  test "protected steps" do
+    error = assert_raise WickedProtectedStepError do
+      class ProtectedBadStepsController < ApplicationController
+        include Wicked::Wizard
+
+        steps :whatever, Wicked::FINISH_STEP
+      end
+    end
+    assert_equal "Protected step detected: '#{Wicked::FINISH_STEP}' is used internally by Wicked please rename your step", error.message
+  end
 end

data/wicked.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wicked"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["schneems"]
-  s.date = "2013-01-27"
+  s.date = "2013-03-20"
   s.description = "Wicked is a Rails engine for producing easy wizard controllers"
   s.email = "richard.schneeman@gmail.com"
   s.extra_rdoc_files = [
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
     "test/dummy/app/controllers/nested/builder_controller.rb",
     "test/dummy/app/controllers/pages_controller.rb",
     "test/dummy/app/controllers/steps_controller.rb",
+    "test/dummy/app/controllers/string_steps_controller.rb",
     "test/dummy/app/helpers/application_helper.rb",
     "test/dummy/app/models/bar.rb",
     "test/dummy/app/views/bar/first.html.erb",
@@ -63,6 +64,7 @@ Gem::Specification.new do |s|
     "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/app/views/string_steps/second.html.erb",
     "test/dummy/config.ru",
     "test/dummy/config/application.rb",
     "test/dummy/config/boot.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wicked
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000Z
+date: 2013-03-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70274032800580 !ruby/object:Gem::Requirement
+  requirement: &70158799315740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70274032800580
+  version_requirements: *70158799315740
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70274032799480 !ruby/object:Gem::Requirement
+  requirement: &70158799315260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70274032799480
+  version_requirements: *70158799315260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70274032798600 !ruby/object:Gem::Requirement
+  requirement: &70158799314780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274032798600
+  version_requirements: *70158799314780
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70274032797260 !ruby/object:Gem::Requirement
+  requirement: &70158799314300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70274032797260
+  version_requirements: *70158799314300
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70274032795260 !ruby/object:Gem::Requirement
+  requirement: &70158799313820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274032795260
+  version_requirements: *70158799313820
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70274032793220 !ruby/object:Gem::Requirement
+  requirement: &70158799313340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *70274032793220
+  version_requirements: *70158799313340
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &70274032791980 !ruby/object:Gem::Requirement
+  requirement: &70158799312860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274032791980
+  version_requirements: *70158799312860
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70274032790300 !ruby/object:Gem::Requirement
+  requirement: &70158799312380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274032790300
+  version_requirements: *70158799312380
 - !ruby/object:Gem::Dependency
   name: activerecord-jdbcsqlite3-adapter
-  requirement: &70274032789360 !ruby/object:Gem::Requirement
+  requirement: &70158799311900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274032789360
+  version_requirements: *70158799311900
 description: Wicked is a Rails engine for producing easy wizard controllers
 email: richard.schneeman@gmail.com
 executables: []
@@ -143,6 +143,7 @@ files:
 - test/dummy/app/controllers/nested/builder_controller.rb
 - test/dummy/app/controllers/pages_controller.rb
 - test/dummy/app/controllers/steps_controller.rb
+- test/dummy/app/controllers/string_steps_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/bar.rb
 - test/dummy/app/views/bar/first.html.erb
@@ -164,6 +165,7 @@ files:
 - 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/app/views/string_steps/second.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
@@ -218,7 +220,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3061735520943754362
+      hash: 2973292026559247990
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: