tiptap-ruby 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60b5aada7f1e70f5781974f227c6957baa22edda85692a1d788a43757c675f2c
-  data.tar.gz: 39b3b083e5fb3023e912ec7b8e778f8c0223feebf20c447a7d46952df03a2ca9
+  metadata.gz: fd7f762d8377a8a4b86b901315b1b4d3d5bc96abd58f6b469861e84ba87b6296
+  data.tar.gz: cfaa3409507308edef86236e01b3d563d023546f2fa75eb0c4d7a0b476bbb7d3
 SHA512:
-  metadata.gz: fb67a28e811555d08ef569c6827c1b7c3f1bdd97b986d52f48661007abd9163da8fc54b1631b45e310b8a5d3ff073fab8780626c7712017a2806c9294fae7cb5
-  data.tar.gz: db4dec5f0e8004e0387e934d3bda318518e2e552cacdef30e3d547dd116f2d3b70c924e9da9eeb21e3b5897df684ac9d98224bc846a662c3a189f7c72e06298b
+  metadata.gz: 99ceb0b18400d9c1549e433d4c5ed488797f9599366859ebd10d17d75b64a80ffb58628786e464abddb7caea42a58d2d1a498ce901ed96d14b026dcfda85c7b1
+  data.tar.gz: ac01ac19fd18f06518711922821b5477fc03bc56ea98797b7e4c8e2f35d4d6f9c59c333583a6c136a66d0007f7a1241987baa9c9e657dba812c6ae1b34b97c46

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.5.0] - 2023-10-30
+
+- Make `Text` a subclass of `Node`.
+- Try to unify the interface a bit more for the initialize method.
+
+## [0.4.0] - 2023-10-29
+
+- Extract `Registerable` module from `JsonRenderable` so that Node registration is separated from being JSON renderable.
+- Make `Document` a subclass of `Node`.
+
 ## [0.3.0] - 2023-10-29
 
 - Tweak dependency version requirements to be greater than or equal to

data/README.md

@@ -72,6 +72,51 @@ Rendering to plain text is useful if you want to search the contents of your Tip
 document.to_plain_text # => My Important Document
 ```
 
+### Custom Nodes
+
+You can extend the library to add custom node types. First, define your `Node` subclass.
+
+```ruby
+# lib/tip_tap/nodes/gallery.rb
+
+module TipTap
+  module Nodes
+    class Gallery < Node
+      self.type_name = 'gallery'
+      self.html_tag = :div
+      self.html_class_name = 'gallery'
+    end
+  end
+end
+```
+
+Then create an initializer and define an extensions module and include it in the corresponding node. For example:
+
+```ruby
+# config/initializers/tiptap.rb
+
+require 'tip_tap'
+require 'tip_tap/nodes/gallery'
+
+module TipTap::DocumentAdditions
+  def gallery(&block)
+    raise ArgumentError, "Block required" if block.nil?
+    add_content(TipTap::Nodes::Gallery.new(&block))
+  end
+end
+
+TipTap::Document.include(TipTap::DocumentAdditions)
+```
+
+Now you can generate gallery nodes on a `Document` instance:
+
+```ruby
+document = TipTap::Document.new
+document.gallery do |gallery|
+  gallery.gallery_item(src: 'example.com')
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/tip_tap/has_content.rb

@@ -4,6 +4,8 @@ require "active_support/core_ext/hash"
 
 module TipTap
   module HasContent
+    include Enumerable
+
     attr_reader :attrs, :content
 
     def self.included(base)
@@ -20,13 +22,23 @@ module TipTap
       yield self if block_given?
     end
 
-    def find_node(node_type)
-      content.find { |child| child.is_a?(node_type) }
+    def each
+      content.each { |child| yield child }
+    end
+
+    def find_node(type_class_or_name)
+      node_type = type_class_or_name.is_a?(String) ? TipTap.node_for(type_class_or_name) : type_class_or_name
+      find { |child| child.is_a?(node_type) }
     end
 
     def add_content(node)
       @content << node
     end
+    alias_method :<<, :add_content
+
+    def size
+      content.size
+    end
 
     module ClassMethods
       # Create a new instance from a TipTap JSON object.

data/lib/tip_tap/nodes/text.rb

@@ -1,23 +1,18 @@
 # frozen_string_literal: true
 
-require "tip_tap/registerable"
-require "tip_tap/json_renderable"
-require "tip_tap/html_renderable"
+require "tip_tap/node"
 
 module TipTap
   module Nodes
-    class Text
-      include Registerable
-      include JsonRenderable
-      include HtmlRenderable
-
+    class Text < Node
       attr_reader :text, :marks
 
       self.type_name = "text"
 
-      def initialize(text, marks: [])
-        @text = text
-        @marks = marks.map(&:deep_stringify_keys)
+      def initialize(content, **attributes)
+        @text = content
+        @marks = Array(attributes[:marks]).map(&:deep_stringify_keys)
+        yield self if block_given?
       end
 
       def self.from_json(json)

data/lib/tip_tap/version.rb

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

metadata

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