rails_template_18f 0.2.0 → 0.4.1

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RailsTemplate18f
+  module Generators
+    class I18nGenerator < ::Rails::Generators::Base
+      include Base
+
+      class_option :languages, default: "es,fr,zh", desc: "Comma separated list of supported language short codes"
+
+      desc <<~DESC
+        Description:
+          Install translation framework and configuration for given languages.
+          Always installs configuration for English
+      DESC
+
+      def install_gem
+        return if gem_installed?("i18n-tasks")
+        gem_group :development, :test do
+          gem "i18n-tasks", "~> 0.9"
+        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:"
+        insert_into_file "config/i18n-tasks.yml", indent(<<~EOM), after: "ignore_missing:\n"
+          - 'shared.languages.*'
+          - 'shared.header.{title,close,demo_banner,menu}'
+        EOM
+      end
+
+      def install_translations
+        inside "config/locales" do
+          template "en.yml"
+          languages.each do |lang|
+            copy_file "#{lang}.yml"
+          end
+        end
+      end
+
+      def configure_i18n
+        application "config.i18n.fallbacks = [:en]"
+        available_regex = /^(\s*config.i18n.available_locales).*$/
+        if file_content("config/application.rb").match?(available_regex)
+          gsub_file "config/application.rb", available_regex, "\\1 = #{supported_languages}"
+        else
+          application "config.i18n.available_locales = #{supported_languages}"
+        end
+      end
+
+      def install_nav_helper
+        inject_into_module "app/helpers/application_helper.rb", "ApplicationHelper", indent(<<~'EOH')
+          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
+      end
+
+      def install_around_action
+        return if languages.empty?
+        inject_into_class "app/controllers/application_controller.rb", "ApplicationController", indent(<<~EOM)
+          around_action :switch_locale
+
+          def switch_locale(&action)
+            locale = params[:locale] || I18n.default_locale
+            I18n.with_locale(locale, &action)
+          end
+        EOM
+      end
+
+      def install_route
+        return if languages.empty?
+        return if file_content("config/routes.rb").match?(/scope "\(:locale\)"/)
+        regex = /(^.+\.routes\.draw do\s*$)\n(.*)^end$/m
+        gsub_file "config/routes.rb", regex, <<~'EOR'
+          \1
+            scope "(:locale)", locale: /#{I18n.available_locales.join("|")}/ do
+              # Your application routes go here
+              \2
+            end
+          end
+        EOR
+      end
+
+      private
+
+      def supported_languages
+        @supported_languages ||= [:en, *languages]
+      end
+
+      def languages
+        @languages ||= options[:languages].split(",").map(&:to_sym)
+      end
+    end
+  end
+end

data/{templates → lib/generators/rails_template18f/i18n/templates}/config/locales/en.yml.tt

@@ -12,11 +12,11 @@ en:
       secure_heading: Secure .gov websites use HTTPS
       us_flag: U.S. Flag
     header:
-      title: <%= app_name.titleize %>
-      menu: Menu
       close: Close
-      primary: Primary navigation
       demo_banner: TEST SITE - Do not use real personal information (demo purposes only) - TEST SITE
+      menu: Menu
+      primary: Primary navigation
+      title: <%= app_name.titleize %>
     languages:
       en: English
       es: Español

data/{templates → lib/generators/rails_template18f/i18n/templates}/config/locales/es.yml

@@ -12,8 +12,8 @@ es:
       secure_heading: Los sitios web seguros .gov usan HTTPS
       us_flag: Bandera de Estados Unidos
     header:
-      menu: Menú
       close: Cerrar
-      primary: Navegacion primaria
       demo_banner: SITIO DE PRUEBA - No utilice información personal real (sólo para propósitos de demostración) - SITIO DE PRUEBA
-    skip_link: Salte al contenido principal
+      menu: Menú
+      primary: Navegacion primaria
+    skip_link: Salte al contenido principal

data/{templates → lib/generators/rails_template18f/i18n/templates}/config/locales/fr.yml

@@ -8,15 +8,12 @@ fr:
       lock: Verrou
       locked_padlock: Verrou fermé
       official_site: Un site web officiel du gouvernement des États-Unis
