maglevcms 1.0.0.rc1

data/app/services/maglev/get_page_sections.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Maglev
+  # Get the content of a page in a specific locale.
+  # The content comes from the sections of the page.
+  # Also replace the links by their real values based on the context (live editing or not).
+  class GetPageSections
+    include Injectable
+    include Maglev::GetPageSections::TransformTextConcern
+    include Maglev::GetPageSections::TransformLinkConcern
+    include Maglev::GetPageSections::TransformCollectionItemConcern
+
+    dependency :fetch_site
+    dependency :fetch_theme
+    dependency :fetch_collection_items
+    dependency :fetch_static_pages
+    dependency :get_page_fullpath
+
+    argument :page
+    argument :page_sections, default: nil
+    argument :locale, default: nil
+
+    def call
+      (page_sections || page.sections || []).map do |section|
+        transform_section(section.dup)
+      end
+    end
+
+    protected
+
+    def theme
+      fetch_theme.call
+    end
+
+    def site
+      fetch_site.call
+    end
+
+    def transform_section(section)
+      definition = theme.sections.find(section['type'])
+
+      raise "Unknown Maglev section type (#{section['type']})" unless definition
+
+      transform_if_site_scoped(section, definition)
+      transform_section_blocks(section['blocks'], definition)
+      transform_section_settings(section, definition)
+
+      section
+    end
+
+    # rubocop:disable Style/StringHashKeys
+    def transform_if_site_scoped(section, definition)
+      return unless definition.site_scoped?
+
+      site_section = site.find_section(section['type'])
+
+      return unless !page_sections && site_section
+
+      # keep the same section id all over the pages
+      section.merge!(
+        'id' => site_section['id'],
+        'settings' => site_section['settings'],
+        'blocks' => site_section['blocks']
+      )
+    end
+    # rubocop:enable Style/StringHashKeys
+
+    def transform_section_blocks(blocks, definition)
+      blocks.each do |block|
+        block_definition = definition.blocks.find { |bd| bd.type == block['type'] }
+
+        next unless block_definition
+
+        transform_section_settings(block, block_definition)
+      end
+    end
+
+    def transform_section_settings(section, definition)
+      definition.settings.each do |setting|
+        section_setting = find_section_setting(section, setting.id)
+        next unless section_setting
+
+        transform_content_setting(section_setting, setting)
+      end
+    end
+
+    def transform_content_setting(content, setting)
+      case setting.type
+      when 'link'
+        transform_link_content_setting(content, setting)
+      when 'text'
+        transform_text_content_setting(content, setting)
+      when 'collection_item'
+        transform_collection_item_content_setting(content, setting)
+      end
+    end
+
+    def find_section_setting(section, setting_id)
+      # NOTE: works for both sections and blocks
+      section['settings'].find { |setting| setting['id'] == setting_id }
+    end
+  end
+end

data/app/services/maglev/persist_page.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Maglev
+  class PersistPage
+    include Injectable
+
+    dependency :fetch_theme
+
+    argument :page
+    argument :page_attributes
+    argument :site
+    argument :site_attributes, default: nil
+    argument :theme, default: nil
+
+    def call
+      ActiveRecord::Base.transaction do
+        persist_page!
+        persist_site!
+        persist_style!
+        page
+      end
+    end
+
+    private
+
+    def persist_page!
+      page.attributes = page_attributes
+      page.prepare_sections
+      page.save!
+    end
+
+    def persist_site!
+      return unless can_persist_site?
+
+      site.attributes = site_attributes_with_consistent_sections
+      site.prepare_sections
+      site.save!
+    end
+
+    def persist_style!
+      return if site_attributes&.dig(:style).blank?
+
+      site.style = site_attributes[:style]
+      site.save!
+    end
+
+    def theme
+      @theme ||= fetch_theme.call
+    end
+
+    # unlike the pages, we don't want to erase
+    # the other global sections of a site if they're missing
+    # from the site_attributes
+    def site_attributes_with_consistent_sections
+      attributes = site_attributes.dup
+
+      site.sections&.each do |section|
+        next if site_section_types.include?(section['type'])
+
+        attributes[:sections].push(section)
+      end
+
+      attributes
+    end
+
+    def site_section_types
+      @site_section_types ||= site_attributes[:sections].map { |section| section[:type] }
+    end
+
+    def can_persist_site?
+      site_attributes.present? && site_attributes[:sections].present?
+    end
+  end
+end

