lcms-engine 0.3.0 → 0.4.0

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/columns_tag.rb

@@ -5,7 +5,7 @@ module DocTemplate
     class ColumnsTag < BlockTag
       include ERB::Util
 
-      ALIGNMENT_RE = /^align-right\s/i
+      ALIGNMENT_RE = /^align-right\s/i.freeze
       SPLIT_SYMBOL = ';'
       TAG_NAME = 'columns'
       TEMPLATE = 'columns.html.erb'

data/lib/doc_template/tags/def_tag.rb

@@ -5,7 +5,7 @@ module DocTemplate
     class DefTag < BaseTag
       include ERB::Util
 
-      STYLE_RE = /<span (style=[^.>]*)>[^<]*$/i
+      STYLE_RE = /<span (style=[^.>]*)>[^<]*$/i.freeze
       TAG_NAME = 'def'
       TAG_SEPARATOR = '[separator]'
       TEMPLATES = {

data/lib/doc_template/tags/expand_tag.rb

@@ -27,6 +27,7 @@ module DocTemplate
         # iterates over all child nodes looking for break tag
         node.at_xpath('.//tr[2]/td').children.each do |child|
           (broken = true) && next if child.text.index("[#{BREAK_TAG_NAME}]")
+
           child.remove_attribute('class')
           child.children.each { |x| x.remove_attribute('class') }
           broken ? content_hidden.push(child) : content_visible.push(child)

data/lib/doc_template/tags/heading_tag.rb

@@ -25,7 +25,7 @@ module DocTemplate
       end
 
       def heading(value)
-        value.include?(prefix + ':') ? value : "#{prefix}: #{value}"
+        value.include?("#{prefix}:") ? value : "#{prefix}: #{value}"
       end
     end
 

data/lib/doc_template/tags/inset_tag.rb

@@ -28,8 +28,8 @@ module DocTemplate
       def preserve_styles(node, opts)
         add_css_class(node, 'o-ld-inset') if gdoc?(opts)
         node.children.each do |el|
-          el['class'] = el['class'].to_s + ' text-bold' if el['style'] =~ STYLES_REGEXP[:bold]
-          el['class'] = el['class'].to_s + ' text-italic' if el['style'] =~ STYLES_REGEXP[:italic]
+          el['class'] = "#{el['class']} text-bold" if el['style'] =~ STYLES_REGEXP[:bold]
+          el['class'] = "#{el['class']} text-italic" if el['style'] =~ STYLES_REGEXP[:italic]
         end
         node
       end

data/lib/doc_template/tags/latex_tag.rb

@@ -5,7 +5,7 @@ require 'doc_template'
 module DocTemplate
   module Tags
     class LatexTag < BaseTag
-      SPACE_RE = /[[:space:]]/
+      SPACE_RE = /[[:space:]]/.freeze
       TAG_NAME = 'latex'
 
       def self.s3_folder

data/lib/doc_template/tags/page_break_tag.rb

@@ -4,7 +4,7 @@ module DocTemplate
   module Tags
     class PageBreakTag < BaseTag
       CSS_CLASS = 'u-pdf-alwaysbreak'
-      TAG_NAME = /page(-|\s*)break/
+      TAG_NAME = /page(-|\s*)break/.freeze
       TAG_SUB = '<p>--GDOC-PAGE-BREAK--</p>'
 
       def parse(node, opts)

data/lib/doc_template/tags/pd_tag.rb

@@ -5,10 +5,10 @@ module DocTemplate
     class PdTag < BaseTag
       include Rails.application.routes.url_helpers
 
-      CG_RE = %r{/content_guides/(\d+)/}i
-      PDF_HTTP_RE = %r{^https?://}i
-      PDF_HTTP_REPLACE_RE = /^http:/i
-      PDF_RE = /\.pdf$/i
+      CG_RE = %r{/content_guides/(\d+)/}i.freeze
+      PDF_HTTP_RE = %r{^https?://}i.freeze
+      PDF_HTTP_REPLACE_RE = /^http:/i.freeze
+      PDF_RE = /\.pdf$/i.freeze
       TAG_NAME = 'pd'
       TEMPLATES = {
         default: 'pd.html.erb',

data/lib/doc_template/tags/section_tag.rb

@@ -5,9 +5,9 @@ module DocTemplate
     class SectionTag < BaseTag
       include DocTemplate::Tags::Helpers
 
-      STUDENT_RE = /^\s*student\s*resources\s*$/i
+      STUDENT_RE = /^\s*student\s*resources\s*$/i.freeze
       TAG_NAME = 'section'
-      SECTION_REMOVE_RE = /\[#{TAG_NAME}:[^\]]*\]/i
+      SECTION_REMOVE_RE = /\[#{TAG_NAME}:[^\]]*\]/i.freeze
       TEMPLATES = {
         default: 'section.html.erb',
         gdoc: 'gdoc/section.html.erb'

data/lib/doc_template/tags/standard_tag.rb

@@ -5,9 +5,9 @@ module DocTemplate
     class StandardTag < BaseTag
       include ERB::Util
 
-      STANDARD_RE = /[^\[\]]*\[(ela\.)?((rl|ri|rf|w|sl|l)\.[^\]]+)\]/i # [rl.2.2a.2]
-      TAG_NAME = /(ela\.)?((rl|ri|rf|w|sl|l)\.[^\]]+)/ # RL.2.4 or ELA.RL.2.4
-      TAG_RE = /\[[^\]]*\]/
+      STANDARD_RE = /[^\[\]]*\[(ela\.)?((rl|ri|rf|w|sl|l)\.[^\]]+)\]/i.freeze # [rl.2.2a.2]
+      TAG_NAME = /(ela\.)?((rl|ri|rf|w|sl|l)\.[^\]]+)/.freeze # RL.2.4 or ELA.RL.2.4
+      TAG_RE = /\[[^\]]*\]/.freeze
       TAG_SEPARATOR = '[separator]'
       TEMPLATES = { default: 'standard.html.erb',
                     gdoc: 'gdoc/standard.html.erb' }.freeze

data/lib/doc_template/tags/table_preserve_alignment_tag.rb

@@ -3,7 +3,7 @@
 module DocTemplate
   module Tags
     class TablePreserveAlignmentTag < BaseTag
-      STYLE_RE = /text-align:(left|center|right)/i
+      STYLE_RE = /text-align:(left|center|right)/i.freeze
       TAG_NAME = 'table-preserve-alignment'
 
       def parse(node, _options = {})

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

data/lib/doc_template.rb

@@ -19,7 +19,7 @@ module DocTemplate
     sanitizer: 'Lcms::Engine::HtmlSanitizer'
   }.freeze
 
