embeddable_content 0.1.19

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d248938f6cfb46c41b491e75619538d518388329abe8970add6cb42188ee2247
+  data.tar.gz: 34843aabc66b6e11dcd4addb69e70c52b71bf8db70039ef111bc5f53a16bb8c5
+SHA512:
+  metadata.gz: 3de97e6f33fad46331b1a9662db068b8ef81913675d224bf0e128b1a2ff1581414ffbbbaf07ad9c68af624c2c75e6c4a99544a6950c25e4ff602ec5c3cc90db0
+  data.tar.gz: 4dfcd81715bfa44e337f5ce8eb8a602f180ed3f3eb62d7569a2b236b87ea5ae030fc084c059d3cdce3f5f9310a2bab2283421d6b873459a8e6895077854d0da7

data/.gitignore

@@ -0,0 +1,15 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+tmp/
+
+Gemfile.lock
+
+.generators
+.idea/
+.rakeTasks

data/.rubocop.yml

@@ -0,0 +1,62 @@
+require:
+  - rubocop-rails
+
+Style/Documentation:
+  Enabled: false
+Layout/ArgumentAlignment:
+  Enabled: false
+Layout/HashAlignment:
+  Enabled: false
+Layout/ParameterAlignment:
+  Enabled: false
+Layout/LeadingCommentSpace:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Rails/InverseOf:
+  Enabled: false
+Metrics/MethodLength:
+  Exclude:
+    - config/routes//**/*.rb
+Metrics/BlockLength:
+  ExcludedMethods:
+    [
+      "describe",
+      "described_class",
+      "context",
+      "scenario",
+      "feature",
+      "let",
+      "shared_examples",
+      "shared_examples_for",
+      "shared_context",
+      "before",
+    ]
+  Exclude:
+    - "*.gemspec"
+    - db/schema.rb
+    - db/migrate/*.rb
+    - config/initializers/**/*.rb
+    - config/routes.rb
+    - config/routes/**/*.rb
+    - spec/factories/*.rb
+    - spec/policies/**/*.rb
+    - spec/system/**/*.rb
+Security/YAMLLoad:
+  Exclude:
+    - spec/support/shared_examples/embeddable_content.rb
+AllCops:
+  Exclude:
+    - db/schema.rb
+    - bin/*
+    - Rakefile
+    - config/environments/production.rb
+    - config/initializers/backtrace_silencers.rb
+    - config/initializers/devise.rb
+    - config/initializers/simple_form.rb
+    - config/initializers/wrap_parameters.rb
+    - config/puma.rb
+    - db/migrate/*.rb
+    - db/seeds.rb

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in embeddable_content.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Eric Connally
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# EmbeddableContent
+
+Embedder functionality has been extracted to this gem to reduce client-app dependencies.
+
+## Installation
+
+For IM gems, add this to your application's Gemfile:
+
+``` ruby
+git_source(:im) do |repo_name|
+  "https://github.com/illustrativemathematics/#{repo_name}.git"
+end
+```
+
+Then add this line to your application's Gemfile:
+
+```ruby
+gem 'embeddable_content', im: 'embeddable_content'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install embeddable_content
+
+## Usage
+
+Ask Eric.
+
+## Development
+
+N.b. (EDC): This bit was auto-generated so it's unclear how relevant it is.
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags,
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/illustrativemathematics/embeddable_content.

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EmbeddableContent'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/javascripts/desmos/support.js

@@ -0,0 +1,12 @@
+document.addEventListener("DOMContentLoaded", function() {
+  document
+    .querySelectorAll('.embedded-content-desmos-file')
+    .forEach(loadDesmosCalculator);
+});
+
+function loadDesmosCalculator(elmt) {
+  var state          = elmt.dataset['state'],
+      calculatorElmt = elmt.getElementsByClassName('desmos-calculator')[0],
+      calculator     = Desmos.GraphingCalculator(calculatorElmt);
+  calculator.setState(state);
+};

data/app/assets/javascripts/geogebra/support.js

@@ -0,0 +1,14 @@
+document.addEventListener("DOMContentLoaded", function() {
+  document
+    .querySelectorAll('.embedded-content-geogebra-file')
+    .forEach(loadGeogebraApplet);
+});
+
+function loadGeogebraApplet(elmt) {
+  var container  = elmt.getElementsByClassName('ggb-applet-container')[0],
+      dataNode   = elmt.getElementsByClassName('ggb-base-64-data')[0],
+      parameters = JSON.parse(dataNode.dataset['parameters']),
+      applet     = new GGBApplet(parameters, '5.0');
+  applet.setHTML5Codebase('/GeoGebra/HTML5/5.0/web3d/');
+  applet.inject(container.id);
+};

data/app/controllers/concerns/cms/embeddable_content_controller.rb

@@ -0,0 +1,14 @@
+module Cms
+  module EmbeddableContentController
+    extend  ActiveSupport::Concern
+    include ::EmbeddableContentController
+
+    included do
+      embed_content_for :show
+    end
+
+    def embedder_target
+      :cms
+    end
+  end
+end

data/app/controllers/concerns/embeddable_content_controller.rb

@@ -0,0 +1,85 @@
+module EmbeddableContentController
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def embed_content_for(* actions)
+      whitelisted_embedder_actions.replace actions
+    end
+
+    def do_not_embed_content_for(* actions)
+      blacklisted_embedder_actions.replace actions
+    end
+  end
+
+  included do
+    class_attribute :whitelisted_embedder_actions, default: []
+    class_attribute :blacklisted_embedder_actions, default: []
+
+    after_action :embed_content
+  end
+
+  private
+
+  def handle_unknown_format_error
+    embed_content
+  end
+
+  def embed_content
+    render_embedded_content if embedder_required_for_action?
+  end
+
+  def render_embedded_content
+    render_html
+  end
+
+  def render_html
+    response.body = embedded_html
+  end
+
+  def embedder_required_for_action?
+    embedder_required_by_default? || embedder_action_whitelisted?
+  end
+
+  def embedder_required_by_default?
+    !embedder_action_blacklisted? && whitelisted_embedder_actions.empty?
+  end
+
+  def embedder_action_whitelisted?
+    whitelisted_embedder_actions.map(&:to_s).include? action_name
+  end
+
+  def embedder_action_blacklisted?
+    blacklisted_embedder_actions.map(&:to_s).include? action_name
+  end
+
+  def embedded_html
+    @embedded_html ||= embedder.embed_content! raw_html
+  end
+
+  def raw_html
+    @raw_html ||= response.body.presence || render_raw_html
+  end
+
+  def requested_format
+    request.format.to_sym
+  end
+
+  def render_raw_html
+    raise 'Define this method for blank response body (e.g., docx)'
+  end
+
+  def embedder
+    @embedder ||= create_embedder
+  end
+
+  def create_embedder
+    raise_missing_target if embedder_target.blank?
+
+    EmbeddableContent::Embedder.new embedder_target
+  end
+
+  def raise_missing_target
+    raise "No embedder target defined for action '#{action_name}'" \
+          " and format '#{requested_format}'"
+  end
+end

data/app/models/concerns/provides_embeddable_content.rb

@@ -0,0 +1,59 @@
+module ProvidesEmbeddableContent
+  extend ActiveSupport::Concern
+  include ActionView::Helpers::TagHelper
+
+  class_methods do
+    def embeddable_model_config
+      @embeddable_model_config ||= EmbeddableModelConfig.for_model self
+    end
+
+    delegate(*EmbeddableModelConfig.attributes, to: :embeddable_model_config)
+  end
+
+  included do
+    validates :title, presence: true
+    delegate(*EmbeddableModelConfig.attributes, to: self)
+  end
+
+  def embeddable_tag_extension
+    try(:file).try(:filename).try(:extension) || embeddable_tag_ext
+  end
+
+  def embeddable_tag(opts = {})
+    convert_safe_buffer_to_string tag(embeddable_tag_name, embeddable_tag_attrs(opts))
+  end
+
+  def template_based?
+    defined?(super) ? super : false
+  end
+
+  private
+
+  def convert_safe_buffer_to_string(safe_buffer)
+    safe_buffer.to_str
+  end
+
+  def embeddable_tag_attrs(opts)
+    { src:  "/#{model_name.route_key}/#{id}.#{embeddable_tag_extension}",
+      data: data_attributes(opts) }.compact
+  end
+
+  def data_attributes(opts)
+    return unless tree_based?
+
+    tree_based_data_attributes opts
+  end
+
+  def tree_based_data_attributes(opts)
+    tree_node    = opts[:tree_node]
+    tree_node_id = tree_node&.id ||
+                   EmbeddableContent::TREE_EMBEDDER_ID_PLACEHOLDER
+    tree_ref_id  = tree_node&.ref_id ||
+                   EmbeddableContent::TREE_EMBEDDER_ID_PLACEHOLDER
+    tree_code    = Tree.where(id: tree_ref_id)&.pluck(:code)&.first
+    { tree_ref_id:  tree_ref_id,
+      tree_node_id: tree_node_id,
+      tree_code:    tree_code,
+      tag_title:    title }.compact
+  end
+end

data/app/models/embeddable_model_config.rb

@@ -0,0 +1,55 @@
+class EmbeddableModelConfig < ApplicationRecord
+  IGNORED_ATTRIBUTES = %w[id created_at updated_at].freeze
+  BOOLEAN_ATTRIBUTES =
+    %w[tree_based?
+       always_display_tag_indicator?
+       embeddable_applet?
+       embeddable_image?
+       requires_rendering?].freeze
+
+  def self.ckeditor_config
+    pluck :embeddable_tag_selector, :ckeditor_allowed_content
+  end
+
+  def self.ckeditor_allowed_content_rules
+    ckeditor_config.map do |selector, content|
+      [selector, content]
+    end.to_h
+  end
+
+  def self.attributes
+    @attributes ||= (attribute_names -
+                     IGNORED_ATTRIBUTES +
+                     BOOLEAN_ATTRIBUTES).map(&:to_sym)
+  end
+
+  def self.all_embeddable_models
+    all.map(&:embeddable_model)
+  end
+
+  def self.embeddable_image_models
+    where(embeddable_image: true).map(&:embeddable_model)
+  end
+
+  def self.embeddable_applet_models
+    where(embeddable_applet: true).map(&:embeddable_model)
+  end
+
+  def self.embeddable_tree_based_models
+    where(tree_based: true).map(&:embeddable_model)
+  end
+
+  def self.for_model(embeddable_model)
+    find_by! embeddable_model_name: embeddable_model.model_name.name
+  end
+
+  def embeddable_model
+    embeddable_model_name.constantize
+  end
+
+  def styled_indicator_selector(tree_node: nil)
+    return embeddable_tag_name unless tree_based? && tree_node.present?
+
+    "#{embeddable_tag_name}[data-tree-ref-id=\"#{tree_node.ref_id}\"]".html_safe
+  end
+end

data/app/models/embedder_config.rb

@@ -0,0 +1,45 @@
+class EmbedderConfig < ApplicationRecord
+  TARGET_CATEGORY_ENUM_CONSULT_BEFORE_CHANGING =
+    { cms:        0,
+      print:      1,
+      web:        2,
+      editable:   3,
+      exported:   4,
+      qti:        5,
+      cc:         6,
+      schoology:  7,
+      kiddom:     8 }.freeze
+  SCOPE_CATEGORY_ENUM_CONSULT_BEFORE_CHANGING =
+    { document: 0,
+      fragment: 1 }.freeze
+  TEX_OUTPUT_FORMAT_CONSULT_BEFORE_CHANGING =
+    { mathjax: 0,
+      svg:     1,
+      mml:     2,
+      canvas:  3,
+      schoology_string: 4}.freeze
+  OUTPUT_FORMAT_CONSULT_BEFORE_CHANGING =
+    { html: 0,
+      xml:  1 }.freeze
+  DEFAULT_OUTPUT_FORMAT = OUTPUT_FORMAT_CONSULT_BEFORE_CHANGING[:html]
+
+  ALL_TARGETS = TARGET_CATEGORY_ENUM_CONSULT_BEFORE_CHANGING.keys.freeze
+
+  enum target:            TARGET_CATEGORY_ENUM_CONSULT_BEFORE_CHANGING
+  enum scope:             SCOPE_CATEGORY_ENUM_CONSULT_BEFORE_CHANGING
+  enum tex_output_format: TEX_OUTPUT_FORMAT_CONSULT_BEFORE_CHANGING
+  enum output_format:     OUTPUT_FORMAT_CONSULT_BEFORE_CHANGING
+
+  def self.for_target(target)
+    find_by target: target
+  end
+
+  def all_other_targets
+    @all_other_targets ||= ALL_TARGETS - [target.to_sym]
+  end
+
+  # EDC: this could be added to field on table
+  def aria_attrs?
+    !qti?
+  end
+end

data/app/models/embedding.rb

@@ -0,0 +1,25 @@
+class Embedding < ApplicationRecord
+  INDIFFERENT_RUN_ORDER      = 0
+  MATH_TYPESETTING_RUN_ORDER = 1000
+  DEFAULT_RUN_ORDER          = INDIFFERENT_RUN_ORDER
+
+  RUN_ORDER_ENUM_CONSULT_BEFORE_CHANGING = {
+    indifferent:      INDIFFERENT_RUN_ORDER,
+    math_typesetting: MATH_TYPESETTING_RUN_ORDER
+  }.freeze
+
+  enum run_order: RUN_ORDER_ENUM_CONSULT_BEFORE_CHANGING
+
+  def self.in_run_order
+    order :run_order
+  end
+
+  def doc_processor_for(embedder)
+    "EmbeddableContent::#{processor_module}::DocProcessor"
+      .constantize.new embedder
+  end
+
+  def process_target?(target)
+    processor_targets.include? target.to_s
+  end
+end

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

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

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

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

data/app/services/embeddable_content/doc_processor.rb

@@ -0,0 +1,63 @@
+module EmbeddableContent
+  class DocProcessor < EmbedderBase
+    PROCESS_NODES_BY_DEFAULT = true
+
+    attr_reader :embedder
+
+    delegate :document, :html, :rebuild_document, to: :embedder
+    delegate :selector, :process_target?, to: :embedding
+
+    def initialize(embedder)
+      @embedder = embedder
+      super embedder.config
+    end
+
+    def process!
+      return unless process_target?(target)
+
+      pre_process
+      process_matching_nodes if process_nodes?
+      post_process
+      refresh_html
+    end
+
+    def embedding
+      @embedding ||= Embedding.find_by processor_module: embedding_module
+    end
+
+    private
+
+    def refresh_html
+      html.replace document.to_s
+    end
+
+    def pre_process; end
+
+    def process_matching_nodes
+      matching_nodes.each.with_index(1) { |node, idx| process_node(node, idx) }
+    end
+
+    def post_process; end
+
+    def process_nodes?
+      PROCESS_NODES_BY_DEFAULT
+    end
+
+    def process_node(node, node_index)
+      node_processor_factory.new(self, node, node_index).process!
+    end
+
+    def node_selector
+      @node_selector ||= embedding_module.underscore.dasherize.singularize
+    end
+
+    def matching_nodes
+      @matching_nodes ||= document.css node_selector
+    end
+
+    def node_processor_factory
+      @node_processor_factory ||=
+        "#{module_name}::NodeProcessor".constantize
+    end
+  end
+end

data/app/services/embeddable_content/embedded_tag_info.rb

@@ -0,0 +1,50 @@
+module EmbeddableContent
+  class EmbeddedTagInfo
+    attr_reader :record, :embedded_model, :attr, :dom_node
+
+    def initialize(record, embedded_model, attr, dom_node)
+      @record         = record
+      @embedded_model = embedded_model
+      @attr           = attr
+      @dom_node       = dom_node
+    end
+
+    def available?
+      match.present?
+    end
+
+    def embedded_record_id
+      match.try :first
+    end
+
+    def embedded_record_ext
+      match.try :last
+    end
+
+    def embedded_record
+      @embedded_record ||= embedded_model.find embedded_record_id
+    end
+
+    private
+
+    def src
+      @src ||= dom_node.attributes['src'].to_html
+    end
+
+    def embed_src_path
+      embedded_model.model_name.route_key
+    end
+
+    def match
+      @match ||= src.match(%r{\/#{embed_src_path}\/(\d+)\.(\w+)}).try :captures
+    end
+
+    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