rails_template_18f 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcc4a62d027d473b29b87425d2418522373457ae750a3bfa1e7d5834f3e3d39f
-  data.tar.gz: 88d86b8508c80de0b0593ca4852a789442e4ac5e84324c074e866bc85d50de37
+  metadata.gz: 71f972115a1f66ddfefa4341186434fe24a4e78b201ad192786a4c5d34bebb8c
+  data.tar.gz: dcbf65cd0f011f12aa918975b426e23002d07c54c14d4251d5e8102bc59e74a3
 SHA512:
-  metadata.gz: b8145b8f45a774296b8ea2add76694855f5c618e5900e2dcb4528666c6a855913d5a8eace278d1f208bce0ff1fa23818544bf1a931b11e88856451684fa6a465
-  data.tar.gz: ef237cfc40495ef9bece29583ad4007c08631e5cfd092e9415914442ffa588302a980f4fef1584d520827df970a791d1633a43cbe90e8d5eb72c036be7e84a0c
+  metadata.gz: '09de09463925281bdb7731686bebfe8eb4441a208e488597abfc910510dead294a0380629ed43af55956fb798fa2aeffeaddc25c0b6e2dd6e584db6791b211b0'
+  data.tar.gz: d12d2667e1aa2bf8e49097ccc9b3f76656a5a71b5ca829b1e02361d33df62af298c27dfe6de8da268f6ead509a54725c1df5852813196bd113f1daedf9f70de4

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.8.2] - 2024-06-06
+
+- Replace deprecated github action for cloud.gov deploys with cg-supported one
+- Update terraform modules use for the actual module api - and specify the module version in use
+
+## [0.8.1] - 2024-06-04
+
+- fix error when compliance-template fork question is left blank
+- fix deprecated and then removed use of `npm set-scripts`
+- add a doc/compliance/TODO.md file with tasks that can sometimes be useful on the ATO journey.
+- generalize create_space_deployer.sh to create_service_account.sh to make it easier to create SpaceAuditor users
+- move support scripts set_space_egress.sh, create_service_account.sh, and destroy_service_account.sh out of terraform generator
+
 ## [0.8.0] - 2022-07-14
 
 - use rails-erd gem for auto-updating logical data models

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_template_18f (0.8.0)
+    rails_template_18f (0.8.2)
       activesupport (~> 7.0.0)
       colorize (~> 0.8)
       railties (~> 7.0.0)
