active_scaffold 4.1.6 → 4.2.0

data/lib/active_scaffold/config/core.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   # to fix the ckeditor bridge problem inherit from full class name
   class Core < ActiveScaffold::Config::Base
     include ActiveScaffold::OrmChecks
+
     # global level configuration
     # --------------------------
 
@@ -24,6 +27,10 @@ module ActiveScaffold::Config
     cattr_accessor :cache_action_link_urls, instance_accessor: false
     @@cache_action_link_urls = true
 
+    # enable caching of action links
+    cattr_accessor :cache_action_links, instance_accessor: false
+    @@cache_action_links = true
+
     # enable caching of association options
     cattr_accessor :cache_association_options, instance_accessor: false
     @@cache_association_options = true
@@ -36,18 +43,14 @@ module ActiveScaffold::Config
     cattr_accessor :store_user_settings, instance_accessor: false
     @@store_user_settings = true
 
-    # lets you disable the DHTML history
-    cattr_writer :dhtml_history, instance_accessor: false
-
-    def self.dhtml_history?
-      @@dhtml_history ? true : false
-    end
-    @@dhtml_history = true
-
     # action links are used by actions to tie together. you can use them, too! this is a collection of ActiveScaffold::DataStructures::ActionLink objects.
     cattr_reader :action_links, instance_reader: false
     @@action_links = ActiveScaffold::DataStructures::ActionLinks.new
 
+    # modules to include after all ActiveScaffold modules are included, to include generic customizations in all controllers
+    cattr_reader :custom_modules, instance_reader: false
+    @@custom_modules = []
+
     # access to the permissions configuration.
     # configuration options include:
     #  * current_user_method - what method on the controller returns the current user. default: :current_user
@@ -116,9 +119,16 @@ module ActiveScaffold::Config
     # lets you override the global ActiveScaffold theme for a specific controller
     attr_accessor :theme
 
+    # modules to include after all ActiveScaffold modules are included, to include generic customizations in some controllers
+    # These modules are included after the modules in global custom_modules setting.
+    attr_reader :custom_modules
+
     # enable caching of action link urls
     attr_accessor :cache_action_link_urls
 
+    # enable caching of action links
+    attr_accessor :cache_action_links
+
     # enable caching of association options
     attr_accessor :cache_association_options
 
@@ -161,6 +171,7 @@ module ActiveScaffold::Config
     def initialize(model_id) # rubocop:disable Lint/MissingSuper
       # model_id is the only absolutely required configuration value. it is also not publicly accessible.
       @model_id = model_id
+      @custom_modules = []
       setup_user_setting_key
 
       # inherit the actions list directly from the global level
@@ -182,6 +193,7 @@ module ActiveScaffold::Config
 
       @theme = self.class.theme
       @cache_action_link_urls = self.class.cache_action_link_urls
+      @cache_action_links = self.class.cache_action_links
       @cache_association_options = self.class.cache_association_options
       @conditional_get_support = self.class.conditional_get_support
       @store_user_settings = self.class.store_user_settings
@@ -197,7 +209,7 @@ module ActiveScaffold::Config
     def _cache_lazy_values
       action_links.collection # ensure the collection group exist although it's empty
       action_links.member # ensure the collection group exist although it's empty
-      if cache_action_link_urls
+      if cache_action_link_urls || cache_action_links
         action_links.each(&:name_to_cache)
         list.filters.each { |filter| filter.each(&:name_to_cache) } if actions.include?(:list)
       end
@@ -249,7 +261,7 @@ module ActiveScaffold::Config
 
       underscored_name = action_name.to_s.underscore.to_sym
       unless @actions.include? underscored_name
-        raise "#{action_name.to_s.camelcase} is not enabled. Please enable it or remove any references in your configuration (e.g. config.#{underscored_name}.columns = [...])."
+        raise ArgumentError, "#{action_name.to_s.camelcase} is not enabled. Please enable it or remove any references in your configuration (e.g. config.#{underscored_name}.columns = [...])."
       end
 
       @action_configs ||= {}
@@ -309,8 +321,9 @@ module ActiveScaffold::Config
 
     class UserSettings < Base::UserSettings
       include ActiveScaffold::Configurable
-      user_attr :cache_action_link_urls, :cache_association_options, :conditional_get_support,
-                :timestamped_messages, :highlight_messages
+
+      user_attr :cache_action_link_urls, :cache_action_links, :cache_association_options,
+                :conditional_get_support, :timestamped_messages, :highlight_messages
       attr_writer :label
 
       def label(options = {})
