Skip to content

Commit 9d12b39

Browse files
authored
Merge pull request #1745 from coderdojo-japan/refactor/unify-yaml-extensions-to-yml
♻️ Refactor: YAMLファイルの拡張子を .yaml から .yml に統一
2 parents 3371676 + 7e84abd commit 9d12b39

15 files changed

+36
-36
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ coderdojo.jp の開発には以下のいずれかの方法で参加できます
3939

4040
Dojo 情報は次の手順で簡単に更新できます。
4141

42-
1. [db/dojos.yaml](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojos.yaml) を開く
42+
1. [db/dojos.yml](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojos.yml) を開く
4343
2. 画面右にある ✎ アイコン (Fork this project and edit this file) をクリックする
4444
3. 気になる箇所を修正し、修正内容にタイトルと説明文を付け、Propose file change をクリックする
4545
4. 修正内容を確認し、問題なければ Create pull request をクリックする
@@ -157,10 +157,10 @@ bundle exec rails db:migrate
157157
# 開発用データの流し込み(seeding)
158158
bundle exec rails db:seed
159159

160-
# db/dojos.yaml の内容をDBに反映するタスク
160+
# db/dojos.yml の内容をDBに反映するタスク
161161
bundle exec rails dojos:update_db_by_yaml
162162

163-
# DBの内容を db/dojos.yaml に反映するタスク
163+
# DBの内容を db/dojos.yml に反映するタスク
164164
bundle exec rails dojos:migrate_adding_id_to_yaml
165165

166166
# 近日開催の道場を更新するタスク
@@ -242,8 +242,8 @@ We use `SCRIVITO_TENANT` and `SCRIVITO_API_KEY` keys in production, but they are
242242
なお本サイト内 DB の各テーブルおよびそのデータ(一般公開部分のみ)は、以下のファイルからご確認いただけます。
243243

244244
- DB テーブル: [`db/schema.rb`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/schema.rb)
245-
- Dojo データ: [`db/dojos.yaml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojo_event_services.yaml)
246-
- Event データ (の情報取得元): [`db/dojo_event_services.yaml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojo_event_services.yaml)
245+
- Dojo データ: [`db/dojos.yml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojos.yml)
246+
- Event データ (の情報取得元): [`db/dojo_event_services.yml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojo_event_services.yml)
247247
- :memo: 1つの Dojo が複数のイベント管理サービスを使う事例もあるため [`Dojo has_many DojoEventServices`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/app/models/dojo.rb) となっています。
248248

249249

app/models/dojo.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ class Dojo < ApplicationRecord
44
NUM_OF_ANNUAL_NINJAS = "7,000"
55
NUM_OF_TOTAL_EVENTS = "10,000"
66
NUM_OF_TOTAL_NINJAS = "62,000"
7-
DOJO_INFO_YAML_PATH = Rails.root.join('db', 'dojos.yaml')
7+
DOJO_INFO_YAML_PATH = Rails.root.join('db', 'dojos.yml')
88

99
belongs_to :prefecture
1010
has_many :dojo_event_services, dependent: :destroy
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919
# 現在は connpass と doorkeeper のみ対応しています。
2020
#
2121
# Facebook イベントなどを含む非対応のイベント情報については、
22-
# `db/static_event_histories.yaml` から手動でデータ入力が可能です。
23-
# https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/static_event_histories.yaml
22+
# `db/static_event_histories.yml` から手動でデータ入力が可能です。
23+
# https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/static_event_histories.yml
2424

2525

2626

2727
### 以下、Dojo 情報まとめ ###
28-
### (dojos.yaml の追加順) ###
28+
### (dojos.yml の追加順) ###
2929

3030
# 播磨科学公園都市(兵庫県上郡町)
3131
#- dojo_id: 343
@@ -34,7 +34,7 @@
3434
# url: https://codeclub.org/ja/clubs/1700a138-2909-4e4e-9e75-88ebcbbbc55a
3535

3636
# 砧(東京都世田谷区)- connpass の個人アカウントのため登録できない。グループアカウントにする必要がある。
37-
# TODO: グループ化されたら dojos.yamlのurlも合わせて更新
37+
# TODO: グループ化されたら dojos.ymlのurlも合わせて更新
3838
#- dojo_id: 342
3939
# name: connpass
4040
# group_id: ???
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
##########################
44
#
55
# This is outdated and will be removed.
6-
# Use `db/static_event_histories.yaml` instead:
7-
# https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/static_event_histories.yaml
6+
# Use `db/static_event_histories.yml` instead:
7+
# https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/static_event_histories.yml
88
#
99
# example
1010
# - dojo_id: 80

