active_scaffold 3.0.23 → 3.0.24

data/lib/active_scaffold/helpers/list_column_helpers.rb~

@@ -0,0 +1,368 @@
+# 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)
+
+          # setup automatic link
+          if column.autolink? && column.singular_association? # link to inline form
+            link = action_link_to_inline_form(column, record, associated, text)
+            return text if link.nil?
+          else
+            url_options[:link] = text
+          end
+
+          if column_link_authorized?(link, column, record, associated)
+            render_action_link(link, url_options, record)
+          else
+            "<a class='disabled'>#{text}</a>".html_safe
+          end
+        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, text)
+        link = column.link.clone
+        link.label = text
+        if column.polymorphic_association?
+          polymorphic_controller = controller_path_for_activerecord(record.send(column.association.name).class)
+          return link if polymorphic_controller.nil?
+          link.controller = polymorphic_controller
+        end
+        configure_column_link(link, associated, column.actions_for_association_links)
+      end
+
+      def configure_column_link(link, associated, actions)
+        if column_empty?(associated) # if association is empty, we only can link to create form
+          if actions.include?(:new)
+            link.action = 'new'
+            link.crud_type = :create
+            link.label = as_(:create_new)
+          end
+        elsif actions.include?(:edit)
+          link.action = 'edit'
+          link.crud_type = :update
+        elsif actions.include?(:show)
+          link.action = 'show'
+          link.crud_type = :read
+        elsif actions.include?(:list)
+          link.action = 'index'
+          link.crud_type = :read
+        end
+        link if link.crud_type.present?
+      end
+
+      def column_link_authorized?(link, column, record, associated)
+        if column.association
+          associated_for_authorized = if associated.nil? || (associated.respond_to?(:blank?) && associated.blank?)
+            column.association.klass
+          elsif [:has_many, :has_and_belongs_to_many].include? column.association.macro
+            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
+          authorized
+        else
+          record.authorized_for?(:crud_type => link.crud_type)
+        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_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_name(column, class_prefix = false)
+        "#{clean_class_name(column.active_record_class.name) + '_' if class_prefix}#{clean_column_name(column.name)}_column"
+      end
+
+      def column_override(column)
+        method_with_class = column_override_name(column, true)
+        return method_with_class if respond_to?(method_with_class)
+        method = column_override_name(column)
+        method if respond_to?(method)
+      end
+      alias_method :column_override?, :column_override
+
+      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) if column.plural_association?
+        end
+        if column.association.nil? or column_empty?(value)
+          if column.form_ui == :select && column.options[:options]
+            text, val = column.options[:options].find {|text, val| (val.nil? ? text : val).to_s == value.to_s}
+            value = active_scaffold_translated_option(column, text, val).first if text
+          end
+          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
+            number_with_delimiter(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| clean_column_value(v.to_label) }
+            else
+              firsts = value.first(column.associated_limit)
+              firsts.collect! { |v| clean_column_value(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(active_scaffold_config.list.association_join_text))
+              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?(:crud_type => :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 = new_model
+          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
+        if active_scaffold_config.mark.mark_all_mode == :page then
+          all_marked = true
+          @page.items.each do |record|
+            all_marked = false if !marked_records.entries.include?(record.id)
+          end
+        else
+          all_marked = (marked_records.length >= @page.pager.count)
+        end
+        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("#{controller_id}_mark_heading_span_input", !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 => nil, :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.member.each do |link|
+          if link.nested_link? && link.column && @nested_auto_open[link.column.name] && @records.length <= @nested_auto_open[link.column.name] && controller.respond_to?(:render_component_into_view)
+            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 << (controller.send(:render_component_into_view, link_url_options) + javascript_tag("ActiveScaffold.ActionLink.get('#{link_id}').set_opened();"))
+          end 
+        end
+        rendered.join(' ').html_safe
+      end  
+      
+    end
+  end
+end
+

data/lib/active_scaffold/helpers/search_column_helpers.rb~

@@ -40,7 +40,7 @@ module ActiveScaffold
               # 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)
-              input(:record, column.name, options.merge(column.options))
+              text_field(:record, column.name, options.merge(column.options))
             end
           end
         end
@@ -59,37 +59,26 @@ module ActiveScaffold
         associated = options.delete :value
         associated = [associated].compact unless associated.is_a? Array
         associated.collect!(&:to_i)
-        select_options = options_for_association(column.association, true)
-        return as_(:no_options) if select_options.empty?
-
-        html = "<ul class=\"checkbox-list\" id=\"#{options[:id]}\">"
-
-        options[:name] += '[]'
-        select_options.each_with_index do |option, i|
-          label, id = option
-          this_id = "#{options[:id]}_#{i}_id"
-          html << "<li>"
-          html << check_box_tag(options[:name], id, associated.include?(id), :id => this_id)
-          html << "<label for='#{this_id}'>"
-          html << label
-          html << "</label>"
-          html << "</li>"
+        
+        if column.association
+          select_options = options_for_association(column.association, false)
+        else
+          select_options = Array(column.options[:options])
         end
+        return as_(:no_options) if select_options.empty?
 
-        html << '</ul>'
-        html << javascript_tag("new DraggableLists('#{options[:id]}')") if column.options[:draggable_lists]
-        html
+        active_scaffold_checkbox_list(column, select_options, associated, options)
       end
 
       def active_scaffold_search_select(column, html_options)
         associated = html_options.delete :value
         if column.association
           associated = associated.is_a?(Array) ? associated.map(&:to_i) : associated.to_i unless associated.nil?
-          method = column.association.macro == :belongs_to ? column.association.primary_key_name : column.name
-          options_for_select = options_for_association(column.association, true)
+          method = column.association.macro == :belongs_to ? column.association.foreign_key : column.name
+          select_options = options_for_association(column.association, true)
         else
           method = column.name
-          options_for_select = active_scaffold_translated_options(column)
+          select_options = Array(column.options[:options])
         end
 
         options = { :selected => associated }.merge! column.options
@@ -118,11 +107,43 @@ module ActiveScaffold
       end
       # we can't use checkbox ui because it's not possible to decide whether search for this field or not
       alias_method :active_scaffold_search_checkbox, :active_scaffold_search_boolean
+      
+      def active_scaffold_search_null(column, options)
+        select_options = []
+        select_options << [as_(:_select_), nil]
+        select_options.concat ActiveScaffold::Finder::NullComparators.collect {|comp| [as_(comp), comp]}
+        select_tag(options[:name], options_for_select(select_options, field_search_params[column.name]))
+      end
 
       def field_search_params_range_values(column)
         values = field_search_params[column.name]
         return nil if values.nil?
-        return values[:opt], values[:from], values[:to]
+        return values[:opt], (values[:from].blank? ? nil : values[:from]), (values[:to].blank? ? nil : values[:to])
+        
+      end
+
+      def active_scaffold_search_range_string?(column)
+        (column.column && column.column.text?) || column.search_ui == :string
+      end
+
+      def include_null_comparators?(column)
+        return column.options[:null_comparators] if column.options.has_key? :null_comparators
+        if column.association
+          column.association.macro != :belongs_to || active_scaffold_config.columns[column.association.primary_key_name].column.try(:null)
+        else
+          column.column.try(:null)
+        end
+      end
+
+      def active_scaffold_search_range_comparator_options(column)
+        select_options = ActiveScaffold::Finder::NumericComparators.collect {|comp| [as_(comp.downcase.to_sym), comp]}
+        if active_scaffold_search_range_string?(column)
+          select_options.unshift *ActiveScaffold::Finder::StringComparators.collect {|title, comp| [as_(title), comp]}
+        end
+        if include_null_comparators? column
+          select_options += ActiveScaffold::Finder::NullComparators.collect {|comp| [as_(comp), comp]}
+        end
+        select_options
       end
 
       def include_null_comparators?(column)
@@ -136,20 +157,29 @@ module ActiveScaffold
 
       def active_scaffold_search_range(column, options)
         opt_value, from_value, to_value = field_search_params_range_values(column)
-        select_options = ActiveScaffold::Finder::NumericComparators.collect {|comp| [as_(comp.downcase.to_sym), comp]}
-        select_options.unshift *ActiveScaffold::Finder::StringComparators.collect {|title, comp| [as_(title), comp]} if column.options[:string_comparators] || column.column.try(:text?)
-        select_options += ActiveScaffold::Finder::NullComparators.collect {|comp| [as_(comp.downcase.to_sym), comp]} if include_null_comparators? column
 
-        html = []
-        html << select_tag("#{options[:name]}[opt]",
+        select_options = active_scaffold_search_range_comparator_options(column)
+        if active_scaffold_search_range_string?(column)
+          text_field_size = 15
+          opt_value ||= '%?%'
+        else
+          text_field_size = 10
+          opt_value ||= '='
+        end
+        
+        from_value = controller.class.condition_value_for_numeric(column, from_value)
+        to_value = controller.class.condition_value_for_numeric(column, to_value)
+        from_value = format_number_value(from_value, column.options) if from_value.is_a?(Numeric)
+        to_value = format_number_value(to_value, column.options) if to_value.is_a?(Numeric)
+        html = select_tag("#{options[:name]}[opt]",
               options_for_select(select_options, opt_value),
               :id => "#{options[:id]}_opt",
-              :onchange => "Element[this.value == 'BETWEEN' ? 'show' : 'hide']('#{options[:id]}_between');")
-        html << text_field_tag("#{options[:name]}[from]", from_value, active_scaffold_input_text_options(:id => options[:id], :size => 10))
-        html << content_tag(:span, ' - ' + text_field_tag("#{options[:name]}[to]", to_value,
-              active_scaffold_input_text_options(:id => "#{options[:id]}_to", :size => 10)),
-              :id => "#{options[:id]}_between", :style => "display:none")
-        html * ' '
+              :class => "as_search_range_option")
+        html << ' ' << text_field_tag("#{options[:name]}[from]", from_value, active_scaffold_input_text_options(:id => options[:id], :size => text_field_size))
+        html << ' ' << content_tag(:span, (' - ' + text_field_tag("#{options[:name]}[to]", to_value,
+              active_scaffold_input_text_options(:id => "#{options[:id]}_to", :size => text_field_size))).html_safe,
+              :id => "#{options[:id]}_between", :class => "as_search_range_between", :style => "display:#{(opt_value == 'BETWEEN') ? '' : 'none'}")
+        content_tag :span, html, :class => 'search_range'
       end
       alias_method :active_scaffold_search_integer, :active_scaffold_search_range
       alias_method :active_scaffold_search_decimal, :active_scaffold_search_range
@@ -164,10 +194,9 @@ module ActiveScaffold
         opt_value, from_value, to_value = field_search_params_range_values(column)
         options = column.options.merge(options)
         helper = "select_#{'date' unless options[:discard_date]}#{'time' unless options[:discard_time]}"
-        html = []
-        html << send(helper, field_search_datetime_value(from_value), {:include_blank => true, :prefix => "#{options[:name]}[from]"}.merge(options))
-        html << send(helper, field_search_datetime_value(to_value), {:include_blank => true, :prefix => "#{options[:name]}[to]"}.merge(options))
-        html * ' - '
+        
+        send(helper, field_search_datetime_value(from_value), {:include_blank => true, :prefix => "#{options[:name]}[from]"}.merge(options)) << 
+        ' - '.html_safe << send(helper, field_search_datetime_value(to_value), {:include_blank => true, :prefix => "#{options[:name]}[to]"}.merge(options))
       end
 
       def active_scaffold_search_date(column, options)
@@ -183,16 +212,9 @@ module ActiveScaffold
       ##
 
       def override_search_field(column)
-        method = override_search_field_name(column)
-        return method if respond_to?(method)
-        old_method = override_search_field_name(column, true)
-        if respond_to?(old_method)
-          ActiveSupport::Deprecation.warn("You are using an old naming schema for overrides, you should name the helper #{method} instead of #{old_method}")
-          old_method
-        end
         method_with_class = override_search_field_name(column, true)
         return method_with_class if respond_to?(method_with_class)
-        method = override_form_field_name(column)
+        method = override_search_field_name(column)
         method if respond_to?(method)
       end
       alias_method :override_search_field?, :override_search_field
@@ -210,6 +232,32 @@ module ActiveScaffold
       def override_search(form_ui)
         "active_scaffold_search_#{form_ui}"
       end
+      
+      def visibles_and_hiddens(search_config)
+        visibles = [] 
+        hiddens = []
+        search_config.columns.each do |column|
+          next unless column.search_sql
+          if search_config.optional_columns.include?(column.name) && !searched_by?(column)
+            hiddens << column
+          else
+            visibles << column
+          end
+        end
+        return visibles, hiddens
+      end
+      
+      def searched_by?(column)
+        value = field_search_params[column.name]
+        case value
+        when Hash
+          !value['from'].blank?
+        when String
+          !value.blank?
+        else
+          false
+        end
+      end
     end
   end
 end

data/lib/active_scaffold/helpers/view_helpers.rb

@@ -161,7 +161,7 @@ module ActiveScaffold
       
       def action_link_html_options(link, url_options, record, html_options)
         link_id = get_action_link_id(url_options, record, link.column)
-        html_options.reverse_merge! link.html_options.merge(:class => link.action)
+        html_options.reverse_merge! link.html_options.merge(:class => link.action.to_s)
 
         # Needs to be in html_options to as the adding _method to the url is no longer supported by Rails        
         html_options[:method] = link.method if link.method != :get