lcms-engine 0.3.1 → 0.4.1

data/db/seeds.rb

@@ -7,7 +7,6 @@ seeds = %w(
   curriculums.seeds.rb
   subjects.seeds.rb
   download_categories.seeds.rb
-  pages.seeds.rb
   development/users.seeds.rb
   development/grades.seeds.rb
 ).freeze

data/docker-compose.ror4.yml

@@ -0,0 +1,32 @@
+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-ror4:
+    image: lcms-engine:ror4
+    # Used to install native gem which solves build errors for nokogumbo and other gems
+    command: bash -c "gem install nokogiri && bundle install && yarn && tail -f /dev/null"
+    env_file:
+      - spec/dummy/.env.docker
+    environment:
+      REDIS_URL: redis://redis:6379/1
+    volumes:
+      - .:/app
+      - bundle-ror4:/usr/local/bundle
+    depends_on:
+      - db
+      - redis
+
+volumes:
+  bundle-ror4:
+  postgres:

data/docker-compose.yml

@@ -3,17 +3,17 @@ services:
   db:
     image: postgres:11.5-alpine
     ports:
-      - 5432:5432
+      - "5432:5432"
     volumes:
       - postgres:/var/lib/postgresql/data
 
   redis:
     image: redis:5.0.5-alpine
     ports:
-      - 6379
+      - "6379"
 
   app:
-    build: .
+    image: lcms-engine
     command: bash -c "bundle install && yarn && tail -f /dev/null"
     env_file:
       - spec/dummy/.env.docker
@@ -21,9 +21,12 @@ services:
       REDIS_URL: redis://redis:6379/1
     volumes:
       - .:/app
+      - ./node_modules:/app/node_modules
+      - bundle:/usr/local/bundle
     depends_on:
       - db
       - redis
 
 volumes:
+  bundle:
   postgres:

data/docs/env-variables.md

@@ -29,59 +29,59 @@
 ### AirBrake config
 The project is set up to support Airbrake, if you use it. You can provide an Airbrake ID and key in the config to enable it (Should be omitted for `development`&`test` environments)
 
-|Name|Description|
-|----|-----------|
-|AIR_BRAKE_PROJECT_ID|Project id in the AirBrake service|
-|AIR_BRAKE_PROJECT_KEY|Project key in the AirBrake service|
+| Name                  | Description                         |
+|-----------------------|-------------------------------------|
+| AIR_BRAKE_PROJECT_ID  | Project id in the AirBrake service  |
+| AIR_BRAKE_PROJECT_KEY | Project key in the AirBrake service |
 
 ### Amazon config
 The project uses AWS S3 to store and serve generated PDFs of learning content. You will need to set up an S3 bucket and provide a key and secret here:
 
-|Name|Description|
-|----|-----------|
-|AWS_ACCESS_KEY_ID|Public part of the AWS credentials|
-|AWS_REGION|Name of the region used for AWS service|
-|AWS_SECRET_ACCESS_KEY|Private part of the AWS credentials|
-|AWS_S3_BUCKET_NAME|Bucket used by application to store generated files|
+| Name                  | Description                                         |
+|-----------------------|-----------------------------------------------------|
+| AWS_ACCESS_KEY_ID     | Public part of the AWS credentials                  |
+| AWS_REGION            | Name of the region used for AWS service             |
+| AWS_SECRET_ACCESS_KEY | Private part of the AWS credentials                 |
+| AWS_S3_BUCKET_NAME    | Bucket used by application to store generated files |
 
 ### Google config
 The project uses several Google products, including analytics, OAuth for allowing the application to use Google APIs, and several Google Drive folders.
 
