chocoby / jp_prefecture Goto Github PK

Rails 3/4 系の最新版でテストを行うようにする

コードとラベルが相互に変換出来るようになると良い

便利なGemを作成いただきありがとうございます！ 🎉

概要

JpPrefecture::Prefecture.find(name: 'hoge') は name / name_e / name_h / name_k を前方一致で検索するという仕様のため、以下のようケースで意図しないレコードが取得されてしまいます。

# 例：レコードが取得できないことを期待しているが、青森のレコードが取得される
JpPrefecture::Prefecture.find(name: '東') 
=> #<JpPrefecture::Prefecture:0x00007fc550158890 @area="東北", @code=2, @name="青森県", @name_e="Aomori", @name_h="あおもりけん", @name_k="アオモリケン", @type="県", @zips=[185501..185501, 300111..395346]>

考えたこと

• JpPrefecture::Prefecture.find の引数が name の場合は、 name のみを検索対象とする
• JpPrefecture::Prefecture.find の引数に name_e / name_h / name_k をうけれるようにする

とすれば解決しそうですが、前方一致だと同じような問題が起きる可能性があります。

とりいそぎのレポートです。

JpPrefecture::Prefecture.find(name: xxx)に対して、引数に空の文字列、nilが与えられた場合の挙動がおかしいように思います。

JpPrefecture::Prefecture.find(name: '') # => <JpPrefecture::Prefecture:0x007fdd21b17938 @code=1, @name="北海道", @name_e="Hokkaido", @name_h="ほっかいどう", @name_k="ホッカイドウ", @zips=[10000..70895, 400000..996509], @area="北海道">

JpPrefecture::Prefecture.find(name: nil) # => NoMethodError: undefined method `downcase' for nil:NilClass

これらの挙動については、nilを返すか、例外を投げるかしたほうが良いように思います。

検索系のメソッドがごちゃごちゃしているので整理したい
https://www.rubydoc.info/github/chocoby/jp_prefecture/master/JpPrefecture%2FPrefecture.find

デフォルトでは全て小文字で格納しておいて、name_e を生成する時に capitalize するようにした方が、検索処理などのバランスが良さそう。

find メソッドと同居:

find(13)
find(name: "東京都")
find(name_e: "Tokyo")

Prefecture クラスのインスタンスを返す

メンテナンスが終了している Ruby/Rails をサポート外にする。
サポート対象のバージョンはそれぞれ以下のページに公開されている。

• Ruby: https://www.ruby-lang.org/en/downloads/branches/
• Rails: https://guides.rubyonrails.org/maintenance_policy.html

WHY

海外の開発者が日本でサービスを立ち上げるときにも気軽に使えるようにしたい

SOLUTION

• Readme_enを作成し、現在のReadmeにリンク加える✅
• 既存Readmeを英語にし、別ファイルで日本語記述
• 既存Readmeを日本語と英語にする
• Github Wikiをでガイド書く