wizardly 0.1.8.9

data/lib/wizardly/wizard/text_helpers.rb

@@ -0,0 +1,16 @@
+module Wizardly
+  module Wizard
+    module TextHelpers
+      private
+      def underscore_button_name(name)
+        name.to_s.strip.squeeze(' ').gsub(/ /, '_').downcase
+      end
+      def button_name_to_symbol(str)
+        underscore_button_name(str).to_sym
+      end
+      def symbol_to_button_name(sym)
+        sym.to_s.gsub(/_/, ' ').squeeze(' ').titleize
+      end
+    end
+  end
+end

data/lib/wizardly/wizard/utils.rb

@@ -0,0 +1,11 @@
+module Wizardly
+  module Wizard
+    module Utils
+      def self.formatted_redirect(r)
+        return(nil) unless r
+        r.is_a?(Hash)? r : "'#{r}'"
+      end
+    end
+  end
+end
+

data/rails_generators/wizardly_app/USAGE

@@ -0,0 +1,6 @@
+Prepares a rails application to use wizardly gem
+
+Moves the wizardly.rake file in to lib/tasks directory
+
+
+

data/rails_generators/wizardly_app/templates/wizardly.rake

@@ -0,0 +1,37 @@
+
+namespace :wizardly do
+  desc "Display wizard configuration details"
+  task :config => :environment do
+    name = ENV['name']
+    return print_usage unless name
+    begin
+      name = name.strip.camelize
+      name += 'Controller' unless name.match('Controller$')
+      controller = name.constantize
+      begin
+        c = controller.wizard_config
+        begin
+          puts
+          puts c.print_config
+        rescue Exception=>e
+          puts "Problem printing configuration."
+          puts "#{e.class.name} -- #{e.message}"
+          puts
+        end
+      rescue Exception=>e
+        puts "{#{name}} is not a 'wizardly' controller.\nMake sure 'wizard_for_model' is defined in the controller class." 
+        puts "#{e.class.name} -- #{e.message}"
+        puts
+      end
+    rescue Exception=>e
+      puts "{#{name}} does not reference a controller class."
+      puts "#{e.class.name} -- #{e.message}"
+      puts
+    end
+  end
+  
+  def print_usage
+    puts "Usage: rake wizardly:config name={controller_name}"
+    puts
+  end
+end

data/rails_generators/wizardly_app/wizardly_app_generator.rb

@@ -0,0 +1,41 @@
+#require 'wizardly'
+
+class WizardlyAppGenerator < Rails::Generator::Base
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+  end
+  
+  def manifest
+    record do |m|
+      m.directory "lib/tasks"
+      
+      m.file "wizardly.rake", "lib/tasks/wizardly.rake"
+      
+    end
+  end
+  
+  def controller_class_name
+    "#{controller_name.camelize}Controller"
+  end
+  def model_class_name
+    "#{model_name.camelize}"
+  end
+  def action_methods
+    @wizard_config.print_page_action_methods
+  end
+  def callback_methods
+    @wizard_config.print_callbacks
+  end
+  def helper_methods
+    @wizard_config.print_helpers
+  end
+  
+  protected
+  # Override with your own usage banner.
+  def banner
+    "Usage: #{$0} wizardly_app"
+  end
+  
+  
+end

data/rails_generators/wizardly_controller/USAGE

@@ -0,0 +1,3 @@
+Generates a wizard controller with all the code displayed
+
+

data/rails_generators/wizardly_controller/templates/controller.rb.erb

