embeddable_content 0.1.19

data/app/services/embeddable_content/token_replacement_map.rb

@@ -0,0 +1,32 @@
+module EmbeddableContent
+  class TokenReplacementMap
+    attr_reader :target_pattern_map
+
+    def initialize(target_pattern_map)
+      @target_pattern_map = target_pattern_map
+    end
+
+    def target_regexp_map
+      @target_regexp_map ||= build_target_regexp_map
+    end
+
+    private
+
+    def build_target_regexp_map
+      {}.tap do |regexp_map|
+        target_pattern_map.each do |target, pattern_replacement_map|
+          regexp_map[target] =
+            convert_patterns_to_regexps pattern_replacement_map
+        end
+      end
+    end
+
+    def convert_patterns_to_regexps(pattern_replacement_map)
+      {}.tap do |regexp_replacement_map|
+        pattern_replacement_map.each do |pattern, replacement|
+          regexp_replacement_map[Regexp.new(pattern)] = replacement
+        end
+      end
+    end
+  end
+end

data/app/services/embeddable_content/tree_based_node_processor.rb

@@ -0,0 +1,23 @@
+module EmbeddableContent
+  class TreeBasedNodeProcessor < EmbeddableContent::RecordNodeProcessor
+    EMBBEDER_TAG_TREE_ID_ATTRIBUTE = 'data-tree-ref-id'.freeze
+
+    private
+
+    def node_should_be_replaced?
+      super && tag_references_current_tree?
+    end
+
+    def tag_references_current_tree?
+      embedded_tag_tree_id == tree_embedder_tag_id
+    end
+
+    def embedded_tag_tree_id
+      node[EMBBEDER_TAG_TREE_ID_ATTRIBUTE]
+    end
+
+    def tree_embedder_tag_id
+      tree_node&.embedder_tag_id
+    end
+  end
+end

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

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

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

@@ -0,0 +1,46 @@
+module EmbeddableContent
+  module VideoLinks
+    class NodeProcessor < EmbeddableContent::VisualElementNodeProcessor
+      include VimeoPlayerSettings
+
+      delegate :url, to: :record
+
+      def video_player
+        case url
+        when VIMEO_URL_REGEX then :vimeo_player
+        else raise "Unrecognized video player for URL: #{url}"
+        end
+      end
+
+      # TODO: make this a field on the embed
+      PLAYER_PRESENTATION_TARGETS =
+        %i[cc kiddom schoology cms exported qti web].freeze
+      DESCRIPTION_PRESENTATION_TARGETS = %i[editable print].freeze
+
+      def presentation
+        case target
+        when *PLAYER_PRESENTATION_TARGETS      then :video_player
+        when *DESCRIPTION_PRESENTATION_TARGETS then :description
+        else raise "Undefined video presentation for target: #{target}"
+        end
+      end
+
+      # TODO: make this a field on the embed
+      CAPTIONED_TARGETS =
+        %i[cc kiddom schoology cms qti web].freeze
+      UNCAPTIONED_TARGETS = %i[editable exported print].freeze
+
+      def display_caption?
+        case target
+        when *CAPTIONED_TARGETS   then true
+        when *UNCAPTIONED_TARGETS then false
+        else raise "Undefined caption status for target: #{target}"
+        end
+      end
+
+      def video_availability_text
+        "Video '#{title}' available here: #{url}."
+      end
+    end
+  end
+end

data/app/services/embeddable_content/video_links/vimeo_player_settings.rb

@@ -0,0 +1,19 @@
+module EmbeddableContent
+  module VideoLinks
+    module VimeoPlayerSettings
+      VIMEO_URL_REGEX = %r{\Ahttps:\/\/player\.vimeo\.com\/video\/\d+\z}.freeze
+      DEFAULT_VIMEO_ATTRIBUTES = {
+        width:                   '640',
+        height:                  '360',
+        frameborder:               '0',
+        allowfullscreen:        'true',
+        mozillaallowfullscreen: 'true',
+        safariallowfullscreen:  'true'
+      }.freeze
+
+      def vimeo_attributes
+        DEFAULT_VIMEO_ATTRIBUTES.merge src: url
+      end
+    end
+  end
+end

data/app/services/embeddable_content/visual_element_node_processor.rb

@@ -0,0 +1,13 @@
+module EmbeddableContent
+  class VisualElementNodeProcessor < RecordNodeProcessor
+    include TemplateBased
+
+    delegate :attribution, :description, :long_description, :title, :caption,
+             to: :record
+
+    MISSING_LABEL_TEXT = ''.freeze
+    def label_text
+      caption.presence || MISSING_LABEL_TEXT
+    end
+  end
+end

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

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

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

