Rails7.1 + PostgreSQL + ESBuildの環境構築 2024

2024/07/06

2024/07/07

# Ruby on Rails

ローカルでRailsプロジェクトを作成

ローカルでRailsの新規プロジェクトを作成します。
各バージョンは以下で行なっています。

$  ruby -v
ruby 3.3.0

$ rails -v
Rails 7.1.3.4

$ node -v
v20.10.0

$ yarn -v
1.22.22

rails newで新規プロジェクトを作成します。

rails new myapp --database=postgresql --javascript=esbuild --css=tailwind --skip-test

オプションとして以下を設定しています。

データベースにPostgreSQLを使用
JavaScriptのビルドにESBuildを使用
cssフレームワークのTailwind CSSを使用
minitestの設定をスキップ

以下のファイルが問題なく作成されたら完了です。

$ cd myapp
$ ls
Dockerfile         README.md          config             log                storage            yarn.lock
Gemfile            Rakefile           config.ru          node_modules       tailwind.config.js
Gemfile.lock       app                db                 package.json       tmp
Procfile.dev       bin                lib                public             vendor

開発環境用のファイルを作成

Dockerfile.dev

プロジェクトルートにDockerfile.devファイルを作成し、自動生成されたDockerfileの内容をコピーして本番環境用の記述を削除します。

# syntax = docker/dockerfile:1

# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
ARG RUBY_VERSION=3.3.0
FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base

# Rails app lives here
WORKDIR /rails

# ----- ↓削除↓ -----
# Set production environment
ENV RAILS_ENV="production" \
    BUNDLE_DEPLOYMENT="1" \
    BUNDLE_PATH="/usr/local/bundle" \
    BUNDLE_WITHOUT="development"


# Throw-away build stage to reduce size of final image
FROM base as build
# ----- ↑削除↑ -----

# Install packages needed to build gems and node modules
RUN apt-get update -qq && \
    apt-get install --no-install-recommends -y build-essential curl git libpq-dev libvips node-gyp pkg-config python-is-python3

# Install JavaScript dependencies
ARG NODE_VERSION=20.10.0
ARG YARN_VERSION=1.22.22
ENV PATH=/usr/local/node/bin:$PATH
RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
    npm install -g yarn@$YARN_VERSION && \
    rm -rf /tmp/node-build-master

# Install application gems
COPY Gemfile Gemfile.lock ./
RUN bundle install && \
    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
    bundle exec bootsnap precompile --gemfile

# Install node modules
COPY package.json yarn.lock ./
RUN yarn install --frozen-lockfile

# Copy application code
COPY . .

# ----- ↓削除↓ -----
# Precompile bootsnap code for faster boot times
RUN bundle exec bootsnap precompile app/ lib/

# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile


# Final stage for app image
FROM base

# Install packages needed for deployment
RUN apt-get update -qq && \
    apt-get install --no-install-recommends -y curl libvips postgresql-client && \
    rm -rf /var/lib/apt/lists /var/cache/apt/archives

# Copy built artifacts: gems, application
COPY --from=build /usr/local/bundle /usr/local/bundle
COPY --from=build /rails /rails

# Run and own only the runtime files as a non-root user for security
RUN useradd rails --create-home --shell /bin/bash && \
    chown -R rails:rails db log storage tmp
USER rails:rails

# Entrypoint prepares the database.
ENTRYPOINT ["/rails/bin/docker-entrypoint"]

# Start the server by default, this can be overwritten at runtime
EXPOSE 3000
CMD ["./bin/rails", "server"]
# ----- ↑削除↑ -----

削除後のDockerfile.devは以下のようになります。

# syntax = docker/dockerfile:1

# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
ARG RUBY_VERSION=3.3.0
FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base

# Rails app lives here
WORKDIR /myapp

# Install packages needed to build gems and node modules
RUN apt-get update -qq && \
    apt-get install --no-install-recommends -y build-essential curl git libpq-dev libvips node-gyp pkg-config python-is-python3

