richer_text 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5520f0457b69a555273d7a738f5257a0951eef4d65153ad783cd2f31246daad
-  data.tar.gz: d4978b9880b46a6af9a91868cdbf40ae8306d3dd749c6ec94631e6999820af89
+  metadata.gz: fff049eb5287d1b4033a4cbd8b42b7e1cb8048273e6be55383ec282dc923feb1
+  data.tar.gz: 641adc8fdc6fa45dfe9aa0d9efb6971d3ed29d448335518d7069c1e306f8d0a2
 SHA512:
-  metadata.gz: faca362e8db800731ec19ade535551664f5bcc2f379e80283229f536a8b06608a6601d50c4672e02394c650f178ec5697244e14adfca4f0a701ec4bba1ca4846
-  data.tar.gz: 4662002c357fee3d91db0b96236c2d314c0551ecbc916a41f6e1c3dea63a5a5d30ab3208045160936b312500a72295d26aed2b59b2c487855431c69f5bf5da6a
+  metadata.gz: 6735d25685c7efc9dfc22e709edd2c6f32b443d9c0f82d93d6697ead4467ee5e2946330be133d3693b589954fe65ef4242b86885b2c080fb370ec6d0f8cc9b96
+  data.tar.gz: 29319df08e89a28d230ff7b45f7d2c4bad11aae0b8927940c15827b2d6fa3ad4970af53ad908415d519c3697c07393d863cfa8c03b446ded0e42ccd08c394964

data/README.md

@@ -2,7 +2,7 @@
 
 RicherText aims to provide a richer text editing experience than what comes out of the box with ActionText in Rails. **It is however a seperate thing from ActionText** and is **not** backwards compatible.
 
-RicherText uses React and TipTap under the hood to create an editor, this does mean that you'll have react and react-dom in your project, but you absolutely don't need to use it outside of the RicherText editor. Additionally there's currently a hard requirement for ActiveStorage as well.
+RicherText uses Lit and TipTap under the hood to create an editor. Additionally there's currently a hard requirement for ActiveStorage as well.
 
 ## Installation
 
@@ -50,10 +50,12 @@ Take a Post model where you'd like to add RicherText to write, and edit the body
 
 ```ruby
 class Post < ApplicationRecord
-  has_richer_text :body
+  has_richer_text :body, store_as: :json
 end
 ```
 
+We recommend storing your Richer Text records as JSON for full compatibility with the TipTap schema under the hood.
+
 **Add the form helper to the form**
 
 Inside of your form partial:
@@ -83,3 +85,25 @@ Contribution directions go here.
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Portions of the code related to the `has_richer_text` attribute, and parsing of the HTML content for the RicherText::RichText model are licensed under the Rails source code license, as it falls under the substantial portion of Software:
+
+Copyright (c) 37signals 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/app/helpers/richer_text/tag_helper.rb

@@ -59,7 +59,7 @@ module RicherText
     cattr_accessor(:id, instance_accessor: false) { 0 }
 
     def richer_text_area_tag(name, value = nil, options = {})
-      options = options.symbolize_keys
+      options = RicherText.default_form_options.merge(options.symbolize_keys).symbolize_keys
       options[:input] ||= "richer_text_input_#{RicherText::TagHelper.id += 1}"
 
       # So that we can access the content in the tiptap editor

data/app/models/richer_text/json_text.rb

@@ -4,7 +4,7 @@ module RicherText
 
     belongs_to :record, polymorphic: true, touch: true
 
-    serialize :body, JSON, default: DEFAULT_BODY.to_json
+    serialize :body, coder: JSON, default: DEFAULT_BODY.to_json
 
     has_many_attached :images
     has_many_attached :rhino_attachments # For handling attachments in the Rhino Editor

data/app/models/richer_text/rich_text.rb

@@ -2,7 +2,7 @@ module RicherText
   class RichText < ApplicationRecord
     belongs_to :record, polymorphic: true, touch: true
 
