b4um_generators 0.2.16 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3872ce0dc22b0119d636611c3948c941da818ed3c8ee65301da95c0570ba677d
-  data.tar.gz: 77a2d8228dddbb5852325b81c1e1cc65482dc429912629884cf7c580438dac4e
+  metadata.gz: 167af7d5ad10e01abf428bf058e8d0ebc1b85e7791e43882dd1c53966d1ef89f
+  data.tar.gz: 715da7ed28265ec0f4451684dd35d375c749fbb8eb7f06b915a13e8bbadea26b
 SHA512:
-  metadata.gz: 1e44802b32dc4e9ee22c7bd2b4507a34a692777ca0a940b904f0403223b0d36b7bbd9c403579a13cd2fe9409d76f86fd21cc487022d13b4abd7de0ef600f4e6a
-  data.tar.gz: 1a20c4ba742c086c788c5426085724d3bea2a3a01e30229ea1dc0f190b6ad4d2819a5c5609e326dd95fdfc4b70beb728260ded64a26416d0725322144e7f6b1b
+  metadata.gz: 2478f3db2a6f42ca3ca83158f86d9313676b5263c07b324f69d786b587ed603ab5af6a2319d123e7524e4cab508530431a161c18ed3e5e1deea50cd581f90a4f
+  data.tar.gz: 7c874c56a5057bbb5110b683ae3cdfbfd84c4471f5f40cc96e2f53fb1ca32843df64f8f5dde7ba3614274cad19e3fa33e5e563c217b9d46394f4e5dbbbdb9c16

data/README.de.md

@@ -732,6 +732,86 @@ Die Suche bietet:
 - Kein zusätzliches Such-Gem erforderlich
 - Sichere wiederholte Ausführung des Generators
 
+## Sortable
+
+Füge einer bestehenden Ressource eine dauerhaft gespeicherte Sortierreihenfolge hinzu:
+
+```bash
+bin/rails generate b4um:sortable Product
+bin/rails db:migrate
+```
+
+Der Generator fügt eine `position`-Spalte hinzu und weist bestehenden Datensätzen beim Ausführen der generierten
+Migration automatisch Positionen zu.
+
+Neue Datensätze werden automatisch am Ende der Liste eingefügt.
+
+Standardmäßig wird die bestehende Index-Seite zur sortierbaren Seite:
+
+```text
+/products
+```
+
+Das bestehende Index-Layout wird auf das b4um-Sortable-Layout umgestellt. Die gespeicherte Position wird außerdem als
+Standardsortierung der Ressource verwendet.
+
+Sortable bietet:
+
+- Dauerhaft in der Datenbank gespeicherte ganzzahlige Positionen
+- Automatische Positionierung bestehender Datensätze während der Migration
+- Automatische Positionierung neuer Datensätze am Ende
+- Drag-and-Drop-Sortierung mit Stimulus
+- Direkte Änderung der Position über ein Zahlenfeld
+- Automatisches Verschieben der betroffenen Datensätze
+- Lückenlose Positionen nach dem Verschieben oder Löschen von Datensätzen
+- Serverseitige Sortierung innerhalb einer Datenbanktransaktion
+- CSRF-geschützte Update-Anfragen
+- Integration mit b4um Search und Pagination
+- Kein zusätzliches Sortier-Gem erforderlich
+- Sichere wiederholte Ausführung des Generators
+
+### Separate Sortierseite
+
+Mit `--path` kann eine separate Sortierseite erstellt werden:
+
+```bash
+bin/rails generate b4um:sortable Product --path=sortierung
+bin/rails db:migrate
+```
+
+Dadurch wird die sortierbare Seite genau unter folgender URL erstellt:
+
+```text
+/sortierung
+```
+
+während der normale Ressourcen-Index weiterhin unter
+
+```text
+/products
+```
+
+verfügbar bleibt.
+
+Das bestehende Index-Layout, beispielsweise Bento oder Table, bleibt unverändert. Es verwendet weiterhin die
+gespeicherte `position`-Sortierung.
+
+Die separate Sortierseite verwendet den bestehenden Controller der Ressource. Es wird kein zusätzlicher Controller und
+kein Namespace erzeugt.
+
+Der mit `--path` angegebene Wert bestimmt direkt die URL der separaten Sortierseite. Zum Beispiel:
+
+```bash
+bin/rails generate b4um:sortable Product --path=produktuebersicht
+bin/rails generate b4um:sortable Product --path=verwaltung
+bin/rails generate b4um:sortable Product --path=admin
+```
+
+Dadurch entstehen entsprechend `/produktuebersicht`, `/verwaltung` und `/admin`.
+
+Eine separate Sortierseite ermöglicht außerdem, nur die `sort`-Action durch die Authentifizierung zu schützen, während
+der normale Ressourcen-Index öffentlich bleiben kann.
+
 ## Kommentare
 
 Füge einem bestehenden Modell polymorphe Kommentare hinzu:
