lcms-engine 0.3.0 → 0.3.1

data/README.md

@@ -13,8 +13,9 @@ separately, simplifying the client applications in the process.
 
 |Branch|Rails version|
 |------|-------------|
-|master|Rails 5.2.4.2|
-|0.1.x|Rails 4.2.11|
+|master|Rails 6|
+|0.3.x|Rails 5.2.4.5|
+|0.1.x|Rails 4.2.11.3|
 
 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

data/app/controllers/concerns/lcms/engine/reimportable.rb

@@ -19,10 +19,20 @@ module Lcms
           status = job_class.status(jid)
           obj[jid] = {
             status: status,
-            result: (status == :done ? job_class.fetch_result(jid) : nil)
+            result: (status == :done ? prepare_result(job_class, jid) : nil)
           }.compact
         end
       end
+
+      def prepare_result(job_class, jid)
+        jid_res = job_class.fetch_result(jid)
+        return jid_res if jid_res['ok']
+
+        {
+          ok: false,
+          errors: Array.wrap("<a href=\"#{jid_res['link']}\">Source</a>: #{jid_res['errors'].join(', ')}")
+        }
+      end
     end
   end
 end

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

@@ -11,7 +11,7 @@ module Lcms
           materials_query: Lcms::Engine::AdminMaterialsQuery
         }.freeze
 
-        RE_GOOGLE_FOLDER = %r{/drive/(.*/)?folders/}
+        RE_GOOGLE_FOLDER = %r{/drive/(.*/)?folders/}.freeze
 
         layout :customized_layout
 

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

@@ -10,9 +10,10 @@ module Lcms
         include Reimportable
 
         before_action :find_selected, only: %i(destroy_selected reimport_selected)
+        before_action :set_query_params
 
         def index
-          @query = OpenStruct.new(params[:query])
+          @query = OpenStruct.new @query_params
           @documents = DocTemplate.config['queries']['document'].constantize.call(@query, page: params[:page])
           render_customized_view
         end
@@ -23,7 +24,7 @@ module Lcms
           @document = reimport_lesson
           if @document.save
             redirect_to AdminController.document_path(@document.document),
-                        notice: t('.success', name: @document.document.name)
+                        notice: t('.success', name: @document.document.name, errors: collect_errors)
           else
             render :new
           end
@@ -32,12 +33,12 @@ module Lcms
         def destroy
           @document = Document.find(params[:id])
           @document.destroy
-          redirect_to admin_documents_path(query: params[:query]), notice: t('.success')
+          redirect_to admin_documents_path(query: @query_params), notice: t('.success')
         end
 
         def destroy_selected
           count = @documents.destroy_all.count
-          redirect_to admin_documents_path(query: params[:query]), notice: t('.success', count: count)
+          redirect_to admin_documents_path(query: @query_params), notice: t('.success', count: count)
         end
 
         def import_status
@@ -67,6 +68,12 @@ module Lcms
           @props = { jobs: jobs, type: :documents, links: view_links }
         end
 
+        def collect_errors
+          return if @document.service_errors.empty?
+
+          "Errors: #{@document.service_errors.join(' ')}"
+        end
+
         def find_selected
           return head(:bad_request) unless params[:selected_ids].present?
 
@@ -105,6 +112,14 @@ module Lcms
             MaterialForm.new({ link: material.file_url, source_type: material.source_type }, google_credentials).save
           end
         end
+
+        def set_query_params
+          @query_params = params[:query]
+            &.permit(
+              :broken_materials, :course, :grade, :inactive, :locale, :module, :only_failed, :reimport_required,
+              :search_term, :sort_by
+            ) || {}
+        end
       end
     end
   end

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

@@ -8,9 +8,10 @@ module Lcms
         include Reimportable
 
         before_action :find_selected, only: %i(destroy_selected reimport_selected)
+        before_action :set_query_params
 
         def index