-|Name|Description|
-|----|-----------|
-|GOOGLE_APPLICATION_FOLDER_ID|Id of the Google Drive folder where generated lessons and materials will be placed(It's `0B7` for url like `https://drive.google.com/drive/u/0/folders/0B7/...`)|
-|GOOGLE_APPLICATION_SCRIPT_ID|Id of the Google Script created to post-process generated Google documents. More details can be found [here](google-cloud-platform-setup.md)|
-|GOOGLE_APPLICATION_SCRIPT_FUNCTION|Name of the function to call to start post-processing|
-|GOOGLE_APPLICATION_TEMPLATE_PORTRAIT|Id of the Google document which is a template for portrait materials(can be identified the same way as `GOOGLE_APPLICATION_FOLDER_ID `)|
-|GOOGLE_APPLICATION_TEMPLATE_LANDSCAPE|Id of the Google document which is a template for landscape materials(can be identified the same way as `GOOGLE_APPLICATION_FOLDER_ID `)|
-|GOOGLE_APPLICATION_PREVIEW_FOLDER_ID| Folder ID where preview documents should get placed
-|GOOGLE_API_CLIENT_UPLOAD_RETRIES||
-|GOOGLE_API_CLIENT_UPLOAD_TIMEOUT||
+| Name                                  | Description                                                                                                                                                      |
+|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| GOOGLE_APPLICATION_FOLDER_ID          | Id of the Google Drive folder where generated lessons and materials will be placed(It's `0B7` for url like `https://drive.google.com/drive/u/0/folders/0B7/...`) |
+| GOOGLE_APPLICATION_SCRIPT_ID          | Id of the Google Script created to post-process generated Google documents. More details can be found [here](google-cloud-platform-setup.md)                     |
+| GOOGLE_APPLICATION_SCRIPT_FUNCTION    | Name of the function to call to start post-processing                                                                                                            |
+| GOOGLE_APPLICATION_TEMPLATE_PORTRAIT  | Id of the Google document which is a template for portrait materials(can be identified the same way as `GOOGLE_APPLICATION_FOLDER_ID `)                          |
+| GOOGLE_APPLICATION_TEMPLATE_LANDSCAPE | Id of the Google document which is a template for landscape materials(can be identified the same way as `GOOGLE_APPLICATION_FOLDER_ID `)                         |
+| GOOGLE_APPLICATION_PREVIEW_FOLDER_ID  | Folder ID where preview documents should get placed                                                                                                              |
+| GOOGLE_API_CLIENT_UPLOAD_RETRIES      ||     |
+| GOOGLE_API_CLIENT_UPLOAD_TIMEOUT      ||     |
 
 ### Miscellaneous settings
-|Name|Description|
-|----|-----------|
-|APP_NAME|The title which will be shown in the page title and in other places. Something like `OpenSciEd LCMS`|
-|BITLY_API_TOKEN|Token of the Bitly service|
-|RESQUE_NAMESPACE|Value is used to separate data stored in Redis when the same redis server is used by multiple environments|
-|PUPPETEER_TIMEOUT|Default is 30 sec|
-|WORKERS_COUNT|Used on the servers. Specifies the number of workers to be started|
-|ELASTICSEARCH_ADDRESS|Elasticsearch server address|
+| Name                  | Description                                                                                                |
+|-----------------------|------------------------------------------------------------------------------------------------------------|
+| APP_NAME              | The title which will be shown in the page title and in other places. Something like `OpenSciEd LCMS`       |
+| BITLY_API_TOKEN       | Token of the Bitly service                                                                                 |
+| RESQUE_NAMESPACE      | Value is used to separate data stored in Redis when the same redis server is used by multiple environments |
+| PUPPETEER_TIMEOUT     | Default is 30 sec                                                                                          |
+| WORKERS_COUNT         | Used on the servers. Specifies the number of workers to be started                                         |
+| ELASTICSEARCH_ADDRESS | Elasticsearch server address                                                                               |
 
 Obs: if you're setting a local dev machine on OSX and getting small fonts when generating pdfs, try downgrading wkhtmltopdf to `0.12.3`
 
 ### PDF related config
-|Name|Description|
-|----|-----------|
-|ENABLE_BASE64_CACHING|Turns on/off caching of assets used for PDF generation (`true` by default, recommended as `false` for local env)|
-|NODE_ENV|We're using puppeteer(npm package) for PDF Generation, should be set as `production` for other env than local|
-|WKHTMLTOPDF_PATH|Path to the [wkhtmltopdf](https://wkhtmltopdf.org) binary. Default to `/usr/local/bin/wkhtmltopdf`. Will be removed when we will be certain on puppeteer|
+| Name                  | Description                                                                                                                                              |
+|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ENABLE_BASE64_CACHING | Turns on/off caching of assets used for PDF generation (`true` by default, recommended as `false` for local env)                                         |
+| NODE_ENV              | We're using puppeteer(npm package) for PDF Generation, should be set as `production` for other env than local                                            |
+| WKHTMLTOPDF_PATH      | Path to the [wkhtmltopdf](https://wkhtmltopdf.org) binary. Default to `/usr/local/bin/wkhtmltopdf`. Will be removed when we will be certain on puppeteer |
 
 ### Postgres config
-|Name|
-|----|
-|POSTGRESQL_ADDRESS|
-|POSTGRESQL_DATABASE|
-|POSTGRESQL_USERNAME|
-|POSTGRESQL_PASSWORD|
-|POSTGRESQL_PORT|
+| Name                |
+|---------------------|
+| POSTGRESQL_ADDRESS  |
+| POSTGRESQL_DATABASE |
+| POSTGRESQL_USERNAME |
+| POSTGRESQL_PASSWORD |
+| POSTGRESQL_PORT     |

data/docs/google-cloud-platform-setup.md

@@ -1,3 +1,5 @@
+# Google Cloud Platform setup
+
 An application calls the Google Application Script in order to post-process generated lesson materials. Instructions below contains all the necessary steps need to set up the integration.
 
 All environment variables and user names provided here have been set up to automate deployment on [Cloud66](https://www.cloud66.com) service stacks. If you plan to use another service provider please change all the variables accordingly.
@@ -7,22 +9,42 @@ All environment variables and user names provided here have been set up to autom
 
 ## Set up
 
-1. Login to google (all google docs will be saved under this account)
+### Update host application's routes
+
+In order to intercept OAuth callback host application's routes should be updated.
+In the sample bellow the Engine is mounted to `/lcms` and this prefix is used in the interceptor.
+You can replace it with whatever prefix has been used in your own project.
+```ruby
+# config/routes.rb
+
+mount Lcms::Engine::Engine, at: '/lcms'
+
+# OAuth2 redirect interceptor
+get 'oauth2callback', to: redirect(path: '/lcms/oauth2callback')
+```
+
+### Login to google
+
+All google docs will be saved under this account. Also, this Google Account should have access to all source documents which will be imported into the system.
+
+### Create project
 
-2. Create project (i.e. LCMS-dev) at [google cloud](https://console.cloud.google.com)
+Name it whatever you like, i.e. LCMS-dev at [google cloud](https://console.cloud.google.com)
 
-3. Enable Google Drive API, Google Apps Script Execution API for that [project](https://console.cloud.google.com/apis/library)
+### Enable Google API
 
-4. Set up google auth
+Enable Google Drive API, Google Apps Script Execution API for that [project](https://console.cloud.google.com/apis/library)
+
+### Set up google auth
 
 #### Credentials
 
 Create credentials:
   - type oAuth Client ID
-  - Application type: Other,
-  - Aplication Name: up to you, i.e. lcms-cli-dev
+  - Application type: Web Application,
+  - Application Name: up to you, i.e. lcms-cli-dev
 
-Download client secret JSON file.
+Download credentials JSON file.
 
 ###### Local development
 
@@ -59,10 +81,11 @@ If you generate token on a remote server, then make sure you're executing comman
 $ sudo -i -u cloud66-user
 ```
 
-Run rake task. You will be asked to go by link, give app permissions and paste code into the terminal
+Run rake task providing the domain name which is registered as _Authorized redirect URIs_ in Google OAuth client.
+You will be asked to go by link, give app permissions and paste code into the terminal
 
 ```bash
-$ bundle exec rake google:setup_auth
+$ bundle exec rake google:setup_auth["https://example.com"]
 ```
 
 This will create `config/google/app_token.yaml`. Change the ownership of the `app_token.yaml` otherwise it will not be accessible for the application:
@@ -73,23 +96,28 @@ $ chown cloud66-user:app_writers app_token.yaml
 $ sudo chmod g+w app_token.yaml
 ```
 
-5. Add script
+#### Add Google App script
+
 - go to https://www.google.com/script/start/
 - copy-paste content of `config/scripts/Code.gs` there and save
 - at top menu Resources->Cloud Platform Project set project from step 2 (you need to paste *project number*)
 - at top menu Publish->Deploy As API Executable set version v1, access Only myself
-- save Current API ID somewhere, click Close on that annoying window (update will not close it)
+- save Current API ID somewhere (wil be used for _GOOGLE_APPLICATION_SCRIPT_ID_), click Close on that annoying window (update will not close it)
 - choose any function and run it, it'll request permissions - grant them (there will be security warnings, just ignore them)
 
-6. Create folder (all materials will be saved there) on Google Drive, give view only to all by link, keep folder id (last part of url), copy to the root [LANDSCAPE](https://docs.google.com/document/d/1pXQDNKYOJYT6OTPnp8gsTWAydg5B9GTRibaWspmX4oE), [PORTRAIT](https://docs.google.com/document/d/1ijuZhGQXkPBxcZT4DRyNVY-qmI0xyVvSzVFqckOpsCc) templates and keep their IDs.
+### Create special folder in Google Drive
 
-7. Update corresponding env-file in the project
+All materials will be saved there. Give view only to all by link, keep folder id (last part of url) for _GOOGLE_APPLICATION_FOLDER_ID_,
+copy to the root of the this folder these documents and keep their IDs for (_GOOGLE_APPLICATION_TEMPLATE_LANSCAPE_, _GOOGLE_APPLICATION_TEMPLATE_PORTRAIT_):
+- [LANDSCAPE](https://docs.google.com/document/d/1pXQDNKYOJYT6OTPnp8gsTWAydg5B9GTRibaWspmX4oE)
+- [PORTRAIT](https://docs.google.com/document/d/1ijuZhGQXkPBxcZT4DRyNVY-qmI0xyVvSzVFqckOpsCc)
 
+### Update corresponding env-file in the project
 ```
-GOOGLE_APPLICATION_FOLDER_ID=saved from step 6
-GOOGLE_APPLICATION_SCRIPT_ID=saved id from step 5
-GOOGLE_APPLICATION_TEMPLATE_PORTRAIT=saved from step 6
-GOOGLE_APPLICATION_TEMPLATE_LANSCAPE=saved from step 6
+GOOGLE_APPLICATION_FOLDER_ID=
+GOOGLE_APPLICATION_SCRIPT_ID=
+GOOGLE_APPLICATION_TEMPLATE_PORTRAIT=
+GOOGLE_APPLICATION_TEMPLATE_LANSCAPE=
 ```
 
 ## How to update Google Application Script

data/docs/how-to-build-and-publish.md

@@ -0,0 +1,14 @@
+# How to build and publish gem
+
+Increase the version in `lib/lcms/engine/version.rb` and update `CHANGELOG.md`.
+
+Build the gem
+```bash
+$ gem build lcms-engine.gemspec
+```
+
+Publish it replacing `x-y-z` with correct version number.
+```bash
+$ gem signin
+$ gem push lcms-engine-x-y-z.gem
+```

data/docs/pdf-generation.md

@@ -0,0 +1,31 @@
+# PDF Generation
+
+We're using [puppeteer](https://pptr.dev/) with headless chrome for PDF generation.
+
+## PDF security policy
+After fresh server installation ImageMagick security policies have to be updated. Complete the following steps:
+
+1. Locate the file `/etc/ImageMagick-6/policy.xml`
+2. Find the policy for PDF format. It looks like this
+```xml
+<policy domain="coder" rights="none" pattern="PDF" />
+```
+3. Change it to this
+```xml
+<policy domain="coder" rights="read|write" pattern="PDF" />
+```
+
+## Local development
+1. install google chrome (see details on #google-chrome-version)
+2. set `ENABLE_BASE64_CACHING` as `false` or don't forger to clean cache on pdf related css/images changes (see below)
+3. install `puppeteer`: `nvm use && yarn install`
+4. set up own s3 bucket to avoid overwriting conflicts (`AWS_S3_BUCKET_NAME`)
+
+## Deployment
+1. on setting up new stack: add blank pages to s3 bucket (`rake openscied_core:s3_blank_page`)
+2. on deploying new version with changes at pdf related css/images: clean cached assets (`rake cache:reset_base64`)
+
+## Google Chrome version
+Chrome version is set as `70`, if we need to use newer release
+1. check PDF generation
+2. change deployment [hook](https://github.com/learningtapestry/openscied-lcms/blob/master/.cloud66/install_chrome.sh#L3) and redeploy (_NOTE_: maybe add `CHROME_VERSION` env variable?)

data/lcms-engine.gemspec

@@ -15,18 +15,24 @@ Gem::Specification.new do |s|
   s.summary = 'Rails engine for LCMS applications'
   s.description = 'Implements common components and features for Rails-based LCMS systems'
   s.license = 'Apache-2.0'
+  s.metadata = {
+    'homepage_uri' => 'https://github.com/learningtapestry/lcms-engine',
+    'changelog_uri' => 'https://github.com/learningtapestry/lcms-engine/blob/master/CHANGELOG.md',
+    'rubygems_mfa_required' => 'true',
+    'source_code_uri' => 'https://github.com/learningtapestry/lcms-engine',
+    'bug_tracker_uri' => 'https://github.com/learningtapestry/lcms-engine/issues'
+  }
 
   s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- spec/*`.split("\n")
 
-  s.required_ruby_version = '>= 2.6'
+  s.required_ruby_version = '~> 2.7'
 
   s.add_dependency 'activejob-retry', '~> 0.6.3'
   s.add_dependency 'active_model_serializers', '~> 0.10.10'
   s.add_dependency 'acts_as_list', '~> 1.0'
-  s.add_dependency 'acts-as-taggable-on', '~> 6.5'
+  s.add_dependency 'acts-as-taggable-on', '~> 7.0'
   s.add_dependency 'addressable', '~> 2.7'
-  s.add_dependency 'airbrake', '~> 10.0'
+  s.add_dependency 'airbrake', '~> 13.0'
   s.add_dependency 'autoprefixer-rails', '~> 9.7'
   s.add_dependency 'aws-sdk-rails', '~> 3.1'
   s.add_dependency 'aws-sdk-s3', '~> 1'
@@ -34,7 +40,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'bootstrap-sass', '~> 3.4'
   s.add_dependency 'bullet', '~> 6.1', '>= 6.1.0'
   s.add_dependency 'carrierwave', '~> 2.1'
-  s.add_dependency 'ckeditor', '~> 4.3'
+  s.add_dependency 'ckeditor', '~> 5.1'
   s.add_dependency 'closure_tree', '~> 7.1'
   s.add_dependency 'combine_pdf', '~> 1.0'
   s.add_dependency 'daemons', '~> 1.3', '>= 1.3.1'
@@ -52,31 +58,32 @@ Gem::Specification.new do |s|
   s.add_dependency 'jbuilder', '~> 2.10'
   s.add_dependency 'jquery-rails', '~> 4.3', '>= 4.3.5'
   s.add_dependency 'js-routes', '~> 1.4', '>= 1.4.9'
-  s.add_dependency 'lt-google-api', '~> 0.2', '>= 0.2.2'
-  s.add_dependency 'lt-lcms', '~> 0.4', '>= 0.4.1'
+  s.add_dependency 'lt-google-api', '~> 0.2', '>= 0.2.3'
+  s.add_dependency 'lt-lcms', '~> 0.4', '>= 0.4.4'
   s.add_dependency 'migration_data', '~> 0.6'
   s.add_dependency 'mini_magick', '~> 4.10', '>= 4.10.1'
   s.add_dependency 'nested_form', '~> 0.3.2'
   s.add_dependency 'nikkou', '~> 0.0.5'
-  s.add_dependency 'nokogiri', '~> 1.10', '>= 1.10.8'
+  s.add_dependency 'nokogiri', '~> 1.11', '>= 1.11.4'
   s.add_dependency 'oj', '~> 3.10', '>= 3.10.2'
   s.add_dependency 'oj_mimic_json', '~> 1.0', '>= 1.0.1'
   s.add_dependency 'pandoc-ruby', '~> 2.0', '>= 2.0.2'
   s.add_dependency 'pdfjs_viewer-rails', '~> 0.3.1'
   s.add_dependency 'pg', '~> 1.2', '>= 1.2.2'
   s.add_dependency 'pg_search', '~> 2.3', '>= 2.3.2'
-  s.add_dependency 'rack-mini-profiler', '~> 1.1', '>= 1.1.6'
-  s.add_dependency 'rails', '~> 5.2', '>= 5.2.4'
+  s.add_dependency 'rack-mini-profiler', '~> 2.3', '>= 2.3.3'
+  s.add_dependency 'rails', '~> 6.1.6', '>= 6.1.6.1'
   s.add_dependency 'ransack', '~> 2.3', '>= 2.3.2'
   s.add_dependency 'react-rails', '~> 2.6', '>= 2.6.1'
   s.add_dependency 'redis', '~> 4.1', '>= 4.1.3'
   s.add_dependency 'resque', '~> 2.0', '>= 2.0.0'
   s.add_dependency 'resque-scheduler', '~> 4.4', '>= 4.4.0'
   s.add_dependency 'rest-client', '~> 2.1', '>= 2.1.0'
+  s.add_dependency 'retriable', '~> 3.1'
   s.add_dependency 'ruby-progressbar', '~> 1.10', '>= 1.10.1'
   s.add_dependency 'rubyzip', '~> 2'
   s.add_dependency 'sanitize', '>= 5.1', '< 5.3'
-  s.add_dependency 'sass-rails', '~> 5.1', '>= 5.1.0'
+  s.add_dependency 'sass-rails', '~> 6'
   s.add_dependency 'simple_form', '~> 5.0', '>= 5.0.2'
   s.add_dependency 'staccato', '~> 0.5.3'
   s.add_dependency 'truncate_html', '~> 0.9.3'
@@ -85,26 +92,31 @@ Gem::Specification.new do |s|
   s.add_dependency 'virtus', '~> 1.0', '>= 1.0.5'
   s.add_dependency 'will_paginate', '~> 3.2', '>= 3.2.1'
   s.add_dependency 'will_paginate-bootstrap', '~> 1.0', '>= 1.0.2'
+  s.add_dependency 'with_advisory_lock', '~> 4.6'
 
   s.add_development_dependency 'capybara', '~> 3.31'
   s.add_development_dependency 'database_cleaner-active_record', '~> 1.8'
   s.add_development_dependency 'dotenv-rails', '~> 2.2'
-  s.add_development_dependency 'email_spec', '~> 2.1'
+  s.add_development_dependency 'email_spec', '2.2.0'
   s.add_development_dependency 'factory_bot', '~> 5'
   s.add_development_dependency 'faker', '~> 2.1'
   s.add_development_dependency 'overcommit', '~> 0.57'
   s.add_development_dependency 'pry-byebug', '~> 3.7'
   s.add_development_dependency 'pry-rails', '~> 0.3.5'
-  s.add_development_dependency 'rspec-rails', '~> 3.8'
-  s.add_development_dependency 'rubocop', '~> 0.93.1'
+  s.add_development_dependency 'rspec-rails', '~> 4.0.2'
+  s.add_development_dependency 'rubocop', '~> 1.17'
   s.add_development_dependency 'safe_attributes', '~> 1.0.10'
   s.add_development_dependency 'sdoc', '~> 2'
   s.add_development_dependency 'seedbank', '~> 0.3'
   s.add_development_dependency 'selenium-webdriver', '~> 3.142', '>= 3.142.7'
   s.add_development_dependency 'shoulda-matchers', '~> 4.1'
+  # Workaround for cc-test-reporter with SimpleCov 0.18.
+  # Stop upgrading SimpleCov until the following issue will be resolved.
+  # https://github.com/codeclimate/test-reporter/issues/418
+  s.add_development_dependency 'simplecov', '< 0.18'
   s.add_development_dependency 'spring', '~> 2.1'
   s.add_development_dependency 'spring-commands-rspec', '~> 1.0'
   s.add_development_dependency 'traceroute', '~> 0.8'
   s.add_development_dependency 'webdrivers', '~> 4.0'
-  s.add_development_dependency 'webpacker', '~> 4.0'
+  s.add_development_dependency 'webpacker', '~> 5.0'
 end

data/lib/doc_template/document.rb

@@ -62,7 +62,7 @@ module DocTemplate
     def check_loop_tag(name, value)
       if @opts.dig(:last_tag, :name) == name && @opts.dig(:last_tag, :value) == value &&
          @opts.dig(:last_tag, :iteration) > DocTemplate::Document::MAX_PARSE_ITERATIONS
-        raise ::DocumentError, "Loop detected for tag #{name} with value #{value}"
+        raise ::Lcms::Engine::DocumentError, "Loop detected for tag #{name} with value #{value}"
       end
     end
 
@@ -154,7 +154,7 @@ module DocTemplate
     def handle_invalid_tag(node)
       return if ::DocTemplate::FULL_TAG.match(node.text).present?
 
-      raise DocumentError, "No closing bracket for node:<br>#{node.to_html}"
+      raise Lcms::Engine::DocumentError, "No closing bracket for node:<br>#{node.to_html}"
     end
 
     def parse_node(node)
@@ -171,8 +171,7 @@ module DocTemplate
       store_last_tag tag_name, tag_value
 
       parsed_content = parsed_tag.content.presence || parsed_tag.render.to_s
-      sanitized_content = ::DocTemplate.config['sanitizer'].constantize
-                            .post_processing(parsed_content, @opts)
+      sanitized_content = ::DocTemplate.sanitizer.post_processing(parsed_content, @opts)
 
       return if TAGS_WITHOUT_PARTS.include?(tag::TAG_NAME)
 

data/lib/doc_template/document_toc.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DocTemplate
-  class DocumentTOC
+  class DocumentToc
     REGISTERED_METADATA = %i(agenda sections).freeze
     private_constant :REGISTERED_METADATA
 
@@ -11,7 +11,7 @@ module DocTemplate
     #
     def self.parse(opts = {})
       metadata = REGISTERED_METADATA.detect { |m| opts[m]&.children.present? }
-      Objects::TOCMetadata.new opts[metadata]
+      Objects::TocMetadata.new opts[metadata]
     end
   end
 end

data/lib/doc_template/objects/activity_metadata.rb

@@ -44,7 +44,7 @@ module DocTemplate
 
       attribute :children, Array[Activity]
       attribute :idx, Integer
-      attribute :task_counter, Hash[String => Integer], default: {}
+      attribute :task_counter, Hash[String => Integer], default: {} # rubocop:disable Style/HashConversion
 
       def self.build_from(data)
         copy = Marshal.load Marshal.dump(data)

data/lib/doc_template/objects/toc_helpers.rb

@@ -7,7 +7,7 @@ module DocTemplate
 
       def level1_by_title(title)
         l1 = children.find { |c| !c.handled && c.title.parameterize == title }
-        raise DocumentError, "Level1 header #{title} not found at metadata" unless l1.present?
+        raise Lcms::Engine::DocumentError, "Level1 header #{title} not found at metadata" unless l1.present?
 
         l1.handled = true
         l1
@@ -18,12 +18,12 @@ module DocTemplate
           l2 = c.children.find { |c1| c1.title.parameterize == title }
           return l2 if l2.present?
         end
-        raise DocumentError, "Level2 header #{title} not found at metadata"
+        raise Lcms::Engine::DocumentError, "Level2 header #{title} not found at metadata"
       end
 
       def find_by_anchor(anchor)
         l1 = children.find { |c| c.anchor == anchor }
-        raise DocumentError, "Anchor #{anchor} not found at metadata" if l1.blank?
+        raise Lcms::Engine::DocumentError, "Anchor #{anchor} not found at metadata" if l1.blank?
 
         l1
       end
@@ -34,7 +34,7 @@ module DocTemplate
       #     result = s.children.detect { |c| c.anchor == anchor }
       #     return result if result.present?
       #   end
-      #   raise DocumentError, "Anchor #{anchor} not found at metadata"
+      #   raise Lcms::Engine::DocumentError, "Anchor #{anchor} not found at metadata"
       # end
 
       class_methods do

data/lib/doc_template/objects/toc_metadata.rb

@@ -2,7 +2,7 @@
 
 module DocTemplate
   module Objects
-    class TOCMetadata
+    class TocMetadata
       include Virtus.model
 
       class Heading
@@ -27,19 +27,17 @@ module DocTemplate
           children.any? && children.all? { |c| c.excluded?(excludes) }
         end
 
-        def time_with(excludes) # rubocop:disable Metrics/PerceivedComplexity
+        def time_with(excludes)
           # Optional and nothing to exclude explicitly
           return excludes.include?(anchor) ? time : 0 if optional
           # General and excluded explicitly
           return 0 if excludes.include?(anchor)
 
-          # do not re-caclculate time if
+          # do not recalculate time if
           # - there are no optional children
           # - no excludes passed
           # - there are no children at all
-          if children.any?(&:optional)
-            children.sum { |c| c.time_with(excludes) }
-          elsif children.blank? || excludes.blank?
+          if children.blank? || excludes.blank?
             time
           else
             children.sum { |c| c.time_with(excludes) }

data/lib/doc_template/tags/answer_space_tag.rb

@@ -14,7 +14,7 @@ module DocTemplate
         num_of_lines = SPACE_SIZE[opts[:value].try(:to_sym)]
         if num_of_lines
           space = '<br>' * num_of_lines
-          @content = node.to_html.sub(/\[#{TAG_NAME}:\s?[s|m|l]\]/i, space)
+          @content = node.to_html.sub(/\[#{TAG_NAME}:\s?[sml]\]/i, space)
         end
         replace_tag node
         self

data/lib/doc_template/tags/base_tag.rb

@@ -35,7 +35,7 @@ module DocTemplate
         # need to remove unicode spaces bc they're not handled by [[:graph:]]
         return unless node.content.gsub(UNICODE_SPACES_RE, '') =~ SOFT_RETURN_RE
 
-        raise ::DocumentError,
+        raise ::Lcms::Engine::DocumentError,
               "Soft return for #{self.class::TAG_NAME} detected: #{node.content}, use hard return instead"
       end
 
@@ -104,7 +104,7 @@ module DocTemplate
         if node == opts[:parent_node]
           opts[:iteration] = opts[:iteration].to_i + 1
           if opts[:iteration] > DocTemplate::Document::MAX_PARSE_ITERATIONS
-            raise ::DocumentError, "Loop detected for node:<br>#{node}"
+            raise ::Lcms::Engine::DocumentError, "Loop detected for node:<br>#{node}"
           end
         end
         parsed = ::DocTemplate::Document.parse(Nokogiri::HTML.fragment(node), opts.merge(level: 1))

data/lib/doc_template/tags/block_tag.rb

@@ -8,7 +8,7 @@ module DocTemplate
       def no_end_tag_for(node)
         msg = "No tag with END value for: #{self.class::TAG_NAME.upcase}<br>" \
               "<em>#{node.parent.try(:inner_html)}</em>"
-        raise DocumentError, msg
+        raise Lcms::Engine::DocumentError, msg
       end
 
       #

data/lib/doc_template/tags/table_tag.rb

@@ -5,7 +5,7 @@ module DocTemplate
     class TableTag < BaseTag
       def parse(node, opts = {})
         unless (table = node.ancestors('table').first)
-          raise ::DocumentError, "Tag #{self.class::TAG_NAME.upcase} placed outside table"
+          raise ::Lcms::Engine::DocumentError, "Tag #{self.class::TAG_NAME.upcase} placed outside table"
         end
 
         @opts = opts

data/lib/doc_template/template.rb

@@ -101,7 +101,7 @@ module DocTemplate
           placeholder: nil
         }
 
-        @toc ||= ::DocTemplate::DocumentTOC.parse(options) unless material?
+        @toc ||= ::DocTemplate::DocumentToc.parse(options) unless material?
       end
 
       self