active_scaffold 3.6.20 → 3.7.1

data/lib/active_scaffold/data_structures/column.rb

@@ -40,14 +40,27 @@ module ActiveScaffold::DataStructures
     # the display-name of the column. this will be used, for instance, as the column title in the table and as the field name in the form.
     # if left alone it will utilize human_attribute_name which includes localization
     attr_writer :label
-    def label
-      as_(@label) || active_record_class.human_attribute_name(name.to_s)
+    def label(record = nil, scope = nil)
+      if @label.respond_to?(:call)
+        if record
+          @label.call(record, self, scope)
+        else
+          # sometimes label is called without a record in context (ie, from table
+          # headers).  In this case fall back to the humanized attribute name
+          # instead of the Proc
+          active_record_class.human_attribute_name(name.to_s)
+        end
+      else
+        as_(@label) || active_record_class.human_attribute_name(name.to_s)
+      end
     end
 
     # a textual description of the column and its contents. this will be displayed with any associated form input widget, so you may want to consider adding a content example.
     attr_writer :description
-    def description
-      if @description
+    def description(record = nil, scope = nil)
+      if @description&.respond_to?(:call)
+        @description.call(record, self, scope)
+      elsif @description
         @description
       else
         I18n.t name, :scope => [:activerecord, :description, active_record_class.to_s.underscore.to_sym], :default => ''
@@ -87,6 +100,19 @@ module ActiveScaffold::DataStructures
     cattr_accessor :send_form_on_update_column, instance_accessor: false
     attr_accessor :send_form_on_update_column
 
+    # add a custom attr_accessor that can contain a Proc (or boolean or symbol)
+    # that will be called when the column renders, such that we can dynamically
+    # hide or show the column with an element that can be replaced by
+    # update_columns, but won't affect the form submission.
+    # The value can be set in the scaffold controller as follows to dynamically
+    # hide the column based on a Proc's output:
+    # config.columns[:my_column].hide_form_column_if = Proc.new { |record, column, scope| record.vehicle_type == 'tractor' }
+    # OR to always hide the column:
+    # config.columns[:my_column].hide_form_column_if = true
+    # OR to call a method on the record to determine whether to hide the column:
+    # config.columns[:my_column].hide_form_column_if = :hide_tractor_fields?
+    attr_accessor :hide_form_column_if
+
     # sorting on a column can be configured four ways:
     #   sort = true               default, uses intelligent sorting sql default
     #   sort = false              sometimes sorting doesn't make sense
@@ -118,24 +144,58 @@ module ActiveScaffold::DataStructures
     # supported options:
     #   * for association columns
     #     * :select - displays a simple <select> or a collection of checkboxes to (dis)associate records
-    attr_accessor :form_ui
+    attr_reader :form_ui
+
+    attr_reader :form_ui_options
 
-    attr_writer :list_ui
+    # value must be a Symbol, or an Array of form_ui and options hash which will be used with form_ui only
+    def form_ui=(value)
+      check_valid_action_ui_params(value)
+      @form_ui, @form_ui_options = *value
+    end
+
+    # value must be a Symbol, or an Array of list_ui and options hash which will be used with list_ui only
+    def list_ui=(value)
+      check_valid_action_ui_params(value)
+      @list_ui, @list_ui_options = *value
+    end
 
     def list_ui
       @list_ui || form_ui
     end
 
-    attr_writer :show_ui
+    def list_ui_options
+      @list_ui ? @list_ui_options : form_ui_options
+    end
+
+    # value must be a Symbol, or an Array of show_ui and options hash which will be used with show_ui only
+    def show_ui=(value)
+      check_valid_action_ui_params(value)
+      @show_ui, @show_ui_options = *value
+    end
+
     def show_ui
       @show_ui || list_ui
     end
 
-    attr_writer :search_ui
+    def show_ui_options
+      @show_ui ? @show_ui_options : list_ui_options
+    end
+
+    # value must be a Symbol, or an Array of search_ui and options hash which will be used with search_ui only
+    def search_ui=(value)
+      check_valid_action_ui_params(value)
+      @search_ui, @search_ui_options = *value
+    end
+
     def search_ui
       @search_ui || @form_ui || (:select if association && !association.polymorphic?)
     end
 
+    def search_ui_options
+      @search_ui ? @search_ui_options : form_ui_options
+    end
+
     # a place to store dev's column specific options
     attr_writer :options
     def options
@@ -314,6 +374,9 @@ module ActiveScaffold::DataStructures
       @name = name.to_sym
       @active_record_class = active_record_class
       @column = _columns_hash[name.to_s]
