├── .prettierignore
├── .rubocop.yml
├── Dockerfile
├── Procfile.dev
├── README.md
├── adr
    └── 00001-record-architecture-decisions.md
├── app
    ├── assets
    │   ├── config
    │   │   └── manifest.js
    │   └── stylesheets
    │   │   └── application.sass.scss
    ├── controllers
    │   └── errors_controller.rb
    ├── javascript
    │   └── application.js
    └── views
    │   ├── errors
    │       ├── internal_server_error.html.erb
    │       ├── not_found.html.erb
    │       ├── too_many_requests.html.erb
    │       └── unprocessable_entity.html.erb
    │   ├── layouts
    │       └── application.html.erb
    │   └── pages
    │       └── home.html.erb
├── bin
    ├── bundle
    └── lint
├── config
    ├── initializers
    │   ├── govuk_formbuilder.rb
    │   └── semantic_logger.rb
    └── locales
    │   └── en.yml
├── dependabot.yml
├── docker-compose.yml
├── dockerignore
├── gitignore
├── solargraph.yml
├── template.rb
├── templates
    ├── adr.rb
    ├── asdf.rb
    ├── docker_compose.rb
    ├── errors.rb
    ├── linting.rb
    ├── readme.rb
    ├── semantic_logger.rb
    ├── solargraph.rb
    └── yarn.rb
├── tool-versions
└── yarnrc.yml


/.prettierignore:
--------------------------------------------------------------------------------
 1 | *.enc
 2 | *.ico
 3 | *.key
 4 | *.lock
 5 | *.log
 6 | *.png
 7 | *.slim
 8 | *.svg
 9 | *.txt
