richer_text 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b81c08a89947035259c743a2fafd9733cc908c9ad44b79d10fe628c8b623f28
-  data.tar.gz: 96b812bf2680e6fef1b889078a8b4641385dbef977604d43df39e38c5fc009a4
+  metadata.gz: 03e9732ed2320f56a2c30cbcd6af7614b6840b601aab70d790c96e6e8412babf
+  data.tar.gz: 4413b9240e46d0153dff22c7b4dd7161a555f572ada62b69159f0c267ae7b0b4
 SHA512:
-  metadata.gz: 119fa92b171048de0cb69a215a11fca49ae736e4a9e473e412344d81b035739cb65f0d534ecef6e00d4fe38fdb59ddff6cf5e42d66d534afd5c6a94891f8d6e6
-  data.tar.gz: f6f03e6c4b2693c60f5f16adf47edc301b66f63ae4a881da39ed8a5500fec0dfbbf0531f173d52813b17521ce2b487fc48ccf0555694480be02c8c0edee409a8
+  metadata.gz: 39f20dfc3cecd2f74f4cc4d01b396d9678ceeed635ff4dc2a35bc62ba0dc8f6361f882dfe1df67b9286d63b1c86fbd6b7e73b729175e8fd3948435eb041a7ade
+  data.tar.gz: 4718871930d84edd4de392d9ea2d321f6a04782e5f0c774906e468e8c70ecac6ea9c78fb4ed92dcf7aa8598fea600dea3d13a117beef8287d5b709a8547d2318

data/app/helpers/richer_text/tag_helper.rb

@@ -17,16 +17,40 @@ module ActionView::Helpers
     end
   end
 
+  class Tags::RhinoEditor < Tags::Base
+    include Tags::Placeholderable
+
+    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"], :rhino_text_input].compact.join("_")) if object
+      options["value"] = options.fetch("value") { value&.to_editor_format }
+      options["serializer"] = options.fetch("serializer") { "html"}
+
+      @template_object.rhino_text_area_tag(options.delete("name"), options["value"], options.except("value"))
+    end
+  end
+
   module FormHelper
     def richer_text_area(object_name, method, options = {})
       Tags::Editor.new(object_name, method, self, options).render
     end
+
+    def rhino_text_area(object_name, method, options = {})
+      Tags::RhinoEditor.new(object_name, method, self, options).render
+    end
   end
 
   class FormBuilder
     def richer_text_area(method, options = {})
       @template.richer_text_area(@object_name, method, objectify_options(options))
     end
+
+    def rhino_text_area(method, options = {})
+      @template.rhino_text_area(@object_name, method, objectify_options(options))
+    end
   end
 end
 
@@ -49,5 +73,18 @@ module RicherText
 
       input_tag + editor_tag
     end
+
+    def rhino_text_area_tag(name, value = nil, options = {})
+      options = options.symbolize_keys
+      options[:input] ||= "rhino_text_input_#{RicherText::TagHelper.id += 1}"
+
+      # So we can choose the serializer to use, e.g. "html" or "json"
+      options[:serializer] ||= "html"
+
+      input_tag = hidden_field_tag(name, value, id: options[:input])
+      editor_tag = tag("rhino-editor", { input: options[:input], serializer: "json",  data: { "blob-url-template": rails_service_blob_url(":signed_id", ":filename"), "direct-upload-url": rails_direct_uploads_url }}.merge(options))
+
+      input_tag + editor_tag
+    end
   end
 end

data/app/models/richer_text/json_text.rb

@@ -7,8 +7,9 @@ module RicherText
     serialize :body, JSON, default: DEFAULT_BODY.to_json
 
     has_many_attached :images
+    has_many_attached :rhino_attachments # For handling attachments in the Rhino Editor
 
-    before_save :update_images
+    before_save :update_attachments
 
     def to_editor_format
       body
@@ -18,18 +19,40 @@ module RicherText
       RicherText.default_renderer.visit(document)
     end
 
+    def mentionees
+      gids = mention_nodes.map(&:id).compact_blank
+
+      GlobalID::Locator.locate_many(gids).uniq # Only return unique records
+    end
+
     private
 
-    def update_images
+    def update_attachments
       self.images = image_nodes.map(&:signed_id)
+      self.rhino_attachments = rhino_attachment_records.map(&:signed_id)
     end
 
     def image_nodes
       find_nodes_of_type(RicherText::Nodes::Image).flatten.compact_blank
     end
 
+    def mention_nodes
+      find_nodes_of_type(RicherText::Nodes::Mention).flatten.compact_blank
+    end
+
+    def rhino_attachment_nodes
+      find_nodes_of_type(RicherText::Nodes::AttachmentFigure).flatten.compact_blank
+    end
+
+    def rhino_attachment_records
+      sgids = rhino_attachment_nodes.map(&:sgid).compact_blank
+      GlobalID::Locator.locate_many_signed(sgids, for: "attachable")
+    end
+
     def find_nodes_of_type(type, node = document)
       if node.children.any?
+        return node if node.is_a?(type)
+
         node.children.map { |child| find_nodes_of_type(type, child) }
       else
         node.is_a?(type) ? node : nil

data/app/models/richer_text/rich_text.rb

@@ -19,6 +19,12 @@ module RicherText
       body&.to_html&.to_s
     end
 
+    def mentionees
+      global_ids = body&.mentionees_global_ids
+
+      GlobalID::Locator.locate_many(global_ids)
+    end
+
     private
 
     def update_images

data/lib/richer_text/content.rb

@@ -28,6 +28,12 @@ module RicherText
       end.uniq
     end
 
