lcms-engine 0.3.1 → 0.4.1

data/lib/doc_template.rb

@@ -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'
-
-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))
+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"].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

@@ -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

@@ -29,10 +29,8 @@ module DocumentRenderer
       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/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.1'
+    VERSION = '0.4.1'
     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/context.rb

@@ -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

@@ -40,11 +40,12 @@ module Lt
             if material?
               @metadata = DocTemplate::Tables::MaterialMetadata.parse content
               @errors.concat @metadata.errors
-              raise ::MaterialError, 'No metadata present' if !@metadata&.table_exist? || @metadata&.data&.empty?
+              raise ::Lcms::Engine::MaterialError, 'No metadata present' \
+                if !@metadata&.table_exist? || @metadata&.data&.empty?
             else
               @metadata = DocTemplate::Tables::Metadata.parse content
               @errors.concat @metadata.errors
-              raise ::DocumentError, 'No metadata present' unless @metadata&.table_exist?
+              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/tasks/cloud66.rake

@@ -27,7 +27,7 @@ namespace :cloud66 do # rubocop:disable Metrics/BlockLength
     desc 'Exports tables to be synced'
     task export: :environment do
       cmd = <<-BASH
-        pg_dump -U #{ENV['POSTGRESQL_USERNAME']} #{ENV['POSTGRESQL_DATABASE']} \
+        pg_dump -U #{ENV.fetch('POSTGRESQL_USERNAME', nil)} #{ENV.fetch('POSTGRESQL_DATABASE', nil)} \
           --no-owner \
           --table=users \
           --table=access_codes \
@@ -40,7 +40,7 @@ namespace :cloud66 do # rubocop:disable Metrics/BlockLength
     task import: :environment do
       raise 'No data file. Please execute `cloud66:swap:export` prior loading the data.' unless File.exist?(swap_file)
 
-      cmd = "psql -U #{ENV['POSTGRESQL_USERNAME']} #{ENV['POSTGRESQL_DATABASE']}"
+      cmd = "psql -U #{ENV.fetch('POSTGRESQL_USERNAME', nil)} #{ENV.fetch('POSTGRESQL_DATABASE', nil)}"
       # Drops old tables
       system "#{cmd} -c 'drop table access_codes, users;'"
       # Create new and load the data

data/lib/tasks/document.rake

