jeffp-wizardly 0.1.8.1 → 0.1.8.3

data/README.rdoc

@@ -4,9 +4,9 @@
 
 == Resources
 
-Development
+Examples
 
-* http://github.com/jeffp/wizardly
+* http://github.com/jeffp/wizardly-examples
 
 Source
 
@@ -34,7 +34,7 @@ Features include:
 
 Put the following in your application's config block in config/environment.rb
 
-  config.gem 'jeffp-wizardly', :lib=>'wizardly' 
+  config.gem 'jeffp-wizardly', :lib=>'wizardly'
 
 and run the install gems rake task on your application
 
@@ -44,6 +44,20 @@ For any rails app, run the following to install wizardly rake tasks (optional)
 
   ./script/generate wizardly_app
 
+== Recommendations
+
+Wizardly uses sessions.  It is recommended you use a session store other than the  
+default cookies store to eliminate the 4KB size restriction.  To use the active 
+record store, add this line to your environment.rb
+
+  config.action_controller.session_store = :active_record_store
+
+And set up the sessions table in the database
+
+  rake db:sessions:create
+  rake db:migrate
+
+Use the MemCached session store for higher performance requirements.
 
 == Example
 
@@ -69,7 +83,9 @@ Step 3: Generate a 'wizardly' scaffold for your controller.
 
 You are ready to go.
 
-General usage and configuration of wizardly follows.
+General usage and configuration of wizardly follows.  See the examples at
+
+  http://github.com/jeffp/wizardly-examples
 
 == Usage
 
@@ -312,6 +328,23 @@ call back for this.
     end
   end
 
