maglevcms 1.0.0.rc1

data/lib/generators/maglev/section_generator.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Maglev
+  class SectionGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('templates/section', __dir__)
+
+    class_option :category, type: :string, default: nil
+    class_option :settings, type: :array, default: []
+
+    hook_for :maglev_section
+
+    attr_reader :theme_name, :category, :settings, :blocks
+
+    def verify_theme_exists
+      raise Thor::Error, set_color('ERROR: You must first create a theme.', :red) if theme.nil?
+    end
+
+    def verify_categories_exist
+      raise Thor::Error, set_color('ERROR: You must add categories to your theme.', :red) if categories.blank?
+    end
+
+    def select_category
+      @category = options['category']
+      return if @category.present?
+
+      say 'You have to select a category for your section. Please check your Maglev theme.yml file to manage them.',
+          :blue
+      @category = ask 'Please choose a category', limited_to: categories, default: categories.first
+    end
+
+    def build_settings
+      @settings = extract_section_settings
+      @blocks = extract_blocks
+    end
+
+    def create_section_files
+      directory 'app'
+    end
+
+    private
+
+    def theme
+      Maglev.local_themes&.first
+    end
+
+    def categories
+      theme.section_categories.map(&:id)
+    end
+
+    def extract_section_settings
+      return default_section_settings if options['settings'].blank?
+
+      # build section settings only
+      options['settings'].map do |raw_setting|
+        next if raw_setting.starts_with?('block:') # block setting
+
+        id, type = raw_setting.split(':')
+        SectionSetting.new(id, type)
+      end.compact.presence
+    end
+
+    def extract_blocks
+      # build block settings
+      blocks = options['settings'].map do |raw_setting|
+        next unless raw_setting.starts_with?('block:') # block setting
+
+        _, block_type, id, type = raw_setting.split(':')
+        BlockSetting.new(block_type, id, type)
+      end.compact.presence || []
+
+      blocks = default_block_settings if blocks.blank? && @settings.blank?
+
+      # group them by block types
+      blocks.group_by(&:block_type)
+    end
+
+    def default_section_settings
+      [
+        SectionSetting.new('title', 'text', 'My awesome title'),
+        SectionSetting.new('image', 'image', 'An image')
+      ]
+    end
+
+    def default_block_settings
+      [
+        BlockSetting.new('list_item', 'title', 'text', 'Item title'),
+        BlockSetting.new('list_item', 'image', 'image', 'Item image')
+      ]
+    end
+
+    class SectionSetting
+      attr_reader :id, :type, :label
+
+      def initialize(id, type, label = nil)
+        @id = id
+        @type = type || 'text'
+        @label = label || id.humanize
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def default
+        case type
+        when 'text' then label
+        when 'image' then '"/theme/image-placeholder.jpg"'
+        when 'checkbox' then true
+        when 'link' then '"#"'
+        when 'color' then '#E5E7EB'
+        when 'radio', 'select' then 'option_1'
+        when 'icon' then 'default-icon-class'
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def value?
+        !%w[hint content_type].include?(type)
+      end
+    end
+
+    class BlockSetting < SectionSetting
+      attr_reader :block_type
+
+      def initialize(block_type, id, type, label = nil)
+        super(id, type, label)
+        @block_type = block_type
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+Maglev.configure do |config|
+  # Title of the Editor window
+  # config.title = 'Maglev - Editor'
+
+  # Logo of the Editor (top left corner).
+  # Put your custom logo in the app/assets/images folder of your Rails application.
+  # config.logo = 'logo.png'
+
+  # Favicon (window tab)
+  # Put your custom favicon in the app/assets/images folder of your Rails application.
+  # config.favicon = 'favicon.ico'
+
+  # Primary color of the Editor
+  # config.primary_color = '#7E6EDB'
+
+  # Action triggered when clicking on the very bottom left button in the Editor
+  # NOTE: If you want the user to signed out from the Editor UI once the back action has been triggered,
+  # you'll have to clear the `maglev_site_id` session variable.
+  # config.back_action = 'https://www.mysite.dev' # External url
+  # config.back_action = :my_account_path # name of the route in your Rails application
+  # config.back_action = ->(site) { redirect_to main_app.my_account_path(site_id: site.id) }
+
+  # I18n locale used in the Editor UI (by default, I18n.locale will be used)
+  # config.ui_locale = 'fr' # make sure your locale has been registered in Rails.
+  # config.ui_locale = :find_my_locale # name of any protected method from your Rails application controller
+  # config.ui_locale = ->(site) { 'fr' }
+
+  # Default locales of a site. By default, Maglev will use English (en).
+  # This setting will only be used when creating the site.
+  # If you want add more locales to your site, use the SetSiteLocalesService (https://docs.maglev.dev/guides/i18n).
+  # The first locale of the array will be considered as the default locale of the site
+  # config.default_site_locales = [
+  #  { label: 'English', prefix: 'en' },
+  #  { label: 'French', prefix: 'fr' }
+  # ]
+
+  # Editor UI authentication (https://docs.maglev.dev/guides/setup-authentication)
+  # config.is_authenticated = :editor_allowed? # name of any protected method from your Rails application controller
+  # config.is_authenticated = ->(site) { current_user&.role == 'editor' }
+
+  # Admin UI authentication (https://docs.maglev.dev/guides/setup-authentication)
+  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)
+  config.uploader = :active_storage
+
+  # Collections mapping (https://docs.maglev.dev/guides/setup-collections)
+  # config.collections = {
+  #   products: {
+  #     model: 'Product',
+  #     fields: {
+  #       label: :name,
+  #       image: :thumbnail_url
+  #     }
+  #   }
+  # }
+
+  # Let your content editors references existing pages of your application but
+  # not served/rendered by Maglev.
+  # config.static_pages = [
+  #   {
+  #     title: { en: 'Products', fr: 'Produits' },
+  #     path: { en: 'products', fr: 'fr/produits' }
+  #   },
+  #   {
+  #     title: { en: 'Authentication', fr: 'Authentification' },
+  #     path: { en: 'sign-in', fr: 'fr/se-connecter' }
+  #   }
+  # ]
+
+  # 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)
+end

