china_regions 0.1.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42ebe2926674e82aeebf73c5111a62a20e182eda
-  data.tar.gz: d7ef3319973190e74f2e17d70a656db38d22a133
+  metadata.gz: 2bb6a315cde1ce4bf6543b865aea9508887d48e9
+  data.tar.gz: ed1e49662e8b1cd04208df7d4d7f4482c630e6b3
 SHA512:
-  metadata.gz: 389e838506bd0821046b6879a11fe63fa8d996afb8f32c03fec9347d8aba079e48d2f3e30f4aeb4e99366e18751e717c5d82cc2cd8207c3a822c83b6dfb2cdcb
-  data.tar.gz: a2924b8c593fbb8a9f6044d29dc84b8b8b5d091daf3e77a1e33fbce5f490633d4dd7dc500d8a29a0146ffb573a190ed3260a1581347a79f5a87fa9e210daf420
+  metadata.gz: 95a372effc18e54b543adfb17ebf25527744e6ed7b50ba2fd4608ecd9b049dbc1a3b6189fa2cd8c811249e5f86fd56d436f84c8c0b83a494a9539674b47682e2
+  data.tar.gz: 6a1a1268ed726a94b1280252a2f52a0916d39a2629770e11eeef55cc0e407e4f2fbc9eb632a9e7b219dbdfb90c6458af02aa74a9da61092673e06b0eaa9f82a9

data/README.md

@@ -1,45 +1,53 @@
 # ChinaRegions
 
-中国省份，城市，地区［地级市］. 紧支持 Ruby on Rails 程序. Ruby Version ( > 1.9.x ) Rails Version ( > 3.2.x )
-       
+中国省份，城市，地区［地级市］
+Ruby on Rails 程式代码, Ruby ( > 1.9.x ) And Rails (> 4.0)
+
+## How to update
+
+If you are using ChinaRegions version 0.1.x be sure to run:
+
+    rails g china_regions:regions
+
+to have the javascript file copied over into your project.
 
 ## How to use it
 
-添加一下代码到你的 Gemfile:
+添加以下代码到你的 Gemfile:
 
 gem 'china_regions'
 
-or
+OR
 
-gem 'china_regions',    :git => 'git://github.com/encoreshao/china_regions.git'
+gem 'china_regions',  github: 'encoreshao/china_regions'
 
 bundle install
 
 执行:
 
     rails g china_regions:install
-   
-   随后你可以看到控制台:
-   * 创建 migration 文件到db/migrate 目录 db/migrate/xxxxxxxxxxx_create_china_regions_tables.rb
-   * 创建 数据源 cities.yml 到 config 目录.  config/cities.yml
-   * 创建 regions.en.yml 和 regions.zh.yml 文件到 config/locales 文件下
-   * 执行 `rake db:migrate` 添加三张表(provinces, cities, districts).
+
+   随后你可以看到控制台发生的变化:
+   * 复制 db/migrate/xxxxxxxxxxx_create_china_regions_tables.rb 文件到db/migrate 目录
+   * 复制 数据源 cities.yml 到 config 目录.  config/cities.yml
+   * 复制 regions.en.yml 和 regions.zh.yml 文件到 config/locales 目录
+   * 执行 `rake db:migrate` 创建所需的表 (provinces, cities, districts).
    * 执行 `rake china_regions:import` 导入数据.
 
 
 此时 你可能需要添加三个 models[`Province`, `City`, `District`] 到你应用中:
-    
+
     你可以执行 `rails g` 查看到 generator LIST.
 
-    执行 rails g china_regions:regions models
+    执行 rails g china_regions:regions
 
    查看 app/models:
-   
+
     create  app/models/province.rb
     create  app/models/city.rb
     create  app/models/district.rb
 
-## How to view 
+## How to view
 
 范例:
 
@@ -57,7 +65,7 @@ bundle install
       = region_select :article, :province
       = region_select :article, :city
       = region_select :article, :district