@@ -0,0 +1,34 @@
+#
+# <%= controller_class_name %> class generated by wizardly_controller
+#
+
+class <%= controller_class_name %> < ApplicationController
+  before_filter :guard_entry
+
+  <%= action_methods %>
+
+  <%= callback_methods %>
+
+  <%= helper_methods %>
+
+  <%= callback_macro_methods %>
+
+  public
+  def wizard_config; self.class.wizard_config; end
+  hide_action :wizard_config
+  
+  private
+
+  def self.wizard_config; @wizard_config; end
+  @wizard_config = Wizardly::Wizard::Configuration.create(:<%=controller_name %>, :<%=model_name %>, :allow_skip=>true) do
+    <%= "when_completed_redirect_to #{Wizardly::Wizard::Utils.formatted_redirect(completed_redirect)}" if completed_redirect %>
+    <%= "when_canceled_redirect_to #{Wizardly::Wizard::Utils.formatted_redirect(canceled_redirect)}" if canceled_redirect  %>
+    
+    # other things you can configure
+    # change_button(:next).to('Next One')
+    # change_button(:back).to('Previous')
+    # create_button('Help')
+    # set_page(:init).buttons_to :next_one, :previous, :cancel, :help #this removes skip
+  end
+
+end

data/rails_generators/wizardly_controller/templates/helper.rb.erb

@@ -0,0 +1,14 @@
+module <%=controller_name.camelize %>Helper
+  
+  def wizardly_submit
+    @@wizardly_submit ||= {}
+    unless @@wizardly_submit[@step]
+      buttons = @wizard.pages[@step].buttons
+      @@wizardly_submit[@step] = buttons.inject(StringIO.new) do |io, button|
+        io << submit_tag(button.name)
+      end.string
+    end
+    @@wizardly_submit[@step]
+  end
+  
+end

data/rails_generators/wizardly_controller/wizardly_controller_generator.rb

@@ -0,0 +1,57 @@
+require 'wizardly'
+
+class WizardlyControllerGenerator < Rails::Generator::Base
+  attr_reader :controller_name, :model_name, :completed_redirect, :canceled_redirect
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @controller_name = @args[0].sub(/^:/,'')
+    @model_name = @args[1].sub(/^:/, '').underscore
+    @completed_redirect = @args[2]
+    @canceled_redirect = @args[3]
+    opts = {}
+    opts[:completed] = @completed_redirect if @completed_redirect
+    opts[:canceled] = @canceled_redirect if @canceled_redirect
+    
+    @wizard_config = Wizardly::Wizard::Configuration.new(@controller_name, opts)
+    @wizard_config.inspect_model!(@model_name.to_sym)
+  end
+  
+  def manifest
+    record do |m|
+      m.directory "app/controllers"
+      
+      m.template "controller.rb.erb", "app/controllers/#{controller_name}_controller.rb"
+      
+      m.template "helper.rb.erb", "app/helpers/#{controller_name}_helper.rb"
+      
+    end
+  end
+  
+  def controller_class_name
+    "#{controller_name.camelize}Controller"
+  end
+  def model_class_name
+    "#{model_name.camelize}"
+  end
+  def action_methods
+    @wizard_config.print_page_action_methods
+  end
+  def callback_methods
+    @wizard_config.print_callbacks
+  end
+  def helper_methods
+    @wizard_config.print_helpers
+  end
+  def callback_macro_methods
+    @wizard_config.print_callback_macros
+  end
+  
+  protected
+  # Override with your own usage banner.
+  def banner
+    "Usage: #{$0} wizardly_controller controller_name model_name [completed_redirect canceled_redirect]"
+  end
+  
+  
+end

data/rails_generators/wizardly_scaffold/USAGE

@@ -0,0 +1,4 @@
+Generates a wizard scaffold from a wizard controller using wizard_for_model (or wizard_for)
+
+
+

data/rails_generators/wizardly_scaffold/templates/form.html.erb

@@ -0,0 +1,23 @@
+<h1><%= page.title %></h1>
+
+<%= "<p>#{page.description}<p>" if !page.description.blank? %>
+<%%= "<p style=\"color: green\">#{flash[:notice]}<p>" if flash[:notice] %>
+
+<%% form_for :<%= model_name %>, :url=>{:action=>:<%= page.name %>}  do |f| %>
+  <%%= f.error_messages %>
+
+<% for field in page.fields -%>
+  <% first_field_id ||= "#{model_name}_#{field.name}" %>
+  <p>
+    <%%= f.label :<%= field.name %> %><br />
+    <%%= f.<%= field.field_type %> :<%= field.name %> %>
+  </p>
+<% end -%>
+  <p>
+    <%%= <%= submit_tag %> %>
+  </p>
+<%% end %>
+
+<script type='text/javascript'>
+  document.getElementById('<%=first_field_id %>').focus()
+</script>

