cm_page_builder-rails 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 459dbee8f8a6d0f44b65f66680fbd49d4e80cb7d98c5e1c51c880d498bee4b6e
-  data.tar.gz: 6575bb5cec83a974583f8a9e3f9647f083aadab5b44545920bdbe10129f0f8e6
+  metadata.gz: 1e528443d6f1df388159a706b5bcab30e2cf42c06af6628ed763d398a202c263
+  data.tar.gz: 81fc89511291e3320123adfd21971d2064a1891b176b78ea59fed00f07b3c62c
 SHA512:
-  metadata.gz: ac569b59270e994afffb4ba5f29369ed07548d34c6705e65b5f5cbe3407f9237f813d317d57c784d556d4960a33d13c469de35cbfc8de2276af5d282f75d39f3
-  data.tar.gz: 3a15e1030e9a41a8e81380dc9542026ed6ca614e6276379102b40a0175d9d845224651a656c4d124a15570b3df9267eea012531ffbf5944125b4d580627d3452
+  metadata.gz: f10ae957d38fa4ba023a078387cbf8dfdc796a16f810111a4eb17a5c3be71f3f6030beca16321f10b0cc2407eba9f2a24ddd76807b08bf2bc6b61266978ecba0
+  data.tar.gz: 3022134f1afda91c279f4e3c955ad486a6ab179f8ff62d3400948f857274b3078dd7eadef2a381b5ca519878643018528a16362063fdae5681317fa92dc9f2fc

data/README.md

@@ -7,6 +7,7 @@ This gem's purpose is to allow easy integration between the Commutatus javascrip
 
 * Rails 6+
 * Webpacker must be enabled in the project
+* S3 as the image backend storage
 
 
 ## Initial setup:
@@ -23,17 +24,24 @@ This gem's purpose is to allow easy integration between the Commutatus javascrip
 * Follow all react-rails installation instructions (https://github.com/reactjs/react-rails)
 *Important:* ensure that the `hello_world` example successfully works
 
-* Add the javascript package with `yarn add cm-page-builder@1.2.69`
+* 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`
 
-* In `config/routes.rb`, mount the endpoint with the line `mount CmPageBuilder::Rails::Engine => "/cm_page_builder"`
+* Run `rails generate cm_page_builder:rails:install` to install the JSX component. This assumes your webpack folder is inside `app/javascripts`
 
-* Initialize the layout
+* 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 rich text field.
+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)`
 
 ### Setting up CORS for aws
 Do this or the direct upload capabilities won't work

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

@@ -43,7 +43,7 @@ module CmPageBuilder::Rails
         attachment_data = {
           filename: attachment.filename.to_s,
           filesize: blob.byte_size,
-          url: Rails.application.routes.url_helpers.rails_blob_path(attachment, only_path: true)
+          url: attachment.service_url
         }
         if blob.variable?
           dimensions = blob.metadata

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

@@ -8,6 +8,6 @@
 
   .field
     input type='hidden' id="content-editor" name="page[components]"
-    = react_component("cm_content_manager/Content", {input: "content-editor", components: @page.components})
+    = react_component("cm_content_manager/Content", { input: "content-editor", components: @page.components, assetBaseUrl: ActiveStorage::Blob.service.bucket.url})
 
   .actions = f.submit

data/lib/cm_page_builder/rails/version.rb

@@ -1,5 +1,5 @@
 module CmPageBuilder
   module Rails
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   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

data/lib/generators/cm_page_builder/rails/templates/app/javascripts/components/cm_content_manager/Content.jsx

@@ -0,0 +1,41 @@
+import React from "react"
+import PropTypes from "prop-types"
+import PageBuilder from 'cm-page-builder'
+
+class Content extends React.Component {
+  constructor(props) {
+		super(props)
+  }
+
+
+  _updatePageComponent = (id, data, type, key) => {}
+
+
+  render () {
+    return (
+      <React.Fragment>
+        <PageBuilder
+           pageComponents={this.props.components}
+           handleUpdate={this._updatePageComponent}
+           updateComponentData={(data) =>
+             { $(`#${this.props.input}`).val(JSON.stringify(data))}
+           }
+           showTitle={false}
+           showEmoji={false}
+           showPageInfo={false}
+           useDirectStorageUpload={true}
+           assetBaseUrl={ this.props.assetBaseUrl }
+           meta={ {id: "debug"} }
+           status="Edit"
+          />
+      </React.Fragment>
+    );
+  }
+}
+
+Content.propTypes = {
+  input: PropTypes.string,
+  components: PropTypes.array,
+  assetBaseUrl: PropTypes.string
+};
+export default Content

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cm_page_builder-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Camilo Ernesto Forero Junco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,6 +104,8 @@ files:
 - lib/cm_page_builder/rails/application_helper.rb
 - lib/cm_page_builder/rails/engine.rb
 - lib/cm_page_builder/rails/version.rb
+- lib/generators/cm_page_builder/rails/install_generator.rb
+- lib/generators/cm_page_builder/rails/templates/app/javascripts/components/cm_content_manager/Content.jsx
 - lib/tasks/cm_page_builder/rails_tasks.rake
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/config/manifest.js