data/app/services/maglev/persist_section_screenshot.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+module Maglev
+  # Used to create a screenshot of a section from the Maglev admin UI.
+  class PersistSectionScreenshot
+    include Injectable
+
+    dependency :fetch_theme
+    dependency :fetch_section_screenshot_path
+
+    argument :section_id
+    argument :base64_image
+
+    def call
+      return false if base64_image.blank?
+
+      image_data = Base64.decode64(
+        base64_image['data:image/png;base64,'.length..]
+      )
+
+      persist_file(image_data)
+
+      section.screenshot_timestamp = Time.now.to_i
+
+      true
+    end
+
+    private
+
+    def persist_file(image_data)
+      tmp_file = Tempfile.new(File.basename(screenshots_dir), binmode: true)
+      tmp_file.write(image_data)
+      tmp_file.close
+
+      # PNG -> JPG to lower the size of the image
+      ::ActiveStorage::Variation.new(format: 'jpg', saver: { quality: 90 }).transform(tmp_file) do |output|
+        FileUtils.mkdir_p(screenshots_dir)
+        File.open(screenshot_filepath, 'wb') do |f|
+          f.write(output.read)
+        end
+      end
+    end
+
+    def section
+      @section ||= fetch_theme.call.sections.find(section_id)
+    end
+
+    def screenshot_filepath
+      fetch_section_screenshot_path.call(section: section, absolute: true)
+    end
+
+    def screenshots_dir
+      File.dirname(screenshot_filepath)
+    end
+  end
+end

data/app/services/maglev/search_pages.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Maglev
+  # Search for a single page if the id param is passed to the call function
+  # or search for all the pages matching or not the q criteria (based on its presence).
+  # It also searches among the static pages
+  class SearchPages
+    include Injectable
+
+    dependency :fetch_site
+    dependency :fetch_static_pages
+
+    argument :id, default: nil
+    argument :q, default: nil
+    argument :content_locale
+    argument :default_locale
+
+    def call
+      id.nil? ? all_pages : single_page
+    end
+
+    protected
+
+    def single_page
+      find_static_pages.find { |page| page.id == id } ||
+        resources.by_id_or_path(id, content_locale).first ||
+        resources.by_id_or_path(id, default_locale).first
+    end
+
+    def all_pages
+      find_persisted_pages + find_static_pages
+    end
+
+    def find_persisted_pages
+      q ? resources.search(q, content_locale) : resources.all
+    end
+
+    def find_static_pages
+      Maglev::I18n.with_locale(content_locale) do
+        fetch_static_pages.call.find_all do |page|
+          match_static_page?(page)
+        end
+      end
+    end
+
+    def match_static_page?(page)
+      q.nil? || (
+        q.present? &&
+        (
+          page.title.downcase.include?(q.downcase) ||
+          page.path.include?(q.downcase)
+        )
+      )
+    end
+
+    def resources
+      ::Maglev::Page
+    end
+  end
+end

data/app/services/maglev/setup_pages.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Maglev
+  # Create the default pages of the theme.
+  # Called by the GenerateSite service.
+  class SetupPages
+    include Injectable
+
+    dependency :persist_page, class: Maglev::PersistPage
+
+    argument :site
+    argument :theme
+
+    def call
+      pages&.map do |page_attributes|
+        create_page(page_attributes)
+      end
+    end
+
+    private
+
+    def pages
+      theme&.pages
+    end
+
+    def create_page(page_attributes)
+      persist_page.call(
+        site: site,
+        site_attributes: site_attributes_from(page_attributes),
+        theme: theme,
+        page: Maglev::Page.new,
+        page_attributes: page_attributes
+      )
+    end
+
+    def site_attributes_from(page_attributes)
+      {
+        sections: (page_attributes[:sections] || []).find_all do |section|
+          definition = theme.sections.find(section['type'])
+          definition.site_scoped?
+        end
+      }
+    end
+  end
+end