data/rails_generators/wizardly_scaffold/templates/form.html.haml.erb

@@ -0,0 +1,22 @@
+%h1 <%= page.title %>
+
+<% unless page.description.blank? %>
+  %p <%= page.description %>
+<% end %>
+- if flash[:notice]
+  %p{:style=>'color: green'}= flash[:notice]
+
+- form_for :<%= model_name %>, :url=>{:action=>:<%= page.name %>} do |f|
+  = f.error_messages
+  
+<% for field in page.fields %>
+  <% first_field_id ||= "#{model_name}_#{field.name}" %>
+  %p
+    = f.label :<%= field.name %>
+    %br
+    = f.<%= field.field_type %> :<%= field.name %>
+<% end %>
+  %p= <%= submit_tag %>
+
+%script{:type=>'text/javascript'} 
+  document.getElementById('<%=first_field_id %>').focus()

data/rails_generators/wizardly_scaffold/templates/helper.rb.erb

@@ -0,0 +1,30 @@
+module <%=controller_name.camelize %>Helper
+  
+  def wizardly_submit
+    @@wizardly_submit ||= {}
+    step_id = "#{controller_name}_#{@step}".to_sym
+    unless @@wizardly_submit[step_id]
+      buttons = @wizard.pages[@step].buttons
+      @@wizardly_submit[step_id] = buttons.inject(StringIO.new) do |io, button|
+        io << submit_tag(button.name, :name=>button.id.to_s)
+      end.string
+    end
+    @@wizardly_submit[step_id]
+  end
+  
+  def wizardly_image_submit(asset_dir = nil, opts = {})
+    @@wizardly_image_submit ||={}
+    step_id = "#{controller_name}_#{@step}".to_sym
+    unless @@wizardly_image_submit[step_id]
+      asset_dir = asset_dir ? "#{asset_dir}/".squeeze("/").sub(/^\//,'') : "wizardly/"
+      buttons = @wizard.pages[@step].buttons
+      @@wizardly_image_submit[step_id] = buttons.inject(StringIO.new) do |io, button|
+        opts[:value] = button.name
+        opts[:name] = button.id.to_s
+        io << image_submit_tag("#{asset_dir}#{button.id}.png", opts)
+      end.string
+    end
+    @@wizardly_image_submit[step_id]
+  end
+  
+end

data/rails_generators/wizardly_scaffold/templates/layout.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title><%= controller_class_name %>: <%%= controller.action_name %></title>
+  <%%= stylesheet_link_tag 'scaffold' %>
+</head>
+<body>
+
+<%%= yield %>
+
+</body>
+</html>

data/rails_generators/wizardly_scaffold/templates/layout.html.haml.erb

@@ -0,0 +1,10 @@
+!!! XML
+!!!
+%html{ :'xml:lang' => "en", :lang => "en" }
+  %head
+    %title= "<%=controller_class_name %>: " + controller.action_name
+    %meta{ :"http-equiv" => "Content-Type", :content => "text/html; charset-utf-8" }
+    %link{ :rel => "shortcut icon", :href => "/favicon.ico" }
+    = stylesheet_link_tag "scaffold", :media => "screen"
+  %body
+    = yield

data/rails_generators/wizardly_scaffold/templates/style.css

@@ -0,0 +1,54 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+.fieldWithErrors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#errorExplanation {
+  width: 400px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#errorExplanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#errorExplanation p {
+  color: #333;
+  margin-bottom: 0;
+  padding: 5px;
+}
+
+#errorExplanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+

data/rails_generators/wizardly_scaffold/wizardly_scaffold_generator.rb