@@ -10,25 +10,25 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.0.3)
-      actionview (= 7.0.3)
-      activesupport (= 7.0.3)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (7.0.8.4)
+      actionview (= 7.0.8.4)
+      activesupport (= 7.0.8.4)
+      rack (~> 2.0, >= 2.2.4)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.3)
-      activesupport (= 7.0.3)
+    actionview (7.0.8.4)
+      activesupport (= 7.0.8.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (7.0.3)
+    activesupport (7.0.8.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    ammeter (1.1.5)
+    ammeter (1.1.7)
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec-rails (>= 2.2)
@@ -36,90 +36,112 @@ GEM
     builder (3.2.4)
     byebug (11.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.3.1)
     crass (1.0.6)
-    diff-lcs (1.5.0)
-    erubi (1.10.0)
-    i18n (1.10.0)
+    diff-lcs (1.5.1)
+    erubi (1.12.0)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.18.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.22.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (1.0.0)
-    minitest (5.16.2)
-    nokogiri (1.13.6-x86_64-darwin)
+      nokogiri (>= 1.12.0)
+    method_source (1.1.0)
+    minitest (5.23.1)
+    nokogiri (1.16.5-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.6-x86_64-linux)
+    nokogiri (1.16.5-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    nokogiri (1.16.5-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
-    racc (1.6.0)
-    rack (2.2.4)
-    rack-test (2.0.2)
+      racc
+    racc (1.8.0)
+    rack (2.2.9)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    railties (7.0.3)
-      actionpack (= 7.0.3)
-      activesupport (= 7.0.3)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.8.4)
+      actionpack (= 7.0.8.4)
+      activesupport (= 7.0.8.4)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-rails (5.1.2)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
-      railties (>= 5.2)
-      rspec-core (~> 3.10)
-      rspec-expectations (~> 3.10)
-      rspec-mocks (~> 3.10)
-      rspec-support (~> 3.10)
-    rspec-support (3.11.0)
-    rubocop (1.29.1)
+      rspec-support (~> 3.13.0)
+    rspec-rails (6.1.2)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.1)
+    rubocop (1.63.5)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    standard (1.12.1)
-      rubocop (= 1.29.1)
-      rubocop-performance (= 1.13.3)
-    thor (1.2.1)
-    tzinfo (2.0.4)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.36.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.63.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    strscan (3.1.0)
+    thor (1.3.1)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
-    zeitwerk (2.6.0)
+    unicode-display_width (2.5.0)
+    zeitwerk (2.6.15)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-darwin-20
   x86_64-darwin-21
   x86_64-linux

data/README.md

@@ -1,71 +1,90 @@
-18F-Flavored Rails 7 Project
+18F Rails Template
 ============================
+The 18F Rails template starts or upgrades Rails projects so that they're more secure, follow compliance rules, and are nearly ready to deploy onto cloud.gov. This gem sets up security checks and compliance diagrams, adds the U.S. Web Design System (USWDS), and much much more — [see the full list of features](#features).
 
 This template will create a new Rails 7.0.x project.
 
-See the `rails-6` branch for Rails 6.1.x
+[See the `rails-6` branch for Rails 6.1.x](https://github.com/18F/rails-template/tree/rails-6)
 
-## Use for new Rails Project
+## Installation
 
-1. `gem install rails_template_18f`
-1. `rails_template_18f help new` for usage instructions
+### For a new Rails project
 
-### Choosing whether to use `--hotwire`
+1. Install the gem:
+```
+$ gem install rails_template_18f
+```
 
-#### Server Rendered _or_ Single Page Applications
+2. Decide whether to install Rails with Hotwire, a framework for client-side interactivity using JavaScript
+  - **For entirely server-side rendered applications**, without any Javascript:
+    - Use the default configuration (`rails_template_18f new <project name> --no-hotwire`)
+  - **For applications that need [a bit of client-side interactivity][aBitOfJS]**, but not a full single page application like React or Vue:
+    - Use Hotwire (`rails_template_18f new <project name> --hotwire`)
+  - **For single-page applications** where most of the interaction will take place via JavaScript, and which will use a framework like React or Vue:
+    - Use the default configuration (`rails_template_18f new <project name> --no-hotwire`)
 
-`rails_template_18f new <<PATH_TO_PROJECT>>` _or_ `rails_template_18f new <<PATH_TO_PROJECT>> --no-hotwire`
+The `--hotwire` flag means that [Hotwire](https://hotwired.dev/) and [ActionCable](https://guides.rubyonrails.org/action_cable_overview.html) are installed. ActionCable is included to enable the [Turbo Streams](https://turbo.hotwired.dev/handbook/streams) functionality of Hotwire.
 
-This creates a Rails application that is appropriate for both server-rendered applications,
-as well as a basis for installing a separate Single Page Application (SPA) library such as React.
+Before installing, you may want to consider the other application configuration options in the next section.
 
-#### A bit more JavaScript needed
+[aBitOfJS]: https://engineering.18f.gov/web-architecture/#:~:text=are%20more%20complex-,If%20your%20use%20case%20requires%20a%20bit%20of%20client%2Dside%20interactivity%2C%20use%20the%20above%20options%20with%20a%20bit%20of%20JavaScript.,-You%20might%20use
 
-`rails_template_18f new <<PATH_TO_PROJECT>> --hotwire`
+#### Advanced configuration
 
-This creates a Rails application that includes the [Hotwire](https://hotwired.dev/) JavaScript framework.
+There are a variety of options that customize your Rails application.
 
-Hotwire can be used to add [a bit of JavaScript](https://engineering.18f.gov/web-architecture/#:~:text=are%20more%20complex-,If%20your%20use%20case%20requires%20a%20bit%20of%20client%2Dside%20interactivity%2C%20use%20the%20above%20options%20with%20a%20bit%20of%20JavaScript.,-You%20might%20use)
-for more interactivity than server-rendered apps, but less than a full SPA.
+**Important:** Do not use flags `--skip-bundle` or `--skip-javascript`, or various parts of this template will break.
 
-### Available Options
+#### Default configuration
 
-The following options can be added to change how the template behaves.
+```sh
+--skip-active-storage   # Don't include ActiveStorage for document upload
+--skip-action-text      # Don't include ActionText libraries for WYSIWYG editing
+--skip-action-cable     # Don't include ActionCable websocket implementation
+--skip-action-mailbox   # Don't include inbound email
+--skip-hotwire          # Don't include Hotwire JS library
+--skip-test             # Skip built-in test framework. (We include RSpec)
+--javascript=webpack    # Use webpack for JS bundling
+--css=postcss           # Use the PostCSS framework for bundling CSS
+--template=template.rb  # Add additional configuration from template.rb
+--database=postgresql   # Use a PostgreSQL database
+```
 
-**Important:** You must not pass `--skip-bundle` or `--skip-javascript` to `rails_template_18f` or various aspects of the template will be broken
+#### Customizing the installation
 
-#### `--javascript=esbuild`
+| Option | Description |
+|--------|-------------|
+| `--no-skip-<framework>` | Each of the skipped frameworks listed above (also in `railsrc`) can be overridden on the command line. For example: `--no-skip-active-storage` will include support for `ActiveStorage` document uploads |
+| `--javascript=esbuild` | Use [esbuild](https://esbuild.github.io/) instead of [webpack](https://webpack.js.org/) for JavaScript bundling. Note that maintaining IE11 support with esbuild may be tricky. |
+| `--no-skip-<FRAMEWORK>` | Each of the skipped frameworks in `railsrc` can be overridden on the command line. For example: `--no-skip-active-storage` will include support for `ActiveStorage` document uploads |
 
-Use [esbuild](https://esbuild.github.io/) instead of [webpack](https://webpack.js.org/) for JavaScript bundling. Note that
-maintaining IE11 support with esbuild may be tricky.
+You probably won't want to customize the template — that defeats the purpose of using this gem!
 
-#### `--no-skip-FRAMEWORK`
+_TODO: Documentation on whether you can override the `css` and `database` options._
 
-Each of the skipped frameworks in `railsrc` can be overridden on the command line. For example: `--no-skip-active-storage` will include support for `ActiveStorage` document uploads
+### For an existing Rails project
 
-### What default use or `--no-hotwire` does
+Installing this gem in a new Rails project will _TODO: say how it will help_
 
-```
---skip-active-storage   # don't include ActiveStorage for document upload
---skip-action-text      # don't include ActionText libraries for WYSIWYG editing
---skip-action-cable     # don't include ActionCable websocket implementation
---skip-action-mailbox   # don't include inbound email
---skip-hotwire          # don't include Hotwire JS library
---skip-test             # Skip built in test framework. (RSpec included via template.rb)
---javascript=webpack    # Use webpack for JS bundling
---css=postcss           # Use the postcss CSS bundling framework
---template=template.rb  # add additional configuration from template.rb
---database=postgresql   # default to PostgreSQL
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_template_18f", group: :development
 ```
 
-### What `--hotwire` does
+And then run:
 
-Identical to `--no-hotwire` except that [Hotwire](https://hotwired.dev/) and [ActionCable](https://guides.rubyonrails.org/action_cable_overview.html) are not skipped.
+    $ bundle install
 
-ActionCable is included to enable the [Turbo Streams](https://turbo.hotwired.dev/handbook/streams) functionality of Hotwire.
+For a list of commands this gem can perform, run:
 
+    $ rails generate | grep 18f
 
-### What `template.rb` does
+_TODO: Add documentation on each option._
+
+### Features
+
+This template does a lot! The template completes the following to-do list to make your application more secure, closer to standards-compliant, and nearly production-ready.
 
 1. Create a better default `README`
 1. Copy `CONTRIBUTING.md` and `LICENSE.md` from the [18F Open Source Policy repo](https://github.com/18F/open-source-policy/)
@@ -101,29 +120,7 @@ ActionCable is included to enable the [Turbo Streams](https://turbo.hotwired.dev
 1. Create [Architecture Decision Records](https://adr.github.io/) for above setup
 1. Commit the resulting project with git (unless `--skip-git` is passed)
 
-## Use for an existing Rails project
-
-### Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem "rails_template_18f", group: :development
-```
-
-And then run:
-
-  $ bundle install
-
-Or install it yourself as:
-
-  $ gem install rails_template_18f
-
-### Usage
-
-Run `rails generate` for a list of commands this gem can run
-
-## Development
+## Developing this gem
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
@@ -133,6 +130,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/18f/rails-template. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/18f/rails-template/blob/main/CODE_OF_CONDUCT.md).
 
-## Code of Conduct
+## Code of conduct
 
 Everyone interacting in the 18F Rails Template project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rahearn/rails-template-18f/blob/main/CODE_OF_CONDUCT.md).

data/lib/generators/rails_template18f/circleci/templates/circleci/config.yml.tt

@@ -47,7 +47,7 @@ commands:
       - run:
           name: Install Cloud Foundry CLI
           command: |
-            curl -v -L -o cf-cli_amd64.deb 'https://packages.cloudfoundry.org/stable?release=debian64&version=v7&source=github'
+            curl -v -L -o cf-cli_amd64.deb 'https://packages.cloudfoundry.org/stable?release=debian64&version=v8&source=github'
             sudo dpkg -i cf-cli_amd64.deb
       - run:
           name: Login with service account

data/lib/generators/rails_template18f/github_actions/github_actions_generator.rb

@@ -62,8 +62,8 @@ EOB
       def update_terraform_readme
         return unless terraform?
         readme_filename = "terraform/README.md"
-        insert_into_file readme_filename, "  |- .force-action-apply\n", after: "  |- secrets.auto.tfvars\n"
-        insert_into_file readme_filename, <<~EOM, after: /- `secrets.auto.tfvars`.*$/
+        insert_into_file readme_filename, "  |- .force-action-apply\n", after: "- <env>/\n"
+        insert_into_file readme_filename, <<~EOM, after: /.*environment-specific modules:$/
           \n- `.force-action-apply` is a file that can be updated to force GitHub Actions to run `terraform apply` during the deploy phase
         EOM
       end

data/lib/generators/rails_template18f/github_actions/templates/github/workflows/deploy-production.yml.tt

@@ -42,7 +42,7 @@ jobs:
         run: terraform apply -auto-approve -input=false
       <% end %>
       - name: Deploy app
-        uses: 18F/cg-deploy-action@main
+        uses: cloud-gov/cg-cli-tools@main
         env:
           RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
         with:
@@ -50,6 +50,4 @@ jobs:
           cf_password: ${{ secrets.CF_PASSWORD }}
           cf_org: <%= cloud_gov_organization %>
           cf_space: <%= cloud_gov_production_space %>
-          push_arguments: >-
-            --vars-file config/deployment/production.yml
-            --var rails_master_key=$RAILS_MASTER_KEY
+          cf_command: push -vars-file config/deployment/production.yml --var rails_master_key=${{ env.RAILS_MASTER_KEY }} --strategy rolling

data/lib/generators/rails_template18f/github_actions/templates/github/workflows/deploy-staging.yml.tt

@@ -42,7 +42,7 @@ jobs:
         run: terraform apply -auto-approve -input=false
       <% end %>
       - name: Deploy app
-        uses: 18F/cg-deploy-action@main
+        uses: cloud-gov/cg-cli-tools@main
         env:
           RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
         with:
@@ -50,6 +50,4 @@ jobs:
           cf_password: ${{ secrets.CF_PASSWORD }}
           cf_org: <%= cloud_gov_organization %>
           cf_space: <%= cloud_gov_staging_space %>
-          push_arguments: >-
-            --vars-file config/deployment/staging.yml
-            --var rails_master_key=$RAILS_MASTER_KEY
+          cf_command: push -vars-file config/deployment/staging.yml --var rails_master_key=${{ env.RAILS_MASTER_KEY }} --strategy rolling