richer_text 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc9681628df0cea14882f90ddc28774653a87d2d7db1ef38049bcbc3e67ddb49
-  data.tar.gz: e99f8e2774aede03570dd03ec2f995f6b3e8ab46a9c7f4eedcdd7527fde69995
+  metadata.gz: 823a38cf937e83676b16a06828bf3a3fa461f8b3d38ae628beecd33dfc3927c2
+  data.tar.gz: 4f02bdb13f66fb9b896dee5d52a01806dfab1cf842c4aa33250d1420b49c8fad
 SHA512:
-  metadata.gz: 93038afde3fae59acedbdd62d1879cdb7825e2d134d8aa520ae620a66619de0b32a594e5f34114e7dac66566f66523150d689a39500968076317313f15f00267
-  data.tar.gz: 176ea00a46823251b32ddcb0cd8e9a59eb00eb6f452a2c7c98b43a797bf95e683f4d6df99452ad903ef5c5d6bc2fadf3ff9174f19a31476d07a44455d00b4dd0
+  metadata.gz: 1cf13ee1015adee390ccdb1da3a3f2f317f01c70ea2f10364762c526a1619f56aa79085ddae04ab1690ed602bca0ccdedc3f83c0691fca21c9d4f46cc4314ade
+  data.tar.gz: 9f1fffb59f348833c3a7ebdf1b86075bddfb2a4b4b4459bb7bdb211418e6fbf34c2ffe42c3b9c70f9c2610f6bd2874386003a11a0aaa75adbc64cc55149f6aa6

data/app/assets/stylesheets/richer_text/richer-text.css

@@ -18,6 +18,7 @@
 
 .richer-text table td>*,
 .richer-text table th>* {
+  margin-top: 0;
   margin-bottom: 0;
 }
 
@@ -32,5 +33,11 @@
 }
 
 .richer-text img {
-  width: 100%;
+  width: auto;
+}
+
+.richer-text blockquote {
+  border-left: 2px solid #ced4da;
+  margin: 1rem 0.5rem;
+  padding: 0 0 0 10px;
 }

data/app/helpers/richer_text/tag_helper.rb

@@ -10,7 +10,8 @@ module ActionView::Helpers
       options = @options.stringify_keys
       add_default_name_and_id(options)
       options["input"] ||= dom_id(object, [options["id"], :richer_text_input].compact.join("_")) if object
-      options["value"] = options.fetch("value") { value&.to_html }
+      options["value"] = options.fetch("value") { value&.to_editor_format }
+      options["serializer"] = options.fetch("serializer") { object.class.send(:"richer_text_#{@method_name}_json") ? "json" : "html" }
 
       @template_object.richer_text_area_tag(options.delete("name"), options["value"], options.except("value"))
     end
@@ -40,6 +41,9 @@ module RicherText
       # So that we can access the content in the tiptap editor
       options[:content] ||= value
 
+      # 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("richer-text-editor", options)
 

data/app/models/richer_text/json_text.rb

@@ -0,0 +1,43 @@
+module RicherText
+  class JsonText < ApplicationRecord
+    DEFAULT_BODY = {"type" => "doc", "content" => [{"type" => "paragraph", "attrs" => {"textAlign" => "left"}}]}
+
+    belongs_to :record, polymorphic: true, touch: true
+
+    serialize :body, JSON, default: DEFAULT_BODY.to_json
+
+    has_many_attached :images
+
+    before_save :update_images
+
+    def to_editor_format
+      body
+    end
+
+    def to_s
+      RicherText.default_renderer.visit(document)
+    end
+
+    private
+
+    def update_images
+      self.images = image_nodes.map(&:signed_id)
+    end
+
+    def image_nodes
+      find_nodes_of_type(RicherText::Nodes::Image).flatten.compact_blank
+    end
+
+    def find_nodes_of_type(type, node = document)
+      if node.children.any?
+        node.children.map { |child| find_nodes_of_type(type, child) }
+      else
+        node.is_a?(type) ? node : nil
+      end
+    end
+
+    def document
+      @document ||= RicherText::Node.build(body)
+    end
+  end
+end

data/app/models/richer_text/rich_text.rb

@@ -15,6 +15,10 @@ module RicherText
       body&.to_html&.to_s
     end
 
+    def to_editor_format
+      body&.to_html&.to_s
+    end
+
     private
 
     def update_images

data/db/migrate/20230916224959_create_richer_text_json_texts.rb

@@ -0,0 +1,13 @@
+class CreateRicherTextJsonTexts < ActiveRecord::Migration[7.0]
+  def change
+    create_table :richer_text_json_texts do |t|
+      t.string :name, null: false
+      t.text :body, size: :long
+      t.references :record, null: false, polymorphic: true
+
+      t.timestamps
+
+      t.index [:record_type, :record_id, :name], name: "index_richer_texts_rich_json_uniqueness", unique: true
+    end
+  end
+end

data/lib/richer_text/attribute.rb

