lcms-engine 0.1.0

data/spec/services/document_build_service_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe Lcms::Engine::DocumentBuildService do
+  # TODO: Need to implement using old DocumentForm specs
+  # subject { form.save }
+  #
+  # context 'when is valid' do
+  #   let(:document) do
+  #     stubs = {
+  #       activate!: nil,
+  #       foundational?: false,
+  #       original_content: nil,
+  #       update!: nil,
+  #       document_parts: double('parts', delete_all: true)
+  #     }
+  #     instance_double Document, stubs
+  #   end
+  #   let(:downloader) { instance_double 'DocumentDownloader::Gdoc', import: document }
+  #   let(:link) { 'doc-url' }
+  #   let(:material_ids) { [1, 3] }
+  #   let(:params) { { link: link } }
+  #   let(:parsed_document) do
+  #     OpenStruct.new(
+  #       activity_metadata: [{ 'material_ids' => material_ids }],
+  #       agenda: [],
+  #       foundational_metadata: '',
+  #       metadata: '',
+  #       parts: []
+  #     )
+  #   end
+  #   let(:template) do
+  #     stubs = {
+  #       css_styles: '',
+  #       parse: parsed_document,
+  #       parse_metadata: '',
+  #       render: '',
+  #       toc: ''
+  #     }
+  #     instance_double DocTemplate::Template, stubs
+  #   end
+  #
+  #   before do
+  #     allow(DocumentDownloader::Gdoc).to receive(:new).with(nil, link, Document).and_return(downloader)
+  #     allow(DocTemplate::Template).to receive(:new).and_return(template)
+  #     allow(DocumentGenerator).to receive(:generate_for)
+  #   end
+  #
+  #   it 'downloads the document' do
+  #     expect(downloader).to receive(:import)
+  #   end
+  #
+  #   it 'parses the document' do
+  #     expect(DocTemplate::Template).to receive(:new)
+  #   end
+  #
+  #   it 'activates the document' do
+  #     expect(document).to receive(:activate!)
+  #   end
+  #
+  #   it 'queues job to generate PDF and GDoc' do
+  #     expect(DocumentGenerator).to receive(:generate_for).with(document)
+  #   end
+  #
+  #   after { subject }
+  # end
+end

data/spec/services/embed_equations_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe Lcms::Engine::EmbedEquations do
+  let(:chart_url) { 'https://chart.googleapis.com/chart?cht=tx&chf=bg,s,FFFFFF00&chco=000000&chl=EF%E2%83%A1' }
+  let(:content) do
+    <<-HTML
+      <span>Intersecting lines</span>
+      <img src="#{chart_url}">
+    HTML
+  end
+  let(:content_new) do
+    <<-HTML
+      <span>Intersecting lines</span>
+      #{tex_to_html}
+    HTML
+  end
+  let(:redis) { instance_double Redis }
+  let(:tex) { 'EF⃡' }
+  let(:tex_to_html) { '<span>LaTeX equation</span>' }
+  let(:tex_to_svg) { '<svg>LaTeX equation</svg>' }
+
+  before { allow(described_class).to receive(:redis).and_return(redis) }
+
+  describe '.call' do
+    subject { described_class.call content }
+
+    before { allow(redis).to receive(:get).and_return(tex_to_html) }
+
+    it 'fetches tex from initial query' do
+      expect(described_class).to receive(:fetch_tex).with(chart_url).and_return(tex)
+      subject
+    end
+
+    it 'converts it to HTML' do
+      allow(described_class).to receive(:fetch_tex).and_return(tex)
+      expect(described_class).to receive(:tex_to_html).with(tex).and_return(tex_to_html)
+      subject
+    end
+
+    it 'returns HTML with replaced image' do
+      expect(subject).to eq content_new
+    end
+  end
+
+  describe '.tex_to_html' do
+    before { allow(redis).to receive(:get).and_return(tex_to_html) }
+
+    subject { described_class.tex_to_html tex }
+
+    it 'returns HTML' do
+      expect(subject).to eq tex_to_html
+    end
+
+    context 'when tex is nil' do
+      let(:tex) { '' }
+      it { is_expected.to be_nil }
+    end
+
+    context 'when there is no previously generated HTML in Redis' do
+      before do
+        allow(redis).to receive(:get)
+        allow(described_class).to receive(:`).and_return(tex_to_html)
+        allow(redis).to receive(:set)
+      end
+
+      it 'generates HTML' do
+        expect(described_class).to receive(:`).with("tex2html -- '#{tex}'")
+        subject
+      end
+
+      it 'stores generated HTML into the Redis' do
+        redis_key = "#{described_class::REDIS_KEY}#{tex}"
+        expect(redis).to receive(:set).with(redis_key, tex_to_html)
+        subject
+      end
+    end
+  end
+
+  describe '.tex_to_svg' do
+    let(:preserve_color) { false }
+
+    before { allow(redis).to receive(:get).and_return(tex_to_svg) }
+
+    subject { described_class.tex_to_svg tex }
+
+    it 'returns SVG' do
+      expect(subject).to eq tex_to_svg
+    end
+
+    context 'when tex is nil' do
+      let(:tex) { '' }
+      it { is_expected.to be_nil }
+    end
+
+    context 'when there is no previously generated SVG in Redis' do
+      before do
+        allow(redis).to receive(:get)
+        allow(described_class).to receive(:`).and_return(tex_to_svg)
+        allow(redis).to receive(:set)
+      end
+
+      it 'generates SVG' do
+        expect(described_class).to receive(:`).with("tex2svg -- '#{tex}'")
+        subject
+      end
+
+      it 'stores generated SVG into the Redis' do
+        redis_key = "#{described_class::REDIS_KEY_SVG}#{tex}#{preserve_color}"
+        expect(redis).to receive(:set).with(redis_key, tex_to_svg)
+        subject
+      end
+    end
+  end
+end

