rails_template_18f 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c87267d368d3e90a500c0fc1bf23312a3f6edf437ba991a9a4c7b994fff4282d
-  data.tar.gz: ec24cf97ec587cf730bb2f63ff4cf0fd5b13ae64364b175041b0b0afd42a4321
+  metadata.gz: 9272beadb19c4c9a6aa8f3da43cfbb06d7fbf23f75d0f4ec393dde3610f06157
+  data.tar.gz: a3906d6bddb262a5bc46f5ed40e0bf64110bd396ac8e765185dcc808abe6c91a
 SHA512:
-  metadata.gz: c2c05519936ff836d7c99dd16a5363755a6e86731c5d41454adbc0f6a7ada083fd1b636d0f5da3db446225866f095b42c2278100c85d3c10a3a2182100fcf550
-  data.tar.gz: b2e6da4f298a5c0054997c2c44244e4956044af83af81792937adf7d52716a68b3f8ebf8332f598943b9bad9a37bebf3c6dd4da0eb196ac119cc32455db00e57
+  metadata.gz: 22926545b3fe7273d36c8fde0445d9865bab390cf2cc856c25bc33e50f1c1420944a30052a2e0ae8b730da4f17dee2c16165cc83a1e21eb1f0475afa0fd30b74
+  data.tar.gz: fe7f4f8df14d4f2eac2a5882daf368cdf68a8c9f53a54550fe8d13f1b7a18767c50334e142a2784b92964478fe0e3a3e88c5986271b30e78d8e0743690c8a09a

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [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
+- fix issues when included gem hadn't been previously installed
+
 ## [0.4.0] - 2022-02-24
 
 - helper script to run rails app:update

data/Gemfile

@@ -7,6 +7,4 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "colorize", "~> 0.8"
-
 gem "byebug"

data/Gemfile.lock

@@ -1,28 +1,29 @@
 PATH
   remote: .
   specs:
-    rails_template_18f (0.4.0)
+    rails_template_18f (0.5.1)
       activesupport (~> 7.0.0)
+      colorize (~> 0.8)
       railties (~> 7.0.0)
       thor (~> 1.0)
 
 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)
@@ -39,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)
@@ -62,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)
@@ -85,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)
@@ -94,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)
@@ -125,7 +126,6 @@ PLATFORMS
 DEPENDENCIES
   ammeter (~> 1.1)
   byebug
-  colorize (~> 0.8)
   rails_template_18f!
   rake (~> 13.0)
   rspec (~> 3.11)

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

@@ -13,8 +13,8 @@ module RailsTemplate18f
       DESC
 
       def configure_active_storage
-        generate "rails_template18f:cloud_gov_config"
-        rails_command "active_storage:install"
+        generate "rails_template18f:cloud_gov_config", inline: true
+        rails_command "active_storage:install", inline: true
         comment_lines "config/environments/production.rb", /active_storage\.service/
         insert_into_file "config/environments/production.rb", "\n  config.active_storage.service = :amazon", after: /active_storage\.service.*$/
         environment "config.active_storage.service = :local", env: "ci"
@@ -30,15 +30,22 @@ module RailsTemplate18f
       end
 
       def install_gems
-        gem "faraday", "~> 2.2"
-        gem "faraday-multipart", "~> 1.0"
-        gem_group :production do
-          gem "aws-sdk-s3", "~> 1.112"
+        faraday_installed = gem_installed?("faraday")
+        middleware_installed = gem_installed?("faraday-multipart")
+        sdk_installed = gem_installed?("aws-sdk-s3")
+        return if faraday_installed && middleware_installed && sdk_installed
+        gem "faraday", "~> 2.2" unless faraday_installed
+        gem "faraday-multipart", "~> 1.0" unless middleware_installed
+        unless sdk_installed
+          gem_group :production do
+            gem "aws-sdk-s3", "~> 1.112"
+          end
         end
+        bundle_install
       end
 
       def create_scanned_upload_model_and_job
-        generate :migration, "CreateFileUploads", "file:attachment", "record:references{polymorphic}", "scan_status:string"
+        generate :migration, "CreateFileUploads", "file:attachment", "record:references{polymorphic}", "scan_status:string", inline: true
         migration_file = Dir.glob(File.expand_path(File.join("db", "migrate", "[0-9]*_*.rb"), destination_root)).grep(/\d+_create_file_uploads.rb$/).first
         unless migration_file.nil?
           gsub_file migration_file, ":scan_status", ":scan_status, null: false, default: \"uploaded\""
@@ -54,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/circleci/circleci_generator.rb

@@ -14,7 +14,10 @@ module RailsTemplate18f
       DESC
 
       def install_needed_gems
