init

Author: rot1024

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Re:Earth contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,36 @@
+# jpareacode
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/eukarya-inc/jpareacode.svg)](https://pkg.go.dev/github.com/eukarya-inc/jpareacode)
+
+日本の都道府県名や市区町村名から、都道府県コードや市区町村コードを取得するライブラリ
+
+```go
+package main
+
+import (
+  jpareacode "github.com/eukarya-inc/jpareacode"
+)
+
+func main() {
+  jpareacode.PrefectureCodeInt("北海道") // 1
+  jpareacode.PrefectureCodeStrings("北海道") // "01"
+  jpareacode.PrefectureCodeInts("北海道", "東京都") // [1, 13]
+  jpareacode.PrefectureCodeStrings("北海道", "東京都") // ["01", "13"]
+  jpareacode.PrefectureName(1) // "北海道"
+  jpareacode.PrefectureNames(1, 13) // ["北海道", "東京都"]
+  jpareacode.Prefectures // []stirng{"北海道", ...}
+
+  jpareacode.CityByName(13, "千代田区") // &City{PrefCode:13, Name:"千代田区", Code:13101}
+  jpareacode.CityByNames("北区") // []City{{PrefCode:1, Name:"北区", Code:1102}, {PrefCode:11, Name:"北区", Code:11102}, ...}
+  jpareacode.CityByCode(13101) // &City{PrefCode:13, Name:"千代田区", Code:13101}
+  jpareacode.Cities // []City{{PrefCode:13, Name:"千代田区", Code:13101}, ...}
+}
+```
+
+データは国土交通省が公開する「都道府県内市区町村一覧取得API」を基にしています。詳しくは以下をご覧ください。
+
+[https://www.land.mlit.go.jp/webland/api.html](https://www.land.mlit.go.jp/webland/api.html)
+
+最終データ更新日：2023/02/20
+
+[MIT License](LICENSE)

city.go

@@ -0,0 +1,103 @@
+//go:generate go run ./jpareacodegen --output data.csv
+package jpareacode
+
+import (
+	"bytes"
+	_ "embed"
+	"encoding/csv"
+	"fmt"
+	"strconv"
+)
+
+//go:embed data.csv
+var data []byte
+
+var Cities []City
+var citym = map[string]City{}
+var citymr = map[int]City{}
+
+type City struct {
+	PrefCode int    `json:"prefCode"`
+	Name     string `json:"name"`
+	Code     int    `json:"code"`
+}
+
+func init() {
+	r := csv.NewReader(bytes.NewBuffer(data))
+	data, err := r.ReadAll()
+	if err != nil {
+		panic(err)
+	}
+	for _, record := range data {
+		if len(record) < 3 {
+			panic("invalid length")
+		}
+		pcode, err := strconv.Atoi(record[0])
+		if err != nil {
+			panic("invalid code")
+		}
+		code, err := strconv.Atoi(record[2])
+		if err != nil {
+			panic("invalid code")
+		}
+		city := City{
+			PrefCode: pcode,
+			Code:     code,
+			Name:     record[1],
+		}
+		Cities = append(Cities, city)
+		citym[record[0]+record[1]] = city
+		citymr[code] = city
+	}
+}
+
+// CityByName は、都道府県コードと市区町村名を基に市区町村情報を返します。
+func CityByName(prefCode int, name string) *City {
+	k := FormatPrefectureCode(prefCode) + name
+	c, ok := citym[k]
+	if !ok {
+		return nil
+	}
+	return &c
+}
+
+// CitiesByName は、市区町村名に合致する全ての市区町村情報を返します。
+func CitiesByName(name string) (res []City) {
+	for _, c := range Cities {
+		if c.Name == name {
+			res = append(res, c)
+		}
+	}
+	return
+}
+
+// CityByCode は、市区町村コードを基に市区町村情報を返します。
+func CityByCode(code int) *City {
+	c, ok := citymr[code]
+	if !ok {
+		return nil
+	}
+	return &c
+}
+
+// FormatCityCode は、intの市区町村名コードをstringに変換します。無効なコードの場合は空文字列が返されます。
+func FormatCityCode(code int) string {
+	if !ValidateCityCode(code) {
+		return ""
+	}
+	return fmt.Sprintf("%05d", code)
+}
+
+// ParseCityCode は、stringの市区町村名コードをintに変換します。パースに失敗した場合や無効なコードの場合は0が返されます。
+func ParseCityCode(code string) int {
+	c, _ := strconv.Atoi(code)
+	if !ValidateCityCode(c) {
+		return 0
+	}
+	return c
+}
+
+// ValidateCityCode は、市区町村コードが有効かどうかを返します。
+func ValidateCityCode(code int) bool {
+	return code >= PrefectureMinCode*100 && code <= (PrefectureMaxCode+1)*1000-1
+}

city_test.go

@@ -0,0 +1,69 @@
+package jpareacode
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestCityByName(t *testing.T) {
+	e := &City{PrefCode: 13, Name: "千代田区", Code: 13101}
+	if c := CityByName(13, "千代田区"); !reflect.DeepEqual(c, e) {
+		t.Errorf("expected: %#v, actual: %#v", e, c)
+	}
+	e = nil
+	if c := CityByName(12, "千代田区"); !reflect.DeepEqual(c, e) {
+		t.Errorf("expected: %#v, actual: %#v", e, c)
+	}
+}
+
+func TestCitiesByName(t *testing.T) {
+	e := []City{{PrefCode: 13, Name: "千代田区", Code: 13101}}
+	if c := CitiesByName("千代田区"); !reflect.DeepEqual(c, e) {
+		t.Errorf("expected: %#v, actual: %#v", e, c)
+	}
+	e = nil
+	if c := CitiesByName("千代田"); !reflect.DeepEqual(c, e) {
+		t.Errorf("expected: %#v, actual: %#v", e, c)
+	}
+}
+
+func TestCityByCode(t *testing.T) {
+	e := &City{PrefCode: 13, Name: "千代田区", Code: 13101}
+	if c := CityByCode(13101); !reflect.DeepEqual(c, e) {
+		t.Errorf("expected: %#v, actual: %#v", e, c)
+	}
+	e = nil
+	if c := CityByCode(1310); !reflect.DeepEqual(c, e) {
+		t.Errorf("expected: %#v, actual: %#v", e, c)
+	}
+}
+
+func TestFormatCityCode(t *testing.T) {
+	if c := FormatCityCode(13101); c != "13101" {
+		t.Errorf("expected: %s, actual: %s", "13101", c)
+	}
+	if c := FormatCityCode(0); c != "" {
+		t.Errorf("expected: %s, actual: %s", "", c)
+	}
+}
+
+func TestParseCityCode(t *testing.T) {
+	if c := ParseCityCode("13101"); c != 13101 {
+		t.Errorf("expected: %d, actual: %d", 13101, c)
+	}
+	if c := ParseCityCode(""); c != 0 {
+		t.Errorf("expected: %d, actual: %d", 0, c)
+	}
+}
+
+func TestValidateCityCode(t *testing.T) {
+	if !ValidateCityCode(13101) {
+		t.Error("expected: true, actual: false")
+	}
+	if ValidateCityCode(0) {
+		t.Error("expected: false, actual: true")
+	}
+	if ValidateCityCode(50000) {
+		t.Error("expected: false, actual: true")
+	}
+}