jeffp-wizardly 0.1.8.5 → 0.1.8.6

data/README.rdoc

@@ -533,16 +533,32 @@ The default button names can be customized in the +act_wizardly_for+ code block
   end
 
 With the above code, the 'Back' button will now be named 'Previous Page' and the 'Finish'
-button is renamed to the longer name 'Save and Return'.  Notice that symbols are used
+button is renamed to the longer name 'Save and Return'.
+
+Notice that symbols are used
 to determine the default button, but the customized name is passed.  A new symbol
 representing the change is created for each change, hence, for our buttons above :back
 is now referred to as :previous_page and :finish is now referred to as :save_and_return.
 
 === Action Callbacks for Customized Buttons
 
-Changing the name of a default button also changes the name of its callback macro.  
-For instance, the on_back() and on_finish() callback macros are replaced by the following
-for the above example
+Changing the name of a default button does not change the name of its callback macro.
+For instance, the renamed :back and :finish buttons above (to 'Previous Page' and 'Save and Return', respectively)
+still use the on_back() and on_finish() callback macros despite the name change.
+
+Perhaps though you want to change the symbol used to represent the button for consistancy
+across your MVC.  You can use the :id option when renaming to do so.
+
+  class UserSignupController < ApplicationController
+    act_wizardly_for :user, :redirect=>'/main/index' do
+      change_button(:back).name_to('Previous Page', :id=>:previous_page)
+      change_button(:finish).name_to('Save and Return', :id=>save_and_return)
+    end
+  end
+
+Coding the above causes the :back button's ID to be replaced with :previous_page and so forth
+for the :finish button.  Thereafter, each button is referred to with the new ID.  For instance,
+the corresponding callback macros would be
 
   on_previous_page(:step3) do
     ...
@@ -573,6 +589,13 @@ button must be defined by the on_help() callback macros for each and every page.
     end
   end
 
+Sometimes you may want to use the default ID given to the button.  You can specify the ID
+with the :id option.  This is particularly useful for international languages.
+
+  create_button('Helfen', :id=>:help)
+
+Now the help button will be called 'Helfen' in German and will be represented by :help in the code.
+
 === Setting Buttons for a Wizard Page
 
 Any new button needs to be explicitly added to every page it will show up on.  Each

data/lib/wizardly/wizard/button.rb

@@ -16,14 +16,12 @@ module Wizardly
       def user_defined?; @user_defined; end
 
       #used in the dsl
-      def name_to(name)
-        if name.is_a?(String)
-          @name = name.strip.squeeze(' ')
-          @id = button_name_to_symbol(name)
-        elsif name.is_a?(Symbol)
-          @id = name
-          @name = symbol_to_button_name(name)
+      def name_to(name, opts={})
+        case name
+        when String then @name = name.strip.squeeze(' ')
+        when Symbol then @name = symbol_to_button_name(name)
         end
+        @id = opts[:id] if (opts[:id] && opts[:id].is_a?(Symbol))
       end
     end
 

data/lib/wizardly/wizard/configuration.rb

@@ -126,13 +126,14 @@ module Wizardly
       def _when_completed_redirect_to(redir); @completed_redirect = redir; end
       def _when_canceled_redirect_to(redir); @canceled_redirect = redir; end
       def _change_button(name)
-        raise(WizardConfigurationError, "Button :#{name} in _change_button() call does not exist", caller) unless @default_buttons.key?(name)
-        @buttons = nil 
-        @default_buttons[name]
+        raise(WizardConfigurationError, "Button :#{name} in _change_button() call does not exist", caller) unless self.buttons.key?(name)
+        _buttons = self.buttons
+        @buttons = nil # clear the buttons for regeneration after change in next line
+        _buttons[name]
       end
-      def _create_button(name)
-        id = button_name_to_symbol(name)
-        raise(WizardConfigurationError, "Button '#{name}' with id :#{id} cannot be created. The ID already exists.", caller) if @default_buttons.key?(id)
+      def _create_button(name, opts)
+        id = opts[:id] || button_name_to_symbol(name)
+        raise(WizardConfigurationError, "Button '#{name}' with id :#{id} cannot be created. The ID already exists.", caller) if self.buttons.key?(id)
         @buttons=nil
         @default_buttons[id] = UserDefinedButton.new(id, name)
       end

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

@@ -279,7 +279,7 @@ SANDBOX
     redirect_to redirect if (redirect && !self.performed?)
     return if @wizard_completed_flag
     _on_wizard_#{finish_button}
-    redirect_to #{Utils.formatted_redirect(self.completed_redirect)} unless self.performed?
+    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']))
@@ -348,14 +348,20 @@ SANDBOX
 
   def check_action_for_button
     button_id = nil
-    #check if params[:commit] has returned a button from submit_tag
-    unless (params[:commit] == nil)
-      button_name = underscore_button_name(params[:commit])
-      unless [:#{next_id}, :#{finish_id}].include?(button_id = button_name.to_sym) 
-        action_method_name = "_on_" + params[:action].to_s + "_form_" + button_name
+    case 
+    when params[:commit]
+      button_name = params[:commit]
+      button_id = underscore_button_name(button_name).to_sym
+    when ((b_ar = self.wizard_config.buttons.find{|k,b| params[k]}) && params[b_ar.first] == b_ar.last.name)
+      button_name = b_ar.last.name
+      button_id = b_ar.first
+    end
+    if button_id
+      unless [:#{next_id}, :#{finish_id}].include?(button_id) 
+        action_method_name = "_on_" + params[:action].to_s + "_form_" + button_id.to_s
         callback_performs_action?(action_method_name)
         unless ((btn_obj = self.wizard_config.buttons[button_id]) == nil || btn_obj.user_defined?)
-          method_name = "_on_wizard_" + button_name
+          method_name = "_on_wizard_" + button_id.to_s
           if (self.method(method_name))
             self.__send__(method_name)
           else
@@ -364,25 +370,24 @@ SANDBOX
         end
       end
     end
-    #add other checks here or above
     button_id
   end
   hide_action :check_action_for_button
 
-  @wizard_callbacks ||= {}
+  @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
+    return false if cache.include?(methId)
+
+    begin
+      self.send(methId)
+    rescue NoMethodError
+      cache << methId
+      return false
     end
-    self.method(methId).call
+    
     self.performed?
   end
   hide_action :callback_performs_action?

data/lib/wizardly/wizard/dsl.rb

@@ -12,8 +12,8 @@ module Wizardly
       def change_button(name)
         @config._change_button(name)
       end
-      def create_button(name)
-        @config._create_button(name)
+      def create_button(name, opts)
+        @config._create_button(name, opts)
       end
       def set_page(name); 
         @config._set_page(name)

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

@@ -6,7 +6,7 @@ module <%=controller_name.camelize %>Helper
     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)
+        io << submit_tag(button.name, :name=>button.id.to_s)
       end.string
     end
     @@wizardly_submit[step_id]
@@ -18,9 +18,9 @@ module <%=controller_name.camelize %>Helper
     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
+        opts[:name] = button.id.to_s
         io << image_submit_tag("#{asset_dir}#{button.id}.png", opts)
       end.string
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jeffp-wizardly
 version: !ruby/object:Gem::Version 
-  version: 0.1.8.5
+  version: 0.1.8.6
 platform: ruby
 authors: 
 - Jeff Patmon
@@ -71,7 +71,6 @@ files:
 - README.rdoc
 has_rdoc: false
 homepage: http://github.com/jeffp/wizardly/tree/master
-licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -92,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Produces controllers and wizard scaffolding for models with validation_groups