【杉山】serverside_challenge_2: 電気料金のシミュレーションを実装

serverside_challenge_2/challenge/Makefile

@@ -0,0 +1,32 @@
+DC = docker compose
+DC_TEST = $(DC) -f compose.test.yml
+
+.PHONY: build up down api-bash init test-build test-up test-down test-api-bash
+
+build:
+	$(DC) build
+up:
+	$(DC) up -d
+
+down:
+	$(DC) down
+
+api-bash:
+	$(DC) exec api bash
+
+init:
+	$(DC) exec api rails db:create
+	$(DC) exec api rails db:migrate
+	$(DC) exec api rails db:seed
+
+test-build:
+	$(DC_TEST) build
+
+test-up:
+	$(DC_TEST) up -d
+
+test-down:
+	$(DC_TEST) down
+
+test-api-bash:
+	$(DC_TEST) exec test-api bash

serverside_challenge_2/challenge/README.md

@@ -1,24 +1,70 @@
-# README
+## 概要
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+このリポジトリは「電気料金のシミュレーション」の課題提出用プロジェクトです。
+指定された電力量と契約アンペア数を元に複数の電力プランを算出します。
 
-Things you may want to cover:
+## 使用技術について
+- フロントエンド: Next.js(TypeScript)
+- バックエンド: Ruby, Ruby on Rails
+- 本番環境:
+  - フロントエンド: Vercel
+  - バックエンド: Cloud Run
+  - データベース: Supabase(PostgreSQL)
 
-* Ruby version
+### インフラ構成について
+- 基本的に費用の掛からない構成で構築しております。
+- Cloud Runはコールドスタートのため起動していない時はレスポンスが少し遅いのでご了承ください。
 
-* System dependencies
+## 各環境のURLについて
+### 本番環境
+  - フロントエンド: https://coding-challenge-rouge-seven.vercel.app
+  - バックエンド: https://energy-charges-118821896069.asia-northeast1.run.app
+### 開発環境
+  - フロントエンド: http://localhost:3001
+  - バックエンド: http://localhost:3000
 
-* Configuration
+### 使い方
+- https://coding-challenge-rouge-seven.vercel.app にアクセス
+- 「契約アンペア数(A)」と「使用量(kWh)」を入力後「計算する」ボタンを押下
+- 「プロバイダ名」「プラン名」「電気料金」情報が返ってくる
 
-* Database creation
+## ディレクトリ構成(ラフ)について
+<pre>
+challenge/
+├── front/                # フロントエンド (Next.js / TypeScript)
+│   ├── app/
+│   ├── dot.env           # 共有用環境変数ファイル
+│   ├── Dockerfile        # 開発環境用Dockerfile
+│   └── ...
+└── api/                  # バックエンド (Ruby on Rails API)
+    ├── app/
+    ├── dot.env           # 共有用環境変数ファイル
+    ├── Dockerfile        # 開発環境用Dockerfile
+    ├── Dockerfile.prd    # Cloud Run用Dockerfile
+    └── ...
+├── Makefile              # ビルド・起動コマンド群
+├── compose.yml           # 開発用docker compose
+├── compose.test.yml      # テスト用docker compose
+</pre>
 
-* Database initialization
+## 開発環境構築手順について
+```bash
+cd coding-challenge/serverside_challenge_2/challenge
+cp api/dot.env api/.env
+cp front/dot.env front/.env
 
-* How to run the test suite
+make build
+make up
+make api-bash
+rails db:migrate:reset db:seed
+```
 
-* Services (job queues, cache servers, search engines, etc.)
+## 補足
+- このリポジトリは課題提出用のため、`service.yaml`や`GithubActions`などの構成ファイルは作成しておりません。
+- `Cloud Run`へは手動デプロイを実施しております。
+- `docker build -f Dockerfile.prd --platform linux/amd64 -t (GARのリンク) .` でイメージをビルド
+- `docker push (GARのリンク):latest` でビルドしたイメージにlatestタグをつけてGARにプッシュ
+- `Cloud RunのUIから環境変数の設定および`Image`の指定をしております。`
 
