jp_local_gov 0.1.0

data/jp_local_gov.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/jp_local_gov/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jp_local_gov"
+  spec.version       = JpLocalGov::VERSION
+  spec.authors       = ["ikuma-t"]
+  spec.email         = ["tadokorodev@gmail.com"]
+
+  spec.summary       = "Convert japan local government code into the local government name."
+  spec.description   = "Convert japan local government code (JIS X 0402 based) into the local government name."
+  spec.homepage      = "https://github.com/IkumaTadokoro/jp_local_gov"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/jp_local_gov/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "../jp_local_gov"
+
+module JpLocalGov
+  module Base
+    def jp_local_gov(column_name)
+      define_method "local_government" do
+        JpLocalGov.find(send(column_name))
+      end
+    end
+  end
+end

data/lib/jp_local_gov/local_gov.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module JpLocalGov
+  class LocalGov
+    attr_reader :code, :prefecture_code, :prefecture, :prefecture_kana, :city, :city_kana, :prefecture_capital
+
+    def initialize(data)
+      @code = data[:code]
+      @prefecture_code = data[:prefecture_code]
+      @prefecture = data[:prefecture]
+      @prefecture_kana = data[:prefecture_kana]
+      @city = data[:city]
+      @city_kana = data[:city_kana]
+      @prefecture_capital = data[:prefecture_capital]
+    end
+  end
+end

data/lib/jp_local_gov/version.rb

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

data/lib/jp_local_gov.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "jp_local_gov/version"
+require_relative "jp_local_gov/local_gov"
+require_relative "jp_local_gov/base"
+require "json"
+
+module JpLocalGov
+  DATA_DIR = "#{File.dirname(__FILE__)}/../data/json/".freeze
+  CHECK_DIGITS_INDEX = 5
+  CHECK_BASE = 11
+
+  module_function
+
+  def included(model_class)
+    model_class.extend Base
+  end
+
+  def find(local_gov_code)
+    return nil unless local_gov_code.is_a?(String) && 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 })
+    local_gov_data = data[local_gov_code.to_sym]
+    return nil if local_gov_data.nil?
+
+    JpLocalGov::LocalGov.new(local_gov_data)
+  end
+
+  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" }
+    results = json_files.map do |json_file|
+      data = JSON.parse(File.open(json_file).read, { symbolize_names: true })
+      build_local_gov(data, conditions)
+    end.flatten.compact
+    return nil if results.empty?
+
+    results
+  end
+
+  def build_local_gov(data, conditions)
+    data.values
+        .select { |target| filter(target, conditions) }
+        .tap { |result| return nil if result.empty? }
+        .map { |result| JpLocalGov::LocalGov.new(result) }
+  end
+
+  def filter(target, conditions)
+    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
+  end
+
+  private_class_method :valid_code?, :build_local_gov, :filter
+  private_constant :CHECK_DIGITS_INDEX, :CHECK_BASE
+end

data/sig/jp_local_gov/base.rbs

@@ -0,0 +1,7 @@
+module JpLocalGov
+  module Base : Module
+    def jp_local_gov: (Symbol | String column_name) -> Symbol
+
+    def local_government: () -> JpLocalGov::LocalGov
+  end
+end

data/sig/jp_local_gov/local_gov.rbs

@@ -0,0 +1,19 @@
+module JpLocalGov
+  class LocalGov
+    attr_reader code: String
+
+    attr_reader prefecture_code: String
+
+    attr_reader prefecture: String
+
+    attr_reader prefecture_kana: String
+
+    attr_reader city: String
+
+    attr_reader city_kana: String
+
+    attr_reader prefecture_capital: bool
+
+    def initialize: (Hash[Symbol, untyped] data) -> void
+  end
+end

data/sig/jp_local_gov/version.rbs

@@ -0,0 +1,3 @@
+module JpLocalGov
+  VERSION: ::String
+end

data/sig/jp_local_gov.rbs

@@ -0,0 +1,19 @@
+module JpLocalGov
+  DATA_DIR: String
+
+  CHECK_DIGITS_INDEX: Integer
+
+  CHECK_BASE: 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?.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
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: jp_local_gov
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ikuma-t
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-22 00:00:00.000000000 Z
+dependencies: []
+description: Convert japan local government code (JIS X 0402 based) into the local
+  government name.
+email:
+- tadokorodev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/auto-update.yml"
+- ".github/workflows/lint.yml"
+- ".github/workflows/main.yml"
+- ".github/workflows/steep.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- bin/console
+- bin/generate_rbs
+- bin/lint
+- bin/setup
+- bin/steep
+- bin/test
+- data/base.rb
+- data/exporter.rb
+- data/importer.rb
+- data/json/01.json
+- data/json/02.json
+- data/json/03.json
+- data/json/04.json
+- data/json/05.json
+- data/json/06.json
+- data/json/07.json
+- data/json/08.json
+- data/json/09.json
+- data/json/10.json
+- data/json/11.json
+- data/json/12.json
+- data/json/13.json
+- data/json/14.json
+- data/json/15.json
+- data/json/16.json
+- data/json/17.json
+- data/json/18.json
+- data/json/19.json
+- data/json/20.json
+- data/json/21.json
+- data/json/22.json
+- data/json/23.json
+- data/json/24.json
+- data/json/25.json
+- data/json/26.json
+- data/json/27.json
+- data/json/28.json
+- data/json/29.json
+- data/json/30.json
+- data/json/31.json
+- data/json/32.json
+- data/json/33.json
+- data/json/34.json
+- data/json/35.json
+- data/json/36.json
+- data/json/37.json
+- data/json/38.json
+- data/json/39.json
+- data/json/40.json
+- data/json/41.json
+- data/json/42.json
+- data/json/43.json
+- data/json/44.json
+- data/json/45.json
+- data/json/46.json
+- data/json/47.json
+- data/prefecture_capital.json
+- gemfiles/rails61.gemfile
+- gemfiles/rails61.gemfile.lock
+- jp_local_gov.gemspec
+- lib/jp_local_gov.rb
+- lib/jp_local_gov/base.rb
+- lib/jp_local_gov/local_gov.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/version.rbs
+homepage: https://github.com/IkumaTadokoro/jp_local_gov
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Convert japan local government code into the local government name.
+test_files: []