lcms-engine 0.1.0

data/lib/generators/lcms/engine/install/templates/config/materials_rules.yml

@@ -0,0 +1,20 @@
+student:
+  sheet_type:
+    - student
+  type:
+    - default
+    - family-letter
+    - recommended-books
+
+sheet_types:
+  default: student
+  family-letter: student
+  recommended-books: student
+  vocabulary-chart: classroom
+
+teacher:
+  sheet_type:
+    - classroom
+    - teacher
+  type:
+    - vocabulary-chart

data/lib/generators/lcms/engine/install/templates/config/pdf.yml

@@ -0,0 +1,21 @@
+default:
+  dpi: 72 # screen dpi to match font sizes
+  image_dpi: 300
+  header: true
+  name_date: false
+  margin:
+    top: 0.5in
+    right: 1in
+    bottom: 0.5in # to have 0.5in margin within 8pt footer + 7pt gap from footer to page content
+    left: 0.5in
+  orientation: portrait
+  padding:
+    right: 0
+    left: 0
+handout:
+  name_date: true
+  margin:
+    top: 1.25in
+    right: 1.25in
+    bottom: 1.25in # to have 1.25in margin within 8pt footer + 0.75in gap from footer to page content
+    left: 1.25in

data/lib/generators/lcms/engine/install/templates/config/tags.yml

@@ -0,0 +1,176 @@
+activity-metadata-section:
+  stop_materials_tags:
+    - ActivityMetadataSectionTag
+    - ActivityMetadataTypeTag
+  stop_tags:
+    - ActivityMetadataSectionTag
+activity-metadata-type:
+  priority_descriptions:
+    - 'This is a Priority 1 activity that should not be skipped. It is tightly connected to the lesson objective.'
+    - 'This is a Priority 2 activity that can be skipped if running short on time. It is less tightly connected to the lesson objective. It might be designed as an extension or to ensure maintenance of prior skills.'
+    - 'This is a Priority 3 activity that can be skipped if running short on time. It is not connected to the lesson objective. It might be designed in anticipation of upcoming learning.'
+  stop_tags:
+    - ActivityMetadataSectionTag
+    - ActivityMetadataTypeTag
+assess:
+  stop_tags:
+    - AssessTag
+    - EtTag
+    - OptBreakTag
+    - GroupTag
+    - JsTag
+    - KeyTag
+    - PhotoTag
+    - RubricTag
+    - SectionTag
+    - ShTag
+    - ThTag
+#default:
+#  remove: true # Do not remove `DefaultTag` from the source
+latex:
+  # RGB representation of the `math-base` color
+  color: '0,166,153'
+et:
+  stop_tags:
+    - AssessTag
+    - EtTag
+    - OptBreakTag
+    - GroupTag
+    - JsTag
+    - KeyTag
+    - PhotoTag
+    - RubricTag
+    - SectionTag
+    - ShTag
+    - ThTag
+group:
+  stop_materials_tags:
+    - GroupTag
+    - SectionTag
+  stop_tags:
+    - GroupTag
+js:
+  stop_tags:
+    - AssessTag
+    - EtTag
+    - OptBreakTag
+    - GroupTag
+    - JsTag
+    - KeyTag
+    - PhotoTag
+    - RubricTag
+    - SectionTag
+    - ShTag
+    - ThTag
+key:
+  stop_tags:
+    - AssessTag
+    - EtTag
+    - OptBreakTag
+    - GroupTag
+    - JsTag
+    - KeyTag
+    - PhotoTag
+    - RubricTag
+    - SectionTag
+    - ShTag
+    - ThTag
+materials:
+  stop_tags:
+    - ActivityMetadataSectionTag
+    - ActivityMetadataTypeTag
+optbreak:
+  stop_tags:
+    - GroupTag
+    - SectionTag
+pdf_templates_path:
+photo:
+  stop_tags:
+    - AssessTag
+    - EtTag
+    - OptBreakTag
+    - GroupTag
+    - JsTag
+    - KeyTag
+    - PhotoTag
+    - RubricTag
+    - SectionTag
+    - ShTag
+    - ThTag
+pv:
+  hundreds:
+    column_count: 1
+    row_count: 3
+    text_header: 'Unlabeled Hundreds Place Value Chart Template'
+    text_footer: 'unlabeled hundreds place value chart'
+  millions:
+    column_count: 2
+    row_count: 7
+    text_footer: 'unlabeled millions place value chart'
+    text_header: 'Unlabeled Millions Place Value Chart Template'
+  thousands:
+    column_count: 1
+    row_count: 4
+    text_footer: 'unlabeled thousands place value chart'
+    text_header: 'Unlabeled Thousands Place Value Chart Template'
+  hundred-thousands:
+    column_count: 2
+    column_width:
+      - 10%
+      - 85%
+    row_count: 6
+    text_footer: 'unlabeled hundred thousands place value chart'
+    text_header: 'Unlabeled Hundred Thousands Place Value Chart Template'
+rubric:
+  stop_tags:
+    - AssessTag
+    - EtTag
+    - OptBreakTag
+    - GroupTag
+    - JsTag
+    - KeyTag
+    - PhotoTag
+    - RubricTag
+    - SectionTag
+    - ShTag
+    - ThTag
+section:
+  priority_descriptions:
+    - 'This is a Priority 1 activity that should not be skipped. It is tightly connected to the focus objective(s) of the lesson or unit.'
+    - 'This is a Priority 2 activity that can be moved or adapted if running short on time. It is less tightly connected to the focus objective(s) of the lesson or unit.'
+  stop_tags:
+    - OptBreakTag
+    - GroupTag
+    - SectionTag
+sh:
+  stop_tags:
+    - AssessTag
+    - EtTag
+    - OptBreakTag
+    - GroupTag
+    - JsTag
+    - KeyTag
+    - PhotoTag
+    - RubricTag
+    - SectionTag
+    - ShTag
+    - ThTag
+source:
+  stop_tags:
+    - ActivityMetadataSectionTag
+    - ActivityMetadataTypeTag
+    - MaterialsTag
+templates_paths:
+th:
+  stop_tags:
+    - AssessTag
+    - EtTag
+    - OptBreakTag
+    - GroupTag
+    - JsTag
+    - KeyTag
+    - PhotoTag
+    - RubricTag
+    - SectionTag
+    - ShTag
+    - ThTag