10 | *.woff*
11 | .bundle
12 | .gitattributes
13 | .gitignore
14 | .keep
15 | .prettierignore
16 | .rladr
17 | .rspec
18 | .ruby-version
19 | .tool-versions
20 | Dockerfile
21 | LICENCE
22 | Procfile
23 | Procfile.*
24 | app/assets/builds
25 | bin/dev
26 | data
27 | db/*.sqlite3
28 | db/schema.rb
29 | log
30 | public/assets
31 | storage
32 | tmp
33 | vendor
34 | 


--------------------------------------------------------------------------------
/.rubocop.yml:
--------------------------------------------------------------------------------
 1 | inherit_gem:
 2 |   rubocop-govuk:
 3 |     - config/default.yml
 4 |     - config/rails.yml
 5 | 
 6 | inherit_from:
 7 |   - node_modules/@prettier/plugin-ruby/rubocop.yml
 8 | 
 9 | inherit_mode:
10 |   merge:
11 |     - Exclude
12 | 
13 | Style/NumericLiterals:
14 |   Exclude:
15 |     - db/schema.rb
16 | 


--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
 1 | # This template builds two images, to optimise caching:
 2 | # builder: builds gems and node modules
 3 | # production: runs the actual app
 4 | 
 5 | # Build builder image
 6 | FROM ruby:3.2.2-alpine as builder
 7 | 
 8 | # RUN apk -U upgrade && \
 9 | #     apk add --update --no-cache gcc git libc6-compat libc-dev make nodejs \
10 | #     postgresql13-dev yarn
11 | 
12 | WORKDIR /app
13 | 
14 | # Add the timezone (builder image) as it's not configured by default in Alpine
15 | RUN apk add --update --no-cache tzdata && \
16 |     cp /usr/share/zoneinfo/Europe/London /etc/localtime && \
17 |     echo "Europe/London" > /etc/timezone
18 | 
19 | # build-base: dependencies for bundle
20 | # yarn: node package manager
21 | # postgresql-dev: postgres driver and libraries
22 | RUN apk add --no-cache build-base yarn postgresql13-dev
23 | 
24 | # Install gems defined in Gemfile
25 | COPY .ruby-version Gemfile Gemfile.lock ./
26 | 
27 | # Install gems and remove gem cache
28 | RUN bundler -v && \
29 |     bundle config set no-cache 'true' && \
30 |     bundle config set no-binstubs 'true' && \
31 |     bundle config set without 'development test' && \
32 |     bundle install --retry=5 --jobs=4 && \
33 |     rm -rf /usr/local/bundle/cache
34 | 
35 | # Install node packages defined in package.json
36 | COPY package.json yarn.lock ./
37 | RUN yarn install --immutable
38 | 
39 | # Copy all files to /app (except what is defined in .dockerignore)
40 | COPY . .
41 | 
42 | # Precompile assets
43 | RUN RAILS_ENV=production SECRET_KEY_BASE=required-to-run-but-not-used \
44 |     bundle exec rails assets:precompile
45 | 
46 | # Cleanup to save space in the production image
47 | RUN rm -rf node_modules log/* tmp/* /tmp && \
48 |     rm -rf /usr/local/bundle/cache && \
49 |     rm -rf .env && \
50 |     find /usr/local/bundle/gems -name "*.c" -delete && \
51 |     find /usr/local/bundle/gems -name "*.h" -delete && \
52 |     find /usr/local/bundle/gems -name "*.o" -delete && \
53 |     find /usr/local/bundle/gems -name "*.html" -delete
54 | 
55 | # Build runtime image
56 | FROM ruby:3.2.2-alpine as production
57 | 
58 | # The application runs from /app
59 | WORKDIR /app
60 | 
61 | # Add the timezone (prod image) as it's not configured by default in Alpine
62 | RUN apk add --update --no-cache tzdata && \
63 |     cp /usr/share/zoneinfo/Europe/London /etc/localtime && \
64 |     echo "Europe/London" > /etc/timezone
65 | 
66 | # libpq: required to run postgres
67 | RUN apk add --no-cache libpq
68 | 
69 | # Copy files generated in the builder image
70 | COPY --from=builder /app /app
71 | COPY --from=builder /usr/local/bundle/ /usr/local/bundle/
72 | 
73 | CMD bundle exec rails db:migrate && \
74 |     bundle exec rails server -b 0.0.0.0
75 | 


--------------------------------------------------------------------------------
/Procfile.dev:
--------------------------------------------------------------------------------
1 | web: bin/rails server -p 3000
2 | js: yarn build --watch
3 | css: yarn build:css --watch
4 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Rails 8 application template
  2 | 
  3 | [DFE-Digital/rails-template](https://guides.rubyonrails.org/rails_application_templates.html)
  4 | is a [Rails application
  5 | template](https://guides.rubyonrails.org/rails_application_templates.html) that
  6 | makes starting a new GOV.UK Rails project fast and fun.
  7 | 
  8 | ## What's included
  9 | 
 10 | - [GOV.UK Frontend 5.8.0](https://github.com/alphagov/govuk-frontend)
 11 | - [GOV.UK Components](https://govuk-components.netlify.app/)
 12 | - [GOV.UK Form Builder](https://govuk-form-builder.netlify.app/)
 13 | - [RSpec](https://rspec.info/)
 14 | - Production/PaaS/Terraform ready Dockerfile
 15 | - (optional) [Architecture decision record
 16 |   support](https://github.com/andrewaguiar/rladr)
 17 | - (optional) GOV.UK styled error pages
 18 | - (optional) [asdf](https://asdf-vm.com/) versioning
 19 | - (optional) [solargraph](https://solargraph.org/) with bundled gem support
 20 | - (optional) Linting with
 21 |   [rubocop-govuk](https://github.com/alphagov/rubocop-govuk), formatting with
 22 |   [prettier/plugin-ruby](https://github.com/prettier/plugin-ruby)
 23 | 
 24 | ### What's improved from the [old boilerplate](https://github.com/DFE-Digital/govuk-rails-boilerplate)
 25 | 
 26 | - :new: Ruby 3, Rails 8, and the template does not require us to manually merge
 27 |   dependabot PRs or to keep Ruby/Rails up to date; that's handled by `rails new`!
 28 | - :new: [rails/propshaft](https://github.com/rails/propshaft) asset pipeline
 29 | - :new: [cssbundling](https://github.com/rails/cssbundling-rails) /
 30 |   [jsbundling](https://github.com/rails/jsbundling-rails) with
 31 |   [dart-sass](https://sass-lang.com/dart-sass) and
 32 |   [esbuild](https://esbuild.github.io/), no more Webpack!
 33 | - :new: [Importing improvements from the
 34 |   template](#importing-improvements-from-the-template)
 35 | 
 36 | ## Requirements
 37 | 
 38 | - Ruby 3.2.2
 39 | - Rails 8.0.x
 40 | - [Foreman](https://github.com/ddollar/foreman)
 41 | 
 42 | ### Tools optionally installed by asdf
 43 | 
 44 | The following tools will be installed by `asdf` if it is enabled during the
 45 | setup process (see: [How to setup a new project](#how-to-setup-a-new-project)).
 46 | 
 47 | - [NodeJS 18.x](https://nodejs.org/en/) (installed using `asdf`)
 48 | - [Yarn 1.22.x](https://yarnpkg.com/)
 49 | - Postgres 13.x
 50 | 
 51 | If `asdf` is not used, ensure these are available and in your path. You can check this with: 
 52 | 
 53 | ``` sh
 54 | $ ruby --version
 55 | ruby ruby 3.4.2
 56 | 
 57 | $ rails --version
 58 | Rails 8.0.2
 59 | 
 60 | $ node --version
 61 | v18.1.0
 62 | 
 63 | $ yarn --version
 64 | 1.22.19
 65 | 
 66 | $ foreman --version
 67 | 0.87.2
 68 | 
 69 | $ pg_config --version
 70 | PostgreSQL 13.5
 71 | ```
 72 | 
 73 | ## How to setup a new project
 74 | 
 75 | To create a new application called `apply-for-a-juggling-licence`:
 76 | 
 77 | ```sh
 78 | rails new \
 79 |   --database=postgresql \
 80 |   --skip-bundle \
 81 |   --skip-git \
 82 |   --skip-jbuilder \
 83 |   --skip-hotwire \
 84 |   --skip-action-mailbox \
 85 |   --skip-action-mailer \
 86 |   --skip-action-text \
 87 |   --skip-action-cable \
 88 |   --javascript=esbuild \
 89 |   --css=sass \
 90 |   -m https://raw.githubusercontent.com/DFE-Digital/rails-template/main/template.rb \
 91 |   apply-for-a-juggling-licence
 92 | ```
 93 | 
 94 | The installer will ask you to confirm `y/N` if you want any optional features.
 95 | 
 96 | Once the project is set up, tidy up the `README`, it should already contain
 97 | some references to helpful things like ADRs/linting if you opted into them.
 98 | 
 99 | ### Working with the project
100 | 
101 | ```bash
102 | # Make sure Postgres is running
103 | cd apply-for-a-juggling-licence
104 | asdf install           # Install Ruby/Node/other tools, see README
105 | bin/setup              # Install gems, create databases, remove old logs
106 | bin/dev                # Run the application in development mode using foreman
107 | open http://localhost:3000
108 | 
109 | # Production
110 | bin/rails db:create RAILS_ENV=production # Prepare database
111 | docker build .                           # Build docker container
112 | docker run --net=host \
113 |   -e RAILS_ENV=production \
114 |   -e RAILS_SERVE_STATIC_FILES=true \
115 |   -e SECRET_KEY_BASE=local \
116 |   <DOCKER_IMAGE_ID_FROM_BUILD_COMMAND>
117 | open http://localhost:3000
118 | ```
119 | 
120 | ### Importing improvements from the template
121 | 
122 | We might make changes to the template to improve how things work, or add new
123 | features. We've tried to make it easy to benefit from these changes.
124 | 
125 | To apply the template to an existing project, run this from inside your
126 | project:
127 | 
128 | ```sh
129 | bin/rails app:template LOCATION=https://raw.githubusercontent.com/DFE-Digital/rails-template/main/template.rb
130 | ```
131 | 
132 | The script will ask to overwrite diverging files; press the `d` key to see the
133 | diffs for each file, and choose accordingly. You might have to make some
134 | changes yourself if you've overriden certain files, like the layout.
135 | 
136 | ### Support
137 | 
138 | The DfE Rails template is a community resource. It is supported by
139 | @DfE-Digital. If you run into any problems using it or have ideas for new
140 | features you can [raise an issue](https://github.com/DFE-Digital/rails-template/issues)
141 | or [ask questions on Slack](https://ukgovernmentdigital.slack.com/archives/CR51BN3HP).
142 | 


--------------------------------------------------------------------------------
/adr/00001-record-architecture-decisions.md:
--------------------------------------------------------------------------------
 1 | # 1. Record architecture decisions
 2 | 
 3 | Date: 2022-05-10
 4 | 
 5 | ## Status
 6 | 
 7 | Accepted
 8 | 
 9 | ## Context
10 | 
11 | We need to record the architectural decisions made on this
12 | project.
13 | 
14 | ## Decision
15 | 
16 | We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
17 | 
18 | ## Consequences
19 | 
20 | See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
21 | 


--------------------------------------------------------------------------------
/app/assets/config/manifest.js:
--------------------------------------------------------------------------------
1 | //= link_tree ../builds/images
2 | //= link_tree ../builds/
3 | 


--------------------------------------------------------------------------------
/app/assets/stylesheets/application.sass.scss:
--------------------------------------------------------------------------------
1 | $govuk-global-styles: true;
2 | $govuk-new-link-styles: true;
3 | $govuk-assets-path: "/";
4 | 
5 | @import "govuk-frontend/dist/govuk/all";
6 | 


--------------------------------------------------------------------------------
/app/controllers/errors_controller.rb:
--------------------------------------------------------------------------------
 1 | # frozen_string_literal: true
 2 | class ErrorsController < ApplicationController
 3 |   skip_before_action :verify_authenticity_token
 4 | 
 5 |   def not_found
 6 |     render 'not_found', status: :not_found
 7 |   end
 8 | 
 9 |   def unprocessable_entity
10 |     render 'unprocessable_entity', status: :unprocessable_entity
11 |   end
12 | 
13 |   def too_many_requests
14 |     render 'too_many_requests', status: :too_many_requests
15 |   end
16 | 
17 |   def internal_server_error
18 |     render 'internal_server_error', status: :internal_server_error
19 |   end
20 | end
21 | 


--------------------------------------------------------------------------------
/app/javascript/application.js:
--------------------------------------------------------------------------------
1 | import { initAll } from "govuk-frontend";
2 | 
3 | initAll();
4 | 


--------------------------------------------------------------------------------
/app/views/errors/internal_server_error.html.erb:
--------------------------------------------------------------------------------
 1 | <%%= content_for :page_title, "Sorry, there’s a problem with the service" %>
 2 | 
 3 | <div class="govuk-grid-row">
 4 |   <div class="govuk-grid-column-two-thirds">
 5 |     <h1 class="govuk-heading-l">Sorry, there’s a problem with the service</h1>
 6 | 
 7 |     <p class="govuk-body">Try again later.</p>
 8 | 
 9 |     <p class="govuk-body">
10 |       If you reached this page after submitting information then it has not
11 |       been saved. You’ll need to enter it again when the service is available.
12 |     </p>
13 |     <p class="govuk-body">
14 |       If you have any questions, please email us at <a class="govuk-link"
15 |         href="mailto:<%%= t('service.email') %>"><%%= t('service.email') %></a>.
16 |     </p>
17 |   </div>
18 | </div>
19 | 


--------------------------------------------------------------------------------
/app/views/errors/not_found.html.erb:
--------------------------------------------------------------------------------
 1 | <%%= content_for :page_title, "Page not found" %>
 2 | 
 3 | <div class="govuk-grid-row">
 4 |   <div class="govuk-grid-column-two-thirds">
 5 |     <h1 class="govuk-heading-l">Page not found</h1>
 6 |     <p class="govuk-body">
 7 |       If you entered a web address, check it is correct.
 8 |     </p>
 9 |     <p class="govuk-body">
10 |       If you pasted the web address, check you copied the entire address.
11 |     </p>
12 |     <p class="govuk-body">
13 |       If the web address is correct or you selected a link or button and you
14 |       need to speak to someone about this problem, contact the <%%=
15 |       t('service.name') %> team: <a class="govuk-link" href="mailto:<%%=
16 |       t('service.email') %>"><%%= t('service.email') %></a>.
17 |     </p>
18 |   </div>
19 | </div>
20 | 


--------------------------------------------------------------------------------
/app/views/errors/too_many_requests.html.erb:
--------------------------------------------------------------------------------
 1 | <%= content_for :page_title, "Sorry, there’s a problem with the service" %>
 2 | 
 3 | <div class="govuk-grid-row">
 4 |   <div class="govuk-grid-column-two-thirds">
 5 |     <h1 class="govuk-heading-l">Sorry, there’s a problem with the service</h1>
 6 | 
 7 |     <p class="govuk-body">Try again later.</p>
 8 | 
 9 |     <p class="govuk-body">
10 |       You’re seeing this message as you’ve tried to access this page
11 |       repeatedly, please wait a few moments before trying again.
12 |     </p>
13 | 
14 |     <p class="govuk-body">
15 |       If you have any questions, please email us at
16 |       <a class="govuk-link" href="mailto:<%= t('service.email') %>"><%= t('service.email') %></a>.
17 |     </p>
18 |   </div>
19 | </div>
20 | 


--------------------------------------------------------------------------------
/app/views/errors/unprocessable_entity.html.erb:
--------------------------------------------------------------------------------
 1 | <%%= content_for :page_title, 'Sorry, there’s a problem with the service' %>
 2 | 
 3 | <div class="govuk-grid-row">
 4 |   <div class="govuk-grid-column-two-thirds">
 5 |     <h1 class="govuk-heading-l">Sorry, there’s a problem with the service</h1>
 6 | 
 7 |     <p class="govuk-body">Try again later.</p>
 8 | 
 9 |     <p class="govuk-body">
10 |       If you continue to see this error contact the <%%= t('service.name')
11 |       %> team: <a class="govuk-link" href="mailto:<%%= t('service.email') %>"><%%=
12 |       t('service.email') %></a>.
13 |     </p>
14 |   </div>
15 | </div>
16 | 


--------------------------------------------------------------------------------
/app/views/layouts/application.html.erb:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en" class="govuk-template">
 3 |   <head>
 4 |     <title><%%= [yield(:page_title).presence, t('service.name')].compact.join(' - ') %></title>
 5 | 
 6 |     <%%= csrf_meta_tags %>
 7 |     <%%= csp_meta_tag %>
 8 | 
 9 |     <%%= tag :meta, name: 'viewport', content: 'width=device-width, initial-scale=1' %>
10 |     <%%= tag :meta, property: 'og:image', content: asset_path('images/govuk-opengraph-image.png') %>
11 |     <%%= tag :meta, name: 'theme-color', content: '#0b0c0c' %>
12 |     <%%= favicon_link_tag asset_path('images/favicon.ico') %>
13 |     <%%= favicon_link_tag asset_path('images/govuk-icon-mask.svg'), rel: 'mask-icon', type: 'image/svg', color: "#0b1c0c" %>
14 |     <%%= favicon_link_tag asset_path('images/govuk-icon-180.png'), rel: 'apple-touch-icon', type: 'image/png', size: '180x180' %>
15 | 
16 |     <%%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
17 |     <%%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
18 |   </head>
19 | 
20 |   <body class="govuk-template__body">
21 |     <script>
22 |       document.body.className += ' js-enabled' + ('noModule' in HTMLScriptElement.prototype ? ' govuk-frontend-supported' : '');
23 |     </script>
24 | 
25 |     <%%= govuk_skip_link %>
26 | 
27 |     <%%= govuk_header(full_width_border: true) %>
28 | 
29 |     <%%=
30 |       govuk_service_navigation(
31 |         service_name: "GOV.UK Rails Boilerplate",
32 |         navigation_items: [
33 |           { text: "Navigation item 1", href: "#", active: true },
34 |           { text: "Navigation item 2", href: "#" },
35 |           { text: "Navigation item 3", href: "#" }
36 |         ]
37 |       )
38 |     %>
39 | 
40 |     <div class="govuk-width-container">
41 |       <main class="govuk-main-wrapper" id="main-content" role="main">
42 |         <%%= yield %>
43 |       </main>
44 |     </div>
45 | 
46 |     <%%= govuk_footer %>
47 |   </body>
48 | </html>
49 | 


--------------------------------------------------------------------------------
/app/views/pages/home.html.erb:
--------------------------------------------------------------------------------
 1 | <div class="govuk-grid-row">
 2 |   <div class="govuk-grid-column-two-thirds">
 3 |     <h1 class="govuk-heading-xl">It works! 🎉</h1>
 4 | 
 5 |     <p class="govuk-body">
 6 |       Your application is ready - so long as this page rendered without any errors you're good to go.
 7 |     </p>
 8 | 
 9 |     <%%= govuk_summary_list(
10 |       rows: [
11 |         { key: { text: "Rails version" }, value: { text:  Rails.version } },
12 |         { key: { text: "Ruby version" }, value: { text:  RUBY_VERSION } },
13 |         { key: {
14 |           text: "GOV.UK Frontend" },
15 |           value: {
16 |             text: JSON
17 |               .parse(File.read(Rails.root.join("package.json")))
18 |               .dig("dependencies", "govuk-frontend")
19 |               .tr("^", "")
20 |           }
21 |         },
22 |         { key: {
23 |           text: "Yarn version" },
24 |           value: {
25 |             text: File
26 |               .read(Rails.root.join(".yarnrc.yml"))
27 |               .match(/releases\/yarn-(?<version>\d+\.\d+\.\d+)\.cjs/)
28 |               .named_captures
29 |               .fetch("version", "Problem retrieving Yarn version")
30 |           }
31 |         }
32 |       ]
33 |     ) %>
34 |   </div>
35 | </div>
36 | 


--------------------------------------------------------------------------------
/bin/bundle:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env ruby
  2 | # frozen_string_literal: true
  3 | 
  4 | #
  5 | # This file was generated by Bundler.
  6 | #
  7 | # The application 'bundle' is installed as part of a gem, and
  8 | # this file is here to facilitate running it.
  9 | #
 10 | 
 11 | require 'rubygems'
 12 | 
 13 | m =
 14 |   Module.new do
 15 |     module_function
 16 | 
 17 |     def invoked_as_script?
 18 |       File.expand_path($0) == File.expand_path(__FILE__)
 19 |     end
 20 | 
 21 |     def env_var_version
 22 |       ENV['BUNDLER_VERSION']
 23 |     end
 24 | 
 25 |     def cli_arg_version
 26 |       return unless invoked_as_script? # don't want to hijack other binstubs
 27 |       return unless 'update'.start_with?(ARGV.first || ' ') # must be running `bundle update`
 28 |       bundler_version = nil
 29 |       update_index = nil
 30 |       ARGV.each_with_index do |a, i|
 31 |         bundler_version = a if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
 32 |         next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
 33 |         bundler_version = $1
 34 |         update_index = i
 35 |       end
 36 |       bundler_version
 37 |     end
 38 | 
 39 |     def gemfile
 40 |       gemfile = ENV['BUNDLE_GEMFILE']
 41 |       return gemfile if gemfile && !gemfile.empty?
 42 | 
 43 |       File.expand_path('../../Gemfile', __FILE__)
 44 |     end
 45 | 
 46 |     def lockfile
 47 |       lockfile =
 48 |         case File.basename(gemfile)
 49 |         when 'gems.rb'
 50 |           gemfile.sub(/\.rb$/, gemfile)
 51 |         else
 52 |           "#{gemfile}.lock"
 53 |         end
 54 |       File.expand_path(lockfile)
 55 |     end
 56 | 
 57 |     def lockfile_version
 58 |       return unless File.file?(lockfile)
 59 |       lockfile_contents = File.read(lockfile)
 60 |       return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
 61 |       Regexp.last_match(1)
 62 |     end
 63 | 
 64 |     def bundler_requirement
 65 |       @bundler_requirement ||= env_var_version || cli_arg_version || bundler_requirement_for(lockfile_version)
 66 |     end
 67 | 
 68 |     def bundler_requirement_for(version)
 69 |       return "#{Gem::Requirement.default}.a" unless version
 70 | 
 71 |       bundler_gem_version = Gem::Version.new(version)
 72 | 
 73 |       requirement = bundler_gem_version.approximate_recommendation
 74 | 
 75 |       return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new('2.7.0')
 76 | 
 77 |       requirement += '.a' if bundler_gem_version.prerelease?
 78 | 
 79 |       requirement
 80 |     end
 81 | 
 82 |     def load_bundler!
 83 |       ENV['BUNDLE_GEMFILE'] ||= gemfile
 84 | 
 85 |       activate_bundler
 86 |     end
 87 | 
 88 |     def activate_bundler
 89 |       gem_error = activation_error_handling { gem 'bundler', bundler_requirement }
 90 |       return if gem_error.nil?
 91 |       require_error = activation_error_handling { require 'bundler/version' }
 92 |       if require_error.nil? &&
 93 |            Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
 94 |         return
 95 |       end
 96 |       warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
 97 |       exit 42
 98 |     end
 99 | 
100 |     def activation_error_handling
101 |       yield
102 |       nil
103 |     rescue StandardError, LoadError => e
104 |       e
105 |     end
106 |   end
107 | 
108 | m.load_bundler!
109 | 
110 | load Gem.bin_path('bundler', 'bundle') if m.invoked_as_script?
111 | 


--------------------------------------------------------------------------------
/bin/lint:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | 
3 | bin/bundle exec rubocop --autocorrect-all
4 | yarn prettier --write --ignore-unknown '**/*'
5 | 