@@ -1135,7 +1215,7 @@ wird.
 
 ## Version
 
-Aktuelle Version: `0.2.16`
+Aktuelle Version: `0.3.0`
 
 ## Autor
 

data/README.md

@@ -725,6 +725,81 @@ Search provides:
 - No additional search gem
 - Safe repeated generator runs
 
+## Sortable
+
+Add persistent sortable positioning to an existing resource:
+
+```bash
+bin/rails generate b4um:sortable Product
+bin/rails db:migrate
+```
+
+The generator adds a `position` column and assigns positions to existing records when the generated migration is run.
+
+New records are automatically added at the end of the list.
+
+By default, the existing resource index becomes the sortable page:
+
+```text
+/products
+```
+
+The existing index layout is switched to the b4um sortable layout. The stored position is also used as the default
+ordering for the resource.
+
+Sortable provides:
+
+- Persistent integer positions stored in the database
+- Automatic positioning of existing records during migration
+- Automatic positioning of new records at the end
+- Drag-and-drop sorting with Stimulus
+- Direct position changes using a number field
+- Automatic shifting of affected records
+- Contiguous positions after moving or deleting records
+- Server-side sorting inside a database transaction
+- CSRF-protected update requests
+- Integration with b4um Search and Pagination
+- No additional sorting gem
+- Safe repeated generator runs
+
+### Separate Sortable Page
+
+A separate sortable page can be created with `--path`:
+
+```bash
+bin/rails generate b4um:sortable Product --path=sortierung
+bin/rails db:migrate
+```
+
+This creates the sortable page at exactly:
+
+```text
+/sortierung
+```
+
+while the regular resource index remains available at:
+
+```text
+/products
+```
+
+The existing index layout, such as Bento or Table, remains unchanged. It still uses the stored `position` ordering.
+
+The separate sortable page uses the existing resource controller. No additional controller or namespace is generated.
+
+The value passed to `--path` directly defines the URL of the separate sortable page. For example:
+
+```bash
+bin/rails generate b4um:sortable Product --path=produktuebersicht
+bin/rails generate b4um:sortable Product --path=verwaltung
+bin/rails generate b4um:sortable Product --path=admin
+```
+
+These create `/produktuebersicht`, `/verwaltung`, and `/admin` respectively.
+
+Using a separate sortable page also makes it possible to protect only the `sort` action with authentication while
+keeping the regular resource index public.
+
 ## Comments
 
 Add polymorphic comments to an existing model:
@@ -1124,7 +1199,7 @@ The gem can be tested locally by referencing the repository with `path:` from a
 
 ## Version
 
-Current version: `0.2.16`
+Current version: `0.3.0`
 
 ## Author
 

data/lib/b4um_generators/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module B4umGenerators
-  VERSION = "0.2.16"
+  VERSION = "0.3.0"
 end

data/lib/generators/b4um/help/help_generator.rb

@@ -943,6 +943,72 @@ module B4um
             - No additional search gem required
             - Safe repeated generator runs
 
+          SORTABLE
+
+            bin/rails generate b4um:sortable MODEL
+
+          Adds persistent sortable positioning to an existing resource.
+
+          Example:
+
+            bin/rails generate b4um:sortable Product
+            bin/rails db:migrate
+
+          Existing records receive positions automatically when the
+          generated migration is run.
+
+          New records are automatically added at the end of the list.
+
+          By default, the existing index page becomes the sortable page:
+
+            /products
+
+          The existing index layout is switched to the b4um sortable
+          layout. The stored position is also used as the default
+          ordering for the resource.
+
+          A separate sortable page can be created with --path:
+
+            bin/rails generate b4um:sortable Product --path=sortierung
+            bin/rails db:migrate
+
+          This creates the sortable page at exactly:
+
+            /sortierung
+
+          The existing resource index remains unchanged:
+
+            /products
+
+          The separate page uses the existing resource controller.
+          No additional controller or namespace is generated.
+
+          Other examples:
+
+            --path=produktuebersicht
+            --path=verwaltung
+            --path=admin
+
+          The value passed to --path defines the URL of the separate
+          sortable page.
+
+          Sortable features:
+
+            - Persistent integer positions stored in the database
+            - Existing records receive positions during migration
+            - New records are automatically placed at the end
+            - Drag-and-drop sorting with Stimulus
+            - Positions can also be changed directly with a number field
+            - Moving a record automatically shifts the affected records
+            - Positions remain contiguous after moving or deleting records
+            - Server-side sorting inside a database transaction
+            - CSRF-protected update requests
+            - No additional sorting gem required
+            - Works with b4um Search and Pagination
+            - Stored ordering is reflected by the regular resource index
+            - Optional separate sortable page with --path
+            - Safe repeated generator runs
+
 
           COMMENTS
 

