japan_postcoder 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42f711e90b2e76e99624f0aafbfde2556a8861fc6e0a8ee28e257d23fdc5e297
-  data.tar.gz: f754eed765d524c921a94151e280c73cb0a6c8a67207603664dab81454dfe4d4
+  metadata.gz: d3e586650b4f5341b900ad823ee293bfd2f8657add741f38b547ff40c12efbca
+  data.tar.gz: a85ca2b8f88ae9c68f230dc9db5e76d6da19800087d8f6c43eb7302cc9036d06
 SHA512:
-  metadata.gz: e33bfd75a16a545c31b0788f915a2df232d2a8208feed1f60e39889b44a9b72ff1d8def8e9eb4077b22ca44ae0a8a30870459a64fe857b2d92935b250a6825fc
-  data.tar.gz: b8a812518c9ab347682f26f38dcc41f4a5629d3252fe060b79451036b728932b2aac7188c14121e868b256244d55d423063e4bcd3013c9acaa1a2f1f611252e4
+  metadata.gz: 1c42fdfa2a7728f0cee86f28aa86e1e68ff6c11793272eb9977d9168689c7f8de0d1a8ef68859fe70cd19442b7d664781880a65452313479bb05a7c5eafad91e
+  data.tar.gz: cade322ce15eb46ce73b119bd25b630da8209b526fc4bd29f8065f551abe94d9bc7f38ab1e79a199c5cfb9f6ce1898b1152ebbf1820b0535724e102efde341e8

data/README.md

@@ -1,35 +1,82 @@
-# JapanPostcoder
+<p align="center">
+  <a>
+    <img src="https://static.vecteezy.com/system/resources/thumbnails/004/587/562/small_2x/doodle-freehand-drawing-of-japan-map-free-vector.jpg" width="60" />
+  </a>
+</p>
+<h1 align="center">
+  🇯🇵 Japan Postcoder
+</h1>
 
