feat: rake task to upgrade to v2 + pimp files from the Maglev generator

did · did · commit 3210bfc4063d · 2025-04-18T00:14:49.000+02:00
diff --git a/app/services/maglev/upgrade_from_v1.rb b/app/services/maglev/upgrade_from_v1.rb
@@ -52,7 +52,7 @@ def upgrade_layout_template
       template = load_old_layout_template
                  .gsub('data-maglev-dropzone',
                        "data-maglev-#{default_layout_group.id}-dropzone")
-                 .gsub('render_maglev_sections', "render_maglev_group :#{default_layout_group.id} %>")
+                 .gsub('render_maglev_sections', "render_maglev_group :#{default_layout_group.id}")
 
       persist_layout_template(template, "#{default_layout.id}.html.erb")
     end
diff --git a/config/initializers/check_maglev_migration.rb b/config/initializers/check_maglev_migration.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Maglev
+  class MigrationV2Error < StandardError; end
+end
+
+Rails.application.config.after_initialize do
+  # Skip in test environment
+  # Only check if we're running the server or console
+  if !Rails.env.test? && (defined?(Rails::Server) || defined?(Rails::Console))
+    site_exists = Maglev::Site.exists?
+    store_exists = Maglev::SectionsContentStore.exists?
+
+    if site_exists && !store_exists
+      raise Maglev::MigrationV2Error,
+            'Your Maglev site needs to be migrated to V2. Please run: rails maglev:upgrade_from_v1'
+    end
+  end
+end
diff --git a/lib/generators/maglev/templates/theme/app/theme/theme.yml.tt b/lib/generators/maglev/templates/theme/app/theme/theme.yml.tt
@@ -6,30 +6,40 @@ name: "theme"
 description: "A brief description of the theme"
 
 section_categories:
-- name: content
+- name: Headers
+  id: headers
+- name: Content
+  id: content
+- name: Footers
+  id: footers
 
 # Properties of your theme such as the primary color, font name, ...etc.
 style_settings: []
 
-pages:
-- title: "Home page"
-  path:  "/index"
-
-# List of CSS class names used by your library of icons (font awesome, remixicons, ...etc)
-icons: []
-
-# Enable the section mirroring feature (default: false)
-# mirror_section: true
-
+# Define layouts with organized groups
 layouts:
 - label: "Default"
   id: "default"
   groups:
   - label: "Header"
     id: "header"
-    store: "header"
-    # accept: ["navbar"]
+    accept: ["headers/*"]  # Only allow sections from the headers group
+    recoverable: ["navbar"]  # Make navbar recoverable
+    # mirror_section: false  # Disable mirroring feature for consistency
   - label: "Main"
     id: "main"
-    store: "page"
-  - "Footer"
+    store: "page"  # Store content per-page
+  - label: "Footer"
+    id: "footer"
+    accept: ["footers/*"]  # Only allow sections from the footers group
+
+pages:
+- title: "Home page"
+  path: "/index"
+  layout_id: "default"  # Use the default layout
+
+# List of CSS class names used by your library of icons (font awesome, remixicons, ...etc)
+icons: []
+
+# Enable the section mirroring feature (default: false)
+# mirror_section: true
diff --git a/lib/generators/maglev/templates/theme/app/views/theme/layouts/default.html.erb.tt b/lib/generators/maglev/templates/theme/app/views/theme/layouts/default.html.erb.tt
@@ -15,16 +15,19 @@
 
   <script src="https://cdn.tailwindcss.com?plugins=forms,typography,aspect-ratio,line-clamp"></script>
 </head>
-<body class="bg-white">
-  <header data-maglev-header-dropzone>
+<body class="min-h-screen flex flex-col">
+  <%# Header group for site-wide navigation and announcements %>
+  <header class="bg-white shadow-sm" data-maglev-header-dropzone>
     <%%= render_maglev_group :header %>
   </header>
 
-  <main data-maglev-main-dropzone>
+  <%# Main content group for page-specific content %>
+  <main class="flex-grow" data-maglev-main-dropzone>
     <%%= render_maglev_group :main %>
   </main>
 
-  <footer data-maglev-footer-dropzone>
+  <%# Footer group for site-wide footer content %>
+  <footer class="bg-gray-50" data-maglev-footer-dropzone>
     <%%= render_maglev_group :footer %>
   </footer>
 </body>
diff --git a/lib/tasks/maglev_tasks.rake b/lib/tasks/maglev_tasks.rake
@@ -55,6 +55,15 @@ namespace :maglev do
     end
   end
 
+  desc 'Upgrade Maglev from V1 to V2'
+  task upgrade_from_v1: :environment do
+    Maglev::UpgradeFromV1.call(
+      site: Maglev::Site.first,
+      theme: Maglev.local_themes.first
+    )
+    puts '🛠️ Your site has been upgraded to V2 with success!'
+  end
+
   namespace :vite do
     desc 'Bundle frontend entrypoints using ViteRuby'
     task build: :'vite:verify_install' do
diff --git a/spec/dummy/db/schema.rb b/spec/dummy/db/schema.rb
@@ -100,10 +100,17 @@
     t.string "name"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.jsonb "navigation", default: []
     t.jsonb "locales", default: []
     t.jsonb "sections_translations", default: {}
     t.integer "lock_version"
+    t.string "siteable_type"
+    t.bigint "siteable_id"
+    t.string "handle"
+    t.string "theme_id"
+    t.string "domain"
     t.jsonb "style", default: []
+    t.index ["siteable_type", "siteable_id"], name: "index_maglev_sites_on_siteable"
   end
 
   create_table "products", force: :cascade do |t|