-    serialize :body, RicherText::Content
+    serialize :body, coder: RicherText::Content
 
     delegate :to_s, :nil?, to: :body
     delegate :blank?, :empty?, :present?, to: :to_html

data/lib/generators/richer_text/install/install_generator.rb

@@ -26,7 +26,11 @@ module RicherText
 
         if destination.join("package.json").exist?
           say "Adding dependencies to package.json", :green
-          run "yarn add react react-dom highlight.js @afomera/richer-text"
+
+          run "npm install highlight.js @afomera/richer-text@alpha" if destination.join("package-lock.json").exist?
+          run "bun add highlight.js @afomera/richer-text@alpha" if destination.join("bun.lockb").exist?
+          run "yarn add highlight.js @afomera/richer-text@alpha" if destination.join("yarn.lock").exist?
+          run "pnpm add highlight.js @afomera/richer-text@alpha" if destination.join("pnpm-lock.yaml").exist?
         end
 
         say "Adding import to application.js", :green

data/lib/richer_text/html_visitor.rb

@@ -42,6 +42,10 @@ module RicherText
       "<div class='richer-text'>#{visit_children(node).join("\n")}</div>".html_safe
     end
 
+    def visit_iframely_embed(node)
+      node.html
+    end
+
     def visit_mention(node, marks)
       if marks.any?
         content_tag(marks[0].tag, visit_mention(node, marks[1..]), marks[0].attrs)
@@ -127,6 +131,8 @@ module RicherText
         attrs.merge(style: "background-color: #{attrs["color"]};")
       elsif attrs.dig("color").present? && tag == "span"
         attrs.merge(style: "color: #{attrs["color"]};")
+      elsif attrs.dig("fontSize").present? && tag == "span"
+        attrs.merge(style: "font-size: #{attrs["fontSize"]};")
       else
         attrs
       end

data/lib/richer_text/nodes/iframely_embed.rb

@@ -0,0 +1,15 @@
+module RicherText
+  module Nodes
+    class IframelyEmbed < ::RicherText::Node
+      def href
+        @attrs["href"]
+      end
+
+      def html
+        "<div class='iframely'>
+          #{@attrs["previewHtml"]}
+        </div>"
+      end
+    end
+  end
+end

data/lib/richer_text/tag_helper.rb

@@ -0,0 +1,4 @@
+module RicherText
+  module TagHelper
+  end
+end

data/lib/richer_text/version.rb

@@ -1,3 +1,3 @@
 module RicherText
-  VERSION = "0.12.0"
+  VERSION = "0.14.0"
 end

data/lib/richer_text.rb

@@ -34,6 +34,7 @@ module RicherText
     autoload :HardBreak
     autoload :Heading
     autoload :HorizontalRule
+    autoload :IframelyEmbed
     autoload :Image
     autoload :ListItem
     autoload :Mention
@@ -52,6 +53,10 @@ module RicherText
       @default_renderer ||= RicherText::HTMLVisitor.new
     end
 
-    attr_writer :default_renderer
+    def default_form_options
+      @default_form_options ||= {}
+    end
+
+    attr_writer :default_renderer, :default_form_options
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: richer_text
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Andrea Fomera
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -89,6 +89,7 @@ files:
 - lib/richer_text/nodes/hard_break.rb
 - lib/richer_text/nodes/heading.rb
 - lib/richer_text/nodes/horizontal_rule.rb
+- lib/richer_text/nodes/iframely_embed.rb
 - lib/richer_text/nodes/image.rb
 - lib/richer_text/nodes/list_item.rb
 - lib/richer_text/nodes/mention.rb
@@ -102,6 +103,7 @@ files:
 - lib/richer_text/nodes/text.rb
 - lib/richer_text/rendering.rb
 - lib/richer_text/serialization.rb
+- lib/richer_text/tag_helper.rb
 - lib/richer_text/version.rb
 - lib/tasks/richer_text_tasks.rake
 homepage: https://github.com/afomera/richer_text
@@ -124,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A richer text editor for Rails