RubyGems - maglevcms - Versions diffs - 1.0.0.rc1 - Mend

maglevcms 1.0.0.rc1

Files changed (695) hide show

data/app/views/maglev/api/themes/_show.json.jbuilder ADDED Viewed

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+json.key_format! camelize: :lower
+json.deep_format_keys!
+json.call(theme, :id, :name, :description)
+json.sections theme.sections do |section|
+  json.call(section, :id, :name, :category, :site_scoped, :singleton, :viewport_fixed_position,
+            :insert_button, :insert_at, :max_width_pane,
+            :blocks_label, :blocks_presentation, :sample)
+  json.settings section.settings.as_json
+  json.blocks section.blocks.as_json
+  json.theme_id theme.id
+  json.screenshot_path services.fetch_section_screenshot_url.call(section: section)
+end
+json.section_categories theme.section_categories.as_json
+json.icons theme.icons || []
+json.style_settings theme.style_settings.as_json

data/app/views/maglev/editor/_header.html.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <!-- custom EDITOR headers -->

data/app/views/maglev/editor/show.html.erb ADDED Viewed

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html class="h-full" lang="<%= editor_ui_locale %>">
+<head>
+  <title><%= editor_window_title %></title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <script>
+    window.locale = <%= h content_locale.to_json.html_safe %>;
+    window.baseUrl = <%= h site_base_editor_path.to_json.html_safe %>;
+    window.leaveUrl = <%= site_leave_editor_path.to_json.html_safe %>;
+    window.apiBaseUrl = <%= h api_base_path.to_json.html_safe %>;
+    window.site = <%= h render(partial: 'maglev/api/sites/show', formats: :json, locals: { site: maglev_site, home_page_id: maglev_home_page_id }).html_safe %>;
+    window.theme = <%= h render(partial: 'maglev/api/themes/show', formats: :json, locals: { theme: maglev_theme }).html_safe %>;
+    window.logoUrl = <%= editor_logo_url.to_json.html_safe %>;
+    window.primaryColor = <%= editor_primary_hex_color.to_json.html_safe %>;
+    window.sitePublishable = <%= editor_site_publishable.to_json %>;
+    window.customTranslations = <%= h editor_custom_translations.to_json.html_safe %>
+  </script>
+  <%= javascript_pack_tag 'editor' %>
+  <%= stylesheet_pack_tag 'editor' %>
+  <%= favicon_link_tag editor_favicon_url %>
+  <style>
+    :root {
+      --editor-color-primary: <%= editor_primary_hex_color %>;
+      --editor-color-primary-non-hex: <%= editor_primary_rgb_color.join(', ') %>;
+    }
+  </style>
+  <%= render 'header' %>
+</head>
+<body class="h-full overflow-y-hidden font-nunito">
+  <div id="maglev-app"></div>
+</body>
+</html>

data/config/initializers/assets.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'webpacker'
+require 'webpacker/helper'
+module Webpacker
+  module DynamicTag
+    def javascript_pack_tag(*names, **options)
+      return super unless options[:webpacker]
+      new_helper = dup
+      new_helper.define_singleton_method(:current_webpacker_instance) do
+        if options[:webpacker] == :root
+          ::Webpacker.instance
+        else
+          options[:webpacker].constantize.webpacker
+        end
+      end
+      new_helper.javascript_pack_tag(*names, **options.except(:webpacker))
+    end
+  end
+end
+Webpacker::Helper.prepend Webpacker::DynamicTag

data/config/initializers/filter_parameters_logging.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# Be sure to restart your server when you modify this file.
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += %i[base64_image]

data/config/initializers/kaminari.rb ADDED Viewed

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'kaminari'
+Kaminari.configure do |config|
+  config.default_per_page = 25
+  config.max_per_page = 25
+  # config.window = 4
+  # config.outer_window = 0
+  # config.left = 0
+  # config.right = 0
+  # config.page_method_name = :page
+  # config.param_name = :page
+  # config.max_pages = nil
+  # config.params_on_first_page = false
+end

data/config/locales/activerecord.en.yml ADDED Viewed

@@ -0,0 +1,7 @@
+en:
+  activerecord:
+    attributes:
+      'maglev/page':
+        cloned_title: "%{title} COPY"
+      'maglev/page/paths':
+        value: Path

data/config/locales/activerecord.fr.yml ADDED Viewed

@@ -0,0 +1,26 @@
+fr:
+  activerecord:
+    models:
+      'maglev/page': Page
+    attributes:
+      'maglev/page':
+        title: Titre
+        cloned_title: "%{title} COPIE"
+        seo_title: Titre SEO
+        meta_description: Meta description
+        og_title: "og:title"
+        og_description: "og:description"
+        og_image_url: "og:image"
+      'maglev/page/paths':
+        value: Chemin
+    errors:
+      models:
+        maglev/page:
+          attributes:
+            title:
+              blank: doît être rempli
+            path:
+              taken: est déjà utilisé par une autre page
+              exclusion: est déjà utilisé par une autre page

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+# rubocop:disable Metrics/BlockLength
+Maglev::Engine.routes.draw do
+  # API
+  constraints format: :json do
+    namespace 'api' do
+      resource :site, only: :show
+      resources :pages do
+        resources :clones, controller: :page_clones, only: :create
+      end
+      resources :assets
+      resource :publication, only: %i[show create]
+      scope 'collections/:collection_id' do
+        get '/', to: 'collection_items#index', as: :collection_items
+      end
+    end
+  end
+  root to: redirect { Maglev::Engine.routes.url_helpers.admin_root_path }
+  # Admin
+  namespace :admin do
+    root to: 'dashboard#index'
+    resource :theme, only: %i[index show]
+    namespace :sections, path: 'sections/:id' do
+      get :preview, to: 'previews#show'
+      get :preview_in_frame, to: 'previews#iframe_show'
+      resources :screenshots, only: [:create]
+    end
+  end
+  # Editor + Preview
+  get 'editor', to: 'editor#show', as: :base_editor
+  get 'editor/:locale/(*something)', to: 'editor#show', as: :editor
+  get 'leave_editor', to: 'editor#destroy', as: :leave_editor
+  get 'preview/(*path)', to: 'page_preview#index',
+                         defaults: { path: 'index', rendering_mode: :editor },
+                         constraints: Maglev::PreviewConstraint.new,
+                         as: :site_preview
+  post 'preview/(*path)', to: 'page_preview#create', defaults: { path: 'index', rendering_mode: :editor }
+  # Public Assets
+  get 'assets/:id(/:filename)', to: 'assets#show', as: :public_asset
+end
+# rubocop:enable Metrics/BlockLength

data/config/webpack/development.js ADDED Viewed

@@ -0,0 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+const environment = require('./environment')
+module.exports = environment.toWebpackConfig()

data/config/webpack/environment.js ADDED Viewed

@@ -0,0 +1,38 @@
+const path = require('path')
+const { environment } = require('@rails/webpacker')
+// VueJS
+const { VueLoaderPlugin } = require('vue-loader')
+const vue = require('./loaders/vue')
+environment.plugins.prepend('VueLoaderPlugin', new VueLoaderPlugin())
+environment.loaders.prepend('vue', vue)
+// OptionalChaining
+const babelLoader = environment.loaders.get('babel')
+babelLoader.use[0].options.plugins = ['@babel/plugin-proposal-optional-chaining', '@babel/plugin-proposal-class-properties'];
+const customConfig = {
+  resolve: {
+    alias: {
+      '@': path.resolve(__dirname, '..', '..', 'app/javascript/editor')
+    }
+  },
+  module: {
+    rules: [
+      {
+        test: /\.svg$/,
+        use: ['vue-loader', 'vue-svg-loader'],
+      },
+      {
+        enforce: 'pre',
+        test: /\.(js|vue)$/,
+        loader: 'eslint-loader',
+        exclude: /node_modules/
+      }
+    ],
+  },
+}
+environment.config.merge(customConfig)
+module.exports = environment

data/config/webpack/loaders/optional_chaining.js ADDED Viewed

@@ -0,0 +1,10 @@
+module.exports = {
+  test: /\.vue(\.erb)?$/,
+  exclude: /node_modules/,
+  loader: 'babel-loader',
+  options: {
+    plugins: [
+      require('@babel/plugin-proposal-optional-chaining'),
+    ],
+  }
+}

data/config/webpack/loaders/vue.js ADDED Viewed

