lcms-engine 0.1.2 → 0.3.1

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

@@ -15,9 +15,9 @@ module Lcms
 
           if response.success?
             url = DocumentExporter::Gdoc::Base.url_for JSON.parse(response.body)['id']
-            redirect_to :back, notice: t('.success', url: url)
+            redirect_back fallback_location: new_admin_sketch_compiler_path, notice: t('.success', url: url)
           else
-            redirect_to :back, alert: t('.compile_error')
+            redirect_back fallback_location: new_admin_sketch_compiler_path, alert: t('.compile_error')
           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/controllers/lcms/engine/application_controller.rb

@@ -6,12 +6,6 @@ module Lcms
       # store location to use at after sign in or other devise callbacks
       include LocationStorable
 
-      protect_from_forgery with: :exception
-
-      # NOTE: Temporary disabled
-      # require auth for accessing the pilot
-      # before_action :pilot_authentication if Rails.env.production? || Rails.env.production_swap?
-
       before_action :authenticate_user!, unless: :pdf_request?
 
       before_action :check_user_has_survey_filled_in, if: :user_signed_in?, unless: :devise_controller?
@@ -54,15 +48,6 @@ module Lcms
       def after_sign_out_path_for(resource_or_scope)
         session_path(resource_or_scope)
       end
-
-      # NOTE: Temporary disabled
-      # def pilot_authentication
-      #   return unless request.format.html?
-      #
-      #   authenticate_or_request_with_http_basic('Administration') do |username, password|
-      #     username == ENV['HTTP_AUTH_NAME'] && password == ENV['HTTP_AUTH_PASS']
-      #   end
-      # end
     end
   end
 end

data/app/controllers/lcms/engine/surveys_controller.rb

@@ -9,33 +9,22 @@ module Lcms
         @form = SurveyForm.new(permitted_params)
         if @form.valid?
           current_user.update(survey: @form.attributes)
-          notify_heap
           loc = stored_location_for(:user)
-          loc = root_path if loc.is_a?(String) && loc[survey_path]
-          redirect_to loc || root_path
+          loc = lcms_engine.root_path if loc.is_a?(String) && loc[survey_path]
+          redirect_to loc || lcms_engine.root_path
         else
           render :show
         end
       end
 
       def show
-        return redirect_to root_path if current_user.ready_to_go?
+        return redirect_to lcms_engine.root_path if current_user.ready_to_go?
 
         @form = SurveyForm.new(current_user.survey)
       end
 
       private
 
-      def notify_heap
-        data = current_user
-                 .survey.except('first_name', 'last_name')
-                 .merge(
-                   access_code: current_user.access_code,
-                   email: current_user.email
-                 )
-        Heap.add_user_properties current_user.id, data
-      end
-
       def permitted_params
         params.require(:survey_form).permit(
           :additional_period,

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

@@ -3,15 +3,16 @@
 module Lcms
   module Engine
     class Pagination
+      PARAMS_DEFAULT = { page: 1, per_page: 20, order: :asc }.freeze
+
       def initialize(params)
-        @params = params
+        @params = handle_params params
       end
 
       def params(strict: false)
         @pagination_params ||= begin
-          default_params = { page: 1, per_page: 20, order: :asc }
-          expected_params = @params.slice(:page, :per_page, :order).symbolize_keys
-          pagination = default_params.merge(expected_params)
+          expected_params = @params.slice(*PARAMS_DEFAULT.keys).symbolize_keys
+          pagination = PARAMS_DEFAULT.merge(expected_params)
 
           pagination[:page] = pagination[:page].to_i
           pagination[:per_page] = pagination[:per_page].to_i
@@ -37,7 +38,15 @@ module Lcms
           total_hits: resources.total_entries
         }
         options[:each_serializer] = serializer
-        ActiveModel::ArraySerializer.new(resources, options).as_json
+        ActiveModel::Serializer::CollectionSerializer.new(resources, options).as_json
+      end
+
+      private
+
+      def handle_params(params)
+        return params unless params.is_a?(ActionController::Parameters)
+
+        params.permit(*PARAMS_DEFAULT.keys).to_h
       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)
@@ -22,17 +22,19 @@ module Lcms
         return false unless valid?
 
         params = {
+          dpi: options[:dpi],
           import_retry: options[:import_retry],
           source_type: source_type.presence
         }.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/application_helper.rb

@@ -8,8 +8,12 @@ module Lcms
       include ViewHelper
       include ::Webpacker::Helper
 
-      def current_webpacker_instance
-        Lcms::Engine.webpacker
+      # Use this to include lcms-engine based packs
+      def lcms_engine_javascript_pack_tag(*names, **options)
+        entries = names
+                    .map { |name| Lcms::Engine.webpacker.manifest.lookup!(name, type: :javascript) }
+                    .flatten
+        javascript_include_tag(*entries, **options)
       end
     end
   end

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

@@ -37,13 +37,6 @@ module Lcms
         ResourceDownload::DOWNLOAD_PER_CATEGORY_LIMIT
       end
 
-      def download_heap_data(download, opts = {})
-        {
-          category: download.download_category&.title,
-          url: download.download.filename.url
-        }.merge(opts).to_json
-      end
-
       def resource_breadcrumbs_with_links(resource)
         return GenericPresenter.new(resource).generic_title if resource.generic?
 
@@ -78,16 +71,6 @@ module Lcms
           .where(id: ids).pluck(:alt_names).flatten.uniq
           .map { |n| Standard.filter_ccss_standards(n, resource.subject) }.compact.sort
       end
-
-      def bundle_heap_data(resource, bundle, cat, content_type)
-        {
-          resource_id: resource.id,
-          resource_title: resource.title,
-          url: bundle.file&.url.presence || bundle.url,
-          category: cat,
-          type: content_type
-        }.to_json
-      end
     end
   end
 end

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

@@ -3,9 +3,7 @@
 module Lcms
   module Engine
     module ViewHelper # rubocop:disable Metrics/ModuleLength
-      ENABLE_BASE64_CACHING = ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES.include?(
-        ENV.fetch('ENABLE_BASE64_CACHING', true)
-      )
+      ENABLE_BASE64_CACHING = ActiveRecord::Type::Boolean.new.cast ENV.fetch('ENABLE_BASE64_CACHING', true)
 
       def add_class_for_path(link_path, klass, klass_prefix = nil)
         [
@@ -118,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

@@ -32,7 +32,7 @@ module Lcms
       end
 
       def grades_props
-        ActiveModel::ArraySerializer.new(
+        ActiveModel::Serializer::CollectionSerializer.new(
           grades,
           each_serializer: CurriculumResourceSerializer,
           root: :results
@@ -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,13 +71,14 @@ 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>
     ))
   }
 
   spinner() {
-    return <span className="o-adm-materials__spinner button primary u-margin-bottom--zero"><i className="fa fa-spin fa-spinner" /></span>
+    return <span className="o-adm-materials__spinner button primary u-margin-bottom--zero"><i className="fas fa-spin fa-spinner" /></span>
   }
 
   render() {
@@ -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>
       )
     })