rails_template_18f 0.2.0 → 0.4.1

data/lib/rails_template18f/generators/base.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
+require "bundler"
+
 module RailsTemplate18f
   module Generators
     module Base
       extend ActiveSupport::Concern
       include ::Rails::Generators::AppName
 
-      included do
-        self.source_path = RailsTemplate18f::Generators.const_source_location(name).first
-      end
-
       class_methods do
         attr_accessor :source_path
 
@@ -18,19 +16,53 @@ module RailsTemplate18f
         end
       end
 
+      included do
+        self.source_path = RailsTemplate18f::Generators.const_source_location(name).first
+      end
+
       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.read(File.expand_path(filename, destination_root))
+        file_path = File.expand_path(filename, destination_root)
+        if File.exist? file_path
+          File.read(file_path)
+        else
+          ""
+        end
       end
 
       def ruby_version
         RUBY_VERSION
       end
 
+      def terraform_dir_exists?
+        Dir.exist? File.expand_path("terraform", destination_root)
+      end
+
       def skip_git?
         !Dir.exist?(File.expand_path(".git", destination_root))
       end
+
+      def has_active_job?
+        defined?(::ActiveJob)
+      end
+
+      def has_active_storage?
+        defined?(::ActiveStorage)
+      end
     end
   end
 end

data/lib/rails_template18f/generators/cloud_gov_options.rb

@@ -48,10 +48,6 @@ module RailsTemplate18f
         end
         "prod"
       end
-
-      def terraform_dir_exists?
-        Dir.exist? File.expand_path("terraform", destination_root)
-      end
     end
   end
 end

data/lib/rails_template18f/version.rb

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

data/rails-template-18f.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   # guide at: https://bundler.io/guides/creating_gem.html
   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

@@ -10,6 +10,10 @@ def skip_git?
   !!options[:skip_git]
 end
 
+def skip_active_job?
+  !!options[:skip_active_job]
+end
+
 def webpack?
   adjusted_javascript_option == "webpack"
 end
@@ -48,24 +52,24 @@ unless Gem::Dependency.new("rails", "~> 7.0.0").match?("rails", Rails.gem_versio
 end
 
 # ask setup questions
-@terraform = yes?("Create terraform files for cloud.gov services? (y/n)")
+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)")
 default_staging_space = "staging"
-@cloud_gov_staging_space = ask("What is your cloud.gov staging space name? (Default: #{default_staging_space})")
+cloud_gov_staging_space = ask("What is your cloud.gov staging space name? (Default: #{default_staging_space})")
 default_prod_space = "prod"
-@cloud_gov_production_space = ask("What is your cloud.gov production space name? (Default: #{default_prod_space})")
+cloud_gov_production_space = ask("What is your cloud.gov production space name? (Default: #{default_prod_space})")
 @cloud_gov_organization = "TKTK-cloud.gov-org-name" if @cloud_gov_organization.blank?
-@cloud_gov_staging_space = default_staging_space if @cloud_gov_staging_space.blank?
-@cloud_gov_production_space = default_prod_space if @cloud_gov_production_space.blank?
+cloud_gov_staging_space = default_staging_space if cloud_gov_staging_space.blank?
+cloud_gov_production_space = default_prod_space if cloud_gov_production_space.blank?
 
 @github_actions = yes?("Create Github Actions? (y/n)")
 @circleci_pipeline = yes?("Create CircleCI config? (y/n)")
-@newrelic = yes?("Create FEDRAMP New Relic config files? (y/n)")
-@dap = yes?("If this will be a public site, should we include Digital Analytics Program code? (y/n)")
-@supported_languages = [:en]
-@supported_languages.push(:es) if yes?("Add Spanish to supported locales, with starter es.yml? (y/n)")
-@supported_languages.push(:fr) if yes?("Add French to supported locales, with starter fr.yml? (y/n)")
-@supported_languages.push(:zh) if yes?("Add Simplified Chinese to supported locales, with starter zh.yml? (y/n)")
+newrelic = yes?("Create FEDRAMP New Relic config files? (y/n)")
+dap = yes?("If this will be a public site, should we include Digital Analytics Program code? (y/n)")
+supported_languages = []
+supported_languages.push(:es) if yes?("Add Spanish to supported locales, with starter es.yml? (y/n)")
+supported_languages.push(:fr) if yes?("Add French to supported locales, with starter fr.yml? (y/n)")
+supported_languages.push(:zh) if yes?("Add Simplified Chinese to supported locales, with starter zh.yml? (y/n)")
 
 running_node_version = `node --version`.gsub(/^v/, "").strip
 @node_version = ask("What version of NodeJS are you using? (Default: #{running_node_version})")