-      secure_description_html: Un <strong>verrou</strong> (%{lock_icon}) ou
-        <strong>https://</strong> signifie que vous êtes connecté en toute
-        sécurité au site Web .gov. Partagez des informations sensibles
-        uniquement sur des sites Web officiels et sécurisés.
+      secure_description_html: Un <strong>verrou</strong> (%{lock_icon}) ou <strong>https://</strong> signifie que vous êtes connecté en toute sécurité au site Web .gov. Partagez des informations sensibles uniquement sur des sites Web officiels et sécurisés.
       secure_heading: Les sites Web sécurisés .gov utilisent HTTPS
       us_flag: Drapeau américain
     header:
-      menu: Menu
       close: Fermer
-      primary: Navigation primaire
       demo_banner: SITE DE TEST - N’utilisez pas de véritables données personnelles (il s’agit d’une démonstration seulement) - SITE DE TEST
+      menu: Menu
+      primary: Navigation primaire
     skip_link: Passer au contenu principal

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RailsTemplate18f
+  module Generators
+    class I18nJsGenerator < ::Rails::Generators::Base
+      include Base
+
+      desc <<~DESC
+        Description:
+          Install and configure i18n-js gem to provide translations to JS code.
+
+          By default, will only export translations with keys that match `*.js.*`
+      DESC
+
+      def install_gem_and_tasks
+        return if gem_installed?("i18n-js")
+        gem "i18n-js", "~> 3.9"
+        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:
+            - file: "app/assets/builds/translations.js"
+              only: "*.js.*"
+        EOYAML
+      end
+
+      def configure_asset_pipeline
+        copy_file "lib/tasks/i18n.rake"
+        environment "config.middleware.use I18n::JS::Middleware", env: :development
+        insert_into_file "app/views/layouts/application.html.erb", indent(<<~EOHTML, 4), after: /<%= stylesheet_link_tag "application".*$\n/
+          <%= javascript_include_tag "i18n", "data-turbo-track": "reload" %>
+          <%= javascript_include_tag "translations", "data-turbo-track": "reload" %>
+        EOHTML
+        append_to_file "app/assets/config/manifest.js", <<~EOJS
+          //= link i18n.js
+          //= link translations.js
+        EOJS
+      end
+
+      def ignore_generated_file
+        unless skip_git?
+          append_to_file ".gitignore", <<~EOM
+
+            # Generated by i18n-js
+            /public/javascripts/i18n.js
+          EOM
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails_template18f/i18n_js/templates/lib/tasks/i18n.rake

