Rails-docker-box, or developing Rails within a dockerized environment

# Installing deps at the project's root level
dip bundle install
# Run all Rails tests (I never tried 🙂)
dip rake test

# That's what I usually do
cd actioncable
# Install Action Cable dev deps
dip bundle
# Run Action Cable tests
dip rake
# Or run a particular test file
dip test test/connection/streams_test.rb

.dockerdev/
  Aptfile
  .bashrc
  Dockerfile
  compose.yml
  # Active Record configs
  config.yml
<some rails files>
dip.yml

ARG RUBY_VERSION
ARG DISTRO_NAME=bullseye

FROM ruby:$RUBY_VERSION-slim-$DISTRO_NAME
ARG DISTRO_NAME

# Common dependencies
RUN apt-get update -qq \
  && DEBIAN_FRONTEND=noninteractive apt-get install -yq --no-install-recommends \
    build-essential \
    gnupg2 \
    curl \
    less \
    git \
  && apt-get clean \
  && rm -rf /tmp/* /var/tmp/* \
  && truncate -s 0 /var/log/*log

ARG PG_MAJOR
RUN curl -sSL https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - \
  && echo deb http://apt.postgresql.org/pub/repos/apt/ $DISTRO_NAME-pgdg main $PG_MAJOR > /etc/apt/sources.list.d/pgdg.list
RUN apt-get update -qq && DEBIAN_FRONTEND=noninteractive apt-get -yq dist-upgrade && \
  DEBIAN_FRONTEND=noninteractive apt-get install -yq --no-install-recommends \
    libpq-dev \
    postgresql-client-$PG_MAJOR && \
    apt-get clean && \
    rm -rf /tmp/* /var/tmp/* && \
    truncate -s 0 /var/log/*log

# Application dependencies
# We use an external Aptfile for this, stay tuned
COPY Aptfile /tmp/Aptfile
RUN apt-get update -qq && DEBIAN_FRONTEND=noninteractive apt-get -yq dist-upgrade && \
  DEBIAN_FRONTEND=noninteractive apt-get install -yq --no-install-recommends \
    $(grep -Ev '^\s*#' /tmp/Aptfile | xargs) && \
    apt-get clean && \
    rm -rf /tmp/* /var/tmp/* && \
    truncate -s 0 /var/log/*log

ENV LANG C.UTF-8
ENV GEM_HOME /bundle
ENV BUNDLE_PATH=$GEM_HOME \
  BUNDLE_APP_CONFIG=$BUNDLE_PATH \
  BUNDLE_BIN=$BUNDLE_PATH/bin \
  BUNDLE_JOBS=4 \
  BUNDLE_RETRY=3
ENV PATH /app/bin:$BUNDLE_BIN:$PATH

ARG BUNDLER_VERSION
RUN gem update --system && \
    gem install bundler

RUN mkdir -p /app
WORKDIR /app

CMD ["/usr/bin/bash"]

vim
# Build tools
autoconf
libtool
libncurses5-dev
libxml2-dev
# ActiveRecord deps
libsqlite3-dev
default-libmysqlclient-dev

x-app: &app
  build:
    context: .
    args:
      RUBY_VERSION: '3.0.2'
      PG_MAJOR: '14'
  image: rails-dev:7.1.0
  tmpfs:
    - /tmp

services:
  runner:
    <<: *app
    stdin_open: true
    tty: true
    volumes:
      - ..:/app:cached
      - bundle:/bundle
      - history:/usr/local/hist
      - ./.psqlrc:/root/.psqlrc:ro
      - ./.bashrc:/root/.bashrc:ro
    environment:
      REDIS_URL: redis://redis:6379/
      DATABASE_URL: postgres://postgres:postgres@postgres/
      HISTFILE: /usr/local/hist/.bash_history
      XDG_DATA_HOME: /app/tmp/caches
      EDITOR: vi
      # Use PostgreSQL by default for AR tests
      ARCONN: ${ARCONN:-postgresql}
    working_dir: ${WORK_DIR:-/app}
    depends_on:
      postgres:
        condition: service_healthy
      redis:
        condition: service_healthy

  postgres:
    image: postgres:14
    volumes:
      - .psqlrc:/root/.psqlrc:ro
      - postgres:/var/lib/postgresql/data
      - history:/user/local/hist
    environment:
      PSQL_HISTFILE: /user/local/hist/.psql_history
      POSTGRES_PASSWORD: postgres
      # For createdb
      PGPASSWORD: postgres
    ports:
      - 5432
    healthcheck:
      test: pg_isready -U postgres -h 127.0.0.1
      interval: 5s

  redis:
    image: redis:6.2-alpine
    volumes:
      - redis:/data
    ports:
      - 6379
    healthcheck:
      test: redis-cli ping
      interval: 1s
      timeout: 3s
      retries: 30

volumes:
  history:
  postgres:
  redis:
  bundle:

alias be="bundle exec"

version: '7.1'

environment:
  WORK_DIR: /app/${DIP_WORK_DIR_REL_PATH}

compose:
  files:
    - .dockerdev/compose.yml
  project_name: rails_dev

interaction:
  # This command spins up a Rails container with the required dependencies (such as databases),
  # and opens a terminal within it.
  runner:
    description: Open a Bash shell within a Rails container (with dependencies up)
    service: runner
    command: /bin/bash

  # Run a Rails container without any dependent services (useful for non-Rails scripts)
  bash:
    description: Run an arbitrary script within a container (or open a shell without deps)
    service: runner
    command: /bin/bash
    compose_run_options: [ no-deps ]

  # A shortcut to run Bundler commands
  bundle:
    description: Run Bundler commands
    service: runner
    command: bundle
    compose_run_options: [ no-deps ]

  rake:
    description: Run Rake commands
    service: runner
    command: bundle exec rake

  ruby:
    description: Run Ruby with Bundler activated
    service: runner
    command: bundle exec ruby

  rubocop:
    description: Run RuboCop
    service: runner
    command: bundle exec rubocop
    compose_run_options: [ no-deps ]

  test:
    description: Run a single test file (an alias for ruby -Ilib:test)
    service: runner
    command: bundle exec ruby -Ilib:test

  psql:
    description: Run Postgres psql console
    service: postgres
    default_args: anycasts_dev
    command: psql -h postgres -U postgres

  createdb:
    description: Create a PostgreSQL database
    service: postgres
    command: createdb -h postgres -U postgres

  'redis-cli':
    description: Run Redis console
    service: redis
    command: redis-cli -h redis

provision:
  - dip compose down --volumes
  - dip compose up -d postgres redis
  - dip bundle install
  - (test -f activerecord/test/config.yml) || (cp .dockerdev/config.yml activerecord/test/config.yml)
  - dip createdb activerecord_unittest
  - dip createdb activerecord_unittest2

# .git/info/exclude

dip.yml
.dockerdev/