Merge upstream releases v4.0.0, v4.0.1, and v4.0.2

.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=

.github/workflows/eslint.yml

@@ -12,7 +12,11 @@ jobs:
     - uses: actions/setup-node@v3
       with:
         node-version: 16
-    - name: Install modules
-      run: yarn
-    - name: Run ESLint
-      run: yarn run eslint ./app/javascript/**/*.js
+        cache: 'yarn'
+
+    # 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

@@ -6,6 +6,7 @@ jobs:
   mysql:
     runs-on: ubuntu-20.04
 
+    # Define environment variables for MySQL and Rails
     env:
       DB_ADAPTER: mysql2
       MYSQL_PWD: root
@@ -14,102 +15,62 @@ jobs:
     steps:
     # Checkout the repo
     - uses: actions/checkout@v3
-      with:
-        fetch-depth: 1
-    - uses: actions/setup-node@v3
-      with:
-        node-version: 16
-
-    - name: 'Install MySQL Packages'
-      run: |
-        sudo apt-get update
-        sudo apt-get install -y mysql-client-core-8.0 
-        sudo apt-get install -y mysql-server
-        sudo apt-get install -y libmysqlclient-dev 
 
-    - 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]'`" >> $GITHUB_ENV
-        echo "BUNDLER_VERSION=`cat ./Gemfile.lock | grep -A 1 'BUNDLED WITH' | grep -oE '[0-9]\.[0-9]'`" >> $GITHUB_ENV
+    # Install Ruby and run bundler
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.6
+        bundler-cache: true
 
-    - name: 'Install Ruby'
-      uses: ruby/setup-ruby@v1
+    # Install Node
+    - uses: actions/setup-node@v2
       with:
-        ruby-version: ${{ env.RUBY_VERSION }}
+        node-version: 16
+        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/database.yml.sample config/database.yml
         cp config/initializers/contact_us.rb.example config/initializers/contact_us.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/[email protected]
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-gem-
-
-    - 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
-
+    # Stub out the Rails credentials file so that we can start the Rails app
     - name: 'Setup Credentials'
-      run: |
-        # generate a default credential file and key
-        EDITOR='echo "$(cat config/credentials.yml.example)" >' bundle exec rails credentials:edit
-
-    # # Try to retrieve the yarn JS dependencies from the cache
-    - name: 'Cache Yarn Packages'
-      uses: actions/[email protected]
-      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 }}-
+      run: EDITOR='echo "$(cat config/credentials.yml.mysql2)" >' bundle exec rails credentials:edit
 
+    # Set the path to the wkhtmltopdf executable
     - name: 'Determine wkhtmltopdf location'
       run: echo "WICKED_PDF_PATH=`bundle exec which wkhtmltopdf`" >> $GITHUB_ENV
 
+    # Run yarn install for JS dependencies
     - name: 'Yarn Install'
-      run: |
-        yarn install
+      run: yarn install
 
+    # Start the DB server and initialize the DB
     - name: 'Start MySQL'
-      run: |
-        sudo systemctl unmask mysql
-        sudo systemctl start mysql
+      run: sudo systemctl start mysql
 
-    - name: 'Setup Test DB'
-      run: bin/rails db:setup RAILS_ENV=test
+    - name: 'Build out the test database'
+      run: |
+        bundle exec rails db:create RAILS_ENV=test
+        bundle exec rails db:schema:load RAILS_ENV=test
 
-    - name: 'Migrate DB'
+    - name: 'Run any pending database migrations'
       run: bin/rails db:migrate RAILS_ENV=test
 
-    - name: 'Compile Assets'
-      run: |
-        bin/rails webpacker:compile
-        bin/rails assets:precompile
-
-    # Note V3.1.0 DMPTool commented out Karma tests and will move this part to rspec
-    - name: 'Run Karma Tests'
-      run: yarn test
+    # Prebuild the CSS, JS and image assets
+    - name: 'Precompile all of the Assets'
+      run: bundle exec rails assets:precompile
 
+    # Run  the unit and functional tests
     - name: 'Run Rspec Unit and Functional Tests'
       run: |
-        bin/bundle exec rspec spec/models/ spec/policies/ spec/services/ spec/helpers/
-        bin/bundle exec rspec spec/controllers/ spec/presenters/ spec/requests/ spec/views
-        bin/bundle exec rspec spec/mixins/
+        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/
 