-      
+
       = f.submit class: 'btn'
 
 添加前缀名:
@@ -66,11 +74,29 @@ bundle install
 
       = f.region_select [:province, :city, :district], :prefix => "home"
       = f.region_select [:province, :city, :district], :prefix => "work"
-   
+
+
+Preselect Province:
+
+    = form_for @article do |f|
+
+      = f.region_select [:province, :city, :district], province: "chongqing"
+
+      OR
+
+      = f.region_select [:province, :city, :district], province: "重庆市"
+
+Prioritize Choice:
+
+    = form_for @article do |f|
+
+      = f.region_select [:province, :city, :district], priority: { province: ["重庆市"], district: %w(巴南区 北碚区 渝北区) }
 
 ## Contributing
 
-Thank you for XuHao
+We have a list of valued contributors. Check them all at:
+
+https://github.com/encoreshao/china_regions/graphs/contributors
 
 
 ## License

data/app/assets/javascripts/region_select.js

@@ -0,0 +1,48 @@
+$(function() {
+  $('body').on('change', '.region_select', function(event) {
+    var changed_object = $(event.currentTarget);
+    var target_dom = get_target(changed_object);
+
+    if (target_dom.size() > 0) {
+      get_options(changed_object, target_dom, deal_with_second_target);
+    }
+  });
+
+  function get_target(dom_object) {
+    return $('#' + dom_object.data('region-target'));
+  }
+
+  function deal_with_second_target(changed_obj, target) {
+    var updated_target = get_target(changed_obj);
+    var second_target = get_target(updated_target);
+
+    // Just clear out the second dropdown if it exists,
+    // they should start from the beginning
+    if (second_target.size() > 0) {
+      $('option[value!=""]', second_target).remove();
+
+      // If the updated target has only one entry ensure that all districts
+      // are loaded so that we can get those options since.
+      if ($('option', updated_target).size() == 1) {
+        get_options(updated_target, second_target);
+      }
+    }
+  }
+
+  // Retrieve options and allow a callback to be included to perform additonal
+  // stuff on success
+  function get_options(changed_object, target, additional_success_callback) {
+    $.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) {
+
+      $('option[value!=""]', target).remove();
+      $.each(data, function(index, value) {
+        target.append("<option value='" + value.id + "'>" + value.name + "</option>");
+      });
+
+      typeof additional_success_callback === 'function' && additional_success_callback(changed_object, target);
+    });
+  }
+});

data/app/controllers/china_regions/fetch_options_controller.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module ChinaRegions
   class FetchOptionsController < ::ActionController::Metal
 
@@ -17,12 +19,13 @@ module ChinaRegions
     end
 
     protected
-      def has_level_column?(klass_name)
-        klass_name.classify.safe_constantize.try(:column_names).to_a.include?('level')
-      end
+    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 params_valid?(params)
-        params[:klass].present? and params[:parent_klass] =~ /^province|city$/i and params[:parent_id].present?
-      end
   end
 end

data/app/models/city.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 class City < ActiveRecord::Base
+
   belongs_to :province
   has_many :districts, dependent: :destroy
 

data/app/models/district.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 class District < ActiveRecord::Base
+
   belongs_to :city
 
   scope :with_city, ->(city) { where(city_id: city) }

data/app/models/province.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 
 class Province < ActiveRecord::Base
+
   has_many :cities, dependent: :destroy
   has_many :districts, through: :cities
+
 end

data/config/locales/zh.yml

@@ -25,4 +25,4 @@ zh:
         city_id: 城市
         city: 城市
         name_en: 拼音
-        name_abbr: 简称
+        name_abbr: 简称

data/lib/china_regions/helpers/form_helper.rb

@@ -1,35 +1,41 @@
 # encoding: utf-8
-
 module ChinaRegions
   module Helpers
     module FormHelper
