richer_text 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0896d20faa3ab1fcf20e72e0be2fe6902bf2831b8f21bc5d006f6bbac0d4aad
-  data.tar.gz: e0b592625c14d7c867087b29129b4bf711e01675eb8e1187a6aa4114fab9eb48
+  metadata.gz: 93af4f6f1d3dba85682d797cd9433f76b557945ea1fef31859ea482cec66f2f6
+  data.tar.gz: 2537fb3cf9f2706e946e71385507ea035625416e4e730aefa6eb6ffbf345897c
 SHA512:
-  metadata.gz: 3f386bd1e15a650db59353b2627224d5dbdcbcfdaa28f49fe7fde165266cac6d876d618da844a00c7c1d7457468543060437aff4a7c2d41736f7eaf6152d92dc
-  data.tar.gz: 364abb9092c4f8bb13959c3dc13291a22b485e8360f12219064ec4bcb73deeff965c4942d5b0320e8d3977ad7bc107a78133649f72a2b02264fa3945a07adc06
+  metadata.gz: a4b553ac51eb39c4c6dc1cd849c5d3034873f0ad4436ba4fccaa7d5565ca55a3cf090207d2571fcd3ced60e9ad1ac4eb3947a12e9d16d53be32b943cf8769115
+  data.tar.gz: 3fa4670ddee0a16fc2ac12b878b3e222bd95c8b3dd06aef720aae5807c3c5c46fe19e272af0cffe3244c1c03b5c8704168776eec1a47e9fa857f978d440f5841

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/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/lib/generators/richer_text/install/install_generator.rb

@@ -26,7 +26,7 @@ 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 "yarn add highlight.js @afomera/richer-text@alpha"
         end
 
         say "Adding import to application.js", :green

data/lib/richer_text/html_visitor.rb

@@ -89,7 +89,7 @@ module RicherText
       if marks.empty?
         node.text
       else
-        content_tag(marks[0].tag, visit_text(node, marks[1..]), marks[0].attrs)
+        content_tag(marks[0].tag, visit_text(node, marks[1..]), parse_mark_attrs(marks[0]))
       end
     end
 
@@ -118,5 +118,20 @@ module RicherText
     def node_previewable?(node)
       node.attrs["contentType"].match(previewable_regex)
     end
+
+    def parse_mark_attrs(mark)
+      attrs = mark.attrs
+      tag = mark.tag
+
+      if attrs.dig("color").present? && tag == "mark"
+        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
+    end
   end
 end

data/lib/richer_text/node.rb

@@ -4,7 +4,7 @@ module RicherText
     include RicherText::Rendering
 
     STYLES = {
-      "textAlign" => "text-align",
+      "textAlign" => "text-align"
     }
 
     def self.build(json)

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.11.0"
+  VERSION = "0.13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: richer_text
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Andrea Fomera
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -102,6 +102,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 +125,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