RubyGems - turbo_crud - Versions diffs - 0.4.4 - Mend

turbo_crud 0.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5680c4f123c59d578d9bc79c132fed6d29251f848eec94be37366bf87f2fb8f0
+  data.tar.gz: 5432fb82ac1a8e8c5a537494955c52dd0e21f57bd1f940c7ed98dad34c2071b2
+SHA512:
+  metadata.gz: 25baeec7a6f6acf23c6294a9b0c107e576deda265349459bd1ac83aeef221a9af2bb4ea013a8387c4010ee77784a45743a4f1183e218d51e79ab60ff11300524
+  data.tar.gz: 381dbfae5cda6cdd2fa0b4088a5ecaf5ac16b0f69f80f9c9696d6bc6979a93995aa2f12f2002f85278aad1ce65fefa60b18d9213584e63d9a4ab292d5809253f

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 TurboCrud
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,277 @@
+# TurboCrud (v0.4.4)
+TurboCrud is a small, opinionated helper layer for Rails + Turbo that makes CRUD feel like you're speedrunning.
+## What you get
+- Consistent **Turbo Stream** responses for create/update/destroy
+- Drop-in **modal frame** + **drawer frame** + **flash frame**
+- `turbo_save` helper (create/update with one method)
+- Generator scaffold that **auto-builds form fields from attributes**
+- Test skeleton + a tiny dummy app (so you can extend it later)
+---
+## Install
+Add to your Gemfile:
+```ruby
+gem "turbo_crud", path: "../turbo_crud"
+```
+Then:
+```bash
+bundle install
+```
+---
+## Layout setup (required)
+Put these in `app/views/layouts/application.html.erb`:
+```erb
+<%= turbo_crud_flash_frame %>
+<%= turbo_crud_modal_frame %>
+<%= turbo_crud_drawer_frame %>
+```
+Put modal/drawer frames near the end of `<body>`.
+---
+## CSS (Sprockets)
+Add:
+```css
+/*
+ *= require turbo_crud
+ *= require turbo_crud_modal
+ *= require turbo_crud_drawer
+ */
+```
+(If you're on cssbundling/importmap, copy these CSS files into your app or import them.)
+---
+## Controller usage
+```ruby
+class PostsController < ApplicationController
+  include TurboCrud::Controller
+  def create
+    @post = Post.new(post_params)
+    turbo_create(@post, list: Post, success_message: "Post created!")
+  end
+  def update
+    @post = Post.find(params[:id])
+    @post.assign_attributes(post_params)
+    turbo_update(@post, success_message: "Post updated!")
+  end
+  def destroy
+    @post = Post.find(params[:id])
+    turbo_destroy(@post, list: Post, success_message: "Post deleted.")
+  end
+end
+```
+### One-liner save (create OR update)
+```ruby
+turbo_save(@post, list: Post, success_message: "Saved!")
+```
+TurboCrud will decide whether to insert (create) or replace (update).
+---
+## Modal vs Drawer
+Links:
+- `turbo_crud_modal_link "New", new_post_path`
+- `turbo_crud_drawer_link "New", new_post_path`
+Forms:
+- `turbo_crud_form_with ...` (defaults to your configured container)
+- or explicitly: `turbo_crud_form_with ..., frame: TurboCrud.config.drawer_frame_id`
+---
+## Generator
+```bash
+rails g turbo_crud:scaffold Post title body:text published:boolean views:integer
+```
+It generates:
+- controller wired to TurboCrud
+- views: index/new/edit/_row/_form
+- `_form` will contain inputs for each attribute you passed.
+---
+## Notes
+This gem stays small on purpose.
+Big gems become “frameworks”.
+Frameworks become “why is this broken?”. 😄
+## Generator options
+By default the scaffold generates **modal** `new/edit` views.
+You can switch to **drawer** views:
+```bash
+rails g turbo_crud:scaffold Post title body:text --container=drawer
+```
+Or generate **both** (modal files + extra drawer files as `new.drawer.html.erb` / `edit.drawer.html.erb`):
+```bash
+rails g turbo_crud:scaffold Post title body:text --container=both
+```
+Tip: if you want the whole app to prefer drawers, set:
+```ruby
+TurboCrud.configure do |c|
+  c.default_container = :drawer
+end
+```
+## Using TurboCrud with existing apps (existing forms, existing views)
+You do **not** have to rewrite your forms.
+### Step 1: open new/edit in a frame (modal or drawer)
+```erb
+<%= turbo_crud_modal_link "New", new_post_path %>
+<%= turbo_crud_modal_link "Edit", edit_post_path(@post) %>
+```
+Or drawer:
+```erb
+<%= turbo_crud_drawer_link "New", new_post_path %>
+```
+### Step 2: wrap your current new/edit views (keep your form partial!)
+In your existing `new.html.erb`:
+```erb
+<%= turbo_crud_container title: "New Post" do %>
+  <%= render "form" %>
+<% end %>
+```
+In your existing `edit.html.erb`:
+```erb
+<%= turbo_crud_container title: "Edit Post" do %>
+  <%= render "form" %>
+<% end %>
+```
+### Step 3: use `turbo_respond` in your controller
+```ruby
+def create
+  @post = Post.new(post_params)
+  turbo_respond(@post, list: Post, success_message: "Created!")
+end
+def update
+  @post = Post.find(params[:id])
+  @post.assign_attributes(post_params)
+  turbo_respond(@post, list: Post, success_message: "Updated!")
+end
+```
+### Row partial auto-detection
+TurboCrud will try:
+1) `posts/_row.html.erb`
+2) `posts/_post.html.erb` (common existing Rails partial)
+You can override globally:
+```ruby
+TurboCrud.configure do |c|
+  c.row_partial = "posts/post" # or "shared/post_row"
+end
+```
+Or per-call:
+```ruby
+turbo_respond(@post, list: Post, row_partial: "posts/post")
+```
+## Full scaffold generator (model + migration + routes + TurboCrud views)
+TurboCrud now includes a “batteries included” generator that creates:
+- Model + migration (like `rails g model ...`)
+- Routes (`resources :things`)
+- TurboCrud controller + views (modal/drawer/both)
+Run it like:
+```bash
+bin/rails g turbo_crud:full_scaffold Post title body:text published:boolean --container=both
+bin/rails db:migrate
+```
+Notes:
+- Rails generators don’t run migrations automatically (Rails is polite like that).
+- If routes already exist, TurboCrud won’t double-inject them.
+## One generator to remember: `turbo_crud:scaffold`
+By default it generates **controller + views** (no model, no routes):
+```bash
+bin/rails g turbo_crud:scaffold Post title body:text published:boolean --container=both
+```
+If you want **FULL scaffold** (model + migration + routes + controller + views), add `--full`:
+```bash
+bin/rails g turbo_crud:scaffold Post title body:text published:boolean --container=both --full
+bin/rails db:migrate
+```
+You can control parts:
+```bash
+bin/rails g turbo_crud:scaffold Post title body:text --full --skip-model
+bin/rails g turbo_crud:scaffold Post title body:text --full --skip-routes
+```
+## Install helper (`--install`)
+You can ask the scaffold generator to also wire up your app layout + CSS.
+```bash
+bin/rails g turbo_crud:scaffold Post title body:text --container=both --install
+```
+What `--install` does (idempotent):
+- injects these frames near the end of `app/views/layouts/application.html.erb` (before `</body>`):
+  - `turbo_crud_flash_frame`
+  - `turbo_crud_modal_frame`
+  - `turbo_crud_drawer_frame`
+- tries to add Sprockets requires to `app/assets/stylesheets/application.css`:
+  - `*= require turbo_crud`
+  - `*= require turbo_crud_modal`
+  - `*= require turbo_crud_drawer`
+If it can’t find those files, it will print a warning with what to add manually.

