active_scaffold_config_list 3.5.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a83952873751f4e7149b4e05e87d2e10cd6d36d6554578e50839d590f89233be
-  data.tar.gz: 6aa24c34a3a32f89238d70974bf509e21c8db01fbb54e66a25d22ceff0b5e0bc
+  metadata.gz: be3b1357610333757d013332316debd39b636bb7f690a3cf57ed27088faf9abe
+  data.tar.gz: 8940de8dc18e5575c74ed3604ddd22dfa6b06abf9a04503d1ffb2335858eb36c
 SHA512:
-  metadata.gz: 7dba2ca3fe3875206b92b44c9f18bf3e7f1b0ba1cc08eb49e7cf1441eba9763aed4307b8cbfa68ac4fb9ace1d05efa1352d434500c55ea6642ed95f64c236c0f
-  data.tar.gz: b92ffd411117506b501bf1133b3777e6ce93307f1b5bee06d5de9dbc2e938dc3bfae821e941e09ce8450688a9eacb0633c08ea832a025d6e508b7776afbb853d
+  metadata.gz: 8171e1910707eca649a41a9df49b7c4333be31a65fde1d9ddfc083c19f92dabc76fd5fef0f5cd3b8f245b5a252033484a3b559a2ccd78a324247042de32ae776
+  data.tar.gz: 6582db9e3c46b42c21330c4b67d0d726e6d55395db2e091849a59de9d09ff73b2b4ae261a2a6592819ffd7e9e7f308ca84660e57b35acbbe9b7daca05b40d73f

data/README.md

