YuukiToriyama · YuukiToriyama · Mar 22, 2024 · Feb 25, 2024 · Feb 25, 2024 · Feb 25, 2024
diff --git a/.github/ISSUE_TEMPLATE/01-city_orthographical_variant_report.yaml b/.github/ISSUE_TEMPLATE/01-city_orthographical_variant_report.yaml
@@ -0,0 +1,43 @@
+name: 表記ゆれの報告(市区町村レベル)
+description: 市区町村名の表記ゆれを報告します
+title: "表記ゆれの報告: 「」と「」の表記ゆれ"
+labels: ["表記ゆれ"]
+body:
+  - type: markdown
+    id: introduction
+    attributes:
+      value: "市区町村レベルでの表記ゆれを報告するためのテンプレートです"
+  - type: textarea
+    id: variety-of-notation
+    attributes:
+      label: 対応すべき表記ゆれ
+      description: 対応すべき表記ゆれを箇条書きで記入してください
+      placeholder: "- 茨城県鹿島市"
+    validations:
+      required: true
+  - type: input
+    id: formal-notation
+    attributes:
+      label: 正式な表記
+      description: 市区町村名の正式な表記を https://yuukitoriyama.github.io/geolonia-japanese-addresses-accompanist/都道府県名/master.json で確認し、記入してください。
+      placeholder: "- 茨城県鹿嶋市"
+    validations:
+      required: true
+  - type: textarea
+    id: reference
+    attributes:
+      label: 表記ゆれが確認できる資料/URL
+      description: 表記ゆれが確認できる資料についての情報や、ウェブサイトのURLを記載してください。
+      placeholder: "行政機関のHPやタウンページの記載など"
+    validations:
+      required: true
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: チェックリスト
+      description: Issueを作成する前に以下の項目を確認してください
+      options:
+        - label: "入力した内容に個人情報が含まれていないことを確認しました。"
+          required: true
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/02-town_orthographical_variant_report.yaml b/.github/ISSUE_TEMPLATE/02-town_orthographical_variant_report.yaml
@@ -0,0 +1,43 @@
+name: 表記ゆれの報告(町名レベル)
+description: 町名の表記ゆれを報告します
+title: "表記ゆれの報告: 「」と「」の表記ゆれ"
+labels: ["表記ゆれ"]
+body:
+  - type: markdown
+    id: introduction
+    attributes:
+      value: "町名レベルでの表記ゆれを報告するためのテンプレートです"
+  - type: textarea
+    id: variety-of-notation
+    attributes:
+      label: 対応すべき表記ゆれ
+      description: 対応すべき表記ゆれを箇条書きで記入してください
+      placeholder: "- 東京都千代田区丸ノ内"
+    validations:
+      required: true
+  - type: input
+    id: formal-notation
+    attributes:
+      label: 正式な表記
+      description: 町名の正式な表記を https://geolonia.github.io/japanese-addresses/api/ja/都道府県名/市区町村名.json で確認し、記入してください。
+      placeholder: "- 東京都千代田区丸の内"
+    validations:
+      required: true
+  - type: textarea
+    id: reference
+    attributes:
+      label: 表記ゆれが確認できる資料/URL
+      description: 表記ゆれが確認できる資料についての情報や、ウェブサイトのURLを記載してください。
+      placeholder: "行政機関のHPやタウンページの記載など"
+    validations:
+      required: true
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: チェックリスト
+      description: Issueを作成する前に以下の項目を確認してください
+      options:
+        - label: "入力した内容に個人情報が含まれていないことを確認しました。"
+          required: true
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/99-default.md b/.github/ISSUE_TEMPLATE/99-default.md
@@ -0,0 +1,14 @@
+---
+name: 汎用Issueテンプレート
+about: それ以外のIssueはこちらから
+title: ''
+labels: ''
+assignees: YuukiToriyama
+
+---
+
+### 概要
+-
+
+### その他
+-
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,9 @@
+### 変更点
+- 
+
+### 確認すべき項目
+- [ ] `cargo fmt`
+- [ ] `cargo test`
+
+### 備考
+- 
diff --git a/.github/scripts/free_test.js b/.github/scripts/free_test.js
@@ -1,4 +1,4 @@
-const {Parser} = require("../../pkg");
+const {Parser} = require("../../wasm/pkg");
 const readline = require("readline");
 const fs = require("fs");
 

