rails_template_18f 0.4.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf6b140f15f85229d716db5c0b51db5b88b41172000f89a613bdc09975c61f7
-  data.tar.gz: 6a3a14efb4cb1373236a53260cf06b161375346d37097563ef65197862e538a8
+  metadata.gz: 2081ea2fe971ba6cdd3af16c00a9e91146fea1e489b48118543b1c95b075f3d9
+  data.tar.gz: 6f7c93f8a5429e2a63fb560e79afc34c940a652168c3cba0e2d548ad61e0c9ca
 SHA512:
-  metadata.gz: 8fb2a0c4a4adf9fa72ea8078a6b1001671f2e562ece7b3d74b64ffa39c113b96c280f64a3eacc0233b67c8bc2b6ec160b2867c78e49363100d1cdc7055352516
-  data.tar.gz: 48e96e771a2fb4dd8ca03719f923ae2749b6b212577c88c8e72a3e2788d71b1a6a6bda768611509aa2001e129a7a29c833ad99a93433bf954c46552671d40c2b
+  metadata.gz: dd118690c1537a3de6db28e7478a492617540ba5d8b2322d80506d5800adbe7997ee78b08098cfb36ace459612f72ae2310bd8ad77a068e5fb3e11fbf6c39f61
+  data.tar.gz: 406ef4a7f114415d3059be3d1713015af635a2dd57e76355d5fb685b74d734d90c835bcec860a4fdd980df512d29b4d413b3ec3733efd46e4adf1a3d2414bdfc

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [0.5.2] - 2022-03-24
+
+- add extra branch test coverage to CloudGovConfig
+- replace forked version of @csstools/postcss-sass with released version
+- upgrade i18n-tasks gem to 1.0
+
+## [0.5.1] - 2022-03-17
+
+- fix interaction between foreman and dotenv by disabling foreman's env loading
+
+## [0.5.0] - 2022-03-04
+
+- use Brewfile for installing homebrew-based dependencies
+- move test site banner to the _usa_banner.html.erb partial
+- use dockerize within bin/with-server to wait for rails to start
+
 ## [0.4.1] - 2022-02-25
 
 - update gem dependencies

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_template_18f (0.4.1)
+    rails_template_18f (0.5.2)
       activesupport (~> 7.0.0)
       colorize (~> 0.8)
       railties (~> 7.0.0)
@@ -10,20 +10,20 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.0.2.2)
-      actionview (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.2.2)
-      activesupport (= 7.0.2.2)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (7.0.2.2)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -40,19 +40,19 @@ GEM
     crass (1.0.6)
     diff-lcs (1.5.0)
     erubi (1.10.0)
-    i18n (1.9.1)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.14.0)
+    loofah (2.15.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     minitest (5.15.0)
-    nokogiri (1.13.1-x86_64-darwin)
+    nokogiri (1.13.3-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.1-x86_64-linux)
+    nokogiri (1.13.3-x86_64-linux)
       racc (~> 1.4)
     parallel (1.21.0)
-    parser (3.1.0.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
     racc (1.6.0)
     rack (2.2.3)
@@ -63,16 +63,16 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -86,7 +86,7 @@ GEM
     rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-rails (5.1.0)
+    rspec-rails (5.1.1)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -95,24 +95,24 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.11.0)
-    rubocop (1.25.1)
+    rubocop (1.26.0)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.13.2)
+    rubocop-ast (1.16.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.7.1)
-      rubocop (= 1.25.1)
-      rubocop-performance (= 1.13.2)
+    standard (1.8.0)
+      rubocop (= 1.26.0)
+      rubocop-performance (= 1.13.3)
     thor (1.2.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)

data/lib/generators/rails_template18f/active_storage/active_storage_generator.rb

@@ -61,7 +61,6 @@ module RailsTemplate18f
       def configure_clamav_env_var
         append_to_file ".env", <<~EOM
 
-
           # CLAMAV_API_URL tells FileScanJob where to send files for virus scans
           CLAMAV_API_URL=https://localhost:9443
         EOM

data/lib/generators/rails_template18f/cloud_gov_config/templates/spec/models/cloud_gov_config_spec.rb

@@ -37,7 +37,11 @@ RSpec.describe CloudGovConfig, type: :model do
       end
 
       it "returns nil for a missing path" do
-        expect(subject.dig(:s3, :credentials, :other)).to be_nil
+        expect(subject.dig(:s3, :missing)).to be_nil
+      end
+
+      it "returns nil for a missing service" do
+        expect(subject.dig(:rds, :credentials)).to be_nil
       end
     end
   end

data/lib/generators/rails_template18f/i18n/i18n_generator.rb

@@ -18,7 +18,7 @@ module RailsTemplate18f
       def install_gem
         return if gem_installed?("i18n-tasks")
         gem_group :development, :test do
-          gem "i18n-tasks", "~> 0.9"
+          gem "i18n-tasks", "~> 1.0"
         end
       end
 