data/lib/generators/maglev/templates/section/app/theme/sections/%category%/%file_name%.yml.tt

@@ -0,0 +1,102 @@
+# Name of the section displayed in the editor UI
+name: "<%= file_name %>"
+
+# Category of the section in the editor UI (headers, features, testimonials, ...etc)
+category: <%= category %>
+
+# A section might have the same content all over the site, like a menu or a footer for instance.
+# To enable this behavior, uncomment the following statement
+# site_scoped: true
+
+# Display or not the button to insert a new section after this one
+# insert_button: false
+
+# Insert this section at the top or the bottom of the page (default: nil)
+# insert_at: top 
+
+# one single instance per page?
+# singleton: true
+
+# Definition of the settings:
+# A setting type can be one of the following values: text, image, link, collection_item, checkbox, color and icon.
+# Please visit: https://docs.maglev.dev/concepts/setting for more explanation.
+settings:
+<%- settings.each do |setting| -%>
+- label: "<%= setting.label %>"
+  id: <%= setting.id %>
+  type: <%= setting.type %>
+  <%- case setting.type -%>
+  <%- when 'text' -%>
+  # html: true
+  # line_break: true
+  # nb_rows: 5
+  <%- when 'select', 'radio' -%>
+  options:
+  - label: Option 1
+    value: option_1
+  - label: Option 2
+    value: option_2
+  <%- when 'color' -%>
+  presents: ['#E5E7EB', '#FECACA', '#FDE68A', '#A7F3D0', '#BFDBFE']
+  <%- end -%>
+  <% if setting.value? -%>default: <%= setting.default %><% end -%>
+
+<%- end -%>
+# Definition of the blocks.
+# You can define as many types of blocks as you want.
+blocks: <%- if blocks.blank? -%>[]
+<% end %>
+<%- blocks.each do |(type, settings)| -%>
+- name: "<%= type.humanize %>"
+  type: <%= type %>
+  settings:
+  <%- settings.each do |setting| -%>
+  - label: "<%= setting.label %>"
+    id: <%= setting.id %>
+    type: <%= setting.type %>
+    <%- case setting.type -%>
+    <%- when 'text' -%>
+    # html: true
+    # line_break: true
+    # nb_rows: 5
+    <%- when 'select', 'radio' -%>
+    options:
+    - label: Option 1
+      value: option_1
+    - label: Option 2
+      value: option_2
+    <%- end -%>
+    <%- if setting.value? -%>
+    default: <%= setting.default %>
+    <%- end -%>
+  <%- end -%>
+
+<%- end -%>
+# By default, in the editor UI, blocks will be listed below the "Content" title.
+# The title can be changed with the following property:
+# blocks_label: "My list of items"
+
+# By default, blocks are presented as a list in the editor UI. 
+# If you like to use blocks to build a menu with sub menu items, 
+# consider using the tree presentation
+# blocks_presentation: "tree"
+
+# In order to get a section with "meaning" content for the editors, 
+# you can set the default content of a new instance of this section.
+# (it's also be useful when taking a screenshot of the section).
+# sample:
+#   settings:
+    <%- settings.each do |setting| -%>
+#     <% if setting.value? -%><%= setting.id %>: <%= setting.default %><% end -%>
+
+    <%- end -%>
+#   blocks: <%- if blocks.blank? -%>[]
+  <% end %>
+  <%- blocks.each do |(type, settings)| -%>
+#   - type: <%= type %>
+#     settings:
+       <%- settings.each do |setting| -%>
+#       <% if setting.value? -%><%= setting.id %>: <%= setting.default %><% end -%>
+        
+       <%- end -%>
+  <%- end -%>

