Add Devcontainer Support

.circleci/config.yml

@@ -26,7 +26,7 @@ aliases:
       paths:
         - node_modules
   - &ruby_node_browsers_docker_image
-      - image: cimg/ruby:3.3.3-browsers
+      - image: cimg/ruby:3.3.4-browsers
         environment:
           PGHOST: localhost
           PGUSER: untitled_application

.devcontainer/Dockerfile

@@ -0,0 +1,5 @@
+# [Choice] Ruby version: 3, 3.3, 3.2, 3.1, 3.0, 2, 2.7, 2.6
+ARG VARIANT="3.3.4"
+FROM ghcr.io/rails/devcontainer/images/ruby:${VARIANT}
+
+RUN apt-get update && apt-get install -y graphviz

.devcontainer/compose.yaml

@@ -0,0 +1,50 @@
+services:
+  rails:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+
+    volumes:
+      - ../..:/workspaces:cached
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    depends_on:
+      - postgres
+      - redis
+      # - memcached
+      - selenium
+
+    # Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
+    # (Adding the "ports" property to this file will not forward from a Codespace.)
+    ports:
+      - 45678:45678
+
+  selenium:
+    image: seleniarm/standalone-chromium
+    restart: unless-stopped
+
+  redis:
+    image: redis:latest
+    restart: unless-stopped
+    volumes:
+    - redis-data:/data
+
+  postgres:
+    image: postgres:latest
+    restart: unless-stopped
+    volumes:
+    - postgres-data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+
+  # memcached:
+  #   image: memcached:latest
+  #   restart: unless-stopped
+  #   command: ["-m", "1024"]      
+
+volumes:
+  postgres-data:
+  redis-data:

.devcontainer/devcontainer.json

@@ -0,0 +1,60 @@
+// For format details, see https://aka.ms/devcontainer.json.
+{
+  "name": "Untitled Application",
+  "dockerComposeFile": "compose.yaml",
+  "service": "rails",
+  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {},
+    "ghcr.io/devcontainers/features/node:1": {},
+    "ghcr.io/rails/devcontainer/features/activestorage": {},
+    "ghcr.io/rails/devcontainer/features/postgres-client": {}
+  },
+
+  // https://code.visualstudio.com/remote/advancedcontainers/environment-variables
+  // https://containers.dev/implementors/json_reference/#variables-in-devcontainerjson
+  "containerEnv": {
+		"PGHOST": "postgres",
+		"PGUSER": "postgres",
+		"PGPASSWORD": "postgres",
+		"REDIS_URL": "redis://redis/0",
+    "CAPYBARA_SERVER_PORT": "45678",
+    "SELENIUM_HOST": "selenium",
+		// "MEMCACHE_SERVERS": "memcached:11211"
+	},
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  "forwardPorts": [
+    3000,
+    5432,
+    6379
+  ],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "corepack enable && yarn set version 4.2.2 && bin/setup-devcontainer",
+
+	// Configure tool-specific properties.
+  "customizations": {
+    "vscode": {
+        // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "marcoroth.stimulus-lsp",
+        "bradlc.vscode-tailwindcss",
+        // "manuelpuyol.erb-linter",
+        // "setobiralo.erb-commenter",
+        // "streetsidesoftware.code-spell-checker",
+        // "GitHub.copilot",
+        // "GitHub.copilot-chat",
+        // "donjayamanne.githistory",
+        // "esbenp.prettier-vscode",
+        // "jemmyw.rails-fast-nav",
+        // "tmikoss.rails-latest-migration"
+      ]
+    }
+  }
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.ruby-version

@@ -1 +1 @@
-3.3.3
+3.3.4

bin/configure-scripts/update_configs.rb

@@ -21,6 +21,7 @@
 puts ""
 puts "Replacing instances of \"Untitled Application\" with \"#{human}\" throughout the codebase.".green
 replace_in_file("./.circleci/config.yml", "untitled_application", variable)
+replace_in_file("./.devcontainer/devcontainer.json", "Untitled Application", human)
 replace_in_file("./config/application.rb", "untitled_application", connected_name)
 replace_in_file("./config/database.yml", "untitled_application", variable)
 replace_in_file("./config/database.yml", "UNTITLED_APPLICATION", environment_variable)

bin/setup-devcontainer

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'bundler/inline'
+
+# First we require a util file that will install a few utility gems
+# and define some utility methods used by other scirpts.
+require "#{__dir__}/setup-scripts/utils"
+
+
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to individual scripts in `bin/setup-scripts` and then `require` them below.
+
+  # We need to check for the same version of ruby as bin/configure, so we
+  # reuse this one from the configure-scritps directory.
+  require "#{__dir__}/configure-scripts/check_ruby"
+  require "#{__dir__}/setup-scripts/bundle_install"
+
+  require "#{__dir__}/setup-scripts/check_node"
+  require "#{__dir__}/setup-scripts/check_yarn"
+  require "#{__dir__}/setup-scripts/yarn_install"
+
+  # Now we check that you have base-level system dependencies installed.
+  # Not needed for devcontainer, as we have a compose file with postgres and redis.
+  # require "#{__dir__}/setup-scripts/check_postgres"
+  # require "#{__dir__}/setup-scripts/check_redis"
+  # require "#{__dir__}/setup-scripts/check_icu"
+
+  require "#{__dir__}/setup-scripts/prepare_local_app"
+
+  require "#{__dir__}/setup-scripts/build_assets"
+
+  require "#{__dir__}/setup-scripts/check_overmind"
+
+  puts ""
+  puts "You're set! Now you can run bin/dev to boot your server and access your new application.".blue
+end

bin/setup-scripts/utils.rb

@@ -5,7 +5,7 @@
 gemfile do
   source "https://rubygems.org"
   require "fileutils"
-  require "colorize"
+  gem "colorize"
   require "json"
 end
 

config/database.yml

@@ -20,6 +20,15 @@ default: &default
   # For details on connection pooling, see rails configuration guide
   # http://guides.rubyonrails.org/configuring.html#database-pooling
   pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  <% if ENV["PGHOST"] %> 
+  host: <%= ENV["PGHOST"] %>
+  <% end %>
+  <% if ENV["PGUSER"] %> 
+  username: <%= ENV["PGUSER"] %>
+  <% end %>
+  <% if ENV["PGPASSWORD"] %> 
+  password: <%= ENV["PGPASSWORD"] %>
+  <% end %>
 
 development:
   <<: *default