@@ -0,0 +1,7 @@
+module EmbeddableContent
+  module WidgetFiles
+    class NodeProcessor < EmbeddableContent::RecordNodeProcessor
+      include TemplateBased
+    end
+  end
+end

data/app/views/embeddable_content/replacements/desmos_files/_applet.html.slim

@@ -0,0 +1,8 @@
+ruby:
+  manager        = @template_manager
+  node_attrs     = manager.node_attrs
+  record         = manager.record
+  applet_attrs   = node_attrs.merge 'data-state': record.state
+
+div *applet_attrs
+  div.desmos-calculator

data/app/views/embeddable_content/replacements/desmos_files/_description.html.slim

@@ -0,0 +1,6 @@
+ruby:
+  manager    = @template_manager
+  node_attrs = manager.node_attrs
+
+span.embedded-content-described *node_attrs
+  | Desmos applet is available in the digital version of the materials.

data/app/views/embeddable_content/replacements/desmos_files/cc.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/desmos_files/applet'

data/app/views/embeddable_content/replacements/desmos_files/cms.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/desmos_files/applet'

data/app/views/embeddable_content/replacements/desmos_files/editable.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/desmos_files/description'

data/app/views/embeddable_content/replacements/desmos_files/exported.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/desmos_files/applet'

data/app/views/embeddable_content/replacements/desmos_files/kiddom.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/desmos_files/applet'

data/app/views/embeddable_content/replacements/desmos_files/print.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/desmos_files/description'

data/app/views/embeddable_content/replacements/desmos_files/qti.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/desmos_files/applet'

data/app/views/embeddable_content/replacements/desmos_files/schoology.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/desmos_files/applet'

data/app/views/embeddable_content/replacements/desmos_files/web.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/desmos_files/applet'

data/app/views/embeddable_content/replacements/geogebra_files/_applet.html.slim

@@ -0,0 +1,11 @@
+ruby:
+  manager         = @template_manager
+  node_processor  = manager.node_processor
+  node_attrs      = manager.node_attrs
+  target_attrs    = manager.target_attrs
+  record          = manager.record
+  data_attrs      = { 'data-parameters': node_processor.data_parameters }
+
+div *node_attrs
+  div.ggb-base-64-data *data_attrs
+  div.ggb-applet-container *target_attrs

data/app/views/embeddable_content/replacements/geogebra_files/_description.html.slim

@@ -0,0 +1,9 @@
+ruby:
+  manager        = @template_manager
+  node_attrs     = manager.node_attrs
+  record         = manager.record
+  title          = record.title
+  applet_url     = record.applet_url
+
+span.embedded-content-described *node_attrs
+  | The Geogebra applet '#{title}' is available here: #{applet_url}.

data/app/views/embeddable_content/replacements/geogebra_files/cc.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/geogebra_files/applet'

data/app/views/embeddable_content/replacements/geogebra_files/cms.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/geogebra_files/applet'

data/app/views/embeddable_content/replacements/geogebra_files/editable.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/geogebra_files/description'

data/app/views/embeddable_content/replacements/geogebra_files/exported.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/geogebra_files/applet'

data/app/views/embeddable_content/replacements/geogebra_files/kiddom.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/geogebra_files/applet'

data/app/views/embeddable_content/replacements/geogebra_files/print.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/geogebra_files/description'

data/app/views/embeddable_content/replacements/geogebra_files/qti.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/geogebra_files/applet'

data/app/views/embeddable_content/replacements/geogebra_files/schoology.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/geogebra_files/applet'

data/app/views/embeddable_content/replacements/geogebra_files/web.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/geogebra_files/applet'

data/app/views/embeddable_content/replacements/html_tags/editable.html.slim

@@ -0,0 +1,16 @@
+ruby:
+  manager        = @template_manager
+  node_attrs     = manager.node_attrs
+  node_processor = manager.node_processor
+  data_rows      = node_processor.data_rows
+
+div *node_attrs
+  table
+    tbody
+      - data_rows.each do |data_row|
+        tr
+          - data_row.each do |data_val|
+            td = data_val
+  p
+  p
+  br

data/app/views/embeddable_content/replacements/images/_button_close.html.slim

@@ -0,0 +1,9 @@
+ruby:
+  manager            = @template_manager
+  node_processor     = manager.node_processor
+  modal_dialog       = node_processor.modal_dialog
+  close_button_attrs = modal_dialog.close_button_attrs
+
+button.js-modal-close.im-c-modal__close
+  svg.im-c-icon.im-c-icon--close *close_button_attrs
+    path d = 'M1162.5,198.75,1001.25,37.5,600,438.75,198.75,37.5,37.5,198.75,438.75,600,37.5,1001.25,198.75,1162.5,600,761.25l401.25,401.25,161.25-161.25L761.25,600Z'

data/app/views/embeddable_content/replacements/images/_button_open.html.slim

