active_scaffold_child_memberships 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 695eb1a91c4345770c5bc16711996ad375555906d762d191b8bd9b18d93ba063
-  data.tar.gz: 9e0c2123bff4f5de59075d4de5d298fa9123cffcb33a1587de0fbf216b61d46e
+  metadata.gz: 3ed22261d2b7d6a07b9f61b19b419bf4ff53491b57671aa5e702f629f41d1b25
+  data.tar.gz: f70a457b8bdfbfe185141a861ee6e1b91cd4960953148e8cdffbff273ec8e56c
 SHA512:
-  metadata.gz: afc624967c0eb0f8d69e8a040cc601f18ee39a7752513513d863a54d0e84dced301d00aa3310f51ec05da9bee9d660ed977eb7bf2e0281ce00fed73bccf6e9f3
-  data.tar.gz: 658231e5a370393e870cd84432c3bbab28a4b20c314a37f1c0f33d7a564a09501edca8dabd45a41a35fcae15e6fe08beadbd9e48eef5522a18684e86d1ef4ab9
+  metadata.gz: 6a183a7b1b809c43b2513aba3b85f595c7f3a559bd5d1cd86004dd572639b4b1473cd2745cf8b32a21c61c02a21d14e3ef9162d6e109ac0803dbc19fe7aa299a
+  data.tar.gz: 78bc6ea3fc431364211180efbc05524eba8e1215d807853447034af896fe17422dbc243559151f651ea242f35247e221553632aa66f96154113061e781c7c45e

data/README.md

@@ -6,3 +6,115 @@ It requires ActiveScaffold 4.0, and RecordSelect 4.0.2 if want to use :recordsel
 
 ## Usage
 
+ActiveScaffold allows to edit memberships on one record with :select form_ui, for either has_and_belongs_to_many, or has_many through. For example, using :select in :roles column with any of these examples would work in the same way:
+
+```ruby
+class User < ApplicationRecord
+  has_and_belongs_to_many :roles
+end
+
+class User < ApplicationRecord
+  has_many :role_memberships
+  has_many :roles, through: :role_memberships
+end
+
+class RoleMembership < ApplicationRecord
+  belongs_to :user
+  belongs_to :role
+end
+```
+
+But sometimes you may have User model grouped in other model, with has_many association, and may want to edit memberships for all the users in the group.
+
+```ruby
+class Group < ApplicationRecord
+  has_many :users
+end
+```
+
+This form_ui :child_memberships can be used in a :roles has_many through association:
+
+```ruby
+class Group < ApplicationRecord
+  has_many :users
+  has_many :roles, through: :users
+end
+class GroupsController < ApplicationController
+  active_scaffold :group do |conf|
+    conf.update.columns = [:name, :roles]
+    conf.columns[:roles].form_ui = :child_memberships
+  end
+end
+```
+
+Then you get a table, with all users in the group in the rows, and roles in the columns. Only the assigned roles are in the columns by default, and new column can be added with a select tag to pick a new role to assign to users:
+
+![image](https://github.com/user-attachments/assets/793b07bd-b7bf-4336-a319-b40136cdb5e8)
+
+The form_ui used to select the record of the new columns can be changed, with options for the form_ui (or column's options), with the key `:add_column_ui`, for example to use RecordSelect:
+
+```ruby
+    conf.columns[:roles].form_ui = :child_memberships, {add_column_ui: :record_select}
+```
+
+If no form_ui is defined with `:add_column_ui`, it defaults to `:select`. If ui options must be passed to the form_ui, they can be added using an array with the form UI and the options hash:
+
+```ruby
+    conf.columns[:roles].form_ui = :child_memberships, {add_column_ui: [:select, {include_blank: 'Pick one'}]}
+```
+
+The method used for the label in the rows is defined with `:label_method`, defaults to `:to_label`. For example, to use `short_name` method of Role model:
+
+```ruby
+    conf.columns[:roles].form_ui = :child_memberships, {label_method: :short_name}
+```
+
+The method used for the label in the rows is defined with `:child_label_method`, defaults to `:to_label`. For example, to use `first_name` method of User model:
+
+```ruby
+    conf.columns[:roles].form_ui = :child_memberships, {child_label_method: :first_name}
+```
+
+The label of the link to add a new column uses `:add_label` translation key, in the `:active_scaffold` scope. It can be changed to a string, skipping the translation, or other symbol to use other translation key, in the `:active_scaffold` scope. The translation can use `%{model}` variable to display the name of the associated model.
+
+```ruby
+    conf.columns[:roles].form_ui = :child_memberships, {add_label: 'Add other role'}
+```
+
+If new columns are not allowed, it can be disabled using `add_label: false`:
+
+```ruby
+    conf.columns[:roles].form_ui = :child_memberships, {add_label: false}
+```
+
+## Overriding Helpers
+
+The helper `active_scaffold_child_memberships_helper` can be overrided to change the default columns rendered, instead of the assigned records only. For example to render all available roles:
+
+```ruby
+def active_scaffold_child_memberships_helper(column, row_records)
+  column.association.klass.all
+end
+```
+
+The helper can use model prefix too:
+
+```ruby
+def group_active_scaffold_child_memberships_helper(column, row_records)
+  column.association.klass.all
+end
+```
+
+To change the record selector for new columns, the helper `active_scaffold_child_memberships_new_column` can be overrided instead of using `:add_column_ui`. It supports model prefix too. The field should be rendered disabled, as it's a template to be cloned when the add column link is clicked:
+
+```ruby
+def active_scaffold_child_memberships_new_column(column, name, source_col, ui_options)
+  if column == :roles
+    select_tag name, options_from_collection_for_select(Role.allowed_for(current_login), :id, :name), id: nil, disabled: true
+  else
+    super
+  end
+end
+```
+
+Also, the available records can be changed with the usual methods, `options_for_association_conditions` and `association_klass_scoped`, they receive the source association of the has_many through association (`:roles` in the example), and an empty record of the through association.

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  active_scaffold:
+    add_column: Add %{model}

data/config/locales/es.yml

@@ -0,0 +1,3 @@
+es:
+  active_scaffold:
+    add_column: Añadir %{model}

data/lib/active_scaffold_child_memberships/helpers.rb

@@ -42,7 +42,6 @@ module ActiveScaffoldChildMemberships
 
     def active_scaffold_child_memberships_members(column, row_records)
       row_records.flat_map(&column.association.source_reflection.name).uniq
-      #column.association.klass.all
     end
 
     def active_scaffold_child_memberships_new_column(column, name, source_col, ui_options)

data/lib/active_scaffold_child_memberships/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_scaffold_child_memberships
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sergio Cambra
@@ -35,6 +35,8 @@ files:
 - LICENSE
 - README.md
 - app/assets/javascripts/active_scaffold_child_memberships.js
+- config/locales/en.yml
+- config/locales/es.yml
 - lib/active_scaffold_child_memberships.rb
 - lib/active_scaffold_child_memberships/attribute_params.rb
 - lib/active_scaffold_child_memberships/engine.rb