editorjs_renderer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb8e368f0d8a52e6ced1d5bad069494aab8be619209b76e7adb845bfe0025b8a
-  data.tar.gz: 5265f195ae17da0ac8c596d713b0eda5d11df7072f70aee64d975c866eb946c3
+  metadata.gz: 5b121c4cae0462b209cc6a06a97d20b604f64532ecde7d0ac17f49590b9071f5
+  data.tar.gz: de06caddb9899d96f371cdae6356d9c62b40aa54082634316e0d6c699e95529d
 SHA512:
-  metadata.gz: 627849905b767eb411b6a65744d68f5f57cd620748ebc609d269698e4721ba3d86764178ba22733d0a09aec647ed04cc015749c0ff5b276bb957b9040fac0a55
-  data.tar.gz: b2c39951c1fc4152f410219657507d363e395cd0889329e9b1a11820a3a4449eee1fe2ed9de7b91553c98f3e0ff83d3246803548e8818b0067b8be6a3ab643a2
+  metadata.gz: '00615381d173edec22850e3baee788a845c429fd2e368cb38912ed8da6dca136fa5d21adeff211cf1309fa0f9505675b0e9d218c2d7c68b899af2dbb57cc8c72'
+  data.tar.gz: fd934f5aa5f525ad06aaba16d2dd7671e19c34f1b32e41f95ddd15a49fdca4be7d5723581081bc1546a10f704ea4789281dedf1a00f06ae17df274ae4104d0f3

data/CHANGELOG.md

@@ -10,8 +10,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ---
+## [0.3.0] - 2025-04-24
 
-## [0.2.0] - 2025-04-23
+### Added
+- Zeitwerk autoloader support: removed all `require_relative` statements.
+- New block: `Image` – renders `<img>` tag with optional `<figure>` and `<figcaption>`.
+- New block: `List` – renders unordered and ordered lists (`<ul>` and `<ol>`).
+- New block: `Attaches` – renders a download link with file size information.
+- New block: `Checklist` – renders a checklist with checkboxes (readonly).
+- New block: `Code` – renders multiline code block as `<pre><code>`.
+- New block: `Delimiter` – renders horizontal rule (`<hr>`).
+- Tests for all new blocks: structure validation, HTML output, plain output.
+- Extended `document_spec.rb` to verify full document rendering with all blocks.
+
+### Changed
+- Replaced manual file loading with Zeitwerk's automatic constant loading.
+
+---
+
+## [0.2.1] - 2025-04-23
 
 ### Added
 - New block: `Spoiler` – supports nested content via recursive rendering of inner `Document`.

data/README.md

@@ -13,6 +13,8 @@ It allows rendering JSON data generated by Editor.js into safe HTML and plain te
 - Built-in validation using JSON Schema
 - Secure HTML output via escaping
 - Configurable block rendering system
+- Support for nested blocks (blocks within blocks)
+- Blocks: `Spoiler`, `Table`, `Checklist`, `Attaches`, `Code`, `Delimiter`, etc.
 - No JavaScript dependencies required on the server side
 
 ---
@@ -39,7 +41,12 @@ bundle install
 data = {
   "time" => "123456789",
   "blocks" => [
-    { "type" => "paragraph", "data" => { "text" => "Hello <b>world</b>" } }
+    { "type" => "paragraph", "data" => { "text" => "Hello <b>world</b>" } },
+    { "type" => "checklist", "data" => { "items" => [
+        { "text" => "Buy milk", "checked" => true },
+        { "text" => "Read book", "checked" => false }
+      ]}
+    }
   ]
 }
 ```
@@ -47,10 +54,10 @@ data = {
 ```bash
 document = EditorjsRenderer::Document.new(data)
 document.render(format: :html)
-# => "<p>Hello &lt;b&gt;world&lt;/b&gt;</p>"
+# => "<p>Hello &lt;b&gt;world&lt;/b&gt;</p><ul class=\"checklist-block\"><li><input type=\"checkbox\" checked disabled> Buy milk</li><li><input type=\"checkbox\" disabled> Read book</li></ul>"
 
 document.render(format: :plain)