@@ -3,7 +3,11 @@ module RicherText
     extend ActiveSupport::Concern
 
     class_methods do
-      def has_richer_text(name)
+      def has_richer_text(name, json: false)
+        # Store if the attribute is using JSON or not.
+        class_attribute :"richer_text_#{name}_json", instance_writer: false
+        self.send(:"richer_text_#{name}_json=", json)
+
         class_eval <<-CODE, __FILE__, __LINE__ + 1
           def #{name}
             richer_text_#{name} || build_richer_text_#{name}
@@ -19,7 +23,7 @@ module RicherText
         CODE
 
         has_one :"richer_text_#{name}", -> { where(name: name) },
-          class_name: "RicherText::RichText", as: :record, inverse_of: :record, autosave: true, dependent: :destroy
+          class_name: json ? "RicherText::JsonText" : "RicherText::RichText", as: :record, inverse_of: :record, autosave: true, dependent: :destroy
 
         scope :"with_richer_text_#{name}", -> { includes("richer_text_#{name}") }
       end

data/lib/richer_text/html_visitor.rb

@@ -0,0 +1,85 @@
+module RicherText
+  class HTMLVisitor
+    include ActionView::Helpers::TagHelper
+
+    def visit(node)
+      node.accept(self)
+    end
+
+    def visit_blockquote(node)
+      "<blockquote>#{visit_children(node).join}</blockquote>"
+    end
+
+    def visit_bullet_list(node)
+      "<ul>#{visit_children(node).join}</ul>"
+    end
+
+    def visit_callout(node)
+      "<div class='callout' data-color='#{node.color}'>#{visit_children(node).join}</div>"
+    end
+
+    def visit_children(node)
+      node.children.map { |child| visit(child) }
+    end
+
+    def visit_code_block(node)
+      "<pre><code>#{visit_children(node).join("\n")}</code></pre>"
+    end
+
+    def visit_doc(node)
+      "<div class='richer-text'>#{visit_children(node).join("\n")}</div>".html_safe
+    end
+
+    def visit_paragraph(node)
+      "<p style='#{node.style}'>#{visit_children(node).join}</p>"
+    end
+
+    def visit_list_item(node)
+      "<li>#{visit_children(node).join}</li>"
+    end
+
+    def visit_ordered_list(node)
+      "<ol>#{visit_children(node).join}</ol>"
+    end
+
+    def visit_heading(node)
+      "<h#{node.level}>#{visit_children(node).join}</h#{node.level}>"
+    end
+
+    def visit_hard_break(_node)
+      "<br>"
+    end
+
+    def visit_horizontal_rule(_node)
+      "<div><hr></div>"
+    end
+
+    def visit_image(node)
+      "<img src='#{node.src}' />"
+    end
+
+    def visit_text(node, marks)
+      if marks.empty?
+        node.text
+      else
+        content_tag(marks[0].tag, visit_text(node, marks[1..]), marks[0].attrs)
+      end
+    end
+
+    def visit_table(node)
+      "<table>#{visit_children(node).join}</table>"
+    end
+
+    def visit_table_row(node)
+      "<tr>#{visit_children(node).join}</tr>"
+    end
+
+    def visit_table_cell(node)
+      "<td>#{visit_children(node).join}</td>"
+    end
+
+    def visit_table_header(node)
+      "<th>#{visit_children(node).join}</th>"
+    end
+  end
+end

data/lib/richer_text/mark.rb

@@ -0,0 +1,23 @@
+module RicherText
+  class Mark
+    attr_reader :attrs, :type
+
+    TAGS = {
+      "bold" => "strong",
+      "italic" => "em",
+      "strike" => "del",
+      "code" => "code",
+      "highlight" => "mark",
+      "link" => "a"
+    }
+
+    def initialize(json)
+      @attrs = json.fetch("attrs", {})
+      @type = json.fetch("type", nil)
+    end
+
+    def tag
+      TAGS[type] || "span"
+    end
+  end
+end

data/lib/richer_text/node.rb

@@ -0,0 +1,30 @@
+module RicherText
+  class Node
+    attr_reader :json, :attrs, :children, :type
+
+    STYLES = {
+      "textAlign" => "text-align",
+    }
+
+    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)
+    end
+
+    def initialize(json)
+      @json = json
+      @attrs = json.fetch("attrs", {})
+      @type = json.fetch("type", "text")
+      @children = json.fetch("content", []).map { |child| self.class.build(child) }
+    end
+
+    def style
+      @attrs.select { |k, v| STYLES.key?(k) }.map { |k, v| "#{STYLES[k]}: #{v};" }.join
+    end
+
+    def accept(visitor)
+      visitor.send("visit_#{type.underscore}", self)
+    end
+  end
+end

data/lib/richer_text/nodes/blockquote.rb

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

data/lib/richer_text/nodes/bullet_list.rb

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

data/lib/richer_text/nodes/callout.rb

