lcms-engine 0.3.0 → 0.4.0

data/spec/dummy/config/lcms-admin.yml

@@ -2,17 +2,13 @@
 # Admin layout
 layout: 'lcms/engine/admin'
 
-# TODO: Check the default values handling
-# Engine
-engine: 'Lcms::Engine::Engine'
-
 # TODO: Check the default values handling
 # Redirects
 redirect:
   host:
-#    root_path: 'admin_path'
-#    document_path: 'document_path'
-#    material_path: 'material_path'
+    root_path: 'admin_path'
+    document_path: 'document_path'
+    material_path: 'material_path'
   engine:
     root_path: 'admin_path'
     document_path: 'document_path'

data/spec/dummy/config/puma.rb

@@ -6,16 +6,16 @@
 # the maximum value specified for Puma. Default is set to 5 threads for minimum
 # and maximum; this matches the default thread size of Active Record.
 #
-threads_count = ENV.fetch('RAILS_MAX_THREADS') { 5 }
+threads_count = ENV.fetch('RAILS_MAX_THREADS', 5)
 threads threads_count, threads_count
 
 # Specifies the `port` that Puma will listen on to receive requests; default is 3000.
 #
-port        ENV.fetch('PORT') { 3000 }
+port        ENV.fetch('PORT', 3000)
 
 # Specifies the `environment` that Puma will run in.
 #
-environment ENV.fetch('RAILS_ENV') { 'development' }
+environment ENV.fetch('RAILS_ENV', 'development')
 
 # Specifies the number of `workers` to boot in clustered mode.
 # Workers are forked webserver processes. If using threads and workers together

data/spec/dummy/config/routes.rb

@@ -4,5 +4,11 @@ Rails.application.routes.draw do
   mount Lcms::Engine::Engine => '/lcms-engine'
   root to: redirect('/lcms-engine/')
 
+  get '/oauth2callback', to: redirect(path: '/lcms-engine/oauth2callback')
+
+  # Used for testing only
+  direct(:document) { '/' }
+  direct(:material) { '/' }
+
   get '/admin', to: 'welcome#index', as: :admin
 end

data/spec/dummy/db/schema.rb

@@ -2,11 +2,11 @@
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# Note that this schema.rb definition is the authoritative source for your
-# database schema. If you need to create the application database on another
-# system, you should be using db:schema:load, not running all the migrations
-# from scratch. The latter is a flawed and unsustainable approach (the more migrations
-# you'll amass, the slower it'll run and the greater likelihood for issues).
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
 #
 # It's strongly recommended that you check this file into your version control system.
 

data/spec/entities/grades_spec.rb

@@ -8,6 +8,18 @@ describe Lcms::Engine::Grades do
   let(:dir) { [] }
   let(:resource) { create :resource, metadata: { grade: dir.uniq } }
 
+  describe 'grades' do
+    it 'returns GRADES constant' do
+      expect(described_class.grades).to eq Lcms::Engine::Grades::GRADES
+    end
+  end
+
+  describe 'gardes_abbrevs' do
+    it 'returns GRADES_ABBR constant' do
+      expect(described_class.grades_abbrevs).to eq Lcms::Engine::Grades::GRADES_ABBR
+    end
+  end
+
   describe 'list' do
     let(:dir) { ['grade 2'] }
     let(:search_doc) { Lcms::Engine::Search::Document.new(grade: ['kindergarten']) }

data/spec/factories/documents.rb

@@ -2,5 +2,6 @@
 
 FactoryBot.define do
   factory :document, class: Lcms::Engine::Document do
+    file_id { "file_#{SecureRandom.hex(6)}" }
   end
 end

data/spec/factories/downloads.rb

@@ -2,7 +2,7 @@
 
 FactoryBot.define do
   factory :download, class: Lcms::Engine::Download do
-    title { Faker::Lorem.words.join '' }
+    title { Faker::Lorem.words.join }
     url { Faker::Internet.url }
   end
 end

data/spec/factories/resources.rb

@@ -5,7 +5,7 @@ FactoryBot.define do
     curriculum { ::Lcms::Engine::Curriculum.default || create(:curriculum) }
     curriculum_type { 'lesson' }
     metadata do