data/Rakefile ADDED Viewed

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+# Tiny Rakefile so `bundle exec rake test` feels at home. 🏠
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+task default: :test

data/app/assets/stylesheets/turbo_crud.css ADDED Viewed

@@ -0,0 +1,22 @@
+/* TurboCrud minimal flash styles (override in your app). */
+/* Goal: good defaults, no extra JavaScript, no drama. */
+.turbo-crud__flash{
+  position: fixed;
+  right: 1rem;
+  top: 1rem;
+  z-index: 9999;
+  max-width: min(92vw, 480px);
+  padding: 0.75rem 1rem;
+  border-radius: 1rem;
+  box-shadow: 0 18px 40px rgba(15, 23, 42, 0.18);
+  backdrop-filter: blur(8px);
+  border: 1px solid rgba(148, 163, 184, 0.35);
+  font-size: 0.9rem;
+}
+/* Green-ish “nice job” */
+.turbo-crud__flash--notice{ background: rgba(16, 185, 129, 0.12); }
+/* Red-ish “uh oh” */
+.turbo-crud__flash--alert{ background: rgba(244, 63, 94, 0.12); }

data/app/assets/stylesheets/turbo_crud.css:Zone.Identifier ADDED Viewed

Binary file

data/app/assets/stylesheets/turbo_crud_drawer.css ADDED Viewed

@@ -0,0 +1,59 @@
+/* TurboCrud JS-free drawer shell.
+   Drawer is just a modal that decided to live on the right side. 😄 */
+.turbo-crud__drawer-shell{
+  position: fixed;
+  inset: 0;
+  z-index: 9998;
+  display: grid;
+  grid-template-columns: 1fr min(92vw, 520px);
+  background: rgba(2,6,23,0.55);
+  backdrop-filter: blur(8px);
+}
+.turbo-crud__drawer-backdrop{
+  /* Clicks will go through unless you add a close link in your drawer head.
+     Keeping it JS-free means: we don't auto-close on backdrop click. */
+}
+.turbo-crud__drawer-card{
+  height: 100%;
+  background: white;
+  border-left: 1px solid rgba(148,163,184,0.35);
+  box-shadow: -20px 0 80px rgba(15,23,42,0.25);
+  overflow: auto;
+}
+.turbo-crud__drawer-head{
+  position: sticky;
+  top: 0;
+  z-index: 1;
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  padding: 1rem 1.25rem;
+  border-bottom: 1px solid rgba(148,163,184,0.25);
+  background: rgba(255,255,255,0.92);
+  backdrop-filter: blur(10px);
+}
+.turbo-crud__drawer-title{
+  font-size: 1rem;
+  font-weight: 800;
+  color: #0f172a;
+}
+.turbo-crud__drawer-close{
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  width: 2.25rem;
+  height: 2.25rem;
+  border-radius: 0.9rem;
+  border: 1px solid rgba(148,163,184,0.35);
+  background: white;
+  color: #0f172a;
+  text-decoration: none;
+}
+.turbo-crud__drawer-body{ padding: 1.25rem; }

data/app/assets/stylesheets/turbo_crud_drawer.css:Zone.Identifier ADDED Viewed

Binary file

data/app/assets/stylesheets/turbo_crud_modal.css ADDED Viewed