-# => "Hello <b>world</b>"
+# => "Hello <b>world</b>\n[x] Buy milk\n[ ] Read book"
 ```
 
 ---
@@ -75,6 +82,20 @@ end
 Schemas should follow the JSON Schema format and be stored in YAML files.
 Each block must have a schema named like paragraph.yml, header.yml, etc.
 
+Example:
+```yml
+type: object
+required:
+  - text
+properties:
+  text:
+  type: string
+  description: "The main content of the header block"
+```
+
+In this schema:
+ - `text` is a required field of type string, which represents the header text.
+
 ---
 
 ## Development
@@ -110,6 +131,16 @@ module EditorjsRenderer
 end
 ```
 
+#### Autoloading with Zeitwerk
+
+This gem uses Zeitwerk to handle autoloading. Ensure you have Zeitwerk set up in your environment:
+
+```ruby
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+```
 ---
 
 ## Contributing

data/lib/editorjs_renderer/blocks/attaches.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/attaches.rb
+module EditorjsRenderer
+  module Blocks
+    # Attaches block: renders a file download link with title and optional size.
+    class Attaches < Base
+      def to_html
+        url = ERB::Util.html_escape(block_data.dig("file", "url"))
+        title = ERB::Util.html_escape(block_data["title"].to_s)
+        size = block_data["size"]
+
+        size_str = size ? " (#{format_size(size)})" : ""
+        "<div class=\"attachment-block\"><a href=\"#{url}\" download>#{title}#{size_str}</a></div>"
+      end
+
+      def to_plain
+        url = block_data.dig("file", "url")
+        title = block_data["title"].to_s
+        size = block_data["size"]
+        size_str = size ? " (#{format_size(size)})" : ""
+        "[Attachment] #{title} — #{url}#{size_str}".strip
+      end
+
+      private
+
+      def format_size(bytes)
+        return unless bytes.respond_to?(:to_f) && bytes.to_f.positive?
+
+        kb = bytes.to_f / 1024
+        mb = kb / 1024
+        return "#{format("%.1f", mb)} MB" if mb >= 1
+
+        "#{format("%.1f", kb)} KB"
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/blocks/checklist.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/checklist.rb
+module EditorjsRenderer
+  module Blocks
+    # Checklist block: renders a list of checkboxes (readonly)
+    class Checklist < Base
+      def to_html
+        items = block_data["items"].map do |item|
+          text = ERB::Util.html_escape(item["text"].to_s)
+          checked_attr = item["checked"] ? " checked" : ""
+          "<li><input type=\"checkbox\"#{checked_attr} disabled> #{text}</li>"
+        end
+
+        "<ul class=\"checklist-block\">#{items.join}</ul>"
+      end
+
+      def to_plain
+        block_data["items"].map do |item|
+          marker = item["checked"] ? "[x]" : "[ ]"
+          "#{marker} #{item["text"]}"
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/blocks/code.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/code.rb
+module EditorjsRenderer
+  module Blocks
+    # Code block: renders a block of code inside <pre><code>
+    class Code < Base
+      def to_html
+        code = ERB::Util.html_escape(block_data["code"].to_s)
+        "<pre><code>#{code}</code></pre>"
+      end
+
+      def to_plain
+        block_data["code"].to_s
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/blocks/delimiter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/delimiter.rb
+module EditorjsRenderer
+  module Blocks
+    # Delimiter block: renders a visual separator line (horizontal rule)
+    #
+    # Used to separate content sections, similar to <hr> or "---" in text.
+    #
+    # @example
+    #   Delimiter.new({}).to_html
+    #   # => '<hr class="delimiter-block">'
+    #
+    #   Delimiter.new({}).to_plain
+    #   # => "---"
+    class Delimiter < Base
+      def to_html
+        '<hr class="delimiter-block">'
+      end
+
+      def to_plain
+        "---"
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/blocks/header.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/header.rb
+module EditorjsRenderer
+  module Blocks
+    # Header block renders a heading tag (<h1>–<h6>) based on level.
+    #
+    # @example
+    #   data = { "text" => "Title", "level" => 2 }
+    #   Header.new(data).to_html # => "<h2>Title</h2>"
+    class Header < Base
+      def to_html
+        level = block_data["level"].to_i.clamp(1, 6)
+        text = ERB::Util.html_escape(block_data["text"])
+        "<h#{level}>#{text}</h#{level}>"
+      end
+
+      def to_plain
+        block_data["text"].to_s
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/blocks/image.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/image.rb
+module EditorjsRenderer
+  module Blocks
+    # Image block: renders an <img> tag with optional caption
+    class Image < Base
+      def to_html
+        url = ERB::Util.html_escape(block_data["url"])
+        caption = ERB::Util.html_escape(block_data["caption"].to_s)
+        figure = "<img src=\"#{url}\" alt=\"#{caption}\">"
+        caption.empty? ? figure : "<figure>#{figure}<figcaption>#{caption}</figcaption></figure>"
+      end
+
+      def to_plain
+        caption = block_data["caption"].to_s
+        "[Image] #{caption}".strip
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/blocks/list.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/list.rb
+module EditorjsRenderer
+  module Blocks
+    # List block: renders a list as <ul>/<ol> with <li> elements.
+    #
+    # Example block data:
+    # {
+    #   "style": "ordered",
+    #   "items": ["First", "Second"]
+    # }
+    #
+    # Renders to:
+    # <ol><li>First</li><li>Second</li></ol>
+    #
+    # Or in plain text:
+    # 1. First
+    # 2. Second
+    class List < Base
+      def to_html
+        style = block_data["style"] == "ordered" ? "ol" : "ul"
+        items = block_data["items"].map do |item|
+          "<li>#{ERB::Util.html_escape(item)}</li>"
+        end
+        "<#{style}>#{items.join}</#{style}>"
+      end
+
+      def to_plain
+        if block_data["style"] == "ordered"
+          block_data["items"].each_with_index.map { |item, i| "#{i + 1}. #{item}" }.join("\n")
+        else
+          block_data["items"].map { |item| "- #{item}" }.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/config.rb

