maglevcms 2.0.0 → 3.0.0.beta1

data/config/routes.rb

@@ -2,47 +2,46 @@
 
 # rubocop:disable Metrics/BlockLength
 Maglev::Engine.routes.draw do
-  # API
-  constraints format: :json do
-    namespace :api do
-      root to: proc { [200, {}, ['{}']] }
-      resource :site, only: :show
+  # Editor
+  namespace :editor do
+    root to: 'home#index'
+
+    get 'leave', to: 'home#destroy', as: :leave
+
+    resources :assets, only: %i[index create destroy]
+    resources :icons, only: %i[index]
+    resource :link, only: %i[edit update]
+
+    # combobox routes
+    namespace :combobox do
+      resources :pages, only: :index
+      resources :collection_items, only: :index
+    end
+
+    # always keep the scope of the current page and locale in the url
+    scope ':locale/:page_id' do
+      root to: 'home#index', as: :real_root
+
       resources :pages do
-        resources :clones, controller: :page_clones, only: :create
+        resource :clone, controller: :page_clone, only: :create
       end
-      resources :assets
-      resource :publication, only: %i[show create]
-      resources :collection_items, path: 'collections/:collection_id', only: %i[index show]
-    end
-  end
 
-  root to: redirect { Maglev::Engine.routes.url_helpers.admin_root_path }
-
-  # JS client lib for a headless use of Maglev
-  get 'live-preview-client.js', to: (redirect(status: 302) do |_, request|
-    manifest = ::Maglev::Engine.vite_ruby.manifest
-    entries = manifest.resolve_entries(*%w[live-preview-rails-client], type: :javascript)
-    [
-      request.base_url,
-      *entries.fetch(:scripts).flatten.uniq
-    ].join
-  end), as: :live_preview_client_js
-
-  # Admin
-  namespace :admin do
-    root to: 'dashboard#index'
-    resource :theme, only: %i[show]
-    namespace :sections, path: 'sections/:id' do
-      get :preview, to: 'previews#show'
-      get :preview_in_frame, to: 'previews#iframe_show'
-      resources :screenshots, only: [:create]
+      resources :sections do
+        put :sort, on: :collection
+        resources :blocks, controller: :section_blocks do
+          put :sort, on: :collection
+        end
+      end
+
+      resource :style, controller: :style, only: %i[edit update]
+
+      resource :publication, controller: :publication, only: :create
     end
   end
 
-  # Editor + Preview
-  get 'editor', to: 'editor#show', as: :base_editor
-  get 'editor/:locale/(*path)', to: 'editor#show', as: :editor
-  get 'leave_editor', to: 'editor#destroy', as: :leave_editor
+  root to: 'editor/home#index'
+
+  # Preview
   get 'preview/(*path)', to: 'page_preview#index',
                          defaults: { path: 'index', rendering_mode: :editor },
                          constraints: Maglev::PreviewConstraint.new,

data/db/migrate/20200831101942_create_maglev_section_content.rb

@@ -3,6 +3,8 @@ class CreateMaglevSectionContent < ActiveRecord::Migration[6.0]
     change_table :maglev_sites do |t|
       if t.respond_to? :jsonb
         t.jsonb :sections, default: []
+      elsif mysql?
+        t.json :sections # MySQL doesn't support default values for json columns
       else
         t.json :sections, default: []
       end
@@ -11,6 +13,8 @@ class CreateMaglevSectionContent < ActiveRecord::Migration[6.0]
     change_table :maglev_pages do |t|
       if t.respond_to? :jsonb
         t.jsonb :sections, default: []
+      elsif mysql?
+        t.json :sections # MySQL doesn't support default values for json columns
       else
         t.json :sections, default: []
       end

data/db/migrate/20210819092740_switch_to_localized_page_fields.rb

@@ -1,12 +1,18 @@
 class SwitchToLocalizedPageFields < ActiveRecord::Migration[6.1]
   def up