data/app/validators/maglev/collection_validator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Maglev
+  class CollectionValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      prefix = attribute.to_s.singularize.humanize
+
+      value.each_with_index do |item, index|
+        next if item.valid?
+
+        record.errors.add(
+          "#{prefix} ##{index}",
+          "is invalid, reason(s): #{clean_item_errors(item)}"
+        )
+      end
+    end
+
+    private
+
+    def clean_item_errors(item)
+      item.errors.full_messages.join(', ')
+    end
+  end
+end

data/app/validators/maglev/presence_validator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Maglev
+  class PresenceValidator < ActiveModel::Validations::PresenceValidator
+    def validate_each(record, attribute, value)
+      value = 'false' if value == false # trick the validator
+      super
+    end
+
+    private
+
+    def clean_item_errors(item)
+      item.errors.full_messages.join(', ')
+    end
+  end
+end

data/app/views/layouts/maglev/admin/_header_actions.html.erb

@@ -0,0 +1,5 @@
+<div class="ml-auto">
+  <%= link_to base_editor_path, class: 'text-white px-3 py-2 bg-purple-400 rounded hover:bg-purple-500 transition-colors' do %>
+    <span>Open editor</span>
+  <% end %>
+</div>

data/app/views/layouts/maglev/admin/application.html.erb

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Maglev - Admin</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= javascript_pack_tag 'application' %>
+  <%= stylesheet_pack_tag 'application' %>
+
+  <%= favicon_link_tag 'maglev/favicon.png' %>
+</head>
+<body class="bg-gray-100">
+  <main role="main" class="container mx-auto">
+    <div class="flex items-center py-3 px-8 my-3 text-white text-opacity-50 bg-purple-600 rounded shadow-sm">    
+      <div class="lh-100">
+        <h6 class="mb-0 text-white lh-100"><%= link_to 'Maglev', admin_root_path %></h6>
+        <small>Administration interface</small>
+      </div>
+      <%= render 'layouts/maglev/admin/header_actions' %>
+    </div>
+    <%= yield %> 
+  </main>
+</body>
+</html>

data/app/views/maglev/admin/sections/previews/show.html.erb

@@ -0,0 +1,32 @@
+<div 
+  class="w-full h-full mt-8" 
+  data-controller="screenshot"
+  data-screenshot-url-value="<%= create_section_screenshot_path(@section) %>"
+>
+  <div class="my-4 flex items-center justify-between">
+    <%= link_to theme_path, class: 'text-gray-600' do %>
+      <span>&#8592; Back to the theme</span>
+    <% end %>
+    <div class="flex">
+      <%= link_to section_iframe_preview_in_iframe_path(@section), class: 'bg-purple-600 hover:bg-purple-700 focus:outline-none focus:ring-2 focus:ring-purple-600 focus:ring-opacity-50 rounded text-white py-2 px-3 mr-6', target: '_blank' do %>
+        Open in a new tab
+      <% end %>
+      <button 
+        class="bg-purple-600 hover:bg-purple-700 focus:outline-none focus:ring-2 focus:ring-purple-600 focus:ring-opacity-50 rounded text-white py-2 px-3"
+        data-action="click->screenshot#take"      
+      >
+        Take screenshot
+      </button>
+    </div>
+  </div>
+  <iframe     
+    src="<%= section_iframe_preview_in_iframe_path(@section) %>"
+    class="w-full h-full bg-white"  
+    data-screenshot-target="source"
+    data-controller="iframe"
+  >
+  </iframe>
+  <div class="mt-4">
+    <img data-screenshot-target="output" class="" />
+  </div>
+</div>

data/app/views/maglev/admin/themes/_empty.html.erb

