maglevcms 1.8.0 → 2.0.0.beta1

data/db/migrate/20210819092740_switch_to_localized_page_fields.rb

@@ -1,15 +1,25 @@
 class SwitchToLocalizedPageFields < ActiveRecord::Migration[6.1]
   def up
     remove_columns :maglev_pages, :title, :seo_title, :meta_description
-    add_column :maglev_pages, :title_translations, :jsonb, default: {}
-    add_column :maglev_pages, :seo_title_translations, :jsonb, default: {}
-    add_column :maglev_pages, :meta_description_translations, :jsonb, default: {}
+
+    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: {}
+      else
+        t.json :title_translations, default: {}
+        t.json :seo_title_translations, default: {}
+        t.json :meta_description_translations, default: {}
+      end
+    end
   end
 
   def down
     add_column :maglev_pages, :title, :string
     add_column :maglev_pages, :seo_title, :string
     add_column :maglev_pages, :meta_description, :string
+
     remove_column :maglev_pages, :title_translations
     remove_column :maglev_pages, :seo_title_translations
     remove_column :maglev_pages, :meta_description_translations

data/db/migrate/20211008064437_add_locales_to_sites.rb

@@ -1,5 +1,11 @@
 class AddLocalesToSites < ActiveRecord::Migration[6.0]
   def change
-    add_column :maglev_sites, :locales, :jsonb, default: []
+    change_table :maglev_sites do |t|
+      if t.respond_to? :jsonb
+        t.jsonb :locales, default: []
+      else
+        t.json :locales, default: []
+      end
+    end
   end
 end

data/db/migrate/20211013210954_translate_section_content.rb

@@ -1,8 +1,22 @@
 class TranslateSectionContent < ActiveRecord::Migration[6.0]
   def change
     remove_column :maglev_sites, :sections, :jsonb, default: []
-    add_column :maglev_sites, :sections_translations, :jsonb, default: {}
     remove_column :maglev_pages, :sections, :jsonb, default: []
-    add_column :maglev_pages, :sections_translations, :jsonb, default: {}
+
+    change_table :maglev_sites do |t|
+      if t.respond_to? :jsonb
+        t.jsonb :sections_translations, default: {}
+      else
+        t.json :sections_translations, default: {}
+      end
+    end
+
+    change_table :maglev_pages do |t|
+      if t.respond_to? :jsonb
+        t.jsonb :sections_translations, default: {}
+      else
+        t.json :sections_translations, default: {}
+      end
+    end
   end
 end

data/db/migrate/20211203224112_add_open_graph_tags_to_pages.rb

@@ -1,9 +1,15 @@
 class AddOpenGraphTagsToPages < ActiveRecord::Migration[6.0]
   def change
     change_table :maglev_pages do |t|
-      t.jsonb :og_title_translations, default: {}
-      t.jsonb :og_description_translations, default: {}
-      t.jsonb :og_image_url_translations, default: {}
+      if t.respond_to? :jsonb
+        t.jsonb :og_title_translations, default: {}
+        t.jsonb :og_description_translations, default: {}
+        t.jsonb :og_image_url_translations, default: {}
+      else
+        t.json :og_title_translations, default: {}
+        t.json :og_description_translations, default: {}
+        t.json :og_image_url_translations, default: {}
+      end
     end
   end
 end

data/db/migrate/20220612092235_add_style_to_sites.rb

@@ -1,7 +1,11 @@
 class AddStyleToSites < ActiveRecord::Migration[6.0]
   def change
     change_table :maglev_sites do |t|
-      t.jsonb :style, default: []
+      if t.respond_to? :jsonb
+        t.jsonb :style, default: []
+      else
+        t.json :style, default: []
+      end
     end
   end
 end

data/lib/commands/maglev/change_site_locales_command.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Maglev
+  class ChangeSiteLocalesCommand < Rails::Command::Base
+    desc 'change_site_locales [LOCALES]', 'Change site locales (format: label:prefix)'
+
+    def self.banner
+      'bin/rails maglev:change_site_locales [label:prefix label2:prefix2 ...]'
+    end
+
+    def perform(*locale_args)
+      require File.expand_path('config/environment', Rails.root)
+
+      site = fetch_site
+      return if site.blank?
+
+      locales = build_locales(locale_args)
+      return if locales.empty?
+
+      update_site_locales(site, locales)
+    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 build_locales(locale_args)
+      build_custom_locales(locale_args).tap do |locales|
+        validate_locales(locales)
+      end
+    end
+
+    def build_custom_locales(locale_args)
+      (locale_args || []).map do |arg|
+        label, prefix = arg.split(':')
+        Maglev::Site::Locale.new(label: label, prefix: prefix)
+      end
+    end
+
+    def validate_locales(locales)
+      return true if !locales.empty? && locales.all?(&:valid?)
+
+      say("[Error] make sure your locales follow the 'label:prefix' pattern. 🤓", :red)
+      false
+    end
+
+    def update_site_locales(site, locales)
+      Maglev::ChangeSiteLocales.call(
+        site: site,
+        locales: locales
+      )
+      say('Success! 🎉🎉🎉', :green)
+    end
+  end
+end

