panda-editor 0.6.0 → 0.8.2

data/lib/panda/editor/blocks/paragraph.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
+require "cgi"
+
 module Panda
   module Editor
     module Blocks
       class Paragraph < Base
         def render
-          content = sanitize(data['text'])
-          return '' if content.blank?
+          content = sanitize(data["text"])
+          return "" if content.blank?
 
-          content = inject_footnotes(content) if data['footnotes'].present?
+          content = inject_footnotes(content) if data["footnotes"].present?
 
           html_safe("<p>#{content}</p>")
         end
@@ -16,13 +18,13 @@ module Panda
         private
 
         def inject_footnotes(text)
-          return text unless data['footnotes'].is_a?(Array)
+          return text unless data["footnotes"].is_a?(Array)
 
           # Sort footnotes by position in descending order to avoid position shifts
-          footnotes = data['footnotes'].sort_by { |fn| -fn['position'].to_i }
+          footnotes = data["footnotes"].sort_by { |fn| -fn["position"].to_i }
 
           footnotes.each do |footnote|
-            position = footnote['position'].to_i
+            position = footnote["position"].to_i
             # Skip if position is beyond text length
             next if position.negative? || position > text.length
 
@@ -30,8 +32,11 @@ module Panda
             footnote_number = register_footnote(footnote)
             next unless footnote_number
 
-            # Create footnote marker
-            marker = "<sup id=\"fnref:#{footnote_number}\"><a href=\"#fn:#{footnote_number}\" class=\"footnote\">#{footnote_number}</a></sup>"
+            # Get processed content for tooltip
+            tooltip_content = get_tooltip_content(footnote["id"])
+
+            # Create footnote marker with tooltip support
+            marker = create_footnote_marker(footnote_number, tooltip_content)
 
             # Insert marker at position
             text.insert(position, marker)
@@ -44,10 +49,36 @@ module Panda
           return nil unless options[:footnote_registry]
 
           options[:footnote_registry].add(
-            id: footnote['id'],
-            content: footnote['content']
+            id: footnote["id"],
+            content: footnote["content"]
           )
         end
