embeddable_content 0.1.19 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d248938f6cfb46c41b491e75619538d518388329abe8970add6cb42188ee2247
-  data.tar.gz: 34843aabc66b6e11dcd4addb69e70c52b71bf8db70039ef111bc5f53a16bb8c5
+  metadata.gz: 56e854adafe6bea8b3bb207d012239ef5775bcc4fdbc14a8f7789ccc7e339c40
+  data.tar.gz: 4bf3769759fa44f21bf0b04b33a61f6c8a69712819afc2e578b76baccab5f2d0
 SHA512:
-  metadata.gz: 3de97e6f33fad46331b1a9662db068b8ef81913675d224bf0e128b1a2ff1581414ffbbbaf07ad9c68af624c2c75e6c4a99544a6950c25e4ff602ec5c3cc90db0
-  data.tar.gz: 4dfcd81715bfa44e337f5ce8eb8a602f180ed3f3eb62d7569a2b236b87ea5ae030fc084c059d3cdce3f5f9310a2bab2283421d6b873459a8e6895077854d0da7
+  metadata.gz: 15a621a874e53c6adae8aca15b4d807f495e7434058e126359efb8a3c170236f367abc9e82b9db32a8b87d17dcd2a974e1eebff26b5f9d2a05cdc03b72258bb6
+  data.tar.gz: 06671f032b7ccc2d193346e21f2053f21ec24d5da47ee25e41ed683a23c0a0e9567b197cb50f58f90ace7ec21cc55b1e14ebdc008733caebcb86358fa0dbcb2f

data/README.md

@@ -2,6 +2,8 @@
 
 Embedder functionality has been extracted to this gem to reduce client-app dependencies.
 
