china_regions 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 355fcf16235b294a0555cd4e759320ee12486509cef20405672bdaaedbf958bd
-  data.tar.gz: 4fdcee628fb6af5057cb20771a05b5bd2f4ab13b100715473d3d567d917f4504
+  metadata.gz: a4de2d9eced27245300d96f23af7e9e5499374f789c975631acbcc286b33c2fb
+  data.tar.gz: eae0d2259e6e32d3557a3f78441ff040c9b271244573f792cfe4f764de55ef72
 SHA512:
-  metadata.gz: a433388666d30dcf2177653ade0bd6523e5a50151d2f54b3f06d6d553f4a21df8d9ec63eb066e7bbc64694d772456868f6d5fae937d27cc805130b006f19c37f
-  data.tar.gz: a26988d21b27a1898b6f17ccefd2cadbb5af352cc00205294954f02afa3f01b741f76e9cd10d7fe9dd16e3d7f033fd9e964eeeb1c030c063628eb2ca5d56f267
+  metadata.gz: 48da9ff3cb7646afb56e391cde3de6d8f721c324f0a4e508b57c6fdeb64dd44445cc466767c76287fce7a898757b75e8da421f94d2858ae11c302935d8a23d96
+  data.tar.gz: 70ef8dd05114aad397f1612c06f6c7df60ba57caafcf4f7a97e9a6f7d63769fc26f11a93b7aecb87dafc3d84dece439a1679f519c21d7cdc1800667d00784d59

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: required
+dist: trusty
+rvm:
+  - 1.9.3
+  - 2.3.1
+  - 2.4.1
+  - 2.5.1
+  - 2.6.3
+
+before_install:
+  - gem install bundler
+
+after_success:
+  - coveralls --verbose

data/LICENSE

@@ -1,5 +1,22 @@
-Copyright (c) 2013 Encore
+Copyright (c) 2015 Encore Shao
 
 MIT License
 
-ChinaRegions is released under the MIT license.
+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

@@ -1,8 +1,12 @@
 # ChinaRegions
 
-中国省份，城市，地区［地级市］Ruby on Rails 程式代码, Ruby (> 1.9.x) And Rails (> 4.0)
+Chinese provinces, cities, regions [prefecture-level cities] Ruby on Rails code, Ruby (> 1.9.x) And Rails (> 4.0)
 
-## 如何更新数据文件
+[![Gem Version](https://badge.fury.io/rb/crunchbase-ruby-library.svg)](https://badge.fury.io/rb/crunchbase-ruby-library)
+[![Build Status](https://travis-ci.org/encoreshao/crunchbase-ruby-library.svg?branch=master)](https://travis-ci.org/encoreshao/crunchbase-ruby-library)
+[![Coverage Status](https://coveralls.io/repos/github/encoreshao/crunchbase-ruby-library/badge.svg)](https://coveralls.io/github/encoreshao/crunchbase-ruby-library)
+
+### How to update data
 
 If you are using ChinaRegions version 0.1.x be sure to run:
 
@@ -10,55 +14,49 @@ If you are using ChinaRegions version 0.1.x be sure to run:
 
 to have the javascript file copied over into your project.
 
-## 如何引入china_regions到你的项目
+### Installation
 
-添加以下代码到你的 Gemfile:
+Add it to your Gemfile:
 
     gem 'china_regions'
 
-OR
-
-    gem 'china_regions',  github: 'encoreshao/china_regions'
-
-安装:
+Run the following command to install it:
 
     >> bundle install
 
-### 开始构建城市数据
-
-复制所需文件到你的项目中:
+Run the generator:
 
     >> 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 目录
+   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 目录
 
-创建所需的表 (provinces, cities, districts):
+Create tables (provinces, cities, districts):
 
     >> rake db:migrate
 
-导入数据到对应表中:
+Import data:
 
     >> rake china_regions:import
 
 
-将所需的模型(Models) [`Province`, `City`, `District`] 到您的应用程式中:
+Copy Models [`Province`, `City`, `District`] into your app:
 
     你可以执行 `rails g` 查看到 generator LIST.
 
      >> rails g china_regions:regions
 
-查看 app/models:
+Newly added models:
 
     create  app/models/province.rb
     create  app/models/city.rb
     create  app/models/district.rb
 
-## 如何在View中使用
+### Usage
 
-范例:
+Example:
 
     = form_for @article do |f|
 
@@ -77,7 +75,7 @@ OR
 
       = f.submit class: 'btn'
 
-添加前缀名:
+Add prefix name:
 
     = form_for @article do |f|
 
@@ -85,7 +83,7 @@ OR
       = f.region_select [:province, :city, :district], :prefix => "work"
 
 
-预选则省份:
+Pre-selected province:
 
     = form_for @article do |f|
 
@@ -95,20 +93,25 @@ OR
 
       = f.region_select [:province, :city, :district], province: "重庆市"
 
-优先选择:
+Prior choice:
 
     = form_for @article do |f|
 
       = f.region_select [:province, :city, :district], priority: { province: ["重庆市"], district: %w(巴南区 北碚区 渝北区) }
 
-## Contributing
+
+### Other languages
+
+[Chinese Readme](https://github.com/encoreshao/china_regions/blob/master/README.zh.md)
+
+### Contributing
 
 We have a list of valued contributors. Check them all at:
 
 https://github.com/encoreshao/china_regions/graphs/contributors
 
 
-## License
+### License
 
-ChinaRegions is released under the MIT license.
+Copyright © 2018-07 Encore Shao. See LICENSE for details.
 

data/README.zh.md

@@ -0,0 +1,117 @@
+# ChinaRegions
+
+中国省份，城市，地区［地级市］Ruby on Rails 程式代码, Ruby (> 1.9.x) And Rails (> 4.0)
+
+[![Gem Version](https://badge.fury.io/rb/china-regions.svg)](https://badge.fury.io/rb/china-regions)
+[![Build Status](https://travis-ci.org/encoreshao/china-regions.svg?branch=master)](https://travis-ci.org/encoreshao/china-regions)
+[![Coverage Status](https://coveralls.io/repos/github/encoreshao/china-regions/badge.svg)](https://coveralls.io/github/encoreshao/china-regions)
+
+### 如何更新数据文件
+
+复制所需文件到你的项目中:
+
+    >> rails g china_regions:regions
+
+### 如何引入china_regions到你的项目
+
+添加以下代码到你的 Gemfile:
+
+    gem 'china_regions'
+
+安装:
+
+    >> bundle 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 目录
+
+创建所需的表 (provinces, cities, districts):
+
+    >> rake db:migrate
+
+导入数据到对应表中:
+
+    >> rake china_regions:import
+
+
+将所需的模型(Models) [`Province`, `City`, `District`] 到您的应用程式中:
+
+    你可以执行 `rails g` 查看到 generator LIST.
+
+     >> rails g china_regions:regions
+
+查看 app/models:
+
+    create  app/models/province.rb
+    create  app/models/city.rb
+    create  app/models/district.rb
+
+### 如何在View中使用
+
+范例:
+
+    = form_for @article do |f|
+
+      = f.region_select [:province, :city, :district]
+
+      # form_tag
+      = region_select :article, :province_id
+      = region_select :article, :city_id
+      = region_select :article, :district_id
+
+      OR
+
+      = region_select :article, :province
+      = region_select :article, :city
+      = region_select :article, :district
+
+      = f.submit class: 'btn'
+
+添加前缀名:
+
+    = form_for @article do |f|
+
+      = f.region_select [:province, :city, :district], :prefix => "home"
+      = f.region_select [:province, :city, :district], :prefix => "work"
+
+
+预选则省份:
+
+    = form_for @article do |f|
+
+      = f.region_select [:province, :city, :district], province: "chongqing"
+
+      OR
+
+      = f.region_select [:province, :city, :district], province: "重庆市"
+
+优先选择:
+
+    = form_for @article do |f|
+
+      = f.region_select [:province, :city, :district], priority: { province: ["重庆市"], district: %w(巴南区 北碚区 渝北区) }
+
+
+### 其它语言
+
+[English Readme](https://github.com/encoreshao/china_regions/blob/master/README.md)
+
+### 贡献者
+
+你可以在这里查看到所有的代码贡献者:
+
+https://github.com/encoreshao/china_regions/graphs/contributors
+
+
+### 许可
+
+Copyright © 2018-07 Encore Shao. See LICENSE for details.
+

data/app/assets/javascripts/region_select.js

@@ -35,7 +35,8 @@ $(function() {
     $.getJSON('/china_regions/fetch_options', {
       klass: changed_object.data('region-target-klass'),
       parent_klass: changed_object.data('region-klass'),
-      parent_id: changed_object.val() }, function(data) {
+      parent_id: changed_object.val()
+    }, function(data) {
 
       $('option[value!=""]', target).remove();
       $.each(data, function(index, value) {

data/app/models/city.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-class City < ActiveRecord::Base
+class City < ApplicationRecord
   belongs_to :province
   has_many :districts, dependent: :destroy
 
-  scope :with_province, ->(province) { where(province_id: province) }
+  scope :for_province, ->(province_id) { where(province_id: province_id) }
 
   def short_name
     @short_name ||= name.gsub(/市|自治州|地区|特别行政区/, '')
   end
 
   def siblings
-    @siblings ||= where(nil).with_province(province_id)
+    @siblings ||= where(nil).for_province(province_id)
   end
 end

data/app/models/district.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-class District < ActiveRecord::Base
+class District < ApplicationRecord
   belongs_to :city
 
-  scope :with_city, ->(city) { where(city_id: city) }
+  scope :for_city, ->(city_id) { where(city_id: city_id) }
 
   def province
     city.province
@@ -14,6 +14,6 @@ class District < ActiveRecord::Base
   end
 
   def siblings
-    @siblings ||= where(nil).with_city(city_id)
+    @siblings ||= where(nil).for_city(city_id)
   end
 end

data/app/models/province.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Province < ActiveRecord::Base
+class Province < ApplicationRecord
   has_many :cities, dependent: :destroy
   has_many :districts, through: :cities
 end

data/config/locales/en.yml

@@ -25,4 +25,4 @@ en:
         city_id: City
         city: City
         name_en: English Name
-        name_abbr: Short Name
+        name_abbr: Short Name

data/lib/china_regions/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: china_regions
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Encore Shao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-03 00:00:00.000000000 Z
+date: 2019-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
@@ -47,9 +47,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
+- README.zh.md
 - Rakefile
 - app/assets/javascripts/region_select.js
 - app/controllers/china_regions/fetch_options_controller.rb