geo_master_jp 0.1.25 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e37df4a089fc32f61b506648b3335984f8c1dce556e78d358e7e1c9a79ddb9aa
-  data.tar.gz: 19fb76758bc175698394db53048286a7a1b9eaa453072a4115892d50cf5af75b
+  metadata.gz: 222479be95afab1d7dfa5087907f5a99dcf229a4c35090c0b2dc8ba0fad79ac6
+  data.tar.gz: 9e7a0dfd2ace7c18dc608d2255cf2a6e50b9198a0f1d981865d650ac479674a5
 SHA512:
-  metadata.gz: f2d121d737c1f492d54175baff56f2f07218f8f6fe8ba04ddd83215809bac5cbc7416e9580f9b4452a3527dc87d70f3ec23b9dffb7d6fd73aa1395e967fc4ac2
-  data.tar.gz: 254fd7458157d3b9ec67253f446d0c58d0edb459169f1ed35e3214c434206e8097cfe97438dc4591d62ad768a44c050f354ec1b71a9a959b0ebacc3d0bf2d2f0
+  metadata.gz: 3a77f5add500810b1e8c5af4645e72f5a420b1a9f2cf2e92682ebbd7636f327b87833c01ae4174e62a9a9efc48d1c7670426bc0bc71ec7e54b88c128f3dad423
+  data.tar.gz: 67e6b73dad5918e49cc8f92889471cbd3521ff7a60e3fa4980fbc9c5a97b7b89d1e4b2911e68b8e7efcda75a3e0081aa6edbd5c04aea6a5c87bfc501a424f813

data/README.md