-  FULL_TAG ||= /\[([^\]:\s]*)?\s*:?\s*([^\]]*?)?\]/mo
+  FULL_TAG ||= /\[([^\]:\s]*)?\s*:?\s*([^\]]*?)?\]/mo.freeze
   START_TAG ||= '\[[^\]]*'
 
   STARTTAG_XPATH ||= 'span[contains(., "[")]'
@@ -60,12 +60,12 @@ module DocTemplate
   end
 end
 
-require_dependency 'doc_template/template'
-require_dependency 'doc_template/document'
-require_dependency 'doc_template/tags'
-require_dependency 'doc_template/document_toc'
-require_dependency 'doc_template/xpath_functions'
+require 'doc_template/template'
+require 'doc_template/document'
+require 'doc_template/tags'
+require 'doc_template/document_toc'
+require 'doc_template/xpath_functions'
 
-Dir["#{__dir__}/doc_template/tables/*.rb"].each(&method(:require_dependency))
-Dir["#{__dir__}/doc_template/tags/*.rb"].each(&method(:require_dependency))
-Dir["#{__dir__}/doc_template/objects/*.rb"].each(&method(:require_dependency))
+Dir["#{__dir__}/doc_template/tables/*.rb"].sort.each(&method(:require))
+Dir["#{__dir__}/doc_template/tags/*.rb"].sort.each(&method(:require))
+Dir["#{__dir__}/doc_template/objects/*.rb"].sort.each(&method(:require))

data/lib/document_exporter/gdoc/base.rb

@@ -16,7 +16,7 @@ module DocumentExporter
           send_timeout_sec: GOOGLE_API_CLIENT_UPLOAD_TIMEOUT
         }
       }.freeze
-      VERSION_RE = /_v\d+$/i
+      VERSION_RE = /_v\d+$/i.freeze
 
       attr_reader :document, :options
 
@@ -108,7 +108,8 @@ module DocumentExporter
       # Deletes files of previous versions
       #
       def delete_previous_versions_from(folder)
-        drive_service.service.list_files(q: "'#{folder}' in parents").files.each do |file|
+        files = drive_service.service.list_files(q: "'#{folder}' in parents")&.files
+        Array.wrap(files).each do |file|
           next unless file.name =~ VERSION_RE
 
           drive_service.service.delete_file file.id
@@ -136,7 +137,9 @@ module DocumentExporter
       end
 
       def post_processing
-        Lcms::Engine::Google::ScriptService.new(document).execute(@id)
+        Retriable.retriable(base_interval: 5, tries: 10) do
+          Lcms::Engine::Google::ScriptService.new(document).execute(@id)
+        end
       end
     end
   end

