maglevcms 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5927f846b9b6ff6238c335be6238e4d6a6f821ff938f703d3e52c371059d3c3
-  data.tar.gz: 6e7293b7cfd56fb7ed7c95571a08b8fa9b27bb6837175926d9ac24e51133d337
+  metadata.gz: fb191e7d79b2c6224c1c5082034d56e19a065d75a42c8a967f88de2e30d1b3ee
+  data.tar.gz: bb2b968757017e6a7eae8935e71e05afffdd453646d8c4c2dbc26d0b819e11dd
 SHA512:
-  metadata.gz: 2d800cf00c89cec1d2bc92b8106eb2bff7fc42db0abfbb80e528df13ab72133211ab6b6ccec6e27ad6bbf293cdc100c058c99ed17f67f0881532cc5756e0767a
-  data.tar.gz: aba0b9aaf8a65f6119a23e3f15e618ad657832fc9bbf0f20cad4bef1a72355b4fe7085948c86a5453a46723f8f13aff06fdcbf2732c4bafd42b04ea0b4ed64c1
+  metadata.gz: 59e86e32d8a2ad174ebf6d0448b8fe953fc5bb7ecee259743efd3f382997e4b92baffa9d0bb5557c6e2f29fbe2c72153472226bec2c63e4db51e6a228cd952ab
+  data.tar.gz: 70ac8b82452c35e9c6acaac1cdc056b0f45ae5d439f86bcfa81a711bfa11f08efd7205a24a92b317988ace188fd6ac2584a576bb57a00ac20b73cc71978b596d

data/app/frontend/editor/components/dynamic-form/dynamic-input.vue

@@ -74,6 +74,7 @@
       :name="setting.id"
       v-model="inputValue"
       :selectOptions="options.selectOptions"
+      :i18nScope="i18nScope"
       v-if="setting.type == 'select'"
     />
     <uikit-collection-item-input

data/app/frontend/editor/components/kit/simple-select.vue

@@ -33,6 +33,7 @@ export default {
         return []
       },
     },
+    i18nScope: { type: String, default: 'support.simpleSelect' },
   },
   computed: {
     selectedOption: {
@@ -46,10 +47,16 @@ export default {
   },
   methods: {
     getOptionLabel(option) {
-      return typeof option === 'object' ? option.label : option
+      const value = this.getOptionValue(option)
+      const i18nKey = `${this.i18nScope}.${this.name}_options.${value}`
+      const translatedLabel = this.$st(i18nKey)
+
+      if (!this.isBlank(translatedLabel)) return translatedLabel
+
+      return typeof option === 'string' ? option : option.label
     },
     getOptionValue(option) {
-      return typeof option === 'object' ? option.value : option
+      return (typeof option === 'string') ? option : option.value
     },
   },
 }

data/app/frontend/editor/components/section-pane/block-list/new-block-button.vue

@@ -17,10 +17,10 @@
           <button
             v-for="blockType in blockTypes"
             :key="blockType.type"
-            class="mb-2 text-base text-gray-900 py-2 px-14 hover:bg-gray-100 transition-colors"
+            class="mb-2 text-base text-gray-900 py-2 px-14 hover:bg-gray-100 transition-colors text-left"
             @click="addSectionBlockAndClose(blockType.type)"
           >
-            {{ blockType.name }}
+            {{ blockTypeLabel(blockType) }}
           </button>
         </div>
       </template>
@@ -56,6 +56,9 @@ export default {
         )
       else return this.currentSectionDefinition.blocks
     },
+    currentBlockTypesI18nScope() {
+      return `${this.currentSectionI18nScope}.blocks.types`
+    }
   },
   methods: {
     ...mapActions(['addSectionBlock']),
@@ -63,6 +66,9 @@ export default {
       this.addSectionBlock({ blockType })
       this.$refs.dropdown.close()
     },
+    blockTypeLabel(blockType) {
+      return this.$st(`${this.currentBlockTypesI18nScope}.${blockType.type}`) ?? blockType.name
+    }
   },
 }
 </script>