@@ -0,0 +1,84 @@
+This works with Rails >= 4.0 and ActiveScaffold >= 3.4.4
+Version 3.3.x worked with Rails 3.2 and ActiveScaffold >= 3.4.4
+Version 3.2.x worked with Rails 3.2 and ActiveScaffold >= 3.3.0
+
+Usage:
+
+```rb
+active_scaffold :model do |conf|
+  conf.actions.add :config_list
+end
+````
+
+
+Overview
+========
+
+A plugin for Active Scaffold that provides the ability to choose the column to show in the scaffold list at run-time.
+
+You have the option of defining a default set of columns for the controller. For example:
+```rb
+config.config_list.default_columns = [:name, :project, :amount]
+```
+If this is not defined then active_scaffold_config.list.columns is used.
+
+This is useful when you want the option to look at a potentially large number of columns but be able to 
+easily reset back to something that fits on the screen without horizontal scrolling.
+
+The available columns in the configure action are the columns defined in `list.columns`. For that reason, if
+`config_list.default_columns` is not defined, then it will default to `list.columns`, and the users only will be able
+to remove some columns, they won't be able to add other columns.
+
+The configuration data will be saved on the session. It can be saved on the DB defining a method on the user model
+(the one returned by current_user method) to return a record for current controller, or empty record if user has no
+list configuration, and setting config_list to use that method.
+
+```rb
+conf.config_list.save_to_user = :config_list_for
+```
+
+The model storing list configuration must have a config_list text column storing the columns list, and config_list_sort
+serialized text column. For example:
+
+```rb
+# == Schema Information
+#
+# Table name: list_configurations
+#
+#  id                  :bigint           not null, primary key
+#  config_list         :text
+#  config_list_sorting :text
+#  created_at          :datetime         not null
+#  updated_at          :datetime         not null
+#  controller_id       :string(255)
+#  user_id             :bigint
+#
+# Indexes
+#
+#  index_list_configurations_on_user_id  (user_id)
+#
+
+class ListConfiguration < ApplicationRecord
+  belongs_to :user
+  serialize :config_list_sorting, JSON
+end
+```
+
+Then in the User model, define the association, and the method returning the config list for the requested controller.
+The method has 2 arguments, `controller_id` and `controller_name`, so only need to save one of them, depending if user
+configuration must be shared on different conditions for embedded controllers, and each parent for nested controllers,
+or save unique configurations. The `controller_id` argument will be different in embedded controllers, nested controllers
+and regular controllers, as it will use `active_scaffold_session_storage_key`, and the controller_name will be the same
+always.
+
+```rb
+class User < ActiveRecord::Base
+  has_many :list_configurations
+  def config_list_for(controller_id, controller_name)
+    # Use controller_id to allow having different columns on different nested or embedded conditions
+    list_configurations.where(controller_id: controller_id).first_or_initialize
+    # Or use controller_name for one configuration for the controller, even embedded or nested
+    list_configurations.where(controller_id: controller_name).first_or_initialize
+  end
+end
+```

data/lib/active_scaffold/actions/config_list.rb

@@ -4,17 +4,6 @@ module ActiveScaffold::Actions
     def self.included(base)
       base.before_action :store_config_list_params, :set_default_sorting, :only => [:index]
       base.helper_method :config_list_params, :config_list_sorting
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def config_list_session_storage_method
-        @config_list_session_storage_method
-      end
-
-      def config_list_session_storage_method=(value)
-        @config_list_session_storage_method = value
-      end
     end
 
     def show_config_list
@@ -57,12 +46,16 @@ module ActiveScaffold::Actions
     end
 
     def config_list_session_storage_method
-      respond_to?(:custom_config_list_session_storage) ? :custom_config_list_session_storage : :active_scaffold_session_storage
+      @config_list_session_storage_method ||=
+        if respond_to?(:custom_config_list_session_storage)
+          :custom_config_list_session_storage
+        else
+          :active_scaffold_session_storage
+        end
     end
 
     def config_list_session_storage
-      self.class.config_list_session_storage_method = self.config_list_session_storage_method unless self.class.config_list_session_storage_method
-      send(self.class.config_list_session_storage_method)
+      send(config_list_session_storage_method)
     end
 
     def active_scaffold_current_user
@@ -77,7 +70,6 @@ module ActiveScaffold::Actions
         config_list_session_storage['config_list_sorting'] = nil
       end
       active_scaffold_config.list.user['sort'] = nil
-      logger.debug "list #{active_scaffold_config.list.sorting.object_id}"
       @config_list_params = nil
       @config_list_sorting = nil
     end
@@ -99,7 +91,7 @@ module ActiveScaffold::Actions
     def objects_for_etag
       # only override when list_columns is called, so 
       if @list_columns && config_list_record
-        @last_modified = [@last_modified, config_list_record.updated_at].compact.maximum if config_list_record.respond_to? :updated_at
+        @last_modified = [@last_modified, config_list_record.updated_at].compact.max if config_list_record.respond_to? :updated_at
         objects = super
         if objects.is_a? Hash
           objects.merge(:etag => [objects[:etag], config_list_record])

data/lib/active_scaffold_config_list/version.rb

@@ -2,7 +2,7 @@ module ActiveScaffoldConfigList
   module Version
     MAJOR = 3
     MINOR = 5
-    PATCH = 0
+    PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_scaffold_config_list
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.5.1
 platform: ruby
 authors:
 - Sergio Cambra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-05 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_scaffold
@@ -43,10 +43,10 @@ email: activescaffold@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README
+- README.md
 files:
 - LICENSE.txt
-- README
+- README.md
 - app/views/active_scaffold_overrides/_show_config_list_form.html.erb
 - app/views/active_scaffold_overrides/_show_config_list_form_body.html.erb
 - app/views/active_scaffold_overrides/show_config_list_form.html.erb

data/README

@@ -1,28 +0,0 @@
-This works with Rails >= 4.0 and ActiveScaffold >= 3.4.4
-Version 3.3.x worked with Rails 3.2 and ActiveScaffold >= 3.4.4
-Version 3.2.x worked with Rails 3.2 and ActiveScaffold >= 3.3.0
-
-Usage:
-active_scaffold :model do |conf|
-  conf.actions.add :config_list
-end
-
-
-Overview
-
-A plugin for Active Scaffold that provides the ability to choose the column to show in the scaffold list at run-time
-
-The configuration data will be saved on the session. It can be saved on the DB defining a method to return a record
-for current controller, or empty record if user has no list configuration, and setting config_list to use that method.
-
-conf.config_list.save_to_user = :config_list_for
-
-class User < ActiveRecord::Base
-  has_many :list_configurations
-  def config_list_for(controller_id, controller_name)
-    list_configurations.where(:controller_id => controller_id).first_or_initialize # different columns on different nested or embedded conditions
-    list_configurations.where(:controller_id => controller_name).first_or_initialize # one configuration for the controller, even embedded or nested
-  end
-end
-
-The model storing list configuration must have a config_list text column storing the config list, and config_list_sort serialized text column.