Removed the custom course resource controller (#965)

Co-authored-by: Adrian Marin <[email protected]>

Author: iainbeeston

.github/workflows/test.yml

@@ -90,6 +90,7 @@ jobs:
         NODE_ENV: production
       run: |
         yarn build:js
+        yarn build:custom-js
         yarn build:css
 
     - name: Run tests

CONTRIBUTING.MD

@@ -94,6 +94,10 @@ POSTGRES_PASSWORD=
 
 We use [appraisal](https://github.com/thoughtbot/appraisal) to run tests against multiple versions of rails. When the gemfile gets updated you must also run `bundle exec appraisal install` to update the versioned ones and commit them to the repo.
 
+# Custom JS
+
+In order to be able to test the custom Stimulus integration we need to have some kind of JS content injected in the dummy app. We also need not to have that content present in every Avo installation. That's why we ejected the `_head.html.erb` partial that loads the `avo_custom.js` file from the engine's `build` directory. The build directory is not commited to git so we're all good on that. In order to have that file built and watche we added a `cjs` (short for `custom-js`) process in the `Procfile.dev` (which is used only in development).
+
 # Misc
 
 ## Annotate models

Procfile.dev

@@ -1,3 +1,4 @@
 web: bin/rails server -p 3030
 js: yarn build:js --watch
 css: yarn build:css --watch
+cjs: yarn build:custom-js --watch

app/javascript/js/controllers.js

@@ -7,7 +7,6 @@ import BelongsToFieldController from './controllers/fields/belongs_to_field_cont
 import BooleanFilterController from './controllers/boolean_filter_controller'
 import CodeFieldController from './controllers/fields/code_field_controller'
 import CopyToClipboardController from './controllers/copy_to_clipboard_controller'
-import CourseResourceController from './controllers/custom/course_resource_controller'
 import DashboardCardController from './controllers/dashboard_card_controller'
 import DateFieldController from './controllers/fields/date_field_controller'
 import FilterController from './controllers/filter_controller'
@@ -70,4 +69,3 @@ application.register('simple-mde', SimpleMdeController)
 application.register('trix-field', TrixFieldController)
 
 // Custom controllers
-application.register('course-resource', CourseResourceController)

bin/test

@@ -12,6 +12,7 @@ fi;
 # Run system tests
 if [[ -z "$1" ]] || [[ "$1" == "system" ]]; then
   yarn build:js
+  yarn build:custom-js
   yarn build:css
   bundle exec rspec ./spec --tag type:system
 fi;

package.json

@@ -9,6 +9,7 @@
     "js:visualize": "yarn prod:build:js -- --metafile=js_bundle_metadata.json && esbuild-visualizer --metadata=js_bundle_metadata.json --filename=js_bundle_stats.html",
     "build": "yarn build:js && yarn build:css",
     "build:js": "esbuild app/javascript/*.js --bundle --sourcemap --minify --outdir=app/assets/builds",
+    "build:custom-js": "esbuild spec/dummy/app/javascript/*.js --bundle --sourcemap --minify --outdir=app/assets/builds",
     "build:css": "tailwindcss -i ./app/assets/stylesheets/avo.css -o ./app/assets/builds/avo.css --postcss",
     "prod:build": "yarn prod:build:js && yarn prod:build:css",
     "prod:build:js": "esbuild app/javascript/*.js --bundle --sourcemap --minify --outdir=public/avo-assets",

spec/dummy/app/javascript/avo_custom.js

@@ -0,0 +1,9 @@
+import { Application } from '@hotwired/stimulus'
+import CourseResourceController from './avo_custom/course_resource_controller'
+
+const application = Application.start()
+console.log('mer')
+
+// Configure Stimulus development experience
+application.debug = window?.localStorage.getItem('avo.debug')
+application.register('course-resource', CourseResourceController)

app/javascript/js/controllers/custom/course_resource_controller.js renamed to spec/dummy/app/javascript/avo_custom/course_resource_controller.js

@@ -9,7 +9,7 @@ export default class extends Controller {
     view: String,
   }
 
-  // Te fields initial value
+  // The fields initial value
   static initialValue
 
   get placeholder() {

spec/dummy/app/views/avo/partials/_head.html.erb

@@ -0,0 +1 @@
+<%= javascript_include_tag "avo_custom", "data-turbo-track": "reload", defer: true %>