@@ -0,0 +1,9 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  modal_dialog   = node_processor.modal_dialog
+  target_div_id  = modal_dialog.target_div_id
+
+button.im-c-button.im-c-modal-trigger data-modal-target = target_div_id
+  p
+    img src = asset_path('expand.png') alt='Expand image' title='Expand image'

data/app/views/embeddable_content/replacements/images/_image_embed.html.slim

@@ -0,0 +1,14 @@
+ruby:
+  manager        = @template_manager
+  node_attrs     = manager.node_attrs
+  node_processor = manager.node_processor
+  img_tag_attrs  = node_processor.img_tag_attrs
+  figure_tag     = node_processor.figure_tag
+  label_text     = node_processor.label_text
+
+*{ tag: figure_tag } *node_attrs
+  span.c-figure__label
+    == label_text
+  img *img_tag_attrs
+  = render 'embeddable_content/replacements/images/modal_dialog'
+  figcaption.c-figcaption

data/app/views/embeddable_content/replacements/images/_modal_content.html.slim

@@ -0,0 +1,30 @@
+ruby:
+  manager         = @template_manager
+  node_processor  = manager.node_processor
+  modal_dialog    = node_processor.modal_dialog
+  img_tag_attrs   = modal_dialog.img_tag_attrs
+  description     = modal_dialog.description
+  described_by_id = modal_dialog.described_by_id
+  caption         = modal_dialog.caption
+  caption_id      = modal_dialog.caption_id
+  attribution     = modal_dialog.attribution
+  attribution_id  = modal_dialog.attribution_id
+
+div.im-c-modal__content.im-c-content
+  div id = described_by_id
+    - if description.present?
+      p
+        strong> Description:
+        = description
+  img *img_tag_attrs
+  - if caption.present?
+    p id = caption_id
+      strong> Caption:
+      == caption
+  - if attribution.present?
+    p id = attribution_id
+      strong> Attribution:
+      => modal_dialog.attribution_display_text
+      a href = attribution.original_url
+        | Source
+      | .

data/app/views/embeddable_content/replacements/images/_modal_dialog.html.slim

@@ -0,0 +1,17 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+
+  return unless node_processor.display_modal_dialog?
+
+  modal_dialog    = node_processor.modal_dialog
+  container_attrs = modal_dialog.container_attrs
+  target_attrs    = modal_dialog.target_attrs
+
+span.embedded-modal-dialog
+  = render 'embeddable_content/replacements/images/button_open'
+  div.im-c-modal *target_attrs
+    div.js-modal-close.im-c-modal__overlay
+    div.im-c-modal__container *container_attrs
+      = render 'embeddable_content/replacements/images/button_close'
+      = render 'embeddable_content/replacements/images/modal_content'

data/app/views/embeddable_content/replacements/images/cc.html.slim

@@ -0,0 +1,12 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  record         = manager.record
+  caption        = record.caption
+  img_tag_attrs  = node_processor.img_tag_attrs
+
+div
+  - if caption.present?
+    span.embedded-image-caption
+      == caption
+  img *img_tag_attrs

data/app/views/embeddable_content/replacements/images/cms.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/images/image_embed'

data/app/views/embeddable_content/replacements/images/editable.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/images/image_embed'

data/app/views/embeddable_content/replacements/images/exported.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/images/image_embed'

data/app/views/embeddable_content/replacements/images/kiddom.html.slim

@@ -0,0 +1,12 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  record         = manager.record
+  caption        = record.caption
+  img_tag_attrs  = node_processor.img_tag_attrs
+
+div
+  - if caption.present?
+    span.embedded-image-caption
+      == caption
+  img *img_tag_attrs

data/app/views/embeddable_content/replacements/images/print.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/images/image_embed'

data/app/views/embeddable_content/replacements/images/qti.html.slim

@@ -0,0 +1,6 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  img_tag_attrs  = node_processor.img_tag_attrs
+
+img *img_tag_attrs

data/app/views/embeddable_content/replacements/images/schoology.html.slim

@@ -0,0 +1,12 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  record         = manager.record
+  caption        = record.caption
+  img_tag_attrs  = node_processor.img_tag_attrs
+
+div
+  img *img_tag_attrs
+  - if caption.present?
+    span.embedded-image-caption
+      == caption

data/app/views/embeddable_content/replacements/images/web.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/images/image_embed'

data/app/views/embeddable_content/replacements/presentation_tags/_default.html.slim

@@ -0,0 +1,6 @@
+ruby:
+  manager        = @template_manager
+  node_attrs     = manager.node_attrs
+  node_processor = manager.node_processor
+
+div *node_attrs

data/app/views/embeddable_content/replacements/presentation_tags/print.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/presentation_tags/default'

data/app/views/embeddable_content/replacements/status/warning.html.slim

