jeffp-wizardly 0.1.8.7 → 0.1.8.8

data/README.rdoc

@@ -15,6 +15,10 @@ Install
 Examples
 
 * http://github.com/jeffp/wizardly-examples
+
+== Contributions
+
+Thanks for feedback from Roland Schulz, Steve Hoeksema, Morgan Christiansson, Jonathan Clarke
 	
 == Description
 
@@ -23,14 +27,13 @@ DRY up the Rails MVC implementation of a wizard.  In three easy steps, +wizardly
 produces the scaffolding and controller of a multi-step wizard.
 
 Features include:
-* Model-based definition
-* Wizard controller macro
-* Wizard scaffold generator
-* Simple wizard page helpers
-* Default and customizable wizard buttons
-* Page and wizard callbacks
-* High in Convention
-* Rich in Configuration
+* Model-based Wizard Definition
+* Wizard Controller Macros
+* Wizard Scaffold Generators
+* Sizard Form Helpers
+* Configurable Buttons
+* Callbacks
+* Paperclip Support
 
 == Example
 
@@ -189,8 +192,8 @@ Here's a list of options for the +act_wizardly_for+ controller macro
   :cancel => false
   :guard => false
   :mask_fields => [:password, :password_confirmation] (by default)
-  :persist_model => {:once|:per_page}
-  :form_data => {:sandbox|:session}
+  :persist_model => {:per_page|:once}
+  :form_data => {:session|:sandbox}
 
 Setting the :skip option to +true+ tells the scaffold helpers to include a skip button on each page.
 The :cancel option set to +false+ removes the 'cancel' button from the wizard views.
@@ -225,7 +228,7 @@ the application needs to navigate away and return to the wizard.
 The guarding behavior works a little differently depending on the :form_data setting.
 When :form_data is set to :session (the default behavior), guarding only occurs
 for the initial entry.  Once a user has entered the form and started it, while
-form data is being kept, the application may thereafter enter anywhere.  On the 
+form data is being kept, the application may thereafter enter anywhere.  On the
 contrary, if :form_data is set to :sandbox, entry is always guarded, and once the user
 leaves the wizard, entry may only occur at the initial page (as the form data has
 been reset).
@@ -233,13 +236,17 @@ been reset).
 ==== Persisting The Model
 
 The :persist_model option controls how the model is saved, either :once or :per_page.
-The default option :once, only saves the model when the wizard is completed, by the 
-user pressing a :finish button or :next button on the final page.  This method 
-prevents numerous incomplete models and possibly invalid models being saved to the
-database.
+The default setting :per_page, saves the model incrementally for each page that
+validates according to its validation group.  This setting may result in invalid and
+incomplete records in the database.
+
+This problem can be remedied by using the :once setting, in which case, form data is
+kept in the session until the wizard is complete and then saved out to the database.
 
-The other option setting, :per_page, saves the model incrementally for each time 
-the form data validates as the user moves through the pages.  
+The :once option does not work in all cases, particularly for any attribute that
+can not be marshalled and dumped in the session.  In particular, this will not work
+for forms with file uploads like any forms using Paperclip.  When using Paperclip, use
+the :per_page setting.
  
 
 === Buttons

data/lib/validation_group.rb

@@ -77,12 +77,17 @@ module ValidationGroup
         # jeffp: delete fields
         @current_validation_fields = nil
       end
+
+      def reject_non_validation_group_errors
+        return unless validation_group_enabled?
+        self.errors.remove_on(@current_validation_fields)
+      end
 			
       # jeffp: optimizer for someone writing custom :validate method -- no need
       # to validate fields outside the current validation group note: could also
       # use in validation modules to improve performance
       def should_validate?(attribute)
-	!self.validation_group_enabled? || (@current_validation_fields && @current_validation_fields.include?(attribute.to_sym))
+        !self.validation_group_enabled? || (@current_validation_fields && @current_validation_fields.include?(attribute.to_sym))
       end
 
       def validation_group_enabled?
@@ -105,6 +110,12 @@ module ValidationGroup
         add_error = @base.respond_to?(:should_validate?) ? @base.should_validate?(attribute.to_sym) : true
         add_without_validation_group(attribute, msg, *args, &block) if add_error
       end