@@ -168,24 +172,13 @@ uncomment_lines csp_initializer, "Rails.application"
 uncomment_lines csp_initializer, /end$/
 uncomment_lines csp_initializer, "content_security_policy_nonce"
 
-if @newrelic
-  after_bundle do
-    generate "rails_template18f:newrelic"
-  end
-  register_announcement("New Relic", <<~EOM)
-    A New Relic config file has been written to `config/newrelic.yml`
-
-    See instructions in README to get started sending data to New Relic
-  EOM
-end
-
+# install development & testing gems
 gem_group :development, :test do
   gem "rspec-rails", "~> 5.1"
   gem "dotenv-rails", "~> 2.7"
   gem "brakeman", "~> 5.2"
   gem "bundler-audit", "~> 0.9"
   gem "standard", "~> 1.7"
-  gem "i18n-tasks", "~> 0.9"
 end
 if ENV["RT_DEV"] == "true"
   gem "rails_template_18f", group: :development, path: ENV["PWD"]
@@ -198,7 +191,9 @@ 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 local dotenv overrides
@@ -213,27 +208,7 @@ unless skip_git?
   EOM
 end
 
-# Setup translations
-@supported_languages.each do |language|
-  template "config/locales/#{language}.yml", force: true
-end
-application "config.i18n.available_locales = #{@supported_languages}"
-application "config.i18n.fallbacks = [:en]"
-after_bundle do
-  # Recommended by i18n-tasks
-  run "cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/"
-end
-insert_into_file "app/helpers/application_helper.rb", <<'EOH', before: /^end$/
-  def format_active_locale(locale_string)
-    link_classes = "usa-nav__link"
-    if locale_string.to_sym == I18n.locale
-      link_classes = "#{link_classes} usa-current"
-    end
-    link_to t("shared.languages.#{locale_string}"), root_path(locale: locale_string), class: link_classes
-  end
-EOH
-
-# setup USWDS
+# setup USWDS and asset pipeline
 copy_file "browserslistrc", ".browserslistrc" if webpack?
 uncomment_lines "Gemfile", "sassc-rails" # use sassc-rails for asset minification in prod
 after_bundle do
@@ -285,7 +260,7 @@ after_bundle do
     @import "uswds-settings.scss";
     @import "../../../node_modules/uswds/dist/scss/uswds.scss";
   EOCSS
-  gsub_file "app/views/layouts/application.html.erb", "<html>", "<html lang=\"en\">"
+  gsub_file "app/views/layouts/application.html.erb", "<html>", '<html lang="<%= I18n.locale %>">'
   gsub_file "app/views/layouts/application.html.erb", /^\s+<%= yield %>/, <<-EOHTML
     <%= render "application/usa_banner" %>
     <%= render "application/header" %>
@@ -300,32 +275,14 @@ end
 directory "app/views/application"
 
 after_bundle do
+  # install and configure RSpec
   generate "rspec:install"
   gsub_file "spec/spec_helper.rb", /^=(begin|end)$/, ""
 
-  # Setup the PagesController, locale routes, and home (root) route
+  # Setup the PagesController and home (root) route
   generate :controller, "pages", "home", "--skip-routes", "--no-helper", "--no-assets"
+  route "root 'pages#home'"
 
-  if @supported_languages.count > 1
-    locale_switching = <<~EOM
-      around_action :switch_locale
-
-      def switch_locale(&action)
-        locale = params[:locale] || I18n.default_locale
-        I18n.with_locale(locale, &action)
-      end
-    EOM
-    insert_into_file "app/controllers/application_controller.rb", locale_switching, before: /^end/
-
-    route <<-'EOM'
-      scope "(:locale)", locale: /#{I18n.available_locales.join('|')}/ do
-        # Your application routes here
-        root 'pages#home'
-      end
-    EOM
-  else
-    route "root 'pages#home'"
-  end
   gsub_file "spec/requests/pages_spec.rb", "/pages/home", "/"
   gsub_file "spec/views/pages/home.html.erb_spec.rb", "  pending \"add some examples to (or delete) \#{__FILE__}\"", <<-EOM
   it "displays the gov banner" do
