shimizu-challenge by shimizu0429 · Pull Request #76 · enechange/coding-challenge

shimizu0429 · 2025-10-02T06:23:39Z

shimizu-challenge

Note

Introduces electricity pricing API (YAML and DB-backed), supporting models/migrations, config/routes, and deployment/docker setup with minor env and gem updates.

API:
- Add ApiController with GET /api/get_price (YAML) and GET /api/get_price_db (DB) returning computed electricity fees.
Domain Models & DB:
- Implement EnergyPlan (YAML-based), EnergyPlanDb with BasicFee and UnitFee.
- Add migrations: energy_plans, basic_fees, unit_fees.
Configuration:
- Add config/api_settings.yml and initializer config/initializers/load_settings.rb.
- Update config/routes.rb to expose API endpoints; add minimal layout and public/index.html test UI.
- Adjust config/application.rb to include cookies/session/flash middleware.
- Update config/database.yml (dev DB host/name; production via DATABASE_URL).
- Tweak config/environments/production.rb (hosts, logging) and config/puma.rb.
Build/Deploy:
- Add .dockerignore, overhaul Dockerfile for production run, add fly.toml.
Dependencies:
- Add rails-html-sanitizer; update Rails and related gems in Gemfile.lock.

^{Written by Cursor Bugbot for commit 6433bae. This will update automatically on new commits. Configure here.}

sugita-seiya

ご提出ありがとうございます！
細かい点ですがコメントしましたので、ご確認お願いします。
併せて、追加で3点コメントさせてください。

◽️1つ目
弊社ではテストコードを非常に重視しており、可能な範囲でテストの追加をご対応いただけますと幸いです。
もしご都合などでテスト追加が難しい場合は、ファイル単位でテスト観点を箇条書きで共有いただけますでしょうか。

例：
controllers/api_controller.rb
- 正常系
    - xxxx
- 異常系
    - xxxx

◽️2つ目

計算結果において、電力量としてマイナス値（price: -1）が返却されているため、計算処理の見直しをお願いします。

◽️3つ目

使用量に非常に大きい数値を入力した際、計算結果として不自然に大きな値（例：1.5285e+49 など）が返却されています。
こちらもご確認お願いします。

sugita-seiya · 2025-10-03T07:41:11Z

serverside_challenge_2/challenge/app/controllers/electricity_api_controller.rb

コントローラ全体がネストされておらず、不要な空白も多いため、Rubocop を導入してコードスタイルを統一するのがよさそうです。
さらに、ApiController というクラス名は抽象的で、今後 API が増えた際に責務が曖昧になる可能性があります。

ElectricityApiControllerに変更いたしました

sugita-seiya · 2025-10-03T07:47:28Z

serverside_challenge_2/challenge/app/models/energy_plan.rb

+	# 基本料金 + 従量料金 を小数点2桁で丸めて返す
+    (fee + usage_fee).round(2)


Q

小数点2桁で丸めた理由はなんでしょうか？
実装の意図をお聞きしたいです。

対象プランと料金表の基本料金、従量料金単価ともに少数2桁で表現してありましたのでそれに揃える形で少数2桁で丸めております。

sugita-seiya · 2025-10-03T07:51:23Z

serverside_challenge_2/challenge/app/models/energy_plan.rb

+    Rails.logger.error("Error calculating fee: #{e.message}")
+    -1
+  end


IMO

-1 がマジックナンバーになっているように見えます。
特別な意味を持たせている場合は、定数化を検討いただくと、実装意図がより明確になり、コードも読みやすくなりそうです。

\config\initializers\constants.rb　を作成し定数としました。

sugita-seiya

資料作成ありがとうございます。

energy_plansテーブルに provider_name と plan_name を持たせる設計だと、同一会社に複数のプランが存在するケースでデータの不整合が発生するリスクがあります。
そのため、DB正規化をした方が良いと考えていますが、設計方針についての考えを教えていただきたいです。

ksugiura-ene · 2025-10-03T13:13:25Z

serverside_challenge_2/challenge/app/controllers/api/_electricity_controller.rb

@@ -0,0 +1,25 @@
+class Api::ElectricityController < ApplicationController


Q

こちらのファイルは何のために存在するファイルでしょうか。

どのようなことを試したか残しておりましたが使用していないファイルは削除いたしました

ありがとうございます。

ksugiura-ene · 2025-10-03T13:53:56Z

serverside_challenge_2/challenge/app/models/energy_plan_db.rb_

@@ -0,0 +1,56 @@
+# app/models/energy_plan_db.rb


IMO

不要なファイルは混乱の元になるので削除した方が良いと思いました。

不要なファイルは削除いたしました
energy_plan_db.rbはDBからのデータ取得に使用しております

ご対応有難うございます。

ksugiura-ene · 2025-10-03T14:01:49Z

