RubyGems - block_editor - Versions diffs - 0.1.0 - Mend

block_editor 0.1.0

Files changed (59) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +147 -0
data/Rakefile +18 -0
data/app/assets/config/block_editor_manifest.js +1 -0
data/app/assets/stylesheets/block_editor/backend.scss +4 -0
data/app/assets/stylesheets/block_editor/backend/blocks.scss +0 -0
data/app/assets/stylesheets/block_editor/frontend.scss +1 -0
data/app/assets/stylesheets/block_editor/frontend/blocks.scss +0 -0
data/app/controllers/block_editor/application_controller.rb +4 -0
data/app/helpers/block_editor/application_helper.rb +11 -0
data/app/javascript/block_editor/blocks/button/edit.js +240 -0
data/app/javascript/block_editor/blocks/column/edit.js +93 -0
data/app/javascript/block_editor/blocks/image/edit.js +656 -0
data/app/javascript/block_editor/blocks/index.js +263 -0
data/app/javascript/block_editor/components/block-editor/index.js +88 -0
data/app/javascript/block_editor/components/block-editor/styles.scss +39 -0
data/app/javascript/block_editor/components/header/index.js +45 -0
data/app/javascript/block_editor/components/header/redo.js +36 -0
data/app/javascript/block_editor/components/header/styles.scss +14 -0
data/app/javascript/block_editor/components/header/undo.js +36 -0
data/app/javascript/block_editor/components/media-upload/index.js +37 -0
data/app/javascript/block_editor/components/notices/index.js +26 -0
data/app/javascript/block_editor/components/notices/styles.scss +9 -0
data/app/javascript/block_editor/components/sidebar/index.js +31 -0
data/app/javascript/block_editor/components/sidebar/styles.scss +43 -0
data/app/javascript/block_editor/stores/action-types.js +4 -0
data/app/javascript/block_editor/stores/actions.js +41 -0
data/app/javascript/block_editor/stores/controls.js +21 -0
data/app/javascript/block_editor/stores/index.js +30 -0
data/app/javascript/block_editor/stores/reducer.js +20 -0
data/app/javascript/block_editor/stores/resolvers.js +10 -0
data/app/javascript/block_editor/stores/selectors.js +13 -0
data/app/javascript/controllers/block_editor_controller.jsx +42 -0
data/app/javascript/controllers/index.js +6 -0
data/app/javascript/packs/block_editor/application.js +2 -0
data/app/javascript/packs/block_editor/application.scss +108 -0
data/app/jobs/block_editor/application_job.rb +4 -0
data/app/mailers/block_editor/application_mailer.rb +6 -0
data/app/models/block_editor/application_record.rb +5 -0
data/app/models/block_editor/block_list.rb +7 -0
data/app/models/concerns/block_editor/listable.rb +24 -0
data/app/views/layouts/block_editor/application.html.erb +15 -0
data/config/initializers/webpacker_extension.rb +12 -0
data/config/routes.rb +2 -0
data/config/webpack/development.js +5 -0
data/config/webpack/environment.js +3 -0
data/config/webpack/production.js +5 -0
data/config/webpack/test.js +5 -0
data/config/webpacker.yml +92 -0
data/db/migrate/20210312032114_create_block_lists.rb +11 -0
data/lib/block_editor.rb +26 -0
data/lib/block_editor/block_list_renderer.rb +43 -0
data/lib/block_editor/blocks/base.rb +32 -0
data/lib/block_editor/engine.rb +34 -0
data/lib/block_editor/instance.rb +19 -0
data/lib/block_editor/version.rb +3 -0
data/lib/tasks/block_editor_tasks.rake +59 -0
metadata +131 -0

data/app/jobs/block_editor/application_job.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module BlockEditor
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/block_editor/application_mailer.rb ADDED Viewed

@@ -0,0 +1,6 @@
+module BlockEditor
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/block_editor/application_record.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module BlockEditor
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/block_editor/block_list.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module BlockEditor
+  # Represents a block list
+  class BlockList < ApplicationRecord
+    # Associations
+    belongs_to :listable, polymorphic: true, touch: true
+  end
+end

data/app/models/concerns/block_editor/listable.rb ADDED Viewed

@@ -0,0 +1,24 @@
+module BlockEditor
+  module Listable
+    extend ActiveSupport::Concern
+    included do
+      has_many :block_lists, as: :listable, class_name: 'BlockEditor::BlockList'
+      has_one :active_block_list, -> { where active: true }, class_name: 'BlockEditor::BlockList', as: :listable
+      validates :active_block_list, presence: true
+      accepts_nested_attributes_for :active_block_list
+      after_initialize :set_block_list_defaults
+    end
+    private
+    def set_block_list_defaults
+      return if self.persisted?
+      self.active_block_list ||= self.build_active_block_list(listable: self)
+    end
+  end
+end

data/app/views/layouts/block_editor/application.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Block editor</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= stylesheet_link_tag    "block_editor/application", media: "all" %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/config/initializers/webpacker_extension.rb ADDED Viewed

@@ -0,0 +1,12 @@
+module Webpacker::DynamicTag
+  def javascript_pack_tag(*names, **options)
+    return super unless options[:webpacker]
+    new_helper = self.dup
+    new_helper.define_singleton_method(:current_webpacker_instance) do
+      options[:webpacker].constantize.webpacker
+    end
+    new_helper.javascript_pack_tag(*names, **options.except(:webpacker))
+  end
+end
+Webpacker::Helper.prepend Webpacker::DynamicTag

data/config/routes.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ BlockEditor::Engine.routes.draw do
2	+ end

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,3 @@
+const { environment } = require('@rails/webpacker')
+module.exports = environment

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,92 @@
+# 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: packs
+  cache_path: tmp/cache/webpacker
+  webpack_compile_output: true
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_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
+    - .svg
+    - .eot
+    - .otf
+    - .ttf
+    - .woff
+    - .woff2
+  extensions:
+    - .mjs
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .svg
+    - .gif
+    - .jpeg
+    - .jpg
+development:
+  <<: *default
+  compile: true
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    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/20210312032114_create_block_lists.rb ADDED Viewed

@@ -0,0 +1,11 @@
+class CreateBlockLists < ActiveRecord::Migration[6.1]
+  def change
+    create_table :block_editor_block_lists do |t|
+      t.string :name
+      t.text :content
+      t.boolean :active, default: false
+      t.references :listable, polymorphic: true
+      t.timestamps
+    end
+  end
+end

data/lib/block_editor.rb ADDED Viewed

@@ -0,0 +1,26 @@
+require "block_editor/version"
+require "block_editor/engine"
+require "block_editor/instance"
+require 'block_editor/blocks/base'
+require 'block_editor/block_list_renderer'
+module BlockEditor
+  ROOT_PATH = Pathname.new(File.join(__dir__, ".."))
+  class << self
+    def webpacker
+      @webpacker ||= ::Webpacker::Instance.new(
+        root_path: ROOT_PATH,
+        config_path: ROOT_PATH.join("config/webpacker.yml")
+      )
+    end
+  end
+  mattr_accessor :dynamic_blocks
+  @@dynamic_blocks = []
+  mattr_accessor :frontend_parent_controller
+  @@frontend_parent_controller = 'ApplicationController'
+end

data/lib/block_editor/block_list_renderer.rb ADDED Viewed

@@ -0,0 +1,43 @@
+module BlockEditor
+  # Handles the rendering of a block list including dynamic blocks and removing HTML comments
+  class BlockListRenderer
+    # Renders dynamic blocks within the HTML snippet then strips all HTML comments (including Gutenberg markup)
+    #
+    # @param raw_html [String]
+    #
+    # @return [String] Parsed content
+    def self.render(raw_html)
+      html = Nokogiri::HTML(raw_html)
+      # # Find & render all instances of a dynamic block
+      BlockEditor.dynamic_blocks.each do |dynamic_block|
+        html.xpath('//comment()').select {|comment| comment.inner_text.starts_with?(" wp:#{dynamic_block.name}") }.each do |block_instance|
+          block_attributes = block_instance.inner_text.split(" wp:#{dynamic_block.name}")[1][0...-1]
+          block_attributes = block_attributes.blank? ? {} : JSON.parse(block_attributes)
+          block_instance.replace(render_block(dynamic_block, block_attributes))
+        end
+      end
+      html.xpath('//comment()').remove
+      html.css('body').inner_html.html_safe
+    end
+    # Renders a specific block using the provided options
+    #
+    # @param block [String] name of block
+    # @param options [Hash] block options to use when rendering
+    #
+    # @return [String] block content (HTML)
+    def self.render_block(block, options)
+      block.render(options)
+    rescue StandardError => e
+      respond_with_block_error(e)
+    end
+    # Handles block errors
+    def self.respond_with_block_error(error)
+      Rails.logger.error("Error rendering block - #{error.message}")
+      ''
+    end
+  end
+end