@@ -334,26 +291,46 @@ after_bundle do
   end
   EOM
 
-  if run_db_setup
-    rails_command "db:create"
-    rails_command "db:migrate"
+  # Setup translations
+  generate "rails_template18f:i18n", "--languages=#{supported_languages.join(",")}", "--force"
+end
+
+# install ADRs and compliance documentation
+directory "doc"
+register_announcement("Documentation", <<~EOM)
+  * Include a short description of your application in doc/compliance/apps/application.boundary.md
+  * Remember to keep your Logical Data Model up to date in doc/compliance/apps/data.logical.md
+EOM
+
+if newrelic
+  after_bundle do
+    generate "rails_template18f:newrelic"
   end
+  register_announcement("New Relic", <<~EOM)
+    A New Relic config file has been written to `config/newrelic.yml`
+
+    See instructions in README to get started sending data to New Relic
+  EOM
+end
+
+if dap
+  after_bundle do
+    generate "rails_template18f:dap"
+  end
+  register_announcement("Digital Analytics Program", "Update the DAP agency code in app/views/layouts/application.html.erb")
 end
 
 # infrastructure & deploy
 template "manifest.yml"
 copy_file "lib/tasks/cf.rake"
 directory "config/deployment"
-after_bundle do
-  run "cp .gitignore .cfignore" unless skip_git?
-end
 
-if @terraform
+if terraform
   after_bundle do
     generator_arguments = [
       "--cg-org=#{@cloud_gov_organization}",
-      "--cg-staging=#{@cloud_gov_staging_space}",
-      "--cg-prod=#{@cloud_gov_production_space}"
+      "--cg-staging=#{cloud_gov_staging_space}",
+      "--cg-prod=#{cloud_gov_production_space}"
     ]
     generate "rails_template18f:terraform", *generator_arguments
   end
@@ -368,13 +345,25 @@ if @terraform
   register_announcement("Terraform", "Run the bootstrap script and update the appropriate CI/CD environment variables defined in the Deployment section of the README")
 end
 
+if !skip_active_job?
+  after_bundle do
+    generate "rails_template18f:sidekiq"
+  end
+end
+
+if !skip_active_storage?
+  after_bundle do
+    generate "rails_template18f:active_storage"
+  end
+end
+
 if @github_actions
   after_bundle do
     generator_arguments = [
-      (@terraform ? "--terraform" : "--no-terraform"),
+      (terraform ? "--terraform" : "--no-terraform"),
       "--cg-org=#{@cloud_gov_organization}",
-      "--cg-staging=#{@cloud_gov_staging_space}",
-      "--cg-prod=#{@cloud_gov_production_space}"
+      "--cg-staging=#{cloud_gov_staging_space}",
+      "--cg-prod=#{cloud_gov_production_space}"
     ]
     generate "rails_template18f:github_actions", *generator_arguments
   end
@@ -391,10 +380,10 @@ end
 if @circleci_pipeline
   after_bundle do
     generator_arguments = [
-      (@terraform ? "--terraform" : "--no-terraform"),
+      (terraform ? "--terraform" : "--no-terraform"),
       "--cg-org=#{@cloud_gov_organization}",
-      "--cg-staging=#{@cloud_gov_staging_space}",
-      "--cg-prod=#{@cloud_gov_production_space}"
+      "--cg-staging=#{cloud_gov_staging_space}",
+      "--cg-prod=#{cloud_gov_production_space}"
     ]
     generate "rails_template18f:circleci", *generator_arguments
   end
@@ -403,19 +392,6 @@ if @circleci_pipeline
   EOM
 end
 
-directory "doc"
-register_announcement("Documentation", <<~EOM)
-  * Include a short description of your application in doc/compliance/apps/application.boundary.md
-  * Remember to keep your Logical Data Model up to date in doc/compliance/apps/data.logical.md
-EOM
-
-if @dap
-  after_bundle do
-    generate "rails_template18f:dap"
-  end
-  register_announcement("Digital Analytics Program", "Update the DAP agency code in app/views/layouts/application.html.erb")
-end
-
 # setup production credentials file
 require "rails/generators"
 require "rails/generators/rails/encryption_key_file/encryption_key_file_generator"