@@ -0,0 +1,51 @@
+/* TurboCrud JS-free modal shell.
+   Turbo swaps modal content into a frame. Simple & stable. 🌙 */
+.turbo-crud__modal-shell{
+  position: fixed;
+  inset: 0;
+  z-index: 9998;
+  display: grid;
+  place-items: center;
+  padding: 1.25rem;
+  background: rgba(2,6,23,0.55);
+  backdrop-filter: blur(8px);
+}
+.turbo-crud__modal-card{
+  width: min(92vw, 720px);
+  border-radius: 1.25rem;
+  background: white;
+  border: 1px solid rgba(148,163,184,0.35);
+  box-shadow: 0 30px 80px rgba(15,23,42,0.30);
+  overflow: hidden;
+}
+.turbo-crud__modal-head{
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  padding: 1rem 1.25rem;
+  border-bottom: 1px solid rgba(148,163,184,0.25);
+}
+.turbo-crud__modal-title{
+  font-size: 1rem;
+  font-weight: 700;
+  color: #0f172a;
+}
+.turbo-crud__modal-close{
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  width: 2.25rem;
+  height: 2.25rem;
+  border-radius: 0.9rem;
+  border: 1px solid rgba(148,163,184,0.35);
+  background: white;
+  color: #0f172a;
+  text-decoration: none;
+}
+.turbo-crud__modal-body{ padding: 1.25rem; }

data/app/assets/stylesheets/turbo_crud_modal.css:Zone.Identifier ADDED Viewed

Binary file

data/app/views/turbo_crud/shared/_container_drawer.html.erb ADDED Viewed

@@ -0,0 +1,21 @@
+<%# Drawer container shell (JS-free). Turbo swaps this into the drawer frame.
+    body is pre-captured HTML from your existing view. %>
+<div class="turbo-crud__drawer-shell">
+  <div class="turbo-crud__drawer-backdrop"></div>
+  <div class="turbo-crud__drawer-card">
+    <div class="turbo-crud__drawer-head">
+      <h2 class="turbo-crud__drawer-title"><%= title %></h2>
+      <%= link_to "✕", "#",
+        data: { turbo_frame: (close_to_top ? "_top" : TurboCrud.config.drawer_frame_id) },
+        class: "turbo-crud__drawer-close",
+        aria: { label: "Close" } %>
+    </div>
+    <div class="turbo-crud__drawer-body">
+      <%= body %>
+    </div>
+  </div>
+</div>

data/app/views/turbo_crud/shared/_container_drawer.html.erb:Zone.Identifier ADDED Viewed

Binary file

data/app/views/turbo_crud/shared/_container_modal.html.erb ADDED Viewed

@@ -0,0 +1,21 @@
+<%# Modal container shell (JS-free). Turbo swaps this into the modal frame.
+    body is pre-captured HTML from your existing view. %>
+<div class="turbo-crud__modal-shell">
+  <div class="turbo-crud__modal-card">
+    <div class="turbo-crud__modal-head">
+      <h2 class="turbo-crud__modal-title"><%= title %></h2>
+      <%# close_to_top: if true, we target _top so the frame clears.
+          (works great for modal/drawer content) %>
+      <%= link_to "✕", "#",
+        data: { turbo_frame: (close_to_top ? "_top" : TurboCrud.config.modal_frame_id) },
+        class: "turbo-crud__modal-close",
+        aria: { label: "Close" } %>
+    </div>
+    <div class="turbo-crud__modal-body">
+      <%= body %>
+    </div>
+  </div>
+</div>

data/app/views/turbo_crud/shared/_container_modal.html.erb:Zone.Identifier ADDED Viewed

Binary file

data/app/views/turbo_crud/shared/_flash.html.erb ADDED Viewed

@@ -0,0 +1,16 @@
+<%# Flash partial. Tiny. Friendly. Like a snack. 🍪 %>
+<% notice_message = local_assigns[:notice] || flash[:notice] %>
+<% alert_message  = local_assigns[:alert]  || flash[:alert] %>
+<% if notice_message.present? %>
+  <div class="turbo-crud__flash turbo-crud__flash--notice" role="status">
+    <span><%= notice_message %></span>
+  </div>
+<% end %>
+<% if alert_message.present? %>
+  <div class="turbo-crud__flash turbo-crud__flash--alert" role="alert">
+    <span><%= alert_message %></span>
+  </div>
+<% end %>

