china_region_fu 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb7a4ba9afffa06e9951668c3b118fff38af7384
+  data.tar.gz: 6d1d2d68a4f9cfefebcf6b9a80f0554d6fec9b8a
+SHA512:
+  metadata.gz: 931fa75b8e33bf6692cd59a6cb1a074341bef82be9052a71a1570f38208153bea10a0f20ff788f9a7132db51b18ef49bd4fc9e066542cd34faca29908c46ef45
+  data.tar.gz: 9cc9a236a8cf053e9aea0b55549c616fa673ffb56dd3d991e6e26bf0c2db58756ca02039a9522f0353f416f83f1ddc4ba34ade89506eec3e658f00a2f67de777

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -1,4 +1,5 @@
-source 'https://rubygems.org'
+# source 'https://rubygems.org'
+source 'http://ruby.taobao.org'
 
 # Specify your gem's dependencies in lean.gemspec
 gemspec

data/README.md

@@ -1,7 +1,9 @@
 # ChinaRegionFu
 
-ChinaRegionFu provide the region data of china.You will got complete chian region data after use this gem.
-       
+[![Gem Version](https://badge.fury.io/rb/china_region_fu.png)](http://badge.fury.io/rb/china_region_fu)
+[![Build Status](https://travis-ci.org/Xuhao/china_region_fu.png?branch=master)](https://travis-ci.org/Xuhao/china_region_fu)
+
+ChinaRegionFu provide the region data of china.You will got complete China region data after use this gem.
 
 ## Installation
 
@@ -16,20 +18,20 @@ Run bundler command to install the gem:
 After you install the gem, you need run the generator:
 
     rails g china_region_fu:install
-   
+
    It will:
-   * Generate `db/migrate/<timestamp>create_china_region_tables.rb` migrate file to your app, `provinces`, `cities`, `districts` table is used for store the regions.
-   * Copy regions.yml to config/ directory.
+   * Generate `db/migrate/<timestamp>create_china_region_tables.rb` migrate file to your app.
+   * Download [https://github.com/Xuhao/china_region_data/raw/master/regions.yml](https://github.com/Xuhao/china_region_data/raw/master/regions.yml) to config/regions.yml.
    * Run `rake db:migrate`.
    * Run `rake region:import`.
 
    Now you have there ActiveRecord modules: `Province`, `City`, `District`.
-   
-   Run with `rails g` for get generator list.
+
+Region data if 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:mvc
+    rails g china_region_fu:models
 
    This will create:
    
@@ -38,57 +40,123 @@ If you want to customize the region modules you can run the generator:
     create  app/models/district.rb
 
    So you can do what you want to do in this files.
-   
+
 ## Usage
 
 #### Model
 
-    a = Province.last
-    a.name                # => "台湾省"
-    a.cities.map(&:name)  # => ["嘉义市", "台南市", "新竹市", "台中市", "基隆市", "台北市"]
-    
-    Province.first.districts.map(&:name) # => ["延庆县", "密云县", "平谷区", ...]
-    
-    c = City.last
-    c.name                # => "酒泉市"
-    c.zip_code            # => "735000"
-    c.pinyin              # => "jiuquan"
-    c.pinyin_abbr         # => "jq"
-    c.districts.map(&:name) # => ["敦煌市", "玉门市", "阿克塞哈萨克族自治县", "肃北蒙古族自治县", "安西县", ...]
-    c.brothers.map(&:name)  # => ["甘南藏族自治州", "临夏回族自治州", "陇南市", ...]
-    
+```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_for(@post) do |f| %>
-      <div class="field">
-        <%= f.label :province, '选择地区：' %><br />
-        
-        # FormBuilder
-        # <%= f.region_select :city %>
-        # <%= f.region_select [:province, :city, :district] %>
-        # <%= f.region_select [:province, :city] %>
-        # <%= f.region_select [:city, :district] %>
-        # <%= f.region_select [:province, :district] %>
-        
-        # FormHelper
-        # <%= region_select :post, :province %>
-        # <%= region_select :post, [:province, :city, :district] %>
-        # ...
-        
-      </div>
-    <% end %>
-
-##### prompt
-  
-You need define `province_select_prompt`, `city_select_prompt`, `district_select_prompt` helpers for each select prompt.
-If you have not define these helpers, it will use the default one like:
-    
-    def region_prompt(region_klass)
-      human_name = region_klass.model_name.human
-      "请选择#{human_name}"
-    end
-    
-  Online example: [医院之家](http://www.yihub.com/ "医院").
+##### Form helpers
+
+```erb
+<%= form_for(@post) do |f| %>
+  <div class="field">
+    <%= f.label :province, '选择地区：' %><br />
+
+    # FormBuilder
+    <%= f.region_select :city %>
+    <%= f.region_select [:province, :city, :district], province_prompt: 'Do', city_prompt: 'it', district_prompt: 'like this' %>
+    <%= f.region_select [:province, :city], include_blank: true %>
+    <%= f.region_select [:city, :district] %>
+    <%= f.region_select [:province, :district] %>
+
+    # FormHelper
+    <%= region_select :post, :province %>
+    <%= region_select :post, [:province, :city, :district] %>
+    ...
+
+    # FormTagHelper
+    <%= region_select_tag :province, class: 'my', include_blank: true %>
+    <%= region_select_tag [:province, :city, :district], province_prompt: 'Do', city_prompt: 'it', district_prompt: 'like this', class: 'my' %>
+    ...
+  </div>
+<% end %>
+```
+
+##### SimpleForm
+
+```erb
+<%= simple_form_for(@post) do |f| %>
+  <%= f.input :province, as: :region, collection: Province.select('id, name'), sub_region: :city %>
+  <%= f.input :city, as: :region, sub_region: :district %>
+  <%= f.input :district, as: :region %>
+  <%= js_for_region_ajax %>
+<% end %>
+```
+
+##### Formtastic
+
+```erb
+<%= semantic_form_for(@post) do |f| %>
+  <%= f.input :province, as: :region, collection: Province.select('id, name'), sub_region: :city %>
+  <%= f.input :city, as: :region, sub_region: :district %>
+  <%= f.input :district, as: :region %>
+  <%= js_for_region_ajax %>
+<% end %>
+```
+
+##### Fetch sub regions by Ajax
+
+Once select one province, we want fetch cities of the selected province and fill the city select box automatically. If you use `:region_select_tag` and FormBuilder/FormHelper method aka `:region_select`, you need do nothing for this. If you use simple_form or normal form helper like `:select_tag` or `:select`, to implement this, what you need to do is add below helper in your form:
+
+```erb
+<%= js_for_region_ajax %>
+```
+
+it will render:
+
+```html
+<script type="text/javascript">
+  //<![CDATA[
+    $(function(){
+      $('body').on('change', '.region_select', function(event) {
+        var self, $targetDom;
+        self = $(event.currentTarget);
+        $targetDom = $('#' + self.data('region-target'));
+        if ($targetDom.size() > 0) {
+          $.getJSON('/china_region_fu/fetch_options', {klass: self.data('region-target-kalss'), parent_klass: self.data('region-klass'), parent_id: self.val()}, function(data) {
+            var options = [];
+            $('option[value!=""]', $targetDom).remove();
+            $.each(data, function(index, value) {
+              options.push("<option value='" + value.id + "'>" + value.name + "</option>");
+            });
+            $targetDom.append(options.join(''));
+          });
+        }
+      });
+    });
+  //]]>
+</script>
+```
+
+## Online example
+[医院之家](http://www.yihub.com/ "医院").
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,6 @@
-#!/usr/bin/env rake
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/china_region_fu/fetch_options_controller.rb

@@ -1,31 +1,37 @@
 module ChinaRegionFu
   class FetchOptionsController < ::ActionController::Metal
-    
+
     def index
-      if params_valid?(params) and parent_klass = params[:parent_klass].classify.safe_constantize.find(params[:parent_id])
-        table_name = params[:klass].tableize
-        regions = parent_klass.__send__(table_name).select("#{table_name}.id, #{table_name}.name")
-        if has_level_column?(params[:klass])
-          regions = regions.order('level ASC')
-        else
-          regions = regions.order('name ASC')
-        end
+      if params_valid? and klass and parent_klass and (parent_object = parent_klass.find(params[:parent_id]))
+        regions = parent_object.__send__(klass.model_name.plural).select("#{klass.table_name}.id, #{klass.table_name}.name").order("#{klass.table_name}.name ASC")
+        regions.reorder("#{klass.table_name}.level ASC") if has_level_column?
         self.response_body = regions.to_json
       else
         self.response_body = [].to_json
       end
     end
-    
-    
+
     private
-    
-    def has_level_column?(klass_name)
-      klass_name.classify.safe_constantize.try(:column_names).to_a.include?('level')
-    end
-    
-    def params_valid?(params)
-      params[:klass].present? and params[:parent_klass] =~ /^province|city$/i and params[:parent_id].present?
-    end
-    
+
+      def has_level_column?
+        klass.column_names.to_a.include?('level')
+      end
+
+      def klass
+        params[:klass].sub(/_id\Z/, '').classify.safe_constantize
+      end
+
+      def parent_klass
+        parent_klass_name.classify.safe_constantize
+      end
+
+      def parent_klass_name
+        params[:parent_klass].sub(/_id\Z/, '')
+      end
+
+      def params_valid?
+        params[:klass].present? and parent_klass_name=~ /\Aprovince\Z|\Acity\Z/i and params[:parent_id].present?
+      end
+
   end
 end

data/app/models/city.rb

@@ -1,7 +1,9 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
 class City < ActiveRecord::Base
-  attr_accessible :name, :province_id, :level, :zip_code, :pinyin, :pinyin_abbr
-  
+  if Rails.version < '4.0'
+    attr_accessible :name, :province_id, :level, :zip_code, :pinyin, :pinyin_abbr
+  end
+
   belongs_to :province
   has_many :districts, dependent: :destroy
 

data/app/models/district.rb

@@ -1,16 +1,18 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
 class District < ActiveRecord::Base
-  attr_accessible :name, :city_id, :pinyin, :pinyin_abbr
-  
-	belongs_to :city
-	belongs_to :province
+  if Rails.version < '4.0'
+    attr_accessible :name, :city_id, :pinyin, :pinyin_abbr
+  end
+
+  belongs_to :city
+  has_one :province, through: :city
+
+  def short_name
+    @short_name ||= name.gsub(/区|县|市|自治县/,'')
+  end
+
+  def brothers
+    @brothers ||= District.where("city_id = #{city_id}")
+  end
 
-	def short_name
-		@short_name ||= name.gsub(/区|县|市|自治县/,'')
-	end
-	
-	def brothers
-		@brothers ||= District.where("city_id = #{city_id}")
-	end
-	
 end

data/app/models/province.rb

@@ -1,7 +1,8 @@
-# -*- encoding: utf-8 -*-
 class Province < ActiveRecord::Base
-  attr_accessible :name, :pinyin, :pinyin_abbr
-  
-	has_many :cities, dependent: :destroy
-	has_many :districts, through: :cities
+  if Rails.version < '4.0'
+    attr_accessible :name, :pinyin, :pinyin_abbr
+  end
+
+  has_many :cities, dependent: :destroy
+  has_many :districts, through: :cities
 end

data/china_region_fu.gemspec

@@ -1,19 +1,26 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/china_region_fu/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'china_region_fu/version'
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Xuhao"]
-  gem.email         = ["xuhao@rubyfans.com"]
-  gem.description   = %q{China region Ruby on rails interface}
-  gem.summary       = %q{China region Ruby on rails interface}
-  gem.homepage      = "http://rubyfans.com"
+Gem::Specification.new do |spec|
+  spec.name          = "china_region_fu"
+  spec.version       = ChinaRegionFu::VERSION
+  spec.authors       = ["Xuhao"]
+  spec.email         = ["xuhao@rubyfans.com"]
+  spec.description   = %q{China region Ruby on rails interface}
+  spec.summary       = %q{China region Ruby on rails interface}
+  spec.homepage      = "https://github.com/Xuhao/china_region_fu"
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "china_region_fu"
-  gem.require_paths = ["lib"]
-  gem.version       = ChinaRegionFu::VERSION
-  
-  gem.add_dependency 'jquery-rails'
-end
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'actionpack'
+end

data/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  match '/china_region_fu/fetch_options', to: ChinaRegionFu::FetchOptionsController.action(:index)
-end
+  get '/china_region_fu/fetch_options', to: ChinaRegionFu::FetchOptionsController.action(:index)
+end

data/lib/china_region_fu.rb

@@ -2,5 +2,3 @@ require "china_region_fu/version"
 require 'china_region_fu/engine' if defined? Rails
 
 module ChinaRegionFu;end
-
-require 'china_region_fu/helper'

data/lib/china_region_fu/engine.rb

@@ -1,5 +1,18 @@
 require "rails"
+require 'china_region_fu/helpers/helpers'
 
 module ChinaRegionFu
-  class Engine < Rails::Engine;end
+  class Engine < Rails::Engine
+    initializer "form helper extensions" do
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, ChinaRegionFu::Helpers
+        ActionView::Helpers::FormBuilder.send :include, ChinaRegionFu::FormBuilder
+      end
+    end
+
+    initializer "simple extension" do
+      require "china_region_fu/helpers/simple_form" if Object.const_defined?("SimpleForm")
+      require "china_region_fu/helpers/formtastic" if Object.const_defined?("Formtastic")
+    end
+  end
 end

data/lib/china_region_fu/exceptions.rb

@@ -0,0 +1,7 @@
+module ChinaRegionFu
+  class InvalidAttributeError < StandardError
+    def initialize
+      super 'Region attribute is not valid.'
+    end
+  end
+end