@@ -444,6 +420,11 @@ EOM
 
 # ensure this is the very last step
 after_bundle do
+  if run_db_setup
+    rails_command "db:create"
+    rails_command "db:migrate"
+  end
+
   # x86_64-linux is required to install gems on any linux system such as cloud.gov or CI pipelines
   run "bundle lock --add-platform x86_64-linux"
 
@@ -453,10 +434,11 @@ after_bundle do
   run "bundle exec standardrb --fix"
 
   unless skip_git?
+    run "cp .gitignore .cfignore"
     git add: "."
     git commit: "-a -m 'Initial commit'"
   end
 
-  # Post-install announcement
+  # Post-install announcements
   print_announcements
 end

data/templates/config/deployment/staging.yml

@@ -1,3 +1,3 @@
 env: staging
 web_instances: 1
-web_memory: 512M
+web_memory: 256M

data/templates/config/environments/ci.rb

@@ -1,7 +1,6 @@
 require_relative "./production"
 
 Rails.application.configure do
-  config.assets.compile = true
   config.public_file_server.enabled = true
 
   logger = ActiveSupport::Logger.new($stdout)

data/templates/doc/compliance/apps/application.boundary.md.tt

@@ -30,15 +30,11 @@ Boundary(aws, "AWS GovCloud") {
             System_Boundary(inventory, "Application") {
                 Container(app, "<&layers> <%= app_name.titleize %>", "Ruby <%= @ruby_version %>, Rails <%= Rails.version %>", "TKTK Application Description")
                 ContainerDb(app_db, "Application DB", "AWS RDS (PostgreSQL)", "Primary data storage")
-                <% if !skip_active_storage? %>
-                ContainerDb(app_s3, "File Storage", "AWS S3", "User-uploaded file storage")
-                <% end %>
             }
         }
     }
 }
 
-
 Boundary(gsa_saas, "GSA-authorized SaaS") {
 }
 
@@ -49,9 +45,6 @@ Rel(browser, aws_alb, "request info, submit requests", "https GET/POST (443)")
 Rel(aws_alb, cloudgov_router, "proxies requests", "https GET/POST (443)")
 Rel(cloudgov_router, app, "proxies requests", "https GET/POST (443)")
 Rel(app, app_db, "reads/writes primary data", "psql (5432)")
