china_regions 0.4.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4de2d9eced27245300d96f23af7e9e5499374f789c975631acbcc286b33c2fb
-  data.tar.gz: eae0d2259e6e32d3557a3f78441ff040c9b271244573f792cfe4f764de55ef72
+  metadata.gz: 5aec74f02a9856df9798317291e9fc587c07a6473f8c13639b878e8b6a10bf67
+  data.tar.gz: 4aaea0730f59300c09c9ad5685f38cfa5e061df00f0d5c81e6aa4c386c04fa6d
 SHA512:
-  metadata.gz: 48da9ff3cb7646afb56e391cde3de6d8f721c324f0a4e508b57c6fdeb64dd44445cc466767c76287fce7a898757b75e8da421f94d2858ae11c302935d8a23d96
-  data.tar.gz: 70ef8dd05114aad397f1612c06f6c7df60ba57caafcf4f7a97e9a6f7d63769fc26f11a93b7aecb87dafc3d84dece439a1679f519c21d7cdc1800667d00784d59
+  metadata.gz: 36d42b1e5e2f74b5492e3cf6d32bf79e13ab131de92e2c9f683a44a8f975a3424bd2851d58947909665684d2c3772ab18a6330371c159351fd9f67cdf454eaaa
+  data.tar.gz: aaffe9a0e03be688218b84aaa8a9005b3300f643b81d6e7cb5a19690ee8b539e7f32ee233e16e92874588f3fbe400da24c23ac97ea33b9483e9839f149c08d93

data/README.md

@@ -10,7 +10,7 @@ Chinese provinces, cities, regions [prefecture-level cities] Ruby on Rails code,
 
 If you are using ChinaRegions version 0.1.x be sure to run:
 
-    >> rails g china_regions:regions
+    rails g china_regions:regions
 
 to have the javascript file copied over into your project.
 
@@ -22,37 +22,39 @@ Add it to your Gemfile:
 
 Run the following command to install it:
 
-    >> bundle install
+    bundle install
 
 Run the generator:
 
-    >> rails g china_regions:install
+    rails g china_regions:install
 
    Then you can see the changes that happened to the console:
-   * copy `db/migrate/xxxxxxxxxxx_create_china_regions_tables.rb` to your project `db/migrate`
-   * copy datasource cities.yml 到 config 目录.  config/cities.yml
-   * copy regions.en.yml 和 regions.zh.yml 文件到 config/locales 目录
+   * Copy `db/migrate/xxxxxxxxxxx_create_china_regions_tables.rb` to `db/migrate` folder.
+   * Copy `regions.en.yml` and `regions.zh.yml` files to `config/locales` folders
 
 Create tables (provinces, cities, districts):
 
-    >> rake db:migrate
+    rake db:migrate
 
-Import data:
+Copy Models [Province`, `City`, `District] into your project:
 
-    >> rake china_regions:import
+  please run `rails g` see the generator list.
 
+    rails g china_regions:regions
 
-Copy Models [`Province`, `City`, `District`] into your app:
+Newly added models:
 
-    你可以执行 `rails g` 查看到 generator LIST.
+  - create  app/models/province.rb
+  - create  app/models/city.rb
+  - create  app/models/district.rb
 
-     >> rails g china_regions:regions
+Download and import the latest regions to your project:
 
-Newly added models:
+    rake china_regions:all
 
-    create  app/models/province.rb
-    create  app/models/city.rb
-    create  app/models/district.rb
+  * 1. Downloading regions from `Administrative-divisions-of-China` to `db/regions` folder.
+    - db/regions/pca-code.json
+  * 2. Import the regions into provinces and cities, districts
 
 ### Usage
 
@@ -102,7 +104,7 @@ Prior choice:
 
 ### Other languages
 