data/lib/generators/rails_template18f/sidekiq/sidekiq_generator.rb

@@ -18,6 +18,15 @@ module RailsTemplate18f
         bundle_install
       end
 
+      def install_redis
+        append_to_file "Brewfile", <<~EOB
+
+          # queue for sidekiq jobs
+          brew "redis"
+        EOB
+        insert_into_file "README.md", indent("* [redis]()\n"), after: /\* Install homebrew dependencies: `brew bundle`\n/
+      end
+
       def configure_server_runner
         append_to_file "Procfile.dev", "worker: bundle exec sidekiq\n"
         insert_into_file "manifest.yml", indent(<<~EOYAML), after: /processes:$\n/

data/lib/generators/rails_template18f/terraform/templates/terraform/README.md.tt

@@ -2,7 +2,7 @@
 
 This directory holds the terraform modules for maintaining your complete persistent infrastructure.
 
-Prerequisite: install the `jq` JSON processor: `brew install jq`
+Prerequisite: install the `jq` JSON processor: `brew bundle` or `brew install jq`
 
 ## Initial setup
 

data/lib/generators/rails_template18f/terraform/terraform_generator.rb

@@ -19,6 +19,15 @@ module RailsTemplate18f
         chmod "terraform/bootstrap/teardown_creds.sh", 0o755
       end
 
+      def install_jq
+        append_to_file "Brewfile", <<~EOB
+
+          # used in terraform/create_space_deployer.sh
+          brew "jq"
+        EOB
+        insert_into_file "README.md", indent("* [jq](https://stedolan.github.io/jq/)\n"), after: /\* Install homebrew dependencies: `brew bundle`\n/
+      end
+
       def ignore_files
         unless skip_git?
           append_to_file ".gitignore", <<~EOM
@@ -34,7 +43,7 @@ module RailsTemplate18f
       end
 
       def update_readme