-    remove_columns :maglev_pages, :title, :seo_title, :meta_description
-
+    remove_column :maglev_pages, :title if column_exists?(:maglev_pages, :title)
+    remove_column :maglev_pages, :seo_title if column_exists?(:maglev_pages, :seo_title)
+    remove_column :maglev_pages, :meta_description if column_exists?(:maglev_pages, :meta_description)
+      
     change_table :maglev_pages do |t|
       if t.respond_to? :jsonb
         t.jsonb :title_translations, default: {}
         t.jsonb :seo_title_translations, default: {}
         t.jsonb :meta_description_translations, default: {}
+      elsif mysql?
+        t.json :title_translations
+        t.json :seo_title_translations
+        t.json :meta_description_translations
       else
         t.json :title_translations, default: {}
         t.json :seo_title_translations, default: {}

data/db/migrate/20211008064437_add_locales_to_sites.rb

@@ -3,6 +3,8 @@ class AddLocalesToSites < ActiveRecord::Migration[6.0]
     change_table :maglev_sites do |t|
       if t.respond_to? :jsonb
         t.jsonb :locales, default: []
+      elsif mysql?
+        t.json :locales # MySQL doesn't support default values for json columns
       else
         t.json :locales, default: []
       end

data/db/migrate/20211013210954_translate_section_content.rb

@@ -1,11 +1,13 @@
 class TranslateSectionContent < ActiveRecord::Migration[6.0]
   def change
-    remove_column :maglev_sites, :sections, :jsonb, default: []
-    remove_column :maglev_pages, :sections, :jsonb, default: []
+    remove_column :maglev_sites, :sections, :jsonb, default: [] if column_exists?(:maglev_sites, :sections)
+    remove_column :maglev_pages, :sections, :jsonb, default: [] if column_exists?(:maglev_pages, :sections)
 
     change_table :maglev_sites do |t|
       if t.respond_to? :jsonb
         t.jsonb :sections_translations, default: {}
+      elsif mysql?
+        t.json :sections_translations # MySQL doesn't support default values for json columns
       else
         t.json :sections_translations, default: {}
       end
@@ -14,6 +16,8 @@ class TranslateSectionContent < ActiveRecord::Migration[6.0]
     change_table :maglev_pages do |t|
       if t.respond_to? :jsonb
         t.jsonb :sections_translations, default: {}
+      elsif mysql?
+        t.json :sections_translations # MySQL doesn't support default values for json columns
       else
         t.json :sections_translations, default: {}
       end

data/db/migrate/20211203224112_add_open_graph_tags_to_pages.rb

@@ -5,6 +5,10 @@ class AddOpenGraphTagsToPages < ActiveRecord::Migration[6.0]
         t.jsonb :og_title_translations, default: {}
         t.jsonb :og_description_translations, default: {}
         t.jsonb :og_image_url_translations, default: {}
+      elsif mysql?
+        t.json :og_title_translations
+        t.json :og_description_translations
+        t.json :og_image_url_translations
       else
         t.json :og_title_translations, default: {}
         t.json :og_description_translations, default: {}

data/db/migrate/20220612092235_add_style_to_sites.rb

@@ -3,6 +3,8 @@ class AddStyleToSites < ActiveRecord::Migration[6.0]
     change_table :maglev_sites do |t|
       if t.respond_to? :jsonb
         t.jsonb :style, default: []
+      elsif mysql?
+        t.json :style # MySQL doesn't support default values for json columns
       else
         t.json :style, default: []
       end

data/db/migrate/20250929203214_create_maglev_sections_content_stores.rb