@@ -0,0 +1,9 @@
+# export translations as part of asset precompile
+
+Rake::Task["assets:precompile"].enhance(["i18n:js:export"])
+
+if Rake::Task.task_defined?("test:prepare")
+  Rake::Task["test:prepare"].enhance(["i18n:js:export"])
+elsif Rake::Task.task_defined?("db:test:prepare")
+  Rake::Task["db:test:prepare"].enhance(["i18n:js:export"])
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RailsTemplate18f
+  module Generators
+    class SidekiqGenerator < ::Rails::Generators::Base
+      include Base
+
+      desc <<~DESC
+        Description:
+          Install Sidekiq and configure it as the ActiveJob backend
+      DESC
+
+      def install_gem
+        return if gem_installed?("sidekiq")
+        gem "sidekiq", "~> 6.4"
+        bundle_install
+      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/
+          - type: worker
+            instances: ((worker_instances))
+            memory: ((worker_memory))
+            command: bundle exec sidekiq
+        EOYAML
+        insert_into_file "manifest.yml", "\n  - #{app_name}-redis-((env))", after: "services:"
+        inside "config/deployment" do
+          append_to_file "staging.yml", <<~EOYAML
+            worker_instances: 1
+            worker_memory: 256M
+          EOYAML
+          append_to_file "production.yml", <<~EOYAML
+            worker_instances: 1
+            worker_memory: 512M
+          EOYAML
+        end
+      end
+
+      def configure_active_job
+        generate "rails_template18f:cloud_gov_config", inline: true
+        copy_file "config/initializers/redis.rb"
+        application "config.active_job.queue_adapter = :sidekiq"
+      end
+
+      def configure_sidekiq_ui
+        prepend_to_file "config/routes.rb", "require \"sidekiq/web\"\n\n"
+        route <<~EOR
+          if Rails.env.development?
+            mount Sidekiq::Web => "/sidekiq"
+          end
+        EOR
+      end
+
+      def update_boundary_diagram
+        boundary_filename = "doc/compliance/apps/application.boundary.md"
+
+        insert_into_file boundary_filename, indent(<<~EOB, 16), after: /ContainerDb\(app_db.*$\n/
+          Container(worker, "<&layers> Sidekiq workers", "Ruby #{ruby_version}, Sidekiq", "Perform background work and data processing")
+          ContainerDb(redis, "Redis Database", "AWS ElastiCache (Redis)", "Background job queue")
+        EOB
+        insert_into_file boundary_filename, <<~EOB, before: "@enduml"
+          Rel(app, redis, "enqueue job parameters", "redis")
+          Rel(worker, redis, "dequeues job parameters", "redis")
+          Rel(worker, app_db, "reads/writes primary data", "psql (5432)")
+        EOB
+      end
+    end
+  end
+end

data/lib/generators/rails_template18f/sidekiq/templates/config/initializers/redis.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+Rails.application.config.to_prepare do
+  redis_url = CloudGovConfig.dig "aws-elasticache-redis", "credentials", "uri"
+  if redis_url.present?
+    Sidekiq.configure_server do |config|
+      config.redis = {url: redis_url, ssl: true}
+    end
+
+    Sidekiq.configure_client do |config|
+      config.redis = {url: redis_url, ssl: true}
+    end
+  end
+end

data/lib/generators/rails_template18f/terraform/templates/terraform/production/main.tf.tt

@@ -16,17 +16,49 @@ module "database" {
   recursive_delete = local.recursive_delete
   rds_plan_name    = "TKTK-production-rds-plan"
 }
+<% if has_active_job? %>
+module "redis" {
+  source = "../shared/redis"
 
+  cf_user          = var.cf_user
+  cf_password      = var.cf_password
+  cf_org_name      = local.cf_org_name
+  cf_space_name    = local.cf_space_name
+  env              = local.env
+  recursive_delete = local.recursive_delete
+  redis_plan_name  = "TKTK-production-redis-plan"
+}
+<% end %>
 <% if has_active_storage? %>
 module "s3" {
   source = "../shared/s3"
 
-  cf_user         = var.cf_user
-  cf_password     = var.cf_password
-  cf_org_name     = local.cf_org_name
-  cf_space_name   = local.cf_space_name
-  s3_service_name = "<%= app_name %>-s3-${local.env}"
+  cf_user          = var.cf_user
+  cf_password      = var.cf_password
+  cf_org_name      = local.cf_org_name
+  cf_space_name    = local.cf_space_name
+  recursive_delete = local.recursive_delete
+  s3_service_name  = "<%= app_name %>-s3-${local.env}"<% if cloud_gov_organization == "sandbox-gsa" %>
+  s3_plan_name     = "basic-sandbox"<% end %>
 }
+
+###########################################################################
+# The following lines need to be commented out for the initial `terraform apply`
+# It can be re-enabled after:
+# 1) the app has first been deployed
+# 2) Your organization has sufficient memory. Each clamav app requires 3GB
+###########################################################################
+# module "clamav" {
+#   source = "../shared/clamav"
+#
+#   cf_user       = var.cf_user
+#   cf_password   = var.cf_password
+#   cf_org_name   = local.cf_org_name
+#   cf_space_name = local.cf_space_name
+#   env           = local.env
+#   clamav_image  = "ajilaag/clamav-rest:20211229"
+#   max_file_size = "30M"
+# }
 <% end %>
 
 ###########################################################################

data/lib/generators/rails_template18f/terraform/templates/terraform/shared/clamav/main.tf.tt

@@ -0,0 +1,50 @@
+###
+# Target space/org
+###
+
+data "cloudfoundry_space" "space" {
+  org_name = var.cf_org_name
+  name     = var.cf_space_name
+}
+
+data "cloudfoundry_domain" "internal" {
+  name = "apps.internal"
+}
+
+data "cloudfoundry_app" "app" {
+  name_or_id = "<%= app_name %>-${var.env}"
+  space = data.cloudfoundry_space.space.id
+}
+
+###
+# ClamAV API app
+###
+
+resource "cloudfoundry_route" "clamav_route" {
+  space    = data.cloudfoundry_space.space.id
+  domain   = data.cloudfoundry_domain.internal.id
+  hostname = "<%= app_name %>-clamapi-${var.env}"
+}
+
+resource "cloudfoundry_app" "clamav_api" {
+  name         = "<%= app_name %>-clamav-api-${var.env}"
+  space        = data.cloudfoundry_space.space.id
+  memory       = var.clamav_memory
+  disk_quota   = 2048
+  timeout      = 600
+  docker_image = var.clamav_image
+  routes {
+    route = cloudfoundry_route.clamav_route.id
+  }
+  environment = {
+    MAX_FILE_SIZE = var.max_file_size
+  }
+}
+
+resource "cloudfoundry_network_policy" "clamav_routing" {
+  policy {
+    source_app      = data.cloudfoundry_app.app.id
+    destination_app = cloudfoundry_app.clamav_api.id
+    port            = "9443"
+  }
+}

data/lib/generators/rails_template18f/terraform/templates/terraform/shared/clamav/providers.tf

@@ -0,0 +1,16 @@
+terraform {
+  required_version = "~> 1.0"
+  required_providers {
+    cloudfoundry = {
+      source  = "cloudfoundry-community/cloudfoundry"
+      version = "0.15.0"
+    }
+  }
+}
+
+provider "cloudfoundry" {
+  api_url      = var.cf_api_url
+  user         = var.cf_user
+  password     = var.cf_password
+  app_logs_max = 30
+}

data/lib/generators/rails_template18f/terraform/templates/terraform/shared/clamav/variables.tf

@@ -0,0 +1,47 @@
+variable "cf_api_url" {
+  type        = string
+  description = "cloud.gov api url"
+  default     = "https://api.fr.cloud.gov"
+}
+
+variable "cf_user" {
+  type        = string
+  description = "cloud.gov deployer account user"
+}
+
+variable "cf_password" {
+  type        = string
+  description = "secret; cloud.gov deployer account password"
+  sensitive   = true
+}
+
+variable "cf_org_name" {
+  type        = string
+  description = "cloud.gov organization name"
+}
+
+variable "cf_space_name" {
+  type        = string
+  description = "cloud.gov space name (staging or prod)"
+}
+
+variable "env" {
+  type        = string
+  description = "deployment environment (staging, production)"
+}
+
+variable "clamav_image" {
+  type        = string
+  description = "Docker image to deploy the clamav api app"
+}
+
+variable "clamav_memory" {
+  type        = number
+  description = "Memory in MB to allocate to clamav app"
+  default     = 3072
+}
+
+variable "max_file_size" {
+  type        = string
+  description = "Maximum file size the API will accept for scanning"
+}

data/lib/generators/rails_template18f/terraform/templates/terraform/shared/redis/main.tf.tt

@@ -0,0 +1,23 @@
+###
+# Target space/org
+###
+
+data "cloudfoundry_space" "space" {
+  org_name = var.cf_org_name
+  name     = var.cf_space_name
+}
+
+###
+# RDS instance
+###
+
+data "cloudfoundry_service" "redis" {
+  name = "aws-elasticache-redis"
+}
+
+resource "cloudfoundry_service_instance" "redis" {
+  name             = "<%= app_name %>-redis-${var.env}"
+  space            = data.cloudfoundry_space.space.id
+  service_plan     = data.cloudfoundry_service.redis.service_plans[var.redis_plan_name]
+  recursive_delete = var.recursive_delete
+}

data/lib/generators/rails_template18f/terraform/templates/terraform/shared/redis/providers.tf

@@ -0,0 +1,16 @@
+terraform {
+  required_version = "~> 1.0"
+  required_providers {
+    cloudfoundry = {
+      source  = "cloudfoundry-community/cloudfoundry"
+      version = "0.15.0"
+    }
+  }
+}
+
+provider "cloudfoundry" {
+  api_url      = var.cf_api_url
+  user         = var.cf_user
+  password     = var.cf_password
+  app_logs_max = 30
+}

data/lib/generators/rails_template18f/terraform/templates/terraform/shared/redis/variables.tf

@@ -0,0 +1,42 @@
+variable "cf_api_url" {
+  type        = string
+  description = "cloud.gov api url"
+  default     = "https://api.fr.cloud.gov"
+}
+
+variable "cf_user" {
+  type        = string
+  description = "cloud.gov deployer account user"
+}
+
+variable "cf_password" {
+  type        = string
+  description = "secret; cloud.gov deployer account password"
+  sensitive   = true
+}
+
+variable "cf_org_name" {
+  type        = string
+  description = "cloud.gov organization name"
+}
+
+variable "cf_space_name" {
+  type        = string
+  description = "cloud.gov space name (staging or prod)"
+}
+
+variable "env" {
+  type        = string
+  description = "deployment environment (staging, production)"
+}
+
+variable "recursive_delete" {
+  type        = bool
+  description = "when true, deletes service bindings attached to the resource (not recommended for production)"
+  default     = false
+}
+
+variable "redis_plan_name" {
+  type        = string
+  description = "name of the service plan name to create"
+}

data/lib/generators/rails_template18f/terraform/templates/terraform/staging/main.tf.tt

@@ -16,15 +16,47 @@ module "database" {
   recursive_delete = local.recursive_delete
   rds_plan_name    = "micro-psql"
 }
+<% if has_active_job? %>
+module "redis" {
+  source = "../shared/redis"
 
+  cf_user          = var.cf_user
+  cf_password      = var.cf_password
+  cf_org_name      = local.cf_org_name
+  cf_space_name    = local.cf_space_name
+  env              = local.env
+  recursive_delete = local.recursive_delete
+  redis_plan_name  = "redis-dev"
+}
+<% end %>
 <% if has_active_storage? %>
 module "s3" {
   source = "../shared/s3"
 
-  cf_user         = var.cf_user
-  cf_password     = var.cf_password
-  cf_org_name     = local.cf_org_name
-  cf_space_name   = local.cf_space_name
-  s3_service_name = "<%= app_name %>-s3-${local.env}"
+  cf_user          = var.cf_user
+  cf_password      = var.cf_password
+  cf_org_name      = local.cf_org_name
+  cf_space_name    = local.cf_space_name
+  recursive_delete = local.recursive_delete
+  s3_service_name  = "<%= app_name %>-s3-${local.env}"<% if cloud_gov_organization == "sandbox-gsa" %>
+  s3_plan_name     = "basic-sandbox"<% end %>
 }
+
+###########################################################################
+# The following lines need to be commented out for the initial `terraform apply`
+# It can be re-enabled after:
+# 1) the app has first been deployed
+# 2) Your organization has sufficient memory. Each clamav app requires 3GB
+###########################################################################
+# module "clamav" {
+#   source = "../shared/clamav"
+#
+#   cf_user       = var.cf_user
+#   cf_password   = var.cf_password
+#   cf_org_name   = local.cf_org_name
+#   cf_space_name = local.cf_space_name
+#   env           = local.env
+#   clamav_image  = "ajilaag/clamav-rest:20211229"
+#   max_file_size = "30M"
+# }
 <% end %>

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

@@ -79,17 +79,6 @@ module RailsTemplate18f
           EOM
         end
       end
-
-      private
-
-      def terraform_dir_exists?
-        # prevents cloud_gov_* helpers from trying to read non-existant .tf files
-        false
-      end
-
-      def has_active_storage?
-        defined?(::ActiveStorage)
-      end
     end
   end
 end

data/lib/rails_template18f/app_updater.rb

@@ -0,0 +1,19 @@
+require "rails/app_updater"
+
+module AppUpdaterOptions
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def generator_options
+      options = super
+      # These options all end up hardcoded to true in the default `rails app:update`
+      options[:skip_active_job] = !defined?(ActiveJob::Railtie)
+      options[:skip_action_mailbox] = !defined?(ActionMailbox::Engine)
+      options[:skip_action_text] = !defined?(ActionText::Engine)
+      options[:skip_test] = !defined?(Rails::TestUnitRailtie)
+      options
+    end
+  end
+end
+
+Rails::AppUpdater.prepend(AppUpdaterOptions)