-<% if !skip_active_storage? %>
-Rel(app, app_s3, "reads/writes file data", "https (443)")
-<% end %>
 @enduml
 ```
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_template_18f
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-16 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
@@ -83,7 +111,8 @@ dependencies:
 description:
 email:
 - ryan.ahearn@gsa.gov
-executables: []
+executables:
+- rails_template_18f
 extensions: []
 extra_rdoc_files: []
 files:
@@ -98,11 +127,21 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/rails_template_18f
+- lib/generators/rails_template18f/active_storage/active_storage_generator.rb
+- lib/generators/rails_template18f/active_storage/templates/app/jobs/file_scan_job.rb
+- lib/generators/rails_template18f/active_storage/templates/app/models/file_upload.rb
+- lib/generators/rails_template18f/active_storage/templates/doc/adr/clamav.md.tt
+- lib/generators/rails_template18f/active_storage/templates/spec/jobs/file_scan_job_spec.rb
+- lib/generators/rails_template18f/active_storage/templates/spec/models/file_upload_spec.rb
 - lib/generators/rails_template18f/circleci/circleci_generator.rb
 - lib/generators/rails_template18f/circleci/templates/Dockerfile.tt
 - lib/generators/rails_template18f/circleci/templates/bin/ci-server-start
 - lib/generators/rails_template18f/circleci/templates/circleci/config.yml.tt
 - lib/generators/rails_template18f/circleci/templates/docker-compose.ci.yml
+- lib/generators/rails_template18f/cloud_gov_config/cloud_gov_config_generator.rb
+- lib/generators/rails_template18f/cloud_gov_config/templates/app/models/cloud_gov_config.rb
+- lib/generators/rails_template18f/cloud_gov_config/templates/spec/models/cloud_gov_config_spec.rb
 - lib/generators/rails_template18f/dap/dap_generator.rb
 - lib/generators/rails_template18f/github_actions/github_actions_generator.rb
 - lib/generators/rails_template18f/github_actions/templates/github/actions/run-server/action.yml
@@ -118,8 +157,17 @@ files:
 - lib/generators/rails_template18f/github_actions/templates/github/workflows/rspec.yml.tt
 - lib/generators/rails_template18f/github_actions/templates/github/workflows/terraform-production.yml
 - lib/generators/rails_template18f/github_actions/templates/github/workflows/terraform-staging.yml
+- lib/generators/rails_template18f/i18n/i18n_generator.rb
+- lib/generators/rails_template18f/i18n/templates/config/locales/en.yml.tt
+- lib/generators/rails_template18f/i18n/templates/config/locales/es.yml
+- lib/generators/rails_template18f/i18n/templates/config/locales/fr.yml
+- lib/generators/rails_template18f/i18n/templates/config/locales/zh.yml
+- lib/generators/rails_template18f/i18n_js/i18n_js_generator.rb
+- lib/generators/rails_template18f/i18n_js/templates/lib/tasks/i18n.rake
 - lib/generators/rails_template18f/newrelic/newrelic_generator.rb
 - lib/generators/rails_template18f/newrelic/templates/config/newrelic.yml.tt
+- lib/generators/rails_template18f/sidekiq/sidekiq_generator.rb
+- lib/generators/rails_template18f/sidekiq/templates/config/initializers/redis.rb
 - lib/generators/rails_template18f/terraform/templates/terraform/README.md.tt
 - lib/generators/rails_template18f/terraform/templates/terraform/bootstrap/import.sh
 - lib/generators/rails_template18f/terraform/templates/terraform/bootstrap/main.tf.tt
@@ -132,12 +180,18 @@ files:
 - lib/generators/rails_template18f/terraform/templates/terraform/production/main.tf.tt
 - lib/generators/rails_template18f/terraform/templates/terraform/production/providers.tf.tt
 - lib/generators/rails_template18f/terraform/templates/terraform/production/variables.tf
+- lib/generators/rails_template18f/terraform/templates/terraform/shared/clamav/main.tf.tt
+- lib/generators/rails_template18f/terraform/templates/terraform/shared/clamav/providers.tf
+- lib/generators/rails_template18f/terraform/templates/terraform/shared/clamav/variables.tf
 - lib/generators/rails_template18f/terraform/templates/terraform/shared/database/main.tf.tt
 - lib/generators/rails_template18f/terraform/templates/terraform/shared/database/providers.tf
 - lib/generators/rails_template18f/terraform/templates/terraform/shared/database/variables.tf
 - lib/generators/rails_template18f/terraform/templates/terraform/shared/domain/main.tf.tt
 - lib/generators/rails_template18f/terraform/templates/terraform/shared/domain/providers.tf
 - lib/generators/rails_template18f/terraform/templates/terraform/shared/domain/variables.tf
+- lib/generators/rails_template18f/terraform/templates/terraform/shared/redis/main.tf.tt
+- lib/generators/rails_template18f/terraform/templates/terraform/shared/redis/providers.tf
+- lib/generators/rails_template18f/terraform/templates/terraform/shared/redis/variables.tf
 - lib/generators/rails_template18f/terraform/templates/terraform/shared/s3/main.tf
 - lib/generators/rails_template18f/terraform/templates/terraform/shared/s3/providers.tf
 - lib/generators/rails_template18f/terraform/templates/terraform/shared/s3/variables.tf
@@ -145,6 +199,7 @@ files:
 - lib/generators/rails_template18f/terraform/templates/terraform/staging/providers.tf.tt
 - lib/generators/rails_template18f/terraform/templates/terraform/staging/variables.tf
 - lib/generators/rails_template18f/terraform/terraform_generator.rb
+- lib/rails_template18f/app_updater.rb
 - lib/rails_template18f/generators.rb
 - lib/rails_template18f/generators/base.rb
 - lib/rails_template18f/generators/cloud_gov_options.rb
@@ -170,10 +225,6 @@ files:
 - templates/config/deployment/staging.yml
 - templates/config/environments/ci.rb
 - templates/config/environments/staging.rb
-- templates/config/locales/en.yml.tt
-- templates/config/locales/es.yml
-- templates/config/locales/fr.yml
-- templates/config/locales/zh.yml
 - templates/doc/adr/0001-record-architecture-decisions.md.tt
 - templates/doc/adr/0002-initial-architecture-decisions.md.tt
 - templates/doc/adr/0003-security-scans.md.tt
@@ -212,7 +263,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