data/lib/document_exporter/pdf/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DocumentExporter
-  module PDF
+  module Pdf
     class Base < DocumentExporter::Base
       def self.s3_folder
         @s3_folder ||= ENV.fetch('SWAP_DOCS', 'documents')

data/lib/document_exporter/pdf/document.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module DocumentExporter
-  module PDF
-    class Document < PDF::Base
+  module Pdf
+    class Document < Pdf::Base
       def export
         content = super
         pdf = CombinePDF.parse(content)

data/lib/document_exporter/pdf/material.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module DocumentExporter
-  module PDF
-    class Material < PDF::Base
+  module Pdf
+    class Material < Pdf::Base
       private
 
       def template_path(name)

data/lib/document_exporter/pdf/student_material.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module DocumentExporter
-  module PDF
-    class StudentMaterial < PDF::Base
+  module Pdf
+    class StudentMaterial < Pdf::Base
       def export
         pdf = CombinePDF.new
 

data/lib/document_exporter/pdf/teacher_material.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module DocumentExporter
-  module PDF
-    class TeacherMaterial < PDF::Base
+  module Pdf
+    class TeacherMaterial < Pdf::Base
       def export
         content = super
         pdf = CombinePDF.parse(content)

data/lib/document_renderer/part.rb

@@ -2,7 +2,7 @@
 
 module DocumentRenderer
   class Part
-    PART_RE = /{{[^}]+}}/
+    PART_RE = /{{[^}]+}}/.freeze
 
     class << self
       def call(content, options)
@@ -11,7 +11,7 @@ module DocumentRenderer
           next unless placeholder
           next unless (part = options[:parts_index][placeholder])
           next unless (subpart = part[:content])
-          next unless should_render?(part, !options[:with_optional])
+          next unless should_render?(part, omit_optional: !options[:with_optional])
 
           call subpart.to_s, options
         end
@@ -26,13 +26,11 @@ module DocumentRenderer
       # If part is not optional:
       # - just ignore it if it has been turned OFF
       #
-      def should_render?(part, omit_optional = true)
+      def should_render?(part, omit_optional: true)
         if part[:optional] && omit_optional
           false unless @excludes.include?(part[:anchor])
-        elsif @excludes.include?(part[:anchor])
-          false
         else
-          true
+          !@excludes.include?(part[:anchor])
         end
       end
     end

data/lib/elasticsearch/persistence/repository/response/results.rb

@@ -20,7 +20,7 @@ module Elasticsearch
             results.respond_to?(method_name) ? results.__send__(method_name, *arguments, &block) : super
           end
 
-          def respond_to?(method_name, include_private = false)
+          def respond_to?(method_name, include_private = false) # rubocop:disable Style/OptionalBooleanParameter
             results.respond_to?(method_name) || super
           end
 

data/lib/lcms/engine/engine.rb

@@ -66,9 +66,16 @@ module Lcms
         # Check if the DB exists
         next unless ActiveRecord::Base.connection
 
+        # Possible decorators
+        decorators = %W[
+          #{Rails.root}/app/decorators/**/*_decorator*.rb
+          #{Rails.root}/app/**/lcms/engine/*_decorator*.rb
+        ]
+
         Dir
-          .glob(Rails.root + 'app/decorators/**/*_decorator*.rb')
-          .each(&method(:require_dependency))
+          .glob(decorators)
+          .sort
+          .each(&method(:require))
       rescue ActiveRecord::NoDatabaseError
         puts 'ActiveRecord::NoDatabaseError thrown!'
       end
@@ -88,13 +95,7 @@ module Lcms
       end
 
       initializer 'lcms.engine.assets.precompile' do |app|
-        app.config.assets.precompile += %w(
-          lcms_engine_manifest.js
-        )
-        # app.config.assets.precompile += %w(
-        #   ckeditor/*
-        #   gdoc.css
-        # )
+        app.config.assets.precompile += %w(lcms_engine_manifest.js ckeditor/config.js)
       end
 
       initializer 'webpacker.proxy' do |app|

data/lib/lcms/engine/version.rb

@@ -2,7 +2,7 @@
 
 module Lcms
   module Engine
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
     RAILS_5_VERSION = 5.2
   end
 end

data/lib/lcms/engine.rb

@@ -23,4 +23,3 @@ module Lcms
 end
 
 require 'lcms/engine/engine'
-require 'lcms/engine/migration'

data/lib/lt/lcms/metadata/base_service.rb

@@ -6,7 +6,7 @@ module Lt
     module Metadata
       class BaseService
         class << self