--------------------------------------------------------------------------------
/config/initializers/govuk_formbuilder.rb:
--------------------------------------------------------------------------------
 1 | GOVUKDesignSystemFormBuilder.configure do |config|
 2 |   # for more info see:
 3 |   #
 4 |   # https://www.rubydoc.info/gems/govuk_design_system_formbuilder/GOVUKDesignSystemFormBuilder
 5 | 
 6 |   # config.brand: 'govuk'
 7 |   #
 8 |   # config.default_legend_size: 'm'
 9 |   # config.default_legend_tag: nil
10 |   # config.default_caption_size: 'm'
11 |   # config.default_submit_button_text: 'Continue'
12 |   # config.default_radio_divider_text: 'or'
13 |   # config.default_check_box_divider_text: 'or'
14 |   # config.default_error_summary_title: 'There is a problem'
15 |   # config.default_error_summary_presenter: Presenters::ErrorSummaryPresenter
16 |   # config.default_error_summary_error_order_method: nil
17 |   # config.default_error_summary_turbo_prefix: 'turbo'
18 |   # config.default_collection_check_boxes_include_hidden: true
19 |   # config.default_collection_radio_buttons_include_hidden: true
20 |   # config.default_submit_validate: false
21 |   #
22 |   # config.localisation_schema_fallback: %i(helpers __context__)
23 |   # config.localisation_schema_label: nil
24 |   # config.localisation_schema_hint: nil
25 |   # config.localisation_schema_legend: nil
26 |   # config.localisation_schema_caption: nil
27 |   #
28 |   # config.enable_logger: true
29 |   # config.trust_error_messages: false
30 | end
31 | 