-      def region_select(object, methods, options = {}, html_options = {})
+      def region_select(object_name, methods, options = {}, html_options = {})
         output = ''
 
-        html_options[:class] ? 
-          (html_options[:class].prepend('region_select ')) : 
+        preselected_choices = set_regions_options(options)
+
+        html_options[:class] ?
+          (html_options[:class].prepend('region_select ')) :
             (html_options[:class] = 'region_select')
 
-        dropdown_prefix = options[:prefix].to_s + "_" || ""
+        dropdown_prefix = options[:prefix] ? options[:prefix].to_s + "_" : ""
 
         if Array === methods
           methods.each_with_index do |method, index|
             if region_klass = method.to_s.classify.safe_constantize
-              choices = (index == 0 ? region_klass.where(nil).collect {|p| [ p.name, p.id ] } : [])
+              choices = get_choices(region_klass, method, preselected_choices, index)
+              choices = prioritize_choices(options[:priority][method], choices) if options[:priority].try(:[], method)
+
               next_method = methods.at(index + 1)
 
-              set_options(method, options, region_klass)
-              set_html_options(object, method, html_options, next_method, dropdown_prefix)
+              set_prompt(method, options, region_klass)
+              set_html_options(object_name, method, html_options, next_method, dropdown_prefix)
 
-              output << select(object, "#{dropdown_prefix}#{method.to_s}_id", choices, options = options, html_options = html_options)
+              if options[:default] && options[:default][method]
+                options[:selected] = options[:default][method] if options[:default][method]
+              end
+
+              output << select(object_name, "#{dropdown_prefix}#{method.to_s}_id", choices, options, html_options)
             else
-              raise "Method '#{method}' is not a vaild attribute of #{object}"
+              raise "Method '#{method}' is not a vaild attribute of #{object_name}"
             end
           end
         else
-
           _methods = unless methods.to_s.include?('_id')
-            (methods.to_s + ('_id')).to_sym 
+            (methods.to_s + ('_id')).to_sym
           else
             _methods = methods
             methods = methods.to_s.gsub(/(_id)$/, '')
@@ -39,20 +45,68 @@ module ChinaRegions
           if region_klass = methods.to_s.classify.safe_constantize
             options[:prompt] = region_prompt(region_klass)
 
-            output << select(object, _methods, region_klass.where(nil).collect {|p| [ p.name, p.id ] }, options = options, html_options = html_options)
+            if methods == :province && preselected_choices[:province_id]
+              options[:selected] = preselected_choices[:province_id]
+            end
+
+            output << select(object_name, _methods, region_klass.where(nil).collect {|p| [ p.name, p.id ] }, options = options, html_options = html_options)
           else
-            raise "Method '#{method}' is not a vaild attribute of #{object}"
+            raise "Method '#{method}' is not a vaild attribute of #{object_name}"
           end
         end
-
-        output << javascript_tag(js_output)
         output.html_safe
       end
 
-
       private
 
-      def set_options(method, options, region_klass)
+      def get_choices(region_klass, method, preselected_choices, index)
+        return preselected_choices[method] if preselected_choices[method]
+
+        if index == 0
+          region_klass.where(nil).collect { |p| [p.name, p.id] }
+        else
+          []
+        end
+      end
+
+      def prioritize_choices(priorities, choices)
+        return choices if priorities.empty?
+
+        temp_choices = []
+        priority_choices = []
+        sorting_map = {}
+
+        priorities.each_with_index do |value, i|
+          sorting_map[value.to_sym] = i
+        end
+
+        choices.each do |name, id|
+          if sorting_map[name.to_sym]
+            priority_choices[sorting_map[name.to_sym]] = [name, id]
+          else
+            temp_choices.push([name, id])
+          end
+        end
+        priority_choices.compact + temp_choices
+      end
+
+      def set_regions_options(options)
+        return {} unless options[:default] && options[:default][:province]
+
+        #TODO: Add validator to check if the passed province, city or district exists within the models
+
+        province_id = get_province_id(options[:default][:province])
+        cities = City.where(province_id: province_id)
+        districts = District.where(city_id: cities)
+
+        {
+          province_id: province_id,
+          city:        cities.collect { |c| [ c.name, c.id ] },
+          district:    districts.collect { |d| [ d.name, d.id ] }
+        }
+      end
+
+      def set_prompt(method, options, region_klass)
         if respond_to?("#{method}_select_prompt")
           options[:prompt] = __send__("#{method}_select_prompt")
         else
