active_scaffold_config_list 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a83952873751f4e7149b4e05e87d2e10cd6d36d6554578e50839d590f89233be
-  data.tar.gz: 6aa24c34a3a32f89238d70974bf509e21c8db01fbb54e66a25d22ceff0b5e0bc
+  metadata.gz: f2c3d3d9d64fafc128d38bf32437db1f53505bde01601d1186f562f3df76e3cf
+  data.tar.gz: f43e78ff81d757bef7fe7ea35d79a5ad73d5b1280dc6460a371e7cf98b212c9e
 SHA512:
-  metadata.gz: 7dba2ca3fe3875206b92b44c9f18bf3e7f1b0ba1cc08eb49e7cf1441eba9763aed4307b8cbfa68ac4fb9ace1d05efa1352d434500c55ea6642ed95f64c236c0f
-  data.tar.gz: b92ffd411117506b501bf1133b3777e6ce93307f1b5bee06d5de9dbc2e938dc3bfae821e941e09ce8450688a9eacb0633c08ea832a025d6e508b7776afbb853d
+  metadata.gz: 61ee9652c00712cf1a5c3163f358cc4c2c6d46accec2abde2c554aaa3604ce09d98c0af694028aba107d4c7254bb52d221a9921c279804eb678a9ea0850d9c51
+  data.tar.gz: 77e1bbda33907266fb31d67722a85c8e22d06b61bd0181a476c80157c52a32c30ba196d579625a5fd45874da2a8b600d900835fce0461cbb43ad6ecf658f364e

data/README.md