data/app/views/turbo_crud/shared/_flash.html.erb:Zone.Identifier ADDED Viewed

Binary file

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# No engine routes (yet). We're a helper gem, not an empire. 👑🚫
+TurboCrud::Engine.routes.draw do
+end

data/config/routes.rb:Zone.Identifier ADDED Viewed

Binary file

data/lib/generators/turbo_crud/full_scaffold_generator.rb ADDED Viewed

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+# FullScaffoldGenerator:
+# Think of this as "rails scaffold" + TurboCrud UI sugar. 🍬
+#
+# It will generate:
+# - model + migration
+# - routes (resources :plural)
+# - TurboCrud controller + views (modal/drawer/both)
+#
+# It does NOT run db:migrate (Rails generators don't do that by default).
+require "rails/generators"
+require "rails/generators/named_base"
+module TurboCrud
+  module Generators
+    class FullScaffoldGenerator < Rails::Generators::NamedBase
+      VALID_CONTAINERS = %w[modal drawer both].freeze
+      source_root File.expand_path("templates", __dir__)
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+      class_option :container,
+                   type: :string,
+                   default: "modal",
+                   desc: "Choose where new/edit renders: modal, drawer, or both"
+      # If you already made the model, you can skip it.
+      class_option :skip_model,
+                   type: :boolean,
+                   default: false,
+                   desc: "Skip generating the model/migration"
+      # If you already have routes, you can skip route injection.
+      class_option :skip_routes,
+                   type: :boolean,
+                   default: false,
+                   desc: "Skip injecting resources routes"
+      def validate_options!
+        normalized = options[:container].to_s.strip.downcase
+        return if VALID_CONTAINERS.include?(normalized)
+        raise Thor::Error,
+              "Invalid --container=#{options[:container].inspect}. Expected one of: #{VALID_CONTAINERS.join(', ')}."
+      end
+      def generate_model
+        return if options[:skip_model]
+        # Build "title:string body:text" etc.
+        model_attrs = attributes.map do |a|
+          a.type ? "#{a.name}:#{a.type}" : a.name
+        end
+        say_status :invoke, "rails g model #{class_name} #{model_attrs.join(' ')}", :green
+        # Invoke the Rails model generator.
+        invoke "active_record:model", [class_name], attributes: attributes
+      end
+      def inject_routes
+        return if options[:skip_routes]
+        route_line = "resources :#{plural_name}"
+        routes_path = File.join(destination_root, "config/routes.rb")
+        unless File.exist?(routes_path)
+          say_status :warning, "config/routes.rb not found. Skipping routes injection.", :yellow
+          return
+        end
+        routes_content = File.read(routes_path)
+        if routes_content.include?(route_line)
+          say_status :identical, "routes already include #{route_line}", :blue
+          return
+        end
+        # Put routes near the top of the draw block.
+        # If we can't find it, we just append at the end.
+        if routes_content.match?(/Rails\.application\.routes\.draw do\n/m)
+          inject_into_file "config/routes.rb", "  #{route_line}\n", after: "Rails.application.routes.draw do\n"
+          say_status :insert, "added #{route_line} to routes.rb", :green
+        else
+          append_to_file "config/routes.rb", "\n#{route_line}\n"
+          say_status :append, "appended #{route_line} to routes.rb", :green
+        end
+      end
+      def generate_turbo_crud_scaffold
+        say_status :invoke, "rails g turbo_crud:scaffold #{class_name} ...", :green
+        # Invoke our own scaffold generator (the one that makes controller/views)
+        invoke "turbo_crud:scaffold", [class_name] + attributes.map { |a| a.type ? "#{a.name}:#{a.type}" : a.name },
+               container: options[:container]
+      end
+    end
+  end
+end

data/lib/generators/turbo_crud/full_scaffold_generator.rb:Zone.Identifier ADDED Viewed

Binary file