jp_local_gov 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4860d4939032f21410e79a628f6000fd037f755e9997903e670e8a9195c272c9
+  data.tar.gz: 2f263d1c09e9db4e138fbaac8bd31bc10f26692bf1bd6b2a1ee07a9c4f879578
+SHA512:
+  metadata.gz: af1984c55d50f4368dfda951e6cc2a18e4a564e54002da1728b1a5c12baeeaddfe89efd38bd36c759d1ce5ff5966f0870eb7e35e42315b703c112eb056cc599d
+  data.tar.gz: ee7b9dc6f8cca9f271a173acac5052a517c9882fb34911f12503782879e29c5239aa3773ea856d5765550b5e8965ad059863f2686e49a36f7200cfa3d18e9c68

data/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "20:00"
+    ignore:
+      - dependency-name: activesupport

data/.github/workflows/auto-update.yml

@@ -0,0 +1,27 @@
+name: auto-update
+
+on:
+  schedule:
+    - cron:  '0 0 1 * *'
+  workflow_dispatch:
+
+jobs:
+  update-jplocalgov-data:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: update jplocalgov data
+        run: bundle exec rake jplocalgov:data:update_all
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          base: main
+          branch: update_jplocalgov_data
+          branch-suffix: timestamp
+          delete-branch: true
+          title: bundle exec rake jplocalgov:data:update_all
+          commit-message: bundle exec rake jplocalgov:data:update_all

data/.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: Lint
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Rubocop
+        run: bundle exec rubocop

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.6
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.github/workflows/steep.yml

