wicked-focused 0.2.0

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

@@ -0,0 +1,87 @@
+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
+
+  # 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
+    attr_reader :wizard_steps
+
+    def steps(*args)
+      options = args.last.is_a?(Hash) ? callbacks.pop : {}
+      steps   = args
+      @wizard_steps = args
+      prepend_before_filter(options) do
+        self.steps = steps
+      end
+    end
+  end
+
+  def steps=(wizard_steps)
+    @wizard_steps = wizard_steps
+  end
+
+  def steps
+    @wizard_steps
+  end
+  alias :wizard_steps :steps
+  alias :steps_list   :steps
+
+  def previous_step(current_step = nil)
+    return previous_step if current_step == nil
+    index =  steps.index(current_step)
+    step  =  steps.at(index - 1) if index.present? && index != 0
+    step ||= steps.first
+    step
+  end
+
+
+  def next_step(current_step = nil)
+    return next_step if current_step == nil
+    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/macros.rb

@@ -0,0 +1,23 @@
+class Module
+  def use_wicked_macros
+    use_focused_macros
+    extend Wicked::Macros
+  end
+end
+
+module Wicked
+  module Macros
+    def wicked_wizard
+      include Wicked::Wizard
+    end
+
+    def wicked_base_action &block
+      focused_action :action do
+        include Wicked::Action
+        
+        instance_eval &block
+      end
+      wicked_wizard
+    end    
+  end
+end

data/lib/wicked/wizard.rb

@@ -0,0 +1,26 @@
+module Wicked
+  module Wizard
+    extend ActiveSupport::Concern
+
+    included do
+      use_focused_macros
+      focused_action :index, "#{self.name}::Action".constantize do
+        run do
+          redirect_to wizard_path(steps.first)
+        end
+      end 
+    end
+
+    module ClassMethods
+      def wizard_actions *names
+        names.each do |name|
+          wizard_action name
+        end
+      end
+
+      def wizard_action action, &block
+        focused_action action, "#{self.name}::Action".constantize, &block
+      end
+    end
+  end
+end

data/lib/wicked-focused.rb

@@ -0,0 +1,25 @@
+module Wicked
+  module Controller
+    module Concerns
+    end
+  end
+  module Wizard
+  end
+end
+
+class ApplicationController < ActionController::Base
+end
+
+require 'focused_controller'
+require 'focused_controller/macros'
+require 'focused_controller/focused_action'
+
+require 'wicked/controller/concerns/render_redirect'
+require 'wicked/controller/concerns/steps'
+require 'wicked/controller/concerns/path'
+require 'wicked/action'
+require 'wicked/wizard'
+require 'wicked/macros'
+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/bar_controller.rb

@@ -0,0 +1,18 @@
+## This controller uses includes
+
+module BarController
+  use_wicked_macros
+  
+  wicked_base_action do
+    steps :first, :second, :last_step
+  end    
+  
+  wizard_action :show do
+    wizard do
+      skip_step if params[:skip_step]
+      render_wizard
+    end
+  end
+
+  focused_action :update
+end

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

@@ -0,0 +1,19 @@
+## This controller uses inheritance
+
+module FooController
+  class Action < FocusedAction
+    include Wicked::Action
+
+    steps :first, :second, :last_step
+  end
+  include Wicked::Wizard  
+
+  wizard_action :show do
+    wizard do
+      skip_step if params[:skip_step]
+      render_wizard
+    end
+  end
+
+  wizard_action :update
+end

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

@@ -0,0 +1,26 @@
+## This controller uses includes
+
+module JumpController
+  class Action < FocusedAction
+    include Wicked::Action
+
+    steps :first, :second, :last_step
+  end
+  include Wicked::Wizard  
+
+  wizard_action :show do
+    wizard do
+      skip_step if params[:skip_step]
+      jump_to :last_step if params[:jump_to]
+      if params[:resource]
+        value = params[:resource][:save] == 'true'
+        @bar  = Bar.new(value)
+        render_wizard(@bar)
+      else
+        render_wizard
+      end
+    end
+  end
+
+  wizard_action :update
+end

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

@@ -0,0 +1,18 @@
+## This controller uses includes
+
+module StepPositionsController
+  class Action < FocusedAction
+    include Wicked::Action
+
+    steps :first, :second, :last_step
+  end
+  include Wicked::Wizard  
+
+  wizard_action :show do
+    wizard do
+      render_wizard
+    end
+  end
+
+  wizard_action :update
+end

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

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

data/test/dummy/app/models/bar.rb

@@ -0,0 +1,9 @@
+class Bar
+  def initialize(value)
+    @value = value
+  end
+
+  def save
+    @value
+  end
+end

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

@@ -0,0 +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/bar/last_step.html.erb

@@ -0,0 +1,3 @@
+last_step
+
+<%= "step #{wizard_steps.index(step) + 1 } of #{wizard_steps.count}" %>

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

@@ -0,0 +1,3 @@
+second
+
+<%= link_to 'previous', previous_wizard_path %>

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

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

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

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

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

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

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

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

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

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

data/test/dummy/app/views/jump/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/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/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-focused"
+
+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: ":memory:"
+  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: ":memory:"
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: ":memory:"
+  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!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,35 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = 'bedc31c5fff702ea808045bbbc5123455f1c00ecd005a1f667a5f04332100a6abf22cfcee2b3d39b8f677c03bb6503cf1c3b65c1287b9e13bd0d20c6431ec6ab'

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/test/dummy/config/initializers/wicked.rb

@@ -0,0 +1,2 @@
+# require 'focused_controller/macros'
+# require 'focused_controller/focused_action'

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -0,0 +1,8 @@
+Dummy::Application.routes.draw do
+  focused_controller_routes do
+    resources :foo
+    resources :bar
+    resources :jump
+    resources :step_positions
+  end
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>