-        gsub_file "README.md", /^(### Automatic linting)/, '\1 and terraform formatting'
+        gsub_file "README.md", /^(### Automatic linting)\s*$/, '\1 and terraform formatting'
         gsub_file "README.md", /(ruby linting) (on every)/, '\1 and terraform formatting \2'
         gsub_file "README.md", /^Before the first deploy only.*$/, "Follow the instructions in `terraform/README.md` to create the supporting services."
       end

data/lib/rails_template18f/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsTemplate18f
-  VERSION = "0.4.1"
+  VERSION = "0.5.2"
 end

data/template.rb

@@ -87,6 +87,13 @@ register_announcement("Documentation", <<~EOM)
   * Review any TBD sections of the README and update where appropriate.
 EOM
 
+# ensure dependencies are installed
+copy_file "Brewfile"
+insert_into_file "bin/setup", <<EOSETUP, after: /Add necessary setup steps to this file.\n/
+  puts "== Installing homebrew dependencies =="
+  system("brew bundle --no-lock")
+EOSETUP
+
 # setup nvmrc
 file ".nvmrc", @node_version
 
@@ -185,6 +192,12 @@ if ENV["RT_DEV"] == "true"
 else
   gem "rails_template_18f", group: :development
 end
+after_bundle do
+  gsub_file "bin/dev", /foreman start -f (.*)$/, <<~'EOM'
+    # pass /dev/null for the environment file to prevent weird interactions between foreman and dotenv
+    foreman start -e /dev/null -f \1
+  EOM
+end
 
 copy_file "lib/tasks/scanning.rake"
 copy_file "env", ".env"
@@ -196,6 +209,9 @@ unless skip_git?
   end
   append_to_file ".gitignore", <<~EOM
 
+    # Ignore Brewfile debug info
+    Brewfile.lock.json
+
     # Ignore local dotenv overrides
     .env*.local
 
@@ -223,10 +239,11 @@ after_bundle do
     "build:css": "postcss ./app/assets/stylesheets/application.postcss.css -o ./app/assets/builds/application.css"
   },
   EOJSON
+  # include verbose flag for dev postcss output
+  gsub_file "Procfile.dev", "yarn build:css --watch", "yarn build:css --verbose --watch"
   # Replace postcss-nesting with sass since USWDS uses sass
   run "yarn remove postcss-nesting"
-  # include fork of @csstools/postcss-sass until that library is updated for postcss 8
-  run "yarn add https://github.com/sinankeskin/postcss-sass"
+  run "yarn add @csstools/postcss-sass"
   run "yarn add postcss-scss"
   insert_into_file "postcss.config.js", "  syntax: 'postcss-scss',\n", before: /^\s+plugins/
   gsub_file "postcss.config.js", "postcss-nesting", "@csstools/postcss-sass"
@@ -255,8 +272,6 @@ after_bundle do
   end
   directory "app/assets"
   append_to_file "app/assets/stylesheets/application.postcss.css", <<~EOCSS
-    /* KNOWN ISSUE: only changes to application.postcss.css will trigger an automatic rebuild */
-    /* restart your server or run `yarn build:css` when changing other files */
     @import "uswds-settings.scss";
     @import "../../../node_modules/uswds/dist/scss/uswds.scss";
   EOCSS

data/templates/Brewfile

@@ -0,0 +1,14 @@
+# Brewfile
+# add any dependencies that must be installed from homebrew here
+
+# cloud.gov RDS is on postgres 12
+brew "postgresql@12", link: true
+
+# used in bin/with-server script
+brew "dockerize"
+
+# helper scripts for creating new ADRs
+brew "adr-tools"
+
+# chromedriver for integration tests
+cask "chromedriver"

data/templates/README.md.tt

@@ -12,16 +12,15 @@ guide for an introduction to the framework.
 
 * Install Ruby <%= @ruby_version %>
 * Install NodeJS <%= @node_version %>
-* Install PostgreSQL: `brew install postgresql`
-  * Add postgres to your PATH if it wasn't done automatically
-  `echo 'export PATH="/usr/local/opt/postgresql/bin:$PATH"' >> ~/.zshrc`
-  * Start the server
-  `brew services start postgresql`
+* Install homebrew dependencies: `brew bundle`
+  * [PostgreSQL](https://www.postgresql.org/)
+  * [Dockerize](https://github.com/jwilder/dockerize)
+  * [ADR Tools](https://github.com/npryce/adr-tools)
+  * [Chromedriver](https://sites.google.com/chromium.org/driver/)
+    * Chromedriver must be allowed to run. You can either do that by:
+      * The command line: `xattr -d com.apple.quarantine $(which chromedriver)` (this is the only option if you are on Big Sur)
+      * Manually: clicking "allow" when you run the integration tests for the first time and a dialogue opens up
 * Install Ruby dependencies: `bundle install`
-* Install chromedriver for integration tests: `brew install --cask chromedriver`
-  * Chromedriver must be allowed to run. You can either do that by:
-    * The command line: `xattr -d com.apple.quarantine $(which chromedriver)` (this is the only option if you are on Big Sur)
-    * Manually: clicking "allow" when you run the integration tests for the first time and a dialogue opens up
 * Install JS dependencies: `yarn install`
 * Create database: `bundle exec rake db:create`
 * Run migrations: `bundle exec rake db:migrate`
@@ -32,9 +31,9 @@ guide for an introduction to the framework.
 
 Environment variables can be set in development using the [dotenv](https://github.com/bkeepers/dotenv) gem.
 
-Consistent but sensitive credentials should be added to `config/credentials.yml.env` by using `$ rails credentials:edit`
+Consistent but sensitive credentials should be added to `config/credentials.yml.enc` by using `$ rails credentials:edit`
 
-Production credentials should be added to `config/credentials/production.yml.env` by using `$ rails credentials:edit --environment production`
+Production credentials should be added to `config/credentials/production.yml.enc` by using `$ rails credentials:edit --environment production`
 
 Any changes to variables in `.env` that should not be checked into git should be set
 in `.env.local`.
@@ -145,7 +144,7 @@ Configuration that changes from staging to production, but is public, should be
 Architectural Decision Records (ADR) are stored in `doc/adr`
 To create a new ADR, first install [ADR-tools](https://github.com/npryce/adr-tools) if you don't
 already have it installed.
-* `brew install adr-tools`
+* `brew bundle` or `brew install adr-tools`
 
 Then create the ADR:
 *  `adr new Title Of Architectural Decision`

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

@@ -1,6 +1,5 @@
 <div class="usa-overlay"></div>
 <header class="usa-header usa-header--basic">
-  <%= render "application/demo_site_banner" if Rails.configuration.x.show_demo_banner %>
   <div class="usa-nav-container">
     <div class="usa-navbar">
       <div class="usa-logo">

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

@@ -49,3 +49,5 @@
     </div>
   </div>
 </section>
+
+<%= render "application/demo_site_banner" if Rails.configuration.x.show_demo_banner %>

data/templates/bin/with-server

@@ -20,9 +20,8 @@ bundle exec rake assets:precompile
 # run the server
 bundle exec rails server &
 server_pid=$!
-# pause to ensure the server has started
-sleep 5
 
+dockerize -wait http://localhost:3000 -timeout 1m
 
 $@
 exit_status=$?

data/templates/env

@@ -7,4 +7,4 @@
 ###################################################################################################
 
 # SHOW_DEMO_BANNER controls whether to show the TEST SITE banner in Rails.env.development
-SHOW_DEMO_BANNER=false
+SHOW_DEMO_BANNER=false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_template_18f
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -210,6 +210,7 @@ files:
 - railsrc
 - railsrc-hotwire
 - template.rb
+- templates/Brewfile
 - templates/README.md.tt
 - templates/app/assets/images/uswds.js
 - templates/app/assets/stylesheets/uswds-settings.scss