-      { subject: 'ela', grade: 'grade 2', 'module': 'module 1',
+      { subject: 'ela', grade: 'grade 2', module: 'module 1',
         unit: 'unit 1', lesson: 'lesson 1' }
     end
     resource_type { ::Lcms::Engine::Resource.resource_types[:resource] }
@@ -20,7 +20,7 @@ FactoryBot.define do
 
     trait :module do
       curriculum_type { 'module' }
-      metadata { { subject: 'ela', grade: 'grade 2', 'module': 'module 1' } }
+      metadata { { subject: 'ela', grade: 'grade 2', module: 'module 1' } }
     end
   end
 end

data/spec/features/admin/lessons/add_lesson_spec.rb

@@ -3,9 +3,9 @@
 require 'rails_helper'
 
 feature 'Admin adds a lesson' do
-  SAMPLE_LESSON_PATH = 'spec/features/admin/lessons/sample-lessons'
+  given(:sample_lesson_path) { 'spec/features/admin/lessons/sample-lessons' }
 
-  DownloadedFile = Struct.new :last_modifying_user, :modified_time, :name, :version
+  given(:downloaded_file) { Struct.new :last_modifying_user, :modified_time, :name, :version }
 
   given(:sample_lessons) do
     [
@@ -43,7 +43,7 @@ feature 'Admin adds a lesson' do
 
       # stub GDoc download
       file_content = File.read File.join(SAMPLE_LESSON_PATH, data[:file_name])
-      allow_any_instance_of(DocumentDownloader::Gdoc).to receive(:file).and_return(DownloadedFile.new(nil, nil, idx))
+      allow_any_instance_of(DocumentDownloader::Gdoc).to receive(:file).and_return(downloaded_file.new(nil, nil, idx))
       allow_any_instance_of(DocumentDownloader::Gdoc).to receive(:content).and_return(file_content)
 
       fill_in :document_form_link, with: data[:url]

data/spec/features/admin/materials/add_material_spec.rb

@@ -6,7 +6,7 @@ require 'lt/lcms/lesson/downloader/gdoc'
 require 'lt/lcms/lesson/downloader/pdf'
 
 feature 'Admin adds a material' do
-  SAMPLE_PATH = 'spec/features/admin/materials/sample-materials'
+  given(:sample_path) { 'spec/features/admin/materials/sample-materials' }
 
   given(:downloaded_file) { Struct.new :last_modifying_user, :modified_time, :name, :version }
 
@@ -34,7 +34,7 @@ feature 'Admin adds a material' do
     data = samples[:gdoc]
 
     # stub GDoc download
-    file_content = File.read File.join(SAMPLE_PATH, data[:file_name])
+    file_content = File.read File.join(sample_path, data[:file_name])
     base_klass = ::Lt::Lcms::Lesson::Downloader::Base
     gdoc_klass = ::Lt::Lcms::Lesson::Downloader::Gdoc
     allow_any_instance_of(base_klass).to receive(:file).and_return(downloaded_file.new(nil, nil, data[:file_name]))
@@ -44,6 +44,7 @@ feature 'Admin adds a material' do
     expect(page).to have_field :material_form_link
 
     fill_in :material_form_link, with: data[:url]
+    find('#material_form_async').uncheck
     click_button 'Parse'
 
     expect(Lcms::Engine::Material.last.name).to eql(data[:file_name])
@@ -59,13 +60,14 @@ feature 'Admin adds a material' do
     base_klass = ::Lt::Lcms::Lesson::Downloader::Base
     allow_any_instance_of(base_klass).to receive(:file).and_return(downloaded_file.new(nil, nil, data[:file_name]))
 
-    file_content = File.read File.join(SAMPLE_PATH, data[:file_name])
+    file_content = File.read File.join(sample_path, data[:file_name])
     allow_any_instance_of(Lt::Lcms::Lesson::Downloader::PDF).to receive(:pdf_content).and_return(file_content)
     allow_any_instance_of(DocumentExporter::Thumbnail).to receive(:export)
     allow_any_instance_of(DocumentExporter::Thumbnail).to receive(:orientation)
     allow(Lcms::Engine::S3Service).to receive(:upload)
 
     fill_in :material_form_link, with: data[:url]
+    find('#material_form_async').uncheck
     click_button 'Parse'
 
     expect(Lcms::Engine::Material.last.name).to eql(data[:file_name])

data/spec/features/admin/users_spec.rb

@@ -7,7 +7,7 @@ feature 'Admin users' do
 
   given(:access_code) { create(:access_code).code }
   given(:admin) { create :admin }
-  given(:domain) { ENV['APPLICATION_DOMAIN'] }
+  given(:domain) { ENV.fetch('APPLICATION_DOMAIN', nil) }
   given!(:user) { create :user, email: "unbounded@#{domain}" }
   given(:name) { Faker::Lorem.name }
   given(:email) { Faker::Internet.email }
@@ -57,7 +57,7 @@ feature 'Admin users' do
     click_button 'Save'
 
     user.reload
-    expect(current_path).to eq lcms_engine.edit_admin_user_path(user.id)
+    expect(current_path).to eq lcms_engine.admin_users_path
     expect(page.find('.callout.success').text).to include('saved successfully')
     expect(user.email).to eq "unbounded@#{domain}"
     expect(user.unconfirmed_email).to eq "joe@#{domain}"

data/spec/forms/document_form_spec.rb

@@ -10,7 +10,7 @@ describe Lcms::Engine::DocumentForm do
 
   describe '#save' do
     let(:document) { create :document }
-    let(:service) { instance_double('DocumentBuildService', build_for: document) }
+    let(:service) { instance_double('DocumentBuildService', build_for: document, errors: []) }
 
     subject { form.save }
 
@@ -64,6 +64,16 @@ describe Lcms::Engine::DocumentForm do
           subject
         end
       end
+
+      context 'when there are non-critical errors' do
+        let(:errors) { %w(error-1 error-2 error-3) }
+        let(:service) { instance_double('DocumentBuildService', build_for: document, errors: errors) }
+
+        it 'store service errors' do
+          subject
+          expect(form.service_errors).to eq errors
+        end
+      end
     end
 
     context 'when is invalid' do

data/spec/{controllers/admin/admin_controller_spec.rb → helpers/path_helper_spec.rb}

@@ -2,26 +2,26 @@
 
 require 'rails_helper'
 
-describe Lcms::Engine::Admin::AdminController do
-  describe '.host_engine_path' do
+describe Lcms::Engine::PathHelper do
+  describe '#dynamic_path' do
     let(:args) { { query: 'test', filter: '1' } }
 
-    subject { described_class.host_engine_path(:root_path, args) }
+    subject { helper.dynamic_path(:root_path, args) }
 
     context 'with host redirect' do
       it 'builds correct path' do
-        expect(subject).to eq "/lcms-engine/admin?#{args.to_param}"
+        expect(subject).to eq "/admin?#{args.to_param}"
       end
     end
 
     context 'with engine redirect' do
       let(:settings) do
-        settings = described_class.settings
+        settings = Lcms::Engine::Admin::AdminController.settings
         settings[:redirect].delete(:host)
         settings
       end
 
-      before { allow(described_class).to receive(:settings).and_return(settings) }
+      before { allow(Lcms::Engine::Admin::AdminController).to receive(:settings).and_return(settings) }
 
       it 'builds correct path' do
         expect(subject).to eq "/lcms-engine/admin?#{args.to_param}"

data/spec/lib/doc_template/objects/activity_metadata_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'rails_helper'
-require 'doc_template/objects/activity_metadata'
+# require 'doc_template/objects/activity_metadata'
 
 describe DocTemplate::Objects::ActivityMetadata do
   describe '.build_from' do

data/spec/lib/doc_template/objects/agenda_metadata_spec.rb

@@ -15,6 +15,7 @@ describe DocTemplate::Objects::AgendaMetadata do
       end
     end
 
+    # rubocop:disable Naming/VariableNumber
     describe 'correct data' do
       describe 'calculates time hierarchily' do
         let(:agenda_table) do
@@ -116,5 +117,6 @@ describe DocTemplate::Objects::AgendaMetadata do
         end
       end
     end
+    # rubocop:enable Naming/VariableNumber
   end
 end

data/spec/lib/doc_template/objects/toc_metadata_spec.rb

@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-describe DocTemplate::Objects::TOCMetadata do
+describe DocTemplate::Objects::TocMetadata do
   let(:empty_toc) { {} }
   let(:l2_toc) do
     {

data/spec/lib/doc_template/tables/shared_examples/remove_table.rb

@@ -4,7 +4,7 @@ require 'rails_helper'
 
 shared_examples 'removes metadata table' do
   it 'removes original table' do
-    table_html = %r{<span\s+[^.]*>\[?#{described_class::HEADER_LABEL}\]?<\/span>}im
+    table_html = %r{<span\s+[^.]*>\[?#{described_class::HEADER_LABEL}\]?</span>}im
     subject
     expect(fragment.to_html).to_not match(table_html)
   end

data/spec/lib/doc_template/tags/page_break_tag_spec.rb

@@ -28,6 +28,6 @@ describe DocTemplate::Tags::PageBreakTag do
   context 'with soft returns on tag' do
     let(:original_content) { '<p><span>[page-break]</span>some content</p>' }
 
-    it { expect { subject }.to raise_error(DocumentError) }
+    it { expect { subject }.to raise_error(Lcms::Engine::DocumentError) }
   end
 end

data/spec/lib/doc_template/tags/pd_tag_spec.rb

@@ -9,7 +9,7 @@ describe DocTemplate::Tags::PdTag do
   let(:original_content) { "<p><span>[PD: #{url}; #{title}; </span><span>#{description}]</span></p><p><span>" }
   let(:params) do
     {
-      metadata: OpenStruct.new(resource_subject: 'ela'),
+      metadata: double('metadata', resource_subject: 'ela'),
       value: [url, title, description].join('; ')
     }
   end

data/spec/models/document_spec.rb

@@ -111,7 +111,7 @@ describe Lcms::Engine::Document do
     subject { document.ordered_material_ids }
 
     it 'proxies the call to the TOC' do
-      expect_any_instance_of(DocTemplate::Objects::TOCMetadata).to receive(:ordered_material_ids)
+      expect_any_instance_of(DocTemplate::Objects::TocMetadata).to receive(:ordered_material_ids)
       subject
     end
   end

data/spec/models/standard_spec.rb

@@ -8,6 +8,7 @@ describe Lcms::Engine::Standard do
     expect(obj).to be_valid
   end
 
+  # rubocop:disable Naming/VariableNumber
   describe '.search_by_name' do
     let(:alt_name) { 'a-synonym' }
     let(:name) { 'test-std' }
@@ -26,4 +27,5 @@ describe Lcms::Engine::Standard do
       expect(described_class.search_by_name(name).first).to eq standard_2
     end
   end
+  # rubocop:enable Naming/VariableNumber
 end

data/spec/queries/lcms/engine/admin_materials_query_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe Lcms::Engine::AdminMaterialsQuery do
+  describe 'filter by metadata' do
+    let(:query) { { lesson: 1, name_date: true } }
+    let(:scope) { double ActiveRecord::Relation }
+
+    before do
+      allow(Lcms::Engine::Material).to receive(:all).and_return(scope)
+      allow(scope).to receive_message_chain(:reorder, :distinct).and_return(scope)
+    end
+
+    subject { described_class.call query }
+
+    it 'filters by metadata using ILIKE' do
+      expect(scope).to receive(:where_metadata_like).with(:lesson, 1).and_return(scope)
+      expect(scope).to receive(:where_metadata_like).with(:name_date, true).and_return(scope)
+      subject
+    end
+
+    context 'strict metadata fields' do
+      let(:query) { { lesson: 1, grade: 'grade 1', subject: Faker::Lorem.word } }
+
+      it 'filters by metadata using explicit comparison' do
+        expect(scope).to receive(:where_metadata_like).with(:lesson, 1).and_return(scope)
+        expect(scope).to receive(:where_metadata).with(query.slice(:grade)).and_return(scope)
+        expect(scope).to receive(:where_metadata).with(query.slice(:subject)).and_return(scope)
+        subject
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 # This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'simplecov'
+SimpleCov.start 'rails'
+
 require 'spec_helper'
 
 ENV['RAILS_ENV'] ||= 'test'
@@ -16,8 +19,11 @@ require 'email_spec'
 require 'email_spec/rspec'
 require 'faker'
 
-Dir[File.expand_path('support/**/*.rb', __dir__)].each(&method(:require))
-Dir[File.expand_path('**/shared_examples/*.rb')].each(&method(:require))
+Warning[:deprecated] = true
+Warning[:experimental] = true
+
+Dir[File.expand_path('support/**/*.rb', __dir__)].sort.each(&method(:require))
+Dir[File.expand_path('**/shared_examples/*.rb')].sort.each(&method(:require))
 
 # Checks for pending migrations and applies them before tests are run.
 # If you are not using ActiveRecord, you can remove these lines.

data/spec/services/document_build_service_spec.rb

@@ -10,29 +10,22 @@ describe Lcms::Engine::DocumentBuildService do
     let(:downloader) { double }
     let(:downloaded_document) { 'html-here' }
     let(:file) do
-      OpenStruct.new(
-        name: 'file name',
-        modified_time: Time.current - 1.day
-      )
+      double('file', name: 'file name', modified_time: Time.current - 1.day, last_modifying_user: 'User', version: '42')
     end
     let(:file_id) { 'Google Document file id' }
     let(:parsed_document) do
-      OpenStruct.new(
-        activity_metadata: [{ 'material_ids' => [] }],
-        agenda: [],
-        parts: []
-      )
+      double('parsed_document', activity_metadata: [{ 'material_ids' => [] }], agenda: [], parts: [])
     end
     let(:template) do
       stubs = {
         css_styles: '',
         metadata: {},
-        metadata_service: nil,
+        metadata_service: double('service', errors: []),
         parse: parsed_document,
         parts: [],
         'prereq?' => false,
         render: '',
-        toc: OpenStruct.new(collect_material_ids: [])
+        toc: double('toc', collect_material_ids: [])
       }
       instance_double DocTemplate::Template, stubs
     end

data/spec/services/s3_service_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe Lcms::Engine::S3Service do
+  describe '.upload' do
+    let(:data) { StringIO.new('data to be uploaded') }
+    let(:full_options) { options.merge(body: data) }
+    let(:key) { 'path/to/file' }
+    let(:object) do
+      params = {
+        put: 'true',
+        public_url: url
+      }
+      double(::Aws::S3::Resource, **params)
+    end
+    let(:options) { { content_type: 'image/png' } }
+    let(:url) { Faker::Internet.url }
+
+    before { allow(described_class).to receive(:create_object).with(key).and_return(object) }
+
+    subject { described_class.upload(key, data, options) }
+
+    it 'uploads data with passed params' do
+      expect(object).to receive(:put).with(full_options)
+      subject
+    end
+
+    it 'returns URL of the uploaded object'
+  end
+end

data/spec/support/concerns/navigable.rb

@@ -2,6 +2,7 @@
 
 require 'rails_helper'
 
+# rubocop:disable Naming/VariableNumber
 shared_examples_for 'navigable' do # rubocop:disable Metrics/BlockLength
   let(:another_grandchild) { create factory }
   let(:child) { create factory }
@@ -71,3 +72,4 @@ shared_examples_for 'navigable' do # rubocop:disable Metrics/BlockLength
     end
   end
 end
+# rubocop:enable Naming/VariableNumber

data/spec/support/routes.rb

@@ -9,6 +9,10 @@ module Lcms
         included do
           routes { ::Lcms::Engine::Engine.routes }
         end
+
+        def lcms_engine(path)
+          "/lcms-engine#{path}"
+        end
       end
     end
   end

data/spec/support/shared_examples/content_tag.rb

@@ -11,7 +11,7 @@ shared_examples 'content_tag' do # rubocop:disable Metrics/BlockLength
       HTML
     end
 
-    it { expect { subject }.to raise_error(DocumentError) }
+    it { expect { subject }.to raise_error(Lcms::Engine::DocumentError) }
   end
 
   context 'with soft return before start tag' do
@@ -22,7 +22,7 @@ shared_examples 'content_tag' do # rubocop:disable Metrics/BlockLength
       HTML
     end
 
-    it { expect { subject }.to raise_error(DocumentError) }
+    it { expect { subject }.to raise_error(Lcms::Engine::DocumentError) }
   end
 
   context 'with soft return before stop tag' do
@@ -34,7 +34,7 @@ shared_examples 'content_tag' do # rubocop:disable Metrics/BlockLength
       HTML
     end
 
-    it { expect { subject }.to raise_error(DocumentError) }
+    it { expect { subject }.to raise_error(Lcms::Engine::DocumentError) }
   end
 
   context 'with soft return after stop tag' do
@@ -46,6 +46,6 @@ shared_examples 'content_tag' do # rubocop:disable Metrics/BlockLength
       HTML
     end
 
-    it { expect { subject }.to raise_error(DocumentError) }
+    it { expect { subject }.to raise_error(Lcms::Engine::DocumentError) }
   end
 end

data/templates/routes.rb

@@ -54,7 +54,6 @@ Rails.application.routes.draw do
 
   namespace :admin do
     get '/' => 'welcome#index'
-    get '/whoami' => 'admin#whoami'
     get 'google_oauth2_callback' => 'google_oauth2#callback'
     get '/association_picker' => 'association_picker#index'
     resources :reading_assignment_texts