data/lib/generators/maglev/templates/section/app/views/theme/sections/%category%/%file_name%.html.erb.tt

@@ -0,0 +1,55 @@
+<%%= maglev_section.wrapper_tag.div class: 'py-6 md:py-12 px-4 md:px-6' do %>
+  <div class="container mx-auto">
+    <div class="mb-4">
+      <h2 class="text-2xl font-bold"><%= file_name %></h2>
+      <p class="mt-1 text-sm text-gray-500">
+        Generated by the <strong class="text-black">Maglev</strong> generator.
+      </p>
+    </div>
+
+    <!-- Section settings -->
+    <div class="border-t border-gray-200 px-0 md:px-10 py-5">
+      <div class="grid grid-cols-1 md:grid-cols-4 gap-x-4 gap-y-8">
+        <%- settings.each do |setting| -%>
+        <div class="col-span-1">
+          <h4 class="text-sm font-medium text-gray-500">
+            <%= setting.label %>
+          </h4>
+          <div class="mt-1 text-sm text-gray-900">
+            <%%= maglev_section.setting_tag :<%= setting.id -%> %>
+          </div>
+        </div>
+        <%- end -%>
+      </div>
+    </div>
+    
+    <%- unless blocks.empty? -%>
+    <!-- Section blocks -->
+    <div class="bg-gray-50 px-4 md:px-10 py-4 md:py-10">
+      <h3 class="text-sm uppercase font-bold">Blocks</h3>
+
+      <div class="grid grid-cols-1 md:grid-cols-2 gap-x-8 gap-y-8 mt-10">
+        <%% section.blocks.each do |maglev_block| %>
+          <%%= maglev_block.wrapper_tag.div class: 'col-span-1 bg-white rounded-lg shadow px-4 py-4' do %>
+            <%% case maglev_block.type %>
+              <%- blocks.each do |(type, block_settings)| -%>
+              <%% when '<%= type %>' %>
+                <%- block_settings.each do |setting| -%>
+                <div class="mb-4">
+                  <h4 class="text-sm font-medium text-gray-500">
+                    <%= setting.label %>
+                  </h4>
+                  <div class="mt-1 text-sm text-gray-900">
+                    <%%= maglev_block.setting_tag :<%= setting.id -%> %>
+                  </div>
+                </div>
+                <%- end -%>
+              <%- end -%>
+            <%% end %>
+          <%% end %>
+        <%% end %>
+      </div>
+    </div> 
+    <%- end -%>
+  </div>
+<%% end %>

