lcms-engine 0.3.1 → 0.4.0

data/README.md

@@ -2,6 +2,7 @@
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/9a41f6860cc4531fc27e/maintainability)](https://codeclimate.com/github/learningtapestry/lcms-engine/maintainability)
 [![Codeship Status for learningtapestry/lcms-engine](https://app.codeship.com/projects/d08d0660-26f7-0137-bc36-1692d0f2de6b/status?branch=master)](https://app.codeship.com/projects/330483)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
 
 Implements a Rails engine for Learning Content Management System (LCMS) applications.
 
@@ -11,11 +12,10 @@ separately, simplifying the client applications in the process.
 
 ## Current development
 
-|Branch|Rails version|
-|------|-------------|
-|master|Rails 6|
-|0.3.x|Rails 5.2.4.5|
-|0.1.x|Rails 4.2.11.3|
+| Branch | Rails version |
+|--------|---------------|
+| master | Rails 6.1.4.6 |
+| 0.3.x  | Rails 5.2.4.5 |
 
 This is still a [work in progress](https://github.com/learningtapestry/lcms-engine/issues/3). The
 initial phase of the project consisted in extracting as much code as possible from the client
@@ -83,20 +83,19 @@ overridden as easily as Ruby classes and modules, but you can always provide you
 the same files, overwriting the ones provided by the engine.
 
 ## Requirements
-- Ruby 2.5 or higher
-- Rails 5.2.4 or higher
+- Ruby 2.7 or higher
+- Rails 6.1 or higher
 - Postgres 9.6 or higher
 
 ## Installation
 Add this to the Gemfile:
 ```ruby
-gem 'lcms-engine','~> 0.1' # Rails 4.2
+gem 'lcms-engine','~> 0.3' # Rails 5.2
 ```
 ```ruby
-gem 'lcms-engine','~> 0.2' # Rails 5.2
+gem 'lcms-engine' # Rails 6.1
 ```
 
-
 And then execute:
 ```bash
 $ bundle
@@ -133,9 +132,10 @@ mount Engine, at: '/engine', as: :engine
 
 If you need to redefine devise routes set up env `DEVISE_ROUTES_REDEFINED` as true and define devise related routes at host app.
 
-Host app routes examples:
-1. host app will have own routes on upper than engine level:
-```
+### Host app routes
+
+When host app has its own routes on upper than engine level:
+```ruby
 Lcms::Engine::Engine.routes.draw do
   devise_for :users, class_name: 'Lcms::Engine::User',
                      router_name: :main_app,
@@ -161,8 +161,8 @@ devise_scope :user do
   delete '/register', to: 'lcms/engine/registrations#destroy'
 end
 ```
-2. host app is ok with `/lcms` devise routes but want to redefine paths after that:
-```
+When host app is ok with `/lcms` devise routes but want to redefine paths after that:
+```ruby
 Lcms::Engine::Engine.routes.draw do
   devise_for :users, class_name: 'Lcms::Engine::User',
                      controllers: {
@@ -212,14 +212,16 @@ $ brew cask install chromedriver
 
 Launch the containers
 ```sh
-$ docker-compose start app
+$ docker build -t lcms-engine .
+$ docker compose start
+$ docker compose exec app sh -c 'bin/rails db:create'
+$ docker compose exec db sh -c "psql -U postgres -d template1 -c 'CREATE EXTENSION IF NOT EXISTS hstore;'"
 ```
 
 Start the specs
 ```sh
-$ docker-compose exec app sh -c 'bundle exec rspec'
+$ docker compose exec app sh -c 'bundle exec rspec'
 ```
 
-
 ## License
 The gem is available as open source under the terms of the [Apache License](https://github.com/learningtapestry/lcms-engine/blob/master/LICENSE).

data/app/assets/config/lcms_engine_manifest.js

@@ -1,8 +1,10 @@
 // JS and CSS bundles
 
-//= link lcms/engine/admin/application.js
+//= link lcms/engine/lcms_engine_application.js
+//= link lcms/engine/admin/lcms_engine_application.js
 
-//= link lcms/engine/admin.scss
+//= link lcms/engine/lcms_engine_application.css
+//= link lcms/engine/lcms_engine_admin.css
 
 // Images and fonts so that views can link to them
 //

data/app/assets/javascripts/lcms/engine/admin/{application.js → lcms_engine_application.js}

@@ -2,10 +2,8 @@
 //= require jquery2
 //= require jquery_ujs
 //= require jquery_nested_form
-//= require ckeditor/init
 //= require foundation
 //= require html.sortable.min
-//= require jquery.tagsinput
 //= require js-routes
 //= require 'selectize.min'
 //= require '../initializers/foundation'
@@ -13,6 +11,6 @@
 document.addEventListener('turbolinks:load', function () {
   $('.selectize').selectize({
     allowEmptyOption: true,
-    plugins: ['remove_button']
+    plugins: ['remove_button'],
   });
 });

data/app/assets/javascripts/lcms/engine/initializers/foundation.js

@@ -2,4 +2,4 @@ document.addEventListener('turbolinks:load', function () {
   $(function () {
     $(document).foundation();
   });
-})
+});

data/app/assets/stylesheets/lcms/engine/admin/collections.scss

@@ -1,3 +1,4 @@
+// stylelint-disable max-nesting-depth, selector-max-compound-selectors, scss/selector-no-redundant-nesting-selector
 .collection-tree {
   label {
     background: map-get($ub-ld-colorcodes, material-thumbnail-border);
@@ -22,7 +23,7 @@
 
   &:checked {
     & ~ label {
-      &::before { // sass-lint:disable-line nesting-depth
+      &::before {
         content: '▾';
       }
     }

data/app/assets/stylesheets/lcms/engine/admin/components.scss

@@ -1,38 +1,70 @@
-// sass-lint:disable *
+// stylelint-disable max-nesting-depth, selector-no-qualifying-type, selector-max-compound-selectors, scss/at-extend-no-missing-placeholder, selector-max-id
 .o-admin-components-table {
   width: 100%;
 
   .o-admin-components-table--header {
     border-bottom: solid 1px #5a5a5a;
-    div { padding: 1em; text-align: center; }
     font-weight: bold;
+
+    div {
+      padding: 1em;
+      text-align: center;
+    }
+  }
+
+  .o-admin-components-table--info {
+    display: inline-block;
+    vertical-align: top;
+  }
+
+  .o-admin-components-table--location {
+    @extend .o-admin-components-table--info;
+    width: 15%;
+  }
+
+  .o-admin-components-table--component-type {
+    @extend .o-admin-components-table--info;
+    width: 15%;
+  }
+
+  .o-admin-components-table--origin {
+    @extend .o-admin-components-table--info;
+    width: 35%;
+  }
+
+  .o-admin-components-table--identifier {
+    @extend .o-admin-components-table--info;
+    width: 25%;
   }
-  .o-admin-components-table--info           { display: inline-block; vertical-align: top; }
-  .o-admin-components-table--location       { @extend .o-admin-components-table--info; width: 15%; }
 
-  .o-admin-components-table--component-type { @extend .o-admin-components-table--info; width: 15%; }
-  .o-admin-components-table--origin         { @extend .o-admin-components-table--info; width: 35%; }
-  .o-admin-components-table--identifier     { @extend .o-admin-components-table--info; width: 25%; }
-  .o-admin-components-table--details        { @extend .o-admin-components-table--info; width: 5%; }
+  .o-admin-components-table--details {
+    @extend .o-admin-components-table--info;
+    width: 5%;
+  }
 
   .o-admin-components-table--entry {
     margin-bottom: 1em;
     padding: 1em;
 
-    &:nth-child(odd) { background-color: $ub-whitepure; }
+    &:nth-child(odd) {
+      background-color: $ub-whitepure;
+    }
   }
 
   .o-admin-components-table--details {
     .button {
       float: right;
-      margin-bottom: -.5em;
+      margin-bottom: -0.5em;
       margin-right: -2em;
     }
   }
 
   .o-admin-components-table--name {
     margin-top: 2em;
-    b { margin-right: 1em; }
+
+    b {
+      margin-right: 1em;
+    }
   }
 }
 
@@ -47,19 +79,21 @@
     .o-admin-ctx-filters {
       padding-right: 2em;
 
-      label { // sass-lint:disable-line nesting-depth
+      label {
         display: inline-block;
         font-weight: normal;
       }
 
-      input { // sass-lint:disable-line nesting-depth
+      input {
         display: inline-block;
         margin-left: 1em;
         width: 6em;
       }
     }
 
-    input[type='submit'] { margin-left: auto; }
+    input[type='submit'] {
+      margin-left: auto;
+    }
   }
 
   .o-admin-search-term {
@@ -72,13 +106,20 @@
     box-shadow: 2px 2px 2px #aaa;
   }
 
-  #component-type-selector, #component-grades {
-    select { height: 285px; }
+  #component-type-selector,
+  #component-grades {
+    select {
+      height: 285px;
+    }
 
-    aside { font-size: .8em; }
+    aside {
+      font-size: 0.8em;
+    }
   }
 
-  label {font-weight: bold; }
+  label {
+    font-weight: bold;
+  }
 }
 
 .o-admin-component-details {
@@ -94,7 +135,7 @@
 
   .o-component-details--content {
     background-color: $ub-whitepure;
-    border-radius: .5em;
+    border-radius: 0.5em;
     margin: 2em;
     padding: 1em;
   }

data/app/assets/stylesheets/lcms/engine/admin/curriculums.scss

@@ -1,3 +1,5 @@
+// stylelint-disable max-nesting-depth, selector-class-pattern
+
 .c-admcur-results {
   .button {
     margin-bottom: 0;
@@ -7,7 +9,7 @@
 .o-curriculum-tree-editor {
   @include e(container) {
     background: $ub-whitepure;
-    border-radius: .5em;
+    border-radius: 0.5em;
     margin: 2em auto;
     min-width: 50%;
     padding: 2em;
@@ -20,7 +22,7 @@
     }
   }
   @include e(menu-info) {
-    font-size: .9em;
+    font-size: 0.9em;
     margin-top: -1em;
     text-align: center;
   }
@@ -30,21 +32,21 @@
   @include e(container) {
     aside {
       display: inline-block;
-      font-size: .9em;
+      font-size: 0.9em;
       margin-left: 1em;
     }
 
-    .resource_parent { // sass-lint:disable-line class-name-format
+    .resource_parent {
+      // sass-lint:disable-line class-name-format
       display: inline-block;
       margin-left: 1em;
-      margin-top: .5em;
+      margin-top: 0.5em;
       max-width: 85%;
       vertical-align: top;
-      strong { margin-left: .25em; }
-    }
 
-    .tagsinput {
-      display: inline-block;
+      strong {
+        margin-left: 0.25em;
+      }
     }
   }
 }
@@ -52,7 +54,7 @@
 .curriculum-picker-modal {
   &.reveal {
     background: $ub-whitepure;
-    border-radius: .5em;
+    border-radius: 0.5em;
     margin: 2em auto;
     min-width: 50%;
     padding: 2em;

data/app/assets/stylesheets/lcms/engine/admin/lessons.scss

@@ -1,5 +1,6 @@
+// stylelint-disable max-nesting-depth, selector-max-compound-selectors
 .o-admin-lessons-search {
-  border: solid 1px #ddd; // sass-lint:disable-line no-color-literals
+  border: solid 1px #ddd;
   border-radius: 5px;
   margin-bottom: 2em;
   padding: 2em 1em 1em;
@@ -8,12 +9,12 @@
     .o-admin-ctx-filters {
       padding-right: 2em;
 
-      label { // sass-lint:disable-line nesting-depth
+      label {
         display: inline-block;
         font-weight: normal;
       }
 
-      input { // sass-lint:disable-line nesting-depth
+      input {
         display: inline-block;
         margin-left: 1em;
         width: 6em;
@@ -31,8 +32,11 @@
   }
 
   .o-admin-option {
-    margin-bottom: .75em;
-    label { font-weight: normal; }
+    margin-bottom: 0.75em;
+
+    label {
+      font-weight: normal;
+    }
   }
 
   .o-admin-unit,
@@ -45,10 +49,14 @@
     box-shadow: 2px 2px 2px #aaa; // sass-lint:disable-line no-color-literals
   }
 
-  label {font-weight: bold; }
+  label {
+    font-weight: bold;
+  }
 }
 
 .lessons-table {
+  table-layout: auto;
+  width: 100%;
   @include e(btns) {
     .button {
       min-width: 80px;
@@ -64,11 +72,10 @@
   }
 
   @include e(materials) {
+    list-style: none;
     @include m(file) {
-      margin-right: .3em;
+      margin-right: 0.3em;
     }
-
-    list-style: none;
   }
 
   @include e(status) {
@@ -78,18 +85,15 @@
     }
   }
 
-  table-layout: auto;
-  width: 100%;
-
   tr {
     th {
-      &:nth-child(5), // sass-lint:disable-line nesting-depth
+      &:nth-child(5),
       &:nth-child(5) {
         max-width: 250px;
         min-width: 200px;
       }
 
-      &:nth-child(6), // sass-lint:disable-line nesting-depth
+      &:nth-child(6),
       &:nth-child(6) {
         min-width: 300px;
       }
@@ -104,6 +108,8 @@
     margin-left: 2em;
     margin-top: 1.5em;
 
-    input { margin-right: .5em; }
+    input {
+      margin-right: 0.5em;
+    }
   }
 }

data/app/assets/stylesheets/lcms/engine/admin/materials.scss

@@ -5,6 +5,9 @@
   }
 
   @include e(result) {
+    border-radius: 0.5rem;
+    margin-bottom: 0.5rem;
+    padding: 0.5rem 1rem;
     @include m(ok) {
       background-color: map-get($ub-green, sixty);
     }
@@ -21,11 +24,9 @@
       background-color: map-get($ub-yellow, sixty);
     }
 
-    border-radius: .5rem;
-    margin-bottom: .5rem;
-    padding: .5rem 1rem;
-
-    p { margin-bottom: 0; }
+    p {
+      margin-bottom: 0;
+    }
   }
 
   @include e(link) {
@@ -34,12 +35,12 @@
   }
 
   @include e(spinner) {
-    background: none !important;
+    background: none !important; // stylelint-disable-line declaration-no-important
   }
 
   @include e(summary) {
     @include m(aside) {
-      font-size: .9em;
+      font-size: 0.9em;
       text-align: center;
     }
 
@@ -51,7 +52,7 @@
   }
 
   @include e(resource) {
-    border-radius: .5em;
+    border-radius: 0.5em;
   }
 }
 
@@ -66,32 +67,39 @@
   }
 
   @include e(btns) {
-    .button { min-width: 80px; }
+    .button {
+      min-width: 80px;
+    }
 
     form {
       &:last-child {
-        .button { margin-bottom: 0; }
+        .button {
+          margin-bottom: 0;
+        }
       }
     }
   }
 
   @include e(lessons) {
+    list-style: none;
     @include m(file) {
-      margin-right: .3em;
+      margin-right: 0.3em;
     }
-
-    list-style: none;
   }
 }
 
 .c-multi-selected--select-all {
   display: inline-block;
   font-weight: bold;
-  margin-left: .5em;
+  margin-left: 0.5em;
   margin-top: 1.5em;
-  input { margin-right: .5em; }
+
+  input {
+    margin-right: 0.5em;
+  }
 }
 
-.o-adm-list .table .c-selected-ids { // sass-lint:disable-line force-element-nesting
-  margin-bottom: .2em;
+.o-adm-list .table .c-selected-ids {
+  // sass-lint:disable-line force-element-nesting
+  margin-bottom: 0.2em;
 }

data/app/assets/stylesheets/lcms/engine/admin/resources.scss

@@ -12,7 +12,7 @@
 }
 
 .resource-search-select {
-  width: 100% !important; // sass-lint:disable-line no-important
+  width: 100% !important; // stylelint-disable-line declaration-no-important
 }
 
 .resource-search-url-slug,
@@ -25,7 +25,7 @@
   flex-basis: 0;
   flex-grow: 1;
   padding-right: 1%;
-  vertical-align: top !important; // sass-lint:disable-line no-important
+  vertical-align: top !important; // stylelint-disable-line declaration-no-important
 
   &:last-child {
     padding: 0;
@@ -33,6 +33,9 @@
 }
 
 .o-adm-download {
+  background-color: $ub-white;
+  margin: 10px 0;
+  padding: 10px;
   @include e(settings) {
     @include flex;
 
@@ -40,14 +43,12 @@
       margin-left: 10px;
     }
   }
-
-  background-color: $ub-white;
-  margin: 10px 0;
-  padding: 10px;
 }
 
 .resource-btns-col {
-  .button { width: 80px; }
+  .button {
+    width: 80px;
+  }
 }
 
 .c-admin > .o-page {

data/app/assets/stylesheets/lcms/engine/admin/standards.scss

@@ -1,10 +1,13 @@
+// stylelint-disable max-nesting-depth
 .o-standard-form {
   .input {
     margin-bottom: 1em;
   }
 
   .o-admin-standard-readonly {
-    label { min-width: 5em; }
+    label {
+      min-width: 5em;
+    }
   }
 
   label {

data/app/assets/stylesheets/lcms/engine/admin/users.scss

@@ -2,7 +2,7 @@
   .o-admin-search-term {
     @include placeholder(#3a3a3a);
 
-    margin-right: .5em;
+    margin-right: 0.5em;
     width: 45%;
   }
 }

data/app/assets/stylesheets/lcms/engine/base/_colors.scss

@@ -39,7 +39,7 @@ $ub-txt-colors: (
   h1: $ub-heading-txt,
   h2: #333,
   h3: $ub-heading-txt,
-  h4: #898989
+  h4: #898989,
 );
 
 $ub-mignight: (
@@ -50,7 +50,7 @@ $ub-mignight: (
   eighty: #6d6590,
   sixty: #928bac,
   forty: #b6b2c7,
-  twenty: #dbd8e3
+  twenty: #dbd8e3,
 );
 
 $ub-yellow: (
@@ -58,7 +58,7 @@ $ub-yellow: (
   eighty: #fc3,
   sixty: #ffd966,
   forty: #ffe599,
-  twenty: #fff2cc
+  twenty: #fff2cc,
 );
 
 $ub-green: (
@@ -66,7 +66,7 @@ $ub-green: (
   eighty: #a4cc2e,
   sixty: #c1dc6f,
   forty: #d5e79f,
-  twenty: #eaf3cf
+  twenty: #eaf3cf,
 );
 
 $ub-buttons: (
@@ -80,7 +80,7 @@ $ub-buttons: (
   math: #00a699,
   lead: #a269bf,
   print: #423872,
-  show-more: #9a9a9a
+  show-more: #9a9a9a,
 );
 
 $ub-leadership: (
@@ -91,7 +91,7 @@ $ub-leadership: (
   subscribe-label: #ca94e0,
   subscribe-input: #b57ed1,
   arrows1: #edecf1,
-  arrows2: #e1d9e8
+  arrows2: #e1d9e8,
 );
 
 $ub-colorcodes: (
@@ -170,12 +170,11 @@ $ub-colorcodes: (
   facet: #6e6e6e,
   light: $ub-white,
   error: #f00,
-  violet-light: #ecebf0,
+  violet-light: #ecebf0
 );
 
 $ub-selection: (
-  disabled-parent-bg: rgba(0, 0, 0, .2),
-
+  disabled-parent-bg: rgba(0, 0, 0, 0.2),
   ela-disabled-switch-bg: #b75638,
   ela-disabled-fg: #f8a58c,
   ela-enabled-bg: #f45b33,
@@ -186,6 +185,5 @@ $ub-selection: (
   math-enabled-bg: #18a497,
   math-enabled-fg: #fff,
   math-enabled-switch-bg: #b4e4e0,
-
   modal-title-fg: #4e4b7a,
 );