wicked 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.1.0 (3/11/2012)
+
+* Allow including `Wicked::Wizard` into controllers
+* Added Tests for Helpers
+
+## 0.0.2
+
+* Fixed url bug
+
+## 0.0.1
+
+* First Release

data/Gemfile

@@ -6,11 +6,12 @@ gem "rails"         , ">= 3.0.7"
 
 
 group :development do
-  gem 'jeweler', "~> 1.6.4"
-  gem "bundler", "~> 1.0.0"
-  gem "rcov", ">= 0"
+  gem 'jeweler',  "~> 1.6.4"
+  gem "bundler",  "~> 1.0.0"
+  gem "rcov",     ">= 0"
   gem "capybara", ">= 0.4.0"
   gem "sqlite3"
+  gem "launchy"
 end
 
 

data/Gemfile.lock

@@ -28,6 +28,7 @@ GEM
       activemodel (= 3.0.11)
       activesupport (= 3.0.11)
     activesupport (3.0.11)
+    addressable (2.2.7)
     arel (2.0.10)
     builder (2.1.2)
     capybara (1.1.2)
@@ -49,6 +50,8 @@ GEM
       git (>= 1.2.5)
       rake
     json (1.6.4)
+    launchy (2.0.5)
+      addressable (~> 2.2.6)
     mail (2.2.19)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
@@ -104,6 +107,7 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   capybara (>= 0.4.0)
   jeweler (~> 1.6.4)
+  launchy
   rails (>= 3.0.7)
   rcov
   sqlite3

data/README.md

@@ -1,39 +1,66 @@
 # Wicked
 