@@ -0,0 +1,20 @@
+<div class="rounded-md bg-yellow-100 p-4">
+  <div class="flex">
+    <div class="flex-shrink-0">
+      <!-- Heroicon name: solid/exclamation -->
+      <svg class="h-5 w-5 text-yellow-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true">
+        <path fill-rule="evenodd" d="M8.257 3.099c.765-1.36 2.722-1.36 3.486 0l5.58 9.92c.75 1.334-.213 2.98-1.742 2.98H4.42c-1.53 0-2.493-1.646-1.743-2.98l5.58-9.92zM11 13a1 1 0 11-2 0 1 1 0 012 0zm-1-8a1 1 0 00-1 1v3a1 1 0 002 0V6a1 1 0 00-1-1z" clip-rule="evenodd" />
+      </svg>
+    </div>
+    <div class="ml-3">
+      <h3 class="text-sm font-medium text-yellow-800">
+        No sections
+      </h3>
+      <div class="mt-2 text-sm text-yellow-700">
+        <p>
+          Use the Maglev section generator to create your first sections. Please visit our documentation <%= link_to 'here', 'https://docs.maglev.dev/guides/create-a-new-section', class: 'underline', target: '_blank' %>.
+        </p>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/maglev/admin/themes/_section_categories.html.erb

@@ -0,0 +1,9 @@
+<% theme.section_categories.each_with_index do |category, index| %>
+  <%- selected = section_category_id == category.id %>
+  <%= link_to section_category_path(category), class: ['rounded-full text-sm px-4 py-1 mr-3 flex items-center transition-colors whitespace-nowrap', selected ? 'bg-purple-600 bg-opacity-25 text-purple-600' : 'bg-gray-300 text-gray-800 hover:bg-gray-400 hover:text-gray-900'].compact.join(' ') do %> 
+    <span><%= category.name.humanize %></span>
+    <%= tag.span class: ['ml-2 font-bold text-xs text-white rounded-full w-4 h-4 flex items-center justify-center', selected ? 'bg-purple-600' : 'bg-gray-600'].compact.join(' ') do %>
+      <%= theme.sections.grouped_by_category[category.id]&.count || 0 %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/maglev/admin/themes/_sections.html.erb

@@ -0,0 +1,54 @@
+<% if !sections || sections.empty? %>
+  <%= render 'empty' %>
+<% else %>
+  <div class="grid grid-cols-1 md:grid-cols-2 gap-6 md:gap-6">
+    <% sections.each_with_index do |section, index| %>
+      <div class="p-3 bg-white rounded shadow-sm">
+        <div class="pb-3 mb-0 small">
+          <div class="flex items-center border-b border-gray-200 pb-4">
+            <% if params[:category_id].blank? %>
+              <span class="bg-gray-500 rounded-full text-white text-xs px-2 py-1 mr-3">
+                <%= section.category %>
+              </span>
+            <% end %>
+            <strong class="block text-gray-800 hover:underline">
+              <%= link_to section.name, section_preview_path(section) %>
+            </strong>
+            <div class="ml-auto">
+              <% if section.valid? %>
+                <span class="bg-green-500 rounded-full text-white text-sm px-2 py-1">Valid 👍</span>
+              <% else %>
+                <span class="bg-red-500 rounded-full text-white text-sm px-2 py-1">Invalid 😞</span> 
+              <% end %>
+            </div>
+          </div>
+
+          <% unless section.valid? %>
+            <div class="border-b border-gray-200 py-4">
+              <pre class="bg-gray-800 py-3 px-4 overflow-auto"><code class="text-white text-sm"><%= section.errors.full_messages %></code></pre>
+            </div>
+          <% end %>
+
+          <p class="px-5 text-sm border-b border-gray-200 py-4">
+            <span class="text-black font-bold">YAML Definition:</span> <%= section_file_path(section) %>
+            <br/>
+            <span class="text-black font-bold">Template:</span> <%= section_template_path(section) %>
+          </p>
+
+          <div class="mt-3">
+            <% if screenshot_path = section_screenshot_path(section) %>
+              <div class="w-full">
+                <img src="<%= screenshot_path %>" class="w-full border" />
+              </div>
+            <% else %>
+              <div class="w-full h-32">
+                <div class="w-full bg-gray-200 h-full">
+                </div>
+              </div>
+            <% end %>          
+          </div>
+        </div>
+      </div>
+    <% end %>
+  </div>
+<% end %>