+
+        def get_tooltip_content(footnote_id)
+          return nil unless options[:footnote_registry]
+
+          options[:footnote_registry].get_content(footnote_id)
+        end
+
+        def create_footnote_marker(number, tooltip_content)
+          # Strip HTML tags for title attribute (simple tooltip fallback)
+          plain_content = tooltip_content ? strip_html(tooltip_content) : nil
+
+          # Build marker with tooltip support
+          if tooltip_content
+            # Include both title attribute (native browser tooltip) and data attribute (for custom tooltips)
+            escaped_content = CGI.escapeHTML(tooltip_content)
+            escaped_title = CGI.escapeHTML(plain_content || "")
+            %(<sup id="fnref:#{number}" class="footnote-ref" data-footnote-content="#{escaped_content}" title="#{escaped_title}"><a href="#fn:#{number}" class="footnote">#{number}</a></sup>)
+          else
+            # Fallback without tooltip
+            %(<sup id="fnref:#{number}"><a href="#fn:#{number}" class="footnote">#{number}</a></sup>)
+          end
+        end
+
+        def strip_html(html)
+          html.gsub(/<\/?[^>]*>/, "")
+        end
       end
     end
   end

data/lib/panda/editor/blocks/quote.rb

@@ -5,15 +5,15 @@ module Panda
     module Blocks
       class Quote < Base
         def render
-          text = data['text']
-          caption = data['caption']
-          alignment = data['alignment'] || 'left'
+          text = data["text"]
+          caption = data["caption"]
+          alignment = data["alignment"] || "left"
 
           # Build the HTML structure
           html = "<figure class=\"text-#{alignment}\">" \
             "<blockquote>#{wrap_text_in_p(text)}</blockquote>" \
             "#{caption_element(caption)}" \
-            '</figure>'
+            "</figure>"
 
           # Return raw HTML - validation will be handled by the main renderer if enabled
           html_safe(html)
@@ -24,7 +24,7 @@ module Panda
         def wrap_text_in_p(text)
           # Only wrap in <p> if it's not already wrapped
           text = sanitize(text)
-          if text.start_with?('<p>') && text.end_with?('</p>')
+          if text.start_with?("<p>") && text.end_with?("</p>")
             text
           else
             "<p>#{text}</p>"
@@ -32,7 +32,7 @@ module Panda
         end
 
         def caption_element(caption)
-          return '' if caption.blank?
+          return "" if caption.blank?
 
           "<figcaption>#{sanitize(caption)}</figcaption>"
         end

data/lib/panda/editor/blocks/table.rb

@@ -5,8 +5,8 @@ module Panda
     module Blocks
       class Table < Base
         def render
-          content = data['content']
-          with_headings = data['withHeadings']
+          content = data["content"]
+          with_headings = data["withHeadings"]
 
           html_safe(<<~HTML)
             <div class="overflow-x-auto">
@@ -25,10 +25,10 @@ module Panda
 
           while index < content.length
             rows << if index.zero? && with_headings
-                      render_header_row(content[index])
-                    else
-                      render_data_row(content[index])
-                    end
+              render_header_row(content[index])
+            else
+              render_data_row(content[index])
+            end
             index += 1
           end
 

data/lib/panda/editor/content.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 module Panda
   module Editor
@@ -36,21 +36,24 @@ module Panda
       end
 
       def generate_cached_content
-        renderer_options = { autolink_urls: true }
+        renderer_options = {
+          autolink_urls: true,
+          custom_renderers: Panda::Editor.config.custom_renderers
+        }
 
         if content.is_a?(String)
           begin
             parsed_content = JSON.parse(content)
-            self.cached_content = if parsed_content.is_a?(Hash) && parsed_content['blocks'].present?
-                                    Panda::Editor::Renderer.new(parsed_content, renderer_options).render
-                                  else
-                                    content
-                                  end
+            self.cached_content = if parsed_content.is_a?(Hash) && parsed_content["blocks"].present?
+              Panda::Editor::Renderer.new(parsed_content, renderer_options).render
+            else
+              content
+            end
           rescue JSON::ParserError
             # If it's not JSON, treat it as plain text
             self.cached_content = content
           end
-        elsif content.is_a?(Hash) && content['blocks'].present?
+        elsif content.is_a?(Hash) && content["blocks"].present?
           # Process EditorJS content
           self.cached_content = Panda::Editor::Renderer.new(content, renderer_options).render
         else

data/lib/panda/editor/engine.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
-require 'rails'
-require 'sanitize'
+require "rails"
+require "sanitize"
+
+# Ensure panda-core is loaded first (provides ModuleRegistry)
+require "panda/core"
+require "panda/core/engine" if defined?(Rails)
 
 module Panda
   module Editor
@@ -14,21 +18,37 @@ module Panda
 
       # Eager load converter classes
       config.to_prepare do
-        require 'panda/editor/markdown_to_editor_js_converter'
-        require 'panda/editor/html_to_editor_js_converter'
+        require "panda/editor/markdown_to_editor_js_converter"
+        require "panda/editor/html_to_editor_js_converter"
       end
 
-      initializer 'panda_editor.assets' do |app|
+      initializer "panda_editor.assets" do |app|
         next unless app.config.respond_to?(:assets)
 
-        app.config.assets.paths << root.join('app/javascript')
-        app.config.assets.paths << root.join('public')
+        app.config.assets.paths << root.join("app/javascript")
+        app.config.assets.paths << root.join("public")
         app.config.assets.precompile += %w[panda/editor/*.js panda/editor/*.css]
       end
 
-      initializer 'panda_editor.importmap', before: 'importmap' do |app|
-        app.config.importmap.paths << root.join('config/importmap.rb') if app.config.respond_to?(:importmap)
+      # Create a separate importmap for panda-editor
+      # This keeps the engine's JavaScript separate from the app's importmap
+      # Admin uses panda_core_javascript helper which reads from ModuleRegistry
+      initializer "panda_editor.importmap", before: "importmap" do |app|
+        Panda::Editor.importmap = Importmap::Map.new.tap do |map|
+          map.draw(Panda::Editor::Engine.root.join("config/importmap.rb"))
+        end
       end
     end
   end
 end
+
+# Register with ModuleRegistry so admin can access the importmap
+Panda::Core::ModuleRegistry.register(
+  gem_name: "panda-editor",
+  engine: "Panda::Editor::Engine",
+  paths: {
+    views: "app/views/panda/editor/**/*.erb",
+    components: "app/components/panda/editor/**/*.rb",
+    javascripts: "app/javascript/panda/editor/**/*.js"
+  }
+)

data/lib/panda/editor/footnote_registry.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'redcarpet'
+require "redcarpet"
 
 module Panda
   module Editor
@@ -19,7 +19,7 @@ module Panda
         return @footnote_ids[id] if @footnote_ids[id]
 
         # Add new footnote
-        @footnotes << { id: id, content: content }
+        @footnotes << {id: id, content: content}
         number = @footnotes.length
 
         # Cache the number for this ID
@@ -29,7 +29,7 @@ module Panda
       end
 
       def render_sources_section
-        return '' if @footnotes.empty?
+        return "" if @footnotes.empty?
 
         footnote_items = @footnotes.map.with_index do |footnote, index|
           number = index + 1
@@ -67,6 +67,11 @@ module Panda
         @footnotes.any?
       end
 
+      def get_content(id)
+        footnote = @footnotes.find { |fn| fn[:id] == id }
+        footnote ? process_content(footnote[:content]) : nil
+      end
+
       private
 
       def process_content(content)
@@ -88,7 +93,7 @@ module Panda
           no_images: true,
           no_styles: true,
           safe_links_only: true,
-          link_attributes: { target: '_blank', rel: 'noopener noreferrer' }
+          link_attributes: {target: "_blank", rel: "noopener noreferrer"}
         )
 
         markdown = Redcarpet::Markdown.new(
@@ -127,7 +132,7 @@ module Panda
             url
           else
             # Add protocol if missing
-            full_url = url.start_with?('www.') ? "https://#{url}" : url
+            full_url = url.start_with?("www.") ? "https://#{url}" : url
             %(<a href="#{full_url}" target="_blank" rel="noopener noreferrer">#{url}</a>)
           end
         end

data/lib/panda/editor/html_to_editor_js_converter.rb

@@ -95,7 +95,7 @@ module Panda
       end
 
       def list_block(node)
-        style = node.name == "ol" ? "ordered" : "unordered"
+        style = (node.name == "ol") ? "ordered" : "unordered"
         items = node.css("li").map { |li| li.inner_html.strip }
 
         {

data/lib/panda/editor/renderer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'sanitize'
+require "sanitize"
 
 module Panda
   module Editor
@@ -20,10 +20,10 @@ module Panda
       end
 
       def render
-        return '' if content.nil? || content == {}
-        return content.to_s unless content.is_a?(Hash) && content['blocks'].is_a?(Array)
+        return "" if content.nil? || content == {}
+        return content.to_s unless content.is_a?(Hash) && content["blocks"].is_a?(Array)
 
-        rendered = content['blocks'].map do |block|
+        rendered = content["blocks"].map do |block|
           render_block(block)
         end.join("\n")
 
@@ -35,36 +35,36 @@ module Panda
           rendered = [rendered, sources_section].join("\n")
         end
 
-        rendered.presence || ''
+        rendered.presence || ""
       end
 
       def section(blocks)
-        return '' if blocks.nil? || blocks.empty?
+        return "" if blocks.nil? || blocks.empty?
 
-        content = { 'blocks' => blocks }
+        content = {"blocks" => blocks}
         rendered = self.class.new(content, options).render
 
         "<section class=\"content-section\">#{rendered}</section>"
       end
 
       def article(blocks, title: nil)
-        return '' if blocks.nil? || blocks.empty?
+        return "" if blocks.nil? || blocks.empty?
 
-        content = { 'blocks' => blocks }
+        content = {"blocks" => blocks}
         rendered = self.class.new(content, options).render
 
         [
-          '<article>',
-          (title ? "<h1>#{title}</h1>" : ''),
+          "<article>",
+          (title ? "<h1>#{title}</h1>" : ""),
           rendered,
-          '</article>'
+          "</article>"
         ].join("\n")
       end
 
       private
 
       def validate_html(html)
-        return '' if html.blank?
+        return "" if html.blank?
 
         begin
           # For quote blocks, only allow specific content
@@ -73,35 +73,35 @@ module Panda
             valid_content = '<figure class="text-left"><blockquote><p>Valid HTML</p></blockquote><figcaption>Valid caption</figcaption></figure>'
             return html if html.strip == valid_content.strip
 
-            return ''
+            return ""
           end
 
           # For other HTML, use sanitize
           config = Sanitize::Config::RELAXED.dup
           config[:elements] += %w[figure figcaption blockquote pre code mention math]
           config[:attributes].merge!({
-                                       'figure' => ['class'],
-                                       'blockquote' => ['class'],
-                                       'p' => ['class'],
-                                       'figcaption' => ['class']
-                                     })
+            "figure" => ["class"],
+            "blockquote" => ["class"],
+            "p" => ["class"],
+            "figcaption" => ["class"]
+          })
 
           sanitized = Sanitize.fragment(html, config)
-          sanitized == html ? html : ''
-        rescue StandardError => e
+          (sanitized == html) ? html : ""
+        rescue => e
           Rails.logger.error("HTML validation error: #{e.message}")
-          ''
+          ""
         end
       end
 
       def render_block_with_cache(block)
         # Don't cache blocks with footnotes - they need to register with the footnote registry
-        if block['data']['footnotes'].present?
+        if block["data"]["footnotes"].present?
           renderer = renderer_for(block)
           return renderer.render
         end
 
-        cache_key = "editor_js_block/#{block['type']}/#{Digest::MD5.hexdigest(block['data'].to_json)}"
+        cache_key = "editor_js_block/#{block["type"]}/#{Digest::MD5.hexdigest(block["data"].to_json)}"
 
         cache_store.fetch(cache_key) do
           renderer = renderer_for(block)
@@ -110,28 +110,28 @@ module Panda
       end
 
       def renderer_for(block)
-        if custom_renderers[block['type']]
-          custom_renderers[block['type']].new(block['data'], options)
+        if custom_renderers[block["type"]]
+          custom_renderers[block["type"]].new(block["data"], options)
         else
           default_renderer_for(block)
         end
       end
 
       def default_renderer_for(block)
-        renderer_class = "Panda::Editor::Blocks::#{block['type'].classify}".constantize
-        renderer_class.new(block['data'], options)
+        renderer_class = "Panda::Editor::Blocks::#{block["type"].classify}".constantize
+        renderer_class.new(block["data"], options)
       rescue NameError
-        Panda::Editor::Blocks::Base.new(block['data'], options)
+        Panda::Editor::Blocks::Base.new(block["data"], options)
       end
 
       def remove_empty_paragraphs(blocks)
         blocks.reject do |block|
-          block['type'] == 'paragraph' && block['data']['text'].blank?
+          block["type"] == "paragraph" && block["data"]["text"].blank?
         end
       end
 
       def empty_paragraph?(block)
-        block['type'] == 'paragraph' && block['data']['text'].blank?
+        block["type"] == "paragraph" && block["data"]["text"].blank?
       end
 
       def render_block(block)

data/lib/panda/editor/version.rb

@@ -2,6 +2,6 @@
 
 module Panda
   module Editor
-    VERSION = '0.6.0'
+    VERSION = "0.8.2"
   end
 end

data/lib/panda/editor.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
-require 'dry-configurable'
-require_relative 'editor/version'
-require_relative 'editor/engine'
+require "dry-configurable"
+require_relative "editor/version"
+require_relative "editor/engine"
 
 module Panda
   module Editor
     extend Dry::Configurable
 
+    mattr_accessor :importmap
+
     # EditorJS configuration
     setting :editor_js_tools, default: []
     setting :editor_js_tool_config, default: {}
@@ -18,21 +20,21 @@ module Panda
     class Error < StandardError; end
 
     # Require components
-    require_relative 'editor/renderer'
-    require_relative 'editor/content'
-    require_relative 'editor/footnote_registry'
-    require_relative 'editor/markdown_to_editor_js_converter'
-    require_relative 'editor/html_to_editor_js_converter'
+    require_relative "editor/renderer"
+    require_relative "editor/content"
+    require_relative "editor/footnote_registry"
+    require_relative "editor/markdown_to_editor_js_converter"
+    require_relative "editor/html_to_editor_js_converter"
 
     module Blocks
-      autoload :Base, 'panda/editor/blocks/base'
-      autoload :Alert, 'panda/editor/blocks/alert'
-      autoload :Header, 'panda/editor/blocks/header'
-      autoload :Image, 'panda/editor/blocks/image'
-      autoload :List, 'panda/editor/blocks/list'
-      autoload :Paragraph, 'panda/editor/blocks/paragraph'
-      autoload :Quote, 'panda/editor/blocks/quote'
-      autoload :Table, 'panda/editor/blocks/table'
+      autoload :Base, "panda/editor/blocks/base"
+      autoload :Alert, "panda/editor/blocks/alert"
+      autoload :Header, "panda/editor/blocks/header"
+      autoload :Image, "panda/editor/blocks/image"
+      autoload :List, "panda/editor/blocks/list"
+      autoload :Paragraph, "panda/editor/blocks/paragraph"
+      autoload :Quote, "panda/editor/blocks/quote"
+      autoload :Table, "panda/editor/blocks/table"
     end
   end
 end

data/lib/tasks/assets.rake

@@ -2,14 +2,14 @@
 
 namespace :panda_editor do
   namespace :assets do
-    desc 'Compile Panda Editor assets for production'
+    desc "Compile Panda Editor assets for production"
     task compile: :environment do
-      require 'fileutils'
+      require "fileutils"
 
-      puts 'Compiling Panda Editor assets...'
+      puts "Compiling Panda Editor assets..."
 
       # Create temporary directory for assets
-      tmp_dir = Rails.root.join('tmp', 'panda_editor_assets')
+      tmp_dir = Rails.root.join("tmp", "panda_editor_assets")
       FileUtils.mkdir_p(tmp_dir)
 
       # Get version from gem
@@ -22,51 +22,51 @@ namespace :panda_editor do
       compile_css(tmp_dir, version)
 
       # Copy to public directory
-      public_dir = Rails.root.join('public', 'panda-editor-assets')
+      public_dir = Rails.root.join("public", "panda-editor-assets")
       FileUtils.mkdir_p(public_dir)
-      FileUtils.cp_r(Dir.glob(tmp_dir.join('*')), public_dir)
+      FileUtils.cp_r(Dir.glob(tmp_dir.join("*")), public_dir)
 
-      puts '✅ Assets compiled successfully'
+      puts "✅ Assets compiled successfully"
     end
 
-    desc 'Download Panda Editor assets from GitHub'
+    desc "Download Panda Editor assets from GitHub"
     task download: :environment do
-      require 'panda/editor/asset_loader'
+      require "panda/editor/asset_loader"
 
-      puts 'Downloading Panda Editor assets from GitHub...'
+      puts "Downloading Panda Editor assets from GitHub..."
       Panda::Editor::AssetLoader.send(:download_assets_from_github)
-      puts '✅ Assets downloaded successfully'
+      puts "✅ Assets downloaded successfully"
     end
 
-    desc 'Upload compiled assets to GitHub release'
+    desc "Upload compiled assets to GitHub release"
     task upload: :environment do
-      require 'net/http'
-      require 'json'
+      require "net/http"
+      require "json"
 
-      puts 'Uploading Panda Editor assets to GitHub release...'
+      puts "Uploading Panda Editor assets to GitHub release..."
 
       # This task would be run in CI to upload compiled assets
       # to the GitHub release when a new version is tagged
 
-      version = ENV['GITHUB_REF_NAME'] || "v#{Panda::Editor::VERSION}"
-      token = ENV['GITHUB_TOKEN']
+      version = ENV["GITHUB_REF_NAME"] || "v#{Panda::Editor::VERSION}"
+      token = ENV["GITHUB_TOKEN"]
 
       unless token
-        puts '❌ GITHUB_TOKEN environment variable required'
+        puts "❌ GITHUB_TOKEN environment variable required"
         exit 1
       end
 
       # Find compiled assets
-      assets_dir = Rails.root.join('public', 'panda-editor-assets')
-      js_file = Dir.glob(assets_dir.join('panda-editor-*.js')).first
-      css_file = Dir.glob(assets_dir.join('panda-editor-*.css')).first
+      assets_dir = Rails.root.join("public", "panda-editor-assets")
+      js_file = Dir.glob(assets_dir.join("panda-editor-*.js")).first
+      css_file = Dir.glob(assets_dir.join("panda-editor-*.css")).first
 
       if js_file && css_file
         upload_to_release(js_file, version, token)
         upload_to_release(css_file, version, token)
-        puts '✅ Assets uploaded successfully'
+        puts "✅ Assets uploaded successfully"
       else
-        puts '❌ Compiled assets not found'
+        puts "❌ Compiled assets not found"
         exit 1
       end
     end
@@ -74,9 +74,9 @@ namespace :panda_editor do
     private
 
     def compile_javascript(tmp_dir, version)
-      puts '  Compiling JavaScript...'
+      puts "  Compiling JavaScript..."
 
-      js_files = Dir.glob(Panda::Editor::Engine.root.join('app/javascript/panda/editor/**/*.js'))
+      js_files = Dir.glob(Panda::Editor::Engine.root.join("app/javascript/panda/editor/**/*.js"))
 
       output = js_files.map { |file| File.read(file) }.join("\n\n")
 
@@ -88,9 +88,9 @@ namespace :panda_editor do
     end
 
     def compile_css(tmp_dir, version)
-      puts '  Compiling CSS...'
+      puts "  Compiling CSS..."
 
-      css_files = Dir.glob(Panda::Editor::Engine.root.join('app/assets/stylesheets/panda/editor/**/*.css'))
+      css_files = Dir.glob(Panda::Editor::Engine.root.join("app/assets/stylesheets/panda/editor/**/*.css"))
 
       output = css_files.map { |file| File.read(file) }.join("\n\n")
 

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "4.0.0"