-        gem "rspec_junit_formatter", "~> 0.5", group: :test
+        gem_name = "rspec_junit_formatter"
+        return if gem_installed? gem_name
+        gem gem_name, "~> 0.5", group: :test
+        bundle_install
       end
 
       def install_pipeline

data/lib/generators/rails_template18f/cloud_gov_config/cloud_gov_config_generator.rb

@@ -13,10 +13,11 @@ module RailsTemplate18f
       DESC
 
       def install_climate_control
-        return if file_content("Gemfile").match?(/gem "climate_control"/)
+        return if gem_installed?("climate_control")
         gem_group :test do
           gem "climate_control", "~> 1.0"
         end
+        bundle_install
       end
 
       def install_model_and_test

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rails/generators"
-require "bundler"
 
 module RailsTemplate18f
   module Generators
@@ -16,17 +15,17 @@ module RailsTemplate18f
           Always installs configuration for English
       DESC
 
-      def install_helper_gem_and_tasks
-        return if file_content("Gemfile").match?(/gem "i18n-tasks"/)
+      def install_gem
+        return if gem_installed?("i18n-tasks")
         gem_group :development, :test do
           gem "i18n-tasks", "~> 0.9"
         end
-        Bundler.with_original_env do
-          in_root do
-            run "bundle install"
-            run "cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/"
-            run "cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/"
-          end
+      end
+
+      def install_helper_tasks
+        bundle_install do
+          run "cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/"
+          run "cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/"
         end
         insert_into_file "config/i18n-tasks.yml", "\n#{indent("- app/assets/builds", 4)}", after: "exclude:"
         uncomment_lines "config/i18n-tasks.yml", "ignore_missing:"

data/lib/generators/rails_template18f/i18n_js/i18n_js_generator.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rails/generators"
-require "bundler"
 
 module RailsTemplate18f
   module Generators
@@ -16,15 +15,15 @@ module RailsTemplate18f
       DESC
 
       def install_gem_and_tasks
-        return if file_content("Gemfile").match?(/gem "i18n-js"/)
+        return if gem_installed?("i18n-js")
         gem "i18n-js", "~> 3.9"
-        Bundler.with_original_env do
-          in_root do
-            run "bundle install"
-            run "yarn add i18n-js"
-            generate "i18n:js:config"
-          end
+        bundle_install do
+          run "yarn add i18n-js"
+          generate "i18n:js:config"
         end
+      end
+
+      def configure_translation_yaml
         append_to_file "config/i18n-js.yml", <<~EOYAML
           # remove `only` to include all translations
           translations:

data/lib/generators/rails_template18f/newrelic/newrelic_generator.rb

@@ -23,7 +23,9 @@ module RailsTemplate18f
       end
 
       def install_gem
+        return if gem_installed?("newrelic_rpm")
         gem "newrelic_rpm", "~> 8.4"
+        bundle_install
       end
 
       def install_config

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

@@ -13,7 +13,18 @@ module RailsTemplate18f
       DESC
 
       def install_gem
+        return if gem_installed?("sidekiq")
         gem "sidekiq", "~> 6.4"
+        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
@@ -38,7 +49,7 @@ module RailsTemplate18f
       end
 
       def configure_active_job
-        generate "rails_template18f:cloud_gov_config"
+        generate "rails_template18f:cloud_gov_config", inline: true
         copy_file "config/initializers/redis.rb"
         application "config.active_job.queue_adapter = :sidekiq"
       end

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/generators/base.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "bundler"
+
 module RailsTemplate18f
   module Generators
     module Base
@@ -20,6 +22,19 @@ module RailsTemplate18f
 
       private
 
+      def bundle_install
+        Bundler.with_original_env do
+          in_root do
+            run "bundle install"
+            yield if block_given?
+          end
+        end
+      end
+
+      def gem_installed?(gem_name)
+        file_content("Gemfile").match?(/gem "#{gem_name}"/)
+      end
+
       def file_content(filename)
         file_path = File.expand_path(filename, destination_root)
         if File.exist? file_path

data/lib/rails_template18f/version.rb

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

data/rails-template-18f.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "railties", "~> 7.0.0"
   spec.add_dependency "activesupport", "~> 7.0.0"
   spec.add_dependency "thor", "~> 1.0"
+  spec.add_dependency "colorize", "~> 0.8"
 
   spec.add_development_dependency "rspec", "~> 3.11"
   spec.add_development_dependency "ammeter", "~> 1.1"

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,15 +192,26 @@ 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"
 copy_file "githooks/pre-commit", ".githooks/pre-commit", mode: :preserve
 
 unless skip_git?
-  rails_command "credentials:diff --enroll"
+  after_bundle do
+    rails_command "credentials:diff --enroll"
+  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`
@@ -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.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -196,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
@@ -249,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Generators for creating an 18F-flavored Rails app