serverside_challenge_2/challenge/config/routes.rb

+  get "api/get_price", to: "api#get_price"     # JSON API
+  get "api/get_price_db", to: "api#get_price_db"     # JSON API


Q

APIの設計的にGET api/get_priceというpathのget_部分が冗長だと思いました。
また、このパスは何かの価格を取得するということはわかりますが、何をするAPIなのか不明確だと思いました。
お考えお聞きできますでしょうか。

get_priceとget_price_dbとあり、get_priceは設定値をYAML、get_price_dbは設定値をDBから取得し計算しております。

ご回答ありがとうございます。修正などは不要です。

ksugiura-ene · 2025-10-03T14:03:37Z

serverside_challenge_2/challenge/app/controllers/electricity_api_controller.rb

@@ -0,0 +1,64 @@
+class ApiController < ApplicationController
+def get_price


一つのControllerに３つの異なるpathのget actionが含まれています。
ファイル分割した方が良いと思いました。

今まではControllerに複数のアクションを持つような設計をしておりました。
Rubyでの開発経験が無いのでRubyでは基本1つのアクションであったり御社の規約がそのようであれば合わせます。

ご回答ありがとうございます。

Rubyでの開発経験が無いので
こちら伺っています。修正などは不要です。

ksugiura-ene · 2025-10-03T14:18:58Z

serverside_challenge_2/challenge/config/api_settings.yml

+  - provider_name: 東京電力エナジーパートナー
+    plan_name: 従量電灯B
+    basic_fee:
+      10: 286.0
+      15: 429.0
+      20: 572.0
+      30: 858.0
+      40: 1144.0
+      50: 1430.0
+      60: 1716.0
+    unit_fee:
+      "0-120": 19.88
+      "121-300": 26.48
+      "301-0": 30.57
+
+  - provider_name: 東京電力エナジーパートナー
+    plan_name: スタンダードS
+    basic_fee:
+      10: 311.75
+      15: 467.63
+      20: 623.50
+      30: 935.25
+      40: 1247.00
+      50: 1558.75
+      60: 1870.50
+    unit_fee:
+      "0-120": 29.80
+      "121-300": 36.40
+      "301-0": 40.49
+
+  - provider_name: 東京ガス
+    plan_name: ずっとも電気1
+    basic_fee:
+      30: 858.0
+      40: 1144.0
+      50: 1430.0
+      60: 1716.0
+    unit_fee:
+      "0-140": 23.67
+      "141-350": 23.88
+      "351-0": 26.41
+
+  - provider_name: Looopでんき
+    plan_name: おうちプラン


Q

developmentとproductionで同一のデータ定義をしている理由はありますでしょうか。

developmentはローカル環境、productionはサーバー環境での設定値になりますので同じ値でも分けて定義しております

承知しました。修正など不要です。

本番、開発用でそれぞれ定義するとマスタ更新時の手間が増えると思いお聞きしました。
yamlの場合設定の共通化が可能ですので、それを使うと良いと思いました。

ksugiura-ene · 2025-10-03T14:24:50Z

serverside_challenge_2/challenge/config/api_settings.yml

+    unit_fee:
+      "0-0": 28.8
+
+  - provider_name: YAMLtest


Q

YAMLで計算をクリックした場合の結果にテスト用らしきデータが出てきますが、要件にないので何を想定して出力しているのかをお聞きしたいです。

{ "provider_name": "YAMLtest", "plan_name": "テスト", "price": -1 }

画面から確認するのにYAMLからデータを取得しているか、DBからデータを取得しているか目に見えて分かるようにYAMLのほうに仮で設定値を追加いたしました。

承知しました。ご回答ありがとうございます。

ksugiura-ene · 2025-10-03T14:43:08Z

serverside_challenge_2/challenge/app/models/energy_plan_db.rb

+      # この従量料金が適用される最小使用量 (kWh)
+      min = uf.min_kwh.to_f
+      # 最大使用量が未設定(nil) または 0 の場合は「上限なし」として扱う
+      max = uf.max_kwh.nil? || uf.max_kwh.zero? ? Float::INFINITY : uf.max_kwh.to_f


Q

max_kwh,min_kwhはUI上整数値受付となっていますがDBとこの処理ではfloatで扱われています。
整数値ではなくfloatで扱っている理由はありますでしょうか。

計算する際にfloatで合わせたら楽かなと思いfloatにしました。特に楽ということもありませんでしたね。

ご回答ありがとうございます。承知しました。

cursor · 2025-10-06T06:25:26Z

serverside_challenge_2/challenge/config/secrets.yml