@@ -0,0 +1,6 @@
+module.exports = {
+  test: /\.vue(\.erb)?$/,
+  use: [{
+    loader: 'vue-loader'
+  }],
+}

data/config/webpack/production.js ADDED Viewed

@@ -0,0 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'production'
+const environment = require('./environment')
+module.exports = environment.toWebpackConfig()

data/config/webpack/test.js ADDED Viewed

@@ -0,0 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+const environment = require('./environment')
+module.exports = environment.toWebpackConfig()

data/config/webpacker.yml ADDED Viewed

@@ -0,0 +1,95 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+default: &default
+  source_path: app/javascript
+  source_entry_path: packs
+  public_root_path: public
+  public_output_path: maglev-packs
+  cache_path: tmp/cache/webpacker
+  check_yarn_integrity: false
+  webpack_compile_output: true
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  resolved_paths: []
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+  # Extract and emit a css file
+  extract_css: false
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .eot
+    - .otf
+    - .ttf
+    - .woff
+    - .woff2
+  extensions:
+    - .vue
+    - .mjs
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .gif
+    - .jpeg
+    - .jpg
+development:
+  <<: *default
+  compile: true
+  # Verifies that correct packages and versions are installed by inspecting package.json, yarn.lock, and node_modules
+  check_yarn_integrity: false # NOTE: bug in Rails?
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3036
+    public: localhost:3036
+    hmr: false
+    # Inline should be set to true if using HMR
+    inline: true
+    overlay: true
+    compress: true
+    disable_host_check: true
+    use_local_ip: false
+    quiet: false
+    pretty: false
+    headers:
+      'Access-Control-Allow-Origin': '*'
+    watch_options:
+      ignored: '**/node_modules/**'
+test:
+  <<: *default
+  compile: true
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+production:
+  <<: *default
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+  # Extract and emit a css file
+  extract_css: true
+  # Cache manifest.json for performance
+  cache_manifest: true

data/db/migrate/20200824085207_create_maglev_sites.rb ADDED Viewed

@@ -0,0 +1,8 @@
+class CreateMaglevSites < ActiveRecord::Migration[6.0]
+  def change
+    create_table :maglev_sites do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200824104648_create_maglev_pages.rb ADDED Viewed

@@ -0,0 +1,17 @@
+class CreateMaglevPages < ActiveRecord::Migration[6.0]
+  def change
+    create_table :maglev_pages do |t|
+      t.string :title
+      t.string :path
+      t.string :seo_title
+      t.string :meta_description
+      t.boolean :visible, default: true
+      t.timestamps
+    end
+    up_only do
+      add_index :maglev_pages, :path, unique: true
+    end
+  end
+end

data/db/migrate/20200831101942_create_maglev_section_content.rb ADDED Viewed

@@ -0,0 +1,11 @@
+class CreateMaglevSectionContent < ActiveRecord::Migration[6.0]
+  def change
+    change_table :maglev_sites do |t|
+      t.jsonb :sections, default: []
+    end
+    change_table :maglev_pages do |t|
+      t.jsonb :sections, default: []
+    end
+  end
+end

data/db/migrate/20201206172020_create_maglev_assets.rb ADDED Viewed

@@ -0,0 +1,13 @@
+class CreateMaglevAssets < ActiveRecord::Migration[6.0]
+  def change
+    create_table :maglev_assets do |t|
+      t.string :filename
+      t.string :content_type
+      t.integer :width
+      t.integer :height
+      t.integer :byte_size
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210819092740_switch_to_localized_page_fields.rb ADDED Viewed

@@ -0,0 +1,17 @@
+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: {}
+  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
+  end
+end

data/db/migrate/20210830085101_create_maglev_page_paths.rb ADDED Viewed

@@ -0,0 +1,13 @@
+class CreateMaglevPagePaths < ActiveRecord::Migration[6.1]
+  def change
+    create_table :maglev_page_paths do |t|
+      t.references :maglev_page
+      t.string :locale, null: false
+      t.string :value, null: false
+    end
+    add_index :maglev_page_paths, [:value, :locale], unique: true
+    remove_column :maglev_pages, :path, :string
+  end
+end

data/db/migrate/20210906102712_add_canonical_to_pages.rb ADDED Viewed

