rails_template_18f 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf6b140f15f85229d716db5c0b51db5b88b41172000f89a613bdc09975c61f7
-  data.tar.gz: 6a3a14efb4cb1373236a53260cf06b161375346d37097563ef65197862e538a8
+  metadata.gz: c9452d60916a767ee1b00bb0a76e6582d4d1ed760b3bf0c4d68a07c8225ddfd4
+  data.tar.gz: 481c2ee7693849f2c21d382d78edd08a59370b8c2b440bef8502d22a039a2243
 SHA512:
-  metadata.gz: 8fb2a0c4a4adf9fa72ea8078a6b1001671f2e562ece7b3d74b64ffa39c113b96c280f64a3eacc0233b67c8bc2b6ec160b2867c78e49363100d1cdc7055352516
-  data.tar.gz: 48e96e771a2fb4dd8ca03719f923ae2749b6b212577c88c8e72a3e2788d71b1a6a6bda768611509aa2001e129a7a29c833ad99a93433bf954c46552671d40c2b
+  metadata.gz: 8a5b1be47db25412b0ba04dd19a395401f86b6d5ee14b907c2de54e95bfae159a6407851bfcd83b07ac20ca9423de568580c5cfdec0c5d49bfd5e2f7f62e59df
+  data.tar.gz: 75ff52ec4661f95c4da617217d7eb7dc993192610d9209ab3f9a438504111281a8c779db3074c1d6506073b126d437c6aaebe328b11add1363797938f70d006e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [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.0)
       activesupport (~> 7.0.0)
       colorize (~> 0.8)
       railties (~> 7.0.0)
@@ -47,9 +47,9 @@ GEM
       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)

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/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.0"
 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
 
@@ -196,6 +203,9 @@ unless skip_git?
   end
   append_to_file ".gitignore", <<~EOM
 
+    # Ignore Brewfile debug info
+    Brewfile.lock.json
+
     # Ignore local dotenv overrides
     .env*.local
 

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`
@@ -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.0
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-03-04 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
@@ -263,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Generators for creating an 18F-flavored Rails app