+    def mentionees_global_ids
+      global_ids = fragment.find_all("span[data-type=mention]").map do |span|
+        span.attributes["data-id"].value
+      end.uniq
+    end
+
     def image_blobs
       image_blob_ids.map { |id| ActiveStorage::Blob.find_signed(id) }
     end

data/lib/richer_text/html_visitor.rb

@@ -6,6 +6,18 @@ module RicherText
       node.accept(self)
     end
 
+    def visit_attachment_figure(node)
+      "<figure sgid=#{node.attrs["sgid"]}>
+        #{node_previewable?(node) ? "<img src=#{node.url} />" : "<a href=#{node.url} target='_blank'>"}
+        <figcaption class='attachment__caption'>#{visit_children(node).join}</figcaption>
+        #{node_previewable?(node) ? "" : "</a>"}
+      </figure>"
+    end
+
+    def visit_attachment_gallery(node)
+      "<div class='attachment-gallery'>#{visit_children(node).join}</div>"
+    end
+
     def visit_blockquote(node)
       "<blockquote>#{visit_children(node).join}</blockquote>"
     end
@@ -30,6 +42,17 @@ module RicherText
       "<div class='richer-text'>#{visit_children(node).join("\n")}</div>".html_safe
     end
 
+    def visit_mention(node, marks)
+      if marks.any?
+        content_tag(marks[0].tag, visit_mention(node, marks[1..]), marks[0].attrs)
+      else
+        tag.span(
+          tag.img(src: node.avatar_url, class: "richer-text--mention-img") +
+          tag.span(node.name, class: "richer-text--mention-label"),
+          class: "richer-text--mention")
+      end
+    end
+
     def visit_paragraph(node)
       "<p style='#{node.style}'>#{visit_children(node).join}</p>"
     end
@@ -81,5 +104,15 @@ module RicherText
     def visit_table_header(node)
       "<th>#{visit_children(node).join}</th>"
     end
+
+    private
+
+    def previewable_regex
+      /^image(\/(gif|png|jpe?g)|$)/
+    end
+
+    def node_previewable?(node)
+      node.attrs["contentType"].match(previewable_regex)
+    end
   end
 end

data/lib/richer_text/node.rb

@@ -8,8 +8,8 @@ module RicherText
 
     def self.build(json)
       node = json.is_a?(String) ? JSON.parse(json) : json
-      klass = "RicherText::Nodes::#{node["type"].underscore.classify}".safe_constantize
-      klass.new(node)
+      klass = "RicherText::Nodes::#{node["type"].underscore.classify}".constantize
+      klass.new(node) if klass
     end
 
     def initialize(json)

data/lib/richer_text/nodes/attachment_figure.rb

@@ -0,0 +1,17 @@
+module RicherText
+  module Nodes
+    class AttachmentFigure < ::RicherText::Node
+      def previewable?
+        @attrs["previewable"]
+      end
+
+      def url
+        @attrs["url"].presence || @attrs["src"]
+      end
+
+      def sgid
+        @attrs["sgid"]
+      end
+    end
+  end
+end

data/lib/richer_text/nodes/attachment_gallery.rb

@@ -0,0 +1,6 @@
+module RicherText
+  module Nodes
+    class AttachmentGallery < ::RicherText::Node
+    end
+  end
+end

data/lib/richer_text/nodes/mention.rb

@@ -0,0 +1,30 @@
+module RicherText
+  module Nodes
+    class Mention < ::RicherText::Node
+      def initialize(json)
+        @marks = json.fetch("marks", []).map { |mark| RicherText::Mark.new(mark) }
+        super(json)
+      end
+
+      def accept(visitor)
+        visitor.visit_mention(self, @marks)
+      end
+
+      def user
+        @user ||= GlobalID::Locator.locate(@attrs["id"])
+      end
+
+      def id
+        @attrs["id"]
+      end
+
+      def name
+        @user.respond_to?(:name) ? @user.name : @attrs["label"]
+      end
+
+      def avatar_url
+        @user.respond_to?(:avatar_url) ? @user.avatar_url : @attrs["avatarUrl"]
+      end
+    end
+  end
+end

data/lib/richer_text/version.rb

@@ -1,3 +1,3 @@
 module RicherText
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

data/lib/richer_text.rb

@@ -21,6 +21,8 @@ module RicherText
   module Nodes
     extend ActiveSupport::Autoload
 
+    autoload :AttachmentFigure # For Rhino Editor support
+    autoload :AttachmentGallery # For Rhino Editor support
     autoload :Blockquote
     autoload :BulletList
     autoload :Callout
@@ -31,8 +33,9 @@ module RicherText
     autoload :HorizontalRule
     autoload :Image
     autoload :ListItem
-    autoload :Paragraph
+    autoload :Mention
     autoload :OrderedList
+    autoload :Paragraph
     autoload :Text
     autoload :Table
     autoload :TableCell

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: richer_text
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Andrea Fomera
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,6 +59,8 @@ files:
 - lib/richer_text/html_visitor.rb
 - lib/richer_text/mark.rb
 - lib/richer_text/node.rb
+- lib/richer_text/nodes/attachment_figure.rb
+- lib/richer_text/nodes/attachment_gallery.rb
 - lib/richer_text/nodes/blockquote.rb
 - lib/richer_text/nodes/bullet_list.rb
 - lib/richer_text/nodes/callout.rb
@@ -69,6 +71,7 @@ files:
 - lib/richer_text/nodes/horizontal_rule.rb
 - lib/richer_text/nodes/image.rb
 - lib/richer_text/nodes/list_item.rb
+- lib/richer_text/nodes/mention.rb
 - lib/richer_text/nodes/ordered_list.rb
 - lib/richer_text/nodes/paragraph.rb
 - lib/richer_text/nodes/table.rb