@@ -337,17 +350,7 @@ module ActiveScaffold::Config
         @columns ||= UserColumns.new(@conf.columns)
       end
 
-      def action_links
-        @conf.action_links
-      end
-
-      def model
-        @conf.model # for performance, called many times, so we avoid method_missing
-      end
-
-      def actions
-        @conf.actions # for performance, called many times, so we avoid method_missing
-      end
+      delegate :action_links, :model, :actions, to: :@conf
     end
 
     class UserColumns

data/lib/active_scaffold/config/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class Create < ActiveScaffold::Config::Form
     self.crud_type = :create

data/lib/active_scaffold/config/delete.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class Delete < Base
     self.crud_type = :delete

data/lib/active_scaffold/config/field_search.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class FieldSearch < Base
     self.crud_type = :read

data/lib/active_scaffold/config/form.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class Form < Base
     def initialize(core_config)
@@ -6,6 +8,7 @@ module ActiveScaffold::Config
       @refresh_list = self.class.refresh_list
       @persistent = self.class.persistent
       @floating_footer = self.class.floating_footer
+      @field_descriptions = self.class.field_descriptions
 
       # no global setting here because multipart should only be set for specific forms
       @multipart = false
@@ -28,6 +31,10 @@ module ActiveScaffold::Config
     class_attribute :floating_footer, instance_accessor: false
     @@floating_footer = false
 
+    # whether field descriptions are visible always, on hover or click (:show, :hover, :click, default to :show)
+    class_attribute :field_descriptions, instance_accessor: false
+    @@field_descriptions = :show
+
     # instance-level configuration
     # ----------------------------
 
@@ -49,6 +56,9 @@ module ActiveScaffold::Config
     # whether footer should float when form is too long to fit in the screen, so footer is always available while scrolling
     attr_accessor :floating_footer
 
+    # whether field descriptions are visible always, on hover or click (:show, :hover, :click, default to :show)
+    attr_accessor :field_descriptions
+
     columns_accessor :columns do
       columns.exclude :created_on, :created_at, :updated_on, :updated_at, :as_marked
       columns.exclude(*@core.columns.filter_map { |c| c.name if c.association&.polymorphic? })
@@ -62,7 +72,7 @@ module ActiveScaffold::Config
     end
 
     UserSettings.class_eval do
-      user_attr :persistent, :refresh_list, :show_unauthorized_columns, :floating_footer
+      user_attr :persistent, :refresh_list, :show_unauthorized_columns, :floating_footer, :field_descriptions
 
       attr_writer :multipart
 

data/lib/active_scaffold/config/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class List < Base
     self.crud_type = :read
@@ -199,8 +201,8 @@ module ActiveScaffold::Config
     # the label for this List action. used for the header.
     attr_writer :label
 
-    def label
-      @label ? as_(@label, count: 2) : @core.label(count: 2)
+    def label(core: @core)
+      @label ? as_(@label, count: 2) : core.label(count: 2)
     end
 
     attr_writer :no_entries_message, :filtered_message, :always_show_search
@@ -244,7 +246,7 @@ module ActiveScaffold::Config
     attr_writer :hide_nested_column
 
     def hide_nested_column
-      @hide_nested_column.nil? ? true : @hide_nested_column
+      @hide_nested_column.nil? || @hide_nested_column
     end
 
     # wrap normal cells (not inplace editable columns or with link) with a tag
@@ -274,7 +276,7 @@ module ActiveScaffold::Config
 
       # This label has already been localized.
       def label
-        self['label'] || embedded_label || @label || @conf.label
+        self['label'] || embedded_label || @label || @conf.label(core: core)
       end
 
       def embedded_label
@@ -339,9 +341,7 @@ module ActiveScaffold::Config
         @_sorting
       end
 
-      def count_includes
-        @conf.count_includes
-      end
+      delegate :count_includes, to: :@conf
 
       protected
 

data/lib/active_scaffold/config/mark.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class Mark < Base
     self.crud_type = :read

data/lib/active_scaffold/config/nested.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class Nested < Base
     self.crud_type = :read
@@ -41,8 +43,34 @@ module ActiveScaffold::Config
       action_link
     end
 
