tiptap-ruby 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd7f762d8377a8a4b86b901315b1b4d3d5bc96abd58f6b469861e84ba87b6296
-  data.tar.gz: cfaa3409507308edef86236e01b3d563d023546f2fa75eb0c4d7a0b476bbb7d3
+  metadata.gz: 4c3416b54084b6d2eee7cb1fa23e935d7fa495578a2dbfac7cb028f91c3bd62e
+  data.tar.gz: 9e62d38585790d5efaaed7506f532c20fc6351644f71b370ba32d95638772ed5
 SHA512:
-  metadata.gz: 99ceb0b18400d9c1549e433d4c5ed488797f9599366859ebd10d17d75b64a80ffb58628786e464abddb7caea42a58d2d1a498ce901ed96d14b026dcfda85c7b1
-  data.tar.gz: ac01ac19fd18f06518711922821b5477fc03bc56ea98797b7e4c8e2f35d4d6f9c59c333583a6c136a66d0007f7a1241987baa9c9e657dba812c6ae1b34b97c46
+  metadata.gz: 9b8c3a916a053f93f21b0735285bf99c8840b0a5ffed9769cc91ce217fa3bbf4c3e3a9f5a247f8c1c02b5f2f47ff635999d33d6ba3aa9587b7bc5917d8245776
+  data.tar.gz: 10e9ae09b3b816041d63d4c8a7feda62f804757608ca49a897955b3acc240911e66d694df86b310bb0874f369bcf84b0466b763c721d8cf932fd8cc42f325397

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.7.0] - 2023-11-02
+
+### Breaking
+
+- Renamed `to_json` to `as_json` to follow Ruby/Rails convention.
+
+## [0.6.1] - 2023-11-01
+
+- Allow customizing the `separator` when calling `to_plain_text`.
+
+## [0.6.0] - 2023-11-01
+
+- Implement `Enumerable` for the `HasContent` module.
+
 ## [0.5.0] - 2023-10-30
 
 - Make `Text` a subclass of `Node`.

data/README.md

@@ -2,6 +2,10 @@
 
 A gem for parsing, generating, and rendering TipTap Documents and Nodes using Ruby.
 
+## Note
+
+This gem is under active development and is changing somewhat quickly. There is a chance that there may be breaking changes until a stable version is released.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -55,7 +59,7 @@ Once you have a Document with some content you can render it to HTML, JSON, and
 #### JSON
 
 ```ruby
-document.to_json # => { type: 'doc', content: […nodes]}
+document.as_json # => { type: 'doc', content: […nodes]}
 ```
 
 ### HTML

data/lib/tip_tap/json_renderable.rb

@@ -9,12 +9,13 @@ module TipTap
     end
 
     # Generate a JSON object that is useable by the editor
-    def to_json
+    def as_json
       json = {type: type_name}
-      json = json.merge(content: content.map(&:to_json)) if should_include_content?
+      json = json.merge(content: content.map(&:as_json)) if should_include_content?
       json = json.merge(attrs: attrs.deep_symbolize_keys) if attrs.present?
       json
     end
+    alias_method :to_h, :as_json
 
     private
 

data/lib/tip_tap/nodes/text.rb

@@ -21,7 +21,7 @@ module TipTap
         new(json["text"], marks: Array(json["marks"]))
       end
 
-      def to_json
+      def as_json
         {type: type_name, text: text, marks: marks.map(&:deep_symbolize_keys)}.compact_blank
       end
 
@@ -37,7 +37,7 @@ module TipTap
         value
       end
 
-      def to_plain_text
+      def to_plain_text(separator: " ")
         text
       end
 

data/lib/tip_tap/plain_text_renderable.rb

@@ -3,8 +3,8 @@
 module TipTap
   module PlainTextRenderable
     # Useful for searching
-    def to_plain_text
-      content.map(&:to_plain_text).join(" ")
+    def to_plain_text(separator: " ")
+      content.map { |node| node.to_plain_text(separator: separator) }.join(separator)
     end
   end
 end

data/lib/tip_tap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TipTap
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiptap-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chad Wilken
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview