lcms-engine 0.1.0 → 0.1.2

data/app/presenters/lcms/engine/content_presenter.rb

@@ -63,11 +63,15 @@ module Lcms
         config[:padding].map { |k, v| "#{align_type}-#{k}:#{v};" }.join
       end
 
-      def render_content(context_type, options = {})
-        options[:parts_index] = document_parts_index
-        rendered_layout = DocumentRenderer::Part.call(layout_content(context_type), options)
-        content = DocTemplate.sanitizer.clean_content(rendered_layout, context_type)
-        Lcms::Engine::ReactMaterialsResolver.resolve(content, self)
+      private
+
+      def document_parts_index
+        @document_parts_index ||= document_parts.pluck(:placeholder, :anchor, :content, :optional)
+                                    .map { |p| [p[0], { anchor: p[1], content: p[2], optional: p[3] }] }.to_h
+      end
+
+      def layout_content(context_type)
+        layout(context_type).content
       end
     end
   end

data/app/presenters/lcms/engine/document_presenter.rb

@@ -124,6 +124,13 @@ module Lcms
         html.to_html
       end
 
+      def render_content(context_type, options = {})
+        options[:parts_index] = document_parts_index
+        rendered_layout = DocumentRenderer::Part.call(layout_content(context_type), options)
+        content = DocTemplate.sanitizer.clean_content(rendered_layout, context_type)
+        Lcms::Engine::ReactMaterialsResolver.resolve(content, self)
+      end
+
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       def short_breadcrumb(join_with: ' / ', with_short_lesson: false, with_subject: true, unit_level: false)
         unless unit_level
@@ -200,17 +207,6 @@ module Lcms
       def unit
         @unit ||= resource&.parent
       end
-
-      private
-
-      def document_parts_index
-        @document_parts_index ||= document_parts.pluck(:placeholder, :anchor, :content, :optional)
-                                    .map { |p| [p[0], { anchor: p[1], content: p[2], optional: p[3] }] }.to_h
-      end
-
-      def layout_content(context_type)
-        layout(context_type).content
-      end
     end
   end
 end

data/app/presenters/lcms/engine/material_presenter.rb

@@ -4,10 +4,8 @@ module Lcms
   module Engine
     class MaterialPresenter < Lcms::Engine::ContentPresenter
       attr_accessor :document
-      attr_reader :parsed_document
 
       delegate :short_url, :subject, to: :document
-      delegate :parts, to: :parsed_document
 
       DEFAULT_TITLE = 'Material'
 
@@ -28,7 +26,7 @@ module Lcms
       end
 
       def content_for(context_type)
-        layout(context_type)&.content
+        render_content(context_type)
       end
 
       def content_type
@@ -138,14 +136,6 @@ module Lcms
 
       private
 
-      def document_parts_index
-        @document_parts_index ||= parts.map { |p| [p[:placeholder], { anchor: p[:anchor], content: p[:content] }] }.to_h
-      end
-
-      def layout_content(context_type)
-        parts.find { |p| p[:part_type] == :layout && p[:context_type] == context_type }&.dig(:content) || ''
-      end
-
       def material_links
         @material_links ||= (document || @lesson).links['materials']&.dig(id.to_s)
       end

data/app/services/lcms/engine/document_build_service.rb

@@ -27,7 +27,7 @@ module Lcms
         @document.update! content_key => content
 
         build
-        create_parts
+        @document.create_parts_for(template)
 
         ActiveSupport::Notifications.instrument EVENT_BUILT, id: document.id
 
@@ -132,22 +132,6 @@ module Lcms
         end
       end
 
-      def create_parts
-        template.parts.each do |part|
-          document.document_parts.create!(
-            active: true,
-            anchor: part[:anchor],
-            content: part[:content],
-            context_type: part[:context_type],
-            data: part[:data],
-            materials: part[:materials],
-            optional: part[:optional],
-            part_type: part[:part_type],
-            placeholder: part[:placeholder]
-          )
-        end
-      end
-
       def document_params
         {
           activity_metadata: template.metadata_service.try(:activity_metadata),

data/app/services/lcms/engine/material_build_service.rb

@@ -39,7 +39,7 @@ module Lcms
           )
         )
 
-        material.material_parts.delete_all
+        material.document_parts.delete_all
 
         basename = DocumentGenerator.material_presenter.new(material).material_filename
         pdf_filename = "#{basename}#{ContentPresenter::PDF_EXT}"
@@ -71,17 +71,8 @@ module Lcms
           )
         )
 
-        material.material_parts.delete_all
-
-        presenter = DocumentGenerator.material_presenter.new(material, parsed_document: template)
-        DocTemplate.context_types.each do |context_type|
-          material.material_parts.create!(
-            active: true,
-            content: presenter.render_content(context_type),
-            context_type: context_type,
-            part_type: :layout
-          )
-        end
+        material.document_parts.delete_all
+        material.create_parts_for(template)
         material
       end
 

data/app/views/layouts/lcms/engine/application.html.erb

@@ -10,13 +10,9 @@
     <%= render partial: 'lcms/engine/shared/open_graph_meta' %>
     <%= render partial: 'lcms/engine/shared/favicon' %>
     <script>document.querySelector('html').className = 'js';</script>
-    <script>
-      window._PDFJSworkerSrc = '<%= asset_url('pdf.worker.js') %>'
-    </script>
     <%= stylesheet_link_tag 'lcms/engine/application', media: 'all', 'data-turbolinks-track' => 'reload' %>
     <%= javascript_include_tag '//s7.addthis.com/js/300/addthis_widget.js#async=1' %>
     <%= javascript_include_tag 'lcms/engine/application', 'data-turbolinks-track' => 'reload' %>
-    <%= javascript_include_tag 'lcms/engine/pdf_js_preview', 'data-turbolinks-track' => 'reload' if generic_page? %>
     <%= render partial: 'lcms/engine/shared/google_analytics' %>
     <%= render partial: 'lcms/engine/shared/heap_analytics' %>
     <%= csrf_meta_tags %>

data/app/views/layouts/lcms/engine/lti.html.erb

@@ -5,13 +5,9 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <script>document.querySelector('html').className = 'js';</script>
-    <script>
-      window._PDFJSworkerSrc = '<%= asset_url('pdf.worker.js') %>'
-    </script>
     <%= stylesheet_link_tag 'lcms/engine/application', media: 'all', 'data-turbolinks-track' => 'reload' %>
     <%= javascript_include_tag '//s7.addthis.com/js/300/addthis_widget.js#async=1' %>
     <%= javascript_include_tag 'lcms/engine/application_lti', 'data-turbolinks-track' => 'reload' %>
-    <%= javascript_include_tag 'lcms/engine/pdf_js_preview', 'data-turbolinks-track' => 'reload' if generic_page? %>
     <%= csrf_meta_tags %>
     <% if content_for?(:canonical_url) %>
       <link rel=canonical href='<%= yield(:canonical_url) %>'>

data/db/migrate/20200217160930_change_document_parts_to_polymorphic.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class ChangeDocumentPartsToPolymorphic < Lcms::Engine::Migration
+  def up
+    add_reference :document_parts, :renderer, polymorphic: true, index: true
+    Lcms::Engine::DocumentPart.update_all("renderer_id = document_id, renderer_type = 'Lcms::Engine::Document'")
+    Lcms::Engine::MaterialPart.find_each do |material_part|
+      Lcms::Engine::DocumentPart.create!(
+        active: material_part.active,
+        content: material_part.content,
+        context_type: material_part.context_type,
+        part_type: material_part.part_type,
+        renderer_id: material_part.material_id,
+        renderer_type: 'Lcms::Engine::Material'
+      )
+    end
+    remove_column :document_parts, :document_id
+  end
+
+  def down
+    Lcms::Engine::MaterialPart.delete_all
+    Lcms::Engine::DocumentPart.where(renderer_type: 'Lcms::Engine::Material').find_each do |material_part|
+      Lcms::Engine::MaterialPart.create!(
+        active: material_part.active,
+        content: material_part.content,
+        context_type: material_part.context_type,
+        part_type: material_part.part_type,
+        material_id: material_part.renderer_id
+      )
+    end
+    Lcms::Engine::DocumentPart.where(renderer_type: 'Lcms::Engine::Material').delete_all
+    add_reference :document_parts, :document, index: true, foreign_key: true
+    Lcms::Engine::DocumentPart.update_all('document_id = renderer_id')
+    remove_reference :document_parts, :renderer, polymorphic: true
+  end
+end

data/db/migrate/20200218144849_drop_material_parts_table.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class DropMaterialPartsTable < Lcms::Engine::Migration
+  def change
+    drop_table :material_parts
+  end
+end

data/db/schema.rb

@@ -62,24 +62,25 @@ ActiveRecord::Schema.define(version: 0) do
   add_index "document_bundles", ["resource_id"], name: "index_document_bundles_on_resource_id", using: :btree
 
   create_table "document_parts", force: :cascade do |t|
-    t.integer  "document_id"
     t.text     "content"
     t.string   "part_type"
     t.boolean  "active"
-    t.datetime "created_at",                   null: false
-    t.datetime "updated_at",                   null: false
+    t.datetime "created_at",                    null: false
+    t.datetime "updated_at",                    null: false
     t.string   "placeholder"
-    t.text     "materials",    default: [],    null: false, array: true
-    t.integer  "context_type", default: 0
+    t.text     "materials",     default: [],    null: false, array: true
+    t.integer  "context_type",  default: 0
     t.string   "anchor"
-    t.boolean  "optional",     default: false, null: false
-    t.jsonb    "data",         default: {},    null: false
+    t.boolean  "optional",      default: false, null: false
+    t.jsonb    "data",          default: {},    null: false
+    t.integer  "renderer_id"
+    t.string   "renderer_type"
   end
 
   add_index "document_parts", ["anchor"], name: "index_document_parts_on_anchor", using: :btree
   add_index "document_parts", ["context_type"], name: "index_document_parts_on_context_type", using: :btree
-  add_index "document_parts", ["document_id"], name: "index_document_parts_on_document_id", using: :btree
   add_index "document_parts", ["placeholder"], name: "index_document_parts_on_placeholder", using: :btree
+  add_index "document_parts", ["renderer_type", "renderer_id"], name: "index_document_parts_on_renderer_type_and_renderer_id", using: :btree
 
   create_table "documents", force: :cascade do |t|
     t.string   "file_id"
@@ -152,18 +153,6 @@ ActiveRecord::Schema.define(version: 0) do
 
   add_index "leadership_posts", ["order", "last_name"], name: "index_leadership_posts_on_order_and_last_name", using: :btree
 
-  create_table "material_parts", force: :cascade do |t|
-    t.integer  "material_id"
-    t.text     "content"
-    t.integer  "context_type", default: 0
-    t.string   "part_type"
-    t.boolean  "active"
-    t.datetime "created_at",               null: false
-    t.datetime "updated_at",               null: false
-  end
-
-  add_index "material_parts", ["material_id"], name: "index_material_parts_on_material_id", using: :btree
-
   create_table "materials", force: :cascade do |t|
     t.string   "file_id",                        null: false
     t.string   "identifier"
@@ -431,10 +420,8 @@ ActiveRecord::Schema.define(version: 0) do
 
   add_foreign_key "copyright_attributions", "resources"
   add_foreign_key "document_bundles", "resources"
-  add_foreign_key "document_parts", "documents"
   add_foreign_key "documents_materials", "documents"
   add_foreign_key "documents_materials", "materials"
-  add_foreign_key "material_parts", "materials"
   add_foreign_key "reading_assignment_texts", "reading_assignment_authors"
   add_foreign_key "resource_additional_resources", "resources"
   add_foreign_key "resource_additional_resources", "resources", column: "additional_resource_id"

data/docker-compose.yml

@@ -0,0 +1,29 @@
+version: '3'
+services:
+  db:
+    image: postgres:11.5-alpine
+    ports:
+      - 5432:5432
+    volumes:
+      - postgres:/var/lib/postgresql/data
+
+  redis:
+    image: redis:5.0.5-alpine
+    ports:
+      - 6379
+
+  app:
+    build: .
+    command: bash -c "bundle install && yarn && tail -f /dev/null"
+    env_file:
+      - spec/dummy/.env.docker
+    environment:
+      REDIS_URL: redis://redis:6379/1
+    volumes:
+      - .:/app
+    depends_on:
+      - db
+      - redis
+
+volumes:
+  postgres:

data/lcms-engine.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'acts-as-taggable-on', '~> 5.0'
   s.add_dependency 'acts_as_list', '~> 0.9.10'
   s.add_dependency 'addressable', '~> 2.5.1'
-  s.add_dependency 'airbrake'
+  s.add_dependency 'airbrake', ' ~> 10'
   s.add_dependency 'autoprefixer-rails', '~> 6.4.0'
   s.add_dependency 'aws-sdk-rails', '~> 1.0'
   s.add_dependency 'backport_new_renderer', '~> 1.0.0'
@@ -50,20 +50,19 @@ Gem::Specification.new do |s|
   s.add_dependency 'foundation-rails', '~> 6.2.1'
   s.add_dependency 'google-api-client', '~> 0.30'
   s.add_dependency 'heap', '~> 1.0'
-  s.add_dependency 'hiredis'
-  s.add_dependency 'httparty'
-  s.add_dependency 'i18n-js', '~> 3.0.2'
+  s.add_dependency 'hiredis', '~> 0.6'
+  s.add_dependency 'httparty', '~> 0.16'
   s.add_dependency 'jbuilder', '~> 2.0'
-  s.add_dependency 'jquery-rails'
+  s.add_dependency 'jquery-rails', '~> 4.3'
   s.add_dependency 'js-routes', '~> 1.1.2'
   s.add_dependency 'lt-google-api', '~> 0.1'
   s.add_dependency 'lt-lcms', '~> 0.2'
   s.add_dependency 'migration_data', '~> 0.2.1'
-  s.add_dependency 'mini_magick', '>= 4.9.4'
-  s.add_dependency 'nested_form'
-  s.add_dependency 'newrelic_rpm'
+  s.add_dependency 'mini_magick', '~> 4.9', '>= 4.9.4'
+  s.add_dependency 'nested_form', '~> 0.3'
+  s.add_dependency 'newrelic_rpm', '~> 6.9'
   s.add_dependency 'nikkou', '~> 0.0.5'
-  s.add_dependency 'nokogiri', '>= 1.10.4'
+  s.add_dependency 'nokogiri', '~> 1.10', '>= 1.10.4'
   s.add_dependency 'oj', '~> 3'
   s.add_dependency 'oj_mimic_json', '~> 1.0.1'
   s.add_dependency 'pandoc-ruby', '~> 2.0.1'
@@ -71,8 +70,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'pg', '0.20'
   s.add_dependency 'pg_search', '~> 2.1'
   s.add_dependency 'postgres_ext', '~> 3.0'
-  s.add_dependency 'rack-mini-profiler'
-  s.add_dependency 'rails', '4.2.11.1'
+  s.add_dependency 'rack-mini-profiler', '~> 2'
+  s.add_dependency 'rails', '~> 4.2.11'
   s.add_dependency 'rails-assets-classnames', '~> 2.2.3'
   s.add_dependency 'rails-assets-es6-promise', '~> 3.1.2'
   s.add_dependency 'rails-assets-eventemitter3', '~> 1.2.0'
@@ -83,13 +82,13 @@ Gem::Specification.new do |s|
   s.add_dependency 'rails-assets-selectize', '~> 0.12.1'
   s.add_dependency 'ransack', '~> 1.7.0'
   s.add_dependency 'react-rails', '~> 2.6.0'
-  s.add_dependency 'readthis'
+  s.add_dependency 'readthis', '~> 2'
   s.add_dependency 'redis', '< 4'