-          attr_reader :activity_metadata, :metadata, :section_metadata
+          attr_reader :activity_metadata, :errors, :metadata, :section_metadata
 
           def materials_metadata
             raise NotImplementedError
@@ -22,6 +22,7 @@ module Lt
           end
 
           def parse(_content, *args)
+            @errors = []
             @options = args.extract_options!
           end
 

data/lib/lt/lcms/metadata/context.rb

@@ -9,7 +9,7 @@ module Lt
       class Context
         attr_reader :context
 
-        NUM_RE = /\d+/
+        NUM_RE = /\d+/.freeze
 
         class << self
           #
@@ -17,7 +17,7 @@ module Lt
           # Is used inside `#find_or_create_resource` method
           #
           def update_grades_level_position_for(grades)
-            update_level_position_for(grades) { |g| ::Lcms::Engine::Grades::GRADES.index(g.metadata['grade']) }
+            update_level_position_for(grades) { |g| ::Lcms::Engine::Grades.grades.index(g.metadata['grade']) }
           end
 
           #
@@ -71,41 +71,45 @@ module Lt
         end
 
         def find_or_create_resource
-          # if the resource exists, return it
-          resource = ::Lcms::Engine::Resource.tree.find_by_directory(directory)
-          return update(resource) if resource
-
-          # else, build missing parents until we build the resource itself.
-          parent = nil
-          directory.each_with_index do |name, index|
-            resource = ::Lcms::Engine::Resource.tree.find_by_directory(directory[0..index])
-            if resource
-              parent = resource
-              next
-            end
+          # rubocop:disable Metrics/BlockLength
+          ::Lcms::Engine::Resource.with_advisory_lock('find_or_create_resource') do
+            # if the resource exists, return it
+            resource = ::Lcms::Engine::Resource.tree.find_by_directory(directory)
+            return update(resource) if resource
+
+            # else, build missing parents until we build the resource itself.
+            parent = nil
+            directory.each_with_index do |name, index|
+              resource = ::Lcms::Engine::Resource.tree.find_by_directory(directory[0..index])
+              if resource
+                parent = resource
+                next
+              end
 
-            resource = build_new_resource(parent, name, index)
-            unless last_item?(index)
-              resource.save!
-              unless resource.subject?
-                self.class.send("update_#{resource.curriculum_type}s_level_position_for", resource.self_and_siblings)
+              resource = build_new_resource(parent, name, index)
+              unless last_item?(index)
+                resource.save!
+                unless resource.subject?
+                  self.class.send("update_#{resource.curriculum_type}s_level_position_for", resource.self_and_siblings)
+                end
+                parent = resource
+                next
               end
-              parent = resource
-              next
-            end
 
-            if mid_assessment?
-              set_mid_assessment_position(parent, resource)
-            elsif prerequisite?
-              set_prerequisite_position(parent, resource)
-            elsif opr?
-              set_opr_position(parent, resource)
-            else
-              set_lesson_position(parent, resource)
+              if mid_assessment?
+                set_mid_assessment_position(parent, resource)
+              elsif prerequisite?
+                set_prerequisite_position(parent, resource)
+              elsif opr?
+                set_opr_position(parent, resource)
+              else
+                set_lesson_position(parent, resource)
+              end
             end
-          end
 
-          update resource
+            update resource
+          end
+          # rubocop:enable Metrics/BlockLength
         end
 
         private
@@ -143,7 +147,7 @@ module Lt
             # ELA G1 M1 U2 Lesson 1
             curr ||= directory
             res = ::Lcms::Engine::Resource.new(metadata: metadata)
-            ::Lcms::Engine::Breadcrumbs.new(res).title.split(' / ')[0...-1].push(curr.last.titleize).join(' ')
+            ::Lcms::Engine::Breadcrumbs.new(res).title.split(' / ')[0...-1].push(curr.last.to_s.titleize).join(' ')
           end
         end
 
@@ -164,7 +168,7 @@ module Lt
 
         def grade
           @grade ||= begin
-            value = context[:grade].try(:downcase)
+            value = context[:grade].to_s.downcase
             value = "grade #{value.to_i}" if number?(value)
             value # if Grades::GRADES.include?(value)
           end
@@ -175,16 +179,18 @@ module Lt
         end
 
         def lesson
