jp_local_gov 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4860d4939032f21410e79a628f6000fd037f755e9997903e670e8a9195c272c9
-  data.tar.gz: 2f263d1c09e9db4e138fbaac8bd31bc10f26692bf1bd6b2a1ee07a9c4f879578
+  metadata.gz: 4759f37789b0e5f5c1919b7fb23038c5ec76e8024e5043207890e79a38ad4a39
+  data.tar.gz: a1ef62fe017d208311ee529f1fe3d7c5903aa31fa3e4316eb68db3ff08a0695e
 SHA512:
-  metadata.gz: af1984c55d50f4368dfda951e6cc2a18e4a564e54002da1728b1a5c12baeeaddfe89efd38bd36c759d1ce5ff5966f0870eb7e35e42315b703c112eb056cc599d
-  data.tar.gz: ee7b9dc6f8cca9f271a173acac5052a517c9882fb34911f12503782879e29c5239aa3773ea856d5765550b5e8965ad059863f2686e49a36f7200cfa3d18e9c68
+  metadata.gz: 9e9a9099eab0080b5c127b41c57758fc0af22a2632aa28c763876fba3788ba8c6f1335082133b64f4decd7b0ca7a3f1c8eb70c7c8457937037f0d004fbc754b9
+  data.tar.gz: 769f134eaf165f276b6ba01ac5b593fddf16f65e4d65ba80745675f33a09ff0304868f5674d1160cf1a06622561e04d7efdb468e9378bdc4fe61c35a7176ac47

data/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,50 @@
+name: BugReport
+description: File a bug report
+title: "[Bug]: "
+assignees: IkumaTadokoro
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: "Thanks for taking the time to fill out this bug report!"
+  - type: textarea
+    id: description
+    attributes:
+      label: Summary
+    validations:
+      required: false
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to reproduce the bug
+      placeholder: |
+        1. ...
+        2. ...
+        3. ...
+    validations:
+      required: false
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected
+    validations:
+      required: false
+  - type: textarea
+    id: log
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: false
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+    validations:
+      required: false
+  - type: textarea
+    id: related_issues
+    attributes:
+      label: Related Issue
+      placeholder: "Ref: #3899"

data/.github/ISSUE_TEMPLATE/feature-suggestion.yml

@@ -0,0 +1,22 @@
+name: Feature Suggestion
+description: Suggestions for new feature
+assignees: IkumaTadokoro
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: "Thanks for taking the time to fill out this feature proposal!"
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of new feature
+    validations:
+      required: false
+  - type: textarea
+    id: reason
+    attributes:
+      label: Reason
+      description: Please fill out the reason why your idea should be adopted.
+    validations:
+      required: false

data/.github/codespell-problem-matcher.json

@@ -0,0 +1,15 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "codespell",
+      "pattern": [
+        {
+          "regexp": "^.+/(.+?):(\\d+): (.+)$",
+          "file": 1,
+          "line": 2,
+          "message": 3
+        }
+      ]
+    }
+  ]
+}

data/.github/misspell-problem-matcher.json

@@ -0,0 +1,15 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "misspell",
+      "pattern": [
+        {
+          "regexp": "^(.+):(\\d+):\\d+: (.+)$",
+          "file": 1,
+          "line": 2,
+          "message": 3
+        }
+      ]
+    }
+  ]
+}

data/.github/workflows/spell-checking.yml