-[Chinese Readme](https://github.com/encoreshao/china_regions/blob/master/README.zh.md)
+[Chinese](https://github.com/encoreshao/china_regions/blob/master/README.zh.md)
 
 ### Contributing
 

data/README.zh.md

@@ -1,4 +1,4 @@
-# ChinaRegions
+# 中国地区
 
 中国省份，城市，地区［地级市］Ruby on Rails 程式代码, Ruby (> 1.9.x) And Rails (> 4.0)
 
@@ -10,7 +10,7 @@
 
 复制所需文件到你的项目中:
 
-    >> rails g china_regions:regions
+    rails g china_regions:regions
 
 ### 如何引入china_regions到你的项目
 
@@ -20,39 +20,41 @@
 
 安装:
 
-    >> bundle install
+    bundle install
 
 #### 开始构建城市数据
 
 复制所需文件到你的项目中:
 
-    >> rails g china_regions:install
+    rails g china_regions:install
 
    随后你可以看到控制台发生的变化:
-   * 复制 db/migrate/xxxxxxxxxxx_create_china_regions_tables.rb 文件到db/migrate 目录
-   * 复制 数据源 cities.yml 到 config 目录.  config/cities.yml
-   * 复制 regions.en.yml 和 regions.zh.yml 文件到 config/locales 目录
+   * 复制 `db/migrate/xxxxxxxxxxx_create_china_regions_tables.rb` 文件到 `db/migrate` 目录中
+   * 复制 `regions.en.yml` 和 `regions.zh.yml` 配置文件到 `config/locales` 目录中
 
 创建所需的表 (provinces, cities, districts):
 
-    >> rake db:migrate
+    rake db:migrate
 
-导入数据到对应表中:
+将所需的模型(Models) [`Province`, `City`, `District`] 到您的应用程式中:
 
-    >> rake china_regions:import
+  你可以执行 `rails g` 查看到 `generator` 列表.
 
+    rails g china_regions:regions
 
-将所需的模型(Models) [`Province`, `City`, `District`] 到您的应用程式中:
+查看 app/models:
 
-    你可以执行 `rails g` 查看到 generator LIST.
+  - create  app/models/province.rb
+  - create  app/models/city.rb
+  - create  app/models/district.rb
 
-     >> rails g china_regions:regions
+下载并导入最新数据到你的项目中:
 
-查看 app/models:
+    rake china_regions:all
 
-    create  app/models/province.rb
-    create  app/models/city.rb
-    create  app/models/district.rb
+  * 1. 从 `Administrative-divisions-of-China` 下载最新的地区信息到 `db/regions` 目录中.
+    - db/regions/pca-code.json
+  * 2. 将下载后的地区信息导入数据库中
 
 ### 如何在View中使用
 
@@ -102,7 +104,7 @@
 
 ### 其它语言
 
-[English Readme](https://github.com/encoreshao/china_regions/blob/master/README.md)
+[English](https://github.com/encoreshao/china_regions/blob/master/README.md)
 
 ### 贡献者
 

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'china_regions'
+
+# If you use this, don't forget to add pry to your Gemfile!
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle install

data/china_regions.gemspec

@@ -6,8 +6,8 @@ require File.expand_path('lib/china_regions/version', __dir__)
 Gem::Specification.new do |gem|
   gem.authors       = ['Encore Shao']
   gem.email         = ['encore.shao@gmail.com']
-  gem.description   = 'China regions Ruby on rails interface'
-  gem.summary       = 'Rails 4 version of dropdowns for all provinces, cities,
+  gem.description   = 'China Regions is Ruby on rails interface'
+  gem.summary       = 'Rails 4+ version of dropdowns for all provinces, cities,
                        and districts in China.'
   gem.homepage      = 'http://github.com/encoreshao'
 
@@ -18,6 +18,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = ChinaRegions::VERSION
 
+  gem.add_dependency 'down'
   gem.add_dependency 'jquery-rails'
+  gem.add_dependency 'ruby-pinyin'
+  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rubocop'
 end

data/config/locales/en.yml

@@ -18,7 +18,6 @@ en:
         province: Province
         name_en: English Name
         name_abbr: Short Name
-        zip_code: Zip
         level: Level
       district:
         name: Name

data/config/locales/zh.yml

@@ -18,7 +18,6 @@ zh:
         province: 省份
         name_en: 拼音
         name_abbr: 简称
-        zip_code: 邮编
         level: 等级
       district:
         name: 名称

data/config/routes.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
-  match '/china_regions/fetch_options' => ChinaRegions::FetchOptionsController.action(:index), via: [:get]
+  match '/china_regions/fetch_options' =>
+    ChinaRegions::FetchOptionsController.action(:index), via: [:get]
 end

data/lib/china_regions.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
 require 'china_regions/version'
-require 'china_regions/engine' if defined? Rails
-require 'china_regions/helpers/form_helper'
 
-module ChinaRegions; end
+if defined? Rails
+  require 'china_regions/engine'
+  require 'china_regions/helpers/form_helper'
+end
+
+module ChinaRegions
+end

data/lib/china_regions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChinaRegions
-  VERSION = '0.4.5'
+  VERSION = '1.0.0'
 end

data/lib/generators/china_regions/install_generator.rb

@@ -11,17 +11,11 @@ module ChinaRegions
       migration_template 'migration.rb', 'db/migrate/create_china_regions_tables.rb'
     end
 
-    def copy_cities
-      copy_file('cities.yml', 'config/cities.yml') unless File.exist?('config/cities.yml')
-    end
-
     def copy_locales
-      copy_file '../../../../config/locales/en.yml', 'config/locales/regions.en.yml' unless File.exist?('config/locales/regions.en.yml')
-      copy_file '../../../../config/locales/zh.yml', 'config/locales/regions.zh.yml' unless File.exist?('config/locales/regions.zh.yml')
-    end
-
-    def copy_rake_tasks
-      copy_file '../../../../lib/custom_tasks/china_regions.rake', 'lib/tasks/china_regions.rake' unless File.exist?('lib/tasks/china_regions.rake')
+      %w[en zh].each do |locale|
+        config_file = "config/locales/regions.#{locale}.yml"
+        copy_file "../../../../config/locales/#{locale}.yml", config_file unless File.exist?(config_file)
+      end
     end
 
     def self.next_migration_number(dirname)

data/lib/generators/china_regions/templates/migration.rb

@@ -10,6 +10,7 @@ class CreateChinaRegionsTables < ActiveRecord::Migration
   def setup_provinces
     create_table :provinces do |t|
       t.string :name
+      t.integer :code
       t.string :name_en
       t.string :name_abbr
 
@@ -22,9 +23,9 @@ class CreateChinaRegionsTables < ActiveRecord::Migration
   def setup_citites
     create_table :cities do |t|
       t.string :name
+      t.integer :code
       t.integer :province_id
       t.integer :level
-      t.string :zip_code
       t.string :name_en
       t.string :name_abbr
 
@@ -32,17 +33,21 @@ class CreateChinaRegionsTables < ActiveRecord::Migration
     end
 
     add_index :cities, :name
+    add_index :cities, :province_id
   end
 
   def setup_districts
     create_table :districts do |t|
       t.string :name
       t.integer :city_id
+      t.integer :code
       t.string :name_en
       t.string :name_abbr
 
       t.timestamps
     end
+
     add_index :districts, :name
+    add_index :districts, :city_id
   end
 end

data/lib/tasks/china_regions.rake

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+namespace :china_regions do
+  desc 'Download and import regions into tables'
+  task all: :environment do
+    Rake::Task['china_regions:download'].invoke
+    Rake::Task['china_regions:import'].invoke
+  end
+
+  desc 'Download regions from `Administrative-divisions-of-China`'
+  task download: :environment do
+    ChinaRegions::Download.all
+  end
+
+  desc 'Import provinces and cities and areas to database'
+  task import: :environment do
+    ChinaRegions::Import.all
+  end
+end
+
+module ChinaRegions
+  module Download
+    require "down"
+
+    module_function
+
+    def all(filename = 'pca-code.json')
+      detect_folder
+
+      downloading(filename)
+    end
+
+    def downloading(filename)
+      down(filename)
+
+      move_to(filename)
+    end
+
+    def down(filename)
+      Down.download(
+        github_url(filename),
+        destination: File.join(Rails.root, 'db', 'regions')
+      )
+    end
+
+    def detect_folder
+      FileUtils.mkdir_p File.join(Rails.root, 'db', 'regions')
+    end
+
+    def github_url(filename)
+      [
+        'https://raw.githubusercontent.com',
+        'encoreshao',
+        'Administrative-divisions-of-China',
+        'master',
+        'dist',
+        filename
+      ].join('/')
+    end
+
+    def move_to(filename)
+      src_file = Dir.glob(File.join(Rails.root, 'db', 'regions', "*.json")).max_by { |f| File.mtime(f) }
+
+      FileUtils.mv src_file, File.join(Rails.root, 'db', 'regions', filename)
+    end
+  end
+
+  module Import
+    require 'json'
+    require 'ruby-pinyin'
+
+    module_function
+
+    def all(filename = 'pca-code.json')
+      data_hash(filename).each { |province_hash| creating_province(province_hash) }
+
+      puts "Imported done!"
+      puts ''
+      puts "  Total of #{Province.count} provinces."
+      puts "  Total of #{City.count} cities."
+      puts "  Total of #{District.count} districts."
+    end
+
+    def creating_province(prov_hash)
+      province = Province.find_or_create_by(name: prov_hash['name'])
+      province.update(build_params(prov_hash['name'], prov_hash['code']))
+
+      prov_hash["children"].each { |city_hash| creating_city(province, city_hash) }
+    end
+
+    def creating_city(province, city_hash)
+      city = City.find_or_create_by(province: province, name: city_hash['name'])
+      city_params = build_params(city_hash['name'], city_hash['code'])
+                    .merge(city_level(city_hash['name']))
+      city.update(city_params)
+
+      city_hash['children'].each { |district| creating_district(city, district) }
+    end
+
+    def city_level(city_name)
+      {
+        level: municipalities.include?(city_name) ? 1 : 4
+      }
+    end
+
+    def creating_district(city, district_hash)
+      district = District.find_or_create_by(city: city, name: district_hash['name'])
+      district.update(build_params(district_hash['name'], district_hash['code']))
+    end
+
+    def build_params(full_name, code)
+      new_name      = convert_pinyin(to_decorate(full_name))
+      name_en       = new_name.join
+      name_abbr     = new_name.map { |e| e[0] }.join
+
+      {
+        code: code,
+        name_en: name_en,
+        name_abbr: name_abbr
+      }
+    end
+
+    def convert_pinyin(text)
+      PinYin.of_string(text)
+    end
+
+    def to_decorate(text)
+      text.gsub(/市|自治州|地区|特别行政区|区|县|自治县/, '')
+    end
+
+    def municipalities
+      %w[北京市 天津市 重庆市 上海市]
+    end
+
+    def data_hash(filename)
+      @data_hash ||= JSON.parse File.read(latest_file_path(filename))
+    end
+
+    def latest_file_path(filename)
+      File.join(Rails.root, 'db', 'regions', filename)
+    end
+  end
+end