Setup dotenv

ruby_on_rails/README.md

@@ -11,6 +11,7 @@ The application (and relative GitHub repo) will be named after the `[project-nam
 > Have you decided if you need two environments (develop and main) or just one?
 > As a rule of thumb: for customers we always use two environments, for internal projects we usually only use one.
 > Why the difference? Because we can bare the risk of having a bug in an internal project, but we cannot do that for a customer.
+> Decide with your team if you want one or two branches.
 
 1. [Initialise the Rails Application](app_initialisation.md)
 1. [Push to Git Repository](first_git_push.md)

ruby_on_rails/app_initialisation.md

@@ -20,19 +20,17 @@ rails new [project-name] --database=postgresql --skip-kamal --skip-ci --skip-act
 where the `project-name` is exactly the one you chose before.
 
 > ⚠️ You may want to choose a different database than Postgres, but most of the time this will be your choice.\
-> If you do not need a DB you may rethink the fact that you may not need Rails at all: Take a look at [Sinatra](http://www.sinatrarb.com/) or [Angular](https://angular.io/)\
 > You might also need actionmailbox of course, so always double-check the parameters that you are using.
 
 > ⭐️ This setup does not include either js-bundling nor css-bundling by default.\
 > It will start with the simplest possible Rails setup and will use sprockets and importmaps.\
 > If you need to do fancy stuff, discuss with your team the opportunity of including a js-bundling and css-bundling tool.\
 > We want to go ["no build"](https://www.youtube.com/watch?v=iqXjGiQ_D-A) whenever possible.
 
-* Run `bin/setup`
-
 * Run `bundle exec rails db:migrate` to generate an empty `schema.rb` file.
+* Run `bin/setup`
 
-* Then check your default Rails setup by running `rails s` and visiting http://localhost:3000.
+* Then check your default Rails setup by running `bin/run` and visiting http://[project-name].localhost:3000.
   You should be on Rails now, yay!
 * Finally check if http://localhost:3000/up is green.
 
@@ -61,36 +59,6 @@ Some other adjustments must be performed manually.
 
 > ⭐️bin/check, bin/fastcheck and bin/run are standardized tools for more convenience at Renuo.
 
-### Manual adjustments
-
-Please perform these adjustments manually:
-
-#### ENV variables
-
-* Add `dotenv-rails` to Gemfile. Check the [gem homepage](https://github.com/bkeepers/dotenv) to see how to install the gem.
-* and create `.env.example` in the root folder of the project where you will specify the only environment variable you need for now:
-  `SECRET_KEY_BASE`.
-* Going forward we will only push the `.env.example` file to the repository in order to protect our env variables.
-* Add .env to .gitignore
-* Add the following section to your `bin/setup` script so that the `.env` is created from the `.env` when the project is setup locally:
-
-  ```ruby
-  puts "\n== Copying sample files =="
-  unless File.exist?('.env')
-    system! 'cp .env.example .env'
-  end
-  ```
-
-* add one more key to .env.example `APP_PORT=3000`
-* To ensure you have all the required keys from the `.env.example` in your `.env`,
-create the initializer for dotenv-rails in `config/initializers/dotenv_rails.rb`:
-
-```ruby
-Dotenv.require_keys(Dotenv.parse(".env.example").keys)
-```
-
-* Run `bin/setup` again.
-
 ### Secrets
 
 We store the secrets necessary to configure the project locally in a 1password Item.

ruby_on_rails/template.rb

@@ -15,7 +15,7 @@
 insert_into_file "bin/setup", before: "\n  puts \"\\n== Preparing database ==\"" do
   <<-RUBY
   puts "\\n== Fetching 1password dependencies =="
-  system! 'renuo fetch-secrets'  
+  system! 'renuo fetch-secrets'
   RUBY
 end
 
@@ -37,6 +37,45 @@
   RUBOCOP
 end
 
+answer = ask("Do you want to setup dotenv? (y/n)", default: "y")
+
+if answer.downcase == "y"
+  insert_into_file "Gemfile", after: /^group :development, :test do\n/ do
+    <<~RUBY
+    gem "dotenv"
+  RUBY
+  end
+
+  create_file ".env.example", force: true do
+    <<~ENV
+      SECRET_KEY_BASE=<%= `bin/rails secret`.strip %>
+      APP_PORT=3000
+    ENV
+  end
+
+  create_file ".env", force: true do
+    <<~ENV
+      SECRET_KEY_BASE=#{SecureRandom.hex(64)}
+      APP_PORT=3000
+    ENV
+  end
+
+  create_file "config/initializers/dotenv.rb", force: true do
+    <<~DOTENV
+      Dotenv.require_keys(Dotenv.parse(".env.example").keys)
+    DOTENV
+  end
+
+  insert_into_file "bin/setup", before: "\n  puts \"\\n== Preparing database ==\"" do
+    <<-RUBY
+    puts "\n== Copying sample files =="
+    unless File.exist?('.env')
+      system! 'cp .env.example .env'
+    end
+    RUBY
+  end
+end
+
 create_file "bin/run", force: true do
   <<~RUN
     #!/usr/bin/env bash