data/lib/commands/maglev/create_site_command.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Maglev
+  class CreateSiteCommand < Rails::Command::Base
+    desc 'create_site', 'Create your site'
+
+    def self.banner
+      'bin/rails maglev:create_site'
+    end
+
+    def perform
+      require File.expand_path('config/environment')
+
+      if Maglev::Site.exists?
+        say '🤔 You already have a site. 🤔', :yellow
+        return
+      end
+
+      Maglev::GenerateSite.call(
+        theme: Maglev.local_themes.first
+      )
+
+      say '🎉 Your site has been created with success!'
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Maglev
+  module Sections
+    class RemoveCommand < Rails::Command::Base
+      desc 'remove TYPE', 'Remove a section type across the site and its pages'
+
+      def self.banner
+        'bin/rails maglev:sections:remove TYPE'
+      end
+
+      def perform(type)
+        require File.expand_path('config/environment', Rails.root)
+
+        site = fetch_site
+
+        return if site.blank?
+
+        removed_count = Maglev::RemoveSectionType.call(
+          site: site,
+          type: type
+        )
+
+        display_final_message(removed_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 display_final_message(removed_count, type)
+        if removed_count.zero?
+          say "No section of type '#{type}' found 🤔", :yellow
+          return
+        end
+
+        say "Successfully removed #{removed_count} #{'section'.pluralize(removed_count)} of type '#{type}' 🎉",
+            :green
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+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
+        'bin/rails maglev:sections:rename OLD_TYPE NEW_TYPE'
+      end
+
+      def perform(old_type, new_type)
+        require File.expand_path('config/environment', Rails.root)
+
+        site = fetch_site
+        theme = fetch_theme
+
+        return if site.blank? || theme.blank?
+
+        rename_sections(site, theme, old_type, new_type)
+
+        say "Successfully renamed all '#{old_type}' sections to '#{new_type}' 🎉", :green
+      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 rename_sections(site, theme, old_type, new_type)
+        Maglev::RenameSectionType.call(
+          site: site,
+          theme: theme,
+          old_type: old_type,
+          new_type: new_type
+        )
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@
 Maglev.configure do |config|
   # Title of the Editor window
   # config.title = 'Maglev - Editor'
+  # config.title = ->(site) { "#{site.name} 👋" }
 
   # Logo of the Editor (top left corner).
   # Put your custom logo in the app/assets/images folder of your Rails application.
@@ -50,7 +51,9 @@ Maglev.configure do |config|
   config.admin_username = Rails.env.production? ? ENV.fetch('MAGLEV_ADMIN_USERNAME') : nil
   config.admin_password = Rails.env.production? ? ENV.fetch('MAGLEV_ADMIN_PASSWORD') : nil
 
-  # Uploader engine (:active_storage is only supported for now)
+  # Uploader engine (:active_storage is the default one)
+  # Checkout https://github.com/MarsBased/maglevcms-shrine for an example of a custom uploader
+  # config.uploader = 'Maglev::Shrine::Uploader'
   config.uploader = :active_storage
 
   # Collections mapping (https://docs.maglev.dev/guides/setup-collections)

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

@@ -4,7 +4,7 @@
   <title><%%= maglev_page.seo_title.presence || maglev_site.name %></title>
   <meta content="width=device-width, initial-scale=1" name="viewport">
 
-  <meta name="description" content="<%%= maglev_page.meta_description %>" />  
+  <meta name="description" content="<%%= maglev_page.meta_description %>" />
   <meta property="og:title" content="<%%= maglev_page.og_title %>" />
   <meta property="og:description" content="<%%= maglev_page.og_description %>" />
   <meta property="og:image" content="<%%= maglev_page.og_image_url %>" />
@@ -13,7 +13,13 @@
 
   <%%= maglev_live_preview_client_javascript_tag %>
 
-  <script src="https://cdn.tailwindcss.com?plugins=forms,typography,aspect-ratio,line-clamp"></script>
+  <%%=
+    javascript_include_tag(
+      "https://cdn.tailwindcss.com?plugins=forms,typography,aspect-ratio",
+      nonce: true,
+      id: "tailwind-cdn"
+    )
+  %>
 </head>
 <body class="bg-white">
   <main data-maglev-dropzone>

data/lib/maglev/errors.rb

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

data/lib/maglev/preview_constraint.rb

@@ -13,7 +13,7 @@ module Maglev
     end
 
     def matches?(request)
-      (accepted_format?(request) || crawler?(request)) && match_host?(request)
+      !websocket?(request) && (accepted_format?(request) || crawler?(request)) && match_host?(request)
     end
 
     protected
@@ -32,6 +32,10 @@ module Maglev
       request.format.symbol.nil? && CRAWLER_USER_AGENTS.match?(request.user_agent)
     end
 
+    def websocket?(request)
+      request.headers['HTTP_UPGRADE'] == 'websocket'
+    end
+
     def match_host?(request)
       !preview_host || preview_host == request.host
     end

data/lib/maglev/theme_filesystem_loader.rb

@@ -11,6 +11,7 @@ module Maglev
     def call(path)
       theme = add(YAML.safe_load(File.read(path.join('theme.yml')), aliases: true))
       sections = load_sections(theme, Pathname.new(path).join('sections/**/*.yml'))
+      detect_duplicate_sections(sections)
       theme.sections = Maglev::Section::Store.new(sections)
       theme
     rescue Errno::ENOENT
@@ -52,6 +53,12 @@ module Maglev
       File.exist?(path) ? File.mtime(path).to_i : nil
     end
 
+    def detect_duplicate_sections(sections)
+      sections.group_by(&:id).each do |id, list|
+        raise Maglev::Errors::DuplicateSectionDefinition, "Duplicate section definition: #{id}" if list.size > 1
+      end
+    end
+
     def log_missing_theme_file(path)
       # don't log the error if the ruby code is not executed inside
       # the Rails console or when the Rails server is running

data/lib/maglev/version.rb

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

data/lib/maglev.rb

@@ -26,7 +26,7 @@ module Maglev
         c.favicon = nil
         c.logo = nil
         c.primary_color = '#040712'
-        c.uploader = 'active_storage'
+        c.uploader = :active_storage
         c.site_publishable = false
         c.preview_host = nil
         c.asset_host = Rails.application.config.action_controller.asset_host
@@ -47,12 +47,22 @@ module Maglev
       config.tap do
         yield(config)
         config.reserved_paths = Maglev::ReservedPaths.new(config.reserved_paths)
+        require_relative 'maglev/active_storage' if config.uploader == :active_storage
       end
     end
 
     def uploader
-      require_relative "maglev/#{config.uploader}"
-      const_get("::Maglev::#{config.uploader.to_s.classify}")
+      case config.uploader
+      when Symbol then const_get("::Maglev::#{config.uploader.to_s.classify}")
+      when String then const_get(config.uploader)
+      when Class then config.uploader
+      else
+        raise "Invalid or not set uploader: #{config.uploader}"
+      end
+    end
+
+    def uploader_proxy_controller_name
+      config.uploader == :active_storage ? 'assets/active_storage_proxy' : 'assets/proxy'
     end
 
     def services(overrides = {})

data/lib/tasks/maglev/icons.rake

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+namespace :maglev do
+  namespace :icons do
+    desc 'Generate FontAwesome icon configuration for Maglev'
+    task fontawesome: :environment do
+      require 'net/http'
+      require 'uri'
+
+      puts 'Fetching FontAwesome icons from CDN...'
+
+      # Fetch the all.css file from FontAwesome CDN
+      uri = URI('https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/all.css')
+      response = Net::HTTP.get(uri)
+
+      # Extract icon classes using regex
+      icon_classes = []
+
+      # Match .fa-* classes that define content
+      response.scan(/\.(fa-[^:]+):before/).each do |match|
+        class_name = match[0]
+        next if class_name.include?('{') || class_name.include?('}') # Skip utility classes
+
+        # Add each style variant
+        %w[fa-solid fa-regular fa-light fa-thin fa-brands].each do |style|
+          # Extract the icon name without fa- prefix
+          icon_name = class_name.sub('fa-', '')
+          icon_classes << "#{style} fa-#{icon_name}"
+        end
+      end
+
+      # Remove duplicates and sort
+      icon_classes.uniq!
+      icon_classes.sort!
+
+      puts "Found #{icon_classes.size} icon variations"
+
+      # Generate the icons YAML content in a single line
+      icons_yaml = ['', '', '# FontAwesome icons', "icons: [#{icon_classes.map { |i| %("#{i}") }.join(', ')}]"]
+      icons_yaml = icons_yaml.join("\n")
+
+      # Append to theme.yml
+      theme_file = Rails.root.join('app/theme/theme.yml')
+
+      if File.exist?(theme_file)
+        # Read the current content
+        content = File.read(theme_file)
+
+        # Check if icons are already defined
+        if content.match?(/^icons:/)
+          puts "Warning: 'icons' section already exists in #{theme_file}"
+          puts "Please remove the existing 'icons' section first"
+          puts 'You can add the following content to your theme.yml file:'
+          puts icons_yaml
+        else
+          # Append the icons section
+          File.write(theme_file, [content.rstrip, icons_yaml, "\n"].join)
+          puts "Updated #{theme_file} with FontAwesome icons"
+        end
+      else
+        puts "Warning: #{theme_file} not found. Please create a theme first."
+        puts 'You can add the following content to your theme.yml file:'
+        puts icons_yaml
+      end
+    end
+
+    desc 'Generate Remixicon icon configuration for Maglev'
+    task remixicon: :environment do
+      require 'net/http'
+      require 'uri'
+
+      puts 'Fetching Remixicon icons from CDN...'
+
+      # Fetch the remixicon.css file from CDN
+      uri = URI('https://cdn.jsdelivr.net/npm/remixicon@3.7.0/fonts/remixicon.css')
+      response = Net::HTTP.get(uri)
+
+      # Extract icon classes using regex
+      icon_classes = []
+
+      # Match .ri-* classes that define content
+      response.scan(/\.(ri-[^:]+):before/).each do |match|
+        class_name = match[0]
+        next if class_name.include?('{') || class_name.include?('}') # Skip utility classes
+
+        icon_classes << class_name
+      end
+
+      icon_classes.uniq!
+      icon_classes.sort!
+
+      puts "Found #{icon_classes.size} Remixicon icons"
+
+      # Generate the icons YAML content in a single line
+      icons_yaml = ['', '', '# Remixicon icons', "icons: [#{icon_classes.map { |i| %("#{i}") }.join(', ')}]"]
+      icons_yaml = icons_yaml.join("\n")
+
+      # Append to theme.yml
+      theme_file = Rails.root.join('app/theme/theme.yml')
+
+      if File.exist?(theme_file)
+        # Read the current content
+        content = File.read(theme_file)
+
+        # Check if icons are already defined
+        if content.match?(/^icons:/)
+          puts "Warning: 'icons' section already exists in #{theme_file}"
+          puts "Please remove the existing 'icons' section first"
+          puts 'You can add the following content to your theme.yml file:'
+          puts icons_yaml
+        else
+          # Append the icons section
+          File.write(theme_file, [content.rstrip, icons_yaml, "\n"].join)
+          puts "Updated #{theme_file} with Remixicon icons"
+        end
+      else
+        puts "Warning: #{theme_file} not found. Please create a theme first."
+        puts 'You can add the following content to your theme.yml file:'
+        puts icons_yaml
+      end
+    end
+  end
+end

data/lib/tasks/maglev/vite.rake

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+namespace :maglev do
+  namespace :vite do
+    desc 'Bundle frontend entrypoints using ViteRuby'
+    task build: :'vite:verify_install' do
+      within_engine_folder do
+        Maglev::Engine.vite_ruby.commands.build_from_task
+      end
+    end
+
+    desc 'Bundle entrypoints using Vite Ruby (SSR only if enabled)'
+    task build_all: :'vite:verify_install' do
+      within_engine_folder do
+        Maglev::Engine.vite_ruby.commands.build_from_task
+        Maglev::Engine.vite_ruby.commands.build_from_task('--ssr') if ViteRuby.config.ssr_build_enabled
+      end
+    end
+
+    desc 'Ensure build dependencies like Vite are installed before bundling'
+    task install_dependencies: :environment do
+      within_engine_folder do
+        install_dev_dependencies = ENV['VITE_RUBY_SKIP_INSTALL_DEV_DEPENDENCIES'] == 'true'
+        # rubocop:disable Style/StringHashKeys
+        install_env_args = install_dev_dependencies ? {} : { 'NODE_ENV' => 'development' }
+        # rubocop:enable Style/StringHashKeys
+        cmd = Maglev::Engine.vite_ruby.commands.legacy_npm_version? ? 'npx ci --yes' : 'npx --yes ci'
+        result = system(install_env_args, cmd)
+        # Fallback to `yarn` if `npx` is not available.
+        system(install_env_args, 'yarn install --frozen-lockfile') if result.nil?
+      end
+    end
+
+    desc 'Verify if ViteRuby is properly installed in the app'
+    task verify_install: :environment do
+      within_engine_folder do
+        Maglev::Engine.vite_ruby.commands.verify_install
+      end
+    end
+
+    desc 'Remove old bundles created by ViteRuby'
+    task :clean, %i[keep age] => :'vite:verify_install' do |_, args|
+      within_engine_folder do
+        Maglev::Engine.vite_ruby.commands.clean_from_task(args)
+      end
+    end
+
+    desc 'Remove the build output directory for ViteRuby'
+    task clobber: :'vite:verify_install' do
+      within_engine_folder do
+        Maglev::Engine.vite_ruby.commands.clobber
+      end
+    end
+
+    desc "Provide information on ViteRuby's environment"
+    task info: :environment do
+      within_engine_folder do
+        Maglev::Engine.vite_ruby.commands.print_info
+      end
+    end
+  end
+end