@@ -0,0 +1,9 @@
+module RicherText
+  module Nodes
+    class Callout < ::RicherText::Node
+      def color
+        attrs["data-color"]
+      end
+    end
+  end
+end

data/lib/richer_text/nodes/code_block.rb

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

data/lib/richer_text/nodes/doc.rb

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

data/lib/richer_text/nodes/hard_break.rb

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

data/lib/richer_text/nodes/heading.rb

@@ -0,0 +1,9 @@
+module RicherText
+  module Nodes
+    class Heading < ::RicherText::Node
+      def level
+        attrs["level"]
+      end
+    end
+  end
+end

data/lib/richer_text/nodes/horizontal_rule.rb

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

data/lib/richer_text/nodes/image.rb

@@ -0,0 +1,13 @@
+module RicherText
+  module Nodes
+    class Image < ::RicherText::Node
+      def src
+        @src ||= attrs['src']
+      end
+
+      def signed_id
+        @signed_id = attrs['signedId']
+      end
+    end
+  end
+end

data/lib/richer_text/nodes/list_item.rb

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

data/lib/richer_text/nodes/ordered_list.rb

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

data/lib/richer_text/nodes/paragraph.rb

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

data/lib/richer_text/nodes/table.rb

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

data/lib/richer_text/nodes/table_cell.rb

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

data/lib/richer_text/nodes/table_header.rb

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

data/lib/richer_text/nodes/table_row.rb

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

data/lib/richer_text/nodes/text.rb

@@ -0,0 +1,18 @@
+module RicherText
+  module Nodes
+    class Text < ::RicherText::Node
+      def initialize(json)
+        @marks = json.fetch("marks", []).map { |mark| RicherText::Mark.new(mark) }
+        super(json)
+      end
+
+      def text
+        json["text"]
+      end
+
+      def accept(visitor)
+        visitor.visit_text(self, @marks)
+      end
+    end
+  end
+end

data/lib/richer_text/version.rb

@@ -1,3 +1,3 @@
 module RicherText
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/richer_text.rb

@@ -13,4 +13,38 @@ module RicherText
   autoload :Fragment
   autoload :Serialization
   autoload :TagHelper
+
+  autoload :Node
+  autoload :Mark
+  autoload :HTMLVisitor
+
+  module Nodes
+    extend ActiveSupport::Autoload
+
+    autoload :Blockquote
+    autoload :BulletList
+    autoload :Callout
+    autoload :CodeBlock
+    autoload :Doc
+    autoload :HardBreak
+    autoload :Heading
+    autoload :HorizontalRule
+    autoload :Image
+    autoload :ListItem
+    autoload :Paragraph
+    autoload :OrderedList
+    autoload :Text
+    autoload :Table
+    autoload :TableCell
+    autoload :TableRow
+    autoload :TableHeader
+  end
+
+  class << self
+    def default_renderer
+      @default_renderer ||= RicherText::HTMLVisitor.new
+    end
+
+    attr_writer :default_renderer
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: richer_text
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrea Fomera
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-02 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,17 +43,39 @@ files:
 - app/jobs/richer_text/application_job.rb
 - app/mailers/richer_text/application_mailer.rb
 - app/models/richer_text/application_record.rb
+- app/models/richer_text/json_text.rb
 - app/models/richer_text/rich_text.rb
 - app/views/layouts/richer_text/application.html.erb
 - app/views/richer_text/contents/_content.html.erb
 - config/routes.rb
 - db/migrate/20230107020316_create_richer_text_rich_texts.rb
+- db/migrate/20230916224959_create_richer_text_json_texts.rb
 - lib/generators/richer_text/install/install_generator.rb
 - lib/richer_text.rb
 - lib/richer_text/attribute.rb
 - lib/richer_text/content.rb
 - lib/richer_text/engine.rb
 - lib/richer_text/fragment.rb
+- lib/richer_text/html_visitor.rb
+- lib/richer_text/mark.rb
+- lib/richer_text/node.rb
+- lib/richer_text/nodes/blockquote.rb
+- lib/richer_text/nodes/bullet_list.rb
+- lib/richer_text/nodes/callout.rb
+- lib/richer_text/nodes/code_block.rb
+- lib/richer_text/nodes/doc.rb
+- lib/richer_text/nodes/hard_break.rb
+- lib/richer_text/nodes/heading.rb
+- lib/richer_text/nodes/horizontal_rule.rb
+- lib/richer_text/nodes/image.rb
+- lib/richer_text/nodes/list_item.rb
+- lib/richer_text/nodes/ordered_list.rb
+- lib/richer_text/nodes/paragraph.rb
+- lib/richer_text/nodes/table.rb
+- lib/richer_text/nodes/table_cell.rb
+- lib/richer_text/nodes/table_header.rb
+- lib/richer_text/nodes/table_row.rb
+- lib/richer_text/nodes/text.rb
 - lib/richer_text/rendering.rb
 - lib/richer_text/serialization.rb
 - lib/richer_text/version.rb