active_scaffold_clarity 3.0.24.2

data/lib/active_scaffold/helpers/form_column_helpers.rb

@@ -0,0 +1,321 @@
+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.
+      def active_scaffold_input_for(column, scope = nil, options = {})
+        options = active_scaffold_input_options(column, scope, options)
+        options = update_columns_options(column, scope, options)
+        active_scaffold_render_input(column, options)
+      end
+
+      alias form_column active_scaffold_input_for
+
+      def active_scaffold_render_input(column, options)
+        begin
+          # first, check if the dev has created an override for this specific field
+          if override_form_field?(column)
+            send(override_form_field(column), @record, 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 column.form_ui.nil?
+                # its an association and nothing is specified, we will assume form_ui :select
+                active_scaffold_input_select(column, options)
+              else
+                # 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}'"
+              end
+            elsif column.virtual?
+              options[:value] = format_number_value(@record.send(column.name), column.options) if column.number?
+              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, :date, :time, :datetime]
+                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[:include_blank] = true if column.column.null and [:date, :datetime, :time].include?(column.column.type)
+                options[:value] = format_number_value(@record.send(column.name), column.options) if column.number?
+                text_field(:record, column.name, options.merge(column.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
+
+      # 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
+      def active_scaffold_input_options(column, scope = nil, options = {})
+        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
+
+        { :name => name, :class => "#{column.name}-input", :id => id_control}.merge(options)
+      end
+
+      def update_columns_options(column, scope, options)
+        if column.update_columns
+          form_action = params[:action] == 'edit' ? :update : :create
+          url_params = {:action => 'render_field', :id => params[:id], :column => column.name}
+          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] = scope if scope
+
+          options[:class] = "#{options[:class]} update_form".strip
+          options['data-update_url'] = url_for(url_params)
+          options['data-update_send_form'] = true if column.send_form_on_update_column
+        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_)}
+
+        html_options.update(column.options[:html_options] || {})
+        options.update(column.options)
+        html_options[:name] = "#{html_options[:name]}[]" if (html_options[:multiple] == true && !html_options[:name].to_s.ends_with?("[]"))
+        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?
+
+        active_scaffold_checkbox_list(column, select_options, associated_options.collect {|a| a[1]}, options)
+      end
+      
+      def active_scaffold_checkbox_list(column, select_options, associated_ids, options)
+        html = "<ul class=\"checkbox-list\" id=\"#{options[:id]}\">"
+        
+        select_options.each_with_index do |option, i|
+          label, id = option
+          this_id = "#{options[:id]}_#{i}_id"
+          html << content_tag(:li) do 
+            check_box_tag("#{options[:name]}[]", id, associated_ids.include?(id), :id => this_id) <<
+            content_tag(:label, h(label), :for => this_id)
+          end
+        end
+        html << '</ul>'
+        html << javascript_tag("new DraggableLists('#{options[:id]}')") if column.options[:draggable_lists]
+        html.html_safe
+      end
+
+      def active_scaffold_translated_option(column, text, value = nil)
+        value = text if value.nil?
+        [(text.is_a?(Symbol) ? column.active_record_class.human_attribute_name(text) : text), value]
+      end
+
+      def active_scaffold_input_enum(column, html_options)
+        options = { :selected => @record.send(column.name) }
+        options_for_select = column.options[:options].collect do |text, value|
+          active_scaffold_translated_option(column, text, value)
+        end
+        html_options.update(column.options[:html_options] || {})
+        options.update(column.options)
+        select(:record, column.name, options_for_select, options, html_options)
+      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
+          active_scaffold_input_enum(column, 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)|
+          text, value = active_scaffold_translated_option(column, text, value)
+          html << content_tag(:label, radio_button(:record, column.name, value, html_options.merge(:id => html_options[:id] + '-' + value.to_s)) + text)
+        end.html_safe
+      end
+
+      def active_scaffold_input_checkbox(column, options)
+        check_box(:record, column.name, 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
+      
+      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.virtual? && 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?(partial_name, path, true)
+      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?(partial_name, path, 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)
+        method_with_class = override_form_field_name(column, true)
+        return method_with_class if respond_to?(method_with_class)
+        method = override_form_field_name(column)
+        method if respond_to?(method)
+      end
+      alias_method :override_form_field?, :override_form_field
+
+      # the naming convention for overriding form fields with helpers
+      def override_form_field_name(column, class_prefix = false)
+        "#{clean_class_name(column.active_record_class.name) + '_' if class_prefix}#{clean_column_name(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, renders_as = nil)
+        renders_as ||= column_renders_as(column)
+        if override_form_field_partial?(column)
+          override_form_field_partial(column)
+        elsif renders_as == :field or override_form_field?(column)
+          "form_attribute"
+        elsif renders_as == :subform
+          "form_association"
+        elsif renders_as == :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 column_scope(column)
+        if column.plural_association?
+          "[#{column.name}][#{@record.id || generate_temporary_id}]"
+        else
+          "[#{column.name}]"
+        end
+      end
+
+      def active_scaffold_add_existing_input(options)
+        if ActiveScaffold.js_framework == :prototype && controller.respond_to?(:record_select_config)
+          remote_controller = active_scaffold_controller_for(record_select_config.model).controller_path
+          options.merge!(:controller => remote_controller)
+          options.merge!(active_scaffold_input_text_options)
+          record_select_field(options[:name], @record, 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.all.collect {|c| [h(c.to_label), c.id]})
+          select_tag 'associated_id', ('<option value="">' + as_(:_select_) + '</option>' + select_options).html_safe unless select_options.empty?
+        end
+      end
+
+      def active_scaffold_add_existing_label
+        if controller.respond_to?(:record_select_config)
+          record_select_config.model.model_name.human
+        else
+          active_scaffold_config.model.model_name.human
+        end
+      end
+    end
+  end
+end

data/lib/active_scaffold/helpers/human_condition_helpers.rb

@@ -0,0 +1,59 @@
+module ActiveScaffold
+  module Helpers
+    # Helpers that assist with rendering of a human readable search statement
+    module HumanConditionHelpers
+
+      def active_scaffold_human_condition_for(column)
+        value = field_search_params[column.name]
+        search_ui = column.search_ui
+        search_ui ||= column.column.type if column.column
+        if override_human_condition_column?(column)
+          send(override_human_condition_column(column), value, {})
+        elsif search_ui and override_human_condition?(column.search_ui)
+          send(override_human_condition(column.search_ui), column, value)
+        else
+          case search_ui
+          when :integer, :decimal, :float
+            "#{column.active_record_class.human_attribute_name(column.name)} #{as_(value[:opt].downcase).downcase} #{format_number_value(controller.class.condition_value_for_numeric(column, value[:from]), column.options)} #{value[:opt] == 'BETWEEN' ? '- ' + format_number_value(controller.class.condition_value_for_numeric(column, value[:to]), column.options).to_s : ''}"
+          when :string
+            opt = ActiveScaffold::Finder::StringComparators.index(value[:opt]) || value[:opt]
+            "#{column.active_record_class.human_attribute_name(column.name)} #{as_(opt).downcase} '#{value[:from]}' #{opt == 'BETWEEN' ? '- ' + value[:to].to_s : ''}"
+          when :date, :time, :datetime, :timestamp
+            conversion = column.column.type == :date ? :to_date : :to_time
+            from = controller.condition_value_for_datetime(value[:from], conversion)
+            to = controller.condition_value_for_datetime(value[:to], conversion)
+            "#{column.active_record_class.human_attribute_name(column.name)} #{as_(value[:opt])} #{I18n.l(from)} #{value[:opt] == 'BETWEEN' ? '- ' + I18n.l(to) : ''}"
+          when :select, :multi_select, :record_select
+            associated = value
+            associated = [associated].compact unless associated.is_a? Array
+            associated = column.association.klass.where(["id in (?)", associated.map(&:to_i)]).collect(&:to_label) if column.association
+            "#{column.active_record_class.human_attribute_name(column.name)} = #{associated.join(', ')}"
+          when :boolean, :checkbox
+            label = column.column.type_cast(value) ? as_(:true) : as_(:false)
+            "#{column.active_record_class.human_attribute_name(column.name)} = #{label}"
+          when :null
+            "#{column.active_record_class.human_attribute_name(column.name)} #{as_(value.to_sym)}"
+          end
+        end unless value.nil?
+      end
+
+      def override_human_condition_column?(column)
+        respond_to?(override_human_condition_column(column))
+      end
+
+      # the naming convention for overriding form fields with helpers
+      def override_human_condition_column(column)
+        "#{column.name}_human_condition_column"
+      end
+
+      def override_human_condition?(search_ui)
+        respond_to?(override_human_condition(search_ui))
+      end
+
+      # the naming convention for overriding human condition search_ui types
+      def override_human_condition(search_ui)
+        "active_scaffold_human_condition_#{search_ui}"
+      end
+    end
+  end
+end

data/lib/active_scaffold/helpers/id_helpers.rb

@@ -0,0 +1,127 @@
+module ActiveScaffold
+  module Helpers
+    # A bunch of helper methods to produce the common view ids
+    module IdHelpers
+      def id_from_controller(controller)
+        controller.to_s.gsub("/", "__")
+      end
+
+      def controller_id(controller = (params[:eid] || params[:parent_controller] || params[:controller]))
+        controller_id ||= 'as_' + id_from_controller(controller)
+      end
+
+      def active_scaffold_id
+        "#{controller_id}-active-scaffold"
+      end
+
+      def active_scaffold_content_id
+        "#{controller_id}-content"
+      end
+
+      def active_scaffold_tbody_id
+        "#{controller_id}-tbody"
+      end
+
+      def active_scaffold_messages_id(options = {})
+        "#{options[:controller_id] || controller_id}-messages"
+      end
+
+      def active_scaffold_calculations_id(column = nil)
+        "#{controller_id}-calculations#{'-' + column.name.to_s if column}"
+      end
+
+      def empty_message_id
+        "#{controller_id}-empty-message"
+      end
+
+      def before_header_id
+        "#{controller_id}-search-container"
+      end
+
+      def search_input_id
+        "#{controller_id}-search-input"
+      end
+
+      def table_action_id(name)
+        "#{controller_id}-action-table-#{name}"
+      end
+
+      def action_link_id(link_action,link_id)
+        "#{controller_id}-#{link_action}-#{link_id}-link"
+      end
+
+      def active_scaffold_column_header_id(column)
+        name = column.respond_to?(:name) ? column.name : column.to_s
+        clean_id "#{controller_id}-#{name}-column"
+      end
+
+      def element_row_id(options = {})
+        options[:action] ||= params[:action]
+        options[:id] ||= params[:id]
+        options[:id] ||= params[:parent_id]
+        clean_id "#{options[:controller_id] || controller_id}-#{options[:action]}-#{options[:id]}-row"
+      end
+
+      def element_cell_id(options = {})
+        options[:action] ||= params[:action]
+        options[:id] ||= params[:id]
+        options[:id] ||= params[:parent_id]
+        options[:name] ||= params[:name]
+        clean_id "#{controller_id}-#{options[:action]}-#{options[:id]}-#{options[:name]}-cell"
+      end
+
+      def element_form_id(options = {})
+        options[:action] ||= params[:action]
+        options[:id] ||= params[:id]
+        options[:id] ||= params[:parent_id]
+        clean_id "#{controller_id}-#{options[:action]}-#{options[:id]}-form"
+      end
+
+      def association_subform_id(column)
+        klass = column.association.klass.to_s.underscore
+        clean_id "#{controller_id}-associated-#{klass}"
+      end
+
+      def loading_indicator_id(options = {})
+        options[:action] ||= params[:action]
+        clean_id "#{controller_id}-#{options[:action]}-#{options[:id]}-loading-indicator"
+      end
+      
+      def sub_section_id(options = {})
+        options[:id] ||= params[:id]
+        options[:id] ||= params[:parent_id]
+        clean_id "#{controller_id}-#{options[:id]}-#{options[:sub_section]}-subsection"
+      end
+
+      def sub_form_id(options = {})
+        options[:id] ||= params[:id]
+        options[:id] ||= params[:parent_id]
+        clean_id "#{controller_id}-#{options[:id]}-#{options[:association]}-subform"
+      end
+      
+      def sub_form_list_id(options = {})
+        options[:id] ||= params[:id]
+        options[:id] ||= params[:parent_id]
+        clean_id "#{controller_id}-#{options[:id]}-#{options[:association]}-subform-list"
+      end
+
+      def element_messages_id(options = {})
+        options[:action] ||= params[:action]
+        options[:id] ||= params[:id]
+        options[:id] ||= params[:parent_id]
+        clean_id "#{controller_id}-#{options[:action]}-#{options[:id]}-messages"
+      end
+
+      def action_iframe_id(options)
+        "#{controller_id}-#{options[:action]}-#{options[:id]}-iframe"
+      end
+
+      private
+
+      # whitelists id-safe characters
+      def clean_id(val)
+        val.gsub /[^-_0-9a-zA-Z]/, '-'
+      end
+    end
+  end
+end