lcms-engine 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11fd71f5879367d4d022bf7f02137c762e80c2f835cc56d30075d03501e244f3
-  data.tar.gz: a257fee98853e8e60a76b9e7b42dc660d40d8d700a028171efdfcefbc0db116b
+  metadata.gz: 231320b0501e5b869cb18ddfbd9303ff59a46f5cbe4d1c1dde514e3e142d0fbc
+  data.tar.gz: f9a52a55bcdfe1ac8d35a094a744489ab22e683a3ddfab0dc65c8c5fe65f7123
 SHA512:
-  metadata.gz: cdc8564069095d46f1196f395691755614395f206f85474593644fbcfffa27e365d4b8baca5a502ec75632c4d048c6b444cf7006c39e5aa3d754ca453e8ac1e3
-  data.tar.gz: 0c1b2a1fdc5435e4eb2d0d6b8598fafe792c69632538cb69fd31cd8b2dce9dac0919ae1f4c6550c1409c2b293ad1678980867efb500893f73e4dc6ef6801f1df
+  metadata.gz: d864539ad2e681823e9801be80b1ee16051970d4610a197e49e662953bba740a38aa86476a6e43f11427623a3bc6cab63186964792e9452fcaac769f64f23281
+  data.tar.gz: 996c695e355795f92897b07c39788c9aa1fbe1d9a666d82089175b96a850b847533557f8b7ee2dd7f6347c4a5b10a570a8355a706230077eeb25943ad45437d5

data/.ruby-version

@@ -1 +1 @@
-2.5.2
+2.5.7

data/CHANGELOG.md