@@ -11,7 +11,7 @@ module EditorjsRenderer
 
     def initialize
       @schemas_path = File.join(EditorjsRenderer.root, "lib", "editorjs_renderer", "schemas")
-      @enabled_blocks = %w[paragraph spoiler]
+      @enabled_blocks = %w[paragraph spoiler table header image list attaches checklist code delimiter]
     end
   end
 end

data/lib/editorjs_renderer/schemas/attaches.yml

@@ -0,0 +1,18 @@
+# lib/editorjs_renderer/schemas/attaches.yml
+
+type: object
+required:
+  - file
+  - title
+properties:
+  file:
+    type: object
+    required:
+      - url
+    properties:
+      url:
+        type: string
+  title:
+    type: string
+  size:
+    type: integer

data/lib/editorjs_renderer/schemas/checklist.yml

@@ -0,0 +1,18 @@
+# lib/editorjs_renderer/schemas/checklist.yml
+
+type: object
+required:
+  - items
+properties:
+  items:
+    type: array
+    items:
+      type: object
+      required:
+        - text
+        - checked
+      properties:
+        text:
+          type: string
+        checked:
+          type: boolean

data/lib/editorjs_renderer/schemas/code.yml

@@ -0,0 +1,8 @@
+# lib/editorjs_renderer/schemas/code.yml
+
+type: object
+required:
+  - code
+properties:
+  code:
+    type: string

data/lib/editorjs_renderer/schemas/delimiter.yml

@@ -0,0 +1,3 @@
+# lib/editorjs_renderer/delimiter.yml
+type: object
+properties: {}

data/lib/editorjs_renderer/schemas/header.yml

@@ -0,0 +1,13 @@
+# lib/editorjs_renderer/schemas/header.yml
+
+type: object
+required:
+  - text
+  - level
+properties:
+  text:
+    type: string
+  level:
+    type: integer
+    minimum: 1
+    maximum: 6

