wicked 0.0.1

data/.rvmrc

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+ruby_string="ruby-1.9.2-p290"
+gemset_name="wicked"
+
+if rvm list strings | grep -q "${ruby_string}" ; then
+
+  rvm use "${ruby_string}@${gemset_name}" --create
+
+  # Complain if bundler isn't installed
+  if [[ -z "`gem which bundler 2>&1 | grep -v ERROR`" ]]; then
+    echo "You need bundler:"
+    echo ""
+    echo "    gem install bundler"
+    echo ""
+  fi
+else
+  echo "${ruby_string} was not found, please run 'rvm install ${ruby_string}' and then cd back into the project directory."
+fi

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+
+gem "activesupport" , ">= 3.0.7"
+gem "rails"         , ">= 3.0.7"
+
+
+
+group :development do
+  gem 'jeweler', "~> 1.6.4"
+  gem "bundler", "~> 1.0.0"
+  gem "rcov", ">= 0"
+  gem "capybara", ">= 0.4.0"
+  gem "sqlite3"
+end
+
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/Gemfile.lock

@@ -0,0 +1,109 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.11)
+      actionpack (= 3.0.11)
+      mail (~> 2.2.19)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+    activesupport (3.0.11)
+    arel (2.0.10)
+    builder (2.1.2)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.2.4)
+      ffi (~> 1.0.6)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (1.0.11)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.4)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    nokogiri (1.5.0)
+    polyglot (0.3.3)
+    rack (1.2.4)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.11)
+      actionmailer (= 3.0.11)
+      actionpack (= 3.0.11)
+      activerecord (= 3.0.11)
+      activeresource (= 3.0.11)
+      activesupport (= 3.0.11)
+      bundler (~> 1.0)
+      railties (= 3.0.11)
+    railties (3.0.11)
+      actionpack (= 3.0.11)
+      activesupport (= 3.0.11)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.12)
+      json (~> 1.4)
+    rubyzip (0.9.5)
+    selenium-webdriver (2.15.0)
+      childprocess (>= 0.2.1)
+      ffi (~> 1.0.9)
+      multi_json (~> 1.0.4)
+      rubyzip
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.7)
+  bundler (~> 1.0.0)
+  capybara (>= 0.4.0)
+  jeweler (~> 1.6.4)
+  rails (>= 3.0.7)
+  rcov
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# Wicked
+
+Use wicked to make your Rails controllers into step-by-step wizards.
+
+## 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.
+
+## Install
+
+Wicked is still in development, and I haven't cut a gem yet, in the mean time you can add this to your Gemfile
+
+```ruby
+
+  gem 'wicked', :git => 'git://github.com/schneems/wicked.git'
+
+```
+
+
+## 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.
+
+```ruby
+  class Users::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:
+
+```ruby
+  class Users::AfterSignupController < Wicked::WizardController
+    def show
+      @user = current_user
+      case step
+      when :find_friends
+        @friends = @user.find_friends
+      end
+      render_wizard
+    end
+  end
+```
+
+Note: 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`
+
+Then in your view you can use the helpers to get to the next step.
+
+```ruby
+   <%= link_to 'skip', next_wizard_path %>
+```
+
+You can manually specify which wizard action you want to link to by using the wizard_path helper.
+
+```ruby
+   <%= link_to 'skip', wizard_path(:find_friends) %>
+```
+
+In addition to showing sequential views we can update elements in our controller.
+
+
+```ruby
+  class Users::AfterSignupController < Wicked::WizardController
+
+    def update
+      @user = current_user
+      case step
+      when :confirm_password
+        @user.update_attributes(params[:user])
+      end
+      sign_in(@user, :bypass => true) # needed for devise
+      render_wizard @user
+    end
+  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.
+
+
+To get to this update action, you simply need to submit a form that PUT's to the same url
+
+```ruby
+
+    <%= form_for @user, :url => wizard_path, :method => :put do |f| %>
+      <%=  f.password_field :password  %>
+      <%=  f.password_field :password_confirmation  %>
+
+      <%= f.submit "Change Password" %>
+    <% end %>
+
+```
+
+Note: we explicitly tell the form to PUT above
+
+
+In the controller if you find that you want to skip a step, you can do it simply by calling `skip_step`
+
+```ruby
+
+  def show
+    @user = current_user
+    case step
+    when :find_friends
+      if @user.has_facebook_access_token?
+        @friends = @user.find_friends
+      else
+        skip_step
+      end
+    end
+    render_wizard
+  end
+
+```
+
+
+## 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.
+
+If you have a question file an issue or, find me on the Twitters [@schneems](http://twitter.com/schneems).
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'rdoc/task'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Wicked'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name        = "wicked"
+  gem.homepage    = "http://github.com/schneems/wicked"
+  gem.license     = "MIT"
+  gem.summary     = %Q{Use Wicked to turn your controller into a wizard}
+  gem.description = %Q{Wicked is a Rails engine for producing easy wizard controllers}
+  gem.email       = "richard.schneeman@gmail.com"
+  gem.authors     = ["schneems"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/controllers/wicked/wizard_controller.rb

@@ -0,0 +1,57 @@
+# 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
+
+  before_filter :setup_wizard
+
+  def index
+    # redirect_to_first_step
+  end
+
+  # steps :confirm_password, :invite_fb
+
+  # @example show action
+  # def show
+  #   case step
+  #   when :confirm_password
+  #     redirect_to_next(@next_step) and return nil unless @user.facebook?
+  #   when :invite_fb
+  #     redirect_to_next(@next_step) and return nil unless @user.facebook?
+  #   end
+  #   render_wizard
+  # end
+
+
+  # @example update action
+  # def update
+  #   case step
+  #   when :confirm_password
+  #     @user.update_attributes(params[:user])
+  #   when :confirm_profile
+  #     @user.update_attributes(params[:user])
+  #   end
+  #   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/lib/wicked/controller/concerns/path.rb

@@ -0,0 +1,27 @@
+module Wicked::Controller::Concerns::Path
+  extend ActiveSupport::Concern
+
+
+  def next_wizard_path
+    wizard_path(@next_step)
+  end
+
+  def controller
+    params[:controller]
+  end
+
+  def action
+    params[:action]
+  end
+
+
+  def wizard_path(goto_step = nil, options = {})
+    options = {
+                 :controller => controller,
+                 :action     => 'show',
+                 :id         => goto_step || action,
+                 :only_path  => true
+               }.merge options
+    url_for(options)
+  end
+end

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

@@ -0,0 +1,46 @@
+module Wicked::Controller::Concerns::RenderRedirect
+  extend ActiveSupport::Concern
+
+
+  # scary and gross, allows for double render
+  def _reset_invocation_response
+    self.instance_variable_set(:@_response_body, nil)
+    response.instance_variable_set :@header, Rack::Utils::HeaderHash.new("cookie" => [], 'Content-Type' => 'text/html')
+  end
+
+
+  def render_wizard(resource = nil)
+    _reset_invocation_response
+    @skip_to = @next_step if resource && resource.save
+    if @skip_to.present?
+      redirect_to wizard_path @skip_to
+    else
+      render_step  @step
+    end
+  end
+
+  def render_step(the_step)
+    if the_step.nil? || the_step == :finish
+      redirect_to_finish_wizard
+    else
+      render the_step
+    end
+  end
+
+  def redirect_to_next(next_step)
+    if next_step.nil?
+      redirect_to_finish_wizard
+    else
+      redirect_to wizard_path(next_step)
+    end
+  end
+
+  def finish_wizard_path
+    '/'
+  end
+
+  def redirect_to_finish_wizard
+    redirect_to finish_wizard_path
+  end
+
+end

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

@@ -0,0 +1,41 @@
+module Wicked::Controller::Concerns::Steps
+  extend ActiveSupport::Concern
+
+
+  def jump_to(goto_step)
+    @skip_to = goto_step
+  end
+
+  def skip_step
+    @skip_to = @next_step
+  end
+
+  def step
+    @step
+  end
+
+  module ClassMethods
+    def steps=(steps)
+      @wizard_steps = steps
+    end
+
+    def steps(*steps_to_set)
+      @wizard_steps = steps_to_set unless steps_to_set.blank?
+      @wizard_steps
+    end
+  end
+
+  def steps
+    self.class.steps
+  end
+
+
+  def next_step(current_step)
+    index = steps.index(current_step)
+    step = steps.at(index + 1) if index.present?
+    step ||= :finish
+    step
+  end
+
+
+end

data/lib/wicked/engine.rb

@@ -0,0 +1,4 @@
+module Wicked
+  class Engine < Rails::Engine
+  end
+end

data/lib/wicked.rb

@@ -0,0 +1,11 @@
+module Wicked
+  module Controller
+    module Concerns
+    end
+  end
+end
+
+require 'wicked/controller/concerns/render_redirect'
+require 'wicked/controller/concerns/steps'
+require 'wicked/controller/concerns/path'
+require 'wicked/engine'

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

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

@@ -0,0 +1,11 @@
+class FooController < Wicked::WizardController
+  steps :first, :second, :last_step
+
+  def show
+    skip_step if params[:skip_step]
+    render_wizard
+  end
+
+  def update
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

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

@@ -0,0 +1 @@
+first

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

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

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "wicked"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!