diff --git a/.github/workflows/free-test.yaml b/.github/workflows/free-test.yaml
@@ -26,8 +26,10 @@ jobs:
             return commit.data.object.sha
 
       - name: Install wasm-pack
+        working-directory: wasm
         run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
       - name: Build wasm module
+        working-directory: wasm
         run: wasm-pack build --target nodejs --scope toriyama
 
       - name: Setup Node.js

diff --git a/.github/workflows/ghpages.yaml b/.github/workflows/ghpages.yaml
@@ -17,14 +17,16 @@ jobs:
       - name: Install wasm-pack
         run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
       - name: Unit Testing for Wasm module
+        working-directory: wasm
         run: wasm-pack test --firefox --headless
       - name: Build wasm module
-        run: wasm-pack build --target web --scope toriyama --features debug
+        working-directory: wasm
+        run: wasm-pack build --target web --scope toriyama --out-name japanese_address_parser --features debug
       - name: Move files
         run: |
           mkdir ./publish
-          rm ./pkg/.gitignore
-          mv ./pkg ./publish
+          rm ./wasm/pkg/.gitignore
+          mv ./wasm/pkg ./publish
           mv ./public ./publish
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3

diff --git a/.github/workflows/upload-cratesio.yaml b/.github/workflows/upload-cratesio.yaml
@@ -8,6 +8,9 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: core
     steps:
       - uses: actions/checkout@v4
 

diff --git a/.github/workflows/upload-npmjs.yaml b/.github/workflows/upload-npmjs.yaml
@@ -8,6 +8,9 @@ on:
 jobs:
   publish:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: wasm
     steps:
       - uses: actions/checkout@v4
 
@@ -22,7 +25,24 @@ jobs:
         run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
 
       - name: Build wasm module
-        run: wasm-pack build --release --target web --scope toriyama
+        run: wasm-pack build --release --target web --scope toriyama --out-name japanese_address_parser
+
+      # package.jsonの`name`が`@toriyama/wasm`になっているため、`@toriyama/japanese-address-parser`に書き換える
+      - name: Check if jq command is available
+        run: |
+          which jq
+          jq --version
+
+      - name: Edit package.name
+        run: |
+          cat pkg/package.json | jq '.name = "@toriyama/japanese-address-parser"' > tmp.json
+          mv tmp.json pkg/package.json
+
+      - name: Check if package.name was changed
+        run: |
+          # package.nameが正しく置換されているかを確認している。
+          # 正しく置換されていればJSONファイルを表示し、置換されていなければエラーを返しJobを中断させる。
+          cat pkg/package.json | jq 'if .name == "@toriyama/japanese-address-parser" then . else error("package.nameが正しく置換されていない") end'
 
       - name: Upload wasm to npmjs.com
         run: |