data/lib/generators/maglev/templates/theme/app/theme/theme.yml.tt

@@ -0,0 +1,22 @@
+# Please, do not change the id of the theme
+id: "theme"
+
+name: "theme"
+
+description: "A brief description of the theme"
+
+section_categories:
+- name: content
+
+# 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: []
+
+
+

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

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <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 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 %>" />
+
+  <%%= render_maglev_alternate_links %>
+
+  <script src="https://cdn.tailwindcss.com?plugins=forms,typography,aspect-ratio,line-clamp"></script>
+</head>
+<body class="bg-white">
+  <main data-maglev-dropzone>
+    <%%= render_maglev_sections %>
+  </main>
+</body>
+</html>

data/lib/generators/maglev/theme_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Maglev
+  class ThemeGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates/theme', __dir__)
+    hook_for :maglev_theme
+
+    def create_theme_files
+      directory 'app'
+    end
+  end
+end

data/lib/maglev/active_storage.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Maglev
+  module ActiveStorage
+    extend ActiveSupport::Concern
+
+    included do
+      after_commit :save_metadata_now, on: :create
+
+      has_one_attached :file
+
+      delegate :url, :download, to: :file
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def save_metadata_now
+      file.analyze if file.attached?
+      update(
+        filename: file.filename.to_s,
+        content_type: file.content_type,
+        byte_size: file.byte_size,
+        height: file.metadata['height'],
+        width: file.metadata['width']
+      )
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    module ClassMethods
+      def optimized
+        all.with_attached_file
+      end
+    end
+  end
+end

data/lib/maglev/config.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Maglev
+  Config = Struct.new(:primary_color, :title, :favicon, :logo, :back_action,
+                      :site_publishable, :uploader, :preview_host, :asset_host, :services,
+                      :collections, :is_authenticated, :ui_locale, :default_site_locales,
+                      :static_pages, :reserved_paths,
+                      :admin_username, :admin_password)
+end

data/lib/maglev/engine.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Maglev
+  class Engine < ::Rails::Engine
+    isolate_namespace Maglev
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+
+    config.assets.precompile += %w[maglev/logo.png maglev/favicon.png]
+
+    initializer 'maglev.theme_reloader' do |app|
+      require_relative './theme_filesystem_loader'
+      theme_path = Rails.root.join('app/theme')
+      theme_reloader = app.config.file_watcher.new([], { theme_path.to_s => ['.yml', 'yml'] }) do
+        theme_loader = Maglev::ThemeFilesystemLoader.new(
+          Maglev.services(context: nil).fetch_section_screenshot_path
+        )
+        Maglev.local_themes = [theme_loader.call(theme_path)]
+      end
+
+      app.reloaders << theme_reloader
+
+      config.to_prepare do
+        # everytime the code of the app or the engine changes, we reload the themes
+        theme_reloader.execute
+      end
+
+      config.after_initialize do
+        theme_reloader.execute
+      end
+    end
+
+    initializer 'maglev.i18n' do |_app|
+      Rails.application.config.i18n.load_path += Dir["#{config.root}/config/locales/**/*.yml"]
+    end
+
+    initializer 'maglev.webpacker.proxy' do |app|
+      insert_middleware = begin
+        Maglev.webpacker.config.dev_server.present?
+      rescue StandardError
+        nil
+      end
+      next unless insert_middleware
+
+      app.middleware.insert_before(
+        0, Webpacker::DevServerProxy,
+        ssl_verify_none: true,
+        webpacker: Maglev.webpacker
+      )
+    end
+
+    # Serves the engine's webpack when requested
+    initializer 'maglev.webpacker.static' do |app|
+      app.config.middleware.use(
+        Rack::Static,
+        urls: ['/maglev-packs'],
+        root: File.expand_path(File.join(__dir__, '..', '..', 'public'))
+      )
+    end
+  end
+end