data/app/frontend/editor/components/section-pane/block-tree/new-nested-block-button.vue

@@ -15,10 +15,10 @@
           <button
             v-for="blockType in blockTypes"
             :key="blockType.type"
-            class="mb-2 text-base text-gray-900 py-2 px-4 hover:bg-gray-100 transition-colors"
+            class="mb-2 text-base text-gray-900 py-2 px-4 hover:bg-gray-100 transition-colors text-left"
             @click="addNestedSectionBlockAndClose(blockType.type)"
           >
-            {{ blockType.name }}
+            {{ blockTypeLabel(blockType) }}
           </button>
         </div>
       </template>
@@ -49,6 +49,9 @@ export default {
         (block) => this.accept.indexOf(block.type) !== -1,
       )
     },
+    currentBlockTypesI18nScope() {
+      return `${this.currentSectionI18nScope}.blocks.types`
+    }
   },
   methods: {
     ...mapActions(['addSectionBlock']),
@@ -62,6 +65,9 @@ export default {
       this.addSectionBlock({ blockType, parentId: this.parentId })
       this.$refs.dropdown.close()
     },
+    blockTypeLabel(blockType) {
+      return this.$st(`${this.currentBlockTypesI18nScope}.${blockType.type}`) ?? blockType.name
+    },
   },
 }
 </script>

data/app/models/concerns/maglev/translatable.rb

@@ -8,20 +8,38 @@ module Maglev
     extend ActiveSupport::Concern
 
     def translations_for(attr)
-      public_send("#{attr}_translations")
+      # With MySQL, there is no default value for JSON columns, so we need to check for nil
+      public_send("#{attr}_translations").presence || {}
     end
 
     def translate_attr_in(attr, locale, source_locale)
       translations_for(attr)[locale.to_s] ||= translations_for(attr)[source_locale.to_s]
     end
 
+    # rubocop:disable Metrics/BlockLength
     class_methods do
       def order_by_translated(attr, direction)
-        order(Arel.sql("#{attr}_translations->>'#{Maglev::I18n.current_locale}'") => direction)
+        order(translated_arel_attribute(attr, Maglev::I18n.current_locale) => direction)
+      end
+
+      def translated_arel_attribute(attr, locale)
+        return Arel.sql("#{attr}_translations->>'#{locale}'") unless mysql?
+
+        # MySQL and MariaDB JSON support 🤬🤬🤬
+        # Note: doesn't work with Rails 7.0.x
+        json_extract = Arel::Nodes::NamedFunction.new(
+          'json_extract',
+          [Arel::Nodes::SqlLiteral.new("#{attr}_translations"), Arel::Nodes.build_quoted("$.#{locale}")]
+        )
+        Arel::Nodes::NamedFunction.new('json_unquote', [json_extract])
       end
 
       def translates(*attributes, presence: false)
-        attributes.each { |attr| setup_accessors(attr) }
+        attributes.each do |attr|
+          # MariaDB doesn't support native JSON columns (longtext instead), we need to force it.
+          attribute("#{attr}_translations", :json) if respond_to?(:attribute)
+          setup_accessors(attr)
+        end
         add_presence_validator(attributes) if presence
       end
 
@@ -37,12 +55,14 @@ module Maglev
 
       def setup_accessors(attr)
         define_method("#{attr}=") do |value|
-          public_send("#{attr}_translations=", translations_for(attr).merge(Maglev::I18n.current_locale => value))
+          public_send("#{attr}_translations=",
+                      translations_for(attr).merge(Maglev::I18n.current_locale.to_s => value))
         end
 
         define_method(attr) { translations_for(attr)[Maglev::I18n.current_locale.to_s] }
         define_method("default_#{attr}") { translations_for(attr)[Maglev::I18n.default_locale.to_s] }
       end
     end
+    # rubocop:enable Metrics/BlockLength
   end
 end

data/app/models/maglev/application_record.rb

