Development

.browserslistrc

@@ -0,0 +1,4 @@
+defaults
+> .25%
+Firefox >= 52
+IE >= 10

.editorconfig

@@ -0,0 +1,17 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,scss,rb,erb}]
+charset = utf-8
+indent_style = space
+indent_size = 2

.env.mysql2

@@ -0,0 +1,48 @@
+# DMPRoadmap dotenv file
+
+# Rails log level
+RAILS_LOG_LEVEL=debug
+# Whether or not Rails should log to STDOUT. If false it will log to `./logs/[env].log`
+RAILS_LOG_TO_STDOUT=true
+# Whether or not Rails will be serving your static assets 
+RAILS_SERVE_STATIC_FILES=false
+# Maximum number of Puma threads
+RAILS_MAX_THREADS=5
+# Maximum number of Puma workers
+WEB_CONCURRENCY=2
+# The port puma will use to host the Rails app
+PORT=3000
+
+# Rails 6.1+ has a white-list of valid domains. You must set this for your production env!
+DMPROADMAP_HOST=localhost
+
+# The location of the wkhtmltopdf app. Once bundler has installed it, you can find it with
+# `which wkhtmltopdf` on linux/osx systems.
+WICKED_PDF_PATH=/usr/local/bin/wkhtmltopdf
+
+# Database settings.
+DB_ADAPTER=mysql2
+DB_HOST=localhost
+DB_PORT=3306
+DB_POOL_SIZE=16
+DB_NAME=roadmap
+
+# Whether or not the Dragonfly gem should use AWS S3 to store logos. If 'false' the logos will 
+# be stored on the local disk. If true, you must provide the `AWS_` prefixed values.
+DRAGONFLY_AWS=false
+AWS_REGION=
+AWS_BUCKET_NAME=
+
+# If you have a Rollbar account and want to redcord errors there, add your token here
+ROLLBAR_ACCESS_TOKEN=
+ROLLBAR_ENV=
+
+# Translation IO variables. The Domain can be either `app` or `client` and is typically defined
+# when running `bin/rails translations:sync DOMAIN=app`. `client` will use any of your 
+# customized content in ./app/views/branded and `app` is for the core roadmap translations.
+# Include your Translation.io API key for the appropriate domains:
+#    app => TRANSLATION_API_ROADMAP
+#    client => TRANSLATION_API_CLIENT
+# DOMAIN=app
+# TRANSLATION_API_ROADMAP=
+# TRANSLATION_API_CLIENT=

.env.postgresql

@@ -0,0 +1,48 @@
+# DMPRoadmap dotenv file
+
+# Rails log level
+RAILS_LOG_LEVEL=debug
+# Whether or not Rails should log to STDOUT. If false it will log to `./logs/[env].log`
+RAILS_LOG_TO_STDOUT=true
+# Whether or not Rails will be serving your static assets 
+RAILS_SERVE_STATIC_FILES=false
+# Maximum number of Puma threads
+RAILS_MAX_THREADS=5
+# Maximum number of Puma workers
+WEB_CONCURRENCY=2
+# The port puma will use to host the Rails app
+PORT=3000
+
+# Rails 6.1+ has a white-list of valid domains. You must set this for your production env!
+DMPROADMAP_HOST=localhost
+
+# The location of the wkhtmltopdf app. Once bundler has installed it, you can find it with
+# `which wkhtmltopdf` on linux/osx systems.
+WICKED_PDF_PATH=/usr/local/bin/wkhtmltopdf
+
+# Database settings.
+DB_ADAPTER=postgresql
+DB_HOST=localhost
+DB_PORT=5432
+DB_POOL_SIZE=16
+DB_NAME=roadmap
+
+# Whether or not the Dragonfly gem should use AWS S3 to store logos. If 'false' the logos will 
+# be stored on the local disk. If true, you must provide the `AWS_` prefixed values.
+DRAGONFLY_AWS=false
+AWS_REGION=
+AWS_BUCKET_NAME=
+
+# If you have a Rollbar account and want to redcord errors there, add your token here
+ROLLBAR_ACCESS_TOKEN=
+ROLLBAR_ENV=
+
+# Translation IO variables. The Domain can be either `app` or `client` and is typically defined
+# when running `bin/rails translations:sync DOMAIN=app`. `client` will use any of your 
+# customized content in ./app/views/branded and `app` is for the core roadmap translations.
+# Include your Translation.io API key for the appropriate domains:
+#    app => TRANSLATION_API_ROADMAP
+#    client => TRANSLATION_API_CLIENT
+DOMAIN=app
+TRANSLATION_API_ROADMAP=
+TRANSLATION_API_CLIENT=

