active_scaffold 3.0.0

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.find(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,131 @@
+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_id ||= 'as_' + id_from_controller(params[:eid] || params[:parent_controller] || params[: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
+        "#{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_form_id
+        "#{controller_id}-search-form"
+      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 "#{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

data/lib/active_scaffold/helpers/list_column_helpers.rb

@@ -0,0 +1,363 @@
+# coding: utf-8
+module ActiveScaffold
+  module Helpers
+    # Helpers that assist with the rendering of a List Column
+    module ListColumnHelpers
+      def get_column_value(record, column)
+        begin
+          # check for an override helper
+          value = if column_override? column
+            # we only pass the record as the argument. we previously also passed the formatted_value,
+            # but mike perham pointed out that prohibited the usage of overrides to improve on the
+            # performance of our default formatting. see issue #138.
+            send(column_override(column), record)
+          # second, check if the dev has specified a valid list_ui for this column
+          elsif column.list_ui and override_column_ui?(column.list_ui)
+            send(override_column_ui(column.list_ui), column, record)
+          elsif column.column and override_column_ui?(column.column.type)
+            send(override_column_ui(column.column.type), column, record)
+          else
+            format_column_value(record, column)
+          end
+
+          value = ' '.html_safe if value.nil? or (value.respond_to?(:empty?) and value.empty?) # fix for IE 6
+          return value
+        rescue Exception => e
+          logger.error Time.now.to_s + "#{e.inspect} -- on the ActiveScaffold column = :#{column.name} in #{controller.class}"
+          raise e
+        end
+      end
+
+      # TODO: move empty_field_text and   logic in here?
+      # TODO: we need to distinguish between the automatic links *we* create and the ones that the dev specified. some logic may not apply if the dev specified the link.
+      def render_list_column(text, column, record)
+        if column.link
+          link = column.link
+          associated = record.send(column.association.name) if column.association
+          url_options = params_for(:action => nil, :id => record.id, :link => text)
+
+          # setup automatic link
+          if column.autolink? && column.singular_association? # link to inline form
+            link = action_link_to_inline_form(column, record, associated)
+            return text if link.crud_type.nil?
+            url_options[:link] = as_(:create_new) if link.crud_type == :create
+          end
+
+          # check authorization
+          if column.association
+            associated_for_authorized = if associated.nil? || (associated.respond_to?(:empty?) && associated.empty?)
+              column.association.klass
+            elsif column.plural_association?
+              associated.first
+            else
+              associated
+            end
+            authorized = associated_for_authorized.authorized_for?(:crud_type => link.crud_type)
+            authorized = authorized and record.authorized_for?(:crud_type => :update, :column => column.name) if link.crud_type == :create
+          else
+            authorized = record.authorized_for?(:crud_type => link.crud_type)
+          end
+          # to make html render properly
+          return "<a class='disabled'>#{text}</a>".html_safe unless authorized
+          render_action_link(link, url_options, record)
+        else
+          text = active_scaffold_inplace_edit(record, column, {:formatted_column => text}) if inplace_edit?(record, column)
+          text
+        end
+      end
+
+      # setup the action link to inline form
+      def action_link_to_inline_form(column, record, associated)
+        link = column.link.clone
+        if column.polymorphic_association?
+          polymorphic_controller = polymorphic_controller_for_nested_link(column, record)
+          return link if polymorphic_controller.nil?
+          link.controller = polymorphic_controller
+        end
+
+        if column_empty?(associated) # if association is empty, we only can link to create form
+          if column.actions_for_association_links.include?(:new)
+            link.action = 'new'
+            link.crud_type = :create
+          end
+        elsif column.actions_for_association_links.include?(:edit)
+          link.action = 'edit'
+          link.crud_type = :update
+        elsif column.actions_for_association_links.include?(:show)
+          link.action = 'show'
+          link.crud_type = :read
+        elsif column.actions_for_association_links.include?(:list)
+          link.parameters[:id] = record.send(column.association.name).id
+          link.action = 'index'
+          link.crud_type = :read
+        end
+        link
+      end
+
+      def polymorphic_controller_for_nested_link(column, record)
+        begin
+          controller = active_scaffold_controller_for(record.send(column.association.name).class)
+          controller.controller_path
+        rescue ActiveScaffold::ControllerNotFound
+          controller = nil
+        end
+      end
+
+      # There are two basic ways to clean a column's value: h() and sanitize(). The latter is useful
+      # when the column contains *valid* html data, and you want to just disable any scripting. People
+      # can always use field overrides to clean data one way or the other, but having this override
+      # lets people decide which way it should happen by default.
+      #
+      # Why is it not a configuration option? Because it seems like a somewhat rare request. But it
+      # could eventually be an option in config.list (and config.show, I guess).
+      def clean_column_value(v)
+        h(v)
+      end
+
+      ##
+      ## Overrides
+      ##
+      def active_scaffold_column_text(column, record)
+        truncate(clean_column_value(record.send(column.name)), :length => column.options[:truncate] || 50)
+      end
+
+      def active_scaffold_column_select(column, record)
+        if column.association
+          format_column_value(record, column)
+        else
+          value = record.send(column.name)
+          text, val = column.options[:options].find {|text, val| (val || text).to_s == value}
+          value = active_scaffold_translated_option(column, text, val).first if text
+          format_column_value(record, column, value)
+        end
+      end
+
+      def active_scaffold_column_checkbox(column, record)
+        options = {:disabled => true, :id => nil, :object => record}
+        options.delete(:disabled) if inplace_edit?(record, column)
+        check_box(:record, column.name, options)
+      end
+
+      def column_override(column)
+        "#{column.name.to_s.gsub('?', '')}_column" # parse out any question marks (see issue 227)
+      end
+
+      def column_override?(column)
+        respond_to?(column_override(column))
+      end
+
+      def override_column_ui?(list_ui)
+        respond_to?(override_column_ui(list_ui))
+      end
+
+      # the naming convention for overriding column types with helpers
+      def override_column_ui(list_ui)
+        "active_scaffold_column_#{list_ui}"
+      end
+
+      ##
+      ## Formatting
+      ##
+      def format_column_value(record, column, value = nil)
+        value ||= record.send(column.name) unless record.nil?
+        if value && column.association # cache association size before calling column_empty?
+          associated_size = value.size if column.plural_association? and column.associated_number? # get count before cache association
+          cache_association(value, column)
+        end
+        if column.association.nil? or column_empty?(value)
+          if value.is_a? Numeric
+            format_number_value(value, column.options)
+          else
+            format_value(value, column.options)
+          end
+        else
+          format_association_value(value, column, associated_size)
+        end
+      end
+
+      def format_number_value(value, options = {})
+        value = case options[:format]
+          when :size
+            number_to_human_size(value, options[:i18n_options] || {})
+          when :percentage
+            number_to_percentage(value, options[:i18n_options] || {})
+          when :currency
+            number_to_currency(value, options[:i18n_options] || {})
+          when :i18n_number
+            send("number_with_#{value.is_a?(Integer) ? 'delimiter' : 'precision'}", value, options[:i18n_options] || {})
+          else
+            value
+        end
+        clean_column_value(value)
+      end
+
+      def format_association_value(value, column, size)
+        case column.association.macro
+          when :has_one, :belongs_to
+            if column.polymorphic_association?
+              format_value("#{value.class.model_name.human}: #{value.to_label}")
+            else
+              format_value(value.to_label)
+            end
+          when :has_many, :has_and_belongs_to_many
+            if column.associated_limit.nil?
+              firsts = value.collect { |v| v.to_label }
+            else
+              firsts = value.first(column.associated_limit)
+              firsts.collect! { |v| v.to_label }
+              firsts[column.associated_limit] = '…' if value.size > column.associated_limit
+            end
+            if column.associated_limit == 0
+              size if column.associated_number?
+            else
+              joined_associated = format_value(firsts.join(', '))
+              joined_associated << " (#{size})" if column.associated_number? and column.associated_limit and value.size > column.associated_limit
+              joined_associated
+            end
+        end
+      end
+
+      def format_value(column_value, options = {})
+        value = if column_empty?(column_value)
+          active_scaffold_config.list.empty_field_text
+        elsif column_value.is_a?(Time) || column_value.is_a?(Date)
+          l(column_value, :format => options[:format] || :default)
+        elsif [FalseClass, TrueClass].include?(column_value.class)
+          as_(column_value.to_s.to_sym)
+        else
+          column_value.to_s
+        end
+        clean_column_value(value)
+      end
+
+      def cache_association(value, column)
+        # we are not using eager loading, cache firsts records in order not to query the database in a future
+        unless value.loaded?
+          # load at least one record, is needed for column_empty? and checking permissions
+          if column.associated_limit.nil?
+            Rails.logger.warn "ActiveScaffold: Enable eager loading for #{column.name} association to reduce SQL queries"
+          else
+            value.target = value.find(:all, :limit => column.associated_limit + 1, :select => column.select_columns)
+          end
+        end
+      end
+
+      # ==========
+      # = Inline Edit =
+      # ==========
+
+      def inplace_edit?(record, column)
+        if column.inplace_edit
+          editable = controller.send(:update_authorized?, record) if controller.respond_to?(:update_authorized?)
+          editable = record.authorized_for?(:action => :update, :column => column.name) if editable.nil? || editable == true
+          editable
+        end
+      end
+
+      def inplace_edit_cloning?(column)
+         column.inplace_edit != :ajax and (override_form_field?(column) or column.form_ui or (column.column and override_input?(column.column.type)))
+      end
+
+      def format_inplace_edit_column(record,column)
+        if column.list_ui == :checkbox
+          active_scaffold_column_checkbox(column, record)
+        else
+          format_column_value(record, column)
+        end
+      end
+
+      def active_scaffold_inplace_edit(record, column, options = {})
+        formatted_column = options[:formatted_column] || format_column_value(record, column)
+        id_options = {:id => record.id.to_s, :action => 'update_column', :name => column.name.to_s}
+        tag_options = {:id => element_cell_id(id_options), :class => "in_place_editor_field",
+                       :title => as_(:click_to_edit), 'data-ie_id' => record.id.to_s}
+
+        content_tag(:span, formatted_column, tag_options)
+      end
+
+      def inplace_edit_control(column)
+        if inplace_edit?(active_scaffold_config.model, column) and inplace_edit_cloning?(column)
+          @record = active_scaffold_config.model.new
+          column = column.clone
+          column.options = column.options.clone
+          column.form_ui = :select if (column.association && column.form_ui.nil?)
+          content_tag(:div, active_scaffold_input_for(column), {:style => "display:none;", :class => inplace_edit_control_css_class})
+        end
+      end
+
+      def inplace_edit_control_css_class
+        "as_inplace_pattern"
+      end
+
+      def inplace_edit_tag_attributes(column)
+        tag_options = {}
+        tag_options['data-ie_url'] = url_for({:controller => params_for[:controller], :action => "update_column", :column => column.name, :id => '__id__'})
+        tag_options['data-ie_cancel_text'] = column.options[:cancel_text] || as_(:cancel)
+        tag_options['data-ie_loading_text'] = column.options[:loading_text] || as_(:loading)
+        tag_options['data-ie_save_text'] = column.options[:save_text] || as_(:update)
+        tag_options['data-ie_saving_text'] = column.options[:saving_text] || as_(:saving)
+        tag_options['data-ie_rows'] = column.options[:rows] || 5 if column.column.try(:type) == :text
+        tag_options['data-ie_cols'] = column.options[:cols] if column.options[:cols]
+        tag_options['data-ie_size'] = column.options[:size] if column.options[:size]
+
+        if column.list_ui == :checkbox
+          tag_options['data-ie_mode'] = :inline_checkbox
+        elsif inplace_edit_cloning?(column)
+          tag_options['data-ie_mode'] = :clone
+        elsif column.inplace_edit == :ajax
+          url = url_for(:controller => params_for[:controller], :action => 'render_field', :id => '__id__', :column => column.name, :update_column => column.name, :in_place_editing => true, :escape => false)
+          plural = column.plural_association? && !override_form_field?(column) && [:select, :record_select].include?(column.form_ui)
+          tag_options['data-ie_render_url'] = url
+          tag_options['data-ie_mode'] = :ajax
+          tag_options['data-ie_plural'] = plural
+        end
+        tag_options
+      end
+
+      def mark_column_heading
+        all_marked = (marked_records.length >= @page.pager.count)
+        tag_options = {:id => "#{controller_id}_mark_heading", :class => "mark_heading in_place_editor_field"}
+        tag_options['data-ie_url'] = url_for({:controller => params_for[:controller], :action => 'mark_all', :eid => params[:eid]})
+        content_tag(:span, check_box_tag(nil, !all_marked, all_marked), tag_options)
+      end
+
+      def render_column_heading(column, sorting, sort_direction)
+        tag_options = {:id => active_scaffold_column_header_id(column), :class => column_heading_class(column, sorting), :title => column.description}
+        tag_options.merge!(inplace_edit_tag_attributes(column)) if column.inplace_edit
+        content_tag(:th, column_heading_value(column, sorting, sort_direction) + inplace_edit_control(column), tag_options)
+      end
+
+
+      def column_heading_value(column, sorting, sort_direction)
+        if column.sortable?
+          options = {:id => search_form_id, :class => "as_sort",
+                     'data-page-history' => controller_id,
+                     :remote => true, :method => :get}
+          url_options = params_for(:action => :index, :page => 1,
+                           :sort => column.name, :sort_direction => sort_direction)
+          link_to column.label, url_options, options
+        else
+          if column.name != :marked
+            content_tag(:p, column.label)
+          else
+            mark_column_heading
+          end
+        end
+      end
+      
+      def render_nested_view(action_links, url_options, record)
+        rendered = []
+        action_links.each do |link| 
+          if link.nested_link? && link.column && @nested_auto_open[link.column.name] && @records.length <= @nested_auto_open[link.column.name] && respond_to?(:render_component) 
+            link_url_options = {:adapter => '_list_inline_adapter', :format => :js}.merge(action_link_url_options(link, url_options, record, options = {:reuse_eid => true})) 
+            link_id = get_action_link_id(link_url_options, record, link.column)
+            rendered << (render_component(link_url_options) + javascript_tag("ActiveScaffold.ActionLink.get('#{link_id}').set_opened();"))
+          end 
+        end
+        rendered.join(' ').html_safe
+      end  
+      
+    end
+  end
+end
+