セットプチフォッカ

勉強したアウトプット、ときどきフォッカチオ作っていました

トップ > PROGRAMMING > 日本の地方公共団体コードをパースするGemをリリースしました

日本の地方公共団体コードをパースするGemをリリースしました

PROGRAMMING Ruby

f:id:ikmbear:20220118162141p:plain

作ったもの

f:id:ikmbear:20220118162056p:plain

jp_local_govという日本の地方公共団体コードを市区町村の情報にパースしてくれるGemを作りました。人生初Gemリリースです🎉

github.com

rubygems.org

「そもそも地方公共団体コードってなんやねん」方も多いと思いますが、

全国地方公共団体コード（ぜんこくちほうこうきょうだんたいコード）[注釈 1]は、日本の地方公共団体につけられた、数字3桁または5桁または6桁の符号（コード）で ある。コードが与えられる地方公共団体とは、都道府県・市町村・特別区、一部事務組合・地方開発事業団・広域連合、加えて、地方公共団体ではないが行政区・東京都区部である。

全国地方公共団体コード - Wikipedia

というものです。JIS規格にも指定されています。

3桁、5桁、6桁とありますが、ルール的には

  • 上2桁が都道府県、
  • 続く3桁が市区町村
  • 残りの1桁がチェックディジット

になっているので、このGemでは6桁フルの状態をパースできるようになっています。

READMEにも書いているのですが、jp_prefectureのアイデアに多大に影響を受けています。

github.com

作った背景

今作っているサービスで必要だったからです。

ざっくりいうと公共料金を計算するサービスで、その計算のための料率が市区町村ごとに違うために、市区町村ごとにレコードを持つ必要がありました。

で、市区町村だけのテーブルをもつのもなんだか微妙だし、市区町村のための管理画面をもつのも面倒だったので、「Gemでできないかな〜」と思っていたのですが、似たようなアイデアのGemは更新が数年前...。

...みたいなことを、FJORD BOOT CAMP内で日報に書いたら、メンターさんから「作ってみては」とアドバイスが。

「ちょっと難しいかも...」と思いつつも、内心「作ってみたい、MY FIRST GEM」という思いが心の中に溢れてきたので、作ることにしました！

使い方

だいたいREADMEに書いてある通りなんですが、英語なので日本語でも書きます。

インストール

一応Ruby3.0.0以上が対象です。

普通にインストールするか

gem install jp_local_gov

Gemfileを使ってインストールします

# Gemfile
gem 'jp_local_gov'
bundle install

必要に応じてrequire します。

require 'jp_local_gov'

id指定の検索（JpLocalGov.find ）

地方公共団体コード（String）を指定することで、地方公共団体の情報を取得することができます。

chiyodaku = JpLocalGov.find("131016")
# => #<JpLocalGov::LocalGov:0x00007fe706a8f148 @code="131016", @prefecture_code="13", @prefecture="東京都", @prefecture_kana="トウキョウト", @city="千代田区", @city_kana="チヨダク", @prefecture_capital=false>
chiyodaku.code
# => "131016"
chiyodaku.prefecture_code
# => "13"
chiyodaku.prefecture
# => "東京都"
chiyodaku.prefecture_kana
# => "トウキョウト"
chiyodaku.city
# => "千代田区"
chiyodaku.city_kana
# => "チヨダク"
chiyodaku.prefecture_capital
# => false

この後のメソッドでも共通ですが、取得できる情報は

です。

ひらがなとか英字とかも追加するのは苦ではないんですが、総務省が出している元データは漢字とカタカナだけなのと、あんまりユースケースが見つからなかったので、一旦出していません。

あと東京都の都庁所在地は一応「東京」って習ったと思うんですが、「新宿」として登録しています。

条件指定での検索（JpLocalGov.where）

上記の取得できる情報をキーとして、ハッシュを渡すことで、指定した条件に合致する市区町村の情報が配列で返ってきます。

なお複数の条件を指定した場合はAND検索になります。

misato = JpLocalGov.where(city: "美郷町")
# => [#<JpLocalGov::LocalGov:0x00007fb1c594cb08 @code="054348", @prefecture_code="05", @prefecture="秋田県", @prefecture_kana="アキタケン", @city="美郷町", @city_kana="ミサトチョウ", @prefecture_capital=false>, #<JpLocalGov::LocalGov:8 @code="324485", @prefecture_code="32", @prefecture="島根県", @prefecture_kana="シマネケン", @city="美郷町", @city_kana="ミサトチョウ", @prefecture_capital=false>, #<JpLocalGov::LocalGov:0x00007fb1c1a3ce40 @code="454311", @prefecture="宮崎県", @prefecture_kana="ミヤザキケン", @city="美郷町", @city_kana="ミサトチョウ", @prefecture_capital=false>]
misato.map { "#{_1.prefecture}:#{_1.city}" }
# => ["秋田県:美郷町", "島根県:美郷町", "宮崎県:美郷町"]