+      if @column.nil? && active_record? && active_record_class._default_attributes.key?(name.to_s)
+        @column = active_record_class._default_attributes[name.to_s]
+      end
       @delegated_association = delegated_association
       @cache_key = [@active_record_class.name, name].compact.map(&:to_s).join('#')
       setup_association_info
@@ -328,24 +391,9 @@ module ActiveScaffold::DataStructures
       @actions_for_association_links = self.class.actions_for_association_links.dup if association
       @select_columns = default_select_columns
 
-      @text = @column.nil? || [:string, :text, String].include?(column_type)
+      @text = @column.nil? || [:string, :text, :citext, String].include?(column_type)
       @number = false
-      if @column
-        if active_record_class.respond_to?(:defined_enums) && active_record_class.defined_enums[name.to_s]
-          @form_ui = :select
-          @options = {:options => active_record_class.send(name.to_s.pluralize).keys.map(&:to_sym)}
-        elsif column_number?
-          @number = true
-          @form_ui = :number
-          @options = {:format => :i18n_number}
-        else
-          @form_ui =
-            case @column.type
-            when :boolean then :checkbox
-            when :text then :textarea
-            end
-        end
-      end
+      setup_defaults_for_column if @column
       @allow_add_existing = true
       @form_ui = self.class.association_form_ui if @association && self.class.association_form_ui
 
@@ -370,7 +418,7 @@ module ActiveScaffold::DataStructures
     # just the field (not table.field)
     def field_name
       return nil if virtual?
-      @field_name ||= column ? quoted_field_name(column.name) : association.foreign_key
+      @field_name ||= column ? quoted_field_name(column.name) : quoted_field_name(association.foreign_key)
     end
 
     def <=>(other)
@@ -404,7 +452,22 @@ module ActiveScaffold::DataStructures
     end
 
     def default_for_empty_value
-      (column.null ? nil : column.default) if column
+      return nil unless column
+      if column.is_a?(ActiveModel::Attribute)
+        column.value
+      elsif active_record?
+        null? ? nil : column.default
+      elsif mongoid?
+        column.default_val
+      end
+    end
+
+    def null?
+      if active_record? && !column.is_a?(ActiveModel::Attribute)
+        column&.null
+      else
+        true
+      end
     end
 
     # the table.field name for this column, if applicable
@@ -412,6 +475,10 @@ module ActiveScaffold::DataStructures
       @field ||= quoted_field(field_name)
     end
 
+    def quoted_foreign_type
+      quoted_field(quoted_field_name(association.foreign_type))
+    end
+
     def type_for_attribute
       ActiveScaffold::OrmChecks.type_for_attribute active_record_class, name
     end
@@ -420,8 +487,39 @@ module ActiveScaffold::DataStructures
       ActiveScaffold::OrmChecks.column_type active_record_class, name
     end
 
+    def default_value
+      ActiveScaffold::OrmChecks.column_type active_record_class, name
+    end
+
+    def attributes=(opts)
+      opts.each do |setting, value|
+        send "#{setting}=", value
+      end
+    end
+
+    def cast(value)
+      ActiveScaffold::OrmChecks.cast active_record_class, name, value
+    end
+
     protected
 
+    def setup_defaults_for_column
+      if active_record_class.respond_to?(:defined_enums) && active_record_class.defined_enums[name.to_s]
+        @form_ui = :select
+        @options = {:options => active_record_class.send(name.to_s.pluralize).keys.map(&:to_sym)}
+      elsif column_number?
+        @number = true
+        @form_ui = :number
+        @options = {:format => :i18n_number}
+      else
+        @form_ui =
+          case column_type
+          when :boolean then null? ? :boolean : :checkbox
+          when :text then :textarea
+          end
+      end
+    end
+
     def setup_association_info
       assoc = active_record_class.reflect_on_association(name)
       @association =
@@ -480,7 +578,7 @@ module ActiveScaffold::DataStructures
     end
 
     def column_number?
-      return %i[float decimal integer].include? @column.type if active_record?
+      return %i[float decimal integer].include? column_type if active_record?
       return @column.type < Numeric if mongoid?
     end
 
@@ -534,5 +632,18 @@ module ActiveScaffold::DataStructures
         300
       end
     end
+
+    def check_valid_action_ui_params(value)
+      return true if valid_action_ui_params?(value)
+      raise ArgumentError, 'value must be a Symbol, or an array of Symbol and Hash'
+    end
+
+    def valid_action_ui_params?(value)
+      if value.is_a?(Array)
+        value.size <= 2 && value[0].is_a?(Symbol) && (value[1].nil? || value[1].is_a?(Hash))
+      else
+        value.nil? || value.is_a?(Symbol)
+      end
+    end
   end
 end

data/lib/active_scaffold/data_structures/columns.rb