-Use wicked to make your Rails controllers into step-by-step wizards.
+Use wicked to make your Rails controllers into step-by-step wizards. To see Wicked in action check out the example [Rails app](https://github.com/schneems/wicked_example) or [watch the screencast](http://schneems.com/post/18437886598/wizard-ify-your-rails-controllers-with-wicked).
 
 ## 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.
+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.
 
 ## Install
 
 Add this to your Gemfile
 
 ```ruby
-
   gem 'wicked'
-
 ```
 
 Then run `bundle install` and you're ready to start
 
 ## How
 
-Simply inherit from Wicked::WizardController and you can specify a set of steps. Here we have a controller called Users::AfterSignupController with existing routes.
+We are going to build an 'after signup' wizard. First create a controller:
+
+```
+  rails g controller after_signup
+```
+
+Add Routes into `config/routes.rb`:
+
+```ruby
+  resources :after_signup
+```
+
+Next include `Wicked::Wizard` in your controller
+
+```ruby
+
+  class AfterSignupController < ApplicationController
+    include Wicked::Wizard
+
+    steps :confirm_password, :confirm_profile, :find_friends
+    # ...
+
+```
+
+You can also use the old way of inheriting from `Wicked::WizardController`.
 
 ```ruby
-  class Users::AfterSignupController < Wicked::WizardController
+
+  class AfterSignupController < Wicked::WizardController
 
     steps :confirm_password, :confirm_profile, :find_friends
     # ...
 
 ```
 
-The wizard is set to call steps in order in the show action, you can specify custom logic in your show using a case statement like this:
+The wizard is set to call steps in order in the show action, you can specify custom logic in your show using a case statement like below. To send someone to the first step in this wizard we can direct them to `after_signup_path(:confirm_password)`. 
 
 ```ruby
-  class Users::AfterSignupController < Wicked::WizardController
+  class AfterSignupController < ApplicationController
+    include Wicked::Wizard
+
+    steps :confirm_password, :confirm_profile, :find_friends
+
     def show
       @user = current_user
       case step
@@ -45,9 +72,9 @@ The wizard is set to call steps in order in the show action, you can specify cus
   end
 ```
 
-Note: you'll need to call `render_wizard` at the end of your action to get the correct views to show up.
+You'll need to call `render_wizard` at the end of your action to get the correct views to show up.
 
-By default the wizard will render a view with the same name as the step. So for our controller `Users::AfterSignupController` with a view path of `/views/users/after_signup/` if call the :confirm_password step, our wizard will render `/views/users/after_signup/confirm_password.html.erb`
+By default the wizard will render a view with the same name as the step. So for our controller `AfterSignupController` with a view path of `/views/users/after_signup/` if call the :confirm_password step, our wizard will render `/views/users/after_signup/confirm_password.html.erb`
 
 Then in your view you can use the helpers to get to the next step.
 
@@ -65,7 +92,10 @@ In addition to showing sequential views we can update elements in our controller
 
 
 ```ruby
-  class Users::AfterSignupController < Wicked::WizardController
+  class AfterSignupController < ApplicationController
+    include Wicked::Wizard
+
+    steps :confirm_password, :confirm_profile, :find_friends
 
     def update
       @user = current_user
@@ -79,7 +109,7 @@ In addition to showing sequential views we can update elements in our controller
   end
 ```
 
-Note we're passing `render_wizard` our `@user` object here. If you pass an object into `render_wizard` it will show the next step if the object saves or re-render the previous view if it does not save.
+We're passing `render_wizard` our `@user` object here. If you pass an object into `render_wizard` it will show the next step if the object saves or re-render the previous view if it does not save.
 
 
 To get to this update action, you simply need to submit a form that PUT's to the same url
@@ -95,7 +125,7 @@ To get to this update action, you simply need to submit a form that PUT's to the
 
 ```
 
-Note: we explicitly tell the form to PUT above
+We explicitly tell the form to PUT above. If you forget this, you will get a warning about the create action not existing, or no route found for POST. Don't forget this.
 
 
 In the controller if you find that you want to skip a step, you can do it simply by calling `skip_step`
@@ -117,6 +147,46 @@ In the controller if you find that you want to skip a step, you can do it simply
 
 ```
 
+Now you've got a fully functioning AfterSignup controller! If you have questions or if you struggled with something, let me know on [twitter](http://twitter.com/schneems), and i'll try to make it better or make the docs better.
+
+## Quick Reference
+
+View/URL Helpers
+
+```ruby
+
+  wizard_path                  # Grabs the current path in the wizard
+  wizard_path(:specific_step)  # Url of the :specific_step
+  next_wizard_path             # Url of the next step
+
+  # These only work while in a Wizard, and are not absolute paths
+  # You can have multiple wizards in a project with multiple `wizard_path` calls
+```
+
+
+Controller Tidbits:
+
+```ruby
+
+  steps  :first, :second       # Sets the order of steps
+  step                         # Gets symbol of current step
+  next_step                    # Gets symbol of next step
+  render_wizard                # Renders the current step
+  render_wizard(@user)         # Shows next_step if @user.save, otherwise renders current step
+```
+
+Finally:
+
+Don't forget to create your named views
+
+```
+  app/
+   views/
+    controller_name/
+      first.html.erb
+      second.html.erb
+      # ...
+```
 
 ## About
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/app/controllers/wicked/wizard_controller.rb

@@ -1,20 +1,40 @@
+module Wicked
+  module Wizard
+    extend ActiveSupport::Concern
+
+    # Include the modules!!
+    include Wicked::Controller::Concerns::Path
+    include Wicked::Controller::Concerns::RenderRedirect
+    include Wicked::Controller::Concerns::Steps
+
+    included do
+      # Give our Views helper methods!
+      helper_method :wizard_path, :next_wizard_path
+      # Set @step and @next_step variables
+      before_filter :setup_wizard
+    end
+
+    private
+    def setup_wizard
+      @step      = params[:id].try(:to_sym) || steps.first
+      @next_step = next_step(@step)
+    end
+    public
+  end
+end
+
+
+
 # Please don't re-use any patterns found in this controller,
 # they work, but are not very good practices.
 # If you have a better way to do this, please let me know
 
 class Wicked::WizardController < ApplicationController
-  include Wicked::Controller::Concerns::Path
-  include Wicked::Controller::Concerns::RenderRedirect
-  include Wicked::Controller::Concerns::Steps
-
-
-  helper_method :wizard_path, :next_wizard_path
+  include Wicked::Wizard
 
-  before_filter :setup_wizard
-
-  def index
-    # redirect_to_first_step
-  end
+  # def index
+  #   # redirect_to_first_step
+  # end
 
   # steps :confirm_password, :invite_fb
 
@@ -41,17 +61,5 @@ class Wicked::WizardController < ApplicationController
   #   sign_in(@user, :bypass => true) # needed for devise
   #   render_wizard
   # end
-
-  private
-
-
-  def setup_wizard
-    @step      = params[:id].try(:to_sym) || steps.first
-    @next_step = next_step(@step)
-  end
-
 end
 
-module Wicked
-  Wizard = Wicked::WizardController
-end

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

@@ -0,0 +1,14 @@
+## This controller uses includes
+
+class BarController < ApplicationController
+  include Wicked::Wizard
+  steps :first, :second, :last_step
+
+  def show
+    skip_step if params[:skip_step]
+    render_wizard
+  end
+
+  def update
+  end
+end

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

@@ -1,3 +1,5 @@
+## This controller uses inheritance
+
 class FooController < Wicked::WizardController
   steps :first, :second, :last_step
 

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

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

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

@@ -0,0 +1 @@
+last_step

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

@@ -0,0 +1 @@
+second

data/test/dummy/config/routes.rb

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

data/test/integration/helpers_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class HelpersTest < ActiveSupport::IntegrationCase
+
+  test 'next_wizard_path' do
+    step = :first
+    visit(bar_path(step))
+    click_link 'skip'
+    assert has_content?(:third)
+  end
+
+  test 'wizard_path' do
+    step = :first
+    visit(bar_path(step))
+    click_link 'current'
+    assert has_content?(step)
+  end
+
+  test 'wizard_path with symbol arg' do
+    step = :first
+    visit(bar_path(step))
+    click_link 'last'
+    assert has_content?(:last_step)
+  end
+
+end

data/test/integration/navigation_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class NavigationTest < ActiveSupport::IntegrationCase
+class InheritNavigationTest < ActiveSupport::IntegrationCase
 
   test 'show first' do
     step = :first
@@ -34,3 +34,39 @@ class NavigationTest < ActiveSupport::IntegrationCase
   end
 
 end
+
+
+class IncludeNavigationTest < ActiveSupport::IntegrationCase
+
+  test 'show first' do
+    step = :first
+    visit(bar_path(step))
+    assert has_content?(step)
+  end
+
+  test 'show second' do
+    step = :second
+    visit(bar_path(step))
+    assert has_content?(step)
+  end
+
+  test 'skip first' do
+    step = :first
+    visit(bar_path(step, :skip_step => 'true'))
+    assert has_content?(:second)
+  end
+
+  test 'invalid step' do
+    step = :notastep
+    assert_raise(ActionView::MissingTemplate) do
+      visit(bar_path(step))
+    end
+  end
+
+  test 'finish' do
+    step = :finish
+    visit(bar_path(step))
+    assert has_content?('home')
+  end
+
+end

data/test/support/integration_case.rb

@@ -1,5 +1,5 @@
 # Define a bare test case to use with Capybara
 class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
-  include Capybara
+  include Capybara::DSL
   include Rails.application.routes.url_helpers
 end

data/wicked.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wicked"
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["schneems"]
-  s.date = "2012-02-23"
+  s.date = "2012-03-12"
   s.description = "Wicked is a Rails engine for producing easy wizard controllers"
   s.email = "richard.schneeman@gmail.com"
   s.extra_rdoc_files = [
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".rvmrc",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "MIT-LICENSE",
@@ -31,8 +32,12 @@ Gem::Specification.new do |s|
     "lib/wicked/engine.rb",
     "test/dummy/Rakefile",
     "test/dummy/app/controllers/application_controller.rb",
+    "test/dummy/app/controllers/bar_controller.rb",
     "test/dummy/app/controllers/foo_controller.rb",
     "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/views/bar/first.html.erb",
+    "test/dummy/app/views/bar/last_step.html.erb",
+    "test/dummy/app/views/bar/second.html.erb",
     "test/dummy/app/views/foo/first.html.erb",
     "test/dummy/app/views/foo/last_step.html.erb",
     "test/dummy/app/views/foo/second.html.erb",
@@ -65,6 +70,7 @@ Gem::Specification.new do |s|
     "test/dummy/public/javascripts/rails.js",
     "test/dummy/public/stylesheets/.gitkeep",
     "test/dummy/script/rails",
+    "test/integration/helpers_test.rb",
     "test/integration/navigation_test.rb",
     "test/support/integration_case.rb",
     "test/test_helper.rb",
@@ -88,6 +94,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<capybara>, [">= 0.4.0"])
       s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<launchy>, [">= 0"])
     else
       s.add_dependency(%q<activesupport>, [">= 3.0.7"])
       s.add_dependency(%q<rails>, [">= 3.0.7"])
