tiptap-ruby 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 252bf239b4d5d2f754d1b57c21e5055206557f6f4288cb8e53b97d43d3a44a68
-  data.tar.gz: b4973d5e59abbd29c5d5203c73c6dd76cdde57b7871cb72f32543a0aba512e1c
+  metadata.gz: 234920a15c4fa07aec094cdfc999631c005cbef531c13eb69ec706bca5ac866f
+  data.tar.gz: 2cdbb32cc437b0490027e94335ce7e57f7f1cd89184642a08590bc3e82e7e6d3
 SHA512:
-  metadata.gz: ad79a5564011be35e9cf2d8eaec3c1ff2ed7e1eac790dbe1a5218034b126041e16a6dc8eda9148e3f922a6855bab52d3fd5e1e11e2733890cc448a128208e2d6
-  data.tar.gz: a22012af8ba3daabc39f862d0269350e22978d2cf16c1f806f1ad1c3c7ae480fabaf4ebb198c6b70a64aa82e49732c385ea2851343321ecf452e97f032c33e2f
+  metadata.gz: 5999cd5ccc9e0772ebbb4c7e5df486499671ae4f34c881a9259bcf0d309a42ccb640ec63f83f901ced8c26909c0ef88c51fb72d1a5ac2cd8184c357b0fbd4e31
+  data.tar.gz: 60b0011c676856731fc1809c6fd8380282b0175ef235fa4a6edaf946275638dd0a9a4b21a307d267d3caf6cf5a1b11e919ccf458262f04f9218e78a9ff9dda4d

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/document.rb

@@ -1,19 +1,11 @@
 # frozen_string_literal: true
 
-require "tip_tap/html_renderable"
-require "tip_tap/json_renderable"
-require "tip_tap/plain_text_renderable"
-require "tip_tap/has_content"
+require "tip_tap/node"
 
 # This is the class that all child nodes will be added to.
 # This is the root object for TipTap.
 module TipTap
-  class Document
-    include JsonRenderable
-    include HtmlRenderable
-    include PlainTextRenderable
-    include HasContent
-
+  class Document < Node
     self.type_name = "doc"
     self.html_tag = :div
     self.html_class_name = "tiptap-document"

data/lib/tip_tap/json_renderable.rb

@@ -4,25 +4,6 @@ require "tip_tap/registry"
 
 module TipTap
   module JsonRenderable
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def type_name=(type_name)
-        @type_name = type_name
-        Registry.register(type_name, self)
-      end
-
-      def type_name
-        @type_name
-      end
-    end
-
-    def type_name
-      self.class.type_name
-    end
-
     def include_empty_content_in_json?
       true
     end

data/lib/tip_tap/node.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "tip_tap/registerable"
 require "tip_tap/html_renderable"
 require "tip_tap/json_renderable"
 require "tip_tap/plain_text_renderable"
@@ -10,6 +11,7 @@ require "tip_tap/has_content"
 # converting to HTML, JSON, and plain text
 module TipTap
   class Node
+    include Registerable
     include HtmlRenderable
     include JsonRenderable
     include PlainTextRenderable

data/lib/tip_tap/nodes/text.rb

@@ -1,21 +1,18 @@
 # frozen_string_literal: true
 
-require "tip_tap/json_renderable"
-require "tip_tap/html_renderable"
+require "tip_tap/node"
 
 module TipTap
   module Nodes
-    class Text
-      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/registerable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "tip_tap/registry"
+
+module TipTap
+  module Registerable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def type_name=(type_name)
+        @type_name = type_name
+        Registry.register(type_name, self)
+      end
+
+      def type_name
+        @type_name
+      end
+    end
+
+    def type_name
+      self.class.type_name
+    end
+  end
+end

data/lib/tip_tap/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiptap-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Chad Wilken
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-29 00:00:00.000000000 Z
+date: 2023-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -69,6 +69,7 @@ files:
 - lib/tip_tap/nodes/task_list.rb
 - lib/tip_tap/nodes/text.rb
 - lib/tip_tap/plain_text_renderable.rb
+- lib/tip_tap/registerable.rb
 - lib/tip_tap/registry.rb
 - lib/tip_tap/version.rb
 - lib/tiptap.rb