@@ -13,7 +13,7 @@ module ActiveScaffold::DataStructures
     # IT IS NOT MEANT FOR PUBLIC USE (but if you know what you're doing, go ahead)
     def _inheritable=(value)
       @sorted = true
-      @_inheritable = value
+      @_inheritable = ::Set.new(value)
     end
 
     # This accessor is used by ActionColumns to create new Column objects without adding them to this set
@@ -21,8 +21,8 @@ module ActiveScaffold::DataStructures
 
     def initialize(active_record_class, *args)
       @active_record_class = active_record_class
-      @_inheritable = []
-      @set = []
+      @_inheritable = ::Set.new
+      @set = {}
       @sorted = nil
 
       add(*args)
@@ -35,9 +35,11 @@ module ActiveScaffold::DataStructures
       args = args.collect(&:to_sym)
 
       # make the columns inheritable
-      @_inheritable.concat(args)
+      @_inheritable.merge(args)
       # then add columns to @set (unless they already exist)
-      args.each { |a| @set << ActiveScaffold::DataStructures::Column.new(a.to_sym, @active_record_class) unless find_by_name(a) }
+      args.each do |a|
+        @set[a.to_sym] = ActiveScaffold::DataStructures::Column.new(a, @active_record_class) unless find_by_name(a)
+      end
     end
     alias << add
 
@@ -55,7 +57,7 @@ module ActiveScaffold::DataStructures
       klass = column.association.klass
       columns.each do |col|
         next if find_by_name col
-        @set << ActiveScaffold::DataStructures::Column.new(col, klass, column.association)
+        @set[col.to_sym] = ActiveScaffold::DataStructures::Column.new(col, klass, column.association)
       end
     end
 
@@ -66,24 +68,22 @@ module ActiveScaffold::DataStructures
 
     # returns an array of columns with the provided names
     def find_by_names(*names)
-      @set.find_all { |column| names.include? column.name }
+      names.map { |name| find_by_name name }
     end
 
     # returns the column of the given name.
     def find_by_name(name)
-      # this works because of `def column.=='
-      column = @set.find { |c| c == name }
-      column
+      @set[name.to_sym]
     end
     alias [] find_by_name
 
     def each
-      @set.each { |i| yield i }
+      @set.each_value { |name| yield name }
     end
 
     def _inheritable
       if @sorted
-        @_inheritable
+        @_inheritable.to_a
       else
         @_inheritable.sort do |a, b|
           self[a] <=> self[b]

data/lib/active_scaffold/data_structures/nested_info.rb

@@ -70,6 +70,10 @@ module ActiveScaffold::DataStructures
     def match_model?(model)
       false
     end
+
+    def create_with_parent?
+      false
+    end
   end
 
   class NestedInfoAssociation < NestedInfo
@@ -104,6 +108,14 @@ module ActiveScaffold::DataStructures
       association.through_singular? && source_reflection.reverse
     end
 
+    def create_with_parent?
+      if has_many? && !association.through?
+        false
+      elsif child_association || create_through_singular?
+        true
+      end
+    end
+
     def source_reflection
       @source_reflection ||= ActiveScaffold::DataStructures::Association::ActiveRecord.new(association.source_reflection)
     end

data/lib/active_scaffold/data_structures/sorting.rb

@@ -41,7 +41,7 @@ module ActiveScaffold::DataStructures
       column = get_column(column_name)
       raise ArgumentError, "Could not find column #{column_name}" if column.nil?
       raise ArgumentError, 'Sorting direction unknown' unless %i[ASC DESC].include? direction.to_sym
-      @clauses << [column, direction.untaint] if column.sortable?
+      @clauses << [column, direction] if column.sortable?
       raise ArgumentError, "Can't mix :method- and :sql-based sorting" if mixed_sorting?
     end
 

data/lib/active_scaffold/engine.rb

@@ -2,8 +2,10 @@ module ActiveScaffold
   class Engine < ::Rails::Engine
     initializer 'active_scaffold.action_controller' do
       ActiveSupport.on_load :action_controller do
+        require 'active_scaffold/extensions/action_controller_rescueing'
+        require 'active_scaffold/extensions/action_controller_rendering'
+        require 'active_scaffold/extensions/routing_mapper'
         include ActiveScaffold::Core
-        include ActiveScaffold::DelayedSetup if ActiveScaffold.delayed_setup
         include ActiveScaffold::RespondsToParent
         include ActiveScaffold::Helpers::ControllerHelpers
         include ActiveScaffold::ActiveRecordPermissions::ModelUserAccess::Controller
@@ -13,12 +15,17 @@ module ActiveScaffold
 
     initializer 'active_scaffold.action_view' do
       ActiveSupport.on_load :action_view do