@@ -96,6 +103,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<capybara>, [">= 0.4.0"])
       s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<launchy>, [">= 0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 3.0.7"])
@@ -105,6 +113,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<capybara>, [">= 0.4.0"])
     s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<launchy>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wicked
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000Z
+date: 2012-03-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70154437447840 !ruby/object:Gem::Requirement
+  requirement: &70095570564240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70154437447840
+  version_requirements: *70095570564240
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70154437447360 !ruby/object:Gem::Requirement
+  requirement: &70095570563680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70154437447360
+  version_requirements: *70095570563680
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70154437464020 !ruby/object:Gem::Requirement
+  requirement: &70095570563180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70154437464020
+  version_requirements: *70095570563180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70154437463540 !ruby/object:Gem::Requirement
+  requirement: &70095570562640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70154437463540
+  version_requirements: *70095570562640
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70154437463060 !ruby/object:Gem::Requirement
+  requirement: &70095570562160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70154437463060
+  version_requirements: *70095570562160
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70154437462580 !ruby/object:Gem::Requirement
+  requirement: &70095570561660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *70154437462580
+  version_requirements: *70095570561660
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70154437462100 !ruby/object:Gem::Requirement
+  requirement: &70095570561180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70154437462100
+  version_requirements: *70095570561180
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: &70095570560700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095570560700
 description: Wicked is a Rails engine for producing easy wizard controllers
 email: richard.schneeman@gmail.com
 executables: []
@@ -96,6 +107,7 @@ extra_rdoc_files:
 - README.md
 files:
 - .rvmrc
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -110,8 +122,12 @@ files:
 - lib/wicked/engine.rb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/bar_controller.rb
 - test/dummy/app/controllers/foo_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/views/bar/first.html.erb
+- test/dummy/app/views/bar/last_step.html.erb
+- test/dummy/app/views/bar/second.html.erb
 - test/dummy/app/views/foo/first.html.erb
 - test/dummy/app/views/foo/last_step.html.erb
 - test/dummy/app/views/foo/second.html.erb
@@ -144,6 +160,7 @@ files:
 - test/dummy/public/javascripts/rails.js
 - test/dummy/public/stylesheets/.gitkeep
 - test/dummy/script/rails
+- test/integration/helpers_test.rb
 - test/integration/navigation_test.rb
 - test/support/integration_case.rb
 - test/test_helper.rb
@@ -164,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1786234786228155746
+      hash: -426714060281947248
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: