cm_page_builder 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03250c93e4b1b662bfd45e5fefd3c35c7349ecd74f050e9d505db26a68bc10e3
+  data.tar.gz: f9a4ededcd0ee8570a9ce9a0ad43b152b621f6d3c3e7ee1dba00f644f860f894
+SHA512:
+  metadata.gz: 3a39c55b1277c85fb7126c2d87b8018a620c61193d8298ad6b90cff87be39fc2fabedb8baf1b46a98336fee01d87a17704a205dc75a88babcf2feeee47a467fb
+  data.tar.gz: 94cb326c6aa789b1272d30712b44767f8bb3e996c7a56fbddaead6ecd22b4a28e115bdc514b5ce959bbe5b6d3009d0530e716a82b04122569f59d38ba6d33d86

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Camilo Ernesto Forero Junco
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+[![Gem Version](https://badge.fury.io/rb/cm_page_builder-rails.svg)](https://badge.fury.io/rb/cm_page_builder-rails)
+
+# CmPageBuilder::Rails
+This gem's purpose is to allow easy integration between the Commutatus javascript library [cm-page-builder](https://github.com/commutatus/cm-page-builder) and any Rails application that requires storing and editing content through Rails-rendered webpages.
+
+## Requirements
+
+* Rails 6+
+* Webpacker must be enabled in the project
+* S3 as the image backend storage
+
+
+## Initial setup:
+
+* Add the following lines to the gemfile:
+  ```ruby
+  gem 'react-rails', '~> 2.6.0'
+  gem 'cm_page_builder-rails'
+  ```
+  And then execute:
+  ```bash
+  $ bundle
+  ```
+* Follow all react-rails installation instructions (https://github.com/reactjs/react-rails)
+*Important:* ensure that the `hello_world` example successfully works
+
+* Install the javascript packages with:
+  ```bash
+  yarn add cm-page-builder@1.3.0 -E
+  yarn add babel-runtime@^6.26.0
+  ```
+  (the emoji-mart package, a dependency of cm-page-builder, sometimes bugs out during the webpack build process without the babel-runtime)
+
+* Run `rails cm_page_builder_rails:install:migrations`
+
+* Run `rails generate cm_page_builder:rails:install` to install the JSX component. This assumes your webpack folder is inside `app/javascripts`
+
+* In `config/routes.rb`, mount the endpoint with the line `mount CmPageBuilder::Rails::Engine => "/cm_page_builder"`
+
+## Usage
+This package comes with a concern, `CmPageBuilder::Rails::HasCmContent` `include CmPageBuilder::Rails::HasCmContent`
+To activate this module, add `include CmPageBuilder::Rails::HasCmContent` on top of any model file that should have an associated page builder record.
+
+The page builder record will be accessible from the model as *page* (`@model.page`). The show path is accessible through the route `cm_page_builder_rails.page_path(@page)`, and the edit path through the route `cm_page_builder_rails.edit_page_path(@page)`
+
+To make the fragment read-only in the form, pass the value in `status` prop as `Read`. Example,
+```ruby
+  = react_component('cm_content_manager/Content', { input: 'content-editor', components: @page.components, assetBaseUrl: ActiveStorage::Blob.service.bucket.url, status: 'Read'})
+```
+
+By default, the value of the status prop is set to `Edit`.
+
+### Setting up CORS for aws
+Do this or the direct upload capabilities won't work
+https://keithpblog.org/post/active-storage-on-amazon-s3/
+
+### Building the gem
+`gem build cm_page_builder-rails.gemspec`
+`gem push cm_page_builder-rails-0.1.x.gem`
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CmPageBuilder::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/config/cm_page_builder_rails_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/cm_page_builder/rails .css

data/app/assets/stylesheets/cm_page_builder/rails/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/cm_page_builder/rails/page_components.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/cm_page_builder/rails/pages.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,80 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px;
+}
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+}
+
+a:visited {
+  color: #666;
+}
+
+a:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+th {
+  padding-bottom: 5px;
+}
+
+td {
+  padding: 0 5px 7px;
+}
+
+div.field,
+div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+label {
+  display: block;
+}

data/app/controllers/cm_page_builder/rails/application_controller.rb

@@ -0,0 +1,14 @@
+module CmPageBuilder
+  module Rails
+    class ApplicationController < ::ApplicationController
+      protect_from_forgery with: :exception
+      layout CmPageBuilder::Rails.layout_template
+      #helper ::Rails.application.routes.url_helpers
+      #helper CmPageBuilder::Rails::ApplicationHelper
+
+      def current_user
+        main_app.scope.request.env['warden'].user
+      end
+    end
+  end
+end

data/app/controllers/cm_page_builder/rails/pages_controller.rb

@@ -0,0 +1,65 @@
+require_dependency "cm_page_builder/rails/application_controller"
+
+module CmPageBuilder::Rails
+  class PagesController < ApplicationController
+    before_action :set_page, only: [:show, :edit, :update, :destroy]
+
+    # GET /pages
+    def index
+      @pages = Page.all
+    end
+
+    # GET /pages/1
+    def show
+    end
+
+    # GET /pages/new
+    def new
+      @page = Page.new
+    end
+
+    # GET /pages/1/edit
+    def edit
+    end
+
+    # POST /pages
+    def create
+      components = page_params.delete('components')
+      @page = Page.new(page_params)
+
+      if @page.save
+        @page.save_content(components)
+        redirect_to @page, notice: 'Page was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    # PATCH/PUT /pages/1
+    def update
+      components = page_params.delete(:components)
+      if @page.save_content(components)
+        redirect_to @page, notice: 'Page was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # DELETE /pages/1
+    def destroy
+      @page.destroy
+      redirect_to pages_url, notice: 'Page was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_page
+        @page = Page.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def page_params
+        params.require(:page).permit(:container_id, :container_type, :components)
+      end
+  end
+end

data/app/helpers/cm_page_builder/rails/application_helper.rb

@@ -0,0 +1,6 @@
+module CmPageBuilder
+  module Rails
+    module ApplicationHelper
+    end
+  end
+end

data/app/helpers/cm_page_builder/rails/page_components_helper.rb

@@ -0,0 +1,4 @@
+module CmPageBuilder::Rails
+  module PageComponentsHelper
+  end
+end

data/app/helpers/cm_page_builder/rails/pages_helper.rb

@@ -0,0 +1,4 @@
+module CmPageBuilder::Rails
+  module PagesHelper
+  end
+end

data/app/jobs/cm_page_builder/rails/application_job.rb

@@ -0,0 +1,6 @@
+module CmPageBuilder
+  module Rails
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/cm_page_builder/rails/application_mailer.rb

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

data/app/models/cm_page_builder/rails/application_record.rb

@@ -0,0 +1,7 @@
+module CmPageBuilder
+  module Rails
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/cm_page_builder/rails/page.rb

@@ -0,0 +1,76 @@
+module CmPageBuilder::Rails
+  class Page < ApplicationRecord
+    belongs_to :container, polymorphic: true
+    has_many :page_components, dependent: :destroy
+
+    accepts_nested_attributes_for :page_components, allow_destroy: true
+
+    def components(**args)
+      page_components.with_attached_component_attachment.select(:id, :uuid, :component_type, :position, :content).map do |component|
+        json_component = component.as_json.transform_keys! { |key| key.camelize(:lower) }
+        json_component["id"] = component[:uuid]
+        json_component["component_attachment"] = _get_attachment(component, args[:max_width])
+        json_component
+      end
+    end
+
+    def duplicate
+      dupl = self.dup
+      dupl.page_components = self.page_components.map do |pc|
+        pc.duplicate
+      end
+      dupl
+    end
+
+    def save_content(component_json)
+      components = JSON.parse component_json
+      deleted_components = page_components.where.not(
+        uuid: components.map { |component| component["id"] }
+      )
+      deleted_components.delete_all
+      components.each do |component|
+        _save_component(component)
+      end
+    end
+
+    private
+
+      def _get_attachment(component, max_width=nil)
+        attachment = component.component_attachment.attachment
+        return unless attachment
+
+        blob = attachment.blob
+        attachment_data = {
+          filename: attachment.filename.to_s,
+          filesize: blob.byte_size,
+          url: attachment.service_url
+        }
+        if blob.variable?
+          dimensions = blob.metadata
+          dimensions['orientation'] =
+            if dimensions['width'].nil? || dimensions['height'].nil?
+              'portrait'
+            elsif dimensions['width'] > dimensions['height']
+              'landscape'
+            else
+              'portrait'
+            end
+          attachment_data[:dimensions] = dimensions
+          attachment_data[:url] = attachment.variant(resize_to_limit: [max_width, nil]).processed.service_url if max_width
+        end
+        attachment_data
+      end
+
+      def _save_component(component)
+        page_component = page_components.find_or_initialize_by(uuid: component["id"])
+        signed_id = component.dig("component_attachment", "signed_id")
+        component_data = {
+          content: component["content"],
+          position: component["position"],
+          component_type: component["componentType"]
+        }
+        component_data[:component_attachment] = signed_id if signed_id
+        page_component.update!(component_data)
+      end
+  end
+end

data/app/models/cm_page_builder/rails/page_component.rb

@@ -0,0 +1,16 @@
+module CmPageBuilder::Rails
+  class PageComponent < ApplicationRecord
+    belongs_to :page
+
+    has_one_attached :component_attachment
+
+    default_scope { order(position: :asc) }
+
+    def duplicate
+      dupl = self.dup
+      dupl.component_attachment.attach(self.component_attachment.blob) if self.component_attachment.attachment
+      dupl
+    end
+
+  end
+end

data/app/models/concerns/cm_page_builder/rails/has_cm_content.rb

@@ -0,0 +1,20 @@
+module CmPageBuilder
+  module Rails
+    module HasCmContent
+      extend ActiveSupport::Concern
+
+      included do
+        has_one :page, as: :container, dependent: :destroy, class_name:"CmPageBuilder::Rails::Page"
+        has_many :page_components, through: :page
+
+        delegate :save_content, to: :page
+
+
+        after_find do
+          self.create_page! unless self.page
+        end
+      end
+
+    end
+  end
+end

data/app/views/cm_page_builder/rails/pages/_form.html.slim

@@ -0,0 +1,13 @@
+= form_for @page do |f|
+  - if @page.errors.any?
+    #error_explanation
+      h2 = "#{pluralize(@page.errors.count, "error")} prohibited this page from being saved:"
+      ul
+        - @page.errors.full_messages.each do |message|
+          li = message
+
+  .field
+    input type='hidden' id="content-editor" name="page[components]"
+    = react_component("cm_content_manager/Content", { input: "content-editor", components: @page.components, assetBaseUrl: ActiveStorage::Blob.service.bucket.url})
+
+  .actions = f.submit

data/app/views/cm_page_builder/rails/pages/edit.html.slim

@@ -0,0 +1,5 @@
+h1 Editing page
+
+== render 'form'
+
+=> link_to 'Show', @page

data/app/views/cm_page_builder/rails/pages/show.html.slim

@@ -0,0 +1,3 @@
+p#notice = notice
+
+=> link_to 'Edit', edit_page_path(@page)

data/app/views/layouts/cm_page_builder/rails/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Cm page builder rails</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "cm_page_builder/rails/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,8 @@
+
+
+CmPageBuilder::Rails::Engine.routes.draw do
+  # Only individual items can be shown and edited.
+  # The only way to access these is through their parent record in the main application, so no index
+  # Their lifecycle is also associated with their parent record's, so no create and destroy
+  resources :pages, only: [:show, :edit, :update]
+end

data/db/migrate/20190816103148_create_cm_page_builder_rails_pages.rb

@@ -0,0 +1,9 @@
+class CreateCmPageBuilderRailsPages < ActiveRecord::Migration[6.0]
+  def change
+    create_table :cm_page_builder_rails_pages do |t|
+      t.references :container, polymorphic: true, null: false, index: { name: 'container_composite_index' }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20190816105056_create_cm_page_builder_rails_page_components.rb

@@ -0,0 +1,13 @@
+
+class CreateCmPageBuilderRailsPageComponents < ActiveRecord::Migration[6.0]
+  def change
+    create_table :cm_page_builder_rails_page_components, id: :string do |t|
+      t.references :page, null: false
+      t.string :content
+      t.integer :position
+      t.string :component_type
+      t.timestamps
+    end
+    add_foreign_key :cm_page_builder_rails_page_components, :cm_page_builder_rails_pages, column: :page_id
+  end
+end

data/db/migrate/20190903110322_change_page_component_primary_key.rb

@@ -0,0 +1,11 @@
+class ChangePageComponentPrimaryKey < ActiveRecord::Migration[6.0]
+  def change
+    rename_column :cm_page_builder_rails_page_components, :id, :uuid
+    CmPageBuilder::Rails::PageComponent.connection.execute(
+      <<~SQL
+      ALTER TABLE cm_page_builder_rails_page_components DROP CONSTRAINT cm_page_builder_rails_page_components_pkey;
+      SQL
+    )
+    add_column :cm_page_builder_rails_page_components, :id, :primary_key
+  end
+end

data/lib/cm_page_builder/rails/application_helper.rb

@@ -0,0 +1,33 @@
+module CmPageBuilder
+  module Rails
+    module ApplicationHelper
+      
+
+      # def method_missing method, *args, &block
+      #   pp "==========="
+      #   if method.to_s.end_with?('_path') or method.to_s.end_with?('_url')
+      #     if main_app.respond_to?(method)
+      #       main_app.send(method, *args)
+      #     else
+      #       super
+      #     end
+      #   else
+      #     super
+      #   end
+      # end
+      #
+      # def respond_to?(method)
+      #   if method.to_s.end_with?('_path') or method.to_s.end_with?('_url')
+      #     if main_app.respond_to?(method)
+      #       true
+      #     else
+      #       super
+      #     end
+      #   else
+      #     super
+      #   end
+      # end
+
+    end
+  end
+end

data/lib/cm_page_builder/rails/engine.rb

@@ -0,0 +1,22 @@
+module CmPageBuilder
+  module Rails
+    class Engine < ::Rails::Engine
+      isolate_namespace CmPageBuilder::Rails
+
+      config.generators do |g|
+        g.template_engine :slim
+        g.test_framework :rspec
+      end
+      # This part of the code makes sure that the main application's helper
+      # methods can be accessed from the engine
+      # initializer 'cm_page_builder_rails.action_controller' do |app|
+      #   ActiveSupport.on_load :action_controller do
+      #     helper CmPageBuilder::Rails::ApplicationHelper
+      #   end
+      #   # ActiveSupport.on_load(:action_controller) do
+      #   #   helper ::Rails.application.routes.url_helpers
+      #   # end
+      # end
+    end
+  end
+end

data/lib/cm_page_builder/rails/version.rb

@@ -0,0 +1,5 @@
+module CmPageBuilder
+  module Rails
+    VERSION = '0.2.2'
+  end
+end

data/lib/cm_page_builder/rails.rb

@@ -0,0 +1,8 @@
+require "cm_page_builder/rails/engine"
+
+module CmPageBuilder
+  module Rails
+    mattr_accessor :layout_template
+    # Your code goes here...
+  end
+end

data/lib/generators/cm_page_builder/rails/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CmPageBuilder::Rails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy the jsx component"
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_jsx_component
+        template "app/javascripts/components/cm_content_manager/Content.jsx"
+      end
+    end
+  end
+end