china_region_fu 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e28ca0436e1c02e7842fda2168254af0c1a095e
-  data.tar.gz: a1b649576d71c22856263875df33c28c9e190df8
+  metadata.gz: 65a269673a48e7be55e4115d225c7b9b9b83206e
+  data.tar.gz: dbfb89b52ffed28f37f5fb6a234fc5f36e437f70
 SHA512:
-  metadata.gz: ed31c16f389c36bbda4ecf00b40e9629f0b9962773c1849beba67677b48f94f16bfc8f7d16a3e9ff215354cc45c6cc75f7f968ad23dde0639f4db8ad105f0ea5
-  data.tar.gz: 77c751addd30b359f6bea919f6cd278d6f80d888e8e472ca9a96a5d4fbc2eec655ef6ab8096d6fe24a8f2b7190ff7c674c9fa08345b78d40d4d7474f5d442f66
+  metadata.gz: 2a99edd958c4560bb477bd561d2aa830b339ea62b3cb7f761837ef95116ef7e2dd51d06b34c2b840709ccc3dfcb6b82f588531d3c3dc6ace88e1f2781743d49b
+  data.tar.gz: dbfcea798f01da81c46b5130390dbf7be3f70f9e8c9ce339ce5740dc7f571076b3aa1c10b8c59091e753f6f3e78645ea802cb7d9d8396860aee4c641df1673c6

data/.gitignore

@@ -1,5 +1,12 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-doc
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.pryrc
+.versions.conf

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
---color
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,101 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+Metrics/LineLength:
+  Enabled: false
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+# Align `when` with `case`.
+Style/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Style/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Style/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Style/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Style/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: rails
+
+# Two spaces, no tabs (for indentation).
+Style/IndentationWidth:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Style/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Style/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Style/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Style/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  AlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/.travis.yml

@@ -1,4 +1,6 @@
+sudo: false
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.2.2
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hao.xu@vpon.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,5 +1,11 @@
-# source 'https://rubygems.org'
-source 'http://ruby.taobao.org'
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in lean.gemspec
-gemspec
+# Specify your gem's dependencies in china_region_fu.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry-byebug'
+  gem 'rspec', '~> 3.5'
+  gem 'actionview', '>= 4.0'
+  gem 'codacy-coverage', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Xuhao
+
+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.en.md

