active_scaffold 4.2.3 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d279597d030fea168fba4fbcc8cd44c99d02f44b4596c774ec4476db04d53cd1
-  data.tar.gz: 48fd530b7990ec28454a1b3adebd5da80ca1d833727b22563a85cef1e140747f
+  metadata.gz: 861686a739ce56092580a717c8a7e85765f5862389465ec8b86060f0924bdf14
+  data.tar.gz: b07820a816aa7652af10cdda2939bc7cfdc2e6307cf76c13ce86d224728e6d51
 SHA512:
-  metadata.gz: 1317103cf2e2344d0340f76f020a7df076f7aedff8f07b1c0a19499338d2d7941e762c51b33757cbcf3cd039d0d9f8bc8b57653282098f23fadfc069fd631bf0
-  data.tar.gz: 1300926c2397ea724f788a2b9899397e6c1e0ec6ca5a55a77677edf93dc98e5ed70e1b742c9a6ee8618067e4c378e58899d18e0fba9514e41cbde943c5589c01
+  metadata.gz: ac54f190035ed02602065f953c2e0172649e87893aead48e5895ac5ed07fb859efa5efcf4fca20af3496bcf3334b2eb22bfff286cf609a308aecb5c0c2c9a2bd
+  data.tar.gz: f5757a2c4e839f98eb0e65d4c010d1a73eaadb2a0de806671baa21a368e5847d114b9a22669677aa0070ef9d930f97e3c2983e5a183be36ad009441b17a4cd03

data/CHANGELOG.rdoc

@@ -1,8 +1,23 @@
+- Support translating enums (or options for :select form_ui on any column) nested in the pluralized name of the column, activerecord.attributes.model_name.pluralized_column.enum_value, defaults to old way activerecord.attributes.model_name.enum_value
+- Support :subform_columns option in column form_ui_options, or column's options, when the column is rendered as subform
+- Use :subform_columns option in :horizontal and :vertical show_ui too
+- Add layout multiple support to ActionColumns, so forms can have columns
+- Better exception handling when error is raised rendering a column, no more empty backtraces
+- Fix render field on subform for polymorphic association, or nested subforms in some cases
+- Add clear_form_column_if, works like hide_form_column_if but sends the column empty, to clear it
+- Add checkboxes form UI, like select form UI in collection associations but supporting DB columns (e.g. columns using serialize)
+- Support draggable form UI in non-association columns, like checkboxes (e.g. columns using serialize)
+- Add list UI for select_multiple, draggable, checkboxes, select and radio. Select and radio were handled by format_column_value, but the list UI works better
+- Support propshaft with dartsass-rails, so it doesn't depend on dartsass-sprockets and one dartsass gem must be added to the Gemfile
+
+= 4.2.4
+- Fix creating records with constraints on collection associations (broken on 4.2.2 on some cases)
+
 = 4.2.3
 - Make simplified searches on LogicalQueryParser bridge working with upstream gem, no need for my fork
 - Styles for radio form_ui
 - Fix style for checkbox list in subform
-- Fix constraints (broken on 4.2.2 on some cases)
+- Fix creating records with constraints on through associations (broken on 4.2.2 on some cases)
 
 = 4.2.2
 - Support setting form_ui_options with nil, for subforms

data/README.md

@@ -1,6 +1,5 @@
 