data/app/views/maglev/admin/themes/show.html.erb

@@ -0,0 +1,21 @@
+<div class="flex items-center mt-8">
+  <h2>
+    <strong><%= @theme.name %></strong>
+    &dash;
+    <small class="text-muted"><%= @theme.description %></small>  
+  </h2>  
+</div>
+
+<% if @theme.sections.count == 0 %>
+  <div class="my-4">
+    <%= render 'empty' %>
+  </div>
+<% else %>
+  <div class="my-4 flex overflow-y-auto">
+    <%= render 'section_categories', theme: @theme %>
+  </div>
+
+  <div class="mb-10">
+    <%= render 'sections', sections: @theme.sections.grouped_by_category[section_category_id] || [] %>
+  </div>
+<% end %>

data/app/views/maglev/api/_pagination.json.jbuilder

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+json.next url_for(page: records.next_page) unless records.last_page?
+json.prev url_for(page: records.prev_page) unless records.first_page?
+json.total_pages records.total_pages
+json.total_items records.total_count

data/app/views/maglev/api/assets/_show.json.jbuilder

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+json.id asset.id
+json.filename asset.filename
+json.byte_size asset.byte_size
+json.width asset.width
+json.height asset.height
+json.url public_asset_url(asset, host: maglev_config.asset_host, only_path: maglev_config.asset_host.blank?)

data/app/views/maglev/api/assets/index.json.jbuilder

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+json.data do
+  json.array! @assets do |asset|
+    json.partial!('show', asset: asset)
+  end
+end
+
+json.partial!('pagination', records: @assets)

data/app/views/maglev/api/assets/show.json.jbuilder

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+json.partial!('show', asset: @asset)

data/app/views/maglev/api/collection_items/_show.json.jbuilder

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+json.id item.id
+json.label item.label
+json.image_url item.image_url

data/app/views/maglev/api/collection_items/index.json.jbuilder

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+json.array! @items do |item|
+  json.partial!('show', item: item)
+end

data/app/views/maglev/api/pages/index.json.jbuilder

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+json.array! @pages do |page|
+  json.id    page.id
+  json.title page.title || page.default_title
+  json.path  page.path || page.default_path
+  json.visible page.visible
+  json.static page.static?
+
+  json.seo_title page.seo_title
+  json.meta_description page.meta_description
+  json.og_title page.og_title
+  json.og_description page.og_description
+  json.og_image_url page.og_image_url
+
+  json.preview_url services.get_page_fullpath.call(page: page, preview_mode: true, locale: content_locale)
+  json.section_names services.get_page_section_names.call(page: page)
+end

data/app/views/maglev/api/pages/show.json.jbuilder

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+json.sections services.get_page_sections.call(page: @page)
+
+json.key_format! camelize: :lower
+json.deep_format_keys!
+
+json.id    @page.id
+json.title @page.title || @page.default_title
+json.path  @page.path || @page.default_path
+json.path_hash @page.path_hash
+json.visible @page.visible
+
+json.seo_title @page.seo_title
+json.meta_description @page.meta_description
+json.og_title @page.og_title
+json.og_description @page.og_description
+json.og_image_url @page.og_image_url
+
+json.preview_url services.get_page_fullpath.call(page: @page, preview_mode: true, locale: content_locale)
+json.live_url services.get_page_fullpath.call(page: @page, preview_mode: false, locale: content_locale)
+json.section_names services.get_page_section_names.call(page: @page)
+json.lock_version @page.lock_version
+json.translated @page.path.present?

data/app/views/maglev/api/sites/_show.json.jbuilder

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+json.key_format! camelize: :lower
+json.deep_format_keys!
+
+json.sections site.sections || []
+
+json.style services.fetch_style.call(site: site, theme: maglev_theme).as_json
+
+json.locales site.locales
+
+json.call(site, *site.api_attributes)
+json.home_page_id home_page_id
+
+json.lock_version site.lock_version

data/app/views/maglev/api/sites/show.json.jbuilder

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+json.partial!('show', site: @site, home_page_id: @home_page_id)