+    # Add a nested ActionLink to new action
+    def add_new_link(attribute, options = {})
+      column = @core.columns[attribute.to_sym]
+      raise ArgumentError, "unknown column #{attribute}" if column.nil?
+      raise ArgumentError, "column #{attribute} is not an association" if column.association.nil?
+
+      model =
+        if column.association.polymorphic?
+          column.label
+        else
+          column.association.klass.model_name.human(count: 1)
+        end
+      options.reverse_merge!(
+        security_method: :nested_authorized?,
+        label: as_(:add_model, model: model),
+        action: 'new',
+        refresh_on_close: false,
+        parameters: {parent_controller: @core.controller_path}
+      )
+      action_group = options.delete(:action_group) || self.action_group
+      action_link = @core.link_for_association(column, options)
+      @core.action_links.add_to_group(action_link, action_group) unless action_link.nil?
+      action_link
+    end
+
     def add_scoped_link(named_scope, options = {})
       action_link = @core.link_for_association_as_scope(named_scope.to_sym, options)
+      action_group = options.delete(:action_group) || self.action_group
       @core.action_links.add_to_group(action_link, action_group) unless action_link.nil?
     end
 

data/lib/active_scaffold/config/search.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class Search < Base
     self.crud_type = :read

data/lib/active_scaffold/config/show.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class Show < Base
     self.crud_type = :read

data/lib/active_scaffold/config/subform.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class Subform < Base
     def initialize(core_config)

data/lib/active_scaffold/config/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::Config
   class Update < ActiveScaffold::Config::Form
     self.crud_type = :update
@@ -35,7 +37,7 @@ module ActiveScaffold::Config
     attr_writer :hide_nested_column
 
     def hide_nested_column
-      @hide_nested_column.nil? ? true : @hide_nested_column
+      @hide_nested_column.nil? || @hide_nested_column
     end
 
     UserSettings.class_eval do

data/lib/active_scaffold/configurable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold
   # Exposes a +configure+ method that accepts a block and runs all contents of the block in two contexts,
   # as opposed to the normal one. First, everything gets evaluated as part of the object including Configurable.
@@ -16,9 +18,9 @@ module ActiveScaffold
       ret
     end
 
-    def method_missing(name, *args)
+    def method_missing(name, *)
       if @configuration_binding&.respond_to?(name, true) # rubocop:disable Lint/RedundantSafeNavigation
-        @configuration_binding.send(name, *args)
+        @configuration_binding.send(name, *)
       else
         super
       end

data/lib/active_scaffold/constraints.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold
   module Constraints
     def self.included(base)

data/lib/active_scaffold/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold
   module Core
     def self.included(base)
@@ -37,6 +39,7 @@ module ActiveScaffold
     module ClassMethods
       def active_scaffold(model_id = nil, &block)
         extend Prefixes
+
         # initialize bridges here
         ActiveScaffold::Bridges.run_all
 
@@ -56,6 +59,8 @@ module ActiveScaffold
             instance_eval(&callback)
           elsif active_scaffold_config.respond_to?(callback)
             active_scaffold_config.send(callback)
+          elsif respond_to?(callback)
+            send(callback)
           end
         end
 
@@ -72,6 +77,7 @@ module ActiveScaffold
           end
           active_scaffold_config.actions.each do |mod|
             include "ActiveScaffold::Actions::#{mod.to_s.camelize}".constantize
+
             mod_conf = active_scaffold_config.send(mod)
             active_scaffold_config._setup_action(mod)
             next unless mod_conf.respond_to?(:link) && (link = mod_conf.link)
@@ -87,6 +93,8 @@ module ActiveScaffold
           end
         end
         _add_sti_create_links if active_scaffold_config.add_sti_create_links?
+        ActiveScaffold::Config::Core.custom_modules.each { |mod| include mod }
+        active_scaffold_config.custom_modules.each { |mod| include mod }
         active_scaffold_config._cache_lazy_values
         active_scaffold_config.deep_freeze!
       end
@@ -110,7 +118,7 @@ module ActiveScaffold
 
         active_scaffold_config.action_links.collection.delete('new')
         active_scaffold_config.sti_children.each do |child|
-          new_sti_link = Marshal.load(Marshal.dump(new_action_link)) # deep clone
+          new_sti_link = new_action_link.deep_dup
           new_sti_link.label = as_(:create_model, model: child.to_s.camelize.constantize.model_name.human)
           new_sti_link.parameters = {parent_sti: controller_path}
           new_sti_link.controller = proc { active_scaffold_controller_for(child.to_s.camelize.constantize).controller_path }
@@ -153,7 +161,7 @@ module ActiveScaffold
         options[:parameters] ||= {}
         options[:parameters].reverse_merge! association: column.association.name
         if column.association.collection?
-          ActiveScaffold::DataStructures::ActionLink.new('index', options.merge(refresh_on_close: true))
+          ActiveScaffold::DataStructures::ActionLink.new('index', options.reverse_merge(refresh_on_close: true))
         else
           actions = controller.active_scaffold_config.actions unless controller == :polymorph
           actions ||= %i[create update show]