+        require 'active_scaffold/extensions/action_view_rendering'
+        require 'active_scaffold/extensions/name_option_for_datetime'
         include ActiveScaffold::Helpers::ViewHelpers
       end
     end
 
     initializer 'active_scaffold.active_record' do
       ActiveSupport.on_load :active_record do
+        require 'active_scaffold/extensions/to_label'
+        require 'active_scaffold/extensions/unsaved_associated'
+        require 'active_scaffold/extensions/unsaved_record'
         include ActiveScaffold::ActiveRecordPermissions::ModelUserAccess::Model
         module ActiveRecord::Associations
           Association.send :include, ActiveScaffold::Tableless::Association
@@ -40,5 +47,12 @@ module ActiveScaffold
     initializer 'active_scaffold.assets' do
       config.assets.precompile << 'active_scaffold/indicator.gif'
     end
+
+    initializer 'active_scaffold.extensions' do
+      require 'active_scaffold/extensions/cow_proxy'
+      require 'active_scaffold/extensions/ice_nine'
+      require 'active_scaffold/extensions/localize'
+      require 'active_scaffold/extensions/paginator_extensions'
+    end
   end
 end

data/lib/active_scaffold/extensions/action_view_rendering.rb

@@ -119,6 +119,17 @@ module ActiveScaffold #:nodoc:
       end
     end
 
+    def remote_controller_config(controller_path)
+      # attempt to retrieve the active_scaffold_config by constantizing the controller path
+      "#{controller_path}_controller".camelize.constantize.active_scaffold_config
+    rescue NameError
+      # if we couldn't determine the controller config by instantiating the
+      # controller class, parse the ActiveRecord model name from the
+      # controller path, which might be a namespaced controller (e.g., 'admin/admins')
+      model = controller_path.to_s.sub(%r{.*/}, '').singularize
+      active_scaffold_config_for(model)
+    end
+
     def render_embedded(options)
       require 'digest/md5'
 
@@ -144,13 +155,10 @@ module ActiveScaffold #:nodoc:
       else
         url = url_for(url_options)
         content_tag(:div, :id => id, :class => 'active-scaffold-component', :data => {:refresh => url}) do
-          # parse the ActiveRecord model name from the controller path, which
-          # might be a namespaced controller (e.g., 'admin/admins')
-          model = remote_controller.to_s.sub(%r{.*/}, '').singularize
           content_tag(:div, :class => 'active-scaffold-header') do
             content_tag(:h2) do
-              link_label = options[:label] || active_scaffold_config_for(model).list.label
-              link_to(link_label, url, remote: true, class: 'load-embedded', data: {error_msg: as_(:error_500)}) <<
+              label = options[:label] || remote_controller_config(remote_controller).list.label
+              link_to(label, url, remote: true, class: 'load-embedded', data: {error_msg: as_(:error_500)}) <<
                 loading_indicator_tag(url_options)
             end
           end

data/lib/active_scaffold/extensions/cow_proxy.rb

@@ -49,7 +49,7 @@ module CowProxy
       class ActionLinks < ::CowProxy::WrapClass(::ActiveScaffold::DataStructures::ActionLinks)
         def method_missing(name, *args, &block)
           CowProxy.debug { "method missing #{name} in #{__getobj__.name}" }
-          return super if name =~ /[!?]$/
+          return super if name.match?(/[!?]$/)
           subgroup =
             if _instance_variable_defined?("@#{name}")
               _instance_variable_get("@#{name}")

data/lib/active_scaffold/extensions/routing_mapper.rb

@@ -68,6 +68,7 @@ module ActiveScaffold
       end
     end
   end
+  ActiveSupport.run_load_hooks(:active_scaffold_routing, Routing)
 end
 
 module ActionDispatch

data/lib/active_scaffold/extensions/unsaved_record.rb

@@ -11,15 +11,21 @@ module ActiveScaffold::UnsavedRecord
   end
 
   # automatically unsets the unsaved flag
-  def save(*)
+  def save(**)
     super.tap { self.unsaved = false }
   end
 
   def keeping_errors
     old_errors = errors.dup if errors.present?
     result = yield
-    old_errors&.each do |attr|
-      old_errors[attr].each { |msg| errors.add(attr, msg) unless errors.added?(attr, msg) }
+    old_errors&.each do |e|
+      if e.is_a?(String) || e.is_a?(Symbol)
+        # Rails <6.1 errors API.
+        old_errors[e].each { |msg| errors.add(e, msg) unless errors.added?(e, msg) }
+      else
+        # Rails >=6.1 errors API (https://code.lulalala.com/2020/0531-1013.html).
+        errors.add(e.attribute, e.message) unless errors.added?(e.attribute, e.message)
+      end
     end
     result && old_errors.blank?
   end