@@ -0,0 +1,6 @@
+class AddCanonicalToPages < ActiveRecord::Migration[6.1]
+  def change
+    add_column :maglev_page_paths, :canonical, :boolean, null: true, default: true
+    add_index :maglev_page_paths, %i[canonical maglev_page_id locale], unique: true, name: 'canonical_uniqueness'
+  end
+end

data/db/migrate/20211008064437_add_locales_to_sites.rb ADDED Viewed

@@ -0,0 +1,5 @@
+class AddLocalesToSites < ActiveRecord::Migration[6.1]
+  def change
+    add_column :maglev_sites, :locales, :jsonb, default: []
+  end
+end

data/db/migrate/20211013210954_translate_section_content.rb ADDED Viewed

@@ -0,0 +1,8 @@
+class TranslateSectionContent < ActiveRecord::Migration[6.1]
+  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: {}
+  end
+end

data/db/migrate/20211101205001_add_lock_version_to_maglev_pages.rb ADDED Viewed

@@ -0,0 +1,6 @@
+class AddLockVersionToMaglevPages < ActiveRecord::Migration[6.1]
+  def change
+    add_column :maglev_sites, :lock_version, :integer
+    add_column :maglev_pages, :lock_version, :integer
+  end
+end

data/db/migrate/20211116161121_better_page_path_canonical_indices.rb ADDED Viewed

@@ -0,0 +1,8 @@
+class BetterPagePathCanonicalIndices < ActiveRecord::Migration[6.1]
+  def change
+    remove_index :maglev_page_paths, [:value, :locale], unique: true
+    remove_index :maglev_page_paths, %i[canonical maglev_page_id locale], unique: true, name: 'canonical_uniqueness'
+    add_index :maglev_page_paths, %i[canonical locale value], name: 'canonical_speed'
+    add_index :maglev_page_paths, %i[canonical maglev_page_id locale value], unique: true, name: 'canonical_uniqueness'
+  end
+end

data/db/migrate/20211124101005_fix_page_path_indices.rb ADDED Viewed

@@ -0,0 +1,6 @@
+class FixPagePathIndices < ActiveRecord::Migration[6.1]
+  def change
+    remove_index :maglev_page_paths, %i[canonical maglev_page_id locale value], unique: true, name: 'canonical_uniqueness'
+    add_index :maglev_page_paths, %i[canonical maglev_page_id locale], name: 'scoped_canonical_speed'
+  end
+end

data/db/migrate/20211203224112_add_open_graph_tags_to_pages.rb ADDED Viewed

@@ -0,0 +1,9 @@
+class AddOpenGraphTagsToPages < ActiveRecord::Migration[6.1]
+  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: {}
+    end
+  end
+end

data/db/migrate/20220612092235_add_style_to_sites.rb ADDED Viewed

@@ -0,0 +1,7 @@
+class AddStyleToSites < ActiveRecord::Migration[6.1]
+  def change
+    change_table :maglev_sites do |t|
+      t.jsonb :style, default: []
+    end
+  end
+end

data/lib/generators/maglev/install_generator.rb ADDED Viewed

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Maglev
+  class InstallGenerator < Rails::Generators::Base
+    desc 'Install Maglev engine'
+    source_root File.expand_path('templates/install', __dir__)
+    hook_for :maglev_install
+    def compile_editor_assets
+      rake 'maglev:webpacker:compile'
+    end
+    def migrations
+      rake 'maglev:install:migrations'
+      rake 'db:migrate'
+    end
+    def create_initializer
+      directory 'config'
+      directory 'public'
+    end
+    def generate_blank_theme
+      generate 'maglev:theme'
+    end
+    def mount_engine
+      inject_into_file 'config/routes.rb', before: /^end/ do
+        <<-CODE
+  mount Maglev::Engine => '/maglev'
+  get '(*path)', to: 'maglev/page_preview#index', defaults: { path: 'index' }, constraints: Maglev::PreviewConstraint.new
+        CODE
+      end
+    end
+    def instructions
+      $stdout.puts <<~INFO
+        Done! 🎉
+        You can now tweak /config/initializers/maglev.rb.
+        You can also modify your theme (in /app/theme and /app/views/theme)
+        and generate new sections with rails g maglev:section.
+        👉 The next step is to create a site using `rails maglev:create_site`.
+        🚨 Don't forget to do it in production as well!
+      INFO
+    end
+  end
+end