-    # Only run Integration tests if the PR or Push is to master or development branches
+    # Run the time consuming integration tests (using Chrome headless browser)
     - name: 'Run Rspec Integration Tests'
-      run: bin/bundle exec rspec spec/features/
+      run: bundle exec rspec spec/features/

.github/workflows/postgres.yml

@@ -31,8 +31,11 @@ jobs:
     # Checkout the repo
     - uses: actions/checkout@v3
       with:
-        fetch-depth: 1
-    - uses: actions/setup-node@v3
+        ruby-version: 2.7.6
+        bundler-cache: true
+
+    # Install Node
+    - uses: actions/setup-node@v2
       with:
         node-version: 16
 
@@ -59,6 +62,7 @@ jobs:
         cp config/database.yml.sample config/database.yml
         cp config/initializers/contact_us.rb.example config/initializers/contact_us.rb
         cp config/initializers/wicked_pdf.rb.example config/initializers/wicked_pdf.rb
+        cp .env.postgresql .env
 
     # Try to retrieve the gems from the cache
     - name: 'Cache Gems'
@@ -78,7 +82,7 @@ jobs:
     - name: 'Setup Credentials'
       run: |
         # generate a default credential file and key
-        EDITOR='echo "$(cat config/credentials.yml.example)" >' bundle exec rails credentials:edit
+        EDITOR='echo "$(cat config/credentials.yml.postgresql)" >' bundle exec rails credentials:edit
 
     # Try to retrieve the yarn JS dependencies from the cache
     - name: 'Cache Yarn Packages'
@@ -100,25 +104,19 @@ jobs:
         yarn install
 
     - name: 'Setup Test DB'
-      run: bin/rails db:setup RAILS_ENV=test
-
-    - name: 'Migrate DB'
-      run: bin/rails db:migrate RAILS_ENV=test
-
-    - name: 'Compile Assets'
       run: |
-        bin/rails webpacker:compile
-        bin/rails assets:precompile
+        bundle exec rails db:setup RAILS_ENV=test
+        bundle exec rails db:migrate RAILS_ENV=test
 
-    - name: 'Run Karma Tests'
-      run: yarn test
+    - name: 'Compile Assets'
+      run: bundle exec rails assets:precompile
 
     - name: 'Run Rspec Unit and Functional Tests'
       run: |
-        bin/rspec spec/models/ spec/policies/ spec/services/ spec/helpers/
-        bin/rspec spec/controllers/ spec/presenters/ spec/requests/ spec/views
-        bin/rspec spec/mixins/
+        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/
 
     # Integration Tests are only run if PR or Push is to master or development branches
     - name: 'Run Integration Tests'
-      run: bin/rspec spec/features/
+      run: bundle exec rspec spec/features/

.github/workflows/rubocop.yml

@@ -18,13 +18,8 @@ jobs:
     - 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
+        ruby-version: 2.7.6
+        bundler-cache: true
 
     - name: 'Run Rubocop'
       run: bin/rubocop

.github/workflows/ruby.yml

@@ -74,7 +74,7 @@ jobs:
     - name: 'Setup Credentials'
       run: |
         # generate a default credential file and key
-        EDITOR='echo "$(cat config/credentials.yml.example)" >' bundle exec rails credentials:edit
+        EDITOR='echo "$(cat config/credentials.yml.mysql2)" >' bundle exec rails credentials:edit
 
     # Try to retrieve the yarn JS dependencies from the cache
     - name: 'Cache Yarn Packages'

.gitignore

@@ -115,4 +115,4 @@ yarn-debug.log*
 .yarn-integrity
 
 # Ignore staging files in db folder since they can be auto-generated
-/db/seeds/staging
+/db/seeds/staging

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [Unreleased]
+
+### Added
+
+ - Merged Upstream Release [v4.0.0](https://github.com/DMPRoadmap/roadmap/releases/tag/v4.0.0)
+
+ - Merged Upstream Release [v4.0.1](https://github.com/DMPRoadmap/roadmap/releases/tag/v4.0.1)
+
+ - Merged Upstream Release [v4.0.2](https://github.com/DMPRoadmap/roadmap/releases/tag/v4.0.2)
+
 ## [3.3.1+portage-3.2.1] - 2023-10-19
 
 ### Fixed