+ secret_key_base:  022eeea32ce3537c8caa3d494d34cbb5ea55bc5ff97a6f656a329973dd27c408f335ffca6d39184a8ab695062aa1f3cb5a64eb8c4cea22c39d12c651d0590212
+
+production:
+ secret_key_base:  022eeea32ce3537c8caa3d494d34cbb5ea55bc5ff97a6f656a329973dd27c408f335ffca6d39184a8ab695062aa1f3cb5a64eb8c4cea22c39d12c651d0590212


Bug: Hardcoded Secret Key Across Environments

The secret_key_base is hardcoded and identical across development, test, and production environments. This is a serious security vulnerability. Secret keys are typically unique per environment and not stored in version control, which exposes the production key and can lead to session hijacking and application compromise.

cursor · 2025-10-06T06:25:26Z

serverside_challenge_2/challenge/fly.toml

+
+[[services]]
+  protocol = 'tcp'
+  internal_port = 8080


Bug: Port Mismatch in Configuration

The fly.toml config sets internal_port to 8080, but the Dockerfile CMD starts the Rails server on port 3000. This port mismatch makes the application unreachable.

cursor · 2025-10-06T06:25:26Z

serverside_challenge_2/challenge/config/database.yml

-  database: app_test
+  host: db
+  port: 5432
+  database: challenge_db


Bug: Missing Test Environment Configuration

The database configuration is missing the test environment section. Rails applications rely on a separate test database, and its absence will lead to test failures.

shimizu0429 · 2025-10-06T06:56:11Z

コメントについて返信させていただきます。
■3つのコメントについて
●1つ目について
今までのプロジェクトでは、エンジニアごとに開発サーバーに開発環境を持ち単体テスト、統合開発環境で結合テスト
こちらのテストについてはテスターが行っておりテストコードを作成する機会がありませんでした。
テスト観点を箇条書きで書き出します。

正常系
有効な契約アンペア数がセットされているか（10 / 15 / 20 / 30 / 40 / 50 / 60）
有効な使用量がセットされているか（0～99,999,999）
返却メッセージ無し
異常系
①
有効な契約アンペア数がセットされているか（10 / 15 / 20 / 30 / 40 / 50 / 60）
無効な使用量がセットされているか（-1, 999,999,999）等
返却メッセージ：対応する基本料金が見つかりません
②
無効な契約アンペア数がセットされているか（0 / 99）等
有効な使用量がセットされているか（0～99,999,999）
返却メッセージ：使用量が異常値です
③
無効な契約アンペア数がセットされているか（0 / 99）等
無効な使用量がセットされているか（-1, 999,999,999）等
返却メッセージ：使用量が異常値です

●2つ目について
ずっとも電気1は10Aの設定値がセットされていないのでエラーで返却されます。
エラーが判別しにくいのでエラーがあった場合はmessageにエラーメッセージを返却するようにいたしました。

●3つ目について
使用量には0～99999999の値以外にはエラーとなるよう変更いたしました。
上限は常識的に入るであろう値で考えております。

■energy_plansテーブルについて
会社名の正規化も考えましたがこのプロジェクト規模ですと会社名のみの正規化となりテーブルを分けるよりは
energy_plansで文字列として扱った方が管理しやすいと思い現在の形にいたしました。

shimizu-takeshi added 7 commits September 29, 2025 15:21

基本項目まで完了

dc3ee06

追加項目、DB、フロントエンド

f84a6cf

dbsettings

ecf62ec

公開サーバー作成中

e4cfc14

fly用DB設定

1382b15

fly用DB設定2

ebc6561

本番立ち上げ完了

6433bae

This comment was marked as outdated.

Sign in to view

sugita-seiya reviewed Oct 3, 2025

View reviewed changes

ksugiura-ene reviewed Oct 3, 2025

View reviewed changes

エラーメッセージ返却、コントローラ名変更

f05abb0

cursor bot reviewed Oct 6, 2025

View reviewed changes

		# 基本料金 + 従量料金を小数点2桁で丸めて返す
		(fee + usage_fee).round(2)

		@@ -0,0 +1,25 @@
		class Api::ElectricityController < ApplicationController

		get "api/get_price", to: "api#get_price" # JSON API
		get "api/get_price_db", to: "api#get_price_db" # JSON API

		@@ -0,0 +1,64 @@
		class ApiController < ApplicationController
		def get_price

Comments

Conversation

shimizu0429 commented Oct 2, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

sugita-seiya left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sugita-seiya left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cursor bot Oct 6, 2025

Choose a reason for hiding this comment

Bug: Hardcoded Secret Key Across Environments

Uh oh!

cursor bot Oct 6, 2025

Choose a reason for hiding this comment

Bug: Port Mismatch in Configuration

Uh oh!

cursor bot Oct 6, 2025

Choose a reason for hiding this comment

Bug: Missing Test Environment Configuration

shimizu0429 commented Oct 2, 2025 •

edited by cursor bot

Loading

sugita-seiya left a comment •

edited

Loading

sugita-seiya left a comment •

edited

Loading