editorjs_renderer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb8e368f0d8a52e6ced1d5bad069494aab8be619209b76e7adb845bfe0025b8a
+  data.tar.gz: 5265f195ae17da0ac8c596d713b0eda5d11df7072f70aee64d975c866eb946c3
+SHA512:
+  metadata.gz: 627849905b767eb411b6a65744d68f5f57cd620748ebc609d269698e4721ba3d86764178ba22733d0a09aec647ed04cc015749c0ff5b276bb957b9040fac0a55
+  data.tar.gz: b2c39951c1fc4152f410219657507d363e395cd0889329e9b1a11820a3a4449eee1fe2ed9de7b91553c98f3e0ff83d3246803548e8818b0067b8be6a3ab643a2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+plugins:
+  - rubocop-rails
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Rails/OutputSafety:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: true
+  CountComments: false 

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),  
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [Unreleased]
+
+---
+
+## [0.2.0] - 2025-04-23
+
+### Added
+- New block: `Spoiler` – supports nested content via recursive rendering of inner `Document`.
+- New block: `Table` – renders as HTML `<table>` or plain text with pipe-delimited rows.
+- YAML schemas for `spoiler.yml` and `table.yml`, with validation on required structure.
+- Full test coverage for `Spoiler` and `Table` blocks, including deep nesting scenarios.
+- Support for nested blocks within blocks (recursive `Document` rendering).
+- Improved error messages for validation failures.
+
+### Changed
+- `Document` now validates block structure more strictly (e.g., `id`, `type`, `data`, `tunes`).
+- Validation is no longer performed in block `initialize`, but deferred to `block_data` access.
+
+### Fixed
+- Multiple RuboCop and RSpec style issues (e.g., multiple expectations per example).
+- Schema for `paragraph` block now validated only within its `data`.
+
+---
+
+### Added
+- Initial support for rendering Editor.js blocks (`paragraph`) in HTML and plain text.
+- JSON schema validation for documents and blocks.
+- Configurable list of allowed block types.
+- Default error handling and logging of skipped blocks.
+- Documentation for each component and setup.
+
+---
+
+## [0.1.0] - 2025-04-22
+
+### Added
+- First public release of the `editorjs_renderer` gem.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Georgy Shcherbakov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+# EditorjsRenderer
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.txt)
+
+EditorjsRenderer is a Ruby gem that brings [Editor.js](https://editorjs.io/) support to Rails applications.  
+It allows rendering JSON data generated by Editor.js into safe HTML and plain text.
+
+---
+
+## Features
+
+- Support for structured content (Editor.js blocks)
+- Built-in validation using JSON Schema
+- Secure HTML output via escaping
+- Configurable block rendering system
+- No JavaScript dependencies required on the server side
+
+---
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem "editorjs_renderer"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+---
+
+## Usage
+
+```
+data = {
+  "time" => "123456789",
+  "blocks" => [
+    { "type" => "paragraph", "data" => { "text" => "Hello <b>world</b>" } }
+  ]
+}
+```
+
+```bash
+document = EditorjsRenderer::Document.new(data)
+document.render(format: :html)
+# => "<p>Hello &lt;b&gt;world&lt;/b&gt;</p>"
+
+document.render(format: :plain)
+# => "Hello <b>world</b>"
+```
+
+---
+
+## Configuration
+
+The gem includes a default schema for the `paragraph` block, located at:
+
+```
+lib/editorjs_renderer/schemas/
+```
+
+You can configure enabled block types and schema path:
+
+```ruby
+EditorjsRenderer.configure do |config|
+  config.enabled_blocks = %w[paragraph]
+  config.schemas_path = Rails.root.join("config/editor_schemas").to_s
+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.
+
+---
+
+## Development
+
+To run tests and linters:
+
+```bash
+bundle exec rake
+```
+
+#### Rendering Custom Blocks
+
+To support a new block:
+
+1. Create a class in EditorjsRenderer::Blocks namespace (e.g., Header)
+2. Inherit from EditorjsRenderer::Blocks::Base
+3. Implement render and plain
+4. Add a corresponding schema
+
+```ruby
+module EditorjsRenderer
+  module Blocks
+    class Header < Base
+      def render
+        "<h1>#{ERB::Util.html_escape(data["text"])}</h1>"
+      end
+
+      def plain
+        data["text"].to_s
+      end
+    end
+  end
+end
+```
+
+---
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lordsynergy/editorjs_renderer.
+
+---
+
+## License
+
+This gem is licensed under the [MIT License](https://opensource.org/license/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# rakefile
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/editorjs_renderer/blocks/base.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/base.rb
+module EditorjsRenderer
+  module Blocks
+    # Abstract base class for all EditorjsRenderer blocks.
+    # Implements schema validation using JSON Schemer and requires subclasses
+    # to implement `render` (HTML) and `plain` (text) output methods.
+    #
+    # @abstract
+    class Base
+      def initialize(block_data)
+        @block_data = block_data
+      end
+
+      def to_html
+        raise NotImplementedError
+      end
+
+      def to_plain
+        raise NotImplementedError
+      end
+
+      def block_data
+        validate!
+        @block_data
+      end
+
+      private
+
+      def validate!
+        raise Errors::InvalidBlock, "Anonymous block class has no name" unless self.class.name
+
+        schema = schema_for(self.class.name)
+        EditorjsRenderer::SchemaValidator.validate!(
+          data: @block_data,
+          schema: schema,
+          error_class: Errors::InvalidBlock,
+          context: self.class.name
+        )
+      end
+
+      def schema_for(class_name)
+        schema_file = "#{class_name.demodulize.underscore}.yml"
+        schema_path = File.join(EditorjsRenderer.config.schemas_path, schema_file)
+        raise Errors::InvalidBlock, "Missing schema file for #{class_name}" unless File.exist?(schema_path)
+
+        YAML.load_file(schema_path)
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/blocks/paragraph.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/paragraph.rb
+module EditorjsRenderer
+  module Blocks
+    # Paragraph block rendering logic.
+    # Converts "paragraph" block data into a `<p>` HTML element and plain text string.
+    #
+    # Expects schema to define at least a "text" property in the data.
+    #
+    # @see EditorjsRenderer::Blocks::Base
+    class Paragraph < Base
+      def to_html
+        "<p>#{ERB::Util.html_escape(block_data["text"])}</p>"
+      end
+
+      def to_plain
+        block_data["text"].to_s
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/blocks/spoiler.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/spoiler.rb
+module EditorjsRenderer
+  module Blocks
+    # Spoiler block rendering logic.
+    #
+    # This block renders collapsible content using <details> and <summary> HTML tags.
+    # It can contain nested EditorJS blocks, including other Spoiler blocks.
+    #
+    # Expects the following structure:
+    # {
+    #   "caption": "Title",
+    #   "content": {
+    #     "blocks": [ ... ]
+    #   }
+    # }
+    #
+    # @example HTML output
+    #   <details>
+    #     <summary>Title</summary>
+    #     ...nested block HTML...
+    #   </details>
+    #
+    # @example Plain text output
+    #   Title: Nested text...
+    #
+    # @see EditorjsRenderer::Blocks::Base
+    class Spoiler < Base
+      def to_html
+        caption = ERB::Util.html_escape(block_data["caption"])
+        content_blocks = block_data.dig("content", "blocks") || []
+        inner_doc = Document.new("blocks" => content_blocks, "time" => Time.now.to_i.to_s)
+        "<details><summary>#{caption}</summary>#{inner_doc.render}</details>"
+      end
+
+      def to_plain
+        content_blocks = block_data.dig("content", "blocks") || []
+        inner_doc = Document.new("blocks" => content_blocks, "time" => Time.now.to_i.to_s)
+        "#{block_data["caption"]}: #{inner_doc.render(format: :plain)}"
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/blocks/table.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/blocks/table.rb
+module EditorjsRenderer
+  module Blocks
+    # Table block rendering logic.
+    # Converts a 2D array into HTML <table> and plain text.
+    class Table < Base
+      def to_html
+        rows = block_data["content"].map do |row|
+          cells = row.map { |cell| "<td>#{ERB::Util.html_escape(cell)}</td>" }.join
+          "<tr>#{cells}</tr>"
+        end.join
+
+        "<table>#{rows}</table>"
+      end
+
+      def to_plain
+        block_data["content"].map { |row| row.join(" | ") }.join("\n")
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/config.rb
+module EditorjsRenderer
+  # Configuration object for EditorjsRenderer.
+  # Used to set block schemas path and list of enabled block types.
+  #
+  # @see EditorjsRenderer.configure
+  class Config
+    attr_accessor :schemas_path, :enabled_blocks
+
+    def initialize
+      @schemas_path = File.join(EditorjsRenderer.root, "lib", "editorjs_renderer", "schemas")
+      @enabled_blocks = %w[paragraph spoiler]
+    end
+  end
+end

data/lib/editorjs_renderer/document.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/document.rb
+module EditorjsRenderer
+  # Represents an EditorJS document parsed from a Hash or JSON structure.
+  # Validates the document structure and renders its blocks using configured renderers.
+  #
+  # @example Rendering HTML
+  #   document = EditorjsRenderer::Document.new(editorjs_data)
+  #   document.render(format: :html)
+  class Document
+    def initialize(editorjs_data)
+      @editorjs_data = editorjs_data
+      @blocks = nil
+    end
+
+    def render(format: :html)
+      renderer_for(format).render(blocks)
+    end
+
+    def blocks
+      validate!
+      @blocks ||= parse_blocks(@editorjs_data["blocks"])
+    end
+
+    private
+
+    def parse_blocks(blocks_data)
+      blocks_data.filter_map { build_block(it) }
+    end
+
+    def build_block(block_data)
+      klass = block_class(block_data["type"])
+      klass.new(block_data["data"])
+    rescue StandardError => e
+      EditorjsRenderer.logger.warn("Invalid block skipped: #{e.message}")
+      nil
+    end
+
+    def block_class(type)
+      unless EditorjsRenderer.config.enabled_blocks.include?(type)
+        raise Errors::UnsupportedBlockType, "Unsupported block type: #{type}"
+      end
+
+      EditorjsRenderer::Blocks.const_get(type.camelize)
+    end
+
+    def renderer_for(format)
+      case format
+      when :html then EditorjsRenderer::Renderers::HtmlRenderer
+      when :plain then EditorjsRenderer::Renderers::PlainRenderer
+      else raise Errors::UnsupportedFormat, "Unsupported format: #{format}"
+      end
+    end
+
+    def validate!
+      schema = YAML.load_file(File.join(EditorjsRenderer.config.schemas_path, "document.yml"))
+      EditorjsRenderer::SchemaValidator.validate!(
+        data: @editorjs_data,
+        schema: schema,
+        error_class: Errors::InvalidDocument,
+        context: "(document)"
+      )
+    end
+  end
+end

data/lib/editorjs_renderer/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/errors.rb
+# Contains custom error classes used throughout EditorjsRenderer.
+module EditorjsRenderer
+  # Custom error namespace for all EditorjsRenderer-specific exceptions.
+  module Errors
+    # Raised when the EditorJS document structure is invalid.
+    class InvalidDocument < StandardError; end
+
+    # Raised when the requested output format (e.g., :html, :plain) is not supported.
+    class UnsupportedFormat < StandardError; end
+
+    # Raised when a block type is not listed in the enabled blocks.
+    class UnsupportedBlockType < StandardError; end
+
+    # Raised when a block fails schema validation or its schema file is missing.
+    class InvalidBlock < StandardError; end
+  end
+end

data/lib/editorjs_renderer/renderers/html_renderer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/renderers/html_renderer.rb
+module EditorjsRenderer
+  module Renderers
+    # Renders an array of block objects to HTML output.
+    # Used internally by `EditorjsRenderer::Document`.
+    module HtmlRenderer
+      def self.render(blocks)
+        blocks.map(&:to_html).join("\n").html_safe
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/renderers/plain_renderer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/renderers/plain_renderer.rb
+module EditorjsRenderer
+  module Renderers
+    # Renders an array of block objects to plain text output.
+    # Used for indexing, previews, or fallback content.
+    module PlainRenderer
+      def self.render(blocks)
+        blocks.map(&:to_plain).join("\n")
+      end
+    end
+  end
+end

data/lib/editorjs_renderer/schema_validator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer/schema_validator.rb
+module EditorjsRenderer
+  # Provides schema validation using JSON Schema via the `json_schemer` gem.
+  # This module is used by EditorjsRenderer::Document and block classes to validate
+  # structure and content of incoming EditorJS data against YAML-defined schemas.
+  #
+  # @api internal
+  module SchemaValidator
+    # Validates the given data against the provided JSON schema.
+    #
+    # @param params [Hash] a hash of named arguments:
+    #   - :data [Hash] the data to validate
+    #   - :schema [Hash] the JSON schema
+    #   - :error_class [Class<StandardError>] class to raise if validation fails
+    #   - :context [String] optional name or description to use in error messages
+    #
+    # @raise [StandardError] instance of provided error_class with detailed message
+    #
+    # @example
+    #   EditorjsRenderer::SchemaValidator.validate!(
+    #     data: { "time" => 123456, "blocks" => [] },
+    #     schema: YAML.load_file("schema.yml"),
+    #     error_class: EditorjsRenderer::Errors::InvalidDocument,
+    #     context: "EditorJS Document"
+    #   )
+    def self.validate!(params)
+      data, schema, error_class, context = extract_params(params)
+
+      errors = JSONSchemer.schema(schema).validate(data).to_a
+      return if errors.empty?
+
+      message = formatted_message(errors, context)
+      raise error_class, message
+    end
+
+    # Extracts and validates required parameters from the input hash.
+    #
+    # @param params [Hash] input hash with required keys
+    # @return [Array] extracted arguments in order: data, schema, error_class, context
+    #
+    # @raise [KeyError] if any required keys are missing
+    def self.extract_params(params)
+      data        = params.fetch(:data)
+      schema      = params.fetch(:schema)
+      error_class = params.fetch(:error_class)
+      context     = params.fetch(:context, "(document)")
+
+      [data, schema, error_class, context]
+    end
+
+    # Builds a human-readable error message from validation errors.
+    #
+    # @param errors [Array<Hash>] list of validation error hashes
+    # @param context [String] the name of the context (block class or document)
+    # @return [String] formatted error message
+    def self.formatted_message(errors, context)
+      error_messages = errors.map do |err|
+        location = err["data_pointer"].presence || context
+        detail = err["message"].presence || "is invalid"
+        "#{location}: #{detail}"
+      end
+
+      "#{context} validation failed: #{error_messages.join(", ")}"
+    end
+  end
+end

data/lib/editorjs_renderer/schemas/document.yml

@@ -0,0 +1,28 @@
+# lib/editorjs_renderer/schemas/document.yml
+
+type: object
+required:
+  - time
+  - blocks
+properties:
+  time:
+    type: string
+  blocks:
+    type: array
+    items:
+      type: object
+      required:
+        - id
+        - type
+        - data
+      properties:
+        id:
+          type: string
+        type:
+          type: string
+        data:
+          type: object
+        tunes:
+          type: object
+          additionalProperties: true
+      additionalProperties: false

data/lib/editorjs_renderer/schemas/paragraph.yml

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

data/lib/editorjs_renderer/schemas/spoiler.yml

@@ -0,0 +1,16 @@
+# lib/editorjs_renderer/schemas/spoiler.yml
+
+type: object
+required:
+  - caption
+  - content
+properties:
+  caption:
+    type: string
+  content:
+    type: object
+    required:
+      - blocks
+    properties:
+      blocks:
+        type: array

data/lib/editorjs_renderer/schemas/table.yml

@@ -0,0 +1,12 @@
+# lib/editorjs_renderer/schemas/table.yml
+
+type: object
+required:
+  - content
+properties:
+  content:
+    type: array
+    items:
+      type: array
+      items:
+        type: string

data/lib/editorjs_renderer/version.rb

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

data/lib/editorjs_renderer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# lib/editorjs_renderer.rb
+require "yaml"
+require "active_support/all"
+require "logger"
+require "json_schemer"
+
+# EditorjsRenderer provides rendering and configuration logic for EditorJS-compatible
+# data in Ruby applications. It allows transforming structured block-based data
+# into HTML and plain text formats.
+#
+# You can configure enabled blocks and schema paths using `.configure`.
+#
+# @example Basic usage
+#   EditorjsRenderer.configure do |config|
+#     config.enabled_blocks = %w[paragraph]
+#   end
+module EditorjsRenderer
+  # Base error class for all EditorjsRenderer-specific exceptions.
+  # All library-level exceptions should inherit from this class.
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :css_name_prefix, :logger
+
+    def root
+      File.expand_path("..", __dir__)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def logger
+      @logger ||= Logger.new($stdout, progname: "EditorjsRenderer", level: Logger::INFO)
+    end
+
+    def css_name_prefix
+      @css_name_prefix ||= "editor_js--"
+    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"

data/sig/editor_rails.rbs

@@ -0,0 +1,4 @@
+module EditorjsRenderer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: editorjs_renderer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Georgy Shcherbakov
+- Sergey Arkhipov
+- Grigory Paraschevin
+bindir: bin
+cert_chain: []
+date: 2025-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: Library for rendering and validating Editor.js documents in Rails applications
+email:
+- lordsynergymail@gmail.com
+- sergey-arkhipov@ya.ru
+- nedprofit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/editorjs_renderer.rb
+- lib/editorjs_renderer/blocks/base.rb
+- lib/editorjs_renderer/blocks/paragraph.rb
+- lib/editorjs_renderer/blocks/spoiler.rb
+- lib/editorjs_renderer/blocks/table.rb
+- lib/editorjs_renderer/config.rb
+- lib/editorjs_renderer/document.rb
+- lib/editorjs_renderer/errors.rb
+- lib/editorjs_renderer/renderers/html_renderer.rb
+- lib/editorjs_renderer/renderers/plain_renderer.rb
+- lib/editorjs_renderer/schema_validator.rb
+- lib/editorjs_renderer/schemas/document.yml
+- lib/editorjs_renderer/schemas/paragraph.yml
+- lib/editorjs_renderer/schemas/spoiler.yml
+- lib/editorjs_renderer/schemas/table.yml
+- lib/editorjs_renderer/version.rb
+- sig/editor_rails.rbs
+homepage: https://github.com/lordsynergy/editorjs_renderer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lordsynergy/editorjs_renderer
+  documentation_uri: https://github.com/lordsynergy/editorjs_renderer#readme
+  changelog_uri: https://github.com/lordsynergy/editorjs_renderer/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/lordsynergy/editorjs_renderer
+  bug_tracker_uri: https://github.com/lordsynergy/editorjs_renderer/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Editor.js renderer for Ruby on Rails
+test_files: []