@@ -0,0 +1,44 @@
+name: Spell Checking
+
+on:
+  push:
+    branches: ["main"]
+    tags: ["**"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  codespell:
+    name: Check spelling all files with codespell
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install codespell
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: enable problem matcher
+        run: |
+          echo "::add-matcher::.github/codespell-problem-matcher.json"
+      - name: Check spelling with codespell
+        run: codespell --ignore-words=codespell.txt || exit 1
+  misspell:
+    name: Check spelling all files in commit with misspell
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install
+        run: wget -O - -q https://git.io/misspell | sh -s -- -b .
+      - name: enable problem matcher
+        run: |
+          echo "::add-matcher::.github/misspell-problem-matcher.json"
+      - name: Misspell
+        run: git ls-files --empty-directory | xargs ./misspell -i 'enviromnent' -error

data/.gitignore

@@ -5,7 +5,6 @@
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
 vendor/bundle
 
 # rspec failure tracking

data/.rubocop.yml

@@ -9,6 +9,14 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/ClassLength:
+  Exclude:
+    - spec/**/*
+
 Layout/LineLength:
   Max: 120
 

data/CHANGELOG.md

@@ -1,4 +1,35 @@
-## [Unreleased]
+# [0.2.0](https://github.com/IkumaTadokoro/jp_local_gov/compare/v0.1.0...v0.2.0) (2022-01-14)
+
+### chore
+
+* Add RSpec Runner for JetBrains IDE ([83d8c86](https://github.com/IkumaTadokoro/jp_local_gov/commit/83d8c8649f69506c9a08acf275960480316eb988))
+* Make JpLocalGov::Data::Importer#prefecture_capital? to return true/false ([82daafd](https://github.com/IkumaTadokoro/jp_local_gov/commit/82daafd19b47e52ff2c1c341a243aef7e5dffae4))
+
+### ci
+
+* Add spell checking GitHub Actions Workflow ([fc23bd1](https://github.com/IkumaTadokoro/jp_local_gov/commit/fc23bd1a3c10cc49f8aaf4e869c0062b50255f03))
+
+### docs
+
+* 💅 ([61c6d66](https://github.com/IkumaTadokoro/jp_local_gov/commit/61c6d66a43b75339036656a1b110dec97156177e))
+* Add how to use JpLocalGov.valid_code? ([2e14d71](https://github.com/IkumaTadokoro/jp_local_gov/commit/2e14d71c146d823e4bc3fa268da2e3a0c5f7ebe1))
+* Add issue template ([9f416a3](https://github.com/IkumaTadokoro/jp_local_gov/commit/9f416a335247c3be5c52e450b914bd73c380092d)), closes [#47](https://github.com/IkumaTadokoro/jp_local_gov/issues/47)
+
+### feat
+
+* Add JpLocalGov::Random module ([bae16d7](https://github.com/IkumaTadokoro/jp_local_gov/commit/bae16d7b8ebeff1871b2b5586f0b916253c462e7)), closes [#65](https://github.com/IkumaTadokoro/jp_local_gov/issues/65)
+* Add JpLocalGov.all_xxx ([f522686](https://github.com/IkumaTadokoro/jp_local_gov/commit/f52268612a5c41435e4a20f3759c9d7d70686a62)), closes [#54](https://github.com/IkumaTadokoro/jp_local_gov/issues/54)
+* Make JpLocalGov.valid_code? public ([e46b4e7](https://github.com/IkumaTadokoro/jp_local_gov/commit/e46b4e79f3fd0098bd2b509123f866a92c01ee37)), closes [#55](https://github.com/IkumaTadokoro/jp_local_gov/issues/55)
+
+### fix
+
+* Fix a task(`jp_local_gov:data:update_all`) ([e21125c](https://github.com/IkumaTadokoro/jp_local_gov/commit/e21125cda74c62e7b45b528ee0f908cfbab6b039)), closes [#60](https://github.com/IkumaTadokoro/jp_local_gov/issues/60)
+
+### style
+
+* Add rubocop-rake and rubocop-rspec ([eb5f7d2](https://github.com/IkumaTadokoro/jp_local_gov/commit/eb5f7d22066a65d41d112e60dc8fc7c9b8b71c47))
+* omit parentheses for internal DSL(RSpec) ([3c23ec5](https://github.com/IkumaTadokoro/jp_local_gov/commit/3c23ec5a19460e2c8ed496b61536ebd800cfeb03))
+* Remove Metrics rule for spec ([e362565](https://github.com/IkumaTadokoro/jp_local_gov/commit/e3625658376a6b0fd8ac5cea97b0d857cd6f6e7b))
 
 ## [0.1.0] - 2021-11-28
 

data/Gemfile

@@ -15,6 +15,8 @@ group :development do
   gem "rbs"
   gem "rubocop"
   gem "rubocop-fjord"
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
   gem "sqlite3"
   gem "steep"
 end

data/README.md

@@ -1,8 +1,25 @@
+[![Gem Version](https://badge.fury.io/rb/jp_local_gov.svg)](https://badge.fury.io/rb/jp_local_gov)
+[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/IkumaTadokoro/jp_local_gov/blob/main/LICENSE.txt)
+![Gem](https://img.shields.io/gem/dt/jp_local_gov)
+
 # JpLocalGov
 
 Convert local government code based on JIS X 0402 to local government name in Japan.  
 Reference(Japanese): [全国地方公共団体コード \- Wikipedia](https://ja.wikipedia.org/wiki/%E5%85%A8%E5%9B%BD%E5%9C%B0%E6%96%B9%E5%85%AC%E5%85%B1%E5%9B%A3%E4%BD%93%E3%82%B3%E3%83%BC%E3%83%89)
 
+### Issues
+
+If you find any bugs or concerns, or have suggestions for new features, please feel free to add them as an [GitHub Issue](https://github.com/IkumaTadokoro/jp_local_gov/issues/new/choose)!
+
+There are issue templates for bug and feature. If neither, please use the blank template.
+
+### Special Thanks
+
+This gem is based on and inspired by [chocoby/jp_prefecture](https://github.com/chocoby/jp_prefecture).   
+And I referenced [kufu/jpostcode-data](https://github.com/kufu/jpostcode-data) for the method of data acquisition.
+
+Thanks!😁
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -60,7 +77,7 @@ This search function is an exact match search.
 
 ```ruby
 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", @prefectuefecture="宮崎県", @prefecture_kana="ミヤザキケン", @city="美郷町", @city_kana="ミサトチョウ", @prefecture_capital=false>]
+# => [#<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}" }
 # => ["秋田県:美郷町", "島根県:美郷町", "宮崎県:美郷町"]
 
@@ -84,13 +101,22 @@ The following attributes can be specified for the condition.
 | city_kana          | String        | "チヨダク"   |
 | prefecture_capital | true or false | false    |
 
+### All data
+
+You can get all local governments using `JpLocalGov.all`
+
+```ruby
+JpLocalGov.all
+# =>  [#<JpLocalGov::LocalGov:0x00007fdf3a9c6758 @code="011002", @prefecture_code="01", @prefecture="北海道", @prefecture_kana="ホッカイドウ", @city="札幌市na="サッポロシ", @prefecture_capital=true>, #<JpLocalGov::LocalGov:0x00007fdf3a9c6730 @code="011011",...
+```
+
 ### Usage on Rails (ActiveRecord)
 
 Include JpLocalGov to Model which ActiveRecord::Base inherited.
 
 ```ruby
-# app/models/insurrance_fees.rb:
-class Place < ActiveRecord::Base
+# app/models/insurance_fee.rb:
+class InsuranceFee < ActiveRecord::Base
   # local_gov_code:String
 
   include JpLocalGov
@@ -110,13 +136,43 @@ insurance_fee.local_government.city
 In Migration file, set `local_gov_code` column type to `string`.
 
 ```ruby
-class AddLocalGovCodeToinsuranceFees < ActiveRecord::Migration
+class AddLocalGovCodeToInsuranceFees < ActiveRecord::Migration
   def change
     add_column :insurance_fees, :local_gov_code, :string
   end
 end
 ```
 
+### Validation
+
+You can use `JpLocalGov.valid_code?(local_gov_code)` in `validate` method.
+
+```ruby
+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
+```
+
+This method inspect code by [check digits defined in JISX0402](https://www.soumu.go.jp/main_content/000137948.pdf).
+(And also check code is String.)
+
+### View Template
+
+Use `collection_select` to generate selector in view:
+
+```ruby
+f.collection_select :local_gov_code, JpLocalGov.all, :code, :city # e.g. code: 131016, city: "千代田区"
+```
+
 ## Development
 
 ### Steps
@@ -138,9 +194,62 @@ end
 | `bin/lint`         | Run Rubocop                                                                                              |
 | `bin/steep`        | Run `steep stats` and `steep check`                                                                      |
 
+### Running Test via JetBrains IDE (e.g. RubyMine)
+
+This gem use 'Appraisal' to inspect several versions of Rails.
+
+So you should run rspec by `bundle exec appraisal rspec` and you won't be able to run spec via IDE (only run via your
+terminal).
+
+If you use JetBrains IDE and you want to run spec via IDE, try to configure the following steps.
+
+1. Open 「Edit Configurations...」
+2. Open 「Edit Configuration templates...」
+3. Select 「RSpec」
+4. Check 「Use custom RSpec runner script:」 and fill the script with `[CLONE_DIR]/bin/spec_runner.rb`
+5. Click「APPLY」, then you can run spec via IDE!!🎉
+
+If you have already run spec via IDE before configuration, delete the existing configuration and try to configure the
+above steps
+
+## Update local government data
+
+This Gem update local government data (format: JSON) automatically once a month by [GitHub Actions](https://github.com/IkumaTadokoro/jp_local_gov/actions/workflows/auto-update.yml).
+
+- Data source: https://www.soumu.go.jp/denshijiti/code.html
+- Output: https://github.com/IkumaTadokoro/jp_local_gov/tree/main/data/json
+
+Fetch script is written in Ruby and Rake Task. So you can run update data at local by the following command.
+
+```ruby
+bundle exec rake jp_local_gov:data:update_all
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/IkumaTadokoro/jp_local_gov. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/IkumaTadokoro/jp_local_gov/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/IkumaTadokoro/jp_local_gov. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://github.com/IkumaTadokoro/jp_local_gov/blob/main/CODE_OF_CONDUCT.md).
+
+### Spell Checking
+
+We are running [misspell](https://github.com/client9/misspell) which is mainly written in
+[Golang](https://golang.org/) to check spelling with [GitHub Actions](../.github/workflows/spell-checking.yml). Correct
+commonly misspelled English words quickly with `misspell`. `misspell` is different from most other spell checkers
+because it doesn't use a custom dictionary. You can run `misspell` locally against all files with:
+
+    $ find . -type f | xargs ./misspell -error
+
+Notable `misspell` help options or flags are:
+
+* `-i` string: ignore the following corrections, comma separated
+* `-w`: Overwrite file with corrections (default is just to display)
+
+We also run [codespell](https://github.com/codespell-project/codespell) with GitHub Actions to check spelling and
+[codespell](https://pypi.org/project/codespell/) runs against a [small custom dictionary](../codespell.txt).
+`codespell` is written in [Python](https://www.python.org/) and you can run it with:
+
+    $ codespell --ignore-words=codespell.txt
 
 ## License
 
@@ -148,4 +257,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the JpLocalGov project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/IkumaTadokoro/jp_local_gov/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the JpLocalGov project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/IkumaTadokoro/jp_local_gov/blob/main/CODE_OF_CONDUCT.md).

data/bin/spec_runner.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# !/usr/bin/env ruby
+
+# Most of the code here is copied from /lib/appraisal/cli.rb in the appraisal gem library
+require "rubygems"
+require "bundler/setup"
+require "appraisal"
+require "appraisal/cli"
+
+begin
+  `bundle exec appraisal list`.split(/\R/) do |appraisal_name|
+    cmd = [appraisal_name, "rspec"] + ARGV
+    Appraisal::CLI.start(cmd)
+  end
+rescue Appraisal::AppraisalsNotFound => e
+  puts e.message
+  exit 127
+end

data/data/importer.rb

@@ -56,7 +56,7 @@ module JpLocalGov
 
       def prefecture_capital?(prefecture, city)
         prefecture_capital_list = JSON.parse(File.open(File.expand_path("prefecture_capital.json", __dir__)).read)
-        prefecture_capital_list.find do |prefecture_capital|
+        prefecture_capital_list.any? do |prefecture_capital|
           prefecture_capital["prefecture"] == prefecture && prefecture_capital["city"] == city
         end
       end

data/lib/jp_local_gov/random.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../jp_local_gov"
+
+module JpLocalGov
+  module Random
+    DATA_DIR = "#{File.dirname(__FILE__)}/../../data/json/".freeze
+    RANDOMIZE_TARGET = %w[code city city_kana prefecture prefecture_code prefecture_kana].freeze
+
+    module_function
+
+    RANDOMIZE_TARGET.each do |target|
+      define_method target.to_s do
+        sample_data.send(target)
+      end
+    end
+
+    def sample_data
+      file_name = ("1".."47").to_a.sample&.rjust(2, "0")
+      json_file = "#{DATA_DIR}#{file_name}.json"
+      data = JSON.parse(File.read(json_file), { symbolize_names: true })
+      JpLocalGov::LocalGov.new(data[data.keys.sample])
+    end
+
+    private_class_method :sample_data
+    private_constant :DATA_DIR, :RANDOMIZE_TARGET
+  end
+end

data/lib/jp_local_gov/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JpLocalGov
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/jp_local_gov.rb

@@ -9,6 +9,8 @@ module JpLocalGov
   DATA_DIR = "#{File.dirname(__FILE__)}/../data/json/".freeze
   CHECK_DIGITS_INDEX = 5
   CHECK_BASE = 11
+  PREFECTURE_RANGE = 1..47
+  VALID_CODE_LENGTH = 6
 
   module_function
 
@@ -17,7 +19,7 @@ module JpLocalGov
   end
 
   def find(local_gov_code)
-    return nil unless local_gov_code.is_a?(String) && valid_code?(local_gov_code)
+    return nil unless valid_code?(local_gov_code)
 
     json_file = "#{DATA_DIR}#{local_gov_code[0..1]}.json"
     data = JSON.parse(File.open(json_file).read, { symbolize_names: true })
@@ -30,9 +32,9 @@ module JpLocalGov
   def where(conditions)
     return nil unless conditions.is_a?(Hash)
 
-    json_files = [*1..47].map { format("%02<number>d", number: _1) }.map { "#{DATA_DIR}#{_1}.json" }
+    json_files = prefecture_code_list.map { "#{DATA_DIR}#{_1}.json" }
     results = json_files.map do |json_file|
-      data = JSON.parse(File.open(json_file).read, { symbolize_names: true })
+      data = JSON.parse(File.read(json_file), { symbolize_names: true })
       build_local_gov(data, conditions)
     end.flatten.compact
     return nil if results.empty?
@@ -40,6 +42,30 @@ module JpLocalGov
     results
   end
 
+  # Inspect code by check digits defined in JISX0402
+  # https://www.soumu.go.jp/main_content/000137948.pdf
+  def valid_code?(code)
+    unless code.is_a?(String) && code.length == VALID_CODE_LENGTH && prefecture_code_list.include?(code[0..1])
+      return false
+    end
+
+    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
+  end
+
+  def all
+    json_files = prefecture_code_list.map { "#{DATA_DIR}#{_1}.json" }
+    json_files.flat_map do |json_file|
+      data = JSON.parse(File.read(json_file), { symbolize_names: true })
+      data.values.map { |value| JpLocalGov::LocalGov.new(value) }
+    end
+  end
+
   def build_local_gov(data, conditions)
     data.values
         .select { |target| filter(target, conditions) }
@@ -51,18 +77,10 @@ module JpLocalGov
     conditions.map { |condition| target[condition[0]] == condition[1] }.all?
   end
 
-  # Inspect code by check digits defined in JISX0402
-  # https://www.soumu.go.jp/main_content/000137948.pdf
-  def valid_code?(code)
-    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
+  def prefecture_code_list
+    [*PREFECTURE_RANGE].map { format("%02<number>d", number: _1) }
   end
 
-  private_class_method :valid_code?, :build_local_gov, :filter
+  private_class_method :build_local_gov, :filter, :prefecture_code_list
   private_constant :CHECK_DIGITS_INDEX, :CHECK_BASE
 end

data/sig/jp_local_gov/random.rbs

@@ -0,0 +1,9 @@
+module JpLocalGov
+  module Random
+    DATA_DIR: String
+
+    RANDOMIZE_TARGET: Array[String]
+
+    def self?.sample_data: () -> JpLocalGov::LocalGov
+  end
+end

data/sig/jp_local_gov.rbs

@@ -5,15 +5,23 @@ module JpLocalGov
 
   CHECK_BASE: Integer
 
+  PREFECTURE_RANGE: Range[Integer]
+
+  VALID_CODE_LENGTH: Integer
+
   def self?.included: (Class | Module model_class) -> (Class | Module)
 
   def self?.find: (String local_gov_code) -> (nil | JpLocalGov::LocalGov)
 
   def self?.where: (Hash[Symbol, untyped] conditions) -> (nil | Array[JpLocalGov::LocalGov])
 
+  def self?.valid_code?: (String code) -> bool
+
+  def self.all: () -> Array[JpLocalGov::LocalGov]
+
   def self?.build_local_gov: (Hash[Symbol, untyped] data, Hash[Symbol, String] conditions) -> (nil | Array[JpLocalGov::LocalGov])
 
   def self?.filter: (Hash[Symbol, untyped] target, Hash[Symbol, String] conditions) -> bool
 
-  def self?.valid_code?: (String code) -> bool
+  def prefecture_code_list: () -> Array[String]
 end

data/tmp/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jp_local_gov
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ikuma-t
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies: []
 description: Convert japan local government code (JIS X 0402 based) into the local
   government name.
@@ -18,10 +18,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug-report.yml"
+- ".github/ISSUE_TEMPLATE/feature-suggestion.yml"
+- ".github/codespell-problem-matcher.json"
 - ".github/dependabot.yml"
+- ".github/misspell-problem-matcher.json"
 - ".github/workflows/auto-update.yml"
 - ".github/workflows/lint.yml"
 - ".github/workflows/main.yml"
+- ".github/workflows/spell-checking.yml"
 - ".github/workflows/steep.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -40,8 +45,10 @@ files:
 - bin/generate_rbs
 - bin/lint
 - bin/setup
+- bin/spec_runner.rb
 - bin/steep
 - bin/test
+- codespell.txt
 - data/base.rb
 - data/exporter.rb
 - data/importer.rb
@@ -99,11 +106,14 @@ files:
 - lib/jp_local_gov.rb
 - lib/jp_local_gov/base.rb
 - lib/jp_local_gov/local_gov.rb
+- lib/jp_local_gov/random.rb
 - lib/jp_local_gov/version.rb
 - sig/jp_local_gov.rbs
 - sig/jp_local_gov/base.rbs
 - sig/jp_local_gov/local_gov.rbs
+- sig/jp_local_gov/random.rbs
 - sig/jp_local_gov/version.rbs
+- tmp/.gitignore
 homepage: https://github.com/IkumaTadokoro/jp_local_gov
 licenses:
 - MIT