data/lib/maglev/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Errors
+    class NotAuthorized < StandardError; end
+    class UnknownSection < StandardError; end
+  end
+end

data/lib/maglev/i18n.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# For example, the editor UI can be in English while the displayed Maglev content is in French.
+# That's why we need another kind of I18n.locale only dedicated to Maglev content.
+# Our Maglev::Translatable concern relies on this specific locale.
+module Maglev
+  module I18n
+    class UnavailableLocaleError < RuntimeError; end
+
+    class << self
+      def available_locales
+        Current.available_locales || %i[en]
+      end
+
+      def available_locales=(locales)
+        Current.available_locales = locales.map(&:to_sym)
+      end
+
+      def default_locale
+        available_locales.first
+      end
+
+      def current_locale
+        Current.locale || default_locale
+      end
+
+      def current_locale=(locale)
+        locale = locale.to_sym
+
+        raise UnavailableLocaleError unless available_locales.include?(locale)
+
+        Current.locale = locale
+      end
+
+      def with_locale(locale, &block)
+        Current.set(locale: locale, &block)
+      end
+    end
+
+    class Current < ActiveSupport::CurrentAttributes
+      attribute :locale
+      attribute :available_locales
+    end
+    private_constant :Current
+  end
+end

data/lib/maglev/preview_constraint.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module Maglev
+  class PreviewConstraint
+    attr_reader :preview_host
+
+    def initialize(preview_host: nil)
+      @preview_host = preview_host == true ? default_preview_host : preview_host
+    end
+
+    def matches?(request)
+      %i[html xml].include?(request.format.symbol) && (!preview_host || preview_host == request.host)
+    end
+
+    protected
+
+    def default_preview_host
+      return nil if Maglev.config.preview_host.blank?
+
+      URI.parse(Maglev.config.preview_host).host # make sure we get only the host here
+    end
+  end
+end

data/lib/maglev/theme_filesystem_loader.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Maglev
+  class ThemeFilesystemLoader
+    attr_reader :fetch_section_screenshot_path
+
+    def initialize(fetch_section_screenshot_path)
+      @fetch_section_screenshot_path = fetch_section_screenshot_path
+    end
+
+    def call(path)
+      theme = add(YAML.safe_load(File.read(path.join('theme.yml'))))
+      sections = load_sections(theme, Pathname.new(path).join('sections/**/*.yml'))
+      theme.sections = Maglev::Section::Store.new(sections)
+      theme
+    rescue Errno::ENOENT
+      Kernel.puts "Missing theme file(s) in #{path}"
+    end
+
+    private
+
+    def add(hash)
+      attributes = hash.merge(
+        section_categories: Maglev::Theme::SectionCategory.build_many(hash['section_categories']),
+        style_settings: Maglev::Theme::StyleSetting.build_many(hash['style_settings']),
+        sections: []
+      )
+
+      Maglev::Theme.new(HashWithIndifferentAccess.new(attributes)).tap do |theme|
+        Rails.logger.info("[Maglev] adding theme: #{theme.name} (##{theme.id})")
+      end
+    end
+
+    def load_sections(theme, source_path)
+      Dir.glob(source_path).map do |path|
+        section_id = File.basename(path, '.yml')
+        attributes = YAML.safe_load(File.read(path)).with_indifferent_access
+        build_section(theme, section_id, attributes)
+      end
+    end
+
+    def build_section(theme, section_id, attributes)
+      section = Maglev::Section.build(
+        attributes.merge(id: section_id, theme: theme)
+      )
+      section.screenshot_timestamp = find_section_screenshot_timestamp(theme, section)
+      section
+    end
+
+    def find_section_screenshot_timestamp(theme, section)
+      path = fetch_section_screenshot_path.call(theme: theme, section: section, absolute: true)
+      File.exist?(path) ? File.mtime(path).to_i : nil
+    end
+  end
+end

data/lib/maglev/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Maglev
+  VERSION = '1.0.0.rc1'
+end