rails_template_18f 0.8.2 → 1.1.0

data/template.rb

@@ -15,7 +15,7 @@ def skip_active_job?
 end
 
 def webpack?
-  adjusted_javascript_option == "webpack"
+  options[:javascript] == "webpack"
 end
 
 def hotwire?
@@ -39,12 +39,14 @@ def print_announcements
   end
 end
 
-unless Gem::Dependency.new("rails", "~> 7.0.0").match?("rails", Rails.gem_version)
-  warn "This template requires Rails 7.0.x"
+unless Gem::Dependency.new("rails", "~> 7.1.0").match?("rails", Rails.gem_version)
+  warn "This template requires Rails 7.1.x"
   if Gem::Dependency.new("rails", "~> 6.1.0").match?("rails", Rails.gem_version)
-    warn "See the rails-6 branch https://github.com/18f/rails-template/tree/rails-6"
-  elsif Gem::Dependency.new("rails", "~> 7.1.0").match?("rails", Rails.gem_version)
-    warn "Rails 7.1 is out! Please file an issue so we can get the template updated"
+    warn "See the rails-6 branch https://github.com/gsa-tts/rails-template/tree/rails-6"
+  elsif Gem::Dependency.new("rails", "~> 7.0.0").match?("rails", Rails.gem_version)
+    warn "See the rails-7.0 branch https://github.com/gsa-tts/rails-template/tree/rails-7.0"
+  elsif Gem::Dependency.new("rails", "~> 7.2.0").match?("rails", Rails.gem_version)
+    warn "We haven't updated the template for Rails 7.2 yet! Please file an issue so we can get the template updated"
   else
     warn "We didn't recognize the version of Rails you are using: #{Rails.version}"
   end