@@ -0,0 +1,30 @@
+name: Steep
+
+on:
+  push:
+    branches: ["main"]
+    tags: ["**"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: bundle exec appraisal install
+      - run: |
+          bundle exec steep check | ruby -pe 'sub(/^(.+):(\d+):(\d+): (.+)$/, %q{::error file=\1,line=\2,col=\3::\4})'
+        shell: bash
+  stats:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: bundle exec appraisal install
+      - run: bundle exec rake steep:stats

data/.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Test
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: bundle exec appraisal install
+      - run: bundle exec appraisal rspec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/bundle
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+inherit_gem:
+  rubocop-fjord:
+    - "config/rubocop.yml"

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/Appraisals

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+appraise "rails61" do
+  gem "activerecord", "~> 6.1.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tadokorodev@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jp_local_gov.gemspec
+gemspec
+
+gem "rake"
+
+group :development do
+  gem "activesupport", "~> 6.1" # TODO: To avoid steep dependencies error. Refs: https://github.com/soutaro/steep/issues/466
+  gem "appraisal"
+  gem "nokogiri"
+  gem "pdf-reader"
+  gem "rbs"
+  gem "rubocop"
+  gem "rubocop-fjord"
+  gem "sqlite3"
+  gem "steep"
+end
+
+group :test do
+  gem "rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ikuma-t
+
+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.

data/README.md

@@ -0,0 +1,151 @@
+# 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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jp_local_gov'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jp_local_gov
+
+## Usage
+
+### Requirement
+
+```ruby
+require 'jp_local_gov'
+```
+
+### Search Local Government by Code
+
+Provide local government code to search local government's data.  
+Only a String can be used for 'code'.
+
+```ruby
+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
+```
+
+About prefecture capital: [List of capitals in Japan \- Wikipedia](https://en.wikipedia.org/wiki/List_of_capitals_in_Japan)
+
+### Filtered Search
+
+Use the `where` to enable AND searches with multiple conditions(Hash).  
+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>]
+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 "東京".
+```
+
+The following attributes can be specified for the condition.
+
+| Attributes         | Type          | Examples |
+|--------------------|---------------|----------|
+| code               | String        | "131016" |
+| prefecture_code    | String        | "13"     |
+| prefecture         | String        | "東京都"    |
+| prefecture_kana    | String        | "トウキョウト" |
+| city               | String        | "千代田区"   |
+| city_kana          | String        | "チヨダク"   |
+| prefecture_capital | true or false | false    |
+
+### Usage on Rails (ActiveRecord)
+
+Include JpLocalGov to Model which ActiveRecord::Base inherited.
+
+```ruby
+# app/models/insurrance_fees.rb:
+class Place < ActiveRecord::Base
+  # local_gov_code:String
+
+  include JpLocalGov
+  jp_local_gov :local_gov_code
+end
+```
+
+By JpLocalGov included, `local_government` method will be generated:
+
+```ruby
+insurance_fee = InsuranceFee.new
+insurance_fee.local_gov_code = "131016"
+insurance_fee.local_government.city
+# => "千代田区"
+```
+
+In Migration file, set `local_gov_code` column type to `string`.
+
+```ruby
+class AddLocalGovCodeToinsuranceFees < ActiveRecord::Migration
+  def change
+    add_column :insurance_fees, :local_gov_code, :string
+  end
+end
+```
+
+## Development
+
+### Steps
+
+1. Fork it -> `git clone https://github.com/IkumaTadokoro/jp_local_gov/fork`
+2. Run `bin/setup` to install dependencies
+3. Create your feature branch
+4. Implement feature and run `bin/test`, `bin/lint`, `bin/steep` to check your implementation
+5. Push to the branch
+6. Create a new Pull Request
+
+### Commands
+
+| Command            | Details                                                                                                  |
+|--------------------|----------------------------------------------------------------------------------------------------------|
+| `bin/console`      | An interactive prompt that will allow you to experiment                                                  |
+| `bin/generate_rbs` | Create rbs file in `/sig` for new ruby files in `/lib`                                                   |
+| `bin/test`         | Run `rspec` via Appraisal. <br>To specify the version, use `bin/test <version>`（e.g. `bin/test rails61`） |
+| `bin/lint`         | Run Rubocop                                                                                              |
+| `bin/steep`        | Run `steep stats` and `steep check`                                                                      |
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+require_relative "data/importer"
+require_relative "data/exporter"
+
+namespace :jplocalgov do
+  namespace :data do
+    desc "Updates local_government_code data"
+    task :update_all do
+      puts "Reset temp DB..."
+      importer = JpLocalGov::Data::Importer.new
+      importer.reset_table
+
+      puts "Retrieving local government data..."
+      importer.retrieve_and_save
+
+      puts "Extract to json files..."
+      JpLocalGov::Data::Exporter.new.execute
+    end
+  end
+end
+
+namespace :steep do
+  desc "Run type-check by Steep"
+  task :check do
+    sh "bundle", "exec", "steep", "check", "--log-level=fatal"
+  end
+
+  desc "Show the Steep coverage report"
+  task :stats do
+    sh "bundle", "exec", "steep", "stats", "--log-level=fatal", "--format=table"
+  end
+end

data/Steepfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+target :lib do
+  check "lib"
+  signature "sig"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jp_local_gov"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/generate_rbs

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pathname"
+
+Dir.glob("lib/**/*.rb") do |rb_file|
+  rbs_file = rb_file.sub(/lib/, "sig").sub(/\.rb$/, ".rbs")
+  next if File.exist?(rbs_file)
+
+  Pathname(rbs_file).parent.mkpath
+  system "bundle exec rbs prototype rb #{rb_file} > #{rbs_file}", exception: true
+  puts "#{rbs_file} generated."
+end

data/bin/lint

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rubocop -a

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+bundle exec appraisal install

data/bin/steep

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+bundle exec rake steep:stats
+bundle exec rake steep:check

data/bin/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+appraisal_name=$1
+bundle exec appraisal ${appraisal_name:+ "${appraisal_name}"} rspec

data/data/base.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module JpLocalGov
+  module Data
+    class Base
+      def db
+        @db ||= SQLite3::Database.new("tmp/test.db")
+      end
+
+      def reset_table
+        drop_table
+        create_table
+      end
+
+      def drop_table
+        db.execute <<-SQL
+          DROP TABLE IF EXISTS local_governments;
+        SQL
+      end
+
+      def create_table
+        db.execute <<-SQL
+          CREATE TABLE local_governments (
+            code VARCHAR(5),
+            prefecture_code VARCHAR(2),
+            prefecture VARCHAR(256),
+            prefecture_kana VARCHAR(256),
+            city VARCHAR(256),
+            city_kana VARCHAR(256),
+            prefecture_capital VARCHAR(10)
+          );
+        SQL
+
+        db.execute <<-SQL
+          CREATE INDEX idx_local_governments ON local_governments (prefecture, city);
+        SQL
+      end
+
+      def retrieve_and_save
+        db.execute "BEGIN TRANSACTION"
+        retrieve.each do |hash|
+          insert(hash)
+        end
+        db.execute "COMMIT"
+      end
+
+      INSERT_SQL = <<-SQL
+        INSERT INTO local_governments (
+          code,
+          prefecture_code,
+          prefecture,
+          prefecture_kana,
+          city,
+          city_kana,
+          prefecture_capital
+        ) VALUES (?, ?, ?, ?, ?, ?, ?);
+      SQL
+
+      private
+
+      def insert(hash)
+        db.execute(
+          INSERT_SQL,
+          hash[:code],
+          hash[:prefecture_code],
+          hash[:prefecture],
+          hash[:prefecture_kana],
+          hash[:city],
+          hash[:city_kana],
+          hash[:prefecture_capital]
+        )
+      end
+    end
+  end
+end