--------------------------------------------------------------------------------
/config/initializers/semantic_logger.rb:
--------------------------------------------------------------------------------
1 | if Rails.env.development? || Rails.env.production?
2 |   Rails.application.configure do
3 |     config.log_tags = [:request_id] # Prepend all log lines with the following tags
4 |   end
5 | 
6 |   SemanticLogger.add_appender(io: $stdout, level: Rails.application.config.log_level, formatter: Rails.application.config.log_format)
7 |   Rails.application.config.logger.info("Application logging to STDOUT")
8 | end
9 | 


--------------------------------------------------------------------------------
/config/locales/en.yml:
--------------------------------------------------------------------------------
1 | en:
2 |   service:
3 |     name: GOV.UK Frontend on Rails
4 |     email: my-service@email
5 | 


--------------------------------------------------------------------------------
/dependabot.yml:
--------------------------------------------------------------------------------
 1 | # To get started with Dependabot version updates, you'll need to specify which
 2 | # package ecosystems to update and where the package manifests are located.
 3 | # Please see the documentation for all configuration options:
 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
 5 | 
 6 | version: 2
 7 | updates:
 8 |   - package-ecosystem: "bundler"
 9 |     directory: "/"
10 |     schedule:
11 |       interval: "weekly"
12 |   - package-ecosystem: "github-actions"
13 |     directory: "/"
14 |     schedule:
15 |       interval: "weekly"
16 |   - package-ecosystem: "npm"
17 |     directory: "/"
18 |     schedule:
19 |       interval: "weekly"
20 | 