# Install JavaScript dependencies
ARG NODE_VERSION=20.10.0
ARG YARN_VERSION=1.22.22
ENV PATH=/usr/local/node/bin:$PATH
RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
    npm install -g yarn@$YARN_VERSION && \
    rm -rf /tmp/node-build-master

# Install application gems
COPY Gemfile Gemfile.lock ./
RUN bundle install && \
    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
    bundle exec bootsnap precompile --gemfile

# Install node modules
COPY package.json yarn.lock ./
RUN yarn install --frozen-lockfile

# Copy application code
COPY . .

compose.yaml

プロジェクトルートにcompose.yamlファイルを作成します。

services:
  db:
    image: postgres:16.3-alpine
    container_name: myapp-postgres-16.3
    volumes:
      - db_data:/var/lib/postgresql/data
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: password
    ports:
      - "5432:5432"
  web:
    build:
      context: .
      dockerfile: Dockerfile.dev
    command: bash -c "rm -f tmp/pids/server.pid && bin/dev"
    environment:
      TZ: Asia/Tokyo
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: password
    volumes:
      - .:/rails
    ports:
      - "3000:3000"
    stdin_open: true
    tty: true
    depends_on:
      - db

volumes:
  db_data:

開発環境用にファイル編集

database.yml

config/database.ymlを次のように編集します。

default: &default
  adapter: postgresql
  encoding: unicode
  # For details on connection pooling, see Rails configuration guide
  # https://guides.rubyonrails.org/configuring.html#database-pooling
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  host: db
  username: <%= ENV["POSTGRES_USER"] %>
  password: <%= ENV["POSTGRES_PASSWORD"] %>

development:
  <<: *default
  database: myapp_development

test:
  <<: *default
  database: myapp_test

production:
  <<: *default
  database: myapp_production
  username: myapp
  password: <%= ENV["MYAPP_DATABASE_PASSWORD"] %>

Procfile.dev

Docker環境用にProcfile.devを編集します。
webの行に-p 3000 -b '0.0.0.0'を追加することでDocker環境でRailsプロジェクトを立ち上げることができます。

web: env RUBY_DEBUG_OPEN=true bin/rails server -p 3000 -b '0.0.0.0'
js: yarn build --watch
css: yarn build:css --watch

立ち上げ

以下の順番で実行し、立ち上げます。

# ビルド
$ docker compose build
$ docker compose run --rm web yarn install
$ docker compose run --rm web rails db:create
$ docker compose up

localhost:3000にアクセスして以下の画面が表示されたら完了です。

日本時刻に設定

現状の時刻設定がどうなっているかコンソールで確認します。

docker compose run --rm web rails c
irb(main):001> Time.now
=> 2024-07-06 23:51:59.561845548 +0900
irb(main):002> Time.current
=> Sat, 06 Jul 2024 14:52:49.243361043 UTC +00:00

Time.nowの場合は日本時刻になっていますが、Time.currentはUTC時刻(協定世界時)になっています。

Time.nowはOSのタイムゾーン(今回はcompose.yamlに記載したAsia/Tokyo)を表示し、Time.currentはアプリケーションの設定時刻を表示しているため、結果が異なっています。

アプリケーションのタイムゾーンを日本時間に設定します。


# 省略
module Myapp
  class Application < Rails::Application
    # 省略
    config.time_zone = 'Tokyo' # 追加
  end
end

コンソールを再起動してもう一度確認します。

docker compose run --rm web rails c
irb(main):001> Time.now
=> 2024-07-07 00:02:23.81375567 +0900
irb(main):002> Time.current
=> Sun, 07 Jul 2024 00:02:21.636353169 JST +09:00

両方日本時刻になっていれば設定完了です。

以上で環境構築は完了です。
次回はRSpecの実行環境を構築していきます。

参考

https://www.youtube.com/watch?v=omv-qHu8FGU&t=604s
https://www.youtube.com/watch?v=ignW-lxGEc0&t=495s

share on