.eslintrc.json

@@ -16,6 +16,7 @@
     "spyOnEvent": true
   },
   "rules": {
+    "import/no-unresolved": "off",
     "indent": [
       "error",
       2
@@ -39,4 +40,4 @@
       "enforceForRenamedProperties": false
     }]
   }
-}
+}

ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE.md

@@ -1,5 +1,7 @@
 Please complete the following fields as applicable:
 
+**What version of the DMPRoadmap code are you running? (e.g. v2.2.0)**
+
 **Expected behaviour:**
 
 **Actual behaviour:**

.github/workflows/brakeman.yml

@@ -8,14 +8,16 @@ on:
 jobs:
   brakeman:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
 
     # Will run Brakeman checks on dependencies
-    #   https://github.com/marketplace/actions/brakeman-linter
+    #   https://github.com/marketplace/actions/brakeman-action
     - name: Brakeman
-      uses: devmasx/brakeman-linter-action@v1.0.0
+      uses: artplan1/brakeman-action@v1.2.1
+      with:
+        flags: "--color"
       env:
-        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/danger.yml

@@ -0,0 +1,32 @@
+name: Danger
+
+on: [push, pull_request]
+
+jobs:
+  danger:
+    runs-on: ubuntu-24.04
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: 'Determine Ruby and Bundler Versions from Gemfile.lock'
+      run: |
+        echo "RUBY_VERSION=`cat ./Gemfile.lock | grep -A 1 'RUBY VERSION' | grep 'ruby' | grep -oE '[0-9]+\.[0-9]+\.[0-9]+'`" >> $GITHUB_ENV
+        echo "BUNDLER_VERSION=`cat ./Gemfile.lock | grep -A 1 'BUNDLED WITH' | grep -oE '[0-9]+\.[0-9]+\.[0-9]+'`" >> $GITHUB_ENV
+
+    # Install Ruby - using the version found in the Gemfile.lock
+    - name: 'Install Ruby'
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ env.RUBY_VERSION }}
+
+    - name: 'Bundle Install'
+      run: |
+        gem install bundler -v ${{ env.BUNDLER_VERSION }}
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3 --without pgsql rollbar aws
+
+    - name: 'Run Danger'
+      env:
+        DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: bundle exec danger

.github/workflows/eslint.yml

@@ -1,18 +1,25 @@
 name: ESLint
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
   eslint:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
-    - uses: actions/checkout@v1
+    # Checkout the repo
+    - uses: actions/checkout@v3
 
-    # Will run ES Lint checks on javascript files
-    #   https://github.com/marketplace/actions/run-eslint
-    - name: 'ES Lint checks'
-      uses: stefanoeb/eslint-action@1.0.0
+    # Install Node
+    - uses: actions/setup-node@v3
       with:
-        args: './app/javascript/**/*.js'
+        cache: 'yarn'
+        node-version: 18
+
+    # Run yarn install for JS dependencies
+    - name: 'Yarn Install'
+      run: yarn install
+
+    - name: 'Run ESLint'
+      run: yarn run eslint app/javascript/**/*.js --ext .js

.github/workflows/mysql.yml

@@ -1,100 +1,76 @@
-name: Run Tests (mySQL)
+name: Tests - MySQL
 
 on: [pull_request]
 
 jobs:
   mysql:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
+    # Define environment variables for MySQL and Rails
     env:
       DB_ADAPTER: mysql2
       MYSQL_PWD: root
       RAILS_ENV: test
-      WICKED_PDF_PATH: vendor/bundle/bin/wkhtmltopdf
 
     steps:
     # Checkout the repo
-    - uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
-
-    # Install the necessary MySQL dev packages
-    - name: 'Install Mysql Packages'
-      run: |
-        sudo apt-get update
-        sudo apt-get install -y mysql-client libmysqlclient-dev
+    - uses: actions/checkout@v3
 