@@ -52,21 +54,23 @@ unless Gem::Dependency.new("rails", "~> 7.0.0").match?("rails", Rails.gem_versio
 end
 
 # ask setup questions
-compliance_template = yes?("Include OSCAL files from compliance-template? (y/n)")
-compliance_template_repo = "git@github.com:GSA-TTS/compliance-template.git"
-compliance_template_submodule = compliance_template && yes?("Clone #{compliance_template_repo} as a git submodule? (y/n)")
-if compliance_template_submodule
-  compliance_template_repo = ask("What is the git clone address of your compliance-template fork?")
+compliance_trestle = yes?("Set up docker-trestle integration for Compliance-as-Code? (y/n)")
+compliance_trestle_repo = nil
+compliance_trestle_submodule = compliance_trestle && yes?("Set up compliance documents as a git submodule? (y/n)")
+if compliance_trestle_submodule
+  compliance_trestle_repo = ask("What is the git clone address of your compliance document repo?")
 end
-if compliance_template_repo.blank?
+if compliance_trestle_submodule && compliance_trestle_repo.blank?
   register_announcement("OSCAL Documentation", <<~EOM)
-    Skipping OSCAL files as the compliance-template fork was left blank.
+    Skipping docker-trestle integration as the compliance document repository was left blank.
 
-    Re-run the oscal generator after creating your template fork to get started with OSCAL.
+    Re-run the oscal generator after creating your repo to get started with OSCAL.
   EOM
-  compliance_template = false
-  compliance_template_submodule = false
+  compliance_trestle = false
+  compliance_trestle_submodule = false
 end
+# only ask about auditree if we're also using docker-trestle
+auditree = compliance_trestle ? yes?("Run compliance checks with auditree? (y/n)") : false
 
 terraform = yes?("Create terraform files for cloud.gov services? (y/n)")
 @cloud_gov_organization = ask("What is your cloud.gov organization name? (Leave blank to fill in later)")
@@ -103,6 +107,23 @@ register_announcement("Documentation", <<~EOM)
   * Review any TBD sections of the README and update where appropriate.
 EOM
 
+# do early so later generators register files in the correct location
+if compliance_trestle
+  after_bundle do
+    generator_arguments = []
+    if compliance_trestle_submodule
+      generator_arguments << "--oscal_repo=#{compliance_trestle_repo}"
+    end
+    generate "rails_template18f:oscal", *generator_arguments
+  end
+  register_announcement("OSCAL Documentation", <<~EOM)
+    OSCAL files have been generated with some default implementation statements in `doc/compliance/oscal`
+
+    All generated statements must be reviewed for accuracy with your system's implementation before being
+    submitted for authorization.
+  EOM
+end
+
 # ensure dependencies are installed
 copy_file "Brewfile"
 insert_into_file "bin/setup", <<EOSETUP, after: /Add necessary setup steps to this file.\n/
@@ -153,7 +174,8 @@ directory "bin", mode: :preserve
 chmod "bin/ops/create_service_account.sh", 0o755
 chmod "bin/ops/destroy_service_account.sh", 0o755
 chmod "bin/ops/set_space_egress.sh", 0o755
-copy_file "pa11yci", ".pa11yci"
+copy_file "pa11y.js"
+copy_file "pa11yci.js"
 copy_file "editorconfig", ".editorconfig"
 copy_file "zap.conf"
 after_bundle do
@@ -200,11 +222,11 @@ uncomment_lines csp_initializer, "content_security_policy_nonce"
 
 # install development & testing gems
 gem_group :development, :test do
-  gem "rspec-rails", "~> 5.1"
-  gem "dotenv-rails", "~> 2.7"
-  gem "brakeman", "~> 5.2"
+  gem "rspec-rails", "~> 6.1"
+  gem "dotenv-rails", "~> 3.1"
+  gem "brakeman", "~> 6.1"
   gem "bundler-audit", "~> 0.9"
-  gem "standard", "~> 1.7"
+  gem "standard", "~> 1.36"
 end
 if ENV["RT_DEV"] == "true"
   gem "rails_template_18f", group: :development, path: ENV["PWD"]
@@ -289,8 +311,10 @@ after_bundle do
   end
   directory "app/assets"
   append_to_file "app/assets/stylesheets/application.postcss.css", <<~EOCSS
-    @forward "uswds-settings.scss";
-    @forward "uswds-components.scss";
+    @forward "uswds-settings";
+    @forward "uswds-components";
+
+    @forward "uswds-overrides";
   EOCSS
   inside "app/assets/stylesheets" do
     File.rename("application.postcss.css", "application.postcss.scss")
@@ -336,22 +360,6 @@ after_bundle do
   generate "rails_template18f:rails_erd"
 end
 
-if compliance_template
-  after_bundle do
-    generator_arguments = [
-      "--oscal_repo=#{compliance_template_repo}",
-      (compliance_template_submodule ? "--no-detach" : "--detach")
-    ]
-    generate "rails_template18f:oscal", *generator_arguments
-  end
-  register_announcement("OSCAL Documentation", <<~EOM)
-    OSCAL files have been generated with some default implementation statements in `doc/compliance/oscal`
-
-    All generated statements must be reviewed for accuracy with your system's implementation before being
-    submitted for authorization.
-  EOM
-end
-
 after_bundle do
   # Setup translations
   generate "rails_template18f:i18n", "--languages=#{supported_languages.join(",")}", "--force"
@@ -452,6 +460,12 @@ if @circleci_pipeline
   EOM
 end
 
+if auditree
+  after_bundle do
+    generate "rails_template18f:auditree"
+  end
+end
+
 # setup production credentials file
 require "rails/generators"
 require "rails/generators/rails/encryption_key_file/encryption_key_file_generator"
@@ -481,8 +495,7 @@ EOM
 # ensure this is the very last step
 after_bundle do
   if run_db_setup
-    rails_command "db:create"
-    rails_command "db:migrate"
+    rails_command "db:setup"
   end
 
   # x86_64-linux is required to install gems on any linux system such as cloud.gov or CI pipelines
@@ -490,7 +503,6 @@ after_bundle do
 
   # bring generated code into compliance with standard ruby: https://github.com/testdouble/standard
   gsub_file "config/environments/production.rb", "(STDOUT)", "($stdout)"
-  gsub_file "config/puma.rb", /\) { (\S+) }/, ', \1)'
   run "bundle exec standardrb --fix"
 
   unless skip_git?
@@ -500,10 +512,10 @@ after_bundle do
       # compliance documentation
       /doc/compliance/
     EOM
-    if compliance_template_submodule
+    if compliance_trestle_submodule
       inside "doc/compliance/oscal" do
         run "git add -A"
-        run "git diff-index --quiet HEAD || git commit -am 'rails-template generated control statements'"
+        run "git diff-index --quiet HEAD || git commit -am 'rails-template generated components'"
       end
     end
     git add: "."

data/templates/Brewfile

@@ -1,8 +1,8 @@
 # Brewfile
 # add any dependencies that must be installed from homebrew here
 
-# cloud.gov RDS is on postgres 12
-brew "postgresql@12", link: true
+# cloud.gov RDS is on postgres 15
+brew "postgresql@15", link: true
 
 # used in bin/with-server script
 brew "dockerize"

data/templates/README.md.tt

@@ -23,9 +23,8 @@ guide for an introduction to the framework.
       * Manually: clicking "allow" when you run the integration tests for the first time and a dialogue opens up
 * Install Ruby dependencies: `bundle install`
 * Install JS dependencies: `yarn install`
-* Create database: `bundle exec rake db:create`
-* Run migrations: `bundle exec rake db:migrate`
-* Run the server: `bundle exec rails s`
+* Create database and run migrations: `bundle exec rake db:setup`
+* Run the server: `bin/dev`
 * Visit the site: http://localhost:3000
 
 ### Local Configuration