-TODO: Delete this and the text below, and describe your gem
+[![Tests](https://github.com/tonystrawberry/japan_postcoder/workflows/Ruby/badge.svg)](https://github.com/tonystrawberry/japan_postcoder/actions/workflows/main.yml)
+<a href="https://codeclimate.com/github/tonystrawberry/japan_postcoder/maintainability"><img src="https://api.codeclimate.com/v1/badges/7362475ad52048cbbee1/maintainability" /></a>
+<a href="https://codeclimate.com/github/tonystrawberry/japan_postcoder/test_coverage"><img src="https://api.codeclimate.com/v1/badges/7362475ad52048cbbee1/test_coverage" /></a>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/japan_postcoder`. To experiment with that code, run `bin/console` for an interactive prompt.
+Japan Postcoder is a library that allows you to get the address of a location in Japan from its postcode.
+It will help you get the prefecture, city, ward and street name from a postcode.
 
-## Installation
+All the location data is provided by the [Japan Post](https://www.post.japanpost.jp/zipcode/download.html)
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Rubygems link is here: https://rubygems.org/gems/japan_postcoder
 
-Install the gem and add to the application's Gemfile by executing:
+# 🏃🏻 Getting started
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Start by including `japan-postcoder` in your project:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem 'japan-postcoder'
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Then, you can use the `JapanPostcoder` class to get the address of a location in Japan from its postcode:
 
-## Usage
+# 👨🏻‍💻 Usage
 
-TODO: Write usage instructions here
+You can use the `JapanPostcoder` class to get the address of a location in Japan in **string** format.
+```ruby
+require 'japan-postcoder'
 
-## Development
+postcode = '2140037'
+address = JapanPostcoder.to_address(postcode)
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+puts address # => "神奈川県川崎市多摩区菅仙谷町"
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You can also use the `JapanPostcoder` class to get the address of a location in Japan in **hash** format.
+```ruby
+require 'japan-postcoder'
 
-## Contributing
+postcode = '2140037'
+address = JapanPostcoder.to_address_hash(postcode)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/japan_postcoder.
+puts address # => {:prefecture=>"神奈川県", :city=>"川崎市", :ward=>"多摩区", :district=>"菅仙谷町"}
+```
 
-## License
+## 🇬🇧 Romaji transcription
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+You can use the `JapanPostcoder` class to get the address of a location in Japan in **romaji** format by using the `romaji` named argument.
+
+```ruby
+address = JapanPostcoder.to_address('2140037', romaji: true)
+puts address # => "KANAGAWA KEN KAWASAKI SHI TAMA KU SUGESEN YACHO"
+```
+
+```ruby
+address = JapanPostcoder.to_address_hash('2140037', romaji: true)
+puts address # => {:prefecture=>"KANAGAWA KEN", :city=>"KAWASAKI SHI", :ward=>"TAMA KU", :district=>"SUGESEN YACHO"}
+```
+
+# 💪 Contributing
+
+If you notice a bug or want to add a new feature, please open an issue or submit a pull request.
+Thank you and enjoy!
+
+# 📝 License
+
+This project is free to use under the terms of the MIT License.
+
+# 📝 Self-memo
+After updating the gem:
+- Update the version in `lib/japan_postcoder/version.rb`
+- Create a PR and merge it after it's been approved & tested
+- Run `gem build japan_postcoder.gemspec`
+- Run `gem push japan_postcoder-<version>.gem`
+- Run `gh release create <version>`

data/japan_postcoder.gemspec

@@ -16,11 +16,10 @@ Gem::Specification.new do |spec|
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 2.7.0'
 
-  spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/tonystrawberry/japan_postcoder'
-  spec.metadata['changelog_uri'] = 'https://github.com/tonystrawberry/japan_postcoder/CHANGELOG.md'
 
   # 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.

data/lib/japan_postcoder/address.rb

@@ -1,37 +1,39 @@
 # frozen_string_literal: true
 
-## Class for Japanese Address
-## Has attributes for postcode, prefecture, city, ward and district
-#
-class JapanPostcoder::Address
-  attr_accessor :postcode, :prefecture, :city, :ward, :district
+module JapanPostcoder
+  ## Class for Japanese Address
+  ## Has attributes for postcode, prefecture, city, ward and district
+  #
+  class Address
+    attr_accessor :postcode, :prefecture, :city, :ward, :district
 
-  # Initialize the address with postcode, prefecture, city, ward and district
-  def initialize(postcode, prefecture, city, ward, district)
-    @postcode = postcode
-    @prefecture = prefecture
-    @city = city
-    @ward = ward
-    @district = district
-  end
+    # Initialize the address with postcode, prefecture, city, ward and district
+    def initialize(postcode, prefecture, city, ward, district)
+      @postcode = postcode
+      @prefecture = prefecture
+      @city = city
+      @ward = ward
+      @district = district
+    end
 
-  # Returns the full address as a string
-  def to_s(romaji: false)
-    if romaji
-      "#{@prefecture} #{@city} #{@ward} #{@district}"
-    else
-      "#{@prefecture}#{@city}#{@ward}#{@district}"
+    # Returns the full address as a string
+    def to_s(romaji: false)
+      if romaji
+        "#{@prefecture} #{@city} #{@ward} #{@district}"
+      else
+        "#{@prefecture}#{@city}#{@ward}#{@district}"
+      end
     end
-  end
 
-  # Returns the full address as a hash
-  def to_h
-    {
-      postcode: @postcode,
-      prefecture: @prefecture,
-      city: @city,
-      ward: @ward,
-      district: @district
-    }
+    # Returns the full address as a hash
+    def to_h
+      {
+        postcode: @postcode,
+        prefecture: @prefecture,
+        city: @city,
+        ward: @ward,
+        district: @district
+      }
+    end
   end
 end

data/lib/japan_postcoder.rb

@@ -14,6 +14,8 @@ module JapanPostcoder
   # Returns the address in string format
   # Example: '神奈川県川崎市多摩区西生田'
   def self.to_address(postal_code, romaji: false)
+    postal_code = postal_code.to_s
+
     validate_postal_code!(postal_code)
 
     address = get_address(postal_code, romaji: romaji)
@@ -31,6 +33,8 @@ module JapanPostcoder
   #   district: '西生田'
   # }
   def self.to_address_hash(postal_code, romaji: false)
+    postal_code = postal_code.to_s
+
     validate_postal_code!(postal_code)
 
     address = get_address(postal_code, romaji: romaji)
@@ -38,8 +42,6 @@ module JapanPostcoder
     address.to_h
   end
 
-  private
-
   # Validates the postal code format
   # Raises InvalidPostalCodeError if the postal code is invalid
   def self.validate_postal_code!(postal_code)
@@ -51,7 +53,11 @@ module JapanPostcoder
 
   # Returns an Address object
   # Example:
-  # #<Japan::Address:0x00007f9d0a8d3d88 @postcode="2140037", @prefecture="神奈川県", @city="川崎市", @ward="多摩区", @district="西生田">
+  # #<Japan::Address:0x00007f9d0a8d3d88 @postcode="2140037",
+  #   @prefecture="神奈川県",
+  #   @city="川崎市",
+  #   @ward="多摩区",
+  #   @district="西生田">
   def self.get_address(postal_code, romaji: false)
     # Read from ./jp_postcodes.json (Shift JIS)
     # Format: {

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JapanPostcoder
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: japan_postcoder
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Tony Duong
@@ -21,12 +21,9 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
-- japan_postcoder-0.1.0.gem
-- japan_postcoder-0.1.1.gem
 - japan_postcoder.gemspec
 - lib/japan_postcoder.rb
 - lib/japan_postcoder/address.rb
@@ -39,7 +36,6 @@ metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/tonystrawberry/japan_postcoder
   source_code_uri: https://github.com/tonystrawberry/japan_postcoder
-  changelog_uri: https://github.com/tonystrawberry/japan_postcoder/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []

data/CHANGELOG.md

@@ -1,3 +0,0 @@
-## [0.1.0] - 2023-08-22
-
-- Initial release