@@ -0,0 +1,109 @@
+require 'wizardly'
+
+class WizardlyScaffoldGenerator < Rails::Generator::Base
+  attr_reader :wizard_config, :pages, :submit_tag
+  attr_reader :controller_name,
+              :controller_class_path,
+              :controller_file_path,
+              :controller_class_nesting,
+              :controller_class_nesting_depth,
+              :controller_class_name,
+              :controller_underscore_name            
+  attr_reader :model_name, :view_file_ext
+  
+  alias_method :controller_file_name, :controller_underscore_name
+  
+  def add_options!(opt)
+    opt.on('--haml', 'Generate scaffold for haml wizard') { |v| options[:output] = :haml }
+    opt.on('--ajax', 'Generate scaffold for ajax wizard') { |v| options[:output] = :ajax }
+    opt.on('--underscore', 'Append an underscore to front of each file') { |v| options[:underscore] = true }
+    opt.on('--image_submit', 'Use image submit tags in forms') {|v| options[:image_submit] = true }
+  end
+  
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    name = @args[0].sub(/^:/, '').underscore.sub(/_controller$/, '').camelize + 'Controller'
+
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(name)
+    @controller_class_name_without_nesting = base_name.camelize
+    @controller_underscore_name = base_name.underscore
+    @controller_name = @controller_underscore_name.sub(/_controller$/, '')
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+
+    begin
+      @controller_class = @controller_class_name.constantize 
+    rescue Exception => e
+      raise Wizardly::WizardlyScaffoldError, "No controller #{@controller_class_name} found: " + e.message, caller
+    end
+    begin
+      @wizard_config = @controller_class.wizard_config
+    rescue Exception => e
+      raise Wizardly::WizardlyScaffoldError, "#{@controller_class_name} must contain a valid 'act_wizardly_for' or 'wizard_for_model' macro: " + e.message, caller
+    end
+
+    @pages = @wizard_config.pages
+    @model_name = @wizard_config.model
+    @submit_tag = options[:image_submit] ? "wizardly_image_submit" : "wizardly_submit"
+
+    #based on options, default is --html, others --ajax, --haml
+    @view_file_ext = ["html.erb", "html.erb"]
+    @view_file_ext = ["html.haml.erb", "html.haml"] if options[:output] == :haml
+    #ajax
+  end
+  
+  def manifest
+    record do |m|
+      # Helper, views, test and stylesheets directories.
+      m.directory(File.join('app/helpers', controller_class_path))
+      m.directory(File.join('app/views', controller_class_path, controller_name))
+      m.directory(File.join('app/views/layouts', controller_class_path))
+      m.directory('public/images/wizardly') if options[:image_submit]
+      #m.directory(File.join('test/functional', controller_class_path))
+      #m.directory(File.join('public/stylesheets', class_path))
+
+      underscore = options[:underscore] ? '_' : ''
+      pages.each do |id, page|
+        m.template(
+          "form.#{view_file_ext.first}",
+          File.join('app/views', controller_class_path, controller_name, "#{underscore}#{id}.#{view_file_ext.last}"),
+          :assigns=>{:id=>id, :page=>page}
+        )
+      end
+      
+      if options[:image_submit]
+        %w(next skip back cancel finish).each do |fn|
+          m.file("images/#{fn}.png", "public/images/wizardly/#{fn}.png")
+        end
+      end
+      
+      m.template("helper.rb.erb", File.join('app/helpers', controller_class_path, "#{controller_name}_helper.rb"))
+
+      # Layout and stylesheet.
+      m.template("layout.#{view_file_ext.first}", File.join('app/views/layouts', controller_class_path, "#{controller_name}.#{view_file_ext.last}"))
+      m.template('style.css', 'public/stylesheets/scaffold.css')
+
+      #m.dependency 'model', [name] + @args, :collision => :skip
+    end
+  end
+  
+  protected
+  def banner
+    "Usage: #{$0} wizardly_scaffold controller_name --ajax --haml"
+  end
+  
+  def extract_modules(name)
+    modules = name.include?('/') ? name.split('/') : name.split('::')
+    name    = modules.pop
+    path    = modules.map { |m| m.underscore }
+    file_path = (path + [name.underscore]).join('/')
+    nesting = modules.map { |m| m.camelize }.join('::')
+    [name, path, file_path, nesting, modules.size]
+  end
+  
+  
+end