@@ -98,7 +97,7 @@ Run everything: `bundle exec rake`
 
 #### Pa11y Scan
 
-When new pages are added to the application, ensure they are added to `./.pa11yci` so that they can be scanned.
+When new pages are added to the application, ensure they are added to `./pa11y.js` so that they can be scanned.
 
 ### Automatic linting
 

data/templates/app/assets/stylesheets/uswds-components.scss

@@ -1,7 +1,13 @@
 @forward "uswds-global";
 @forward "uswds-utilities";
 @forward "uswds-typography";
+@forward "usa-layout-grid";
 @forward "usa-header";
 @forward "usa-banner";
 @forward "usa-section";
+@forward "usa-language-selector";
 // add additional packages here as you use them
+
+// or replace these all with
+// @forward "uswds";
+// to import the entirety of uswds

data/templates/app/assets/stylesheets/uswds-overrides/_index.scss

@@ -0,0 +1,2 @@
+@forward "override-usa-banner";
+@forward "override-usa-language-selector";

data/templates/app/assets/stylesheets/uswds-overrides/_override-usa-banner.scss

@@ -0,0 +1,13 @@
+
+.banner__text-container {
+  flex: 1;
+}
+
+.usa-banner__button {
+  margin-right: 0.5rem;
+}
+
+[dir="rtl"] .usa-banner__header-flag {
+  margin-left: 0.5rem;
+  margin-right: 0;
+}

data/templates/app/assets/stylesheets/uswds-overrides/_override-usa-language-selector.scss

@@ -0,0 +1,38 @@
+
+.usa-language-container {
+  padding: 0.5rem 1rem;
+}
+
+.usa-language__submenu {
+  padding: 20px;
+  width: auto;
+  border-radius: 3px;
+  white-space: nowrap;
+}
+
+.usa-language__submenu-item {
+  padding: 4px 8px;
+
+  &:last-child {
+    border-bottom: 1px solid #dfe1e2;
+  }
+}
+
+.switcher-desktop {
+  @media (max-width: 800px) {
+    display: none;
+  }
+}
+
+.switcher-mobile {
+  @media (min-width: 800px) {
+    display: none;
+  }
+}
+
+.usa-language__primary-item:last-of-type .usa-language__submenu {
+  [dir="rtl"] & {
+    right: unset;
+    left: 0;
+  }
+}

data/templates/app/views/application/_header.html.erb

@@ -1,5 +1,8 @@
 <div class="usa-overlay"></div>
 <header class="usa-header usa-header--basic">
+  <div class="switcher-mobile">
+    <%= render partial: "application/language_selector", locals: {mode: "mobile"} %>
+  </div>
   <div class="usa-nav-container">
     <div class="usa-navbar">
       <div class="usa-logo">
@@ -14,11 +17,9 @@
         <%= image_tag "@uswds/uswds/dist/img/usa-icons/close.svg", role: "img", alt: t('shared.header.close') %>
       </button>
       <ul class="usa-nav__primary usa-accordion">
-        <% I18n.available_locales.each do |l| %>
-          <li class="usa-nav__primary-item">
-            <%= format_active_locale(l) %>
-          </li>
-        <% end %>
+        <li class="usa-nav__primary-item">
+          <%= link_to "Example Nav Item", root_path %>
+        </li>
       </ul>
     </nav>
   </div>

data/templates/app/views/application/_language_selector.html.erb

@@ -0,0 +1,35 @@
+
+<% if I18n.available_locales.count == 2 %>
+  <% I18n.available_locales.each do |l| %>
+    <% unless active_locale?(l) %>
+      <div class="usa-language-container usa-language--small">
+        <%= link_to language_span(l), root_path(locale: l), class: "usa-button" %>
+      </div>
+    <% end %>
+  <% end %>
+<% elsif I18n.available_locales.count > 2 %>
+  <div class="usa-language-container">
+    <ul class="usa-language__primary usa-accordion">
+      <li class="usa-language__primary-item">
+        <button
+          type="button"
+          class="usa-button usa-language__link"
+          role="button"
+          aria-expanded="false"
+          aria-controls="language-options-<%= mode %>"
+        >
+          <%= t "shared.languages.selector" %>
+        </button>
+        <ul id="language-options-<%= mode %>" class="usa-language__submenu" hidden="true">
+          <% I18n.available_locales.each do |l| %>
+            <% unless active_locale?(l) %>
+              <li class="usa-language__submenu-item">
+                <%= link_to content_tag(:strong, language_span(l)), root_path(locale: l) %>
+              </li>
+            <% end %>
+          <% end %>
+        </ul>
+      </li>
+    </ul>
+  </div>
+<% end %>

