actiontext 6.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9eb946145656ee7d27e4ee9ce733a3e0f55e1b63ab16e4cea8741fecaac697f6
+  data.tar.gz: 658a5373916fd11abfdbd569746f1f4ed23fb71cc52294d513d063de47a148ab
+SHA512:
+  metadata.gz: 8418aebfa611943071b773ec51544e039f4f3e8220a594c4a66bfced904754da4f2ee1fc7d0472e7d6e0e207f4aad70f8828509fd0f6a95df5db1557e42f34cb
+  data.tar.gz: 427541191977534c0d36bf0b4cfb0615a5525e0ef645a939b31e066dac689ec0288bc7b6dca919523c8adae6ffee56888bc0d0cb232cd592c51bd8f06daee357

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Rails 6.0.0.beta1 (January 18, 2019) ##
+
+*   Added to Rails.
+
+    *DHH*

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Basecamp, LLC
+
+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,9 @@
+# Action Text
+
+Action Text brings rich text content and editing to Rails. It includes the [Trix editor](https://trix-editor.org) that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that's associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model.
+
+You can read more about Action Text in the [Action Text Overview](https://edgeguides.rubyonrails.org/action_text_overview.html) guide.
+
+## License
+
+Action Text is released under the [MIT License](https://opensource.org/licenses/MIT).

data/app/helpers/action_text/content_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ActionText
+  module ContentHelper
+    SANITIZER          = Rails::Html::Sanitizer.white_list_sanitizer
+    ALLOWED_TAGS       = SANITIZER.allowed_tags + [ ActionText::Attachment::TAG_NAME, "figure", "figcaption" ]
+    ALLOWED_ATTRIBUTES = SANITIZER.allowed_attributes + ActionText::Attachment::ATTRIBUTES
+
+    def render_action_text_content(content)
+      content = content.render_attachments do |attachment|
+        unless attachment.in?(content.gallery_attachments)
+          attachment.node.tap do |node|
+            node.inner_html = render(attachment, in_gallery: false).chomp
+          end
+        end
+      end
+
+      content = content.render_attachment_galleries do |attachment_gallery|
+        render(layout: attachment_gallery, object: attachment_gallery) do
+          attachment_gallery.attachments.map do |attachment|
+            attachment.node.inner_html = render(attachment, in_gallery: true).chomp
+            attachment.to_html
+          end.join("").html_safe
+        end.chomp
+      end
+
+      sanitize content.to_html, tags: ALLOWED_TAGS, attributes: ALLOWED_ATTRIBUTES
+    end
+  end
+end

data/app/helpers/action_text/tag_helper.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module ActionText
+  module TagHelper
+    cattr_accessor(:id, instance_accessor: false) { 0 }
+
+    # Returns a `trix-editor` tag that instantiates the Trix JavaScript editor as well as a hidden field
+    # that Trix will write to on changes, so the content will be sent on form submissions.
+    #
+    # ==== Options
+    # * <tt>:class</tt> - Defaults to "trix-content" which ensures default styling is applied.
+    #
+    # ==== Example
+    #
+    #   rich_text_area_tag "content", message.content
+    #   # <input type="hidden" name="content" id="trix_input_post_1">
+    #   # <trix-editor id="content" input="trix_input_post_1" class="trix-content" ...></trix-editor>
+    def rich_text_area_tag(name, value = nil, options = {})
+      options = options.symbolize_keys
+
+      options[:input] ||= "trix_input_#{ActionText::TagHelper.id += 1}"
+      options[:class] ||= "trix-content"
+
+      options[:data] ||= {}
+      options[:data][:direct_upload_url] = main_app.rails_direct_uploads_url
+      options[:data][:blob_url_template] = main_app.rails_service_blob_url(":signed_id", ":filename")
+
+      editor_tag = content_tag("trix-editor", "", options)
+      input_tag = hidden_field_tag(name, value, id: options[:input])
+
+      input_tag + editor_tag
+    end
+  end
+end
+
+module ActionView::Helpers
+  class Tags::ActionText < Tags::Base
+    delegate :dom_id, to: ActionView::RecordIdentifier
+
+    def render
+      options = @options.stringify_keys
+      add_default_name_and_id(options)
+      options["input"] ||= dom_id(object, [options["id"], :trix_input].compact.join("_")) if object
+      @template_object.rich_text_area_tag(options.delete("name"), editable_value, options)
+    end
+
+    def editable_value
+      value&.body.try(:to_trix_html)
+    end
+  end
+
+  module FormHelper
+    # Returns a `trix-editor` tag that instantiates the Trix JavaScript editor as well as a hidden field
+    # that Trix will write to on changes, so the content will be sent on form submissions.
+    #
+    # ==== Options
+    # * <tt>:class</tt> - Defaults to "trix-content" which ensures default styling is applied.
+    #
+    # ==== Example
+    #   form_with(model: @message) do |form|
+    #     form.rich_text_area :content
+    #   end
+    #   # <input type="hidden" name="message[content]" id="message_content_trix_input_message_1">
+    #   # <trix-editor id="content" input="message_content_trix_input_message_1" class="trix-content" ...></trix-editor>
+    def rich_text_area(object_name, method, options = {})
+      Tags::ActionText.new(object_name, method, self, options).render
+    end
+  end
+
+  class FormBuilder
+    def rich_text_area(method, options = {})
+      @template.rich_text_area(@object_name, method, objectify_options(options))
+    end
+  end
+end

data/app/javascript/actiontext/attachment_upload.js

@@ -0,0 +1,45 @@
+import { DirectUpload } from "@rails/activestorage"
+
+export class AttachmentUpload {
+  constructor(attachment, element) {
+    this.attachment = attachment
+    this.element = element
+    this.directUpload = new DirectUpload(attachment.file, this.directUploadUrl, this)
+  }
+
+  start() {
+    this.directUpload.create(this.directUploadDidComplete.bind(this))
+  }
+
+  directUploadWillStoreFileWithXHR(xhr) {
+    xhr.upload.addEventListener("progress", event => {
+      const progress = event.loaded / event.total * 100
+      this.attachment.setUploadProgress(progress)
+    })
+  }
+
+  directUploadDidComplete(error, attributes) {
+    if (error) {
+      throw new Error(`Direct upload failed: ${error}`)
+    }
+
+    this.attachment.setAttributes({
+      sgid: attributes.attachable_sgid,
+      url: this.createBlobUrl(attributes.signed_id, attributes.filename)
+    })
+  }
+
+  createBlobUrl(signedId, filename) {
+    return this.blobUrlTemplate
+      .replace(":signed_id", signedId)
+      .replace(":filename", encodeURIComponent(filename))
+  }
+
+  get directUploadUrl() {
+    return this.element.dataset.directUploadUrl
+  }
+
+  get blobUrlTemplate() {
+    return this.element.dataset.blobUrlTemplate
+  }
+}

data/app/javascript/actiontext/index.js

@@ -0,0 +1,10 @@
+import { AttachmentUpload } from "./attachment_upload"
+
+addEventListener("trix-attachment-add", event => {
+  const { attachment, target } = event
+
+  if (attachment.file) {
+    const upload = new AttachmentUpload(attachment, target)
+    upload.start()
+  }
+})

data/app/models/action_text/rich_text.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ActionText
+  # The RichText record holds the content produced by the Trix editor in a serialized `body` attribute.
+  # It also holds all the references to the embedded files, which are stored using Active Storage.
+  # This record is then associated with the Active Record model the application desires to have
+  # rich text content using the `has_rich_text` class method.
+  class RichText < ActiveRecord::Base
+    self.table_name = "action_text_rich_texts"
+
+    serialize :body, ActionText::Content
+    delegate :to_s, :nil?, to: :body
+
+    belongs_to :record, polymorphic: true, touch: true
+    has_many_attached :embeds
+
+    before_save do
+      self.embeds = body.attachments.map(&:attachable) if body.present?
+    end
+
+    def to_plain_text
+      body&.to_plain_text.to_s
+    end
+
+    delegate :blank?, :empty?, :present?, to: :to_plain_text
+  end
+end
+
+ActiveSupport.run_load_hooks :action_text_rich_text, ActionText::RichText

data/app/views/action_text/attachables/_missing_attachable.html.erb

@@ -0,0 +1 @@
+<%= "☒" -%>

data/app/views/action_text/attachables/_remote_image.html.erb

@@ -0,0 +1,8 @@
+<figure class="attachment attachment--preview">
+  <%= image_tag(remote_image.url, width: remote_image.width, height: remote_image.height) %>
+  <% if caption = remote_image.try(:caption) %>
+    <figcaption class="attachment__caption">
+      <%= caption %>
+    </figcaption>
+  <% end %>
+</figure>

data/app/views/action_text/attachment_galleries/_attachment_gallery.html.erb

@@ -0,0 +1,3 @@
+<div class="attachment-gallery attachment-gallery--<%= attachment_gallery.size %>">
+  <%= yield %>
+</div>

data/app/views/action_text/content/_layout.html.erb

@@ -0,0 +1,3 @@
+<div class="trix-content">
+  <%= render_action_text_content(content) %>
+</div>

data/app/views/active_storage/blobs/_blob.html.erb

@@ -0,0 +1,14 @@
+<figure class="attachment attachment--<%= blob.representable? ? "preview" : "file" %> attachment--<%= blob.filename.extension %>">
+  <% if blob.representable? %>
+    <%= image_tag blob.representation(resize_to_fit: local_assigns[:in_gallery] ? [ 800, 600 ] : [ 1024, 768 ]) %>
+  <% end %>
+
+  <figcaption class="attachment__caption">
+    <% if caption = blob.try(:caption) %>
+      <%= caption %>
+    <% else %>
+      <span class="attachment__name"><%= blob.filename %></span>
+      <span class="attachment__size"><%= number_to_human_size blob.byte_size %></span>
+    <% end %>
+  </figcaption>
+</figure>

data/db/migrate/201805281641_create_action_text_tables.rb

@@ -0,0 +1,14 @@
+class CreateActionTextTables < ActiveRecord::Migration[6.0]
+  def change
+    create_table :action_text_rich_texts do |t|
+      t.string     :name, null: false
+      t.text       :body, limit: 16777215
+      t.references :record, null: false, polymorphic: true, index: false
+
+      t.datetime :created_at, null: false
+      t.datetime :updated_at, null: false
+
+      t.index [ :record_type, :record_id, :name ], name: "index_action_text_rich_texts_uniqueness", unique: true
+    end
+  end
+end

data/lib/action_text.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/rails"
+
+require "nokogiri"
+
+module ActionText
+  extend ActiveSupport::Autoload
+
+  autoload :Attachable
+  autoload :AttachmentGallery
+  autoload :Attachment
+  autoload :Attribute
+  autoload :Content
+  autoload :Fragment
+  autoload :HtmlConversion
+  autoload :PlainTextConversion
+  autoload :Serialization
+  autoload :TrixAttachment
+
+  module Attachables
+    extend ActiveSupport::Autoload
+
+    autoload :ContentAttachment
+    autoload :MissingAttachable
+    autoload :RemoteImage
+  end
+
+  module Attachments
+    extend ActiveSupport::Autoload
+
+    autoload :Caching
+    autoload :Minification
+    autoload :TrixConversion
+  end
+end

data/lib/action_text/attachable.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module ActionText
+  module Attachable
+    extend ActiveSupport::Concern
+
+    LOCATOR_NAME = "attachable"
+
+    class << self
+      def from_node(node)
+        if attachable = attachable_from_sgid(node["sgid"])
+          attachable
+        elsif attachable = ActionText::Attachables::ContentAttachment.from_node(node)
+          attachable
+        elsif attachable = ActionText::Attachables::RemoteImage.from_node(node)
+          attachable
+        else
+          ActionText::Attachables::MissingAttachable
+        end
+      end
+
+      def from_attachable_sgid(sgid, options = {})
+        method = sgid.is_a?(Array) ? :locate_many_signed : :locate_signed
+        record = GlobalID::Locator.public_send(method, sgid, options.merge(for: LOCATOR_NAME))
+        record || raise(ActiveRecord::RecordNotFound)
+      end
+
+      private
+        def attachable_from_sgid(sgid)
+          from_attachable_sgid(sgid)
+        rescue ActiveRecord::RecordNotFound
+          nil
+        end
+    end
+
+    class_methods do
+      def from_attachable_sgid(sgid)
+        ActionText::Attachable.from_attachable_sgid(sgid, only: self)
+      end
+    end
+
+    def attachable_sgid
+      to_sgid(expires_in: nil, for: LOCATOR_NAME).to_s
+    end
+
+    def attachable_content_type
+      try(:content_type) || "application/octet-stream"
+    end
+
+    def attachable_filename
+      filename.to_s if respond_to?(:filename)
+    end
+
+    def attachable_filesize
+      try(:byte_size) || try(:filesize)
+    end
+
+    def attachable_metadata
+      try(:metadata) || {}
+    end
+
+    def previewable_attachable?
+      false
+    end
+
+    def as_json(*)
+      super.merge(attachable_sgid: attachable_sgid)
+    end
+
+    def to_rich_text_attributes(attributes = {})
+      attributes.dup.tap do |attrs|
+        attrs[:sgid] = attachable_sgid
+        attrs[:content_type] = attachable_content_type
+        attrs[:previewable] = true if previewable_attachable?
+        attrs[:filename] = attachable_filename
+        attrs[:filesize] = attachable_filesize
+        attrs[:width] = attachable_metadata[:width]
+        attrs[:height] = attachable_metadata[:height]
+      end.compact
+    end
+  end
+end

data/lib/action_text/attachables/content_attachment.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ActionText
+  module Attachables
+    class ContentAttachment
+      include ActiveModel::Model
+
+      def self.from_node(node)
+        if node["content-type"]
+          if matches = node["content-type"].match(/vnd\.rubyonrails\.(.+)\.html/)
+            attachment = new(name: matches[1])
+            attachment if attachment.valid?
+          end
+        end
+      end
+
+      attr_accessor :name
+      validates_inclusion_of :name, in: %w( horizontal-rule )
+
+      def attachable_plain_text_representation(caption)
+        case name
+        when "horizontal-rule"
+          " ┄ "
+        else
+          " "
+        end
+      end
+
+      def to_partial_path
+        "action_text/attachables/content_attachment"
+      end
+
+      def to_trix_content_attachment_partial_path
+        "action_text/attachables/content_attachments/#{name.underscore}"
+      end
+    end
+  end
+end