+
+      def remove_on(attributes)
+        return unless attributes
+        attributes = [attributes] unless attributes.is_a?(Array)
+        @errors.reject!{|k,v| !attributes.include?(k.to_sym)}
+      end
 			
       def self.included(base) #:nodoc:
         base.class_eval do

data/lib/wizardly/wizard/configuration.rb

@@ -23,7 +23,7 @@ module Wizardly
         @include_cancel_button = opts.key?(:cancel) ? opts[:cancel] : true
         @guard_entry = opts.key?(:guard) ? opts[:guard] : true
         @password_fields = opts[:mask_fields] || opts[:mask_passwords] || [:password, :password_confirmation]
-        @persist_model = opts[:persist_model] || :once
+        @persist_model = opts[:persist_model] || :per_page
         @form_data = opts[:form_data] || :session
         raise(ArgumentError, ":persist_model option must be one of :once or :per_page", caller) unless [:once, :per_page].include?(@persist_model)
         raise(ArgumentError, ":form_data option must be one of :sandbox or :session", caller) unless [:sandbox, :session].include?(@form_data)

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

@@ -85,7 +85,6 @@ EVENTS
         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? ? "@#{self.model}.save_without_validation!" : ''
 
         (mb = StringIO.new) << <<-ONE
   def #{page.name}
@@ -94,8 +93,7 @@ EVENTS
       @wizard = wizard_config
       @title = '#{page.title}'
       @description = '#{page.description}'