diff --git a/.github/workflows/wasm-pack-test.yaml b/.github/workflows/wasm-pack-test.yaml
@@ -8,6 +8,9 @@ on:
 jobs:
   wasm-pack:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: wasm
     steps:
       - uses: actions/checkout@v4
       - name: Install wasm-pack

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+## How to contribute to `japanese-address-parser`
+`japanese-address-parser`に興味を持っていただきありがとうございます。
+このライブラリは[@YuukiToriyama](https://github.com/YuukiToriyama)による個人プロジェクトですが、皆さんのコントリビューションを歓迎します！
+以下ではコントリビューションの手順について説明いたします。
+
+### 地名の表記ゆれを発見した場合
+地名の表記ゆれを発見した場合はIssueで報告していただけると助かります。
+市区町村名の表記ゆれと町名の表記ゆれでそれぞれIssueフォームを用意しているので適当なものを選んでください。
+なる早で返信いたします。
+ご自身で解決できそうな場合は、IssueのAssigniesにご自身を指定していただき、PRを投げてもらっても構いません。
+
+### クラッシュを報告する場合
+ライブラリがクラッシュした場合は、汎用Issueテンプレートから報告をお願いします。
+使用しているRustのバージョン、ライブラリのバージョン、クラッシュログなどを添付していただけると対応可能です。
+
+### PRの作成方法
+#### 前提知識
+このリポジトリでは簡素化したGit-flow方式でのブランチ管理を行なっています。具体的には以下のようになっています。
+- `main`ブランチが全ての親ブランチ
+- 何か修正を行なう場合は`main`ブランチから`feature/*`ブランチを切る
+- リリースを行なう場合は`main`ブランチから`release/vX.Y.Z`ブランチを切る
+  - リリースに含めたい`feature`ブランチを`release/vX.Y.Z`にマージする
+  - タグ`vX.Y.Z`を打つ
+  - リリースが完了したら`main`ブランチにマージする
+
+何か修正を行ないたい場合は`main`ブランチから修正ブランチを切ってくださいますようお願いします。
+また、PRを作成する際は、とりあえず`main`ブランチに対して投げてください。こちらで対応する`feature`ブランチを作成し、マージ先をそちらに変更いたします。
+
+#### 具体的な作成方法
+1. リポジトリをフォークする
+2. mainブランチが最新になっていることを確認する
+3. mainブランチからfeatureブランチを切り開発を行なう
+4. フォーク元のリポジトリのmainブランチに対してPullRequestを発行する
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,39 +1,22 @@
-[package]
-name = "japanese-address-parser"
-version = "0.1.0-beta.9"
+[workspace]
+members = [
+    "core",
+    "wasm",
+    "tests"
+]
+resolver = "2"
+
+[workspace.package]
+version = "0.1.0-beta.10"
 edition = "2021"
 description = "A Rust Library to parse japanses addresses."
-authors = ["Yuuki Toriyama <[email protected]>"]
 repository = "https://github.com/YuukiToriyama/japanese-address-parser"
+authors = ["Yuuki Toriyama <[email protected]>"]
 license = "MIT"
 keywords = ["parser", "geo", "wasm"]
 categories = ["parser-implementations", "wasm"]
-exclude = [
-    "public/*",
-    "tests/*",
-    ".github/*",
-]
-
-[lib]
-crate-type = ["rlib", "cdylib"]
 
-[features]
-debug = []
-
-[dependencies]
-console_error_panic_hook = "0.1.7"
-itertools = "0.12.0"
-js-sys = "0.3.67"
-nom = "7.1.3"
-regex = "1.10.2"
-reqwest = { version = "0.11.23", default-features = false, features = ["json", "rustls-tls", "blocking"] }
-serde = { version = "1.0.192", features = ["derive"] }
-serde-wasm-bindgen = "0.6.1"
+[workspace.dependencies]
 wasm-bindgen = "0.2.89"
 wasm-bindgen-futures = "0.4.39"
-
-[dev-dependencies]
-csv = "1.3.0"
-test-case = "3.3.1"
-tokio = { version = "1.35.1", features = ["rt", "macros"] }
 wasm-bindgen-test = "0.3.38"
diff --git a/core/Cargo.toml b/core/Cargo.toml
@@ -0,0 +1,27 @@
+[package]
+name = "japanese-address-parser"
+version.workspace = true
+edition.workspace = true
+description.workspace = true
+repository.workspace = true
+authors.workspace = true
+license.workspace = true
+readme = "../README.md"
+keywords.workspace = true
+categories.workspace = true
+
+[lib]
+crate-type = ["rlib", "cdylib"]
+
+[dependencies]
+itertools = "0.12.0"
+js-sys = "0.3.67"
+nom = "7.1.3"
+regex = "1.10.2"
+reqwest = { version = "0.11.23", default-features = false, features = ["json", "rustls-tls", "blocking"] }
+serde = { version = "1.0.192", features = ["derive"] }
+
+[dev-dependencies]
+test-case = "3.3.1"
+tokio = { version = "1.35.1", features = ["rt", "macros"] }
+wasm-bindgen-test = { workspace = true }
diff --git a/core/LICENSE b/core/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ToriChan
+
+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.
diff --git a/src/api.rs → core/src/api.rs b/src/api.rs → core/src/api.rs
diff --git a/src/api/city_master_api.rs → core/src/api/city_master_api.rs b/src/api/city_master_api.rs → core/src/api/city_master_api.rs
diff --git a/src/api/prefecture_master_api.rs → core/src/api/prefecture_master_api.rs b/src/api/prefecture_master_api.rs → core/src/api/prefecture_master_api.rs
diff --git a/src/entity.rs → core/src/entity.rs b/src/entity.rs → core/src/entity.rs
diff --git a/src/err.rs → core/src/err.rs b/src/err.rs → core/src/err.rs
diff --git a/core/src/lib.rs b/core/src/lib.rs
@@ -0,0 +1,5 @@
+pub mod api;
+pub mod entity;
+mod err;
+pub mod parser;
+mod util;
diff --git a/src/parser.rs → core/src/parser.rs b/src/parser.rs → core/src/parser.rs
diff --git a/src/parser/adapter.rs → core/src/parser/adapter.rs b/src/parser/adapter.rs → core/src/parser/adapter.rs
diff --git a/...adapter/orthographical_variant_adapter.rs → ...adapter/orthographical_variant_adapter.rs b/...adapter/orthographical_variant_adapter.rs → ...adapter/orthographical_variant_adapter.rs
diff --git a/src/parser/filter.rs → core/src/parser/filter.rs b/src/parser/filter.rs → core/src/parser/filter.rs
diff --git a/src/parser/filter/fullwidth_character.rs → .../src/parser/filter/fullwidth_character.rs b/src/parser/filter/fullwidth_character.rs → .../src/parser/filter/fullwidth_character.rs
diff --git a/...parser/filter/invalid_town_name_format.rs → ...parser/filter/invalid_town_name_format.rs b/...parser/filter/invalid_town_name_format.rs → ...parser/filter/invalid_town_name_format.rs
diff --git a/src/parser/filter/non_kanji_block_number.rs → ...c/parser/filter/non_kanji_block_number.rs b/src/parser/filter/non_kanji_block_number.rs → ...c/parser/filter/non_kanji_block_number.rs
diff --git a/src/parser/read_city.rs → core/src/parser/read_city.rs b/src/parser/read_city.rs → core/src/parser/read_city.rs
diff --git a/src/parser/read_house_number.rs → core/src/parser/read_house_number.rs b/src/parser/read_house_number.rs → core/src/parser/read_house_number.rs
diff --git a/src/parser/read_prefecture.rs → core/src/parser/read_prefecture.rs b/src/parser/read_prefecture.rs → core/src/parser/read_prefecture.rs
diff --git a/src/parser/read_town.rs → core/src/parser/read_town.rs b/src/parser/read_town.rs → core/src/parser/read_town.rs
diff --git a/src/util.rs → core/src/util.rs b/src/util.rs → core/src/util.rs
diff --git a/src/util/converter.rs → core/src/util/converter.rs b/src/util/converter.rs → core/src/util/converter.rs
diff --git a/tests/Cargo.toml b/tests/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "tests"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+publish = false
+
+[[test]]
+name = "integration_tests"
+path = "integration_tests.rs"
+
+[dev-dependencies]
+csv = "1.3.0"
+japanese-address-parser = { path = "../core"}
+serde = { version = "1.0.197", features = ["derive"] }
+tokio = { version = "1.35.1", features = ["rt", "macros"] }
diff --git a/tests/common/mod.rs b/tests/common/mod.rs
@@ -1,6 +1,6 @@
 use csv::ReaderBuilder;
 use japanese_address_parser::api::{Api, ApiImpl};
-use japanese_address_parser::parser;
+use japanese_address_parser::parser::parse;
 use serde::Deserialize;
 use std::fs::File;
 use std::panic;
@@ -30,7 +30,7 @@ pub async fn run_data_driven_tests(file_path: &str) {
     let mut success_count = 0;
     for record in &records {
         let api = ApiImpl::new();
-        let result = parser::parse(api, &record.address).await;
+        let result = parse(api, &record.address).await;
 
         let test_result = panic::catch_unwind(|| {
             assert_eq!(result.address.prefecture, record.prefecture);