data/lib/lcms/engine.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Lcms
+  module Engine
+    class << self
+      # TODO: Set the correct prefix after renaming all the tables?
+      def table_name_prefix
+        ''
+      end
+
+      def webpacker
+        @webpacker ||=
+          begin
+            root_path = Pathname.new File.expand_path('../..', __dir__)
+            ::Webpacker::Instance.new(
+              root_path: root_path,
+              config_path: root_path.join('config/webpacker.yml')
+            )
+          end
+      end
+    end
+  end
+end
+
+require 'lcms/engine/engine'
+require 'lcms/engine/migration'

data/lib/lcms/engine/engine.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require 'active_job'
+require 'acts-as-taggable-on'
+require 'active_model_serializers'
+require 'backport_new_renderer'
+require 'carrierwave'
+require 'carrierwave/orm/activerecord'
+require 'closure_tree'
+require 'devise'
+require 'heap'
+require 'i18n-js'
+require 'jquery-rails'
+require 'pdfjs_viewer-rails'
+require 'ransack'
+require 'react-rails'
+require 'resque/server'
+require 'turbolinks'
+require 'validate_url'
+require 'virtus'
+require 'will_paginate'
+require 'will_paginate-bootstrap'
+
+# UI and asset specific gems have to be required for host app to have access to its assets
+require 'ckeditor'
+require 'font-awesome-sass'
+require 'foundation-rails'
+require 'js-routes'
+require 'nested_form'
+require 'rails-assets-classnames'
+require 'rails-assets-es6-promise'
+require 'rails-assets-eventemitter3'
+require 'rails-assets-fetch'
+require 'rails-assets-jstree'
+require 'rails-assets-lodash'
+require 'rails-assets-selectize'
+require 'webpacker'
+
+# LearningTapestry gems
+require 'lt/google/api'
+require 'lt/google/api/auth/credentials'
+require 'lt/lcms'
+
+module Lcms
+  module Engine
+    class Engine < ::Rails::Engine
+      isolate_namespace Lcms::Engine
+
+      config.redis = Redis.new(url: ENV.fetch('REDIS_URL', 'redis://localhost:6379'))
+
+      config.autoload_paths += [
+        config.root.join('lib'),
+        config.root.join('app', 'jobs', 'concerns')
+      ]
+
+      config.i18n.load_path += Dir[config.root.join('config', 'locales', '**', '*.yml')]
+
+      # Used by i18n-js gem
+      config.middleware.use I18n::JS::Middleware
+
+      config.middleware.insert_after ActionDispatch::Static, Rack::LiveReload if ENV['ENABLE_LIVERELOAD']
+
+      config.assets.paths << "#{config.root}/public/javascripts"
+
+      config.after_initialize do
+        config.active_job.queue_adapter = :resque
+
+        if ::Rails.env.development? || ::Rails.env.test?
+          require 'bullet'
+
+          ::Bullet.enable = true
+          ::Bullet.bullet_logger = true
+          ::Bullet.console = true
+          ::Bullet.rails_logger = true
+        end
+      end
+
+      config.to_prepare do
+        Dir
+          .glob(Rails.root + 'app/decorators/**/*_decorator*.rb')
+          .each(&method(:require_dependency))
+      end
+
+      config.generators do |g|
+        g.test_framework :rspec
+        g.fixture_replacement :factory_bot
+        g.factory_bot dir: 'spec/factories'
+      end
+
+      initializer 'append_migrations' do |app|
+        unless app.root.to_s.match?(root.to_s)
+          config.paths['db/migrate'].expanded.each do |expanded_path|
+            app.config.paths['db/migrate'] << expanded_path
+          end
+        end
+      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
+        # )
+      end
+
+      initializer 'webpacker.proxy' do |app|
+        insert_middleware =
+          begin
+            Lcms::Engine.webpacker.config.dev_server.present?
+          rescue StandardError
+            nil
+          end
+        next unless insert_middleware
+
+        app.middleware.insert_before(
+          0, Webpacker::DevServerProxy,
+          ssl_verify_none: true,
+          webpacker: Lcms::Engine.webpacker
+        )
+      end
+
+      # Serves the engine's webpack when requested
+      initializer 'webpacker.static' do |app|
+        app.config.middleware.use(
+          Rack::Static,
+          urls: ['/lcms_engine_packs'],
+          root: File.join(Gem.loaded_specs['lcms-engine'].full_gem_path, 'public')
+        )
+      end
+
+      ENABLE_CACHING = ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES.include?(
+        ENV.fetch('ENABLE_CACHING', true)
+      )
+
+      if ENABLE_CACHING
+        redis_url = ENV.fetch('REDIS_URL', 'redis://localhost:6379')
+        config.cache_store = :readthis_store, {
+          expires_in: 1.hour.to_i,
+          namespace: 'unbounded',
+          redis: { url: redis_url, driver: :hiredis }
+        }
+      else
+        config.cache_store = :null_store
+      end
+
+      # NOTE: Sample to customize the layout
+      # config.to_prepare do
+      #   Devise::SessionsController.layout "layout_for_sessions_controller"
+      # end
+    end
+  end
+end