-          @query = OpenStruct.new params[:query]
+          @query = OpenStruct.new @query_params
           @materials = DocTemplate.config['queries']['material'].constantize.call(@query, page: params[:page])
           render_customized_view
         end
@@ -32,12 +33,12 @@ module Lcms
         def destroy
           material = Material.find(params[:id])
           material.destroy
-          redirect_to admin_materials_path(query: params[:query]), notice: t('.success')
+          redirect_to admin_materials_path(query: @query_params), notice: t('.success')
         end
 
         def destroy_selected
           count = @materials.destroy_all.count
-          redirect_to admin_materials_path(query: params[:query]), notice: t('.success', count: count)
+          redirect_to admin_materials_path(query: @query_params), notice: t('.success', count: count)
         end
 
         def import_status
@@ -89,6 +90,14 @@ module Lcms
               .map { |id| ::Lt::Lcms::Lesson::Downloader::Gdoc.gdoc_file_url(id) }
           end
         end
+
+        def set_query_params
+          @query_params = params[:query]
+            &.permit(
+              :course, :lesson, :name_date, :orientation, :search_term, :search_file_name, :sort_by, :title, :type,
+              :unit
+            ) || {}
+        end
       end
     end
   end

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

@@ -5,11 +5,12 @@ module Lcms
     module Admin
       class StandardsController < AdminController
         before_action :find_standard, except: [:index]
+        before_action :set_query_params
 
         def edit; end
 
         def index
-          @query = OpenStruct.new params[:query]
+          @query = OpenStruct.new @query_params
 
           scope = Standard.order(:id)
           scope = scope.search_by_name(@query.name) if @query.name.present?
@@ -31,6 +32,10 @@ module Lcms
           @standard = Standard.find(params[:id])
         end
 
+        def set_query_params
+          @query_params = params[:query]&.permit(:name) || {}
+        end
+
         def standard_params
           params.require(:standard).permit(:description)
         end

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

@@ -5,9 +5,10 @@ module Lcms
     module Admin
       class UsersController < AdminController
         before_action :find_user, except: %i(index new create)
+        before_action :set_query_params
 
         def index
-          @query = OpenStruct.new(params[:query])
+          @query = OpenStruct.new @query_params
           @users = users(@query)
         end
 
@@ -52,6 +53,10 @@ module Lcms
           @user = User.find(params[:id])
         end
 
+        def set_query_params
+          @query_params = params[:query]&.permit(:access_code, :email) || {}
+        end
+
         def user_params
           params.require(:user).permit(:access_code, :email, :name, :role)
         end

data/app/entities/lcms/engine/grades.rb

@@ -12,31 +12,42 @@ module Lcms
 
       attr_reader :model
 
+      class << self
+        def grades
+          ::Lcms::Engine::Grades::GRADES
+        end
+
+        def grades_abbrevs
+          ::Lcms::Engine::Grades::GRADES_ABBR
+        end
+      end
+
       def initialize(model)
         @model = model
       end
 
       def list
-        @list ||= if model.is_a?(Resource)
+        @list ||= case model
+                  when Resource
                     Array.wrap model.metadata['grade']
-                  elsif model.is_a?(Search::Document)
+                  when Search::Document
                     Array.wrap model.grade.presence
                   else
                     model.grade_list
-                  end.sort_by { |g| GRADES.index(g) }
+                  end.sort_by { |g| self.class.grades.index(g) }
       end
 
       def average(abbr: true)
         return nil if average_number.nil?
 
-        avg = GRADES[average_number]
+        avg = self.class.grades[average_number]
         abbr ? (grade_abbr(avg) || 'base') : avg
       end
 
       def average_number
         return nil if list.empty?
 
-        list.map { |g| GRADES.index(g) }.sum / (list.size.nonzero? || 1)
+        list.map { |g| self.class.grades.index(g) }.sum / (list.size.nonzero? || 1)
       end
 
       def grade_abbr(abbr)
@@ -62,7 +73,7 @@ module Lcms
           abbr = grade_abbr(g).upcase
 
           # if the current grade is subsequent we store on the same chain