@@ -0,0 +1,212 @@
+# [中文说明](https://github.com/Xuhao/china_region_fu/blob/master/README.zh-cn.md)
+
+# ChinaRegionFu
+
+[![Build Status](https://travis-ci.org/Xuhao/china_region_fu.svg?branch=master)](https://travis-ci.org/Xuhao/china_region_fu)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/85643743367e47d6853b94431f4f503f)](https://www.codacy.com/app/xuhao/china_region_fu?utm_source=github.com&utm_medium=referral&utm_content=Xuhao/china_region_fu&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/85643743367e47d6853b94431f4f503f)](https://www.codacy.com/app/xuhao/china_region_fu?utm_source=github.com&utm_medium=referral&utm_content=Xuhao/china_region_fu&utm_campaign=Badge_Coverage)
+[![Gem Version](https://badge.fury.io/rb/china_region_fu.svg)](https://badge.fury.io/rb/china_region_fu)
+
+ChinaRegionFu is a rails engine(means only suit for rails) that provide region data of china and handy view helpers. You will got complete China region data after use this gem.
+
+![Screenshot](https://cloud.githubusercontent.com/assets/324973/19191241/2c5726a8-8cd4-11e6-960d-6edd1fa69427.gif "Screenshot")
+
+## Requirements
+
+  * CRuby 2.2 or greater
+  * Rails 4.0 or greater
+  * jQuery 1.8 or greater, ignore if don't need reactive effect
+
+## Installation
+
+Put 'gem china_region_fu' to your Gemfile:
+
+    gem 'china_region_fu'
+
+Run bundler command to install the gem:
+
+    bundle install
+
+After you install the gem, you need run below tasks one by one:
+
+  1. Copy migration file to your app.
+
+      <pre>rake china_region_fu:install:migrations</pre>
+
+  2. Run db:migrate to create region tables.
+
+      <pre>rake db:migrate</pre>
+
+  3. Download the latest regions.yml form [github](https://raw.github.com/Xuhao/china_region_data/master/regions.yml).
+
+      <pre>rake china_region_fu:download</pre>
+
+  4. Import regions to database.
+
+      <pre>rake china_region_fu:import</pre>
+
+You also can use below task to do the same things as four tasks above:
+
+    rake region:install
+
+Region data is from [ChinaRegionData](https://github.com/Xuhao/china_region_data), check it out to see what kind of data you have now.
+
+If you want to customize the region modules you can run the generator:
+
+    rails g china_region_fu:models
+
+   This will create:
+
+    create  app/models/province.rb
+    create  app/models/city.rb
+    create  app/models/district.rb
+
+   So you can do what you want to do in this files.
+
+## Usage
+
+### Model
+
+```ruby
+a = Province.last
+a.name                   # => "台湾省"
+a.cities.pluck(:name)    # => ["嘉义市", "台南市", "新竹市", "台中市", "基隆市", "台北市"]
+
+Province.first.districts.pluck(:name) # => ["延庆县", "密云县", "平谷区", ...]
+
+c = City.last
+c.name                   # => "酒泉市"
+c.short_name             # => "酒泉"
+c.zip_code               # => "735000"
+c.pinyin                 # => "jiuquan"
+c.pinyin_abbr            # => "jq"
+c.districts.pluck(:name) # => ["敦煌市", "玉门市", "阿克塞哈萨克族自治县", "肃北蒙古族自治县", "安西县", ...]
+c.brothers.pluck(:name)  # => ["甘南藏族自治州", "临夏回族自治州", "陇南市", ...]
+
+d = District.last
+d.name                   # => "吉木乃县"
+d.short_name             # => "吉木乃"
+d.pinyin                 # => "jimunai"
+d.pinyin_abbr            # => "jmn"
+d.city.name              # => "阿勒泰地区"
+d.province.name          # => "新疆维吾尔自治区"
+```
+
+### View
+
+#### Form helpers
+
+```erb
+<%= form_for(@address) do |f| %>
+  <div class="field">
+    <%= f.label :province, '选择地区：' %><br />
+
+    # FormBuilder
+    <%= f.region_select :city %>
+    <%= f.region_select [:province_id, :city_id, :district_id], province_prompt: 'Do', city_prompt: 'it', district_prompt: 'like this' %>
+    <%= f.region_select [:province_id, :city_id], include_blank: true %>
+    <%= f.region_select [:city_id, :district_id] %>
+
+    # FormHelper
+    <%= region_select :address, :province_id %>
+    <%= region_select :address, [:province_id, :city_id, :district_id] %>
+    ...
+
+    # FormTagHelper
+    <%= region_select_tag :province_id, class: 'province-select', include_blank: true %>
+    <%= region_select_tag [:province_id, :city_id, :district_id], province_prompt: 'Do', city_prompt: 'it', district_prompt: 'like this', class: 'region-select' %>
+    ...
+  </div>
+<% end %>
+```
+
+#### SimpleForm
+
+```erb
+<%= simple_form_for(@address) do |f| %>
+  <%= f.input :province_id, as: :region, collection: Province.select('id, name'), sub_region: :city_id %>
+  <%= f.input :city_id, as: :region, collection: City.where(province_id: f.object.province_id).select('id, name'), sub_region: :district_id %>
+  <%= f.input :district_id, as: :region, collection: District.where(city_id: f.object.city_id).select('id, name') %>
+  <%= china_region_fu_js %>
+<% end %>
+```
+
+#### Formtastic
+
+```erb
+<%= semantic_form_for(@address) do |f| %>
+  <%= f.input :province_id, as: :region, collection: Province.select('id, name'), sub_region: :city_id) %>
+  <%= f.input :city_id, as: :region, collection: City.where(province_id: f.object.province_id).select('id, name'), sub_region: :district_id %>
+  <%= f.input :district_id, as: :region, collection: District.where(city_id: f.object.city_id).select('id, name') %>
+  <%= china_region_fu_js %>
+<% end %>
+```
+
+#### Reactive effect by Ajax
+
+Once select one province, we want fetch cities of the selected province and fill the city select box automatically. to implement this, you need add below helper in your form:
+
+```erb
+<%= china_region_fu_js %>
+# or
+<%= content_for :china_region_fu_js %>
+```
+
+it will render:
+
+```html
+<script type="text/javascript">
+  //<![CDATA[
+    window.chinaRegionFu = window.chinaRegionFu || {};
+    $(function(){
+      $('body').off('change', '.china-region-select').on('change', '.china-region-select', function(event) {
+        var $self, $targetDom;
+        $self = $(event.currentTarget);
+        $subRegionDom = $('[data-region-name="' + $self.data('sub-region') + '"]');
+        if ($subRegionDom.size() > 0) {
+          $.getJSON('/china_region_fu/fetch_options', {
+              columns: window.chinaRegionFu.fetchColumns || 'id,name',
+              sub_name: $self.data('sub-region'),
+              parent_name: $self.data('region-name'),
+              parent_id: $self.val()
+            }, function(json) {
+              if (window.chinaRegionFu.ajaxDone) {
+                window.chinaRegionFu.ajaxDone(json);
+              } else {
+                var options = [];
+                $self.parent().nextAll().find('.china-region-select > option[value!=""]').remove()
+                $.each(json.data, function(_, value) {
+                  options.push("<option value='" + value.id + "'>" + value.name + "</option>");
+                });
+                $subRegionDom.append(options.join(''));
+              }
+          }).fail(function(xhr, textStatus, error) {
+            window.chinaRegionFu.ajaxFail && window.chinaRegionFu.ajaxFail(xhr, textStatus, error);
+          }).always(function(event, xhr, settings) {
+            window.chinaRegionFu.ajaxAlways && window.chinaRegionFu.ajaxAlways(event, xhr, settings);
+          });
+        }
+      });
+    });
+  //]]>
+</script>
+```
+hooks:
+
+  * `window.chinaRegionFu.fetchColumns`: Set columns of each returned region, default: `id,name`
+  * `window.chinaRegionFu.ajaxDone(json)`: Customize ajax `success` event，default: reload sub region options
+  * `window.chinaRegionFu.ajaxFail(xhr, textStatus, error)`: Customize ajax `fail` event
+  * `window.chinaRegionFu.ajaxAlways(event, xhr, settings)`: Customize ajax `always` event
+
+## Online example
+
+[yihub.com](http://www.yihub.com/ "医院").
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xuhao/china_region_fu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+