data/lib/generators/b4um/in_place/in_place_generator.rb

@@ -1149,6 +1149,7 @@ module B4um
         )
 
         @field = field
+        @field_type = field_type(field)
 
         template(
           template_name,
@@ -1156,6 +1157,7 @@ module B4um
         )
       ensure
         @field = nil
+        @field_type = nil
       end
 
       def display_template_for(field)

data/lib/generators/b4um/in_place/templates/display_number.html.erb.tt

@@ -11,8 +11,9 @@
   >
     <strong class="resource-label"><%= @field.humanize %>:</strong>
 
-    <span class="resource-value">
-      <%%= <%= singular_table_name %>.<%= @field %>.presence || "—" %>
+    <span class="resource-value"><% if @field_type == :decimal %>
+      <%%= <%= singular_table_name %>.<%= @field %>.present? ? number_with_precision(<%= singular_table_name %>.<%= @field %>, precision: 2, delimiter: ".", separator: ",") : "—" %><% else %>
+      <%%= <%= singular_table_name %>.<%= @field %>.presence || "—" %><% end %>
     </span>
   </div>
 <%% end %>

data/lib/generators/b4um/install/templates/b4um/sortable.css

@@ -0,0 +1,158 @@
+/* -------------------------------------------------------
+   Sortable
+------------------------------------------------------- */
+
+.b4um-sortable {
+  display: grid;
+  gap: 0.75rem;
+}
+
+.b4um-sortable__item {
+  display: grid;
+  grid-template-columns: auto minmax(0, 1fr) auto;
+  align-items: center;
+  gap: 1.25rem;
+
+  padding: 1rem 1.25rem;
+
+  background: var(--b4um-surface);
+  border: 1px solid var(--b4um-border-light);
+  border-radius: var(--b4um-radius);
+
+  transition:
+    border-color 0.2s ease,
+    box-shadow 0.2s ease,
+    opacity 0.2s ease;
+}
+
+.b4um-sortable__item:hover {
+  border-color: var(--b4um-border-hover);
+}
+
+.b4um-sortable__item--dragging {
+  opacity: 0.5;
+  box-shadow: 0 8px 24px var(--b4um-primary-shadow-soft);
+}
+
+/* -------------------------------------------------------
+   Controls
+------------------------------------------------------- */
+
+.b4um-sortable__controls {
+  display: flex;
+  align-items: center;
+  gap: 0.5rem;
+}
+
+.b4um-sortable__position {
+  box-sizing: border-box;
+
+  width: 4rem;
+  min-width: 4rem;
+  height: 2.75rem;
+
+  margin: 0;
+  padding: 0.5rem;
+
+  background: var(--b4um-surface);
+  color: var(--b4um-text);
+
+  border: 1px solid var(--b4um-border);
+  border-radius: 10px;
+
+  font: inherit;
+  text-align: center;
+}
+
+.b4um-sortable__position:hover {
+  border-color: var(--b4um-border-hover);
+}
+
+.b4um-sortable__position:focus {
+  border-color: var(--b4um-primary);
+  outline: 3px solid var(--b4um-primary-focus);
+  outline-offset: 1px;
+}
+
+/* -------------------------------------------------------
+   Drag handle
+------------------------------------------------------- */
+
+.b4um-sortable__handle {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+
+  width: 2.75rem;
+  height: 2.75rem;
+
+  margin: 0;
+  padding: 0;
+
+  background: transparent;
+  color: var(--b4um-text-secondary);
+
+  border: 0;
+  border-radius: 10px;
+
+  font: inherit;
+  font-size: 1.2rem;
+  line-height: 1;
+
+  cursor: grab;
+
+  transition:
+    background 0.2s ease,
+    color 0.2s ease;
+}
+
+.b4um-sortable__handle:hover {
+  background: var(--b4um-primary-soft);
+  color: var(--b4um-primary);
+}
+
+.b4um-sortable__handle:active {
+  cursor: grabbing;
+}
+
+/* -------------------------------------------------------
+   Content
+------------------------------------------------------- */
+
+.b4um-sortable__content {
+  min-width: 0;
+}
+
+.b4um-sortable__content .resource {
+  margin: 0;
+}
+
+/* -------------------------------------------------------
+   Actions
+------------------------------------------------------- */
+
+.b4um-sortable__actions {
+  display: flex;
+  align-items: center;
+  justify-content: flex-end;
+}
+
+.b4um-sortable__actions .button {
+  margin: 0;
+  white-space: nowrap;
+}
+
+/* -------------------------------------------------------
+   Responsive
+------------------------------------------------------- */
+
+@media (max-width: 48rem) {
+  .b4um-sortable__item {
+    grid-template-columns: 1fr;
+    gap: 0.75rem;
+  }
+
+  .b4um-sortable__actions {
+    justify-content: flex-start;
+  }
+}