@@ -178,7 +186,7 @@ module ActiveScaffold
         as_path = File.realpath File.join(ActiveScaffold::Config::Core.plugin_directory, 'app', 'views')
         index = view_paths.find_index { |p| p.to_s == as_path }
         if index
-          self.view_paths = view_paths[0..index - 1] + Array(path) + view_paths[index..]
+          self.view_paths = view_paths[0..(index - 1)] + Array(path) + view_paths[index..]
         else
           append_view_path path
         end
@@ -214,7 +222,9 @@ module ActiveScaffold
         return self if uses_active_scaffold? && klass == active_scaffold_config.model
 
         # noinspection RubyArgCount
-        ActiveScaffold::Core.active_scaffold_controller_for(klass, "#{to_s.deconstantize}::")
+        ActiveScaffold::Registry.cache :as_controller, klass do
+          ActiveScaffold::Core.active_scaffold_controller_for(klass, "#{to_s.deconstantize}::")
+        end
       end
 
       def uses_active_scaffold?

data/lib/active_scaffold/data_structures/action_columns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   # A set of columns. These structures can be nested for organization.
   class ActionColumns < ActiveScaffold::DataStructures::Set
@@ -86,7 +88,7 @@ module ActiveScaffold::DataStructures
             yield item
           end
         else
-          next if skip_column?(item, options)
+          next if !options[:skip_authorization] && skip_column?(item, options)
 
           yield columns[item] || ActiveScaffold::DataStructures::Column.new(item.to_sym, columns.active_record_class)
         end

data/lib/active_scaffold/data_structures/action_link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class ActionLink
     NO_OPTIONS = {}.freeze
@@ -39,6 +41,14 @@ module ActiveScaffold::DataStructures
       self.html_options = html_options.clone if action_link.instance_variable_get(:@html_options)
     end
 
+    def deep_dup
+      link = dup
+      instance_variables.each do |var|
+        link.instance_variable_set(var, link.instance_variable_get(var).deep_dup)
+      end
+      link
+    end
+
     # the weight for this link in the action links collection, it will be used to sort the collection
     attr_accessor :weight
 

data/lib/active_scaffold/data_structures/action_link_separator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class ActionLinkSeparator
     def initialize(weight)

data/lib/active_scaffold/data_structures/action_links.rb

@@ -1,15 +1,30 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class ActionLinks
     include Enumerable
-    attr_accessor :default_type
 
-    def initialize(name = :root)
+    COLLECTION_CLICK_MENU_LINK = ActionLink.new(:index, position: false, type: :member, toggle: false, parameters: {action_links: '--ACTION-LINKS--', id: nil}) # member so it's cached
+    MEMBER_CLICK_MENU_LINK = ActionLink.new(:index, position: false, type: :member, toggle: false, parameters: {action_links: '--ACTION-LINKS--'})
+
+    attr_accessor :default_type, :weight, :css_class
+    attr_writer :click_menu, :label
+    attr_reader :name, :path
+
+    def initialize(name = :root, parent_path = nil)
       @set = []
       @name = name
       @css_class = name.to_s.downcase
       @weight = 0
+      @path = [parent_path, name].compact.join('.') unless name == :root
     end
 
+    def click_menu?
+      @click_menu
+    end
+
+    alias name_to_cache path
+
     # adds an ActionLink, creating one from the arguments if need be
     def add(action, options = {})
       link =
@@ -126,29 +141,26 @@ module ActiveScaffold::DataStructures
       @set
     end
 
-    def empty?
-      @set.empty?
-    end
+    delegate :empty?, to: :@set
 
     def subgroup(name, label = nil)
+      name = name.to_sym
       group = self if name == self.name
       group ||= @set.find do |item|
         name == item.name if item.is_a?(ActiveScaffold::DataStructures::ActionLinks)
       end
 
       if group.nil?
-        raise "Can't add new subgroup '#{name}', links are frozen" if frozen?
+        raise FrozenError, "Can't add new subgroup '#{name}', links are frozen" if frozen?
 
-        group = ActiveScaffold::DataStructures::ActionLinks.new(name)
+        group = ActiveScaffold::DataStructures::ActionLinks.new(name, path)
         group.label = label || name
-        group.default_type = self.name == :root ? (name.to_sym if %w[member collection].include?(name.to_s)) : default_type
+        group.default_type = self.name == :root ? (name if %i[member collection].include?(name)) : default_type
         add_to_set group
       end
       group
     end
 
-    attr_writer :label
-
     def label(record)
       case @label
       when Symbol