@@ -0,0 +1,21 @@
+class CreateMaglevSectionsContentStores < ActiveRecord::Migration[6.0]
+  include Maglev::Migration
+  def change
+    create_table :maglev_sections_content_stores, id: primary_key_type do |t|
+      t.string :container_id
+      t.string :container_type
+      if t.respond_to? :jsonb
+        t.jsonb :sections_translations, default: {}
+      elsif mysql?
+        t.json :sections_translations # MySQL doesn't support default values for json columns
+      else
+        t.json :sections_translations, default: {}
+      end
+      t.boolean :published, default: false
+
+      t.timestamps
+    end
+
+    add_index :maglev_sections_content_stores, %i[container_id container_type published], unique: true, name: 'maglev_sections_content_stores_container_and_published'
+  end
+end

data/exe/tailwind-cli

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This is a wrapper for the tailwindcss-ruby gem to make it easier to use in the Maglev CMS.
+# Source: https://github.com/flavorjones/tailwindcss-ruby
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'tailwindcss-ruby', '4.1.11'
+end
+
+require 'tailwindcss/ruby'
+
+begin
+  command = [Tailwindcss::Ruby.executable, *ARGV]
+  puts command.inspect
+  if Gem.win_platform?
+    # use system rather than exec as exec inexplicably fails to find the executable on Windows
+    # see related https://github.com/rubys/sprockets-esbuild/pull/4
+    system(*command, exception: true)
+  else
+    exec(*command)
+  end
+rescue Tailwindcss::Ruby::UnsupportedPlatformException, Tailwindcss::Ruby::ExecutableNotFoundException => e
+  warn("ERROR: #{e.message}")
+  exit 1
+end

data/lib/commands/maglev/change_site_locales_command.rb

@@ -6,7 +6,7 @@ module Maglev
   class ChangeSiteLocalesCommand < Rails::Command::Base
     desc 'change_site_locales [LOCALES]', 'Change site locales (format: label:prefix)'
 
-    def self.banner
+    def self.banner(_command = nil, *)
       'bin/rails maglev:change_site_locales [label:prefix label2:prefix2 ...]'
     end
 

data/lib/commands/maglev/create_site_command.rb

@@ -6,7 +6,7 @@ module Maglev
   class CreateSiteCommand < Rails::Command::Base
     desc 'create_site', 'Create your site'
 
-    def self.banner
+    def self.banner(_command = nil, *)
       'bin/rails maglev:create_site'
     end
 

data/lib/commands/maglev/publish_site_command.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Maglev
+  class PublishSiteCommand < Rails::Command::Base
+    desc 'publish_site', 'Publish all the pages of the site'
+
+    def self.banner(_command = nil, *)
+      'bin/rails maglev:publish_site'
+    end
+
+    def perform
+      require File.expand_path('config/environment')
+
+      site = fetch_site
+
+      return if site.blank?
+
+      publish_pages(site)
+
+      say '🎉 All the pages of the site have been published with success!'
+    end
+
+    private
+
+    def publish_pages(site)
+      fetch_pages.find_each do |page|
+        Maglev::PublishService.call(
+          site: site,
+          page: page
+        )
+      end
+    end
+
+    def fetch_site
+      Maglev::Site.first.tap do |site|
+        say("[Error] You don't seem to have an existing site. 🤔", :red) unless site
+      end
+    end
+
+    def fetch_pages
+      Maglev::Page.all
+    end
+  end
+end

data/lib/commands/maglev/sections/remove_command.rb

@@ -7,7 +7,7 @@ module Maglev
     class RemoveCommand < Rails::Command::Base
       desc 'remove TYPE', 'Remove a section type across the site and its pages'
 
-      def self.banner
+      def self.banner(_command = nil, *)
         'bin/rails maglev:sections:remove TYPE'
       end
 

data/lib/commands/maglev/sections/rename_command.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
+require 'rails'
+
 module Maglev
   module Sections
     class RenameCommand < Rails::Command::Base
       desc 'rename OLD_TYPE NEW_TYPE', 'Rename a section type across the site and its pages'
 
-      def self.banner
+      def self.banner(_command = nil, *)
         'bin/rails maglev:sections:rename OLD_TYPE NEW_TYPE'
       end
 