@@ -4,7 +4,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/learningtapestry/lcms-engine/compare/v0.1.0...HEAD)
+## [0.1.2](https://github.com/learningtapestry/lcms-engine/compare/v0.1.0...v0.1.2) - 2020.04.23
+
+### Added
+- Add Docker support [@paranoicsan](https://github.com/paranoicsan)
+
+### Changed
+- Assets optimization [@paranoicsan](https://github.com/paranoicsan)
+- Replace [capybara-selenium](https://github.com/dsaenztagarro/capybara-selenium) with [selenium-webdriver](https://rubygems.org/gems/selenium-webdriver) [@paranoicsan](https://github.com/paranoicsan)
+ 
+### Removed
+- Remove [I18n.js gem](https://github.com/fnando/i18n-js) [@paranoicsan](https://github.com/paranoicsan)
+
+### Fixed
+- Fix preview path on admin panel documents and materials index page [@paranoicsan](https://github.com/paranoicsan)
+- Fix parse loop when content of the tag  contains tag name [@paranoicsan](https://github.com/paranoicsan)
+- Fix possible grade leading zeros [@shlag3n](https://github.com/shlag3n)
+- Fix nested jobs concern [@shlag3n](https://github.com/shlag3n)
 
 ## [0.1.0] - 2020.01.13
 

data/Dockerfile

@@ -0,0 +1,28 @@
+FROM ruby:2.5.7
+
+ENV APP_PATH /app/
+
+WORKDIR $APP_PATH
+
+RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - \
+    && echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list  \
+    && curl -sL https://deb.nodesource.com/setup_10.x | bash - \
+    && apt-get update -qqy \
+    && apt-get install -y --no-install-recommends nodejs yarn \
+    && rm -rf /var/lib/apt/lists/* /var/cache/apt/*
+
+# Add codebase
+ADD . $APP_PATH
+
+# Install gems
+ADD lcms-engine.gemspec $APP_PATH
+ADD Gemfile* $APP_PATH
+RUN gem install bundler -v 1.17.3 \
+    && bundle install --jobs `expr $(cat /proc/cpuinfo | grep -c "cpu cores") - 1` --retry 3 \
+    && rm -rf /usr/local/bundle/cache/*.gem \
+    && find /usr/local/bundle/gems/ -name "*.c" -delete \
+    && find /usr/local/bundle/gems/ -name "*.o" -delete
+
+# Install yarn packages
+COPY package.json yarn.lock $APP_PATH
+RUN yarn install

data/Gemfile

@@ -18,4 +18,5 @@ gemspec
 # gem 'byebug', group: [:development, :test]
 
 gem 'wicked_pdf', git: 'https://github.com/learningtapestry/wicked_pdf.git',
-                  branch: 'puppeteer-support', ref: '67f73d3'
+                  branch: 'puppeteer-support',
+                  ref: '964a090'

data/README.md

@@ -11,6 +11,11 @@ separately, simplifying the client applications in the process.
 
 ## Current development
 
+|Branch|Rails version|
+|------|-------------|
+|master|Rails 5.2.4.2|
+|0.1.x|Rails 4.2.11|
+
 This is still a [work in progress](https://github.com/learningtapestry/lcms-engine/issues/3). The
 initial phase of the project consisted in extracting as much code as possible from the client
 projects and set the engine as the core foundation for further development and optimizations.
@@ -26,18 +31,6 @@ options.
 The following are a few recommendations and guidelines to keep in mind when modifying code in the
 engine as well as making the client projects aware of these changes.
 
-## Targeting Rails versions
-
-For the most part, the engine targets Rails version 5, but it's also compatible with version 4.2.
-
-So far, we have not encountered any major obstacles to guarantee compatibility with both versions,
-but in some cases we can all agree that total compatibility can be difficult to achieve.
-
-Overall, it's fine to add a few conditionals here and there to check the running version of the
-framework, like [in this case](https://github.com/learningtapestry/lcms-engine/blob/master/lib/lcms/engine/migration.rb).
-However, when you feel you're adding too many conditionals, perhaps it's time to consider creating
-specific versions that cater to individual Rails releases.
-
 ## Use of separate gems
 
 In our opinion, the creation of separate gems in a given project only makes sense when the features
@@ -90,14 +83,14 @@ the same files, overwriting the ones provided by the engine.
 
 ## Requirements
 - Ruby 2.5 or higher
-- Rails 4.2 or higher
+- Rails 4.2.11.x
 - Postgres 9.6 or higher
 
 ## Installation
 Include the gem in your Gemfile:
 
 ```ruby
-gem 'lcms-engine', git: 'https://github.com/learningtapestry/lcms-engine.git', branch: 'master'
+gem 'lcms-engine', git: 'https://github.com/learningtapestry/lcms-engine.git', branch: '0.1.x'
 ```
 
 And then execute:
@@ -192,7 +185,7 @@ All migrations included in the gem are already available for you to run from ins
 
 You need to run special rake task if default routes were overridden
 ```bash
-bundle exec rake js-routes:generate
+$ bundle exec rake js-routes:generate
 ```
 
 ## Developing and testing
@@ -206,10 +199,23 @@ connection (see `spec/dummy/.env` as a template)
 `chromedriver` is required to run feature specs. You may find OS-specific instructions [here](https://sites.google.com/a/chromium.org/chromedriver/getting-started).
 For macOS it can be installed with Homebrew:
 
+```bash
+$ brew tap homebrew/cask
+$ brew cask install chromedriver
+```
+
+#### Using Docker
+
+Launch the containers
+```sh
+$ docker-compose start app
+```
+
+Start the specs
 ```sh
-brew tap homebrew/cask
-brew cask install chromedriver
+$ docker-compose exec app sh -c 'bundle exec rspec'
 ```
 
+
 ## License
 The gem is available as open source under the terms of the [Apache License](https://github.com/learningtapestry/lcms-engine/blob/master/LICENSE).

data/app/assets/config/lcms_engine_manifest.js

@@ -1,15 +1,8 @@
 // JS and CSS bundles
 
-//= link lcms/engine/application.js
-//= link lcms/engine/application_lti.js
-//= link lcms/engine/pdf_js_preview.js
-//= link pdf.worker.js
+//= link lcms/engine/admin/application.js
 
-// TODO: Need to rebundle according to requirements
-//= link lcms/engine/application.scss
 //= link lcms/engine/admin.scss
-//= link lcms/engine/pdf.scss
-//= link lcms/engine/pdf_plain.scss
 
 // Images and fonts so that views can link to them
 //

data/app/assets/javascripts/lcms/engine/admin/application.js

@@ -2,7 +2,6 @@
 //= require jquery2
 //= require jquery_ujs
 //= require jquery_nested_form
-//= require i18n/translations
 //= require lodash
 //= require foundation.initialize
 //= require ckeditor/init
@@ -14,7 +13,6 @@
 //= require jquery.tagsinput
 //= require jstree
 //= require js-routes
-//= require ../initializers/google_analytics
 
 document.addEventListener('turbolinks:load', function () {
   $(document).initFoundation();
@@ -24,5 +22,10 @@ document.addEventListener('turbolinks:load', function () {
     plugins: ['remove_button']
   });
 
-  window.initializeGoogleAnalytics();
+  if (window.ga) {
+    ga('set', 'location', location.href.split('#')[0]);
+    ga('send', 'pageview', {
+      "title": document.title
+    });
+  }
 });

data/app/assets/javascripts/lcms/engine/application.js

@@ -1,10 +1,8 @@
 //= require turbolinks
 //= require jquery2
 //= require jquery_ujs
-//= require i18n/translations
 //= require modernizr-custom
 //= require swiper.jquery
-//= require pdfobject.js
 //= require smoothscrolling
 //= require lodash
 //= require foundation

data/app/assets/javascripts/lcms/engine/application_lti.js

@@ -1,10 +1,8 @@
 //= require turbolinks
 //= require jquery2
 //= require jquery_ujs
-//= require i18n/translations
 //= require modernizr-custom
 //= require swiper.jquery
-//= require pdfobject.js
 //= require smoothscrolling
 //= require lodash
 //= require foundation.initialize

data/app/assets/stylesheets/lcms/engine/components/_instruction-cards.scss

@@ -143,9 +143,6 @@ $media-img-height: 110px;
 
     @include e(icon) {
       @include fa-icon;
-      &:before {
-        content: $fa-var-play-circle-o;
-      }
     }
   }
 

data/app/controllers/lcms/engine/admin/admin_controller.rb

@@ -25,11 +25,11 @@ module Lcms
           end
 
           def document_path(*args)
-            host_engine_path(:document_path, args).presence || url_helpers.document_path(args)
+            host_engine_path(:document_path, *args).presence || url_helpers.document_path(*args)
           end
 
           def material_path(*args)
-            host_engine_path(:material_path, args).presence || url_helpers.material_path(args)
+            host_engine_path(:material_path, *args).presence || url_helpers.material_path(*args)
           end
 
           def root_path
@@ -38,9 +38,9 @@ module Lcms
 
           def host_engine_path(key, *args)
             if (host_route = settings.dig(:redirect, :host, key)).present?
-              Rails.application.routes.url_helpers.send(host_route, args)
+              Rails.application.routes.url_helpers.send(host_route, *args)
             elsif (engine_route = settings.dig(:redirect, :engine, key)).present?
-              engine_klass.routes.url_helpers.send(engine_route, args)
+              engine_klass.routes.url_helpers.send(engine_route, *args)
             end
           end
 

data/app/helpers/lcms/engine/view_helper.rb

@@ -99,10 +99,6 @@ module Lcms
         strip_tags(str).squish
       end
 
-      def generic_page?
-        controller.controller_name == 'resources' && controller.action_name == 'generic'
-      end
-
       def set_social_media_sharing(target) # rubocop:disable Naming/AccessorMethodName
         @social_media_presenter = SocialMediaPresenter.new(target: target, view: self)
       end

data/app/javascript/components/admin/association-picker/AssociationPickerItem.jsx

@@ -1,3 +1,5 @@
+import React from 'react';
+
 // eslint-disable-next-line no-unused-vars
 function AssociationPickerItem(props) {
   let input

data/app/javascript/components/admin/association-picker/AssociationPickerResults.jsx

@@ -1,3 +1,5 @@
+import React from 'react';
+
 function AssociationPickerResults(props) {
   let items
 

data/app/javascript/components/admin/association-picker/AssociationPickerWindow.jsx

@@ -1,5 +1,5 @@
 import React from 'react'
-// import AssociationPickerResults from './AssociationPickerResults'
+import AssociationPickerResults from './AssociationPickerResults'
 
 class AssociationPickerWindow extends React.Component {
   constructor(props) {

data/app/javascript/components/admin/picker/pickerWindowWrapper.jsx

@@ -1,5 +1,5 @@
 import React from 'react'
-// import PaginationBoxView from '../../paginate/PaginationBoxView'
+import PaginationBoxView from '../../paginate/PaginationBoxView'
 // import Routes from '../../../js-routes.js.erb';
 
 // eslint-disable-next-line no-unused-vars

data/app/javascript/components/admin/resource-picker/ResourcePicker.jsx

@@ -1,8 +1,8 @@
 import React from 'react'
 import ReactDOM from 'react-dom'
 import ResourcePickerWindow from './ResourcePickerWindow'
-// import ResourcePickerResource from './ResourcePickerResource'
-// import PickerButton from '../picker/PickerButton'
+import ResourcePickerResource from './ResourcePickerResource'
+import PickerButton from '../picker/PickerButton'
 import pickerWindowWrapper from '../picker/pickerWindowWrapper'
 import pickerModal from '../picker/pickerModal'
 

data/app/javascript/components/paginate/PaginationBoxView.jsx

@@ -2,7 +2,7 @@
 
 import React from 'react'
 import PropTypes from 'prop-types'
-// import PaginationListView from './PaginationListView'
+import PaginationListView from './PaginationListView'
 import classNames from 'classnames'
 
 class PaginationBoxView extends React.Component {

data/app/javascript/components/paginate/PaginationListView.jsx

@@ -1,7 +1,7 @@
 // from https://github.com/AdeleD/react-paginate (converted)
 
 import React from 'react'
-// import PageView from './PageView'
+import PageView from './PageView'
 
 class PaginationListView extends React.Component {
   lessPageRangeItems() {

data/app/jobs/concerns/lcms/engine/nested_resque_job.rb

@@ -7,7 +7,7 @@ module Lcms
 
       class_methods do # rubocop:disable Metrics/BlockLength
         def queued_or_running_nested?(job_id, current_job_id = -1)
-          check_child = ->(j) { j['arguments'][1]['initial_job_id'] == job_id && j['job_id'] != current_job_id }
+          check_child = ->(j) { j['arguments'][1]&.dig('initial_job_id') == job_id && j['job_id'] != current_job_id }
           job_klasses = self::NESTED_JOBS + [name]
           job_klasses.each do |job_klass|
             queued = find_in_queue_by_payload(job_klass, &check_child) ||

data/app/jobs/lcms/engine/material_generate_job.rb

@@ -9,7 +9,7 @@ module Lcms
 
       def perform(material, document)
         if document.math?
-          material.material_parts.default.each { |p| p.update!(content: EmbedEquations.call(p.content)) }
+          material.document_parts.default.each { |p| p.update!(content: EmbedEquations.call(p.content)) }
         end
 
         DocumentGenerator.material_generators.each do |klass|

data/app/models/concerns/lcms/engine/partable.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Lcms
+  module Engine
+    module Partable
+      def create_parts_for(template)
+        template.parts.each do |part|
+          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 layout(context_type)
+        document_parts.where(part_type: :layout, context_type: DocumentPart.context_types[context_type.to_sym]).last
+      end
+    end
+  end
+end

data/app/models/lcms/engine/document.rb

@@ -3,10 +3,11 @@
 module Lcms
   module Engine
     class Document < ActiveRecord::Base
+      include Partable
       GOOGLE_URL_PREFIX = 'https://docs.google.com/document/d'
 
       belongs_to :resource
-      has_many :document_parts, dependent: :delete_all
+      has_many :document_parts, as: :renderer, dependent: :delete_all
       has_and_belongs_to_many :materials
 
       before_save :clean_curriculum_metadata
@@ -98,11 +99,6 @@ module Lcms
         materials.gdoc.pluck(:id)
       end
 
-      def layout(context_type)
-        # TODO: Move to concern with the same method in `Material`
-        document_parts.where(part_type: :layout, context_type: DocumentPart.context_types[context_type.to_sym]).last
-      end
-
       def materials_anchors
         {}.tap do |materials_with_anchors|
           toc.collect_children.each do |x|
@@ -140,7 +136,7 @@ module Lcms
         metadata['subject'] = metadata['subject']&.downcase
 
         /(\d+)/.match(metadata['grade']) do |m|
-          metadata['grade'] = "grade #{m[1]}"
+          metadata['grade'] = "grade #{m[1].to_i}"
         end
 
         # store only the lesson number

data/app/models/lcms/engine/document_part.rb

@@ -3,7 +3,7 @@
 module Lcms
   module Engine
     class DocumentPart < ActiveRecord::Base
-      belongs_to :document
+      belongs_to :renderer, polymorphic: true
 
       enum context_type: { default: 0, gdoc: 1 }
 

data/app/models/lcms/engine/material.rb

@@ -6,11 +6,12 @@ module Lcms
   module Engine
     class Material < ActiveRecord::Base
       include PgSearch::Model
+      include Partable
 
       validates :file_id, presence: true
       validates :identifier, uniqueness: true
 
-      has_many :material_parts, dependent: :delete_all
+      has_many :document_parts, as: :renderer, dependent: :delete_all
       has_and_belongs_to_many :documents
 
       store_accessor :metadata
@@ -33,11 +34,6 @@ module Lcms
         "https://docs.google.com/#{pdf? ? 'file' : 'document'}/d/#{file_id}"
       end
 
-      def layout(context_type)
-        # TODO: Move to concern with the same method in `Document`
-        material_parts.where(part_type: :layout, context_type: DocumentPart.context_types[context_type.to_sym]).last
-      end
-
       # Material is optional if it's included in optional activity only
       def optional_for?(document)
         general_ids = document.document_parts.general.pluck(:materials).flatten