data/lib/generators/b4um/install/templates/b4um.css

@@ -22,6 +22,7 @@
 @import 'b4um/hero.css';
 @import 'b4um/cards.css';
 @import 'b4um/tables.css';
+@import 'b4um/sortable.css';
 @import 'b4um/pagination.css';
 @import 'b4um/badges.css';
 @import 'b4um/callouts.css';

data/lib/generators/b4um/pagination/pagination_generator.rb

@@ -108,20 +108,33 @@ module B4um
         /
           @#{Regexp.escape(plural_table_name)}\s*=\s*
           b4um_search\(\s*
-          #{Regexp.escape(class_name)}\.all,\s*
+          (?<collection>
+            #{Regexp.escape(class_name)}
+            \.(?:all|order\(\s*:position\s*,\s*:id\s*\))
+          )\s*,\s*
           params\[:q\]\s*
           \)
         /x
       end
 
       def paginate_existing_search
+        controller_content = File.read(controller_path)
+        match = controller_content.match(search_pattern)
+
+        unless match
+          raise Thor::Error,
+                "Could not find the search collection in app/controllers/#{plural_table_name}_controller.rb"
+        end
+
+        collection = match[:collection]
+
         gsub_file(
           controller_path,
           search_pattern,
           [
             "@#{plural_table_name}, @pagination = b4um_paginate(",
             "      b4um_search(",
-            "        #{class_name}.all,",
+            "        #{collection},",
             "        params[:q]",
             "      ),",
             "      per_page: #{options[:per_page]}",
@@ -131,19 +144,33 @@ module B4um
       end
 
       def paginate_plain_collection(controller_content)
-        old_index = "@#{plural_table_name} = #{class_name}.all"
+        plain_collection = "#{class_name}.all"
+        sortable_collection = "#{class_name}.order(:position, :id)"
 
-        unless controller_content.include?(old_index)
+        collection =
+          if controller_content.include?(
+            "@#{plural_table_name} = #{sortable_collection}"
+          )
+            sortable_collection
+          elsif controller_content.include?(
+            "@#{plural_table_name} = #{plain_collection}"
+          )
+            plain_collection
+          end
+
+        unless collection
           raise Thor::Error,
                 "Could not find the index collection in app/controllers/#{plural_table_name}_controller.rb"
         end
 
+        old_index = "@#{plural_table_name} = #{collection}"
+
         gsub_file(
           controller_path,
           old_index,
           [
             "@#{plural_table_name}, @pagination = b4um_paginate(",
-            "      #{class_name}.all,",
+            "      #{collection},",
             "      per_page: #{options[:per_page]}",
             "    )"
           ].join("\n")

data/lib/generators/b4um/search/search_generator.rb

@@ -92,19 +92,33 @@ module B4um
           return
         end
 
-        old_index = "@#{file_name.pluralize} = #{class_name}.all"
+        plain_collection = "#{class_name}.all"
+        sortable_collection = "#{class_name}.order(:position, :id)"
 
-        unless controller_content.include?(old_index)
+        collection =
+          if controller_content.include?(
+            "@#{file_name.pluralize} = #{sortable_collection}"
+          )
+            sortable_collection
+          elsif controller_content.include?(
+            "@#{file_name.pluralize} = #{plain_collection}"
+          )
+            plain_collection
+          end
+
+        unless collection
           raise Thor::Error,
                 "Could not find the index collection in #{controller_path}"
         end
 
-        search_code = <<~RUBY.chomp
-          @#{file_name.pluralize} = b4um_search(
-            #{class_name}.all,
-            params[:q]
-          )
-        RUBY
+        old_index = "@#{file_name.pluralize} = #{collection}"
+
+        search_code = [
+          "@#{file_name.pluralize} = b4um_search(",
+          "      #{collection},",
+          "      params[:q]",
+          "    )"
+        ].join("\n")
 
         gsub_file(
           controller_path,