@@ -3,5 +3,15 @@
 module Maglev
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
+
+    def self.mysql?
+      connection.adapter_name.downcase == 'mysql2'
+    end
+
+    private
+
+    def mysql?
+      self.class.mysql?
+    end
   end
 end

data/app/models/maglev/page/search_concern.rb

@@ -32,9 +32,7 @@ module Maglev::Page::SearchConcern
     end
 
     def search_title_node(locale)
-      Arel::Nodes::InfixOperation.new('->>',
-                                      arel_table[:title_translations],
-                                      Arel::Nodes.build_quoted(locale))
+      translated_arel_attribute(:title, locale)
     end
   end
 end

data/app/models/maglev/site/locales_concern.rb

@@ -5,12 +5,8 @@ module Maglev::Site::LocalesConcern
   extend ActiveSupport::Concern
 
   included do
-    ## serializers ##
-    if Rails::VERSION::MAJOR >= 8 || (Rails::VERSION::MAJOR >= 7 && Rails::VERSION::MINOR.positive?)
-      serialize :locales, coder: LocalesSerializer
-    else
-      serialize :locales, LocalesSerializer
-    end
+    ## custom column type ##
+    attribute :locales, :maglev_locales
 
     ## validation ##
     validates :locales, 'maglev/collection': true, length: { minimum: 1 }
@@ -42,15 +38,5 @@ module Maglev::Site::LocalesConcern
       end
     end
   end
-
-  class LocalesSerializer
-    def self.dump(array)
-      (array || []).map(&:as_json)
-    end
-
-    def self.load(array)
-      (array || []).map { |attributes| Maglev::Site::Locale.new(**attributes.symbolize_keys) }
-    end
-  end
 end
 # rubocop:enable Style/ClassAndModuleChildren

data/app/models/maglev/site.rb

@@ -20,6 +20,10 @@ module Maglev
     include Maglev::SectionsConcern
     include Maglev::Translatable
 
+    ## force JSON columns for MariaDB ##
+    attribute :style, :json
+    attribute :sections_translations, :json
+
     ## translations ##
     translates :sections
 

data/app/services/maglev/fetch_section_screenshot_url.rb

@@ -8,7 +8,18 @@ module Maglev
     argument :section
 
     def call
-      fetch_section_screenshot_path.call(section: section) + "?#{section.screenshot_timestamp}"
+      screenshot_path = fetch_section_screenshot_path.call(section: section) + query_string
+      asset_host ? URI.join(asset_host, screenshot_path).to_s : screenshot_path
+    end
+
+    private
+
+    def asset_host
+      Rails.application.config.asset_host
+    end
+
+    def query_string
+      "?#{section.screenshot_timestamp}"
     end
   end
 end

data/app/services/maglev/fetch_style.rb

@@ -31,7 +31,7 @@ module Maglev
     end
 
     def custom_value(setting)
-      value = site.style.find { |local_value| local_value['id'] == setting.id }
+      value = (site.style || []).find { |local_value| local_value['id'] == setting.id }
       value && value['type'] == setting.type ? value['value'] : setting.default
     end
   end

data/app/services/maglev/reset_section_content.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Maglev
+  # Reset the content of a section type across a site and its pages
+  class ResetSectionContent
+    include Injectable
+
+    argument :site
+    argument :theme
+    argument :type
+
+    def call
+      validate_section_type!
+
+      @count = 0
+
+      reset_content
+
+      @count
+    end
+
+    private
+
+    def validate_section_type!
+      return if theme.sections.find(type)
+
+      raise Maglev::Errors::UnknownSection,
+            "Section type '#{type}' doesn't exist in the theme"
+    end
+
+    def reset_content
+      ActiveRecord::Base.transaction do
+        reset_resource_content(site)
+        site_pages.find_each do |page|
+          reset_resource_content(page)
+        end
+      end
+    end
+
+    def reset_resource_content(resource)
+      site.each_locale do
+        @count += reset_sections_content_of_type(resource.find_sections_by_type(type), type)
+      end
+
+      resource.save!
+    end
+
+    def reset_sections_content_of_type(sections, type)
+      return 0 if sections.blank?
+
+      sections.map do |section|
+        section.replace(build_default_content(type))
+      end.size
+    end
+
+    def build_default_content(type)
+      theme.sections.find(type).build_default_content
+    end
+
+    def site_pages
+      Maglev::Page
+    end
+  end
+end