@@ -39,10 +39,10 @@ namespace :document do
       topic['lessons'].push(
         'file_name' => file_name,
         'identifier' => 'ENY-' \
-          "G#{grade_key.split('-').last}-" \
-          "M#{module_key.split('-').last}-" \
-          "T#{topic_key.split('-').last}-" \
-          "L#{lesson_number}",
+                        "G#{grade_key.split('-').last}-" \
+                        "M#{module_key.split('-').last}-" \
+                        "T#{topic_key.split('-').last}-" \
+                        "L#{lesson_number}",
         'name' => document.metadata['title_text'],
         'standards' => document.metadata['standard'],
         'description' => Nokogiri::HTML(document.metadata['description']).text,

data/lib/tasks/google.rake

@@ -4,22 +4,37 @@ require 'googleauth'
 require 'googleauth/stores/file_token_store'
 require 'lt/google/api/auth/cli'
 
-OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
-
 namespace :google do
-  desc 'set up google credentials'
-  task setup_auth: :environment do
+  desc 'Set up google credentials. Specify `domain` argument which will be used as a base for redirect URI'
+  task :setup_auth, [:domain] => [:environment] do |_task, args|
     service = ::Lt::Google::Api::Auth::Cli.new
-    if service.credentials.nil?
-      authorizer = service.authorizer
-      url = authorizer.get_authorization_url(base_url: OOB_URI)
-      puts "Open \n>> #{url}\n in your browser and enter the resulting code:"
-      code = $stdin.gets.strip
-      authorizer.get_and_store_credentials_from_code(
-        user_id: ::Lt::Google::Api::Auth::Cli::USER_ID, code: code, base_url: OOB_URI
-      )
-    else
-      puts 'No need in action, everything is already set up'
+
+    # Check if there is existing auth token
+    if service.credentials.present?
+      puts <<~TEXT
+        Auth token already exists. Do you want to request new one?
+        Type Y for Yes, N for No
+      TEXT
+      next unless $stdin.gets.to_s.strip.downcase == 'y'
     end
+
+    authorizer = service.authorizer
+    url = authorizer.get_authorization_url(base_url: args[:domain])
+
+    puts <<~TEXT
+      Open this URL in your browser:
+      >>>>>
+      #{url}
+      >>>>>
+      Copy auth code and paste it below.
+    TEXT
+
+    code = $stdin.gets.to_s.strip
+
+    authorizer.get_and_store_credentials_from_code(
+      user_id: ::Lt::Google::Api::Auth::Cli::USER_ID,
+      code: code,
+      base_url: args[:domain]
+    )
   end
 end

data/lib/tasks/lcms/engine_tasks.rake

@@ -70,7 +70,7 @@ def enhance_assets_precompile
 end
 
 # Compile packs after we've compiled all other assets during precompilation
-skip_webpacker_precompile = %w(no false n f).include?(ENV['WEBPACKER_PRECOMPILE'])
+skip_webpacker_precompile = %w(no false n f).include?(ENV.fetch('WEBPACKER_PRECOMPILE', nil))
 
 unless skip_webpacker_precompile
   if Rake::Task.task_defined?('assets:precompile')

data/package.json

@@ -5,31 +5,52 @@
   "dependencies": {
     "@babel/core": "^7.6.0",
     "@babel/preset-react": "^7.0.0",
-    "@rails/webpacker": "~4",
+    "@rails/webpacker": "~5.4.3",
     "babel-plugin-transform-react-remove-prop-types": "^0.4.24",
     "classnames": "^2.2.6",
-    "lodash": "^4.17.20",
+    "foundation-sites": "^6.7.4",
+    "jquery": "^3.6.0",
+    "lodash": "^4.17.21",
     "prop-types": "^15.7.2",
     "react": "^16.9.0",
     "react-dom": "^16.9.0",
-    "react_ujs": "^2.6.0"
+    "react-tagsinput": "^3.19.0",
+    "react_ujs": "^2.6.0",
+    "webpack": "^4.46.0",
+    "webpack-cli": "^3.3.12"
   },
   "devDependencies": {
-    "eslint": "^6.5.1",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-react": "^7.16.0",
-    "webpack": "~4",
-    "webpack-dev-server": "^3.8.1"
+    "babel-eslint": "^10.1.0",
+    "eslint": "^7.23.0",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-config-react-app": "^6.0.0",
+    "eslint-plugin-flowtype": "^5.6.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-react": "^7.23.1",
+    "eslint-plugin-react-hooks": "^4.2.0",
+    "prettier": "^2.2.1",
+    "stylelint": "^13.12.0",
+    "stylelint-config-prettier": "^8.0.2",
+    "stylelint-config-sass-guidelines": "^8.0.0",
+    "stylelint-prettier": "^1.2.0",
+    "stylelint-selector-bem-pattern": "^2.1.0",
+    "webpack-dev-server": "^3"
   },
   "scripts": {
-    "lint:scss": "sass-lint '**/*.scss' -v -q"
+    "lint": "eslint --ext .js --ext .jsx app/javascript && stylelint 'app/assets/stylesheets/**/*.{css,scss}' --quiet",
+    "lint:js": "eslint --ext .js --ext .jsx app/javascript",
+    "lint:js:fix": "eslint --ext .js --ext .jsx app/javascript --quiet --fix",
+    "lint:scss": "stylelint 'app/assets/stylesheets/**/*.{css,scss}' --quiet",
+    "lint:scss:fix": "stylelint 'app/assets/stylesheets/**/*.{css,scss}' --quiet --fix"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/learningtapestry/lcms-engine.git"
   },
   "engines": {
-    "node": ">=10.16.1",
+    "node": ">=14.17.0",
     "yarn": ">=1.17.1"
   },
   "author": "Alexander Kuznetsov <paranoic.san@gmail.com>",

data/postcss.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  plugins: [
+    require('postcss-import'),
+    require('postcss-flexbugs-fixes'),
+    require('postcss-preset-env')({
+      autoprefixer: {
+        flexbox: 'no-2009'
+      },
+      stage: 3
+    })
+  ]
+}

data/spec/controllers/admin/curriculums_controller_spec.rb

@@ -12,4 +12,27 @@ describe Lcms::Engine::Admin::CurriculumsController do
 
     it { is_expected.to be_successful }
   end
