embeddable_content 0.1.19

data/app/services/embeddable_content/embedded_tags.rb

@@ -0,0 +1,30 @@
+module EmbeddableContent
+  class EmbeddedTags
+    attr_reader :record, :attr, :embedded_models
+
+    def initialize(record, attr, embedded_models)
+      @record          = record
+      @attr            = attr
+      @embedded_models = embedded_models
+    end
+
+    def each
+      embedded_models.each do |model|
+        document.css(model.embeddable_tag_name).each do |dom_node|
+          info = EmbeddedTagInfo.new record, model, attr, dom_node
+          yield info if info.available?
+        end
+      end
+    end
+
+    private
+
+    def document
+      @document ||= Nokogiri::HTML.fragment searchable_text
+    end
+
+    def searchable_text
+      record[attr].is_a?(Array) ? record[attr].join(' ') : record[attr]
+    end
+  end
+end

data/app/services/embeddable_content/embedder.rb

@@ -0,0 +1,89 @@
+module EmbeddableContent
+  class Embedder < EmbedderBase
+    NO_REPLACEMENTS_BY_DEFAULT = {}.freeze
+
+    attr_reader :html, :document
+
+    def initialize(target, options = {})
+      super EmbedderConfig.for_target(target), options
+    end
+
+    def image_catalog
+      @image_catalog ||= Set.new
+    end
+
+    def embed_content!(content)
+      @html = content.to_str.dup
+      @document = scrub parse_html
+      perform_replacements
+      run_doc_processors
+      write_embedded_html_to_tmp_file if debug_embedder?
+      @html
+    end
+
+    def rebuild_document
+      @document = parse_html
+    end
+
+    private
+
+    def parse_html
+      case scope&.to_sym
+      when :document then html_parser.parse    html
+      when :fragment then html_parser.fragment html
+      else raise "Unrecognized parsing scope: #{scope}"
+      end
+    end
+
+    def run_doc_processors
+      doc_processors.each(&:process!)
+    end
+
+    def html_parser
+      @html_parser ||=
+        case output_format&.to_sym
+        when :html then Nokogiri::HTML
+        when :xml  then Nokogiri::XML
+        else raise "Unrecognized output format: #{output_format}"
+        end
+    end
+
+    def scrub(document)
+      Scrubber.new(config).scrub document
+    end
+
+    def perform_replacements
+      replacements.each { |old, new| html.gsub! old, new }
+    end
+
+    def replacements
+      token_replacement_map[target] || NO_REPLACEMENTS_BY_DEFAULT
+    end
+
+    def token_replacement_map
+      @token_replacement_map ||=
+        TokenReplacementMap.new(replacement_map).target_regexp_map
+    end
+
+    def doc_processors
+      @doc_processors ||=
+        embeddings.map { |embedding| embedding.doc_processor_for self }
+    end
+
+    def embeddings
+      @embeddings ||= Embedding.all.in_run_order
+    end
+
+    def debug_embedder?
+      ENV['DEBUG_EMBEDDER'] == 'true'
+    end
+
+    def write_embedded_html_to_tmp_file
+      Rails.root.join('tmp').join(temp_filename).write html
+    end
+
+    def temp_filename
+      Time.current.strftime "embedded-#{target}-%Y-%m-%d-%H%M.html"
+    end
+  end
+end

data/app/services/embeddable_content/embedder_base.rb