@@ -45,6 +45,34 @@ rails g geo_master_jp:install_area_data
 rails g geo_master_jp:install_railway_data
 ```
 
+## Usage
+
+### Use Area Data Examples
+
+```ruby
+prefectures = GeoMasterJp::Prefecture.all
+
+tokyo = prefectures.find_by(code: '13')
+cities = tokyo.cities
+
+shinjuku = cities.find_by(code: '13104')
+towns = shinjuku.towns
+```
+
+### Use Area Data API
+
+Add the following line to your `config/routes.rb`:
+
+```ruby
+GeoMasterJp.set_routes(self)
+```
+
+Then you can use the following API:
+
+- `/geo_master_jp/api/prefectures`
+- `/geo_master_jp/api/cities?prefecture_code=13`
+- `/geo_master_jp/api/towns?city_code=13104`
+
 ## Contributing
 Contribution directions go here.
 

data/app/controllers/geo_master_jp/application_controller.rb

@@ -0,0 +1,4 @@
+module GeoMasterJp
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/geo_master_jp/area_api_controller.rb

@@ -0,0 +1,48 @@
+module GeoMasterJp
+  class AreaApiController < ApplicationController
+    def prefectures
+      prefectures = GeoMasterJp::Prefecture.all
+
+      render json: {
+        prefectures: prefectures.map{|prefecture|
+          prefecture.as_json(only: [:code, :name, :name_kana, :name_alphabet, :short_name])
+        },
+        initials: prefectures.group_by(&:head_kana).sort_by(&:first).to_h
+      }
+    end
+
+    def cities
+      if params[:prefecture_code].blank?
+        return render json: {
+          message: 'prefecture_code is required.'
+        }, status: 400
+      end
+
+      cities = GeoMasterJp::Prefecture.find_by(code: params[:prefecture_code]).cities
+
+      render json: {
+        cities: cities.map{|city|
+          city.as_json(only: [:code, :name, :name_kana, :name_alphabet, :short_name])
+        },
+        initials: cities.group_by(&:head_kana).sort_by(&:first).to_h
+      }
+    end
+
+    def towns
+      if params[:city_code].blank?
+        return render json: {
+          message: 'city_code is required.'
+        }, status: 400
+      end
+
+      towns = GeoMasterJp::City.find_by(code: params[:city_code]).towns
+
+      render json: {
+        towns: towns.map{|town|
+          town.as_json(only: [:zip_code, :code, :name, :name_kana, :name_alphabet, :short_name])
+        },
+        initials: towns.group_by(&:head_kana).sort_by(&:first).to_h
+      }
+    end
+  end
+end

data/{lib/geo_master_jp/models → app/models/geo_master_jp}/city.rb

@@ -17,5 +17,9 @@ module GeoMasterJp
 
       super
     end
+
+    def town_select_options
+      self.towns.map{|town| [town.name, town.code] }
+    end
   end
 end

data/{lib/geo_master_jp/models → app/models/geo_master_jp}/prefecture.rb

@@ -17,5 +17,13 @@ module GeoMasterJp
 
       super
     end
+
+    def city_select_options
+      self.cities.map{|city| [city.name, city.code] }
+    end
+
+    def self.select_options
+      self.all.map{|prefecture| [prefecture.name, prefecture.code] }
+    end
   end
 end

data/config/routes.rb

@@ -0,0 +1,7 @@
+GeoMasterJp::Engine.routes.draw do
+  scope :api, as: 'api' do
+    get 'prefectures', to: 'area_api#prefectures'
+    get 'cities', to: 'area_api#cities'
+    get 'towns', to: 'area_api#towns'
+  end
+end

data/lib/geo_master_jp/config.rb

@@ -1,4 +1,12 @@
 module GeoMasterJp
+  def self.config
+    @config ||= GeoMasterJp::Config.new
+  end
+
+  def self.configure(&block)
+    yield(config) if block_given?
+  end
+
   class Config
     # Variables detail is writen in lib/generators/templates/geo_master_jp.rb.
     attr_accessor :alternative_class_names, :use_models

data/lib/geo_master_jp/engine.rb

@@ -1,27 +1,12 @@
-require 'geo_master_jp/config'
 module GeoMasterJp
-  def self.config
-    @config ||= GeoMasterJp::Config.new
+  # GeoMasterJp用のroutingを設定する。
+  class Engine < ::Rails::Engine
+    isolate_namespace GeoMasterJp
   end
-
-  def self.configure(&block)
-    yield(config) if block_given?
+  def self.set_routes(rails_router)
+    rails_router.mount Engine, at: '/geo_master_jp'
   end
 end
 
-if GeoMasterJp.config.use_models.include?(:area)
-  require 'geo_master_jp/models/prefecture'
-  require 'geo_master_jp/models/city'
-  require 'geo_master_jp/models/town'
-end
-if GeoMasterJp.config.use_models.include?(:railway)
-  require 'geo_master_jp/models/railway_company'
-  require 'geo_master_jp/models/line'
-  require 'geo_master_jp/models/station'
-  require 'geo_master_jp/models/station_connection'
-end
-require 'geo_master_jp/models/version'
-
 require 'active_record'
 require 'activerecord-import'
-

data/lib/geo_master_jp/version.rb

@@ -1,3 +1,3 @@
 module GeoMasterJp
-  VERSION = '0.1.25'
+  VERSION = '0.1.26'
 end

data/lib/geo_master_jp.rb

@@ -1,4 +1,5 @@
 require "geo_master_jp/railtie"
+require "geo_master_jp/config"
 require "geo_master_jp/engine"
 require "geo_master_jp/association_helper"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geo_master_jp
 version: !ruby/object:Gem::Version
-  version: 0.1.25
+  version: 0.1.26
 platform: ruby
 authors:
 - ykogure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -90,6 +90,17 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/geo_master_jp/application_controller.rb
+- app/controllers/geo_master_jp/area_api_controller.rb
+- app/models/geo_master_jp/city.rb
+- app/models/geo_master_jp/line.rb
+- app/models/geo_master_jp/prefecture.rb
+- app/models/geo_master_jp/railway_company.rb
+- app/models/geo_master_jp/station.rb
+- app/models/geo_master_jp/station_connection.rb
+- app/models/geo_master_jp/town.rb
+- app/models/geo_master_jp/version.rb
+- config/routes.rb
 - lib/generators/geo_master_jp/data/company20180424.csv.zip
 - lib/generators/geo_master_jp/data/join20190405.csv.zip
 - lib/generators/geo_master_jp/data/line20190405free.csv.zip
@@ -112,14 +123,6 @@ files:
 - lib/geo_master_jp/association_helper.rb
 - lib/geo_master_jp/config.rb
 - lib/geo_master_jp/engine.rb
-- lib/geo_master_jp/models/city.rb
-- lib/geo_master_jp/models/line.rb
-- lib/geo_master_jp/models/prefecture.rb
-- lib/geo_master_jp/models/railway_company.rb
-- lib/geo_master_jp/models/station.rb
-- lib/geo_master_jp/models/station_connection.rb
-- lib/geo_master_jp/models/town.rb
-- lib/geo_master_jp/models/version.rb
 - lib/geo_master_jp/railtie.rb
 - lib/geo_master_jp/version.rb
 - lib/tasks/geo_master_jp_tasks.rake