data/spec/services/html_sanitizer_spec.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+describe Lcms::Engine::HtmlSanitizer do
+  describe '.sanitize' do
+    subject { described_class.sanitize(html) }
+
+    context 'with gdocs suggestions' do
+      let(:html) do
+        <<-HTML
+        <tbody>
+          <tr>
+            <td colspan=\"2\" rowspan=\"1\">
+              <p>
+                <span>d</span><sup><a href=\"#cmnt1\" id=\"cmnt_ref1\">[a]</a></sup><sup><a href=\"#cmnt2\"
+                id=\"cmnt_ref2\">[b]</a></sup><span>ocument-metadata</span><sup><a href=\"#cmnt3\" id=\"cmnt_ref3\">
+                [c]</a></sup>
+              </p>
+            </td>
+          </tr>
+        </tbody>
+        HTML
+      end
+
+      it { expect(subject).to_not include('cmnt_ref') }
+    end
+
+    context 'with gdocs charts' do
+      let(:html) do
+        <<-HTML
+        <p>
+          <span>Using the floor tiles design shown below, create </span>
+          <img src="https://www.google.com/chart?cht=tx&amp;chf=bg,s,FFFFFF00&amp;chco=000000&amp;chl=4">
+          <span>&nbsp;different ratios related to the image. &nbsp;Describe the ratio relationship, and write the ratio in the form </span>
+          <img src="https://www.google.com/chart?cht=tx&amp;chf=bg,s,FFFFFF00&amp;chco=000000&amp;chl=A%3AB" data-pin-nopin="true"><span>&nbsp;or the form </span><img src="https://www.google.com/chart?cht=tx&amp;chf=bg,s,FFFFFF00&amp;chco=000000&amp;chl=A"><span>&nbsp;to </span><img src="https://www.google.com/chart?cht=tx&amp;chf=bg,s,FFFFFF00&amp;chco=000000&amp;chl=B"><span>. </span>
+        </p>
+        HTML
+      end
+
+      it 'replaces gdocs charts' do
+        expect(subject).to_not include('www.google')
+        expect(subject).to include('chart.googleapis')
+      end
+    end
+
+    context 'with superscript/subscript' do
+      let(:html) do
+        <<-HTML
+          <p style="padding-top:6pt;margin:0;color:#000000;padding-left:0;font-size:11pt;padding-bottom:6pt;font-family:'Calibri';line-height:1.0833333333333333;text-align:left;padding-right:0"><span style="color:#231f20">10</span><span style="color:#231f20;vertical-align: super">24</span><span style="color:#231f20">&nbsp;stars and 10</span><span style="color:#231f20;vertical-align:sub">80</span><span style="color:#231f20;font-weight:400;text-decoration:none;font-size:11pt;font-family:'Calibri';font-style:normal">&nbsp;atom
+          <table>
+            <td>
+              <p style="padding-top:6pt;margin:0;color:#000000;padding-left:0;font-size:11pt;padding-bottom:6pt;font-family:'Calibri';line-height:1.0833333333333333;padding-right:0"><span style="color:#231f20">10</span><span style="font-style:italic;color:#231f20;vertical-align: sub">23</span><span style="color:#231f20">&nbsp;and 10</span><span style="color:#231f20;vertical-align:super">79</span></p>
+            </td>
+          </table>
+        HTML
+      end
+
+      it 'replace sup/sub aligned spans to sup/sub' do
+        expect(subject).to include('80</sub>', '79</sup>', '24</sup>', '23</sub>', 'font-style')
+        expect(subject).not_to include('vertical-align')
+        expect(subject.scan(/span/).size).to eq 10
+        expect(subject.scan(/sub/).size).to eq 4
+        expect(subject.scan(/sup/).size).to eq 4
+      end
+    end
+  end
+
+  describe '.clean_content' do
+    subject { described_class.clean_content(html, opts) }
+
+    context 'not gdoc' do
+      let(:opts) { {} }
+      let(:html) { '<p></p>' }
+
+      it 'skips it' do
+        expect(subject).to eq(html)
+      end
+    end
+
+    context 'gdoc' do
+      let(:opts) { 'gdoc' }
+      let(:nested_html) do
+        <<-HTML
+          <p></p>
+          <p><span> </span></p>
+          <h4><table/></table></h4>
+        HTML
+      end
+      let(:p_html) do
+        <<-HTML
+          <p>TEXT</p>
+          <p><span> </span></p>
+          <h4><table/></table></h4>
+        HTML
+      end
+
+      context 'with simple html' do
+        let(:html) do
+          <<-HTML
+            <p>NOT EMPTY</p>
+            <h4></h4>
+            <table/></table>
+          HTML
+        end
+
+        it 'combines empty elements into 1' do
+          expect(subject).to eq('<p>NOT EMPTY</p>')
+        end
+      end
+
+      context 'with nested html' do
+        let(:html) { nested_html }
+
+        it 'collapse elements' do
+          expect(subject).to be_empty
+        end
+      end
+
+      context 'with nested html with p' do
+        let(:html) { p_html }
+
+        it 'combines empty elements into 1' do
+          expect(subject).to eq('<p>TEXT</p>')
+        end
+      end
+
+      context 'with several html blocks' do
+        let(:html) do
+          <<-HTML
+            <div>
+              #{p_html}
+            </div>
+            <h4>H4</h4>
+            <div>
+              #{nested_html}
+            </div>
+          HTML
+        end
+
+        it 'keeps non empty elements' do
+          expect(subject.gsub(/\s*/, '')).to eq('<div><p>TEXT</p></div><h4>H4</h4><div></div>')
+        end
+      end
+
+      context 'with do-not-strip elements first' do
+        let(:html) do
+          <<-HTML
+            <table>
+              <td>NOT EMPTY</td>
+            </table>
+            <p class="do-not-strip u-gdoc-empty-p"></p>
+            <p><span> </span></p>
+          HTML
+        end
+
+        it 'keeps do-not-strip element' do
+          table = '<table> <td>NOT EMPTY</td> </table> <p class="do-not-strip u-gdoc-empty-p"></p>'
+          expect(subject.gsub(/\s+/, ' ')).to eq table
+        end
+      end
+
+      context 'with p in ul section' do
+        let(:html) do
+          <<-HTML
+            <p><span>Students will:</span></p>
+            <ul>
+              <li><p><span><span>Identify the characteristics of fairy tales using literary language and explain the characteristics as they apply to the fairy tale </span></p></li>
+              <li><p><span>Prior to listening to </span></p></li>
+            </ul>
+            <p></p>
+            <p>NOT EMPTY</p>
+          HTML
+        end
+
+        it 'keeps empty p after ul' do
+          expect(subject.scan('<p>').size).to eq 5
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  # config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  # config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  # Use the documentation formatter for detailed output,
+  # unless a formatter has already been configured
+  # (e.g. via a command-line flag).
+  # config.default_formatter = "doc"
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  # Kernel.srand config.seed
+end