-          @lesson ||= begin
-            return nil if assessment? # assessment is a unit now, so lesson -> nil
-
-            num = if ela? && prerequisite?
-                    ::Lcms::Engine::RomanNumerals.to_roman(context[:lesson].to_i)&.downcase
-                  else
-                    context[:lesson].presence
-                  end
-            "lesson #{num}" if num.present?
-          end
+          @lesson ||=
+            if assessment?
+              # assessment is a unit now, so lesson -> nil
+              nil
+            else
+              num = if ela? && prerequisite?
+                      ::Lcms::Engine::RomanNumerals.to_roman(context[:lesson].to_i)&.downcase
+                    else
+                      context[:lesson].presence
+                    end
+              "lesson #{num}" if num.present?
+            end
         end
 
         def mid_assessment?
@@ -240,20 +246,18 @@ module Lt
         end
 
         def unit
-          @unit ||= begin
-            if assessment?
-              type # assessment-mid || assessment-end
-            else
-              ela? ? "unit #{context[:unit]}" : "topic #{context[:topic]}"
-            end
-          end
+          @unit ||= if assessment?
+                      type # assessment-mid || assessment-end
+                    else
+                      ela? ? "unit #{context[:unit]}" : "topic #{context[:topic]}"
+                    end
         end
 
-        def update(resource)
+        def update(resource) # rubocop:disable Metrics/AbcSize
           return if resource.nil?
 
           # if resource changed to prerequisite, fix positioning
-          prereq = context['type'].to_s.casecmp('prereq').zero?
+          prereq = context['type'].to_s.casecmp('prereq').to_i.zero?
           fix_prereq_position(resource) if prereq && !resource.prerequisite?
 
           # Update resource with document metadata
@@ -261,7 +265,7 @@ module Lt
           resource.teaser = context['teaser'] if context['teaser'].present?
           resource.description = context['description'] if context['description'].present?
           resource.tag_list << 'prereq' if prereq
-          resource.tag_list << 'opr' if context['type'].to_s.casecmp('opr').zero?
+          resource.tag_list << 'opr' if context['type'].to_s.casecmp('opr').to_i.zero?
           resource.save
 
           resource

data/lib/lt/lcms/metadata/service.rb

@@ -35,14 +35,17 @@ module Lt
             )
           end
 
-          def parse(content, *args)
+          def parse(content, *args) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
             super
             if material?
               @metadata = DocTemplate::Tables::MaterialMetadata.parse content
-              raise ::MaterialError, 'No metadata present' if !@metadata&.table_exist? || @metadata&.data&.empty?
+              @errors.concat @metadata.errors
+              raise ::Lcms::Engine::MaterialError, 'No metadata present' \
+                if !@metadata&.table_exist? || @metadata&.data&.empty?
             else
               @metadata = DocTemplate::Tables::Metadata.parse content
-              raise ::DocumentError, 'No metadata present' unless @metadata&.table_exist?
+              @errors.concat @metadata.errors
+              raise ::Lcms::Engine::DocumentError, 'No metadata present' unless @metadata&.table_exist?
 
               @agenda = DocTemplate::Tables::Agenda.parse content
               @section_metadata = DocTemplate::Tables::Section.parse content,

data/lib/resque_job.rb

@@ -17,7 +17,8 @@ module ResqueJob
     end
 
     def find_in_queue_by_payload(job_class, &block)
-      result = Resque.peek(:default, 0, 0)
+      jobs = Array.wrap Resque.peek(queue_name, 0, 0)
+      result = jobs
                  .select { |j| j['args'].first['job_class'] == job_class.to_s }
                  .flat_map { |j| j['args'] }
       return result unless block_given?
@@ -46,11 +47,7 @@ module ResqueJob
     end
 
     def fetch_result(job_id)
-      res = Resque.redis.multi do
-        key = result_key(job_id)
-        Resque.redis.get key
-        Resque.redis.del key
-      end.first
+      res = Resque.redis.get result_key(job_id)
       JSON.parse(res) rescue res
     end
 

data/lib/standard_importer.rb

@@ -20,7 +20,7 @@ class StandardImporter
 
   private
 
-  RE_EMPHASIS = /^\(\+\)\s?/
+  RE_EMPHASIS = /^\(\+\)\s?/.freeze
 
   attr_reader :source_file, :subject
 
@@ -45,10 +45,10 @@ class StandardImporter
 
     return grades if to_name.blank?
 
-    from_idx = Grades::GRADES_ABBR.index from_name
-    to_idx = Grades::GRADES_ABBR.index from_name
+    from_idx = Grades.grades_abbrevs.index from_name
+    to_idx = Grades.grades_abbrevs.index from_name
 
-    Grades::GRADES_ABBR.slice(from_idx..to_idx).each { |name| grades << find_grade(name) }
+    Grades.grades_abbrevs.slice(from_idx..to_idx).each { |name| grades << find_grade(name) }
 
     grades.compact
   end