@@ -0,0 +1,93 @@
+This works with Rails >= 5.2 and ActiveScaffold >= 3.7.1  
+Version 3.4.x and 3.5.x worked 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
+```
+
+It can be changed globally for the app in `ActiveScaffold.defaults` in an initializer, such as:
+
+```rb
+ActiveScaffold.defaults do |config|
+  config.config_list.save_to_user
+end
+```
+
+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/app/views/active_scaffold_overrides/_show_config_list_form.html.erb

@@ -1,16 +1,16 @@
-<% url_options = params_for(:action => :index, :escape => false, :config_list => nil) -%>
+<% url_options = params_for(action: :index, escape: false, config_list: nil) -%>
 <%=
-options = {:id => element_form_id(:action => :config_list),
-           :class => "as_form config_list",
-           :remote => request.xhr?,
-           :method => :get,
+options = {id: element_form_id(action: :config_list),
+           class: "as_form config_list",
+           remote: request.xhr?,
+           method: :get,
            'data-loading' => true}
 form_tag url_options, options %>
   <h4><%= active_scaffold_config.config_list.label -%></h4>
-  <%= render :partial => 'show_config_list_form_body' %>
+  <%= render 'show_config_list_form_body' %>
   <p class="form-footer">
-    <%= submit_tag as_(:config_list), :class => "submit" %>
-    <%= link_to as_(:reset), url_for(url_options.merge(:config_list => '')), :class => 'as_cancel', :remote => true, :data => {:refresh => true} %>
-    <%= loading_indicator_tag(:action => :config_list) %>
+    <%= submit_tag as_(:config_list), class: "submit" %>
+    <%= link_to as_(:reset), url_for(url_options.merge(config_list: '')), class: 'as_cancel', remote: true, data: {refresh: true} %>
+    <%= loading_indicator_tag(action: :config_list) %>
   </p>
 </form>

data/app/views/active_scaffold_overrides/_show_config_list_form_body.html.erb

@@ -1,33 +1,31 @@
 <ol class="form">
+  <% if config_list_columns? %>
   <li class="form-element">
     <dl><dt><label><%= as_ :columns %></label></dt>
-    <dd><ul class="<%= active_scaffold_config.config_list.draggable ? 'draggable-lists' : 'sortable-container' %>" id="<%= element_form_id(:action => :config_list) %>-columns">
-<%
-  if !config_list_params.nil? && config_list_params.is_a?(Array)
-    config_list = config_list_params
-    list_columns.concat active_scaffold_config.list.columns.visible_columns.select{|column| config_list.exclude? column.name}
-  end
-%>
-<% list_columns.each do |c| %>
+    <dd><ul class="<%= active_scaffold_config.config_list.draggable ? 'draggable-lists' : 'sortable-container' %>" id="<%= element_form_id(action: :config_list) %>-columns">
+<% config_list_columns.each do |label, column| %>
       <li class="sortable">
-        <%= check_box_tag 'config_list[]', c.name.to_s, (config_list_params.nil? ? true : config_list_params.include?(c.name)), {:id => nil}%>
-        <label><%= column_heading_label(c) %></label>
+        <%= check_box_tag 'config_list[]', column.to_s, (config_list_params.nil? ? true : config_list_params.include?(column)), {id: nil}%>
+        <label><%= label %></label>
       </li>
 <% end %>
     </ul></dd></dl>
   </li>
+  <% end %>
+  <% if config_list_sorting? %>
   <li class="form-element">
     <dl><dt><label><%= as_ :default_sorting %></label></dt>
     <dd><ol>
 <%
-  columns_options = list_columns.select{|c| c.sortable?}.map{|c| [c.label, c.name]}
-  order_options = ['asc', 'desc'].map{ |v| [as_(v), v] }
+  columns_options = list_columns.select(&:sortable?).map { |c| [c.label, c.name] }
+  order_options = ['asc', 'desc'].map { |v| [as_(v), v] }
   selected = config_list_sorting || []
   3.times do |i|
 %>
-      <li><%= select_tag "config_list_sorting[#{i}][]", options_for_select(columns_options, :selected => selected[i].try(:first)), :include_blank => as_(:_select_), :class => 'column' %>
-      <%= select_tag "config_list_sorting[#{i}][]", options_for_select(order_options, :selected => selected[i].try(:last)), :include_blank => as_(:_select_), :class => 'order' %></li>
+      <li><%= select_tag "config_list_sorting[#{i}][]", options_for_select(columns_options, selected: selected[i]&.first), include_blank: as_(:_select_), class: 'column' %>
+      <%= select_tag "config_list_sorting[#{i}][]", options_for_select(order_options, selected: selected[i]&.last), include_blank: as_(:_select_), class: 'order' %></li>
 <% end %>
     </ol></dd></dl>
   </li>
+  <% end %>
 </ol>

data/app/views/active_scaffold_overrides/show_config_list_form.html.erb

@@ -1,5 +1,5 @@
 <div class="active-scaffold">
   <div class="config_list-view view">
-    <%= render :partial => 'show_config_list_form' -%>
+    <%= render 'show_config_list_form' -%>
   </div>
 </div>

data/lib/active_scaffold/actions/config_list.rb

@@ -2,28 +2,17 @@ module ActiveScaffold::Actions
   module ConfigList
     
     def self.included(base)
-      base.before_action :store_config_list_params, :set_default_sorting, :only => [:index]
+      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
       respond_to do |type|
         type.html do
-          render(:action => 'show_config_list_form', :layout => true)
+          render(action: 'show_config_list_form', layout: true)
         end
         type.js do
-          render(:partial => 'show_config_list_form', :layout => false)
+          render(partial: 'show_config_list_form', layout: false)
         end
       end
     end
@@ -57,12 +46,24 @@ 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 config_list_session_storage_key
+      active_scaffold_session_storage_key
+    end
+
+    def config_list_controller_name
+      controller_name
     end
 
     def active_scaffold_current_user
@@ -71,20 +72,19 @@ module ActiveScaffold::Actions
 
     def delete_config_list_params
       if active_scaffold_config.config_list.save_to_user && active_scaffold_current_user
-        active_scaffold_current_user.send(active_scaffold_config.config_list.save_to_user, active_scaffold_session_storage_key, controller_name).destroy
+        active_scaffold_current_user.send(active_scaffold_config.config_list.save_to_user, config_list_session_storage_key, config_list_controller_name).destroy
       else
         config_list_session_storage['config_list'] = nil
         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
 
     def save_config_list_params(config_list, config_list_sorting)
       if active_scaffold_config.config_list.save_to_user && active_scaffold_current_user
-        record = active_scaffold_current_user.send(active_scaffold_config.config_list.save_to_user, active_scaffold_session_storage_key, controller_name)
+        record = active_scaffold_current_user.send(active_scaffold_config.config_list.save_to_user, config_list_session_storage_key, config_list_controller_name)
         record.config_list = config_list.join(',')
         record.config_list_sorting = config_list_sorting if record.respond_to? :config_list_sorting
         record.save
@@ -99,10 +99,10 @@ 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])
+          objects.merge(etag: [objects[:etag], config_list_record])
         else
           [objects, config_list_record]
         end
@@ -113,20 +113,22 @@ module ActiveScaffold::Actions
 
     def config_list_record
       return @config_list_record if defined? @config_list_record
-      @config_list_record = if active_scaffold_config.config_list.save_to_user
-        if active_scaffold_current_user
-          active_scaffold_current_user.send(active_scaffold_config.config_list.save_to_user, active_scaffold_session_storage_key, controller_name)
+      @config_list_record =
+        if active_scaffold_config.config_list.save_to_user && active_scaffold_current_user
+          active_scaffold_current_user.send(active_scaffold_config.config_list.save_to_user, config_list_session_storage_key, config_list_controller_name)
         end
-      end
     end
 
     def config_list_params
-      @config_list_params = if config_list_record 
-        params = config_list_record.config_list
-        params.split(',').map(&:to_sym) if params
-      else
-        config_list_session_storage['config_list']
-      end unless defined? @config_list_params
+      unless defined? @config_list_params
+        @config_list_params =
+          if config_list_record
+            params = config_list_record.config_list
+            params.split(',').map(&:to_sym) if params
+          else
+            config_list_session_storage['config_list']
+          end
+      end
       @config_list_params || config_list_default_columns
     end
 
@@ -135,11 +137,14 @@ module ActiveScaffold::Actions
     end
 
     def config_list_sorting
-      @config_list_sorting = if config_list_record 
-        config_list_record.config_list_sorting if config_list_record.respond_to? :config_list_sorting
-      else
-        config_list_session_storage['config_list_sorting']
-      end unless defined? @config_list_sorting
+      unless defined? @config_list_sorting
+        @config_list_sorting =
+          if config_list_record
+            config_list_record.config_list_sorting if config_list_record.respond_to? :config_list_sorting
+          else
+            config_list_session_storage['config_list_sorting']
+          end
+      end
       @config_list_sorting
     end
 
@@ -147,8 +152,9 @@ module ActiveScaffold::Actions
       @list_columns ||= begin
         columns = super
         if config_list_params.present?
-          config_list = Hash[config_list_params.each_with_index.map{|c,i| [c,i]}]
-          columns.select{|column| config_list.include? column.name}.sort{|x,y| config_list[x.name] <=> config_list[y.name]}
+          config_list = config_list_params.each.with_index.to_h
+          columns.select { |column| config_list.include? column.name }.
+            sort { |x, y| config_list[x.name] <=> config_list[y.name] }
         else
           columns
         end
@@ -158,7 +164,7 @@ module ActiveScaffold::Actions
     # The default security delegates to ActiveRecordPermissions.
     # You may override the method to customize.
     def config_list_authorized?
-      authorized_for?(:action => :read)
+      authorized_for?(action: :read)
     end
   end
 end

data/lib/active_scaffold/helpers/config_list_helpers.rb

@@ -0,0 +1,24 @@
+module ActiveScaffold
+  module Helpers
+    module ConfigListHelpers
+      def config_list_sorting?
+        true
+      end
+
+      def config_list_columns?
+        true
+      end
+
+      def config_list_columns
+        columns =
+          if config_list_params.is_a?(Array)
+            config_list = config_list_params
+            list_columns.concat active_scaffold_config.list.columns.visible_columns.select { |column| config_list.exclude? column.name }
+          else
+            list_columns
+          end
+        columns.map { |c| [column_heading_label(c), c.name] }
+      end
+    end
+  end
+end

data/lib/active_scaffold_config_list/engine.rb

@@ -5,5 +5,11 @@ module ActiveScaffoldConfigList
         self::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:show_config_list] = :get
       end
     end
+
+    initializer 'active_scaffold_config_list.action_view' do
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, ActiveScaffold::Helpers::ConfigListHelpers
+      end
+    end
   end
 end

data/lib/active_scaffold_config_list/version.rb

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

data/lib/active_scaffold_config_list.rb

@@ -9,4 +9,9 @@ module ActiveScaffold
   module Config
     ActiveScaffold.autoload_subdir('config', self, File.dirname(__FILE__))
   end
+
+  module Helpers
+    ActiveScaffold.autoload_subdir('helpers', self, File.dirname(__FILE__))
+  end
 end
+ActiveSupport.run_load_hooks(:active_scaffold_config_list)

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.6.0
 platform: ruby
 authors:
 - Sergio Cambra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-05 00:00:00.000000000 Z
+date: 2024-12-19 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
@@ -59,6 +59,7 @@ files:
 - config/locales/ru.yml
 - lib/active_scaffold/actions/config_list.rb
 - lib/active_scaffold/config/config_list.rb
+- lib/active_scaffold/helpers/config_list_helpers.rb
 - lib/active_scaffold_config_list.rb
 - lib/active_scaffold_config_list/engine.rb
 - lib/active_scaffold_config_list/version.rb
@@ -74,14 +75,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: User specific column configuration for ActiveScaffold

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.