JpLocalGov.where(prefecture: "東京都", prefecture_capital: true)
# => [#<JpLocalGov::LocalGov:0x00007fb1c219e418 @code="131041", @prefecture_code="13", @prefecture="東京都", @prefecture_kana="トウキョウト", @city="新宿区", @city_kana="シンジュクク", @prefecture_capital=true>]

JpLocalGov.where(prefecture: "東京")
# => nil
# Exact match search. You should specified "東京都" instead of "東京".

全件検索（JpLocalGov.all）

すべての地方公共団体の情報を取得したい場合に使用します。戻り値は配列です。

JpLocalGov.all
# =>  [#<JpLocalGov::LocalGov:0x00007fdf3a9c6758 @code="011002", @prefecture_code="01", @prefecture="北海道", @prefecture_kana="ホッカイドウ", @city="札幌市na="サッポロシ", @prefecture_capital=true>, #<JpLocalGov::LocalGov:0x00007fdf3a9c6730 @code="011011",...

Railsだと、collection_select を使用することで、すべての市区町村のコンボボックスを簡単に作ることができます。

ランダムな地方公共団体情報の生成（JpLocalGov::Random）

ランダムな地方公共団体情報から、指定したプロパティを返します。

JpLocalGov::Random.code
# => "281077"
JpLocalGov::Random.city
# => "大島町"
JpLocalGov::Random.city_kana
# => "チュウオウシ"
JpLocalGov::Random.prefecture
# => "青森県"
JpLocalGov::Random.prefecture_code
# => "46"
JpLocalGov::Random.prefecture_kana
# => "ヒョウゴケン"

一応想定するケースとしては、FactoryBotで地方公共団体コードを指定する際に、決めうちではんく探索的なテストデータを作成しておきたいという場合を想定しています。

後述しますが、Railsで使用する場合はDBに保持するカラムはlocal_gov_code だけなので、その他のプロパティのメソッドはあまり使い所がないかもしれません笑

補足として、あくまでプロパティ単位でしかランダムな値を生成しないので、ランダムな地方公共団体のインスタンスを作成する場合は、

JpLocalGov.find(JpLocalGov::Random.code)

という具合に呼んでやる必要があります。需要があれば、JpLocalGov::Random.new みたいなのを作るかもです。

Railsでの使用（基本）

このGemをModelクラスにincludeすることで、そのモデル内でlocal_govenment というメソッドが使えるようになります。

jp_local_gov :<地方公共団体コードを保存したカラム名> とすることで、そのカラム（地方公共団体コード）から、都道府県名や市区町村の情報を展開することができるようになります。

# app/models/insurance_fee.rb:
class InsuranceFee < ActiveRecord::Base
  # local_gov_code:String

  include JpLocalGov
  jp_local_gov :local_gov_code
end

insurance_fee = InsuranceFee.new
insurance_fee.local_gov_code = "131016"
insurance_fee.local_government.city
# => "千代田区"

なおカラム「地方公共団体コード」の作成時、型はStringにする必要があります。

Railsでの使用（バリデーション）（JpLocalGov.valid_code? ）

地方公共団体コードのチェックのためのメソッドを設けているので、これをカスタムバリデーションに組み込むことで、地方公共団体コードのチェックができます。

class InsuranceFee < ApplicationRecord
  include JpLocalGov
  jp_local_gov :local_gov_code

  ## カスタムバリデーションで利用する
  validate :valid_code?

  def valid_code?
    unless JpLocalGov.valid_code?(local_gov_code)
      errors.add(:local_gov_code, "is not valid code")
    end
  end
end

実施しているチェックは

  • コードが文字列かどうか
  • コードが正しい長さか（6文字）
  • チェックディジットを満たしているか
  • 正しい都道府県コードを持っているか

です。

チェックディジットについては、地方公共団体コードの仕様に記載があります。

f:id:ikmbear:20220118162309p:plain

11 検査数字

全国地方公共団体コードにおける検査数字は、電算処理にあたって、不正なコードが使わ れないよう第6桁目をチェック用としたもので、次の方式により算出した数字とする。 (方式) 第1桁から第5桁までの数字に、それぞれ6.5.4.3.2を乗じて算出した積の和を 求め、その和を11で除し、商と剰余(以下「余り数字」という。)を求めて、11と余り 数字との差の下1桁の数字を検査数字とする。 ただし、積の和が11より小なるときは、検査数字は、11から積の和を控除した数字と する。