data/templates/app/views/application/_usa_banner.html.erb

@@ -4,24 +4,29 @@
   <div class="usa-accordion">
     <header class="usa-banner__header">
       <div class="usa-banner__inner">
-        <div class="grid-col-auto">
-          <%= image_tag "@uswds/uswds/dist/img/us_flag_small.png", alt: t('shared.banner.us_flag'), class: "usa-banner__header-flag" %>
+        <div class="banner__text-container grid-row">
+          <div class="grid-col-auto">
+            <%= image_tag "@uswds/uswds/dist/img/us_flag_small.png", alt: t('shared.banner.us_flag'), class: "usa-banner__header-flag" %>
+          </div>
+          <div class="grid-col-fill tablet:grid-col-auto">
+            <p class="usa-banner__header-text">
+              <%= t('shared.banner.official_site') %>
+            </p>
+            <p class="usa-banner__header-action" aria-hidden="true">
+              <%= t('shared.banner.how') %>
+            </p>
+          </div>
+          <button
+            class="usa-accordion__button usa-banner__button"
+            aria-expanded="false"
+            aria-controls="gov-banner"
+          >
+            <span class="usa-banner__button-text"><%= t('shared.banner.how') %></span>
+          </button>
         </div>
-        <div class="grid-col-fill tablet:grid-col-auto">
-          <p class="usa-banner__header-text">
-            <%= t('shared.banner.official_site') %>
-          </p>
-          <p class="usa-banner__header-action" aria-hidden="true">
-            <%= t('shared.banner.how') %>
-          </p>
+        <div class="switcher-desktop">
+          <%= render partial: "application/language_selector", locals: {mode: "desktop"} %>
         </div>
-        <button
-          class="usa-accordion__button usa-banner__button"
-          aria-expanded="false"
-          aria-controls="gov-banner"
-        >
-          <span class="usa-banner__button-text"><%= t('shared.banner.how') %></span>
-        </button>
       </div>
     </header>
     <div class="usa-banner__content usa-accordion__content" id="gov-banner">

data/templates/bin/owasp-scan

@@ -24,7 +24,7 @@ Notes:
 set -e
 
 scan="zap-baseline.py"
-docker_name="owasp/zap2docker-weekly"
+docker_tag="weekly"
 
 while getopts "hfs" opt; do
   case "$opt" in
@@ -32,7 +32,7 @@ while getopts "hfs" opt; do
       scan="zap-full-scan.py"
       ;;
     s)
-      docker_name="owasp/zap2docker-stable"
+      docker_tag="stable"
       ;;
     *)
       echo "$usage"
@@ -44,6 +44,6 @@ done
 
 hostname="http://host.docker.internal:3000"
 args="-c zap.conf -I -r zap_report.html"
-cmd="docker run --rm --user root -v $(pwd):/zap/wrk/:rw -t $docker_name $scan -t $hostname $args"
+cmd="docker run --rm -v $(pwd):/zap/wrk/:rw -t ghcr.io/zaproxy/zaproxy:$docker_tag $scan -t $hostname $args"
 
 `dirname "$0"`/with-server "$cmd"

data/templates/bin/pa11y-scan

@@ -7,4 +7,4 @@
 #  * no other server is listening on port 3000
 
 
-`dirname "$0"`/with-server "yarn run pa11y-ci"
+`dirname "$0"`/with-server "yarn run pa11y-ci -c pa11y.js"

data/templates/config/environments/ci.rb

@@ -2,6 +2,7 @@ require_relative "production"
 
 Rails.application.configure do
   config.public_file_server.enabled = true
+  config.force_ssl = false
 
   logger = ActiveSupport::Logger.new($stdout)
   logger.formatter = config.log_formatter

data/templates/manifest.yml.tt

@@ -2,7 +2,6 @@
 applications:
 - name: <%= app_name %>-((env))
   buildpacks:
-    - nodejs_buildpack
     - ruby_buildpack
   env:
     RAILS_MASTER_KEY: ((rails_master_key))

data/templates/pa11y.js

@@ -0,0 +1,12 @@
+module.exports = {
+  defaults: {
+    standard: "WCAG2AA",
+    runners: ["axe"],
+    hideElements: [
+      ".usa-banner__button-text" // axe can't determine the background color for this button
+    ]
+  },
+  urls: [
+    "http://localhost:3000"
+  ]
+};

data/templates/pa11yci.js

@@ -0,0 +1,8 @@
+let defaults = require("./pa11y.js");
+
+// set chrome path for github actions
+defaults.defaults.chromeLaunchConfig = {
+  "executablePath": "/usr/bin/google-chrome"
+};
+
+module.exports = defaults;