data/app/types/maglev/locales_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Maglev
+  class LocalesType < ActiveRecord::Type::Json
+    def deserialize(value)
+      (super || []).map { |attributes| Maglev::Site::Locale.new(**attributes.symbolize_keys) }
+    end
+  end
+end

data/config/initializers/active_record_types.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative '../../app/types/maglev/locales_type'
+
+ActiveRecord::Type.register(:maglev_locales, Maglev::LocalesType)

data/config/initializers/migration_patches.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  class Migration
+    def mysql?
+      connection.adapter_name.downcase == 'mysql2'
+    end
+  end
+end

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/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/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/maglev/version.rb

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

data/lib/maglev.rb

@@ -29,7 +29,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 = {}

data/lib/tasks/maglev/vite.rake

@@ -58,5 +58,13 @@ namespace :maglev do
         Maglev::Engine.vite_ruby.commands.print_info
       end
     end
+
+    desc "Copy the ViteRuby's public directory to the app's public directory"
+    task copy_public_dir: :environment do
+      output_dir_name = Maglev::Engine.vite_ruby.config.public_output_dir
+      source_path = Maglev::Engine.root.join('public', output_dir_name)
+      target_path = Rails.root.join('public')
+      FileUtils.cp_r(source_path, target_path)
+    end
   end
 end

data/lib/tasks/maglev_tasks.rake

@@ -6,17 +6,6 @@ def within_engine_folder(&block)
   Dir.chdir(File.join(__dir__, '..', '..'), &block)
 end
 
-# Load all task files only if they haven't been loaded before
-Dir[File.join(__dir__, 'maglev', '*.rake')].each do |file|
-  # Create a unique task loaded flag
-  task_name = File.basename(file, '.rake')
-  next if Rake::Task.task_defined?("maglev:#{task_name}:loaded")
-
-  load file
-  # Create a dummy task to mark this file as loaded
-  Rake::Task.define_task("maglev:#{task_name}:loaded")
-end
-
 unless ENV['VITE_RUBY_SKIP_ASSETS_PRECOMPILE_EXTENSION'] == 'true'
   if Rake::Task.task_defined?('assets:precompile')
     Rake::Task['assets:precompile'].enhance do |_task|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maglevcms
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Didier Lafforgue
@@ -497,8 +497,10 @@ files:
 - app/services/maglev/persist_section_screenshot.rb
 - app/services/maglev/remove_section_type.rb
 - app/services/maglev/rename_section_type.rb
+- app/services/maglev/reset_section_content.rb
 - app/services/maglev/search_pages.rb
 - app/services/maglev/setup_pages.rb
+- app/types/maglev/locales_type.rb
 - app/validators/maglev/collection_validator.rb
 - app/validators/maglev/presence_validator.rb
 - app/views/layouts/maglev/admin/_header_actions.html.erb
@@ -527,8 +529,10 @@ files:
 - app/views/maglev/settings/index.html.erb
 - app/views/maglev/sitemap/index.xml.builder
 - bin/vite
+- config/initializers/active_record_types.rb
 - config/initializers/filter_parameters_logging.rb
 - config/initializers/kaminari.rb
+- config/initializers/migration_patches.rb
 - config/initializers/zeitwerk.rb
 - config/locales/activerecord.ar.yml
 - config/locales/activerecord.en.yml
@@ -555,6 +559,7 @@ files:
 - lib/commands/maglev/create_site_command.rb
 - lib/commands/maglev/sections/remove_command.rb
 - lib/commands/maglev/sections/rename_command.rb
+- lib/commands/maglev/sections/reset_command.rb
 - lib/generators/maglev/install_generator.rb
 - lib/generators/maglev/section_generator.rb
 - lib/generators/maglev/templates/install/config/initializers/maglev.rb