data/lib/block_editor/blocks/base.rb ADDED Viewed

@@ -0,0 +1,32 @@
+module BlockEditor
+  # Blocks used to render dynamic content
+  module Blocks
+    # Base for dynamic blocks
+    class Base
+      def self.name
+        raise NotImplementedError, 'Must specify block name'
+      end
+      # Render the block
+      def self.render(options = {})
+        options = options.reverse_merge(default_options.with_indifferent_access)
+        controller.render(
+          partial: "block_editor/blocks/#{name}/block",
+          locals: { collection: options },
+          layout: false
+        )
+      end
+      # Frontend controller used to render views
+      def self.controller
+        BlockEditor.frontend_parent_controller.constantize
+      end
+      # Default widget options
+      def self.default_options
+        {}
+      end
+    end
+  end
+end

data/lib/block_editor/engine.rb ADDED Viewed

@@ -0,0 +1,34 @@
+module BlockEditor
+  class Engine < ::Rails::Engine
+    isolate_namespace BlockEditor
+    initializer "webpacker.proxy" do |app|
+      insert_middleware = begin
+                            BlockEditor.webpacker.config.dev_server.present?
+                          rescue
+                            nil
+                          end
+      next unless insert_middleware
+      app.middleware.insert_before(
+        0, Webpacker::DevServerProxy,
+        ssl_verify_none: true,
+        webpacker: BlockEditor.webpacker
+      )
+    end
+    # Initializer to combine this engines static assets with the static assets of the host application
+    initializer 'static assets' do |app|
+      app.middleware.insert_before(::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public")
+    end
+    initializer 'block_editor.assets.precompile' do |app|
+      assets_for_precompile = [
+        'block_editor/frontend.css',
+        'block_editor/backend.css'
+      ]
+      app.config.assets.precompile.concat assets_for_precompile
+    end
+  end
+end

data/lib/block_editor/instance.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module BlockEditor
+  class Instance
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::FormTagHelper
+    attr_accessor :output_buffer
+    def self.render(form_builder)
+      self.new.render(form_builder)
+    end
+    def render(form_builder)
+      content_tag(:div, data: { controller: 'block-editor' }) do
+        form_builder.hidden_field(:content, data: { 'block-editor-target' => 'input' }) +
+          content_tag('div', nil, { class: 'block-editor', data: { 'block-editor-target' => 'output' } })
+      end
+    end
+  end
+end

data/lib/block_editor/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module BlockEditor
+  VERSION = '0.1.0'
+end

data/lib/tasks/block_editor_tasks.rake ADDED Viewed

@@ -0,0 +1,59 @@
+def ensure_log_goes_to_stdout
+  old_logger = Webpacker.logger
+  Webpacker.logger = ActiveSupport::Logger.new(STDOUT)
+  yield
+ensure
+  Webpacker.logger = old_logger
+end
+namespace :block_editor do
+  namespace :webpacker do
+    desc "Install deps with yarn"
+    task :yarn_install do
+      Dir.chdir(File.join(__dir__, "../..")) do
+        system "yarn install --no-progress --production"
+      end
+    end
+    desc "Compile JavaScript packs using webpack for production with digests"
+    task compile: [:yarn_install, :environment] do
+      Webpacker.with_node_env("production") do
+        ensure_log_goes_to_stdout do
+          if BlockEditor.webpacker.commands.compile
+            # Successful compilation!
+          else
+            # Failed compilation
+            exit!
+          end
+        end
+      end
+    end
+  end
+end
+def yarn_install_available?
+  rails_major = Rails::VERSION::MAJOR
+  rails_minor = Rails::VERSION::MINOR
+  rails_major > 5 || (rails_major == 5 && rails_minor >= 1)
+end
+def enhance_assets_precompile
+  # yarn:install was added in Rails 5.1
+  deps = yarn_install_available? ? [] : ["block_editor:webpacker:yarn_install"]
+  Rake::Task["assets:precompile"].enhance(deps) do
+    Rake::Task["block_editor:webpacker:compile"].invoke
+  end
+end
+# Compile packs after we've compiled all other assets during precompilation
+skip_webpacker_precompile = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+unless skip_webpacker_precompile
+  if Rake::Task.task_defined?("assets:precompile")
+    enhance_assets_precompile
+  else
+    Rake::Task.define_task("assets:precompile" => "block_editor:webpacker:compile")
+  end
+end