embeddable_content 0.1.19

data/app/services/embeddable_content/images/node_processor.rb

@@ -0,0 +1,91 @@
+module EmbeddableContent
+  module Images
+    class NodeProcessor < EmbeddableContent::VisualElementNodeProcessor
+      delegate :target, :image_catalog, to: :embedder
+      delegate :attribution, :long_description, :label, :alt_text,
+               to: :record
+
+      def modal_dialog
+        @modal_dialog = ModalDialog.new self
+      end
+
+      def img_tag_attrs
+        @img_tag_attrs ||= ImgTagAttributes.new(self).to_h
+      end
+
+      TARGETS_THAT_DISPLAY_A_MODAL_DIALOG = %i[web].freeze
+      def display_modal_dialog?
+        TARGETS_THAT_DISPLAY_A_MODAL_DIALOG.include? target.to_sym
+      end
+
+      TARGETS_THAT_USE_DIV_TAGS    = %i[editable].freeze
+      TARGETS_THAT_USE_FIGURE_TAGS = %i[cms print web exported qti cc schoology]
+                                     .freeze
+      def figure_tag
+        case target
+        when *TARGETS_THAT_USE_DIV_TAGS     then :div
+        when *TARGETS_THAT_USE_FIGURE_TAGS  then :figure
+        else raise "Undefined tag for target: #{target}"
+        end
+      end
+
+      def node_can_be_removed?
+        false
+      end
+
+      def node_selector_class
+        [super, 'embedded-content-image'].join ' '
+      end
+
+      private
+
+      def catalog_image
+        image_catalog << record
+      end
+
+      def replace_node
+        record.render_svg if svg_should_be_rendered?
+        catalog_image     if image_should_be_catalogued?
+
+        super
+      end
+
+      def svg_should_be_rendered?
+        config.render_images?              &&
+          record_model.requires_rendering? &&
+          attachment_status_matters?       &&
+          attachment_unavailable?
+      end
+
+      def attachment_unavailable?
+        !attached_file.attached? ||
+          !attachment_url_response_status_ok?
+      end
+
+      def attachment_url_response_status_ok?
+        attachment_url_response.instance_of? Net::HTTPOK
+      end
+
+      def attachment_url_response
+        @attachment_url_response ||= Net::HTTP.get_response s3_ttl_service_uri
+      end
+
+      def s3_ttl_service_uri
+        @s3_ttl_service_uri ||= URI.parse s3_ttl_service_url
+      end
+
+      def attachment_status_matters?
+        Rails.env.production? &&
+          ENV['VERIFY_ATTACHMENT_STATUS'].eql?('true')
+      end
+
+      def image_should_be_catalogued?
+        record.present? && attribution.present?
+      end
+
+      def route_keys
+        %i[tikz_files image_files]
+      end
+    end
+  end
+end

data/app/services/embeddable_content/images/shared.rb

@@ -0,0 +1,11 @@
+module EmbeddableContent
+  module Images
+    module Shared
+      private
+
+      def strip_tags(html)
+        Nokogiri::HTML.fragment(html).text.strip
+      end
+    end
+  end
+end

data/app/services/embeddable_content/node_processor.rb

@@ -0,0 +1,75 @@
+module EmbeddableContent
+  class NodeProcessor < EmbedderBase
+    NODE_CAN_BE_REMOVED_BY_DEFAULT   = true
+    SELECTOR_CLASS_BLANK_BY_DEFAULT  = nil
+    RECORD_BLANK_BY_DEFAULT          = nil
+    ALL_TARGETS_PROCESSED_BY_DEFAULT = EmbedderConfig::ALL_TARGETS
+    DEFAULT_TEMPLATE_MANAGER_CLASS   = TemplateManager
+    ADDED_CLASSES_BLANK_BY_DEFAULT   = [].freeze
+
+    attr_reader :node, :node_index, :doc_processor, :error
+
+    delegate :embedder,     to: :doc_processor
+    delegate :warning_node, to: :template_manager
+
+    def initialize(doc_processor, node, node_index)
+      @doc_processor  = doc_processor
+      @node           = node
+      @node_index     = node_index
+      super embedder.config, embedder.options
+    end
+
+    def process!
+      process_node || remove_node
+    rescue StandardError => e
+      @error = e
+      node.replace warning_node
+    end
+
+    def node_selector_class
+      SELECTOR_CLASS_BLANK_BY_DEFAULT
+    end
+
+    def node_added_classes
+      ADDED_CLASSES_BLANK_BY_DEFAULT
+    end
+
+    def record
+      RECORD_BLANK_BY_DEFAULT
+    end
+
+    private
+
+    def process_node
+      replace_node if node_should_be_replaced?
+    end
+
+    def node_should_be_replaced?
+      targets_that_require_processing.include? target
+    end
+
+    def targets_that_require_processing
+      ALL_TARGETS_PROCESSED_BY_DEFAULT
+    end
+
+    def replace_node
+      raise 'implement in a subclass'
+    end
+
+    def remove_node
+      node.remove if node_can_be_removed?
+    end
+
+    def node_can_be_removed?
+      NODE_CAN_BE_REMOVED_BY_DEFAULT
+    end
+
+    def template_manager
+      @template_manager ||= template_manager_class.new self
+    end
+
+    def template_manager_class
+      DEFAULT_TEMPLATE_MANAGER_CLASS
+    end
+  end
+end