data/lib/editorjs_renderer/schemas/image.yml

@@ -0,0 +1,16 @@
+# lib/editorjs_renderer/schemas/image.yml
+
+type: object
+required:
+  - url
+properties:
+  url:
+    type: string
+  caption:
+    type: string
+  withBorder:
+    type: boolean
+  withBackground:
+    type: boolean
+  stretched:
+    type: boolean

data/lib/editorjs_renderer/schemas/list.yml

@@ -0,0 +1,16 @@
+# lib/editorjs_renderer/schemas/list.yml
+
+type: object
+required:
+  - style
+  - items
+properties:
+  style:
+    type: string
+    enum:
+      - unordered
+      - ordered
+  items:
+    type: array
+    items:
+      type: string

data/lib/editorjs_renderer/version.rb

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

data/lib/editorjs_renderer.rb

@@ -5,6 +5,10 @@ require "yaml"
 require "active_support/all"
 require "logger"
 require "json_schemer"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
 # EditorjsRenderer provides rendering and configuration logic for EditorJS-compatible
 # data in Ruby applications. It allows transforming structured block-based data
@@ -45,15 +49,3 @@ module EditorjsRenderer
     end
   end
 end
-
-require_relative "editorjs_renderer/errors"
-require_relative "editorjs_renderer/config"
-require_relative "editorjs_renderer/document"
-require_relative "editorjs_renderer/renderers/html_renderer"
-require_relative "editorjs_renderer/renderers/plain_renderer"
-require_relative "editorjs_renderer/blocks/base"
-require_relative "editorjs_renderer/blocks/paragraph"
-require_relative "editorjs_renderer/blocks/spoiler"
-require_relative "editorjs_renderer/blocks/table"
-require_relative "editorjs_renderer/version"
-require_relative "editorjs_renderer/schema_validator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: editorjs_renderer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Georgy Shcherbakov
@@ -9,7 +9,7 @@ authors:
 - Grigory Paraschevin
 bindir: bin
 cert_chain: []
-date: 2025-04-23 00:00:00.000000000 Z
+date: 2025-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description: Library for rendering and validating Editor.js documents in Rails applications
 email:
 - lordsynergymail@gmail.com
@@ -70,7 +84,14 @@ files:
 - README.md
 - Rakefile
 - lib/editorjs_renderer.rb
+- lib/editorjs_renderer/blocks/attaches.rb
 - lib/editorjs_renderer/blocks/base.rb
+- lib/editorjs_renderer/blocks/checklist.rb
+- lib/editorjs_renderer/blocks/code.rb
+- lib/editorjs_renderer/blocks/delimiter.rb
+- lib/editorjs_renderer/blocks/header.rb
+- lib/editorjs_renderer/blocks/image.rb
+- lib/editorjs_renderer/blocks/list.rb
 - lib/editorjs_renderer/blocks/paragraph.rb
 - lib/editorjs_renderer/blocks/spoiler.rb
 - lib/editorjs_renderer/blocks/table.rb
@@ -80,7 +101,14 @@ files:
 - lib/editorjs_renderer/renderers/html_renderer.rb
 - lib/editorjs_renderer/renderers/plain_renderer.rb
 - lib/editorjs_renderer/schema_validator.rb
+- lib/editorjs_renderer/schemas/attaches.yml
+- lib/editorjs_renderer/schemas/checklist.yml
+- lib/editorjs_renderer/schemas/code.yml
+- lib/editorjs_renderer/schemas/delimiter.yml
 - lib/editorjs_renderer/schemas/document.yml
+- lib/editorjs_renderer/schemas/header.yml
+- lib/editorjs_renderer/schemas/image.yml
+- lib/editorjs_renderer/schemas/list.yml
 - lib/editorjs_renderer/schemas/paragraph.yml
 - lib/editorjs_renderer/schemas/spoiler.yml
 - lib/editorjs_renderer/schemas/table.yml