出典：https://www.soumu.go.jp/main_content/000137948.pdf

実装としてはこんな感じです。ボリューム的にもプログラミングのちょうどいい問題だと感じていて、結構好きな仕様です。

CHECK_DIGITS_INDEX = 5
CHECK_BASE = 11

sub_total = code.chars
                .take(CHECK_DIGITS_INDEX)
                .map.with_index { |digit, index| digit.to_i * (CHECK_DIGITS_INDEX - index + 1) }
                .sum
candidate = (CHECK_BASE - sub_total % CHECK_BASE) % 10
check_digits = sub_total > CHECK_BASE ? candidate : CHECK_BASE - sub_total
code[CHECK_DIGITS_INDEX] == check_digits.to_s

なお最初はチェックディジットだけのチェックでいいかなと思っていたんですが、チェックディジットを満たしていても、都道府県コードがイレギュラーになるケースに後から気がつきました。

'481238' # 都道府県は47までなので、こんな市区町村はない

# 第1桁から第5桁までの数字に、それぞれ6.5.4.3.2を乗じて算出した積の和を求める
80

# その和を11で除し、商と剰余(以下「余り数字」という。)を求めて、11と余り数字との差の下1桁の数字を検査数字とする。
8　　# 存在しない市区町村だけど、チェックディジットを満たす

なので、都道府県コード（1..47）のチェックも入っています。

仕組み

f:id:ikmbear:20220118161859p:plain

そこまで複雑なGemではないのですが、一応こういう仕組みです。

総務省｜地方行政のデジタル化｜全国地方公共団体コード

情報の元は総務省のこのページです。手順的には以下のような感じです。

  1. 元データ（PDF）をGem：pdf-readerで読み取る
  2. sqliteにぶん投げる
  3. sqlite内でソートを行う
  4. 都道府県ごとにSELECTしてJSONに出力する
  5. 出力されたJSONを使って地方公共団体コードをパースする

このGemは地方公共団体コードの情報が命なので、この処理自体をRakeタスクとして登録して、GitHub Actionsで1ヶ月に1回、自動でPRを作成する形式にしています。

今後の展望

まだIssueにも登録していませんが、ここらへんはやりたいなと思っています。

JpLocalGov.all で政令指定都市の行政区を除外する

「区」って東京のイメージが強いですが、実は各都道府県の政令指定都市には区があります。例えば札幌市には中央区や東区があります。

市区町村を選択するのに、ここら辺を選択したい場合もあれば、「札幌市」という市区町村の単位だけがあればいいケースもあると思っています（私のアプリもそうです）。

なので、これをオプションで除外できるようにしたいです。一応、都道府県コードに続く3桁の決まりでなんとか除外できそうなので、近いうちに入ると思います。

YARDでドキュメントを書く

@params とかかいてあるあれです。

このGemはRBSを使っているので、それが半分ドキュメントの役割を果たしている感じもしますが、まだまだ普及率も高くないことと、自分自身が書いてみたいので、これも時間ができたらやる予定です。

各RubyバージョンでのテストのCIを実行する

強いGemのCIで走っているあれです。

今はリポジトリにruby-versionをおいて、それをGitHub Actionsで参照するようにしているのですが、これを各Rubyバージョンで実行できるようにしたいです。

どうやってやるのかわからんですが。

曖昧検索、一つのプロパティに対して複数条件検索、OR検索

今実装しているwhere は完全一致検索かつAND検索で、一つのプロパティに対して一つの条件しか指定できないんですが、ここら辺をもうちょっと柔軟にしたいです。

あんまり使う機会ないんですけど、なんかできたら良さそうな感じするじゃないですか。

変更差分の見える化

リリースしてからまだ時間が立ってないので、地方公共団体コードの変更は起こっていないんですが、変更が発生した場合になんかいい感じに見せられないかな〜とぼんやり思っています。

終わりに

というわけで、地方公共団体コードをパースしてくれるGem「jp_local_gov」をリリースしたというお話でした。

前にもnpmを作ったことはあったのですが、今回はちゃんと実践的に使えるものを作ったので、いろいろと学びも多かったし、楽しかったです😄

（npmの話はこちら） ikmbear.hatenablog.com

市区町村まで必要になるケースってそんなに多くないかもですが、もしこのGemを作っていただける方がいるなら嬉しいです！バグや要望はIssueにお気軽に登録してください！

github.com