data/app/services/embeddable_content/presentation_tags/doc_processor.rb

@@ -0,0 +1,5 @@
+module EmbeddableContent
+  module PresentationTags
+    class DocProcessor < EmbeddableContent::DocProcessor; end
+  end
+end

data/app/services/embeddable_content/presentation_tags/node_processor.rb

@@ -0,0 +1,35 @@
+module EmbeddableContent
+  module PresentationTags
+    class NodeProcessor < EmbeddableContent::TreeBasedNodeProcessor
+      include TemplateBased
+
+      alias presentation_tag record
+
+      def node_added_classes
+        ['presentation-tag-classes-added',
+         presentation_tag.added_class].join ' '
+      end
+
+      private
+
+      delegate :template_based?, to: :presentation_tag
+
+      def replace_node
+        template_based? ? super : modify_parent
+      end
+
+      def modify_parent
+        parent_node.add_class node_added_classes
+        remove_node
+      end
+
+      def parent_node
+        @parent_node ||= node.parent
+      end
+
+      def targets_that_require_processing
+        %i[print]
+      end
+    end
+  end
+end

data/app/services/embeddable_content/record_node_processor.rb

@@ -0,0 +1,90 @@
+module EmbeddableContent
+  class RecordNodeProcessor < NodeProcessor
+    delegate :title, to: :record
+
+    def record_id
+      @record_id ||= tag_match_data[:id] if tag_references_record?
+    end
+
+    def record_model
+      @record_model ||= tag_match_data[:model].classify.constantize if
+        tag_references_record?
+    end
+
+    def record_css_id_for(type)
+      "#{type}-#{record_model}-#{record_id}"
+    end
+
+    def record
+      @record ||= target_scope.find record_id
+    end
+
+    def s3_url(with_extension: false)
+      with_extension ? s3_url_with_extension : bare_s3_url
+    end
+
+    def cms_url
+      src_url
+    end
+
+    def s3_ttl_service_url
+      if Rails.env.test?
+        Pathname
+          .new(ActiveStorage::Blob.service.send(:path_for, blob.key))
+          .relative_path_from Rails.root
+      else
+        blob.service_url(content_type: content_type)
+      end
+    end
+
+    def attached_file
+      record.file
+    end
+
+    def node_selector_class
+      "embedded-content-#{record_model.model_name.param_key.dasherize}"
+    end
+
+    private
+
+    delegate :s3_bucket,    to: :embedder
+    delegate :blob,         to: :attached_file
+    delegate :content_type, to: :blob
+
+    def bare_s3_url
+      "https://s3.amazonaws.com/#{s3_bucket}/#{blob_key}"
+    end
+
+    def s3_url_with_extension
+      "#{bare_s3_url}.#{blob.filename.extension}"
+    end
+
+    def blob_key
+      blob.key
+    end
+
+    def src_url
+      @src_url ||= node.attr 'src'
+    end
+
+    def tag_match_data
+      @tag_match_data ||= regex_src_url.match src_url
+    end
+
+    def regex_src_url
+      %r{\/(?<model>#{route_keys.join('|')})\/(?<id>\d+)\.(?<ext>\w+)}
+    end
+
+    def target_scope
+      record_model
+    end
+
+    def tag_references_record?
+      tag_match_data.present?
+    end
+
+    def node_should_be_replaced?
+      super && tag_match_data.present?
+    end
+  end
+end

data/app/services/embeddable_content/replacement_template_manager.rb

@@ -0,0 +1,21 @@
+module EmbeddableContent
+  class ReplacementTemplateManager < TemplateManager
+    def replacement_node
+      render_target || warning_node
+    end
+
+    private
+
+    def node_templates_subdir
+      @node_templates_subdir ||= node_type.underscore
+    end
+
+    def node_templates_path
+      @node_templates_path ||= templates_dir.join node_templates_subdir
+    end
+
+    def target_path
+      @target_path ||= node_templates_path.join target.to_s
+    end
+  end
+end

data/app/services/embeddable_content/sad_embedded_tags.rb

@@ -0,0 +1,29 @@
+module EmbeddableContent
+  class SadEmbeddedTags
+    attr_accessor :ed_node, :sad_related_records, :embedded_models
+
+    def initialize(ed_node, embedded_models)
+      @ed_node = ed_node
+      @sad_related_records = SadRelatedRecords.new ed_node
+      @embedded_models     = embedded_models
+    end
+
+    def each
+      @ed_node.tags.each do |tag|
+        tag.html_attrs.each do |attr|
+          EmbeddedTags.new(tag, attr, embedded_models).each do |info|
+            yield nil, nil, info
+          end
+        end
+      end
+
+      sad_related_records.each do |node, node_address, related_record|
+        related_record.html_attrs.each do |attr|
+          EmbeddedTags.new(related_record, attr, embedded_models).each do |info|
+            yield node, node_address, info
+          end
+        end
+      end
+    end
+  end
+end

data/app/services/embeddable_content/scrubber.rb

@@ -0,0 +1,32 @@
+module EmbeddableContent
+  class Scrubber < EmbedderBase
+    def scrub(document)
+      document.search(scrubbed_nodes_selector).remove
+      document
+    end
+
+    private
+
+    def scrubbed_nodes_selector
+      all_selectors.join ','
+    end
+
+    def all_selectors
+      selectors_for_other_targets <<
+        '.removed-for-all-embedder-targets' <<
+        selector_for_current_target
+    end
+
+    def selector_for_current_target
+      ".removed-for-#{target}-embedder-target"
+    end
+
+    def selectors_for_other_targets
+      all_other_targets.map { |tgt| selector_for_other_target tgt }
+    end
+
+    def selector_for_other_target(tgt)
+      ".removed-for-all-but-#{tgt}-embedder-target"
+    end
+  end
+end

data/app/services/embeddable_content/template_based.rb

@@ -0,0 +1,19 @@
+module EmbeddableContent
+  module TemplateBased
+    delegate :replacement_node, to: :template_manager
+
+    def node_type
+      @node_type ||= embedding_module.underscore
+    end
+
+    private
+
+    def replace_node
+      node.replace replacement_node
+    end
+
+    def template_manager_class
+      ReplacementTemplateManager
+    end
+  end
+end

data/app/services/embeddable_content/template_manager.rb

@@ -0,0 +1,100 @@
+module EmbeddableContent
+  class TemplateManager < EmbedderBase
+    DEFAULT_NUM_BACKTRACE_LINES = 10
+    NUM_BACKTRACE_LINES =
+      ENV.fetch('NUM_BACKTRACE_LINES', DEFAULT_NUM_BACKTRACE_LINES).try :to_i
+
+    attr_reader :node_processor
+
+    delegate :record, :node, :node_type, :error, :node_selector_class,
+             :node_added_classes, :node_index,
+             to: :node_processor
+
+    def initialize(node_processor)
+      @node_processor = node_processor
+      super node_processor.config, node_processor.options
+    end
+
+    def warning_node
+      render_path warning_node_path
+    end
+
+    def selected_backtrace_lines
+      return if error.nil?
+
+      error.backtrace.first(NUM_BACKTRACE_LINES).join "\n"
+    end
+
+    def node_attrs
+      @node_attrs ||= { class: node_classes,
+                        data:  node_data }.compact
+    end
+
+    def target_attrs
+      @target_attrs ||= { id: node_id }.compact
+    end
+
+    def node_id
+      return if record.nil?
+
+      "#{record_model}-#{record.id}-#{node_index}"
+    end
+
+    private
+
+    def node_data
+      @node_data ||= { 'embedder-target': target }.merge record_node_data
+    end
+
+    def record_node_data
+      return {} if record.nil?
+
+      { 'record-model': record_model,
+        'record-id':    record.id }
+    end
+
+    def record_model
+      return if record.nil?
+
+      @record_model ||= record.model_name.name
+    end
+
+    def node_classes
+      ['embedded-content',
+       node_selector_class,
+       node_added_classes].flatten.compact
+    end
+
+    def render_target
+      I18n.with_locale(locale) { render_path target_path }
+    end
+
+    def render_path(path)
+      ApplicationController.render rendering_options_for path
+    end
+
+    def rendering_options_for(path)
+      { assigns: assigns, template: path, layout: false }
+    end
+
+    def assigns
+      { template_manager: self }
+    end
+
+    def warning_node_path
+      @warning_node_path ||= status_template_path 'warning'
+    end
+
+    def status_template_path(status)
+      status_dir.join status
+    end
+
+    def status_dir
+      @status_dir ||= templates_dir.join 'status'
+    end
+
+    def templates_dir
+      @templates_dir ||= Pathname.new('embeddable_content').join 'replacements'
+    end
+  end
+end

data/app/services/embeddable_content/tex/base_renderer.rb

@@ -0,0 +1,33 @@
+require 'open3'
+
+module EmbeddableContent
+  module Tex
+    class BaseRenderer
+      RENDER_TEX_JS_PATH = Pathname.new('lib').join 'tasks/render_tex.js'
+
+      attr_reader :html
+
+      def initialize(html)
+        @html = html
+      end
+
+      def render
+        html.replace render_format(target_format) if target_format.present?
+      end
+
+      private
+
+      def render_format(format)
+        output, status = Open3.capture2(render_tex(format), stdin_data: html)
+        return output if status.success?
+
+        Rails.logger.warn "Error calling #{render_tex(format)}: #{status}"
+        html
+      end
+
+      def render_tex(format)
+        [RENDER_TEX_JS_PATH, '--output', format].join(' ')
+      end
+    end
+  end
+end

data/app/services/embeddable_content/tex/canvas_renderer.rb

@@ -0,0 +1,15 @@
+require 'open3'
+
+module EmbeddableContent
+  module Tex
+    class CanvasRenderer < BaseRenderer
+      def target_format
+        :canvas
+      end
+
+      def render_format(_format)
+        Mathjax::CanvasRenderer.new(html).render
+      end
+    end
+  end
+end

data/app/services/embeddable_content/tex/doc_processor.rb

@@ -0,0 +1,55 @@
+module EmbeddableContent
+  module Tex
+    class DocProcessor < EmbeddableContent::DocProcessor
+      REPAIRED_MATH_CSS_CLASS    = 'math-repaired'.freeze
+      REPAIRED_MATH_CSS_SELECTOR = ".#{REPAIRED_MATH_CSS_CLASS}".freeze
+
+      delegate :remove_repaired_math_spans?, to: :embedder
+
+      private
+
+      def process_nodes?
+        remove_repaired_math_spans?
+      end
+
+      def process_node(node, _node_index)
+        remove_repaired_math_span node
+      end
+
+      def remove_repaired_math_span(node)
+        node.replace node.content
+      end
+
+      def post_process
+        refresh_html
+        render_tex
+        fix_mml_fragments if fix_mml_fragments?
+        rebuild_document
+      end
+
+      def node_selector
+        REPAIRED_MATH_CSS_SELECTOR
+      end
+
+      def repaired_math_nodes
+        @repaired_math_nodes ||= document.css(REPAIRED_MATH_CSS_SELECTOR)
+      end
+
+      def render_tex
+        tex_renderer.new(html).render
+      end
+
+      def fix_mml_fragments?
+        embedder.fragment? && embedder.xml?
+      end
+
+      def fix_mml_fragments
+        html.replace Nokogiri::HTML(html).at('body').children.to_xml
+      end
+
+      def tex_renderer
+        "#{module_name}::#{tex_output_format.classify}Renderer".constantize
+      end
+    end
+  end
+end

data/app/services/embeddable_content/tex/mathjax_renderer.rb

@@ -0,0 +1,11 @@
+require 'open3'
+
+module EmbeddableContent
+  module Tex
+    class MathjaxRenderer < BaseRenderer
+      def target_format
+        nil
+      end
+    end
+  end
+end

data/app/services/embeddable_content/tex/mml_renderer.rb

@@ -0,0 +1,11 @@
+require 'open3'
+
+module EmbeddableContent
+  module Tex
+    class MmlRenderer < BaseRenderer
+      def target_format
+        :mml
+      end
+    end
+  end
+end

data/app/services/embeddable_content/tex/schoology_string_renderer.rb

@@ -0,0 +1,15 @@
+require 'open3'
+
+module EmbeddableContent
+  module Tex
+    class SchoologyStringRenderer < BaseRenderer
+      def target_format
+        :schoology_string
+      end
+
+      def render_format(_format)
+        Mathjax::SchoologyStringRenderer.new(html).render
+      end
+    end
+  end
+end

data/app/services/embeddable_content/tex/svg_renderer.rb

@@ -0,0 +1,11 @@
+require 'open3'
+
+module EmbeddableContent
+  module Tex
+    class SvgRenderer < BaseRenderer
+      def target_format
+        :svg
+      end
+    end
+  end
+end