-      def perform(old_type, new_type)
+      def perform(*args)
         require File.expand_path('config/environment', Rails.root)
 
+        old_type, new_type = args
+
         site = fetch_site
         theme = fetch_theme
 

data/lib/commands/maglev/sections/reset_command.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Maglev
+  module Sections
+    class ResetCommand < Rails::Command::Base
+      desc 'reset TYPE', 'Reset the content of a section type across the site and its pages'
+
+      def self.banner(_command = nil, *)
+        'bin/rails maglev:sections:reset TYPE'
+      end
+
+      def perform(type)
+        require File.expand_path('config/environment', Rails.root)
+
+        site = fetch_site
+        theme = fetch_theme
+
+        return if site.blank? || theme.blank?
+
+        count = Maglev::ResetSectionContent.call(
+          site: site,
+          theme: theme,
+          type: type
+        )
+
+        display_final_message(count, type)
+      end
+
+      private
+
+      def fetch_site
+        Maglev::Site.first.tap do |site|
+          say("[Error] You don't seem to have an existing site. 🤔", :red) unless site
+        end
+      end
+
+      def fetch_theme
+        Maglev.local_themes&.first.tap do |theme|
+          say('[Error] No theme found. 🤔', :red) unless theme
+        end
+      end
+
+      def display_final_message(count, type)
+        if count.zero?
+          say "No section of type '#{type}' found 🤔", :yellow
+          return
+        end
+
+        say "Successfully reset content of #{count} #{'section'.pluralize(count)} of type '#{type}' 🎉",
+            :green
+      end
+    end
+  end
+end

data/lib/generators/maglev/install_generator.rb

@@ -6,11 +6,6 @@ module Maglev
     source_root File.expand_path('templates/install', __dir__)
     hook_for :maglev_install
 
-    def compile_editor_assets
-      rake 'maglev:vite:install_dependencies'
-      rake 'maglev:vite:build_all'
-    end
-
     def migrations
       rake 'maglev:install:migrations'
       rake 'db:migrate'
@@ -30,7 +25,7 @@ module Maglev
         <<-CODE
   mount Maglev::Engine => '/maglev'
   get '/sitemap', to: 'maglev/sitemap#index', defaults: { format: 'xml' }
-  get '(*path)', to: 'maglev/page_preview#index', defaults: { path: 'index' }, constraints: Maglev::PreviewConstraint.new
+  get '(*path)', to: 'maglev/published_page_preview#index', defaults: { path: 'index' }, constraints: Maglev::PreviewConstraint.new
         CODE
       end
     end

data/lib/generators/maglev/templates/install/config/initializers/maglev.rb

@@ -10,14 +10,14 @@ Maglev.configure do |config|
   # config.logo = 'logo.png'
   # Or use the following option:
   # config.logo = ->(site) { site.siteable.avatar_url }
-  # config.logo = ->(site) { ActionController::Base.helpers.vite_asset_path('logo.png') }
+  # config.logo = ->(site) { ActionController::Base.helpers.asset_path('logo.png') }
 
   # Favicon (window tab)
   # Put your custom favicon in the app/assets/images folder of your Rails application.
   # config.favicon = 'favicon.ico'
   # Or use the following options:
   # config.favicon = ->(site) { site.siteable.favicon_url }
-  # config.favicon = ->(site) { ActionController::Base.helpers.vite_asset_path('favicon.png') }
+  # config.favicon = ->(site) { ActionController::Base.helpers.asset_path('favicon.png') }
 
   # Primary color of the Editor
   # config.primary_color = '#040712'
@@ -83,4 +83,8 @@ Maglev.configure do |config|
   # Prevent the content editors to create pages sharing the same path with other
   # existing pages of the application.
   # config.reserved_paths = %w(products sign-in search posts/*)
+
+  # Extra Tailwind CSS folders to watch for changes.
+  # To be used if you need to implement a custom component in a folder of the main app.
+  # config.tailwindcss_folders = []
 end