doc/how_to_add_dojo.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616
1. 掲載依頼の申請内容を確認する
1717
2. 総務省の[全国地方公共団体コード](https://www.soumu.go.jp/denshijiti/code.html)ページに行く
1818
3. 最新版の PDF にアクセスし、申請内容と一致する全国地方公共団体コードを確認する
19-
4. `db/dojos.yaml` ファイルを開き、全国地方公共団体コードの近い値(隣接する Dojo)のデータを見つける
19+
4. `db/dojos.yml` ファイルを開き、全国地方公共団体コードの近い値(隣接する Dojo)のデータを見つける
2020
5. 同じ全国地方公共団体コードがあれば同コードの直後に、初のコードであれば `order` の昇順で適した場所を探す
21-
6. 下記「[データの読み方](#データの読み方申請内容と対応例)」を参考に、申請内容から新しい Dojo データを [`db/dojos.yaml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojos.yaml) に追加する
22-
7. 下記「[統計システムへの追加](#統計システムへの追加)」を参考に、イベント管理サービスを [`db/dojo_event_services.yaml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojo_event_services.yaml) に追加する
21+
6. 下記「[データの読み方](#データの読み方申請内容と対応例)」を参考に、申請内容から新しい Dojo データを [`db/dojos.yml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojos.yml) に追加する
22+
7. 下記「[統計システムへの追加](#統計システムへの追加)」を参考に、イベント管理サービスを [`db/dojo_event_services.yml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojo_event_services.yml) に追加する
2323
8. 上記の作業結果をコミットし、Pull Request (PR) を送る
2424

2525
[&raquo; これまでの対応例 (PR) を見る](https://github.com/coderdojo-japan/coderdojo.jp/pulls?q=is:pr+"Add+CoderDojo")
@@ -42,7 +42,7 @@ Web: https://coderdojo-naha.doorkeeper.jp/
4242
Zen: https://zen.coderdojo.com/dojos/jp/okinawa-ken/okinawa-okinawa-prefecture/naha
4343
```
4444

45-
上記のような申請を受け取ったら `db/dojos.yaml` に次のように追記します。
45+
上記のような申請を受け取ったら `db/dojos.yml` に次のように追記します。
4646
(order 順に追加すると見やすくてベターです)
4747

4848

@@ -125,7 +125,7 @@ https://coderdojo.jp/stats
125125
集計は手作業でなく、イベントページのAPIを利用し自動化して行っています。
126126
このため、新規 Dojo を追加する際は、集計対象にも追加をお願いします。
127127

128-
集計対象は [`db/dojo_event_services.yaml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojo_event_services.yaml) で管理しています。以下のように追記してください。
128+
集計対象は [`db/dojo_event_services.yml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/dojo_event_services.yml) で管理しています。以下のように追記してください。
129129

130130
```yaml
131131
# 田町@VMware
@@ -172,7 +172,7 @@ https://coderdojo.jp/stats
172172

173173
## 本番環境への反映方法
174174

175-
dojos.yaml, dojo_event_services.yaml の更新を GitHub に push すると、次の手順で本番環境に反映されます。
175+
dojos.yml, dojo_event_services.yml の更新を GitHub に push すると、次の手順で本番環境に反映されます。
176176

177177
1. GitHub の更新を [GitHub Actions](https://github.com/coderdojo-japan/coderdojo.jp/actions) が検知します
178178
1. [GitHub Actions](https://github.com/coderdojo-japan/coderdojo.jp/actions) で各種テストが実行されます

doc/how_to_aggregate_stats_and_events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ bundle exec rails statistics:aggregation[201801,201910,connpass,xxx]
4949
bundle exec rails statistics:aggregation[201801,201910,,xxx]
5050
```
5151

52-
[`db/static_event_histories.yaml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/static_event_histories.yaml) にある YAML データを更新する
52+
[`db/static_event_histories.yml`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/static_event_histories.yml) にある YAML データを更新する
5353

5454
```
5555
# 全ての期間を更新する (Zshの場合)

doc/plan_inactivated_at_column.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ end
163163

164164
#### 重要: YAMLファイルがマスターデータ
165165

166-
**db/dojos.yaml がマスターレコードであることに注意**:
166+
**db/dojos.yml がマスターレコードであることに注意**:
167167
- データベースの変更だけでは不十分
168168
- `rails dojos:update_db_by_yaml` 実行時にYAMLの内容でDBが上書きされる
169169
- 永続化にはYAMLファイルへの反映が必須
@@ -184,7 +184,7 @@ desc 'Git履歴からinactivated_at日付を抽出してYAMLファイルに反
184184
task extract_inactivated_at_from_git: :environment do
185185
require 'git'
186186

187-
yaml_path = Rails.root.join('db', 'dojos.yaml')
187+
yaml_path = Rails.root.join('db', 'dojos.yml')
188188
git = Git.open(Rails.root)
189189

190190
# YAMLファイルの内容を行番号付きで読み込む
@@ -266,7 +266,7 @@ task extract_inactivated_at_from_git: :environment do
266266
puts "Total inactive dojos: #{inactive_dojos.count}"
267267
puts "YAML file has been updated with inactivated_at dates"
268268
puts "\nNext steps:"
269-
puts "1. Review the changes in db/dojos.yaml"
269+
puts "1. Review the changes in db/dojos.yml"
270270
puts "2. Run: rails dojos:update_db_by_yaml"
271271
puts "3. Commit the updated YAML file"
272272
end
@@ -584,10 +584,10 @@ end
584584

585585
```bash
586586
# 特定のDojoのis_active履歴を確認
587-
git log -p --follow db/dojos.yaml | grep -B5 -A5 "id: 104"
587+
git log -p --follow db/dojos.yml | grep -B5 -A5 "id: 104"
588588

589589
# YAMLファイルの特定行のblame情報を確認
590-
git blame db/dojos.yaml -L 17,17 --porcelain
590+
git blame db/dojos.yml -L 17,17 --porcelain
591591

592592
# 非アクティブDojoの一覧を取得
593593
rails runner "Dojo.inactive.pluck(:id, :name).each { |id, name| puts \"#{id}: #{name}\" }"
@@ -621,8 +621,8 @@ rails runner "
621621
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
622622

623623
# 1. YAMLファイルのバックアップ
624-
cp db/dojos.yaml db/dojos.yaml.backup.${TIMESTAMP}
625-
echo "✅ YAMLバックアップ完了: db/dojos.yaml.backup.${TIMESTAMP}"
624+
cp db/dojos.yml db/dojos.yml.backup.${TIMESTAMP}
625+
echo "✅ YAMLバックアップ完了: db/dojos.yml.backup.${TIMESTAMP}"
626626

627627
# 2. 現在の統計値を記録
628628
rails runner "
@@ -655,7 +655,7 @@ require 'git'
655655

656656
class GitExtractionValidator
657657
def self.run
658-
yaml_path = Rails.root.join('db', 'dojos.yaml')
658+
yaml_path = Rails.root.join('db', 'dojos.yml')
659659
git = Git.open(Rails.root)
660660

661661
issues = []
@@ -714,7 +714,7 @@ GitExtractionValidator.run
714714
# script/apply_inactivated_dates.rb
715715
class InactivatedDateApplier
716716
def self.run(dry_run: true)
717-
yaml_path = Rails.root.join('db', 'dojos.yaml')
717+
yaml_path = Rails.root.join('db', 'dojos.yml')
718718
backup_path = yaml_path.to_s + ".backup.#{Time.now.strftime('%Y%m%d_%H%M%S')}"
719719

720720
if dry_run
@@ -735,7 +735,7 @@ class InactivatedDateApplier
735735
# 変更内容の確認
736736
if dry_run
737737
puts "\n📋 変更プレビュー:"
738-
system("git diff --stat db/dojos.yaml")
738+
system("git diff --stat db/dojos.yml")
739739
else
740740
# YAMLの構文チェック
741741
begin

lib/event_service/providers/facebook.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ class Facebook
66
# You can load data from the following YAML file by exec (on Zsh):
77
#
88
# $ bundle exec rails statistics:aggregation\[-,-,facebook\]
9-
YAML_FILE = Rails.root.join('db', 'facebook_event_histories.yaml')
9+
YAML_FILE = Rails.root.join('db', 'facebook_event_histories.yml')
1010

1111
def fetch_events(dojo_id: nil, since_at: nil, until_at: nil)
1212
dojo_ids = dojo_id if dojo_id.is_a?(Array)

0 commit comments

Comments
 (0)