@@ -164,23 +176,22 @@ module ActiveScaffold::DataStructures
       return super if name.match?(/[=!?]$/)
       return subgroup(name.to_sym, args.first, &) if frozen?
 
-      class_eval <<-METHOD, __FILE__, __LINE__ + 1
-        def #{name}(label = nil)                     # def group_name(label = nil)
-          @#{name} ||= subgroup(:'#{name}', label)   #   @group_name ||= subgroup(:'group_name', label)
-          yield @#{name} if block_given?             #   yield @group_name if block_given?
-          @#{name}                                   #   @group_name
-        end                                          # end
-      METHOD
+      define_singleton_method name do |label = nil|
+        value = instance_variable_get("@#{name}")
+        unless value
+          value = subgroup(name.to_sym, label)
+          instance_variable_set("@#{name}", value)
+        end
+        yield value if block_given?
+        value
+      end
       send(name, args.first, &)
     end
 
     def respond_to_missing?(name, *)
-      name !~ /[!?]$/
+      name !~ /[=!?]$/
     end
 
-    attr_reader :name
-    attr_accessor :weight, :css_class
-
     protected
 
     # called during clone or dup. makes the clone/dup deeper.

data/lib/active_scaffold/data_structures/actions.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 class ActiveScaffold::DataStructures::Actions
   include Enumerable
 
-  def initialize(*args)
+  def initialize(*)
     @set = []
-    add(*args)
+    add(*)
   end
 
   def exclude(*args)

data/lib/active_scaffold/data_structures/association/abstract.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures::Association
   class Abstract
     def initialize(association)
@@ -24,11 +26,11 @@ module ActiveScaffold::DataStructures::Association
       @association.macro == :belongs_to
     end
 
-    def has_one? # rubocop:disable Naming/PredicateName
+    def has_one? # rubocop:disable Naming/PredicatePrefix
       @association.macro == :has_one
     end
 
-    def has_many? # rubocop:disable Naming/PredicateName
+    def has_many? # rubocop:disable Naming/PredicatePrefix
       @association.macro == :has_many
     end
 

data/lib/active_scaffold/data_structures/association/active_mongoid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures::Association
   class ActiveMongoid < Mongoid
     def self.reflect_on_all_associations(klass)
@@ -26,11 +28,11 @@ module ActiveScaffold::DataStructures::Association
       %i[belongs_to_record belongs_to_document].include?(@association.macro)
     end
 
-    def has_one? # rubocop:disable Naming/PredicateName
+    def has_one? # rubocop:disable Naming/PredicatePrefix
       %i[has_one_record has_one_document].include?(@association.macro)
     end
 
-    def has_many? # rubocop:disable Naming/PredicateName
+    def has_many? # rubocop:disable Naming/PredicatePrefix
       %i[has_many_records has_many_documents].include?(@association.macro)
     end
 

data/lib/active_scaffold/data_structures/association/active_record.rb

@@ -1,19 +1,17 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures::Association
   class ActiveRecord < Abstract
     def self.reflect_on_all_associations(klass)
       klass.reflect_on_all_associations
     end
 
-    delegate :collection?, :polymorphic?, :association_primary_key, :foreign_type, :table_name, to: :@association
+    delegate :collection?, :polymorphic?, :association_primary_key, :foreign_type, :table_name, :nested?, :scope, to: :@association
 
     def through?
       @association.options[:through].present?
     end
 
-    def nested?
-      @association.nested?
-    end
-
     def readonly?
       scope_values[:readonly]
     end
@@ -26,10 +24,6 @@ module ActiveScaffold::DataStructures::Association
       @association.source_reflection if through?
     end
 
-    def scope
-      @association.scope
-    end
-
     def inverse_klass
       @association.active_record
     end

data/lib/active_scaffold/data_structures/association/mongoid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures::Association
   class Mongoid < Abstract
     delegate :inverse_klass, :as, :dependent, :inverse, to: :@association
@@ -7,11 +9,11 @@ module ActiveScaffold::DataStructures::Association
       defined?(::Mongoid::Association) ? macro_mapping?(:belongs_to) : super
     end
 
-    def has_one? # rubocop:disable Naming/PredicateName
+    def has_one? # rubocop:disable Naming/PredicatePrefix
       defined?(::Mongoid::Association) ? macro_mapping?(:has_one) : super
     end
 
-    def has_many? # rubocop:disable Naming/PredicateName
+    def has_many? # rubocop:disable Naming/PredicatePrefix
       defined?(::Mongoid::Association) ? macro_mapping?(:has_many) : super
     end