panda-editor 0.2.1 → 0.4.0

data/lib/panda/editor/engine.rb

@@ -12,13 +12,9 @@ module Panda
         g.test_framework :rspec
       end
 
-      # Allow applications to configure editor tools
-      config.editor_js_tools = []
-
-      # Custom block renderers
-      config.custom_renderers = {}
-
       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.precompile += %w[panda/editor/*.js panda/editor/*.css]

data/lib/panda/editor/footnote_registry.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require "redcarpet"
+
+module Panda
+  module Editor
+    class FootnoteRegistry
+      attr_reader :footnotes
+
+      def initialize(autolink_urls: false, markdown: false)
+        @footnotes = []
+        @footnote_ids = {}
+        @autolink_urls = autolink_urls
+        @markdown = markdown
+      end
+
+      def add(id:, content:)
+        # Return existing number if this ID was already registered
+        return @footnote_ids[id] if @footnote_ids[id]
+
+        # Add new footnote
+        @footnotes << {id: id, content: content}
+        number = @footnotes.length
+
+        # Cache the number for this ID
+        @footnote_ids[id] = number
+
+        number
+      end
+
+      def render_sources_section
+        return "" if @footnotes.empty?
+
+        footnote_items = @footnotes.map.with_index do |footnote, index|
+          number = index + 1
+          content = process_content(footnote[:content])
+          <<~HTML.strip
+            <li id="fn:#{number}">
+              <p>
+                #{content}
+                <a href="#fnref:#{number}" class="footnote-backref">↩</a>
+              </p>
+            </li>
+          HTML
+        end.join("\n")
+
+        <<~HTML
+          <div class="mx-6 lg:mx-8 mt-4 mb-8">
+            <div class="footnotes-section bg-gray-50 rounded-lg overflow-hidden">
+              <button class="footnotes-header w-full px-4 py-3 flex items-center justify-between cursor-pointer hover:bg-gray-100 transition-colors" data-footnotes-target="toggle" data-action="click->footnotes#toggle">
+                <h3 class="text-sm font-unbounded font-medium text-gray-900 m-0">Sources/References</h3>
+                <svg class="footnotes-chevron w-5 h-5 text-gray-600" data-footnotes-target="chevron" fill="none" stroke="currentColor" viewBox="0 0 24 24">
+                  <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M19 9l-7 7-7-7"></path>
+                </svg>
+              </button>
+              <div class="footnotes-content" data-footnotes-target="content">
+                <ol class="footnotes text-sm text-gray-700 space-y-2 px-4 pb-3">
+          #{footnote_items}
+                </ol>
+              </div>
+            </div>
+          </div>
+        HTML
+      end
+
+      def any?
+        @footnotes.any?
+      end
+
+      private
+
+      def process_content(content)
+        # Apply markdown processing if enabled
+        content = render_markdown(content) if @markdown
+
+        # Apply URL autolinking if enabled
+        # Note: Markdown already includes autolink, but custom autolink_urls can still be used
+        # if needed for additional URL patterns. The autolink_urls method skips already-linked URLs.
+        content = autolink_urls(content) if @autolink_urls
+
+        content
+      end
+
+      def render_markdown(text)
+        # Configure Redcarpet with safe options for footnotes
+        renderer = Redcarpet::Render::HTML.new(
+          filter_html: false,
+          no_images: true,
+          no_styles: true,
+          safe_links_only: true,
+          link_attributes: {target: "_blank", rel: "noopener noreferrer"}
+        )
+
+        markdown = Redcarpet::Markdown.new(
+          renderer,
+          autolink: true,
+          space_after_headers: true,
+          fenced_code_blocks: false,
+          no_intra_emphasis: true,
+          strikethrough: true,
+          superscript: false,
+          underline: false
+        )
+
+        # Render markdown and strip the wrapping <p> tags if present
+        # since we're already wrapping in <p> tags in the template
+        html = markdown.render(text).strip
+        html.gsub(%r{^<p>(.*)</p>$}m, '\1')
+      end
+
+      def autolink_urls(text)
+        # Regex to match URLs that aren't already in <a> tags
+        # Matches http://, https://, and other common protocols
+        url_pattern = %r{
+          (?<!["'>])                           # Not preceded by quotes or >
+          \b                                    # Word boundary
+          (https?://|ftp://|www\.)             # Protocol or www
+          [^\s<>"']+                           # URL characters (not whitespace, <, >, quotes)
+          [^\s<>"'.,;:!?)\]]                   # Ends with non-punctuation
+        }x
+
+        # Don't replace URLs that are already in <a> tags
+        text.gsub(url_pattern) do |url|
+          # Skip if this URL is already part of an href attribute
+          before_match = $`
+          if /<a[^>]*href\s*=\s*["']?\z/i.match?(before_match)
+            url
+          else
+            # Add protocol if missing
+            full_url = url.start_with?("www.") ? "https://#{url}" : url
+            %(<a href="#{full_url}" target="_blank" rel="noopener noreferrer">#{url}</a>)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/panda/editor/renderer.rb

@@ -5,7 +5,7 @@ require "sanitize"
 module Panda
   module Editor
     class Renderer
-      attr_reader :content, :options, :custom_renderers, :cache_store
+      attr_reader :content, :options, :custom_renderers, :cache_store, :footnote_registry
 
       def initialize(content, options = {})
         @content = content
@@ -13,6 +13,10 @@ module Panda
         @custom_renderers = options.delete(:custom_renderers) || {}
         @cache_store = options.delete(:cache_store) || Rails.cache
         @validate_html = options.delete(:validate_html) || false
+        autolink_urls = options.delete(:autolink_urls) || false
+        markdown = options.delete(:markdown) || false
+        @footnote_registry = FootnoteRegistry.new(autolink_urls: autolink_urls, markdown: markdown)
+        @options[:footnote_registry] = @footnote_registry
       end
 
       def render
@@ -24,6 +28,13 @@ module Panda
         end.join("\n")
 
         rendered = @validate_html ? validate_html(rendered) : rendered
+
+        # Append sources section if footnotes were collected
+        if @footnote_registry.any?
+          sources_section = @footnote_registry.render_sources_section
+          rendered = [rendered, sources_section].join("\n")
+        end
+
         rendered.presence || ""
       end
 
@@ -84,6 +95,12 @@ module Panda
       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?
+          renderer = renderer_for(block)
+          return renderer.render
+        end
+
         cache_key = "editor_js_block/#{block["type"]}/#{Digest::MD5.hexdigest(block["data"].to_json)}"
 
         cache_store.fetch(cache_key) do

data/lib/panda/editor/version.rb

@@ -2,6 +2,6 @@
 
 module Panda
   module Editor
-    VERSION = "0.2.1"
+    VERSION = "0.4.0"
   end
 end

data/lib/panda/editor.rb

@@ -1,15 +1,26 @@
 # frozen_string_literal: true
 
+require "dry-configurable"
 require_relative "editor/version"
 require_relative "editor/engine"
 
 module Panda
   module Editor
+    extend Dry::Configurable
+
+    # EditorJS configuration
+    setting :editor_js_tools, default: []
+    setting :editor_js_tool_config, default: {}
+
+    # Custom block renderers
+    setting :custom_renderers, default: {}
+
     class Error < StandardError; end
 
     # Autoload components
     autoload :Renderer, "panda/editor/renderer"
     autoload :Content, "panda/editor/content"
+    autoload :FootnoteRegistry, "panda/editor/footnote_registry"
 
     module Blocks
       autoload :Base, "panda/editor/blocks/base"

data/panda-editor.gemspec

@@ -5,8 +5,8 @@ require_relative "lib/panda/editor/version"
 Gem::Specification.new do |spec|
   spec.name = "panda-editor"
   spec.version = Panda::Editor::VERSION
-  spec.authors = ["Panda CMS Team"]
-  spec.email = ["hello@pandacms.io"]
+  spec.authors = ["Otaina Limited", "James Inman"]
+  spec.email = ["james@otaina.co.uk"]
 
   spec.summary = "EditorJS integration for Rails applications"
   spec.description = "A modular, extensible rich text editor using EditorJS for Rails applications. Extracted from Panda CMS."
@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   # Rails dependencies
   spec.add_dependency "rails", ">= 7.1"
   spec.add_dependency "sanitize", "~> 6.0"
+  spec.add_dependency "dry-configurable", "~> 1.0"
+  spec.add_dependency "redcarpet", "~> 3.6"
 
   # Development dependencies
   spec.add_development_dependency "rspec-rails", "~> 6.0"