-          if idx.zero? || GRADES.index(g) == GRADES.index(prev) + 1
+          if idx.zero? || self.class.grades.index(g) == self.class.grades.index(prev) + 1
             chain << abbr
           else
             # the grade is not subsequent, so we store the current chain, and create a new one

data/app/entities/lcms/engine/media_embed.rb

@@ -26,7 +26,7 @@ module Lcms
         when /vimeo\.com/
           url.match(%r{https?://(www\.)?vimeo.com/(\d+)}).try(:[], 2)
         when /youtu\.be/
-          url.match(%r{https?://(www\.)?youtu\.be/([^"&?\/]+)}).try(:[], 2)
+          url.match(%r{https?://(www\.)?youtu\.be/([^"&?/]+)}).try(:[], 2)
         end
       end
     end

data/app/entities/lcms/engine/roman_numerals.rb

@@ -3,7 +3,7 @@
 module Lcms
   module Engine
     class RomanNumerals
-      ROMAN_NUMERALS_RE = /^(M|CM|D|CD|C|XC|L|XL|X|IX|V|IV|I)/
+      ROMAN_NUMERALS_RE = /^(M|CM|D|CD|C|XC|L|XL|X|IX|V|IV|I)/.freeze
       SYMBOLS = [
         [1000, 'M'],
         [900, 'CM'],

data/app/forms/lcms/engine/document_form.rb

@@ -13,7 +13,7 @@ module Lcms
       validates_presence_of :link, if: -> { link_fs.blank? }
       validates_presence_of :link_fs, if: -> { link.blank? }
 
-      attr_reader :document
+      attr_reader :document, :service_errors
 
       def initialize(attributes = {}, opts = {})
         @is_reimport = attributes.delete(:reimport).present? || false
@@ -29,7 +29,7 @@ module Lcms
         @document.update(reimported: true)
       rescue StandardError => e
         @document&.update(reimported: false)
-        Rails.logger.error e.message + "\n " + e.backtrace.join("\n ")
+        Rails.logger.error "#{e.message}\n #{e.backtrace.join("\n ")}"
         errors.add(:link, e.message)
         false
       end
@@ -45,18 +45,23 @@ module Lcms
       def build_document
         service = document_build_service
 
-        if is_reimport
-          doc = service.build_for(link)
-          doc = service.build_for(link_fs, expand: true) if link_fs.present?
-          doc
-        elsif (full_doc = find_full_document)
-          # if there is a document with the same file_id or foundational_file_id
-          # we need to make full re-import to correctly handle expand process
-          service.build_for(full_doc.file_url)
-          service.build_for(full_doc.file_fs_url, expand: true)
-        else
-          service.build_for link
-        end
+        result =
+          if is_reimport
+            doc = service.build_for(link)
+            doc = service.build_for(link_fs, expand: true) if link_fs.present?
+            doc
+          elsif (full_doc = find_full_document)
+            # if there is a document with the same file_id or foundational_file_id
+            # we need to make full re-import to correctly handle expand process
+            service.build_for(full_doc.file_url)
+            service.build_for(full_doc.file_fs_url, expand: true)
+          else
+            service.build_for link
+          end
+
+        @service_errors = service.errors
+
+        result
       end
 
       def document_build_service

data/app/forms/lcms/engine/material_form.rb

@@ -11,7 +11,7 @@ module Lcms
       attribute :source_type, String
       validates :link, presence: true
 
-      attr_accessor :material
+      attr_accessor :material, :service_errors
 
       def initialize(attributes = {}, opts = {})
         super(attributes)
@@ -28,12 +28,13 @@ module Lcms
         }.compact
         service = MaterialBuildService.new google_credentials, params
         @material = service.build link
+        @service_errors = service.errors
 
         material.update preview_links: {}
         after_reimport_hook
         true
       rescue StandardError => e
-        Rails.logger.error e.message + "\n " + e.backtrace.join("\n ")
+        Rails.logger.error "#{e.message}\n #{e.backtrace.join("\n ")}"
         errors.add(:link, e.message)
         false
       end

data/app/helpers/admin/components_helper.rb

@@ -2,9 +2,9 @@
 
 module Admin
   module ComponentsHelper
-    HIDDEN_FIELD_RE = /\b(?<=name=")[^"]+(?=")/
+    HIDDEN_FIELD_RE = /\b(?<=name=")[^"]+(?=")/.freeze
 
-    def resource_picker_field(form, collection, allow_multiple: true, path:, name:)
+    def resource_picker_field(form, collection, path:, name:, allow_multiple: true)
       path = path.to_s
 
       base_name = form.hidden_field(name).scan(HIDDEN_FIELD_RE)[0]

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

@@ -116,7 +116,7 @@ module Lcms
         return unless selected_ids.present?
 
         case selected_ids
-        when Array then
+        when Array
           selected_ids.include?(id.to_s)
         else
           selected_ids.split(',').include?(id.to_s)

data/app/interactors/lcms/engine/explore_curriculum_interactor.rb

@@ -70,7 +70,7 @@ module Lcms
 
       def slug_param
         slug = params[:p]
-        (slug.start_with?('/') ? slug[1..-1] : slug) if slug.present?
+        (slug.start_with?('/') ? slug[1..] : slug) if slug.present?
       end
 
       def expanded?

data/app/javascript/components/admin/ImportStatus.jsx

@@ -1,4 +1,5 @@
 import React from 'react'
+import _ from 'lodash'
 
 class ImportStatus extends React.Component {
   constructor(props) {
@@ -53,7 +54,8 @@ class ImportStatus extends React.Component {
     if (this.withPdf) {
       return (
         <a href={job.link}
-          className="o-adm-materials__resource ub-icon ub-file-pdf button primary u-margin-left--small u-margin-bottom--zero" target="_blank">
+          className="o-adm-materials__resource button primary u-margin-left--small u-margin-bottom--zero" target="_blank">
+          <i className="far fa-file-pdf"></i>
         </a>
       )
     }
@@ -69,7 +71,8 @@ class ImportStatus extends React.Component {
     return _.map(this.links, (link, idx) => (
       <a key={`pl-${idx}`}
         href={linkWithParams(link, { id: job.model.id })}
-        className="o-adm-materials__resource ub-icon ub-eye button primary u-margin-left--small u-margin-bottom--zero" target="_blank">
+        className="o-adm-materials__resource button primary u-margin-left--small u-margin-bottom--zero" target="_blank">
+        <i className="fas fa-eye"></i>
       </a>
     ))
   }
@@ -99,7 +102,8 @@ class ImportStatus extends React.Component {
             {job.status !== 'done' ? this.spinner() : null}
             {job.status === 'done' && job.ok ? <span>{this.resourceButton(job)}</span> : null}
           </div>
-          {job.errors ? (<p dangerouslySetInnerHTML={{__html: _.join(job.errors, '<br/>')}}></p>) : null}
+          {!(_.isEmpty(job.errors)) ? (<p dangerouslySetInnerHTML={{__html: _.join(job.errors, '<br/>')}}></p>) : null}
+          {!(_.isEmpty(job.warnings)) ? (<p dangerouslySetInnerHTML={{ __html: _.join(job.warnings, '<br/>') }}></p>) : null}
         </li>
       )
     })

data/app/javascript/components/admin/MultiSelectedOperation.jsx

@@ -1,5 +1,6 @@
 import React from 'react'
 import ReactDOM from 'react-dom'
+import _ from 'lodash'
 
 class MultiSelectedOperation extends React.Component {
   componentDidMount() {

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

@@ -1,5 +1,6 @@
 import React from 'react'
 import ReactDOM from 'react-dom'
+import _ from 'lodash'
 // eslint-disable-next-line no-unused-vars
 import AssociationPickerItem from './AssociationPickerItem'
 import AssociationPickerWindow from './AssociationPickerWindow'

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

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