+
+  describe '#children' do
+    let(:id) { resource.id }
+    let(:resource) { create(:resource, :module) }
+    let!(:children) { create_list(:resource, 3, parent: resource) }
+
+    subject { get :children, params: { id: id } }
+
+    it 'returns children of the requested resource' do
+      JSON.parse(subject.body).each do |data|
+        child = ::Lcms::Engine::Resource.find(data['id'])
+        expect(child.parent_id).to eq id
+      end
+    end
+
+    context 'when # is requested' do
+      let(:id) { '#' }
+
+      it 'returns root resources' do
+        expect(JSON.parse(subject.body).first['id']).to eq resource.id
+      end
+    end
+  end
 end

data/spec/controllers/admin/documents_controller_spec.rb

@@ -27,7 +27,7 @@ describe Lcms::Engine::Admin::DocumentsController do
 
     it 'redirects to document' do
       subject
-      expect(response).to redirect_to Lcms::Engine::Admin::AdminController.document_path(document)
+      expect(response).to redirect_to document_path(document)
     end
 
     # TODO: Rails upgrade - move to system spec
@@ -53,7 +53,7 @@ describe Lcms::Engine::Admin::DocumentsController do
 
       it 'calls batch reimport' do
         expect(Lcms::Engine::DocumentGenerator).to \
-          receive_message_chain(:document_parse_job, :perform_later).and_return(OpenStruct.new(job_id: 0))
+          receive_message_chain(:document_parse_job, :perform_later).and_return(double('response', job_id: 0))
         subject
       end
 
@@ -71,6 +71,18 @@ describe Lcms::Engine::Admin::DocumentsController do
         end
       end
     end
+
+    context 'when asynchronous import was requested' do
+      let(:link) { 'https://google.com/somefile' }
+      let(:params) { { async: '1', link: link } }
+
+      before { allow(controller).to receive(:bulk_import) }
+
+      it 'calls bulk import for that particular document' do
+        expect(controller).to receive(:bulk_import).with(Array.wrap(link))
+        subject
+      end
+    end
   end
 
   describe '#destroy' do
@@ -81,6 +93,14 @@ describe Lcms::Engine::Admin::DocumentsController do
     it 'deletes the document' do
       expect { subject }.to change(Lcms::Engine::Document, :count).by(-1)
     end
+
+    context 'when there was custom filter' do
+      let(:query) { { course: 'value' } }
+
+      subject { delete :destroy, params: { id: document.id, query: query } }
+
+      it { is_expected.to redirect_to "/lcms-engine/admin/documents?#{{ query: query }.to_param}" }
+    end
   end
 
   describe '#new' do

data/spec/controllers/admin/materials_controller_spec.rb

@@ -3,6 +3,8 @@
 require 'rails_helper'
 
 describe Lcms::Engine::Admin::MaterialsController do
+  include Lcms::Engine::PathHelper
+
   let(:user) { create :admin }
 
   before { sign_in user }
@@ -25,7 +27,7 @@ describe Lcms::Engine::Admin::MaterialsController do
 
     it 'redirects to material' do
       subject
-      expect(response).to redirect_to Lcms::Engine::Admin::AdminController.material_path(material)
+      expect(response).to redirect_to material_path(material)
     end
 
     context 'when there is an error' do
@@ -51,7 +53,7 @@ describe Lcms::Engine::Admin::MaterialsController do
 
       it 'calls batch reimport' do
         expect(Lcms::Engine::DocumentGenerator).to \
-          receive_message_chain(:material_parse_job, :perform_later).and_return(OpenStruct.new(job_id: 0))
+          receive_message_chain(:material_parse_job, :perform_later).and_return(double('response', job_id: 0))
         subject
       end
 
@@ -69,6 +71,17 @@ describe Lcms::Engine::Admin::MaterialsController do
         end
       end
     end
+
+    context 'when asynchronous import was requested' do
+      let(:params) { { async: '1', link: link } }
+
+      before { allow(controller).to receive(:bulk_import) }
+
+      it 'calls bulk import for that particular document' do
+        expect(controller).to receive(:bulk_import).with(Array.wrap(link))
+        subject
+      end
+    end
   end
 
   describe '#destroy' do
@@ -83,7 +96,7 @@ describe Lcms::Engine::Admin::MaterialsController do
 
       subject { delete :destroy, params: { id: material.id, query: query } }
 
-      it { is_expected.to redirect_to admin_materials_path(query: query) }
+      it { is_expected.to redirect_to "/lcms-engine/admin/materials?#{{ query: query }.to_param}" }
     end
   end