+=== Completing the Wizard Programmatically
+
+Perhaps you want to complete a wizard based off of a test instead of a button
+click.  You can do this in your callbacks by calling the +complete_wizard+ method.
+
+  on_next(:step4) do
+    if (test_radio_button)
+      complete_wizard
+    end
+  end
+
+Complete wizard will save the model and redirect to the :completed redirect setting.
+You can change the redirect dynamically by passing it to the method.
+
+  complete_wizard(some_model_path)
+
+
 === Creating Scaffolds
 
 Wizard scaffolds can be created for any wizardly controller (one using the acts_wizardly_for
@@ -329,6 +362,11 @@ each page.
 
   ./script/generate wizardly_scaffold controller_name --underscore
 
+You can create a scaffold using image_submit_tag by doing the following:
+
+  ./script/generate wizardly_scaffold controller_name --image_submit
+
+Default button images are provided under the public/images/wizardly/ directory.
 
 == Advanced Configuration 
 
@@ -336,7 +374,7 @@ To be provided
 
 == Testing
 
-Testing uses RSpec and Webrat.  Make sure you have those gems installed.  Then 
+Testing uses RSpec and Webrat.  Make sure you have the gems installed.  Then 
 to test the development code run the following:
 
   rake spec:all  

data/lib/validation_group.rb

@@ -44,7 +44,7 @@ module ValidationGroup
 
     module InstanceMethods # included in every model which calls validation_group
       #needs testing
-#      def reset_validation_group(group)
+#      def reset_fields_for_validation_group(group)
 #        group_classes = self.class.validation_group_classes
 #        found = ValidationGroup::Util.current_and_ancestors(self.class).find do |klass|
 #          group_classes[klass] && group_classes[klass].include?(group)

data/lib/wizardly/wizard/configuration.rb

@@ -7,12 +7,15 @@ require 'wizardly/wizard/configuration/methods'
 module Wizardly
   module Wizard
     class Configuration
-      attr_reader :pages, :completed_redirect, :canceled_redirect, :controller_name, :page_order
+      attr_reader :pages, :completed_redirect, :canceled_redirect, :controller_path, :controller_class_name, :controller_name, :page_order
       
       #enum_attr :persistance, %w(sandbox session database)
 
-      def initialize(controller_name, opts) #completed_redirect = nil, canceled_redirect = nil)
-        @controller_name = controller_name
+      def initialize(controller, opts) #completed_redirect = nil, canceled_redirect = nil)
+        @controller_class_name = controller.to_s.camelcase
+        @controller_class_name += 'Controller' unless @controller_class_name =~ /Controller$/
+        @controller_path = @controller_class_name.sub(/Controller$/,'').underscore
+        @controller_name = @controller_class_name.demodulize.sub(/Controller$/,'').underscore
         @completed_redirect = opts[:redirect] || opts[:completed] || opts[:when_completed] #format_redirect(completed_redirect)
         @canceled_redirect = opts[:redirect] || opts[:canceled] || opts[:when_canceled]
         @allow_skipping = opts[:skip] || opts[:allow_skip] || opts[:allow_skipping] || false
@@ -59,7 +62,7 @@ module Wizardly
       end
     
       def self.create(controller_name, model_name, opts={}, &block)
-        controller_name = controller_name.to_s.underscore.sub(/_controller$/, '').to_sym
+        # controller_name = controller_name.to_s.underscore.sub(/_controller$/, '').to_sym
         model_name = model_name.to_s.underscore.to_sym
         config = Wizardly::Wizard::Configuration.new(controller_name, opts)
         config.inspect_model!(model_name)

data/lib/wizardly/wizard/configuration/methods.rb

@@ -53,16 +53,22 @@ MACRO
         INDEX
         mb.string
       end
-      
-      def persist_key; 
-        @persist_key ||= "wizardly_#{controller_name.to_s.underscore}_#{model}".to_sym 
-      end      
-    
+
+      def initial_referer_key
+        @initial_referer_key ||= "#{self.controller_path.sub(/\//, '')}_irk".to_sym
+      end
+      def persist_key;
+        @persist_key ||= "#{self.controller_path.sub(/\//, '')}_dat".to_sym 
+      end
+      def progression_key
+        @progression_key ||= "#{self.controller_path.sub(/\//, '')}_prg".to_sym
+      end
+
       def print_page_action_method(id)
         page = @pages[id]
         finish_button = self.button_for_function(:finish).id
         next_button = self.button_for_function(:next).id
-        model_persist_line = self.persist_model_per_page? ? 'save_wizard_model!' : ''
+        model_persist_line = self.persist_model_per_page? ? "@#{self.model}.save_without_validation!" : ''
 
         (mb = StringIO.new) << <<-ONE
   def #{page.name}
@@ -95,15 +101,13 @@ MACRO
         if self.last_page?(id)
           mb << <<-TWO
       callback_performs_action?(:on_#{id}_form_#{finish_button})
-      _on_wizard_#{finish_button}
-      redirect_to #{Utils.formatted_redirect(self.completed_redirect)} unless self.performed?
+      complete_wizard
         TWO
         elsif self.first_page?(id)
           mb << <<-THREE
       if button_id == :#{finish_button}
         callback_performs_action?(:on_#{id}_form_#{finish_button})
-        _on_wizard_#{finish_button} if button_id == :#{finish_button}
-        redirect_to #{Utils.formatted_redirect(self.completed_redirect)} unless self.performed?
+        complete_wizard
         return
       end
       #{model_persist_line}
@@ -114,8 +118,7 @@ MACRO
           mb << <<-FOUR
       if button_id == :#{finish_button}
         callback_performs_action?(:on_#{id}_form_#{finish_button})
-        _on_wizard_#{finish_button} if button_id == :#{finish_button}
-        redirect_to #{Utils.formatted_redirect(self.completed_redirect)} unless self.performed?
+        complete_wizard
         return
       end
       #{model_persist_line}
@@ -147,7 +150,7 @@ ENSURE
     _wizard_final_redirect_to(:completed)
   end
   def _on_wizard_#{skip}
-    session[:progression] = (session[:progression]||[]) - [@step]
+    self.progression = self.progression - [@step]
     redirect_to(:action=>wizard_config.next_page(@step)) unless self.performed?
   end
   def _on_wizard_#{back} 
@@ -156,12 +159,12 @@ ENSURE
   def _on_wizard_#{cancel}
     _wizard_final_redirect_to(:canceled)
   end
-  def _wizard_final_redirect_to(type) 
-    initial_referer = (type == :canceled && wizard_config.form_data_keep_in_session?) ?
-      session[:initial_referer] :
+  def _wizard_final_redirect_to(type)
+    init = (type == :canceled && wizard_config.form_data_keep_in_session?) ?
+      self.initial_referer :
       reset_wizard_session_vars
     unless self.performed?
-      redir = (type == :canceled ? wizard_config.canceled_redirect : wizard_config.completed_redirect) || initial_referer
+      redir = (type == :canceled ? wizard_config.canceled_redirect : wizard_config.completed_redirect) || init
       return redirect_to(redir) if redir
       raise Wizardly::RedirectNotDefinedError, "No redirect was defined for completion or canceling the wizard.  Use :completed and :canceled options to define redirects.", caller
     end
@@ -174,26 +177,27 @@ ENSURE
         next_id = self.button_for_function(:next).id
         finish_id = self.button_for_function(:finish).id
         first_page = self.page_order.first
+        finish_button = self.button_for_function(:finish).id        
         guard_line = self.guard? ? '' : 'return check_progression #guard entry disabled'
         mb = StringIO.new
         mb << <<-PROGRESSION
   protected
   def previous_in_progression_from(step)
-    po = wizard_config.page_order
-    p = session[:progression]||[]
+    po = #{self.page_order.inspect}
+    p = self.progression
     p -= po[po.index(step)..-1]
-    session[:progression] = p
+    self.progression = p
     p.last
   end
   def check_progression
-    p = session[:progression]||[]
+    p = self.progression
     a = params[:action].to_sym
     return if p.last == a
-    po = wizard_config.page_order
+    po = #{self.page_order.inspect}
     return unless (ai = po.index(a))
     p -= po[ai..-1]
     p << a
-    session[:progression] = p
+    self.progression = p
   end        
 PROGRESSION
         if self.form_data_keep_in_session?
@@ -203,14 +207,14 @@ PROGRESSION
     if (r = request.env['HTTP_REFERER'])
       h = ::ActionController::Routing::Routes.recognize_path(URI.parse(r).path)
       return check_progression if (h[:controller]||'') == '#{self.controller_name}'
-      session[:initial_referer] ||= h
+      self.initial_referer = h unless self.initial_referer
     end
     # coming from outside the controller
     #{guard_line}
     if (params[:action] == '#{first_page}' || params[:action] == 'index')
       return check_progression
     elsif self.wizard_form_data
-      p = session[:progression]||[]
+      p = self.progression
       return check_progression if p.include?(params[:action].to_sym)
       return redirect_to(:action=>(p.last||:#{first_page}))
     end
@@ -226,9 +230,9 @@ SESSION
     if (r = request.env['HTTP_REFERER'])
       h = ::ActionController::Routing::Routes.recognize_path(URI.parse(r).path)
       return check_progression if (h[:controller]||'') == '#{self.controller_name}'
-      session[:initial_referer] = h
+      self.initial_referer = h
     else
-      session[:initial_referer] = nil 
+      self.initial_referer = nil 
     end
     # coming from outside the controller
     reset_wizard_form_data 
@@ -241,25 +245,38 @@ SESSION
 SANDBOX
         end
         mb << <<-HELPERS
-  def save_wizard_model!
-    @#{self.model}.save_without_validation!
-    if wizard_config.form_data_keep_in_session?
-      h = self.wizard_form_data
-      h['id'] = @#{self.model}.id
-      self.wizard_form_data= h
-    end
+  def complete_wizard(redirect = nil)
+    redirect_to redirect if redirect
+    _on_wizard_#{finish_button}
+    redirect_to #{Utils.formatted_redirect(self.completed_redirect)} unless self.performed?
   end
   def build_wizard_model(params)
     if (wizard_config.persist_model_per_page? && (model_id = params['id']))
-      _model = #{self.model_class_name}.find(model_id)
-      _model.attributes = params
-      _model
-    else
-      #{self.model_class_name}.new(params)
+       begin
+        _model = #{self.model_class_name}.find(model_id) 
+        _model.attributes = params
+        return _model
+      rescue
+      end
     end
+    #{self.model_class_name}.new(params)
   end
   hide_action :build_wizard_model, :save_wizard_model!
 
+  def initial_referer
+    session[:#{self.initial_referer_key}]
+  end
+  def initial_referer=(val)
+    session[:#{self.initial_referer_key}] = val
+  end
+  def progression=(array)
+    session[:#{self.progression_key}] = array
+  end
+  def progression
+    session[:#{self.progression_key}]||[]
+  end
+  hide_action :progression, :progression=
+
   def wizard_form_data=(hash)
     if wizard_config.form_data_keep_in_session?
       session[:#{self.persist_key}] = hash
@@ -291,9 +308,9 @@ SANDBOX
   hide_action :underscore_button_name
 
   def reset_wizard_session_vars
-    session[:progression] = nil
-    init = session[:initial_referer]
-    session[:initial_referer] = nil
+    self.progression = nil
+    init = self.initial_referer
+    self.initial_referer = nil
     init
   end
   hide_action :reset_wizard_session_vars
@@ -319,9 +336,19 @@ SANDBOX
   end
   hide_action :check_action_for_button
 
-  def callback_performs_action?(methId, arg=nil)
-    return false unless self.methods.include?(methId.to_s)
-    #self.__send__(methId)
+  @wizard_callbacks ||= {}
+  def self.wizard_callbacks; @wizard_callbacks; end
+
+  def callback_performs_action?(methId)
+    cache = self.class.wizard_callbacks
+    return false if ((m = cache[methId]) == :none)
+    unless m == :found
+      unless self.methods.include?(methId.to_s)
+        cache[methId] = :none
+        return false
+      end
+      cache[methId] = :found
+    end
     self.method(methId).call
     self.performed?
   end

data/rails_generators/wizardly_controller/wizardly_controller_generator.rb

@@ -5,7 +5,7 @@ class WizardlyControllerGenerator < Rails::Generator::Base
   
   def initialize(runtime_args, runtime_options = {})
     super
-    @controller_name = @args[0].sub(/^:/, '').underscore
+    @controller_name = @args[0].sub(/^:/,'')
     @model_name = @args[1].sub(/^:/, '').underscore
     @completed_redirect = @args[2]
     @canceled_redirect = @args[3]
@@ -13,7 +13,7 @@ class WizardlyControllerGenerator < Rails::Generator::Base
     opts[:completed] = @completed_redirect if @completed_redirect
     opts[:canceled] = @canceled_redirect if @canceled_redirect
     
-    @wizard_config = Wizardly::Wizard::Configuration.new(@controller_name.to_sym, opts)
+    @wizard_config = Wizardly::Wizard::Configuration.new(@controller_name, opts)
     @wizard_config.inspect_model!(@model_name.to_sym)
   end
   

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

@@ -14,7 +14,7 @@
   </p>
 <% end -%>
   <p>
-    <%%= wizardly_submit %>
+    <%%= <%= submit_tag %> %>
   </p>
 <%% end %>
 

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

@@ -16,7 +16,7 @@
     %br
     = f.<%= field.field_type %> :<%= field.name %>
 <% end %>
-  %p= wizardly_submit
+  %p= <%= submit_tag %>
 
 %script{:type=>'text/javascript'} 
   document.getElementById('<%=first_field_id %>').focus()

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

@@ -2,13 +2,29 @@ module <%=controller_name.camelize %>Helper
   
   def wizardly_submit
     @@wizardly_submit ||= {}
-    unless @@wizardly_submit[@step]
+    step_id = "#{controller_name}_#{@step}".to_sym
+    unless @@wizardly_submit[step_id]
       buttons = @wizard.pages[@step].buttons
-      @@wizardly_submit[@step] = buttons.inject(StringIO.new) do |io, button|
+      @@wizardly_submit[step_id] = buttons.inject(StringIO.new) do |io, button|
         io << submit_tag(button.name)
       end.string
     end
-    @@wizardly_submit[@step]
+    @@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
+      opts[:name] = 'commit'
+      @@wizardly_image_submit[step_id] = buttons.inject(StringIO.new) do |io, button|
+        opts[:value] = button.name
+        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/wizardly_scaffold_generator.rb

@@ -1,7 +1,7 @@
 require 'wizardly'
 
 class WizardlyScaffoldGenerator < Rails::Generator::Base
-  attr_reader :wizard_config, :pages
+  attr_reader :wizard_config, :pages, :submit_tag
   attr_reader :controller_name,
               :controller_class_path,
               :controller_file_path,
@@ -17,6 +17,7 @@ class WizardlyScaffoldGenerator < Rails::Generator::Base
     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
   
   
@@ -47,6 +48,7 @@ class WizardlyScaffoldGenerator < Rails::Generator::Base
 
     @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"]
@@ -60,6 +62,7 @@ class WizardlyScaffoldGenerator < Rails::Generator::Base
       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))
 
@@ -72,6 +75,12 @@ class WizardlyScaffoldGenerator < Rails::Generator::Base
         )
       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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jeffp-wizardly
 version: !ruby/object:Gem::Version 
-  version: 0.1.8.1
+  version: 0.1.8.3
 platform: ruby
 authors: 
 - Jeff Patmon
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-14 00:00:00 -07:00
+date: 2009-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -54,6 +54,12 @@ files:
 - rails_generators/wizardly_scaffold/templates/form.html.erb
 - rails_generators/wizardly_scaffold/templates/form.html.haml.erb
 - rails_generators/wizardly_scaffold/templates/helper.rb.erb
+- rails_generators/wizardly_scaffold/templates/images
+- rails_generators/wizardly_scaffold/templates/images/back.png
+- rails_generators/wizardly_scaffold/templates/images/cancel.png
+- rails_generators/wizardly_scaffold/templates/images/finish.png
+- rails_generators/wizardly_scaffold/templates/images/next.png
+- rails_generators/wizardly_scaffold/templates/images/skip.png
 - rails_generators/wizardly_scaffold/templates/layout.html.erb
 - rails_generators/wizardly_scaffold/templates/layout.html.haml.erb
 - rails_generators/wizardly_scaffold/templates/style.css