data/lib/lcms/engine/migration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Lcms
+  module Engine
+    if Rails::VERSION::MAJOR >= 5
+      class Migration < ActiveRecord::Migration[RAILS_5_VERSION]
+      end
+    else
+      # Rails 4 migrations are not versioned.
+      class Migration < ActiveRecord::Migration
+      end
+    end
+  end
+end

data/lib/lcms/engine/test/resource_helpers.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Lcms
+  module Engine
+    module Test
+      module ResourceHelpers
+        def resources_sample_collection
+          # ELA G2 => 2 lessons
+          2.times do |i|
+            pos = i + 1
+            dir = ['ela', 'grade 2', 'module 1', 'unit 1', "lesson #{pos}"]
+            create(:resource,
+                   title: "Test Resource ELA G2 L#{pos}",
+                   metadata: ::Lcms::Engine::Resource.metadata_from_dir(dir))
+          end
+
+          # ELA G6 => 6 lessons
+          6.times do |i|
+            pos = i + 1
+            dir = ['ela', 'grade 6', 'module 1', 'unit 1', "lesson #{pos}"]
+            create(:resource,
+                   title: "Test Resource ELA G6 L#{pos}",
+                   metadata: ::Lcms::Engine::Resource.metadata_from_dir(dir))
+          end
+
+          # Math G4 => 4 lessons
+          4.times do |i|
+            pos = i + 1
+            dir = ['math', 'grade 4', 'module 1', 'unit 1', "lesson #{pos}"]
+            create(:resource,
+                   title: "Test Resource Math G4 L#{pos}",
+                   metadata: ::Lcms::Engine::Resource.metadata_from_dir(dir))
+          end
+
+          # Math G7 => 7 lessons
+          7.times do |i|
+            pos = i + 1
+            dir = ['math', 'grade 7', 'module 1', 'unit 1', "lesson #{pos}"]
+            create(:resource,
+                   title: "Test Resource Math G7 L#{pos}",
+                   metadata: ::Lcms::Engine::Resource.metadata_from_dir(dir))
+          end
+        end
+
+        def build_resources_chain(curr)
+          dir = []
+          parent = nil
+          ::Lcms::Engine::Resource.hierarchy.each_with_index do |type, idx|
+            next unless curr[idx]
+
+            dir.push curr[idx]
+            res = create(:resource,
+                         title: "Test Resource #{dir.join('|')}",
+                         short_title: curr[idx],
+                         curriculum_type: type,
+                         parent: parent,
+                         metadata: ::Lcms::Engine::Resource.metadata_from_dir(dir))
+            parent = res
+          end
+        end
+
+        def build_or_return_resources_chain(curr)
+          dir = []
+          parent = nil
+          ::Lcms::Engine::Resource.hierarchy.each_with_index do |type, idx|
+            next unless curr[idx]
+
+            dir.push curr[idx]
+            res = ::Lcms::Engine::Resource.find_by(short_title: curr[idx]) ||
+                  FactoryBot.create(:resource,
+                                    title: "Test Resource #{dir.join('|')}",
+                                    short_title: curr[idx],
+                                    curriculum_type: type,
+                                    parent: parent,
+                                    metadata: ::Lcms::Engine::Resource.metadata_from_dir(dir))
+            parent = res
+          end
+          parent
+        end
+      end
+    end
+  end
+end