-      h = (self.wizard_form_data||{}).merge(params[:#{self.model}] || {}) 
-      @#{self.model} = build_wizard_model(h)
+      _build_wizard_model
       if request.post? && callback_performs_action?(:_on_post_#{id}_form)
         raise CallbackError, "render or redirect not allowed in :on_post(:#{id}) callback", caller
       end
@@ -128,7 +126,6 @@ EVENTS
         complete_wizard unless @do_not_complete
         return
       end
-      #{model_persist_line}
       return if callback_performs_action?(:_on_#{id}_form_#{next_button})
       redirect_to :action=>:#{self.next_page(id)}
         THREE
@@ -139,7 +136,6 @@ EVENTS
         complete_wizard unless @do_not_complete
         return
       end
-      #{model_persist_line}
       return if callback_performs_action?(:_on_#{id}_form_#{next_button})
       redirect_to :action=>:#{self.next_page(id)}
         FOUR
@@ -147,7 +143,7 @@ EVENTS
         
         mb << <<-ENSURE
     ensure
-      self.wizard_form_data = h.merge(@#{self.model}.attributes) if (@#{self.model} && !@wizard_completed_flag)
+      _preserve_wizard_model
     end
   end        
 ENSURE
@@ -281,18 +277,36 @@ SANDBOX
     _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']))
-       begin
-        _model = #{self.model_class_name}.find(model_id) 
-        _model.attributes = params
-        return _model
-      rescue
+  def _build_wizard_model
+    if self.wizard_config.persist_model_per_page?
+      h = self.wizard_form_data
+      if (h && model_id = h['id'])
+          _model = #{self.model_class_name}.find(model_id)
+          _model.attributes = params[:#{self.model}]||{}
+          @#{self.model} = _model
+          return
       end
+      @#{self.model} = #{self.model_class_name}.new(params[:#{self.model}])
+    else # persist data in session or flash
+      h = (self.wizard_form_data||{}).merge(params[:#{self.model}] || {})
+      @#{self.model} = #{self.model_class_name}.new(h)
     end
-    #{self.model_class_name}.new(params)
   end
-  hide_action :build_wizard_model, :save_wizard_model!
+  def _preserve_wizard_model
+    return unless (@#{self.model} && !@wizard_completed_flag)
+    if self.wizard_config.persist_model_per_page?
+      @#{self.model}.save_without_validation!
+      if request.get?
+        @#{self.model}.errors.clear
+      else
+        @#{self.model}.reject_non_validation_group_errors
+      end
+      self.wizard_form_data = {'id'=>@#{self.model}.id}
+    else
+      self.wizard_form_data = @#{self.model}.attributes
+    end
+  end
+  hide_action :_build_wizard_model, :_preserve_wizard_model
 
   def initial_referer
     session[:#{self.initial_referer_key}]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jeffp-wizardly
 version: !ruby/object:Gem::Version 
-  version: 0.1.8.7
+  version: 0.1.8.8
 platform: ruby
 authors: 
 - Jeff Patmon
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-31 00:00:00 -07:00
+date: 2009-09-10 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -22,55 +22,56 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/validation_group.rb
+- lib/generators
 - lib/wizardly.rb
+- lib/validation_group.rb
+- lib/jeffp-wizardly.rb
 - lib/wizardly
-- lib/wizardly/action_controller.rb
+- lib/wizardly/wizard.rb
 - lib/wizardly/wizard
+- lib/wizardly/wizard/page.rb
 - lib/wizardly/wizard/configuration.rb
 - lib/wizardly/wizard/button.rb
+- lib/wizardly/wizard/utils.rb
+- lib/wizardly/wizard/dsl.rb
 - lib/wizardly/wizard/configuration
 - lib/wizardly/wizard/configuration/methods.rb
 - lib/wizardly/wizard/text_helpers.rb
-- lib/wizardly/wizard/utils.rb
-- lib/wizardly/wizard/page.rb
-- lib/wizardly/wizard/dsl.rb
-- lib/wizardly/wizard.rb
-- lib/jeffp-wizardly.rb
-- lib/generators
-- rails_generators/wizardly_controller
-- rails_generators/wizardly_controller/wizardly_controller_generator.rb
-- rails_generators/wizardly_controller/templates
-- rails_generators/wizardly_controller/templates/controller.rb.erb
-- rails_generators/wizardly_controller/templates/helper.rb.erb
-- rails_generators/wizardly_controller/USAGE
+- lib/wizardly/action_controller.rb
 - rails_generators/wizardly_app
-- rails_generators/wizardly_app/templates
-- rails_generators/wizardly_app/templates/wizardly.rake
 - rails_generators/wizardly_app/USAGE
 - rails_generators/wizardly_app/wizardly_app_generator.rb
+- rails_generators/wizardly_app/templates
+- rails_generators/wizardly_app/templates/wizardly.rake
 - rails_generators/wizardly_scaffold
 - rails_generators/wizardly_scaffold/wizardly_scaffold_generator.rb
+- rails_generators/wizardly_scaffold/USAGE
 - rails_generators/wizardly_scaffold/templates
+- rails_generators/wizardly_scaffold/templates/style.css
+- rails_generators/wizardly_scaffold/templates/form.html.haml.erb
+- rails_generators/wizardly_scaffold/templates/form.html.erb
+- rails_generators/wizardly_scaffold/templates/layout.html.haml.erb
+- rails_generators/wizardly_scaffold/templates/layout.html.erb
 - rails_generators/wizardly_scaffold/templates/images
-- rails_generators/wizardly_scaffold/templates/images/skip.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/finish.png
 - rails_generators/wizardly_scaffold/templates/images/back.png
-- rails_generators/wizardly_scaffold/templates/form.html.erb
-- rails_generators/wizardly_scaffold/templates/form.html.haml.erb
-- rails_generators/wizardly_scaffold/templates/style.css
+- rails_generators/wizardly_scaffold/templates/images/cancel.png
+- rails_generators/wizardly_scaffold/templates/images/skip.png
 - rails_generators/wizardly_scaffold/templates/helper.rb.erb
-- rails_generators/wizardly_scaffold/templates/layout.html.haml.erb
-- rails_generators/wizardly_scaffold/templates/layout.html.erb
-- rails_generators/wizardly_scaffold/USAGE
+- rails_generators/wizardly_controller
+- rails_generators/wizardly_controller/USAGE
+- rails_generators/wizardly_controller/wizardly_controller_generator.rb
+- rails_generators/wizardly_controller/templates
+- rails_generators/wizardly_controller/templates/controller.rb.erb
+- rails_generators/wizardly_controller/templates/helper.rb.erb
 - CHANGELOG.rdoc
 - init.rb
 - LICENSE
 - README.rdoc
 has_rdoc: false
 homepage: http://github.com/jeffp/wizardly/tree/master
+licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Produces controllers and wizard scaffolding for models with validation_groups