@@ -0,0 +1,12 @@
+ruby:
+  manager          = @template_manager
+  error            = manager.error
+  node             = manager.node
+  backtrace_lines  = manager.selected_backtrace_lines
+
+div.embedded-content-warning
+  = "Unable to process #{node}"
+  span.embedded-content-error-backtrace
+    = error.message
+    = "\nBacktrace:\n"
+    = backtrace_lines

data/app/views/embeddable_content/replacements/video_links/_caption.html.slim

@@ -0,0 +1,13 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  title          = node_processor.title
+  url            = node_processor.url
+
+| Video
+em<>
+  = title
+| available at
+a< href = url
+  = url
+| .

data/app/views/embeddable_content/replacements/video_links/_description.html.slim

@@ -0,0 +1,12 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  title          = node_processor.title
+  url            = node_processor.url
+
+span
+  | Video
+  =<> "'#{title}'"
+  | available here:
+  =< url
+  | .

data/app/views/embeddable_content/replacements/video_links/_video_embed.html.slim

@@ -0,0 +1,13 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  node_attrs     = manager.node_attrs
+  presentation   = node_processor.presentation
+
+figure *node_attrs
+  span.c-figure__label
+    = node_processor.label_text
+  = render "embeddable_content/replacements/video_links/#{presentation}"
+  figcaption.c-figcaption
+    - if node_processor.display_caption?
+      = render 'embeddable_content/replacements/video_links/caption'

data/app/views/embeddable_content/replacements/video_links/_video_player.html.slim

@@ -0,0 +1,6 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  video_player   = node_processor.video_player
+
+= render "embeddable_content/replacements/video_links/#{video_player}"

data/app/views/embeddable_content/replacements/video_links/_vimeo_player.html.slim

@@ -0,0 +1,6 @@
+ruby:
+  manager        = @template_manager
+  node_processor = manager.node_processor
+  iframe_attrs   = node_processor.vimeo_attributes
+
+iframe *iframe_attrs

data/app/views/embeddable_content/replacements/video_links/cc.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/video_links/video_embed'

data/app/views/embeddable_content/replacements/video_links/cms.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/video_links/video_embed'

data/app/views/embeddable_content/replacements/video_links/editable.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/video_links/video_embed'

data/app/views/embeddable_content/replacements/video_links/exported.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/video_links/video_embed'

data/app/views/embeddable_content/replacements/video_links/kiddom.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/video_links/video_embed'

data/app/views/embeddable_content/replacements/video_links/print.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/video_links/video_embed'

data/app/views/embeddable_content/replacements/video_links/qti.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/video_links/video_embed'

data/app/views/embeddable_content/replacements/video_links/schoology.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/video_links/video_embed'

data/app/views/embeddable_content/replacements/video_links/web.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/video_links/video_embed'

data/app/views/embeddable_content/replacements/widget_files/_widget_omitted.html.slim

@@ -0,0 +1,8 @@
+ruby:
+  manager      = @template_manager
+  node_attrs   = manager.node_attrs
+  record       = manager.record
+  widget_attrs = node_attrs.merge 'data-record-title': record.title
+
+span.embedded-content-omitted *widget_attrs
+  | Applet appears here.

data/app/views/embeddable_content/replacements/widget_files/_widget_script.html.slim

@@ -0,0 +1,13 @@
+ruby:
+  manager        = @template_manager
+  node_attrs     = manager.node_attrs
+  record         = manager.record
+  target_attrs   = manager.target_attrs
+  node_id        = manager.node_id
+  widget_attrs   = node_attrs.merge 'data-record-title': record.title
+  script_body    = record.interpolated_script_body node_id
+
+div *widget_attrs
+  div.widget-target-node *target_attrs
+  script
+    == script_body

data/app/views/embeddable_content/replacements/widget_files/cc.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/widget_files/widget_script'

data/app/views/embeddable_content/replacements/widget_files/cms.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/widget_files/widget_script'

data/app/views/embeddable_content/replacements/widget_files/editable.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/widget_files/widget_omitted'

data/app/views/embeddable_content/replacements/widget_files/exported.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/widget_files/widget_script'

data/app/views/embeddable_content/replacements/widget_files/kiddom.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/widget_files/widget_script'

data/app/views/embeddable_content/replacements/widget_files/print.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/widget_files/widget_omitted'

data/app/views/embeddable_content/replacements/widget_files/qti.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/widget_files/widget_script'

data/app/views/embeddable_content/replacements/widget_files/schoology.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/widget_files/widget_script'

data/app/views/embeddable_content/replacements/widget_files/web.html.slim

@@ -0,0 +1 @@
+= render 'embeddable_content/replacements/widget_files/widget_script'

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/embeddable_content/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+require 'rails/engine/commands'