tiptap-ruby 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 509879e5f27755a131f63f83c7375eb4aa2eaffb575d7f7e10531f402a59a617
-  data.tar.gz: 9a6006a38ca591dca214830907e3a258d6829db4aac044d0b2052c80d281c6cd
+  metadata.gz: 72933879434ba89c5d8e4098c88742ca7c0cba2695440de87a549583df48241d
+  data.tar.gz: f54733e71099b36b8cf59b3beb83a36f330930cc687c768ff9fad5256175ef74
 SHA512:
-  metadata.gz: 62a148965cdaccfc5ba2f18637c681563ee73e83947b6e907d27669ec81f9b24b74a069daf479095433a1ce8c717da7e0846f01217675b2677efdfb109468e7b
-  data.tar.gz: f72265d70fe15905adade16d29abda9b4b3425c1080e50d4ae34b14aeb29a2017d9276bb6b8352005dfd3d7774164f0a959e7357925353a6e2ae1e46b6c84c9e
+  metadata.gz: ec61a23fa173bf933d2296f7eab32d30192f2d2636004012e22bdf80df985c35dcf8438ef714c119a52e683db22493af03750c961fc2293dfe4486de884f07d4
+  data.tar.gz: e370161edd3717f8a22641e00a468254962c1cd3e4d3e1c89ff64c90d5d85a90e5872c245dfdd1351acf3f0ad076e0ff55eb8f7a024da21793e92a41868b133e

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## [Unreleased]
 
+## [0.8.0] - 2023-11-02
+
+### Breaking
+
+- Renamed `as_json` to `to_h` details outlined in https://github.com/chadwilken/tiptap-ruby/issues/10.
+
+## [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.to_h # => { type: 'doc', content: […nodes]}
 ```
 
 ### HTML

data/lib/tip_tap/json_renderable.rb

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

data/lib/tip_tap/node.rb

@@ -12,9 +12,9 @@ require "tip_tap/has_content"
 module TipTap
   class Node
     include Registerable
+    include HasContent
     include HtmlRenderable
     include JsonRenderable
     include PlainTextRenderable
-    include HasContent
   end
 end

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 to_h
         {type: type_name, text: text, marks: marks.map(&:deep_symbolize_keys)}.compact_blank
       end
 

data/lib/tip_tap/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiptap-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.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