@@ -60,10 +114,17 @@ module ChinaRegions
         end
       end
 
-      def set_html_options(object, method, html_options, next_region, prefix)
+      def get_province_id(province)
+        return province if province.to_s =~ /\A[0-9]*\z/
+        Province.where('name_en = ? OR name = ?', province.downcase, province).first.id
+      end
+
+      def set_html_options(object_name, method, html_options, next_region, prefix)
         html_options[:data] ? (html_options[:data][:region_klass] = "#{method.to_s}") : (html_options[:data] = { region_klass: "#{method.to_s}" })
         if next_region
-          html_options[:data].merge!(region_target: "#{object}_#{prefix}#{next_region.to_s}_id", region_target_klass: next_region.to_s)
+          object_name = object_name.dup.gsub(/\[/, '_')
+          object_name = object_name.dup.gsub(/\]/, '')
+          html_options[:data].merge!(region_target: "#{object_name}_#{prefix}#{next_region.to_s}_id", region_target_klass: next_region.to_s)
         else
           html_options[:data].delete(:region_target)
           html_options[:data].delete(:region_target_klass)
@@ -73,38 +134,11 @@ module ChinaRegions
       def region_prompt(region_klass)
         t('views.select', model: region_klass.model_name.human)
       end
-
-      def js_output
-        %~
-          $(function(){
-            $('body').on('change', '.region_select', function(event) {
-              var changedObj, targetDom;
-              changedObj = $(event.currentTarget);
-              targetDom = $('#' + changedObj.data('region-target'));
-              if (targetDom.size() > 0) {
-                $.getJSON('/china_regions/fetch_options', {klass: changedObj.data('region-target-klass'), parent_klass: changedObj.data('region-klass'), parent_id: changedObj.val()}, function(data) {
-                  $('option[value!=""]', targetDom).remove();
-                  $.each(data, function(index, value) {
-                    targetDom.append("<option value='" + value.id + "'>" + value.name + "</option>");
-                  });
-                })
-                // just clear out the second dropdown if it exists, they should start from the beginning
-                secondTargetDom = $('#' + targetDom.data('region-target'));
-                if (secondTargetDom.size() > 0) {
-                  $('option[value!=""]', secondTargetDom).remove();
-                }
-              }
-            });
-          });
-        ~
-      end
-
     end
 
-
     module FormBuilder
       def region_select(methods, options = {}, html_options = {})
-        @template.region_select(@object_name, methods, options = options, html_options = html_options)
+        @template.region_select(@object_name.to_s, methods, options = options, html_options = html_options)
       end
     end
 

data/lib/china_regions/version.rb

@@ -1,3 +1,3 @@
 module ChinaRegions
-  VERSION = "0.1.0"
+  VERSION = "0.4.2"
 end

data/lib/generators/china_regions/install_generator.rb

@@ -7,6 +7,7 @@ module ChinaRegions
 
     def copy_migration
       Dir["db/migrate/*_china_regions_tables.rb"].each{ |file| File.delete(file) }
+
       migration_template "migration.rb", "db/migrate/create_china_regions_tables.rb"
     end
 

data/lib/generators/china_regions/regions_generator.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module ChinaRegions
-  class RegionsGenerator < Rails::Generators::NamedBase
+  class RegionsGenerator < Rails::Generators::Base
     source_root File.expand_path('../../../../app', __FILE__)
 
     def copy_models_file
@@ -9,5 +9,9 @@ module ChinaRegions
       copy_file "models/city.rb",     "app/models/city.rb"
       copy_file "models/district.rb", "app/models/district.rb"
     end
+
+    def copy_js_file
+      copy_file "assets/javascripts/region_select.js", "app/assets/javascripts/region_select.js"
+    end
   end
 end

data/lib/generators/china_regions/templates/cities.yml

@@ -70,7 +70,7 @@
     天津市:
       name_en: tianjin
       name_abbr: tj
-      zip_code: '100000'
+      zip_code: '300000'
       level: 1
       districts:
         和平区:

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

@@ -11,8 +11,6 @@ class CreateChinaRegionsTables < ActiveRecord::Migration
       end
 
       add_index :provinces, :name
-      add_index :provinces, :name_en
-      add_index :provinces, :name_abbr
     end
 
     unless table_exists? 'cities'
@@ -25,15 +23,11 @@ class CreateChinaRegionsTables < ActiveRecord::Migration
         t.string :name_abbr
         t.timestamps
       end
+
       add_index :cities, :name
-      add_index :cities, :province_id
-      add_index :cities, :level
-      add_index :cities, :zip_code
-      add_index :cities, :name_en
-      add_index :cities, :name_abbr
     end
 
-    unless table_exists? 'districts'  
+    unless table_exists? 'districts'
       create_table :districts do |t|
         t.string :name
         t.integer :city_id
@@ -42,9 +36,6 @@ class CreateChinaRegionsTables < ActiveRecord::Migration
         t.timestamps
       end
       add_index :districts, :name
-      add_index :districts, :city_id
-      add_index :districts, :name_en
-      add_index :districts, :name_abbr
     end
   end
 end

data/lib/tasks/china_regions.rake

@@ -9,6 +9,7 @@ namespace :china_regions do
     file_path = File.join(Rails.root, 'config', 'cities.yml')
     data = File.open(file_path) { |file| YAML.load(file) }
     remove_china_regions && load_to_db(data)
+
     puts "\n China's provinces, city, region data import is complete."
   end
 
@@ -19,8 +20,8 @@ namespace :china_regions do
   def load_to_db(data)
     data.each do |province_name, province_hash|
       province_parameters = province_params({
-        name:       province_name, 
-        name_en:    province_hash['name_en'], 
+        name:       province_name,
+        name_en:    province_hash['name_en'],
         name_abbr:  province_hash['name_abbr']
       })
       province = Province.create(province_parameters)
@@ -28,9 +29,9 @@ namespace :china_regions do
       province_hash['cities'].each do |city_name, city_hash|
         city_parameters = city_params({
           province_id:  province.id,
-          name:         city_name, 
-          name_en:      city_hash['name_en'], 
-          name_abbr:    city_hash['name_abbr'], 
+          name:         city_name,
+          name_en:      city_hash['name_en'],
+          name_abbr:    city_hash['name_abbr'],
           zip_code:     city_hash['zip_code'],
           level:        city_hash['level'] || 4
         })
@@ -40,8 +41,8 @@ namespace :china_regions do
         districts_hash.each do |district_name, district_hash|
           district_parameters = district_params({
             city_id:    city.id,
-            name:       district_name, 
-            name_en:    district_hash['name_en'], 
+            name:       district_name,
+            name_en:    district_hash['name_en'],
             name_abbr:  district_hash['name_abbr']
           })
           District.create(district_parameters)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: china_regions
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Encore Shao
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-12 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
@@ -38,6 +38,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/assets/javascripts/region_select.js
 - app/controllers/china_regions/fetch_options_controller.rb
 - app/models/city.rb
 - app/models/district.rb
@@ -74,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Rails 4 version of dropdowns for all provinces, cities, and districts in