--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/DFE-Digital/rails-template/4450665ad34eec558ec9529ac512a33e7e04e82b/docker-compose.yml


--------------------------------------------------------------------------------
/dockerignore:
--------------------------------------------------------------------------------
 1 | *.log
 2 | .byebug_history
 3 | .env
 4 | .git
 5 | .github
 6 | .yarn-integrity
 7 | config/master.key
 8 | log
 9 | node_modules
10 | public/assets
11 | public/packs
12 | public/packs-test
13 | storage
14 | tmp
15 | vendor/cache
16 | yarn-debug.log*
17 | 


--------------------------------------------------------------------------------
/gitignore:
--------------------------------------------------------------------------------
 1 | *.log
 2 | .DS_Store
 3 | .bundle
 4 | .env
 5 | .env.local
 6 | .envrc
 7 | .idea
 8 | .vscode
 9 | 
10 | .yarn/*
11 | !.yarn/cache
12 | !.yarn/patches
13 | !.yarn/plugins
14 | !.yarn/releases
15 | !.yarn/sdks
16 | !.yarn/versions
17 | 
18 | config/master.key
19 | db/*.sqlite3
20 | node_modules
21 | public/assets
22 | 
23 | app/assets/builds/*
24 | !app/assets/builds/.keep
25 | 
26 | log/*
27 | !log/.keep
28 | 
29 | tmp/*
30 | !tmp/.keep
31 | 
32 | tmp/pids/*
33 | !tmp/pids/
34 | !tmp/pids/.keep
35 | 


--------------------------------------------------------------------------------
/solargraph.yml:
--------------------------------------------------------------------------------
 1 | ---
 2 | include:
 3 | - "**/*.rb"
 4 | exclude:
 5 | - spec/**/*
 6 | - test/**/*
 7 | - vendor/**/*
 8 | - ".bundle/**/*"
 9 | require: []
10 | domains: []
11 | reporters:
12 | - rubocop
13 | - require_not_found
14 | formatter:
15 |   rubocop:
16 |     cops: safe
17 |     except: []
18 |     only: []
19 |     extra_args: []
20 | require_paths: []
21 | plugins:
22 |   - solargraph-rails
23 | max_files: 5000
24 | 