@@ -0,0 +1,68 @@
+require Rails.root.join 'lib/tasks/support/verbosity.rb'
+
+module EmbeddableContent
+  class EmbedderBase
+    include HtmlService::Helpers
+    include Verbosity
+
+    attr_reader :config, :options
+
+    delegate :tex_output_format, :render_images?, :scope, :xml?,
+             :output_format, :fragment?, :remove_repaired_math_spans?,
+             :replacement_map, :all_other_targets, :aria_attrs?,
+             to: :config
+
+    def self.default_s3_bucket
+      ENV['AWS_S3_BUCKET']
+    end
+
+    def initialize(config, options = {})
+      @config  = config
+      @options = options
+      show_options if show_options?
+    end
+
+    def target
+      @target ||= config.target.to_sym
+    end
+
+    def to_s
+      "#{self.class} for #{config.inspect}"
+    end
+
+    def s3_bucket
+      @s3_bucket ||= options[:s3_bucket] ||
+                     self.class.default_s3_bucket
+    end
+
+    def ed_node
+      @ed_node ||= options[:ed_node]
+    end
+
+    def tree_node
+      @tree_node ||= ed_node&.root
+    end
+
+    def tree
+      @tree ||= tree_node&.ref
+    end
+
+    def locale
+      @locale ||= tree&.locale
+    end
+
+    private
+
+    def module_name
+      @module_name ||= self.class.name.deconstantize
+    end
+
+    def embedding_module
+      @embedding_module ||= module_name.demodulize
+    end
+
+    def route_keys
+      @route_keys ||= [embedding_module.underscore]
+    end
+  end
+end

data/app/services/embeddable_content/fragment_embedder.rb

@@ -0,0 +1,30 @@
+module EmbeddableContent
+  class FragmentEmbedder < EmbedderBase
+    attr_reader :fragment
+
+    def initialize(fragment)
+      super EmbedderConfig.for_target(:exported)
+      @fragment = fragment
+    end
+
+    def run
+      return '' if fragment.blank?
+
+      embedder.embed_content!(fragment)
+    end
+
+    private
+
+    def embedder
+      @embedder ||= Embedder.new config
+    end
+
+    def opts
+      @opts ||= { s3_bucket: s3_bucket }
+    end
+
+    def s3_bucket
+      ENV.fetch('OCX_EXPORT_DEST_S3_BUCKET', 'cms-im')
+    end
+  end
+end

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

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

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