-* Deployment instructions
-
-* ...
+- 各機能実装時の記録としてプルリクエストを随時作成しております。
+- 確認手順などはプルリクエストへ詳細に記載させていただいております。

serverside_challenge_2/challenge/api/.dockerignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.dockerignore
+/.git/
+/.git*
+/.ruby-version
+/README.md
+/config/master.key
+/log/
+/node_modules/
+/storage/
+/tmp/
+/vendor/bundle/
+/public/uploads/

serverside_challenge_2/challenge/.gitignore → serverside_challenge_2/challenge/api/.gitignore

@@ -27,3 +27,5 @@
 
 # Ignore master key for decrypting credentials and more.
 /config/master.key
+.env
+.env.test

serverside_challenge_2/challenge/api/.rubocop.yml

@@ -0,0 +1,33 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+plugins:
+  - rubocop-rails
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Rails/LexicallyScopedActionFilter:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: percent
+
+AllCops:
+  SuggestExtensions: false
+  Exclude:
+    - 'db/**/*'
+    - 'lib/tasks/**/*'
+    - 'config/application.rb'
+    - 'config/environments/**/*'
+    - 'config/initializers/**/*'
+    - 'bin/**/*'
+    - 'vendor/**/*'
+    - 'Rakefile'
+    - 'config.ru'

serverside_challenge_2/challenge/api/Dockerfile.prd

@@ -0,0 +1,34 @@
+FROM ruby:3.1.2-slim-bullseye AS base
+
+ENV LANG=C.UTF-8 \
+    RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle"
+WORKDIR /app
+
+FROM base AS builder
+
+RUN apt-get update -qq && \
+    apt-get install -y build-essential libpq-dev && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY Gemfile Gemfile.lock ./
+RUN bundle install --jobs "$(nproc)" --without development test && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git
+
+COPY . .
+
+FROM base AS runner
+
+RUN apt-get update -qq && \
+    apt-get install -y libpq-dev && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/local/bundle /usr/local/bundle
+COPY --from=builder /app /app
+COPY db/csv /app/db/csv
+
+RUN chmod +x bin/start.sh
+
+EXPOSE ${PORT:-8080}
+CMD ["bin/start.sh"]

serverside_challenge_2/challenge/Gemfile → serverside_challenge_2/challenge/api/Gemfile

@@ -1,16 +1,18 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby "3.1.2"
+ruby '3.1.2'
 
 # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
-gem "rails", "~> 7.0.8"
+gem 'rails', '~> 7.0.8'
 
 # Use postgresql as the database for Active Record
-gem "pg", "~> 1.1"
+gem 'pg', '~> 1.1'
 
 # Use the Puma web server [https://github.com/puma/puma]
-gem "puma", "~> 5.0"
+gem 'puma', '~> 5.0'
 
 # Build JSON APIs with ease [https://github.com/rails/jbuilder]
 # gem "jbuilder"
@@ -25,10 +27,10 @@ gem "puma", "~> 5.0"
 # gem "bcrypt", "~> 3.1.7"
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
 # Reduces boot times through caching; required in config/boot.rb
-gem "bootsnap", require: false
+gem 'bootsnap', require: false
 
 # Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
 # gem "image_processing", "~> 1.2"
@@ -38,11 +40,26 @@ gem "bootsnap", require: false
 
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
-  gem "debug", platforms: %i[ mri mingw x64_mingw ]
+  gem 'debug', platforms: [:mri, :mingw, :x64_mingw]
+  gem 'rubocop', require: false
+  gem 'rubocop-rails', require: false
+  gem 'rubocop-shopify', require: false
+  gem 'annotate', require: false
+  gem 'pry-rails'
 end
 
 group :development do
   # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
   # gem "spring"
 end
 
+group :test do
+  gem 'factory_bot_rails'
+  gem 'shoulda-matchers', '~> 6.0'
+  gem 'shoulda-context', '~> 3.0.0.rc1'
+  gem 'minitest-power_assert'
+  gem 'faker'
+  gem 'mocha'
+end
+
+gem 'rack-cors'