--------------------------------------------------------------------------------
/template.rb:
--------------------------------------------------------------------------------
  1 | fail("Rails 7.0.0 or greater is required") if Rails.version <= "7"
  2 | 
  3 | def apply_template!
  4 |   add_template_repository_to_source_path
  5 | 
  6 |   setup_readme
  7 |   setup_dependabot
  8 | 
  9 |   setup_asdf
 10 | 
 11 |   install_gems
 12 |   initialize_package_json
 13 | 
 14 |   create_bin_bundle
 15 |   create_application_scss
 16 |   create_application_js
 17 |   create_application_html_erb
 18 |   create_builds_keep
 19 | 
 20 |   initialize_rspec
 21 |   initialize_formbuilder
 22 |   initialize_govuk_frontend_assets
 23 | 
 24 |   add_pages_controller
 25 |   add_en_yml
 26 |   add_docker
 27 |   add_docker_compose
 28 | 
 29 |   setup_yarn
 30 | 
 31 |   setup_error_pages
 32 |   setup_linting
 33 |   setup_solargraph # Needs to come after linting
 34 |   setup_adrs # Put last for correct ordering in README
 35 |   setup_semantic_logger
 36 | 
 37 |   after_bundle do
 38 |     initialize_git
 39 |   end
 40 | end
 41 | 
 42 | # Taken from https://github.com/mattbrictson/rails-template/blob/215a87d00ff2b2a656be3ebd277e7f71607f5d49/template.rb#L99
 43 | def add_template_repository_to_source_path
 44 |   if __FILE__ =~ %r{\Ahttps?://}
 45 |     require "tmpdir"
 46 |     source_paths.unshift(tempdir = Dir.mktmpdir("rails-template-"))
 47 |     at_exit { FileUtils.remove_entry(tempdir) }
 48 |     git clone: [
 49 |       "--quiet",
 50 |       "https://github.com/DFE-Digital/rails-template.git",
 51 |       tempdir
 52 |     ].map(&:shellescape).join(" ")
 53 | 
 54 |     if (branch = __FILE__[%r{rails-template/(.+)/template.rb}, 1])
 55 |       Dir.chdir(tempdir) { git checkout: branch }
 56 |     end
 57 |   else
 58 |     source_paths.unshift(File.dirname(__FILE__))
 59 |   end
 60 | end
 61 | 
 62 | def file_exists?(file)
 63 |   File.exist?(file)
 64 | end
 65 | 
 66 | def file_contains?(file, contains)
 67 |   return false unless file_exists?(file)
 68 | 
 69 |   File.foreach(file).any? { |line| line.include?(contains) }
 70 | end
 71 | 
 72 | def install_gems
 73 |   gem "govuk-components" unless file_contains?("Gemfile", "govuk-components")
 74 |   gem "govuk_design_system_formbuilder" unless
 75 |     file_contains?("Gemfile", "govuk_design_system_formbuilder")
 76 | 
 77 |   gem_group :test, :development do
 78 |     gem "rspec"
 79 |     gem "rspec-rails"
 80 |   end unless file_contains?("Gemfile", 'rspec-rails')
 81 | 
 82 |   run "bundle --quiet"
 83 | end
 84 | 
 85 | def create_application_scss
 86 |   remove_file("app/assets/stylesheets/application.css")
 87 | 
 88 |   remove_file('app/assets/stylesheets/application.sass.scss', verbose: false)
 89 |   template('app/assets/stylesheets/application.sass.scss')
 90 | end
 91 | 
 92 | def create_application_js
 93 |   remove_file('app/javascript/application.js', verbose: false)
 94 |   template('app/javascript/application.js')
 95 | end
 96 | 
 97 | def create_application_html_erb
 98 |   remove_file('app/views/layouts/application.html.erb', verbose: false)
 99 |   template('app/views/layouts/application.html.erb')
100 | end
101 | 
102 | def create_builds_keep
103 |   FileUtils.mkdir_p 'app/assets/builds'
104 |   FileUtils.touch 'app/assets/builds/.keep'
105 | end
106 | 
107 | def add_pages_controller
108 |   return if file_exists?("app/controllers/pages_controller.rb")
109 | 
110 |   generate("controller", "pages", "home", "--skip-routes")
111 |   route("root to: 'pages#home'") unless file_contains?("config/routes.rb", "root to:")
112 | 
113 |   template('app/views/pages/home.html.erb', force: true)
114 | end
115 | 
116 | def initialize_package_json
117 |   return if file_contains?('package.json', 'esbuild')
118 |   run "rails css:install:sass"
119 |   run "rails javascript:install:esbuild"
120 | 
121 |   gsub_file(
122 |     'package.json',
123 |     /--load-path=node_modules/,
124 |     '--load-path=node_modules --quiet-deps'
125 |   )
126 | end
127 | 
128 | def initialize_rspec
129 |   generate("rspec:install") unless file_exists?(".rspec")
130 | end
131 | 
132 | def initialize_formbuilder
133 |   return if file_contains?("config/initializers/govuk_formbuilder.rb", "GOVUKDesignSystemFormBuilder")
134 | 
135 |   inject_into_file(
136 |     "app/controllers/application_controller.rb",
137 |     "default_form_builder(GOVUKDesignSystemFormBuilder::FormBuilder)\n".indent(2),
138 |     after: "class ApplicationController < ActionController::Base\n"
139 |   )
140 | 
141 |   template('config/initializers/govuk_formbuilder.rb')
142 | end
143 | 
144 | def initialize_govuk_frontend_assets
145 |   return if file_contains?("config/application.rb", "govuk-frontend")
146 | 
147 |   insert_into_file(
148 |     'config/application.rb',
149 |     "\nconfig.assets.paths << Rails.root.join('node_modules/govuk-frontend/dist/govuk/assets')\n".indent(4),
150 |     before: "  end\nend"
151 |   )
152 | 
153 |   remove_file("config/initializers/assets.rb")
154 | end
155 | 
156 | def setup_yarn
157 |   apply 'templates/yarn.rb'
158 | 
159 |   run "yarn set version stable"
160 |   run "yarn --silent add govuk-frontend@5.8.0"
161 | end
162 | 
163 | def initialize_git
164 |   template('gitignore', '.gitignore')
165 | 
166 |   git(init: "--initial-branch=main")
167 |   git(add: ".")
168 |   git(commit: <<~COMMIT)
169 |     -m "Initial commit
170 | 
171 |     Built using the Department for Education's Rails template"
172 |   COMMIT
173 | end
174 | 
175 | def create_bin_bundle
176 |   template('bin/bundle')
177 | 
178 |   chmod "bin/bundle", "+x"
179 | end
180 | 
181 | 
182 | def get_tools_version_of(tool_name)
183 |   File.readlines(".tool-versions")
184 |     .map(&:split)
185 |     .find { |tool, version| tool == tool_name }
186 |     .at(1)
187 | end
188 | 
189 | def setup_asdf
190 |   unless file_exists?('.tool-versions')
191 |     say("\n=== `asdf-vm` https://asdf-vm.com/ ===")
192 | 
193 |     return unless yes?('Add `asdf` for Ruby/Node/Yarn versioning support? y/N')
194 |   end
195 | 
196 |   apply 'templates/asdf.rb'
197 | 
198 |   # bundle changes directory before installing gems, which means the asdf shim
199 |   # won't know which version of postgres we want and the 'pg' gem will fail to
200 |   # install, later. Setting the env var ensures asdf picks up the right version of
201 |   # postgres.
202 |   ENV["ASDF_POSTGRES_VERSION"] = get_tools_version_of("postgres")
203 | end
204 | 
205 | def setup_readme
206 |   apply 'templates/readme.rb'
207 | end
208 | 
209 | def setup_adrs
210 |   return say('ADRs already setup, skipping') if file_contains?('Gemfile', 'rladr')
211 |   say("\n=== Architecture Decision Records (ADRs) ===")
212 |   return unless yes?('Add `rladr` for Architecture Decision Record (ADR) support? y/N')
213 | 
214 |   apply 'templates/adr.rb'
215 | end
216 | 
217 | def add_en_yml
218 |   return unless file_contains?('config/locales/en.yml', 'Hello world')
219 |   remove_file('config/locales/en.yml', verbose: false)
220 |   template('config/locales/en.yml')
221 | end
222 | 
223 | def add_docker
224 |   template('Dockerfile')
225 |   template('dockerignore', '.dockerignore')
226 | end
227 | 
228 | def add_docker_compose
229 |   apply 'templates/docker_compose.rb'
230 | end
231 | 
232 | def setup_error_pages
233 |   return say('Error pages already setup, skipping') if file_exists?('app/controllers/errors_controller.rb')
234 |   say("\n=== GOV.UK styled error pages ===")
235 |   return unless yes?('Add GOV.UK styled error pages? y/N')
236 | 
237 |   apply 'templates/errors.rb'
238 | end
239 | 
240 | def setup_linting
241 |   return say('linting already setup, skipping') if file_exists?('.rubocop.yml')
242 |   say("\n=== Rubocop and prettier ===")
243 |   return unless yes?('Add govuk-rubocop and Prettier for linting/formatting? y/N')
244 | 
245 |   apply 'templates/linting.rb'
246 | end
247 | 
248 | def setup_solargraph
249 |   return say('solargraph already setup, skipping') if file_exists?('.solargraph.yml')
250 |   say("\n=== solargraph https://solargraph.org/ ===")
251 |   return unless yes?('Add solargraph for Ruby intellisense support? y/N')
252 | 
253 |   apply 'templates/solargraph.rb'
254 | end
255 | 
256 | def setup_dependabot
257 |   template('dependabot.yml', '.github/dependabot.yml')
258 | end
259 | 
260 | def setup_semantic_logger
261 |   say("\n=== semantic logger https://logger.rocketjob.io/ ===")
262 |   return unless yes?('Add semantic logging for integration with kibana? y/N')
263 |   apply 'templates/semantic_logger.rb'
264 | end
265 | 
266 | apply_template!
267 | 


--------------------------------------------------------------------------------
/templates/adr.rb:
--------------------------------------------------------------------------------
 1 | inject_into_file(
 2 |   "Gemfile",
 3 |   "gem 'rladr'\n".indent(2),
 4 |   after: "group :development do\n"
 5 | )
 6 | 
 7 | run "bin/bundle --quiet"
 8 | 
 9 | run "bin/bundle exec rladr init adr"
10 | 
11 | append_to_file(
12 |   'README.md',
13 |   <<~MD
14 |     ## How the application works
15 | 
16 |     We keep track of architecture decisions in [Architecture Decision Records
17 |     (ADRs)](/adr/).
18 | 
19 |     We use `rladr` to generate the boilerplate for new records:
20 | 
21 |     ```bash
22 |     bin/bundle exec rladr new title
23 |     ```
24 |   MD
25 | )
26 | 
27 | template 'adr/00001-record-architecture-decisions.md', force: true
28 | 
29 | gsub_file(
30 |   'adr/00001-record-architecture-decisions.md',
31 |   /2022-05-10/,
32 |   Time.new.strftime('%Y-%m-%d')
33 | )
34 | 


--------------------------------------------------------------------------------
/templates/asdf.rb:
--------------------------------------------------------------------------------
 1 | template('tool-versions', '.tool-versions')
 2 | 
 3 | run "asdf plugin add ruby || true"
 4 | run "asdf plugin add nodejs || true"
 5 | run "asdf plugin add yarn || true"
 6 | run "asdf plugin add postgres || true"
 7 | run "asdf install"
 8 | 
 9 | postgres_version = get_tools_version_of("postgres")
10 | 
11 | append_to_file(
12 |   'README.md',
13 |   <<~MD
14 |     ### asdf
15 | 
16 |     This project uses `asdf`. Use the following to install the required tools:
17 | 
18 |     ```sh
19 |     # The first time
20 |     brew install asdf # Mac-specific
21 |     asdf plugin add ruby
22 |     asdf plugin add nodejs
23 |     asdf plugin add yarn
24 |     asdf plugin add postgres
25 | 
26 |     # To install (or update, following a change to .tool-versions)
27 |     asdf install
28 |     ```
29 | 
30 |     When installing the `pg` gem, bundle changes directory outside of this
31 |     project directory, causing it lose track of which version of postgres has
32 |     been selected in the project's `.tool-versions` file. To ensure the `pg` gem
33 |     installs correctly, you'll want to set the version of postgres that `asdf`
34 |     will use:
35 | 
36 |     ```sh
37 |     # Temporarily set the version of postgres to use to build the pg gem
38 |     ASDF_POSTGRES_VERSION=#{postgres_version} bundle install
39 |     ```
40 | 
41 |   MD
42 | )
43 | 


--------------------------------------------------------------------------------
/templates/docker_compose.rb:
--------------------------------------------------------------------------------
 1 | template('docker-compose.yml','docker-compose.yml')
 2 | append_to_file(
 3 |   'docker-compose.yml',
 4 |   <<~MD
 5 |     # services:
 6 |     # db:
 7 |     #   image: "postgres:#{ENV["ASDF_POSTGRES_VERSION"]}-alpine"
 8 |     #   environment:
 9 |     #     POSTGRES_HOST_AUTH_METHOD: "trust"
10 |     #   ports:
11 |     #     - 5432:5432
12 |   MD
13 | )


--------------------------------------------------------------------------------
/templates/errors.rb:
--------------------------------------------------------------------------------
 1 | template 'app/controllers/errors_controller.rb'
 2 | 
 3 | template 'app/views/errors/internal_server_error.html.erb'
 4 | template 'app/views/errors/not_found.html.erb'
 5 | template 'app/views/errors/unprocessable_entity.html.erb'
 6 | 
 7 | routes = <<-RUBY
 8 | 
 9 |   scope via: :all do
10 |     get '/404', to: 'errors#not_found'
11 |     get '/422', to: 'errors#unprocessable_entity'
12 |     get '/429', to: 'errors#too_many_requests'
13 |     get '/500', to: 'errors#internal_server_error'
14 |   end
15 | RUBY
16 | 
17 | insert_into_file('config/routes.rb', routes, before: /^end/)
18 | 
19 | insert_into_file(
20 |   'config/application.rb',
21 |   "\nconfig.exceptions_app = routes\n".indent(4),
22 |   before: "  end\nend"
23 | )
24 | 
25 | remove_file 'public/404.html'
26 | remove_file 'public/422.html'
27 | remove_file 'public/500.html'
28 | 


--------------------------------------------------------------------------------
/templates/linting.rb:
--------------------------------------------------------------------------------
 1 | template '.rubocop.yml'
 2 | template '.prettierignore'
 3 | template 'bin/lint'
 4 | chmod "bin/lint", "+x"
 5 | 
 6 | inject_into_file(
 7 |   "Gemfile",
 8 |   "gem 'prettier_print', require: false\n" \
 9 |   "gem 'rubocop-govuk', require: false\n" \
10 |   "gem 'syntax_tree', require: false\n" \
11 |   "gem 'syntax_tree-haml', require: false\n" \
12 |   "gem 'syntax_tree-rbs', require: false\n".indent(2),
13 |   after: "group :development do\n"
14 | )
15 | 
16 | run "bin/bundle --quiet"
17 | 
18 | run "yarn add --silent --dev prettier @prettier/plugin-ruby"
19 | 
20 | append_to_file(
21 |   'README.md',
22 |   <<~MD
23 |     ### Linting
24 | 
25 |     To run the linters:
26 | 
27 |     ```bash
28 |     bin/lint
29 |     ```
30 |   MD
31 | )
32 | 


--------------------------------------------------------------------------------
/templates/readme.rb:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env ruby
 2 | 
 3 | append_to_file(
 4 |   'README.md',
 5 |   <<~MD
 6 | 
 7 |     ## Setup
 8 | 
 9 |     ### Prerequisites
10 | 
11 |     This project depends on:
12 | 
13 |       - [Ruby](https://www.ruby-lang.org/)
14 |       - [Ruby on Rails](https://rubyonrails.org/)
15 |       - [NodeJS](https://nodejs.org/)
16 |       - [Yarn](https://yarnpkg.com/)
17 |       - [Postgres](https://www.postgresql.org/)
18 | 
19 |   MD
20 | )
21 | 


--------------------------------------------------------------------------------
/templates/semantic_logger.rb:
--------------------------------------------------------------------------------
 1 | unless file_exists?("config/initializers/semantic_logger.rb")
 2 |   template("config/initializers/semantic_logger.rb")
 3 | end
 4 | 
 5 | gem_group :development, :production do
 6 |   gem "amazing_print" unless file_contains?("Gemfile", "amazing_print")
 7 |   gem "rails_semantic_logger"
 8 | end unless file_contains?("Gemfile", 'rails_semantic_logger')
 9 | 
10 | run "bundle --quiet"
11 | 
12 | development_config = <<-RUBY
13 |   # Semantic logging for integration with Kibana
14 |   config.log_level = :info                        # Or :debug
15 |   config.log_format = :color                      # Console colorised non-json output
16 |   config.semantic_logger.backtrace_level = :debug # Show file and line number (expensive: not for production)
17 | RUBY
18 | 
19 | insert_into_file(
20 |   "config/environments/development.rb",
21 |   development_config,
22 |   after: "Rails.application.configure do",
23 | ) unless file_contains?(
24 |   "config/environments/development.rb",
25 |   "config.semantic_logger.backtrace_level",
26 | )
27 | 
28 | production_config = <<-RUBY
29 |   # Semantic logging for integration with Kibana
30 |   config.log_level = :info                                # Or :warn, or :error
31 |   config.log_format = :json                               # For parsing in Logit
32 |   config.rails_semantic_logger.add_file_appender = false  # Don't log to file
33 |   config.active_record.logger = nil                       # Don't log SQL
34 | RUBY
35 | 
36 | insert_into_file(
37 |   "config/environments/production.rb",
38 |   production_config,
39 |   after: "Rails.application.configure do",
40 | ) unless file_contains?(
41 |   "config/environments/production.rb",
42 |   "config.rails_semantic_logger.add_file_appender",
43 | )
44 | 


--------------------------------------------------------------------------------
/templates/solargraph.rb:
--------------------------------------------------------------------------------
 1 | template 'solargraph.yml', '.solargraph.yml'
 2 | 
 3 | inject_into_file(
 4 |   "Gemfile",
 5 |   "gem 'solargraph', require: false\n" \
 6 |   "gem 'solargraph-rails', require: false\n".indent(2),
 7 |   after: "group :development do\n"
 8 | )
 9 | 
10 | run "bin/bundle --quiet"
11 | 
12 | append_to_file(
13 |   'README.md',
14 |   <<~MD
15 |     ### Intellisense
16 | 
17 |     [solargraph](https://github.com/castwide/solargraph) is bundled as part of the
18 |     development dependencies. You need to [set it up for your
19 |     editor](https://github.com/castwide/solargraph#using-solargraph), and then run
20 |     this command to index your local bundle (re-run if/when we install new
21 |     dependencies and you want completion):
22 | 
23 |     ```sh
24 |     bin/bundle exec yard gems
25 |     ```
26 | 
27 |     You'll also need to configure your editor's `solargraph` plugin to
28 |     `useBundler`:
29 | 
30 |     ```diff
31 |     +  "solargraph.useBundler": true,
32 |     ```
33 |   MD
34 | )
35 | 


--------------------------------------------------------------------------------
/templates/yarn.rb:
--------------------------------------------------------------------------------
1 | template('yarnrc.yml', '.yarnrc.yml')
2 | 


--------------------------------------------------------------------------------
/tool-versions:
--------------------------------------------------------------------------------
1 | ruby 3.4.1
2 | nodejs 22.13.1
3 | yarn 1.22.22
4 | postgres 17.2
5 | 


--------------------------------------------------------------------------------
/yarnrc.yml:
--------------------------------------------------------------------------------
1 | nodeLinker: node-modules
2 | 


--------------------------------------------------------------------------------