six-updater-web 0.10.8 → 0.11.1

data/lib/vendor/plugins/active_scaffold/lib/active_scaffold/helpers/form_column_helpers.rb

@@ -0,0 +1,484 @@
+module ActiveScaffold
+  module Helpers
+    # Helpers that assist with the rendering of a Form Column
+    module FormColumnHelpers
+      # This method decides which input to use for the given column.
+      # It does not do any rendering. It only decides which method is responsible for rendering.
+      # AST - (cf - verify_request), options param
+      def active_scaffold_input_for(column, scope = nil, options = {})
+        begin
+        # AST - (cf - verify_request), options
+        options = active_scaffold_input_options(column, scope, options)
+        options = javascript_for_update_column(column, scope, options)
+        # first, check if the dev has created an override for this specific field
+        if override_form_field?(column)
+          # AST - I like column and options as params
+          send(override_form_field(column), @record, column, options)
+        # second, check if the dev has specified a valid form_ui for this column
+        elsif column.form_ui and override_input?(column.form_ui)
+          send(override_input(column.form_ui), column, options)
+        # fallback: we get to make the decision
+        else
+          if column.association
+            # if we get here, it's because the column has a form_ui but not one ActiveScaffold knows about.
+            raise "Unknown form_ui `#{column.form_ui}' for column `#{column.name}'"
+          elsif column.virtual?
+            active_scaffold_input_virtual(column, options)
+
+          else # regular model attribute column
+            # if we (or someone else) have created a custom render option for the column type, use that
+            if override_input?(column.column.type)
+              send(override_input(column.column.type), column, options)
+            # final ultimate fallback: use rails' generic input method
+            else
+              # for textual fields we pass different options
+              text_types = [:text, :string, :integer, :float, :decimal]
+              options = active_scaffold_input_text_options(options) if text_types.include?(column.column.type)
+              if column.column.type == :string && options[:maxlength].blank?
+                options[:maxlength] = column.column.limit
+                options[:size] ||= ActionView::Helpers::InstanceTag::DEFAULT_FIELD_OPTIONS["size"]
+              end
+              options.update(:value => format_number_value(@record.send(column.name), column.options)) if column.column.number?
+              input(:record, column.name, options.merge(column.options)) + active_scaffold_observe(column, scope, options)
+            end
+          end
+        end
+        rescue Exception => e
+          logger.error Time.now.to_s + "#{e.inspect} -- on the ActiveScaffold column = :#{column.name} in #{@controller.class}"
+          raise e
+        end
+      end
+
+      alias form_column active_scaffold_input_for
+
+      # the standard active scaffold options used for textual inputs
+      def active_scaffold_input_text_options(options = {})
+        options[:autocomplete] = 'off'
+        options[:class] = "#{options[:class]} text-input".strip
+        options
+      end
+
+      # the standard active scaffold options used for class, name and scope
+      # AST - (cf - verify_request), options param
+      def active_scaffold_input_options(column, scope = nil, options = {})
+        # AST Begin - upper_case_form_fields
+        if active_scaffold_config.upper_case_form_fields and column.column and [:text, :string].include?(column.column.type) and column.form_ui.nil? and (!column.options.has_key?(:upper_case_form_fields) or column.options[:upper_case_form_fields] != false)
+          options[:onchange] ||= ''
+          options.merge!(:onchange => options[:onchange] + "ToUpper(this);") 
+        end
+        # Allow override of :class
+        options[:class] ||= "#{column.name}-input"
+        # AST End
+        name = scope ? "record#{scope}[#{column.name}]" : "record[#{column.name}]"
+
+        # Fix for keeping unique IDs in subform
+        id_control = "record_#{column.name}_#{[params[:eid], params[:id]].compact.join '_'}"
+        id_control += scope.gsub(/(\[|\])/, '_').gsub('__', '_').gsub(/_$/, '') if scope
+
+        # AST - cf - verify_request, options
+        { :name => name, :class => "#{column.name}-input", :id => id_control}.merge(options)
+      end
+      
+      def javascript_for_update_column(column, scope, options)
+        if column.options.is_a?(Hash) && column.options[:update_column]
+          form_action = :create
+          form_action = :update if params[:action] == 'edit'
+          url_params = {:action => 'render_field', :id => params[:id], :column => column.name, :update_column => column.options[:update_column]}
+          url_params[:eid] = params[:eid] if params[:eid]
+          url_params[:controller] = controller.class.active_scaffold_controller_for(@record.class).controller_path if scope
+          url_params[:scope] = params[:scope] if scope
+          ajax_options = {:method => :get, 
+                          :url => url_for(url_params), :with => "'value=' + this.value",
+                          :after => "$('#{loading_indicator_id(:action => :render_field, :id => params[:id])}').style.visibility = 'visible'; Form.disable('#{element_form_id(:action => form_action)}');",
+                          :complete => "$('#{loading_indicator_id(:action => :render_field, :id => params[:id])}').style.visibility = 'hidden'; Form.enable('#{element_form_id(:action => form_action)}');"}
+          options[:onchange] = "#{remote_function(ajax_options)};#{options[:onchange]}"
+        end
+        options
+      end
+
+      ##
+      ## Form input methods
+      ##
+
+      def active_scaffold_input_singular_association(column, html_options)
+        associated = @record.send(column.association.name)
+
+        select_options = options_for_association(column.association)
+        select_options.unshift([ associated.to_label, associated.id ]) unless associated.nil? or select_options.find {|label, id| id == associated.id}
+
+        selected = associated.nil? ? nil : associated.id
+        method = column.name
+        html_options[:name] += '[id]'
+        options = {:selected => selected, :include_blank => as_(:_select_)}
+
+        # For backwards compatibility, to add method options is needed to set a html_options hash
+        # in other case all column.options will be added as html options
+        if column.options[:html_options]
+          html_options.update(column.options[:html_options] || {})
+          options.update(column.options)
+        else
+          # AST - This message implies that config.columns[:column_name].options = {:html_options => {...}, ...} is required. Why?"
+          # Rails.logger.warn "ActiveScaffold: Column: (#{column.name}) Setting html options directly in a hash is deprecated for :select form_ui. Set the html options hash under html_options key, such as config.columns[:column_name].options = {:html_options => {...}, ...}"
+          html_options.update(column.options)
+        end
+        select(:record, method, select_options.uniq, options, html_options)
+      end
+
+      def active_scaffold_input_plural_association(column, options)
+        associated_options = @record.send(column.association.name).collect {|r| [r.to_label, r.id]}
+        select_options = associated_options | options_for_association(column.association)
+        return content_tag(:span, as_(:no_options), :id => options[:id]) if select_options.empty?
+
+        html = "<ul class=\"checkbox-list\" id=\"#{options[:id]}\">"
+
+        associated_ids = associated_options.collect {|a| a[1]}
+        select_options.each_with_index do |option, i|
+          label, id = option
+          this_name = "#{options[:name]}[#{i}][id]"
+          this_id = "#{options[:id]}_#{i}_id"
+          html << "<li>"
+          html << check_box_tag(this_name, id, associated_ids.include?(id), :id => this_id)
+          html << "<label for='#{this_id}'>"
+          html << label
+          html << "</label>"
+          html << "</li>"
+        end
+
+        html << '</ul>'
+        html << javascript_tag("new DraggableLists('#{options[:id]}')") if column.options[:draggable_lists]
+        html
+      end
+
+      def active_scaffold_input_select(column, html_options)
+        if column.singular_association?
+          active_scaffold_input_singular_association(column, html_options)
+        elsif column.plural_association?
+          active_scaffold_input_plural_association(column, html_options)
+        else
+          options = { :selected => @record.send(column.name) }
+          if column.options.is_a? Hash
+            options_for_select = column.options[:options]
+            html_options.update(column.options[:html_options] || {})
+            options.update(column.options)
+          else
+            Rails.logger.warn "ActiveScaffold: Setting the options array directly is deprecated for :select form_ui. Set the options array in a hash under options key, such as config.columns[:column_name].options = {:options => [...], ...}"
+            options_for_select = column.options
+          end
+          select(:record, column.name, options_for_select, options, html_options)
+        end
+      end
+
+      def active_scaffold_input_radio(column, html_options)
+        html_options.update(column.options[:html_options] || {})
+        column.options[:options].inject('') do |html, (text, value)|
+          value ||= text
+          html << content_tag(:label, radio_button(:record, column.name, value, html_options.merge(:id => html_options[:id] + '-' + value)) + text)
+        end
+      end
+
+      # only works for singular associations
+      # requires RecordSelect plugin to be installed and configured.
+      # ... maybe this should be provided in a bridge?
+      def active_scaffold_input_record_select(column, options)
+        unless column.association
+          raise ArgumentError, "record_select can only work against associations (and #{column.name} is not).  A common mistake is to specify the foreign key field (like :user_id), instead of the association (:user)."
+        end
+        remote_controller = active_scaffold_controller_for(column.association.klass).controller_path
+
+        # if the opposite association is a :belongs_to (in that case association in this class must be has_one or has_many)
+        # then only show records that have not been associated yet
+        if [:has_one, :has_many].include?(column.association.macro)
+          params.merge!({column.association.primary_key_name => ''})
+        end
+        
+        record_select_options = {:controller => remote_controller, :id => options[:id]}
+        record_select_options.merge!(active_scaffold_input_text_options)
+        record_select_options.merge!(column.options)
+
+        if column.singular_association?
+          record_select_field(options[:name], (@record.send(column.name) || column.association.klass.new), record_select_options)
+        elsif column.plural_association?
+          record_multi_select_field(options[:name], @record.send(column.name), record_select_options)
+        end   
+      end
+
+      def active_scaffold_input_checkbox(column, options)
+        check_box(:record, column.name, options)
+      end
+      
+      # AST active_scaffold_input_country
+      def active_scaffold_input_country(column, options)
+        priority = ["United States"]
+        select_options = {:prompt => as_('- select -')}
+        select_options.merge!(options)
+        country_select(:record, column.name, column.options[:priority] || priority, select_options, column.options)
+      end
+
+      def active_scaffold_input_password(column, options)
+        options = active_scaffold_input_text_options(options)
+        password_field :record, column.name, options.merge(column.options)
+      end
+
+      def active_scaffold_input_textarea(column, options)
+        text_area(:record, column.name, options.merge(:cols => column.options[:cols], :rows => column.options[:rows], :size => column.options[:size]))
+      end
+
+      # AST active_scaffold_input_usa_state
+      def active_scaffold_input_usa_state(column, options)
+        select_options = {:prompt => as_('- select -')}
+        select_options.merge!(options)
+        select_options.delete(:size)
+        options.delete(:prompt)
+        options.delete(:priority)
+        usa_state_select(:record, column.name, column.options[:priority], select_options, column.options.merge!(options))
+      end
+
+      def active_scaffold_input_virtual(column, options)
+        options = active_scaffold_input_text_options(options)
+        text_field :record, column.name, options.merge(column.options)
+      end
+
+      #
+      # Column.type-based inputs
+      #
+
+      def active_scaffold_input_boolean(column, options)
+        select_options = []
+        select_options << [as_(:_select_), nil] if column.column.null
+        select_options << [as_(:true), true]
+        select_options << [as_(:false), false]
+
+        select_tag(options[:name], options_for_select(select_options, @record.send(column.name)), options)
+      end
+
+      def onsubmit
+      end
+
+      ##
+      ## Form column override signatures
+      ##
+
+      # add functionality for overriding subform partials from association class path
+      def override_subform_partial?(column, subform_partial)
+        path, partial_name = partial_pieces(override_subform_partial(column, subform_partial))
+        template_exists?(File.join(path, "_#{partial_name}"))
+      end
+
+      def override_subform_partial(column, subform_partial)
+        File.join(active_scaffold_controller_for(column.association.klass).controller_path, subform_partial) if column_renders_as(column) == :subform
+      end
+
+      def override_form_field_partial?(column)
+        path, partial_name = partial_pieces(override_form_field_partial(column))
+        template_exists?(File.join(path, "_#{partial_name}"), true)
+      end
+
+      # the naming convention for overriding form fields with partials
+      def override_form_field_partial(column)
+        "#{column.name}_form_column"
+      end
+
+      def override_form_field?(column)
+        respond_to?(override_form_field(column))
+      end
+
+      # the naming convention for overriding form fields with helpers
+      def override_form_field(column)
+        "#{column.name}_form_column"
+      end
+
+      def override_input?(form_ui)
+        respond_to?(override_input(form_ui))
+      end
+
+      # the naming convention for overriding form input types with helpers
+      def override_input(form_ui)
+        "active_scaffold_input_#{form_ui}"
+      end
+
+      def form_partial_for_column(column)
+        if override_form_field_partial?(column)
+          override_form_field_partial(column)
+        elsif column_renders_as(column) == :field or override_form_field?(column)
+          "form_attribute"
+        elsif column_renders_as(column) == :subform
+          "form_association"
+        elsif column_renders_as(column) == :hidden
+          "form_hidden_attribute"
+        end
+      end
+
+      def subform_partial_for_column(column)
+        subform_partial = "#{active_scaffold_config_for(column.association.klass).subform.layout}_subform"
+        if override_subform_partial?(column, subform_partial)
+          override_subform_partial(column, subform_partial)
+        else
+          subform_partial
+        end
+      end
+
+      ##
+      ## Macro-level rendering decisions for columns
+      ##
+
+      def column_renders_as(column)
+        if column.is_a? ActiveScaffold::DataStructures::ActionColumns
+          return :subsection
+        elsif column.active_record_class.locking_column.to_s == column.name.to_s or column.form_ui == :hidden
+          return :hidden
+        elsif column.association.nil? or column.form_ui or !active_scaffold_config_for(column.association.klass).actions.include?(:subform)
+          return :field
+        else
+          return :subform
+        end
+      end
+
+      def is_subsection?(column)
+        column_renders_as(column) == :subsection
+      end
+
+      def is_subform?(column)
+        column_renders_as(column) == :subform
+      end
+
+      def column_scope(column)
+        if column.plural_association?
+          "[#{column.name}][#{@record.id || generate_temporary_id}]"
+        else
+          "[#{column.name}]"
+        end
+      end
+  
+  # AST Begin
+  def active_scaffold_add_existing_input(options)
+    if controller.respond_to?(:record_select_config)
+      remote_controller = active_scaffold_controller_for(record_select_config.model).controller_path
+      record_select_options = {:controller => remote_controller, :params => {:parent_model => record_select_config.model}}
+      record_select_options.merge!(active_scaffold_input_text_options)
+      record_select_field(options[:name], @record, record_select_options)
+      # record_select_field(
+      #   "#{options[:name]}",
+      #   active_scaffold_config.model.new,
+      #   {:controller => remote_controller, :params => options[:url_options].merge(:parent_model => record_select_config.model)}.merge(active_scaffold_input_text_options))        
+    else
+      # select_options = options_for_select(options_for_association(nested_association)) unless column.through_association?
+      select_options ||= options_for_select(active_scaffold_config.model.find(:all).collect {|c| [h(c.to_label), c.id]})
+      unless select_options.empty?
+        select_tag 'associated_id', '<option value="">' + as_(:_select_) + '</option>' + select_options
+      end  
+    end
+  end
+
+  def active_scaffold_add_existing_label
+    if controller.respond_to?(:record_select_config)
+      record_select_config.model.to_s.underscore.humanize
+    else
+      active_scaffold_config.model.to_s.underscore.humanize
+    end
+  end
+
+  def active_scaffold_observe(column, scope = nil, options = {})
+    if column.options[:observe_method]
+      action = @record.id ? :update : :create
+      href_options = {:action => column.options[:observe_method], :id => @record.id, :parent_id => params[:id], :scope => scope}
+      href_options[:controller] = column.options[:observe_controller] if column.options[:observe_controller]
+      return observe_field(active_scaffold_input_options(column, scope)[:id],
+                  :frequency => 0.2,
+                  :url => params_for(href_options), 
+                  :with => "Form.serialize('#{element_form_id(:action => action)}')+'&='" ) unless !column.options[:observe_restrict_actions].nil? and column.options[:observe_restrict_actions].include?(action)
+    end
+    ''
+  end
+
+  def active_scaffold_input_hidden(column, options)
+    input(:record, column.name, options.merge(:type => :hidden))
+  end
+
+  def active_scaffold_input_ssn(column, options)
+    column.description ||= as_(:ssn_example)
+    options = active_scaffold_input_text_options(options)
+    if @record.respond_to?("#{column.name}_for_human")
+      value = @record.send("#{column.name}_for_human")
+    else
+      value = usa_number_to_ssn(@record.send(column.name).to_s)
+    end
+    text_field :record, column.name, options.merge(
+                  :value => value,
+                  :onblur => "SsnDashAdd(this);return true;")
+  end
+  alias active_scaffold_input_social_security_number active_scaffold_input_ssn
+  
+  def active_scaffold_input_timezone(column, options)
+    time_zone_select(:record, column.name)
+  end
+
+  def active_scaffold_input_percentage(column, options)
+    column.description ||= as_(:percentage_example)
+    options[:onblur] ||= "PercentageFormat(this);return true;"
+    options = active_scaffold_input_text_options(options)
+    text_field :record, column.name, options.merge(:value => number_to_percentage(@record.send(column.name).to_s, :precision => 1))
+  end
+
+  # :usa_money requires some type casting help like the following in your Model
+  #
+  # def write_attribute(attr, value)
+  #   if column_for_attribute(attr).precision
+  #    value = BigDecimal(value.gsub(",", "").gsub("$", "")) if value.is_a?(String)
+  #   end
+  #   super
+  # end
+  def active_scaffold_input_usa_money(column, options)
+    column.description ||= as_(:usa_money_example)
+    options[:onblur] ||= "UsaMoney(this);return true;"
+    value = number_to_currency(@record.send(column.name).to_s) unless options[:blank_if_nil] == true
+    value ||= ""
+    options = active_scaffold_input_text_options(options)
+    text_field :record, column.name, options.merge(:value => value)
+  end
+
+  def active_scaffold_input_phone_number(column, options)
+    column.description ||= as_(:phone_example)
+    options[:onblur] ||= "PhoneDashAdd(this);return true;"
+    options = active_scaffold_input_text_options(options)
+    if @record.respond_to?("#{column.name}_for_human")
+      value = @record.send("#{column.name}_for_human")
+    else
+      value = usa_number_to_phone(@record.send(column.name).to_s)
+    end
+    text_field :record, column.name, options.merge(:value => value)
+  end
+
+  def active_scaffold_input_usa_zip_code(column, options)
+    column.description ||= as_(:usa_zip_example)
+    options[:onblur] ||= "UsaZipDashAdd(this);return true;"
+    options = active_scaffold_input_text_options(options)
+    if @record.respond_to?("#{column.name}_for_human")
+      value = @record.send("#{column.name}_for_human")
+    else
+      value = usa_number_to_zip(@record.send(column.name).to_s)
+    end
+    text_field :record, column.name, options.merge(:value => value)
+  end
+
+  def active_scaffold_input_yes_no_radio(column, options)
+    render :partial => '/yes_no_radio', :locals => {:column_name => column.name, :options => options}
+  end
+
+  def active_scaffold_input_true_false_radio(column, options)
+    render :partial => '/true_false_radio', :locals => {:column_name => column.name, :options => options, :question_text => column.description, :question_type => :yes_or_no}
+  end
+
+  def remote_image_submit_tag(source, options)
+    options[:with] ||= 'Form.serialize(this.form)'
+
+    options[:html] ||= {}
+    options[:html][:type] = 'image'
+    options[:html][:onclick] = "#{remote_function(options)}; return false;"
+    options[:html][:src] = image_path(source)
+
+    tag("input", options[:html], false)
+  end      
+  # AST End
+end
+  end
+end