@@ -0,0 +1,11 @@
+module EmbeddableContent
+  module GeogebraFiles
+    class NodeProcessor < EmbeddableContent::RecordNodeProcessor
+      include TemplateBased
+
+      def data_parameters
+        @data_parameters ||= record.full_configuration.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module EmbeddableContent
+  module HtmlTags
+    class DocProcessor < EmbeddableContent::DocProcessor
+      private
+
+      def node_selector
+        'ul.c-unstructured'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module EmbeddableContent
+  module HtmlTags
+    class NodeProcessor < EmbeddableContent::NodeProcessor
+      include TemplateBased
+
+      def data_rows
+        @data_rows ||= list_data.each_slice(num_columns).to_a
+      end
+
+      def node_selector_class
+        'embedded-unstructured-data'
+      end
+
+      private
+
+      def list_data
+        @list_data ||= node.css('li').map(&:text)
+      end
+
+      DEFAULT_NUM_COLUMNS = 8
+      def num_columns
+        DEFAULT_NUM_COLUMNS
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+module EmbeddableContent
+  module Images
+    class AttributionsProcessor
+      attr_reader :image_processor
+
+      delegate :embedder, :target, :document, :image_catalog, to: :image_processor
+      delegate :locale, to: :embedder
+
+      TARGETS_NEEDING_ATTRIBUTIONS = %i[print].freeze
+      ATTRIBUTIONS_PARTIAL = 'export/shared/attributions_images'.freeze
+      ATTRIBUTIONS_NODE_ID = 'image-attributions-node'.freeze
+      ATTRIBUTIONS_NODE_SELECTOR = "div##{ATTRIBUTIONS_NODE_ID}".freeze
+
+      def initialize(image_processor)
+        @image_processor = image_processor
+      end
+
+      def process!
+        render_attributions if attributions_required?
+      end
+
+      private
+
+      def attributions_required?
+        TARGETS_NEEDING_ATTRIBUTIONS.include?(target) &&
+          attributions_node.present? &&
+          image_catalog.present? &&
+          attributions.present?
+      end
+
+      def attributions
+        @attributions =
+          image_catalog.select(&:attribution).compact
+      end
+
+      def attributions_node
+        @attributions_node ||= document.css(ATTRIBUTIONS_NODE_SELECTOR).first
+      end
+
+      def render_attributions
+        attributions_node.replace(attributions_fragment)
+      end
+
+      def attributions_html
+        I18n.with_locale(locale) { render_html }
+      end
+
+      def render_html
+        ApplicationController.renderer.render(
+          partial: ATTRIBUTIONS_PARTIAL,
+          locals:  { image_files: image_catalog }
+        )
+      end
+
+      def attributions_fragment
+        @attributions_fragment ||= Nokogiri::HTML.fragment(attributions_html)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module EmbeddableContent
+  module Images
+    class DocProcessor < EmbeddableContent::DocProcessor
+      delegate :image_catalog, to: :embedder
+
+      CLASS_IMG_TAG_RELOCATED = 'img-tag-relocated-by-embedder'
+
+      private
+
+      def pre_process
+        move_img_tags_out_from_p_tags
+      end
+
+      def post_process
+        attributions_processor.process!
+      end
+
+      def attributions_processor
+        @attributions_processor ||=
+          EmbeddableContent::Images::AttributionsProcessor.new self
+      end
+
+      def node_selector
+        'img'
+      end
+
+      def move_img_tags_out_from_p_tags
+        img_tags_inside_p_tags.each do |img_tag|
+          move_img_tag_out_from_p_tag img_tag
+        end
+        remove_affected_empty_p_tags
+      end
+
+      def remove_affected_empty_p_tags
+        document.css("p.#{CLASS_IMG_TAG_RELOCATED}").each do |p_tag|
+          remove_if_empty p_tag
+        end
+      end
+
+      def move_img_tag_out_from_p_tag(img_tag)
+        img_tag.parent.tap do |p_tag|
+          p_tag.add_previous_sibling img_tag
+          p_tag.add_class CLASS_IMG_TAG_RELOCATED
+        end
+      end
+
+      def img_tags_inside_p_tags
+        @img_tags_inside_p_tags ||= document.css 'p > img'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+module EmbeddableContent
+  module Images
+    class ImageDownloader
+      attr_reader :attached_image
+
+      delegate :to_path, to: :image_file
+
+      def initialize(attached_image)
+        @attached_image = attached_image
+      end
+
+      def save
+        image_file.tap { |file| file.write raw_image_data }
+      end
+
+      def delete
+        image_file.delete if image_file.exist?
+      end
+
+      def raw_svg
+        @raw_svg ||= downloaded_image_data if svg_attached?
+      end
+
+      private
+
+      TMP_IMAGE_DIR = Rails.root.join('tmp').freeze
+
+      def image_file
+        @image_file ||= TMP_IMAGE_DIR.join filename
+      end
+
+      def raw_image_data
+        png_rendered_from_svg || downloaded_image_data
+      end
+
+      def png_rendered_from_svg
+        Script::SvgToPng.new(downloaded_image_data).to_png if svg_attached?
+      end
+
+      def downloaded_image_data
+        @downloaded_image_data ||=
+          attached_image.download.force_encoding 'utf-8'
+      end
+
+      def filename
+        @filename ||= "embedder-#{Time.now.to_f}.#{extension}"
+      end
+
+      def extension
+        @extension ||=
+          svg_attached? ? 'png' : attached_image.filename.extension
+      end
+
+      CONTENT_TYPE_SVG = 'image/svg+xml'.freeze
+      def svg_attached?
+        attached_image.content_type.eql? CONTENT_TYPE_SVG
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+module EmbeddableContent
+  module Images
+    class ImgTagAttributes
+      include Images::Shared
+      attr_reader :node_processor
+
+      delegate :alt_text, :attached_file, :record, :aria_attrs?,
+               :cms_url, :s3_url, :s3_ttl_service_url, :target,
+               :node,    to: :node_processor
+      delegate :image,   to: :record
+      delegate :raw_svg, to: :image_downloader
+
+      def initialize(node_processor)
+        @node_processor = node_processor
+      end
+
+      def to_h
+        { alt:    strip_tags(alt_text),
+          src:    src,
+          height: height,
+          class:  css_classes,
+          width:  width }.merge(aria_attrs).compact
+      end
+
+      def src
+        case target
+        when :schoology, :cc, :kiddom then s3_url with_extension: false
+        when :cms                     then cms_url
+        when :editable                then downloaded_file_url
+        when :exported, :qti          then s3_url with_extension: false
+        when :print, :web             then s3_ttl_service_url
+        end
+      end
+
+      def width
+        case target
+        when :editable then width_for_editable_target
+        when :cc, :kiddom, :qti, :schoology then image_width
+        end
+      end
+
+      # TODO: should this be abstracted?
+      def height
+        case target
+        when :editable then height_for_editable_target
+        when :cc, :kiddom, :qti, :schoology then image_height
+        end
+      end
+
+      private
+
+      def aria_attrs
+        aria_attrs? ? { role: :image } : {}
+      end
+
+      def css_classes
+        node.classes.any? ? node.classes.join(' ') : nil
+      end
+
+      def svg_image?
+        image.attached? && image.content_type == 'image/svg+xml'
+      end
+
+      def use_original_svg_dimensions_for_converted_png_file?
+        svg_image? && svg_document.present?
+      end
+
+      def downloaded_file_url
+        downloaded_image.to_path
+      end
+
+      def downloaded_image
+        @downloaded_image ||= image_downloader.save
+      end
+
+      def image_downloader
+        @image_downloader ||= ImageDownloader.new attached_file
+      end
+
+      def height_for_editable_target
+        svg_height if use_original_svg_dimensions_for_converted_png_file?
+      end
+
+      def width_for_editable_target
+        svg_width if use_original_svg_dimensions_for_converted_png_file?
+      end
+
+      def svg_width
+        svg_document.root['width'] if svg_available?
+      end
+
+      def svg_height
+        svg_document.root['height'] if svg_available?
+      end
+
+      def svg_available?
+        svg_image? && svg_document.present?
+      end
+
+      def svg_document
+        @svg_document ||= Nokogiri::XML.parse raw_svg if raw_svg.present?
+      end
+
+      def image_width
+        image.metadata[:width] || image_dimensions[1]
+      end
+
+      def image_height
+        image.metadata[:height] || image_dimensions[2]
+      end
+
+      IMAGE_DIMENSION_SCRIPT = %(identify -ping -format "%[w]x%[h]").freeze
+      IMAGE_DIMENSION_REGEX  = /(\d+)x(\d+)/.freeze
+
+      def run_image_dimension_script
+        `#{IMAGE_DIMENSION_SCRIPT} #{downloaded_file_url}`
+      end
+
+      def image_dimensions
+        @image_dimensions ||=
+          run_image_dimension_script.match IMAGE_DIMENSION_REGEX
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module EmbeddableContent
+  module Images
+    class ModalDialog
+      include Images::Shared
+
+      attr_reader :node_processor
+
+      delegate :record_css_id_for, :s3_ttl_service_url, :caption, :attribution,
+               :alt_text, to: :node_processor
+
+      def initialize(node_processor)
+        @node_processor = node_processor
+      end
+
+      def img_tag_attrs
+        { src:   s3_ttl_service_url,
+          width: '80%',
+          alt:   strip_tags(alt_text),
+          role:  :image }
+      end
+
+      def attribution_display_text
+        [attribution.owner_and_title_info,
+         attribution.license.name,
+         attribution.via_reference].join('. ').strip + '.'
+      end
+
+      def container_attrs
+        { tabindex:           '-1',
+          role:               'dialog',
+          'aria-labelledby':  labelled_by_id,
+          'aria-describedby': described_by_id,
+          'aria-label':       'Image information' }
+      end
+
+      def target_attrs
+        { 'id':          target_div_id,
+          'hidden':      'true',
+          'aria-hidden': 'true' }
+      end
+
+      def close_button_attrs
+        { 'aria-hidden':  'true',
+          height:         '18',
+          width:          '18',
+          viewBox:        '0 0 1200 1200' }
+      end
+
+      def description
+        node_processor.long_description
+      end
+
+      def labelled_by_id
+        record_css_id_for 'dialog-alt-text'
+      end
+
+      def described_by_id
+        record_css_id_for 'dialog-long-description'
+      end
+
+      def target_div_id
+        record_css_id_for 'modal-target'
+      end
+
+      def caption_id
+        record_css_id_for 'dialog-caption'
+      end
+
+      def attribution_id
+        record_css_id_for 'dialog-attribution'
+      end
+    end
+  end
+end