-  s.add_dependency 'resque'
-  s.add_dependency 'resque-scheduler'
+  s.add_dependency 'resque', '~> 2'
+  s.add_dependency 'resque-scheduler', '~> 4.4'
   s.add_dependency 'rest-client', '~> 1.8'
   s.add_dependency 'ruby-progressbar', '~> 1.7', '>= 1.7.5'
-  s.add_dependency 'rubyzip', '>= 1.3.0'
+  s.add_dependency 'rubyzip', '~> 2'
   s.add_dependency 'sanitize', '~> 5.0'
   s.add_dependency 'sass-rails', '~> 5.0'
   s.add_dependency 'simple_form', '~> 3.5'
@@ -101,19 +100,18 @@ Gem::Specification.new do |s|
   s.add_dependency 'validate_url', '~> 1.0'
   s.add_dependency 'virtus', '~> 1.0.5'
   s.add_dependency 'will_paginate', '~> 3.0.7'
-  s.add_dependency 'will_paginate-bootstrap'
+  s.add_dependency 'will_paginate-bootstrap', '~> 1'
 
-  s.add_development_dependency 'capybara-screenshot'
-  s.add_development_dependency 'capybara-selenium'
+  s.add_development_dependency 'capybara-screenshot', '~> 1'
   s.add_development_dependency 'database_cleaner', '~> 1'
   s.add_development_dependency 'dotenv-rails', '~> 2.2'
   s.add_development_dependency 'email_spec', '~> 2.1'
-  s.add_development_dependency 'factory_bot'
-  s.add_development_dependency 'faker'
+  s.add_development_dependency 'factory_bot', '~> 5'
+  s.add_development_dependency 'faker', '~> 2.1'
   s.add_development_dependency 'guard-livereload', '~> 2.5', '>= 2.5.2'
-  s.add_development_dependency 'mailcatcher'
+  s.add_development_dependency 'mailcatcher', '~> 0.7'
   s.add_development_dependency 'overcommit', '~> 0.49.1'
-  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'pry-byebug', '~> 3.7'
   s.add_development_dependency 'pry-rails', '~> 0.3.5'
   s.add_development_dependency 'puma', '~> 3'
   s.add_development_dependency 'quiet_assets', '~> 1.1'
@@ -123,9 +121,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'safe_attributes', '~> 1.0.10'
   s.add_development_dependency 'sdoc', '~> 0.4.0'
   s.add_development_dependency 'seedbank', '~> 0.3'
-  s.add_development_dependency 'shoulda-matchers'
-  s.add_development_dependency 'spring'
-  s.add_development_dependency 'spring-commands-rspec'
-  s.add_development_dependency 'traceroute'
+  s.add_development_dependency 'selenium-webdriver', '~> 3.142', '>= 3.142.7'
+  s.add_development_dependency 'shoulda-matchers', '~> 4.1'
+  s.add_development_dependency 'spring', '~> 2.1'
+  s.add_development_dependency 'spring-commands-rspec', '~> 1'
+  s.add_development_dependency 'traceroute', '~> 0.8'
   s.add_development_dependency 'webpacker', '~> 4.0.6'
 end

data/lib/doc_template/tags/base_tag.rb

@@ -16,7 +16,7 @@ module DocTemplate
         def tag_with_html_regexp
           raise NotImplementedError unless const_defined?(:TAG_NAME)
 
-          @tag_with_html_regexp ||= /\[[^\]]*#{self::TAG_NAME}[[^\:]]*:?\s?[^\]]*\]/i
+          @tag_with_html_regexp ||= /\[[^\]]*#{self::TAG_NAME}[[^\:,;.]]*:?\s?[^\]]*\]/i
         end
 
         def template_path_for(name)

data/lib/document_exporter/base.rb

@@ -51,10 +51,7 @@ module DocumentExporter
     def render_template(path, layout:)
       field = path.starts_with?('/') ? :file : :template
       # Using backport of Rails 5 Renderer here
-      ApplicationController.class_eval do
-        helper ::Lcms::Engine::Engine.helpers
-      end
-      ApplicationController.render(
+      Lcms::Engine::ApplicationController.render(
         field => path,
         layout: layout,
         locals: { document: @document, options: @options }