data/lib/generators/maglev/templates/theme/app/views/theme/layout.html.erb.tt

@@ -11,8 +11,8 @@
 
   <%%= render_maglev_alternate_links %>
 
-  <%%= maglev_live_preview_client_javascript_tag %>
-
+  <%%= maglev_client_javascript_tags %>
+  
   <%%=
     javascript_include_tag(
       "https://cdn.tailwindcss.com?plugins=forms,typography,aspect-ratio",

data/lib/maglev/config.rb

@@ -5,5 +5,6 @@ module Maglev
                       :site_publishable, :uploader, :preview_host, :asset_host, :services,
                       :collections, :is_authenticated, :ui_locale, :default_site_locales,
                       :static_pages, :reserved_paths,
-                      :admin_username, :admin_password)
+                      :admin_username, :admin_password,
+                      :tailwindcss_folders)
 end

data/lib/maglev/engine.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'vite_ruby'
+require 'turbo-rails'
+require 'importmap-rails'
 require 'maglev/migration'
 
 module Maglev
@@ -39,52 +40,43 @@ module Maglev
       Rails.application.config.i18n.load_path += Dir["#{config.root}/config/locales/**/*.yml"]
     end
 
-    delegate :vite_ruby, to: :class
-
-    def self.vite_ruby
-      @vite_ruby ||= ::ViteRuby.new(root: root, mode: Rails.env)
+    def self.importmaps
+      @importmaps ||= {
+        editor: ::Importmap::Map.new,
+        client: ::Importmap::Map.new
+      }
     end
 
-    # Serves the engine's vite-ruby when requested
-    initializer 'maglev.vite_rails.static' do |app|
-      if Rails.application.config.public_file_server.enabled
-        # this is the right setup when the main application is already
-        # using Vite for the theme assets.
-        app.middleware.insert_after ActionDispatch::Static,
-                                    Rack::Static,
-                                    urls: ["/#{vite_ruby.config.public_output_dir}"],
-                                    root: root.join(vite_ruby.config.public_dir),
-                                    header_rules: [
-                                      # rubocop:disable Style/StringHashKeys
-                                      [:all, { 'Access-Control-Allow-Origin' => '*' }]
-                                      # rubocop:enable Style/StringHashKeys
-                                    ]
-      else
-        # mostly when running the application in production behind NGINX or APACHE
-        app.middleware.insert_before 0,
-                                     Rack::Static,
-                                     urls: ["/#{vite_ruby.config.public_output_dir}"],
-                                     root: root.join(vite_ruby.config.public_dir),
-                                     header_rules: [
-                                       # rubocop:disable Style/StringHashKeys
-                                       [:all, { 'Access-Control-Allow-Origin' => '*' }]
-                                       # rubocop:enable Style/StringHashKeys
-                                     ]
-      end
-    end
+    initializer 'maglev.assets' do |app|
+      app.config.assets.paths << Engine.root.join('app/assets/builds')
+      app.config.assets.paths << Engine.root.join('app/components')
+      app.config.assets.paths << Engine.root.join('app/assets/javascripts')
+      app.config.assets.paths << Engine.root.join('vendor/javascript')
 
-    initializer 'maglev.vite_rails_engine.proxy' do |app|
-      if vite_ruby.run_proxy?
-        app.middleware.insert_before 0,
-                                     ViteRuby::DevServerProxy,
-                                     ssl_verify_none: true,
-                                     vite_ruby: vite_ruby
-      end
+      # required by Sprockets (if used by the main app)
+      app.config.assets.precompile += %w[maglev_manifest]
     end
 
-    initializer 'maglev.vite_rails_engine.logger' do
-      config.after_initialize do
-        vite_ruby.logger = Rails.logger
+    initializer 'maglev.importmap', after: 'importmap' do |app|
+      Engine.importmaps[:editor].draw(Engine.root.join('config/editor_importmap.rb'))
+      Engine.importmaps[:client].draw(Engine.root.join('config/client_importmap.rb'))
+
+      if (Rails.env.development? || Rails.env.test?) && !app.config.cache_classes
+        # Editor
+        Engine.importmaps[:editor].cache_sweeper(watches: [
+                                                   Engine.root.join('app/assets/javascripts'),
+                                                   Engine.root.join('app/components')
+                                                 ])
+
+        # Client
+        Engine.importmaps[:client].cache_sweeper(watches: [
+                                                   Engine.root.join('app/assets/javascripts/maglev/client')
+                                                 ])
+
+        ActiveSupport.on_load(:action_controller_base) do
+          before_action { Engine.importmaps[:editor].cache_sweeper.execute_if_updated }
+          before_action { Engine.importmaps[:client].cache_sweeper.execute_if_updated }
+        end
       end
     end
   end

data/lib/maglev/errors.rb

@@ -4,7 +4,10 @@ module Maglev
   module Errors
     class NotAuthorized < StandardError; end
     class UnknownSection < StandardError; end
+    class UnknownBlock < StandardError; end
     class DuplicateSectionDefinition < StandardError; end
+    class NotImplemented < StandardError; end
+    class UnpublishedPage < StandardError; end
 
     class UnknownSetting < StandardError
       def initialize(section_id, block_id, setting_id)

data/lib/maglev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Maglev
-  VERSION = '2.0.0'
+  VERSION = '3.0.0.beta1'
 end

data/lib/maglev.rb

@@ -9,7 +9,8 @@ require_relative 'maglev/preview_constraint'
 require_relative 'maglev/reserved_paths'
 
 require 'injectable'
-require 'jbuilder'
+require 'pagy'
+require 'view_component'
 
 module Maglev
   ROOT_PATH = Pathname.new(File.join(__dir__, '..'))
@@ -29,7 +30,7 @@ module Maglev
         c.uploader = :active_storage
         c.site_publishable = false
         c.preview_host = nil
-        c.asset_host = Rails.application.config.action_controller.asset_host
+        c.asset_host = Rails.application.config.asset_host
         c.ui_locale = nil
         c.back_action = nil
         c.services = {}
@@ -39,6 +40,7 @@ module Maglev
         c.admin_password = nil
         c.static_pages = []
         c.reserved_paths = []
+        c.tailwindcss_folders = []
       end
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize

data/lib/tasks/maglev/tailwindcss.rake

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+namespace :maglev do
+  namespace :tailwindcss do
+    desc 'Generate Tailwind CSS classes from component files'
+    task build: :environment do
+      puts '[Maglev] Building EditorTailwind CSS'
+      run_tailwindcss_cli
+    end
+
+    desc 'Watch for changes in component files and rebuild Tailwind CSS'
+    task watch: :environment do
+      run_tailwindcss_cli('--watch')
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def run_tailwindcss_cli(options = nil)
+      command_path = Maglev::Engine.root.join('exe', 'tailwind-cli')
+      Maglev::Engine.root.join('tmp/maglev-compiled-tailwind.css')
+      erb_input_path = Maglev::Engine.root.join('app/assets/stylesheets/maglev/tailwind.css.erb')
+      input_path = Maglev::Engine.root.join('tmp/maglev-compiled-tailwind.css')
+      output_path = Maglev::Engine.root.join('app/assets/builds/maglev/tailwind.css')
+
+      FileUtils.mkdir_p(input_path.dirname)
+
+      puts "[Maglev] Generating temporary Tailwind input file at: #{input_path}"
+
+      rendered_css = ERB.new(File.read(erb_input_path)).result
+      File.write(input_path, rendered_css)
+
+      require 'bundler'
+      Bundler.with_unbundled_env do
+        system "#{command_path} -i #{input_path} -o #{output_path} #{options}"
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end