-Overview
-========
+# Overview
 [![Build status](https://github.com/activescaffold/active_scaffold/actions/workflows/ci.yml/badge.svg)](https://github.com/activescaffold/active_scaffold/actions/workflows/ci.yml)
 [![Maintainability](https://qlty.sh/gh/activescaffold/projects/active_scaffold/maintainability.svg)](https://qlty.sh/gh/activescaffold/projects/active_scaffold)
 [![Code Coverage](https://qlty.sh/gh/activescaffold/projects/active_scaffold/coverage.svg)](https://qlty.sh/gh/activescaffold/projects/active_scaffold)
@@ -10,8 +9,8 @@ Overview
 
 ActiveScaffold provides a quick and powerful user interfaces for CRUD (create, read, update, delete) operations for Rails applications. It offers additonal features including searching, pagination & layout control.  Rails >= 6.1.0 is supported, ruby >= 3.0 required.
 
-Branch Details
---------------
+## Branch Details
+
 master supports rails >= 7.2.x and ruby >= 3.2.0  
 4-2-stable supports rails >= 7.2.x and ruby >= 3.2.0
 
@@ -25,8 +24,7 @@ These versions are not supported anymore:
 3-3-stable supports rails 3.2.x and ruby >= 1.8  
 rails-3.2 supports Rails 3.1 & 3.2, and is the current source of the 3.2.x line of gems.
 
-Quick Start
------------
+## Quick Start
 To get started with a new Rails project
 
 Added to Gemfile
@@ -45,6 +43,8 @@ For rails 7.x, install generator will add `active_scaffold` to `config/importmap
 
 For rails 6.1, install generator will create `app/assets/javascripts/application.js`, add it, and `active_scaffold/manifest.js`, to `app/assets/config/manifest.js` and add `javascript_include_tag` in the layout, as ActiveScaffold doesn't work with webpack. It will add `jquery` to `app/assets/javascripts/application.js` too if query-rails gem is available, although Jquery may be loaded by packs too and it will work, it won't add `jquery_ujs` or `@rails/ujs` as it's added to `app/javascript/packs/application.js` by default.
 
+-- TODO: Add notes about dartsass-rails for propshaft or dartsass-sprockets for sprockets.
+
 Run the following commands
 
 ```console
@@ -59,6 +59,107 @@ Run the app and visit localhost:3000/<plural_model>
 
 It's recommended to call `clear_helpers` in ApplicationController, as some helpers defined by ActiveScaffold, such as active_scaffold_enum_options, options_for_association_conditions, association_klass_scoped, are usually overrided for different controllers, and it may cause issues when all helper modules are available to every controller, specially when models have associations or columns with the same name but need different code for those overrided helper methods.
 
+## Stylesheet Loading
+
+ActiveScaffold provides flexible stylesheet loading to work with both Sprockets and Propshaft, choose which want you want adding `dartsass-sprockets` or `dartsass-rails` to your Gemfile.
+ActiveScaffold has SASS variables to define the colours, but, from version 4.3, the values are moved to CSS variables. It's still possible to change the colours with the old SASS variables, but they may be removed in the future.
+
+### With Propshaft + dartsass-rails
+
+Traditionally, ActiveScaffold loaded all CSS needed, from itself and other ActiveScaffold plugins, and every other library integrated with bridges, such as RecordSelect, Chosen or TinyMCE. It was done using css.erb files, but with propshaft erb is not supported, so a SCSS file is generated when app boots in development and running `rake assets:precompile` on the deployment. There is a task to generate them, `active_scaffold:assets:generate`.
+
+Also, when using jquery-ui-rails gem, the CSS is generated from the erb in the gem in the same way.
+
+```scss
+// In application.scss
+@use 'active_scaffold/core' with (
+// set values to variables
+);
+```
+
+
+### With Sprockets + dartsass-sprockets
+
+Add `@use` to application.scss, it will load all CSS needed, jQuery UI if jquery-ui-rails gem is installed, and CSS for other ActiveScaffold plugins and bridges.
+
+```scss
+@use 'active_scaffold' with (
+// set values to variables
+);
+```
+
+In this case, if you want more flexibility, you have to use `@use` with each individual CSS file that ActiveScaffold provides:
+
+```scss
+@use 'active_scaffold/variables' with (
+// set values to variables
+);
+@use 'active_scaffold/colours';
+@use 'active_scaffold/layout';
+@use 'active_scaffold/images';
+// load CSS for other ActiveScaffold plugins and bridges
+```
+
+## Javascript Loading
+
+There are 2 options to load JS with propshaft, using importmaps or loading the files individually.
+
+### Propshaft + importmaps
+
+When using importmaps, add active_scaffold to importmap, it should have jquery and jquery_ujs or rails_ujs too:
+
+```ruby
+pin 'active_scaffold', to: 'active_scaffold/load.js'
+pin 'jquery'
+pin 'jquery_ujs'
+```
+
+In the app/javascript/application.js, import jquery, jquery_ujs or rails_ujs and active_scaffold:
+
+```js
+import 'jquery'
+import 'jquery_ujs'
+import 'active_scaffold'
+```
+
+In the layout, load the importmap modules and call active_scaffold_javascript_tag, that includes some script tags which was in js.erb when using sprockets, so JS ActiveScaffold dependencies are loaded (jquery UI if using jquery-ui-rails, and JS for other ActiveScaffold plugins and bridges): 
+
+```erb
+    <%= javascript_importmap_tags %>
+    <%= active_scaffold_javascript_tag %>
+```
+
+### Propshaft
+
+If you're not using importmaps, then you can load the JS files individually, but you only need to load jquery and jquery_ujs or rails_ujs, and then call active_scaffold_javascript_tag:
+
+```erb
+    <%= javascript_include_tag 'jquery', 'jquery_ujs' %>
+    <%= active_scaffold_javascript_tag %>
+```
+
+### With Sprockets
+
+For the JS, you can keep using `//= require active_scaffold` in your application.js
+
+It's possible to use importmaps too, add active_scaffold to importmap, that should have jquery and jquery_ujs or rails_ujs too:
+
+```ruby
+pin 'active_scaffold'
+pin 'jquery'
+pin 'jquery_ujs'
+```
+
+In the app/javascript/application.js, import jquery, jquery_ujs or rails_ujs and active_scaffold:
+
+```js
+import 'jquery'
+import 'jquery_ujs'
+import 'active_scaffold'
+```
+
+In the layout, load the importmap modules, in this case we are not using `to` in the importmap, so the js.erb file will be used, that include some generated code, and calling active_scaffold_javascript_tag is not needed.
+
 Threadsafe
 ----------
 
@@ -117,4 +218,4 @@ A ruby translation project managed on [Locale](http://www.localeapp.com/) that's
 Happy translating!
 
 ### Powered by
-[![RubyMine logo](https://resources.jetbrains.com/storage/products/company/brand/logos/RubyMine.png)](https://jb.gg/OpenSource)
+[![RubyMine logo](https://resources.jetbrains.com/storage/products/company/brand/logos/RubyMine.png)](https://jb.gg/OpenSource)