+[![Gem Version](https://badge.fury.io/rb/embeddable_content.svg)](https://badge.fury.io/rb/embeddable_content)
+
 ## Installation
 
 For IM gems, add this to your application's Gemfile:

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

@@ -2,31 +2,123 @@ require 'open3'
 
 module EmbeddableContent
   module Tex
+    class RenderError < StandardError
+      attr_reader :script, :stderr, :status
+
+      def initialize(script, stderr, status, api_errors)
+        @script = script
+        @stderr = stderr
+        @status = status
+        super "Unable to resolve error raised calling #{script}: #{status}\n#{stderr}\n#{api_errors}"
+      end
+    end
+
     class BaseRenderer
       RENDER_TEX_JS_PATH = Pathname.new('lib').join 'tasks/render_tex.js'
 
-      attr_reader :html
+      attr_reader :html, :stdout, :stderr, :status
 
       def initialize(html)
         @html = html
       end
 
       def render
-        html.replace render_format(target_format) if target_format.present?
+        return html unless rendering_required?
+
+        run_script
       end
 
       private
 
-      def render_format(format)
-        output, status = Open3.capture2(render_tex(format), stdin_data: html)
-        return output if status.success?
+      def rendering_required?
+        not_yet_rendered? && target_format.present?
+      end
+
+      def not_yet_rendered?
+        status.blank?
+      end
+
+      def render_failed?
+        failed_status || stderr.present?
+      end
+
+      def failed_status
+        status.present? && !status.success?
+      end
+
+      def render_error
+        @render_error ||= RenderError.new script, stderr, status, api_errors
+      end
+
+      def run_script
+        @run_script ||= Open3.capture3(script, stdin_data: html).tap do |stdout, stderr, status|
+          @stdout = stdout
+          @stderr = stderr
+          @status = status
+        end
+        render_failed? ? try_api_client : html.replace(stdout)
+      end
+
+      def script
+        @script ||= [RENDER_TEX_JS_PATH, '--output', target_format].join(' ')
+      end
+
+      REGEX_TEX_STRING = /Formula\s+(?<texstring>.*)\s+contains the following errors:/.freeze
+      def offending_tex_string
+        @offending_tex_string ||= REGEX_TEX_STRING.match(stderr)[:texstring].strip if
+          stderr.present?
+      end
+
+      def document
+        @document ||= Nokogiri::HTML html
+      end
+
+      def all_spans
+        @all_spans ||= document.css 'span'
+      end
+
+      def api_errors
+        offending_node.blank? ? '' : api_client.errors.unshift('API errors:').join("\n")
+      end
+
+      def try_api_client
+        raise render_error if offending_node.blank?
+        raise render_error unless api_client.success?
+
+        offending_node.content = ''
+        offending_node.add_child repaired_content
+        renderer_for_repaired_document.render
+      end
+
+      def renderer_for_repaired_document
+        @renderer_for_repaired_document ||=
+          self.class.new html.replace(document.to_html)
+      end
+
+      def repaired_span
+        @repaired_span = %w[<span class="mathjax-api"></span>].tap do |span|
+          span << repaired_content
+        end
+      end
+
+      def repaired_content
+        @repaired_content ||= api_client.send target_format
+      end
+
+      def api_client
+        @api_client ||= Mathjax::Api::Client.new offending_tex_string
+      end
 
-        Rails.logger.warn "Error calling #{render_tex(format)}: #{status}"
-        html
+      def offending_node
+        @offending_node ||=
+          all_spans.detect { |node| offending_tex_appears_in?(node) }
       end
 
-      def render_tex(format)
-        [RENDER_TEX_JS_PATH, '--output', format].join(' ')
+      REGEX_NODE_TEX_CONTENT = /\\\(\s*(?<tex_string>.*)\s*\\\)/m.freeze
+      def offending_tex_appears_in?(node)
+        node.content.match(REGEX_NODE_TEX_CONTENT).then do |md|
+          md.present? && md[:tex_string]&.strip.eql?(offending_tex_string)
+        end
       end
     end
   end

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

@@ -7,8 +7,8 @@ module EmbeddableContent
         :canvas
       end
 
-      def render_format(_format)
-        Mathjax::CanvasRenderer.new(html).render
+      def render
+        html.replace Mathjax::CanvasRenderer.new(html).render
       end
     end
   end

data/app/services/mathjax/api/client.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mathjax
+  module Api
+    class Client; end
+  end
+end

data/embeddable_content.gemspec

@@ -14,15 +14,13 @@ Gem::Specification.new do |spec|
     'Provides embeddable content functionality to apps using this gem.'
   spec.homepage =
     'https://github.com/illustrativemathematics/embedded_content'
-  spec.metadata = {
-    'github_repo' => 'git@github.com/illustrativemathematics/embeddable_content.git'
-  }
+
   # Prevent pushing this gem to RubyGems.org.
   # To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section
   # to allow pushing to any host.
   # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "https://rubygems.org/gems/embedded_content"
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
   # else
   #   raise 'RubyGems 2.0 or newer is required to protect against ' \
   #     'public gem pushes.'

data/lib/embeddable_content/version.rb

@@ -1,3 +1,3 @@
 module EmbeddableContent
-  VERSION = '0.1.19'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: embeddable_content
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.2.0
 platform: ruby
 authors:
 - Eric Connally
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-13 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -208,6 +208,7 @@ files:
 - app/services/embeddable_content/visual_element_node_processor.rb
 - app/services/embeddable_content/widget_files/doc_processor.rb
 - app/services/embeddable_content/widget_files/node_processor.rb
+- app/services/mathjax/api/client.rb
 - app/views/.keep
 - app/views/embeddable_content/replacements/desmos_files/_applet.html.slim
 - app/views/embeddable_content/replacements/desmos_files/_description.html.slim
@@ -284,8 +285,7 @@ files:
 - lib/tasks/embeddable_content_tasks.rake
 homepage: https://github.com/illustrativemathematics/embedded_content
 licenses: []
-metadata:
-  github_repo: git@github.com/illustrativemathematics/embeddable_content.git
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths: