actiontext5 5.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8160e6be3d5b37488107aa744e5a8a2b74347ba2a36227c149d9e79dbd0630e5
+  data.tar.gz: a0674e2c6bbdd9a4fd9301870768fc560701e3cc1b86f8a68c4db7dd0d73aa40
+SHA512:
+  metadata.gz: 9cc4c4939ae0f7d160faa09aefc48a13f6ee55659ca11b4511304b155982876cff63d4f1c0c5e58df2cebc982a598a2ac3c45fef7c09ef8c7196272415447952
+  data.tar.gz: 71bb739f6919d271cef629b64f39c3eb2c0fa9dfa743d4408954956221b6f1e9adb790b101a562f8d561ce5904fd154565750e94083f3e16ba05556891976094

data/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle/
+.byebug_history
+log/*.log
+node_modules/
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/node_modules/
+test/dummy/public/
+test/dummy/yarn-error.log
+test/dummy/storage/
+test/dummy/tmp/

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+sudo: false
+
+rvm:
+  - 2.5.3
+  - ruby-head
+
+cache:
+  bundler: true
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+
+script:
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+git_source(:github) { |repo_path| "https://github.com/#{repo_path}.git" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,140 @@
+PATH
+  remote: .
+  specs:
+    actiontext5 (5.2.0)
+      nokogiri
+      rails (~> 5.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.8)
+      actionpack (= 5.2.8)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.8)
+      actionpack (= 5.2.8)
+      actionview (= 5.2.8)
+      activejob (= 5.2.8)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.8)
+      actionview (= 5.2.8)
+      activesupport (= 5.2.8)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.8)
+      activesupport (= 5.2.8)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.8)
+      activesupport (= 5.2.8)
+      globalid (>= 0.3.6)
+    activemodel (5.2.8)
+      activesupport (= 5.2.8)
+    activerecord (5.2.8)
+      activemodel (= 5.2.8)
+      activesupport (= 5.2.8)
+      arel (>= 9.0)
+    activestorage (5.2.8)
+      actionpack (= 5.2.8)
+      activerecord (= 5.2.8)
+      marcel (~> 1.0.0)
+    activesupport (5.2.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_magick (4.11.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3.1)
+    rack-proxy (0.7.2)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.8)
+      actioncable (= 5.2.8)
+      actionmailer (= 5.2.8)
+      actionpack (= 5.2.8)
+      actionview (= 5.2.8)
+      activejob (= 5.2.8)
+      activemodel (= 5.2.8)
+      activerecord (= 5.2.8)
+      activestorage (= 5.2.8)
+      activesupport (= 5.2.8)
+      bundler (>= 1.3.0)
+      railties (= 5.2.8)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (5.2.8)
+      actionpack (= 5.2.8)
+      activesupport (= 5.2.8)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (13.0.6)
+    sprockets (4.0.3)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    webpacker (3.2.2)
+      activesupport (>= 4.2)
+      rack-proxy (>= 0.6.1)
+      railties (>= 4.2)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actiontext5!
+  bundler (~> 1.15)
+  byebug
+  mini_magick
+  sqlite3
+  webpacker (~> 3.2.2)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 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 @@
+This gem is just a fork from https://github.com/rails/actiontext builded to work with Rails 5.2.

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'Action Text'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/actiontext.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "action_text/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name     = "actiontext5"
+  s.version  = ActionText::VERSION
+  s.authors  = ["Benoit MARTIN-CHAVE"]
+  s.email    = ["benoit@martin-chave.com"]
+  s.summary  = "ActionText for Rails 5"
+  s.homepage = "https://github.com/BenoitMC/actiontext5"
+  s.license  = "MIT"
+
+  s.required_ruby_version = ">= 2.5.0"
+
+  s.add_dependency "rails", "~> 5.2.0"
+  s.add_dependency "nokogiri"
+
+  s.add_development_dependency "bundler", "~> 1.15"
+  s.add_development_dependency "mini_magick"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "webpacker", "~> 3.2.2"
+  s.add_development_dependency "byebug"
+
+  s.files      = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+end

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 "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,11 @@
+import * as Trix from "trix"
+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,25 @@
+# frozen_string_literal: true
+
+# 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 ActionText::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

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/bin/test

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/bin/webpack

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'webpack' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("webpacker", "webpack")

data/bin/webpack-dev-server

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'webpack-dev-server' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("webpacker", "webpack-dev-server")

data/db/migrate/201805281641_create_action_text_tables.rb

@@ -0,0 +1,14 @@
+class CreateActionTextTables < ActiveRecord::Migration[5.2]
+  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/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 or 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