-    # Extract the Ruby version from the Gemfile.lock
-    - name: 'Determine Ruby Version'
-      run: echo ::set-env name=RUBY_VERSION::$(echo `cat ./Gemfile.lock | grep -A 1 'RUBY VERSION' | grep 'ruby' | grep -oE '[0-9]\.[0-9]'`)
-
-    # Install Ruby - using the version found in the Gemfile.lock
-    - name: 'Install Ruby'
-      uses: actions/setup-ruby@v1
+    # Install Ruby and run bundler
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+        bundler-cache: true
+
+    # Install Node
+    - uses: actions/setup-node@v3
       with:
-        ruby-version: ${{ env.RUBY_VERSION }}
+        node-version: 18
+        cache: 'yarn'
 
     # Copy all of the example configs over
-    - name: 'Setup Default Configuration'
+    - name: 'Setup the application'
       run: |
-        # Make copies of all the example config files
-        cp config/branding.yml.sample config/branding.yml
         cp config/database.yml.sample config/database.yml
-        cp config/secrets.yml.sample config/secrets.yml
         cp config/initializers/contact_us.rb.example config/initializers/contact_us.rb
-        cp config/initializers/devise.rb.example config/initializers/devise.rb
-        cp config/initializers/recaptcha.rb.example config/initializers/recaptcha.rb
         cp config/initializers/wicked_pdf.rb.example config/initializers/wicked_pdf.rb
+        cp .env.mysql2 .env
 
-    # Try to retrieve the gems from the cache
-    - name: 'Cache Gems'
-      uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-gem-
-
-    # Install bundler and run bundle install
-    - name: 'Bundle Install'
-      run: |
-        gem install bundler -v 1.17.2
-        bundle config path vendor/bundle
-        bundle install --jobs 4 --retry 3 --without pgsql rollbar aws
+    # Stub out the Rails credentials file so that we can start the Rails app
+    - name: 'Setup Credentials'
+      run: EDITOR="sh -c 'echo \"$(cat config/credentials.yml.mysql2)\" > \$1' --" bundle exec rails credentials:edit
 
-    # Try to retrieve the yarn JS dependencies from the cache
-    - name: 'Cache Yarn Packages'
-      uses: actions/cache@v1
-      with:
-        path: node_modules/
-        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-build-${{ env.cache-name }}-
-          ${{ runner.os }}-build-
-          ${{ runner.os }}-yarn-
-          ${{ runner.os }}-
+    # Set the path to the wkhtmltopdf executable
+    - name: 'Determine wkhtmltopdf location'
+      run: echo "WICKED_PDF_PATH=`bundle exec which wkhtmltopdf`" >> $GITHUB_ENV
 
-    # Install the JS dependencies
+    # Run yarn install for JS dependencies
     - name: 'Yarn Install'
-      run: |
-        yarn install
+      run: yarn install
 
-    # Setup the database
-    - name: 'Setup Test DB'
-      run: bundle exec rake db:setup RAILS_ENV=test
+    # Start the DB server and initialize the DB
+    - name: 'Start MySQL'
+      run: sudo systemctl start mysql
 
-    # Compile the assets
-    - name: 'Compile Assets'
+    - name: 'Build out the test database'
       run: |
-        bundle exec rake webpacker:compile RAILS_ENV=test
-        bundle exec rake assets:precompile RAILS_ENV=test
+        DISABLE_SPRING=1 bundle exec rails db:create RAILS_ENV=test
+        DISABLE_SPRING=1 bundle exec rails db:schema:load RAILS_ENV=test
+
+    - name: 'Run any pending database migrations'
+      run: bin/rails db:migrate RAILS_ENV=test
+
+    # Prebuild the CSS, JS and image assets
+    - name: 'Precompile all of the Assets'
+      run: bundle exec rails assets:precompile
 
-    # Run the JS tests
-    - name: 'Run Karma Tests'
+    # Run  the unit and functional tests
+    - name: 'Run Rspec Unit and Functional Tests'
       run: |
-        yarn add karma
-        yarn run test
+        bundle exec rspec spec/models/ spec/policies/ spec/services/ spec/helpers/
+        bundle exec rspec spec/controllers/ spec/presenters/ spec/requests/ spec/views
+        bundle exec rspec spec/mixins/
 
-    # Run the Rspec tests
-    - name: 'Run Rspec Tests'
-      run: bundle exec rspec spec/
+    # Run the time consuming integration tests (using Chrome headless browser)
+    - name: 'Run Rspec Integration Tests'
+      run: bundle exec rspec spec/features/