china_region_fu 0.0.6 → 0.1.0

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/china_region_fu.gemspec

@@ -1,27 +1,28 @@
-# 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 |spec|
-  spec.name          = "china_region_fu"
+  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"
-
-  spec.files         = `git ls-files`.split($/)
+  spec.authors       = ['Xuhao']
+  spec.email         = ['xuhao@rubyfans.com']
+  spec.summary       = 'china_region_fu provides simple helpers to get an HTML select list of countries, cities and districts.'
+  spec.description   = 'china_region_fu provides simple helpers to get an HTML select list of countries, cities and districts.'
+  spec.homepage      = 'https://github.com/Xuhao/china_region_fu'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
   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.test_files    = Dir['spec/**/*']
+  spec.require_paths = ['lib']
+  spec.required_ruby_version     = '>= 2.2.2'
+  spec.required_rubygems_version = '>= 1.8.11'
 
-  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'
-  spec.add_dependency 'httparty'
-end
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'activesupport', '>= 4.0'
+  spec.add_dependency 'httparty', '~> 0.14.0'
+end

data/db/migrate/20111111111111_create_china_region_tables.rb

@@ -7,12 +7,12 @@ class CreateChinaRegionTables < ActiveRecord::Migration
         t.string :pinyin_abbr
         t.timestamps
       end
-      
-      add_index :provinces, :name
-      add_index :provinces, :pinyin
-      add_index :provinces, :pinyin_abbr
+
+      add_index(:provinces, :name) unless index_exists?(:provinces, :name)
+      add_index(:provinces, :pinyin) unless index_exists?(:provinces, :pinyin)
+      add_index(:provinces, :pinyin_abbr) unless index_exists?(:provinces, :pinyin_abbr)
     end
-    
+
     unless table_exists? 'cities'
       create_table :cities do |t|
         t.string :name
@@ -23,14 +23,15 @@ class CreateChinaRegionTables < ActiveRecord::Migration
         t.string :pinyin_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, :pinyin
-      add_index :cities, :pinyin_abbr
+
+      add_index(:cities, :name) unless index_exists?(:cities, :name)
+      add_index(:cities, :province_id) unless index_exists?(:cities, :province_id)
+      add_index(:cities, :level) unless index_exists?(:cities, :level)
+      add_index(:cities, :zip_code) unless index_exists?(:cities, :zip_code)
+      add_index(:cities, :pinyin) unless index_exists?(:cities, :pinyin)
+      add_index(:cities, :pinyin_abbr) unless index_exists?(:cities, :pinyin_abbr)
     end
-    
+
     unless table_exists? 'districts'
       create_table :districts do |t|
         t.string :name
@@ -39,10 +40,11 @@ class CreateChinaRegionTables < ActiveRecord::Migration
         t.string :pinyin_abbr
         t.timestamps
       end
-      add_index :districts, :name
-      add_index :districts, :city_id
-      add_index :districts, :pinyin
-      add_index :districts, :pinyin_abbr
+
+      add_index(:districts, :name) unless index_exists?(:districts, :name)
+      add_index(:districts, :city_id) unless index_exists?(:districts, :city_id)
+      add_index(:districts, :pinyin) unless index_exists?(:districts, :pinyin)
+      add_index(:districts, :pinyin_abbr) unless index_exists?(:districts, :pinyin_abbr)
     end
   end
-end
+end

data/lib/china_region_fu.rb

@@ -1,4 +1,5 @@
-require "china_region_fu/version"
-require 'china_region_fu/engine' if defined? Rails
+require 'china_region_fu/version'
+require 'china_region_fu/engine' if Object.const_defined?('Rails')
 
-module ChinaRegionFu;end
+module ChinaRegionFu
+end

data/lib/china_region_fu/engine.rb

@@ -1,18 +1,20 @@
-require "rails"
+require 'rails'
 require 'china_region_fu/helpers/helpers'
 
 module ChinaRegionFu
-  class Engine < Rails::Engine
-    initializer "form helper extensions" do
+  class Engine < ::Rails::Engine
+    isolate_namespace ChinaRegionFu
+
+    initializer 'china_region_fu: form helper extensions' do
       ActiveSupport.on_load :action_view do
-        ActionView::Base.send :include, ChinaRegionFu::Helpers
-        ActionView::Helpers::FormBuilder.send :include, ChinaRegionFu::FormBuilder
+        ActionView::Base.send :include, ChinaRegionFu::Helpers::FormHelper
+        ActionView::Helpers::FormBuilder.send :include, ChinaRegionFu::Helpers::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")
+    initializer 'china_region_fu: third-party extensions' 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
+end

data/lib/china_region_fu/errors.rb

@@ -0,0 +1,5 @@
+# :nocov:
+module ChinaRegionFu
+  InvalidFieldError = Class.new(StandardError)
+end
+# :nocov:

data/lib/china_region_fu/helpers/formtastic.rb

@@ -1,7 +1,7 @@
-require 'china_region_fu/helpers/utilities'
+require 'china_region_fu/helpers/utils'
 
 class RegionInput < Formtastic::Inputs::SelectInput
-  include ChinaRegionFu::Utilities
+  include ChinaRegionFu::Utils
 
   def collection_from_options
     return [] unless options.key?(:collection)
@@ -9,8 +9,6 @@ class RegionInput < Formtastic::Inputs::SelectInput
   end
 
   def input_html_options
-    the_options = append_region_class(super.dup)
-    the_options = set_html_options(object_name, input_name, the_options, input_options.delete(:sub_region).to_s.sub(/_id\Z/, '').foreign_key) if input_options.key?(:sub_region)
-    the_options
+    append_html_options(input_name, input_options.delete(:sub_region), super)
   end
-end
+end

data/lib/china_region_fu/helpers/helpers.rb

@@ -1,70 +1,61 @@
-require 'china_region_fu/exceptions'
-require 'china_region_fu/helpers/utilities'
+require 'china_region_fu/errors'
+require 'china_region_fu/helpers/utils'
+require 'active_support/core_ext/object/blank'
 
 module ChinaRegionFu
   module Helpers
-    include Utilities
+    module FormHelper
+      include Utils
 
-    def region_select_tag(names, options = {})
-      append_region_class(options)
-
-      if Array === names
-        output = ActiveSupport::SafeBuffer.new
-        names.each_with_index do |name, index|
-          if klass = to_class(name)
-            choices = index == 0 ? options_from_collection_for_select(klass.select('id, name'), "id", "name") : ''
-            next_name = names.at(index + 1)
-            set_html_options(nil, name, options, next_name)
+      def region_select_tag(regions, options = {})
+        render_region_select_tags(nil, regions, ActiveSupport::SafeBuffer.new, options)
+      end
 
-            output << content_tag(:div, select_tag(name, choices, options.merge(prompt: options.delete("#{name}_prompt".to_sym))), class: "input region #{name.to_s}")
-          else
-            raise InvalidAttributeError
-          end
-        end
-        output << js_for_region_ajax if names.size > 1
-        output
-      else
-        if klass = to_class(names)
-          select_tag(names, options_from_collection_for_select(klass.select('id, name'), "id", "name"), options)
-        else
-          raise InvalidAttributeError
-        end
+      def region_select(object, methods, options = {}, html_options = {})
+        render_region_select_tags(object, methods, ActiveSupport::SafeBuffer.new, options, html_options)
       end
-    end
 
-    def region_select(object, methods, options = {}, html_options = {})
-      options.symbolize_keys!
-      html_options.symbolize_keys!
-      append_region_class(html_options)
+      private
 
-      if Array === methods
-        output = ActiveSupport::SafeBuffer.new
-        methods.each_with_index do |method, index|
-          if klass = to_class(method)
-            choices = index == 0 ? klass.select('id, name').collect {|p| [ p.name, p.id ] } : []
-            next_method = methods.at(index + 1)
-            set_html_options(object, method, html_options, next_method)
+        def render_region_select_tags(object, regions, buffer = ActiveSupport::SafeBuffer.new, options = {}, html_options = {})
+          regions = (regions.is_a?(Symbol) || regions.is_a?(String)) ? [regions] : regions.to_a
+          regions.each_with_index do |region, index|
+            if klass = region.to_s.sub(/_id\Z/, '').classify.safe_constantize
+              buffer << content_tag(:div, make_select(object, klass, region, regions.at(index + 1), index, options, html_options), class: "input region #{region}")
+            else
+              raise ChinaRegionFu::InvalidFieldError, "Invalid region field: `#{region}`, valid fields are: province, province_id, city, city_id, district and district_id."
+            end
+          end
+          content_for(:china_region_fu_js) { china_region_fu_js }
+          buffer
+        end
 
-            output << content_tag(:div, select(object, method.to_s, choices, options.merge(prompt: options.delete("#{method}_prompt".to_sym)), html_options = html_options), class: "input region #{method.to_s}")
+        def make_select(object, klass, region, sub_region, order_index, options = {}, html_options = {})
+          choices = order_index == 0 ? klass.pluck(:name, :id) : get_choices(object, klass, region, options[:object])
+          if object
+            select(object, region, choices, append_prompt(region, options), append_html_options(region, sub_region, html_options))
           else
-            raise InvalidAttributeError
+            select_tag(region, options_for_select(choices), append_html_options(region, sub_region, append_prompt(region, options)))
           end
         end
-        output << js_for_region_ajax if methods.size > 1
-        output
-      else
-        if klass = to_class(methods)
-          content_tag(:div, select(object, methods, klass.select('id, name').collect {|p| [ p.name, p.id ] }, options = options, html_options = html_options), class: "input region #{methods.to_s}")
-        else
-          raise InvalidAttributeError
+
+        def get_choices(object, klass, region, ar_object)
+          return [] if object.blank?
+          return [] if !ar_object.is_a?(ActiveRecord::Base)
+          if %w(city city_id).include?(region.to_s) && ar_object.province_id.present?
+            klass.where(province_id: ar_object.province_id).pluck(:name, :id)
+          elsif %w(district district_id).include?(region.to_s) && ar_object.city_id.present?
+            klass.where(city_id: ar_object.city_id).pluck(:name, :id)
+          else
+            []
+          end
         end
-      end
     end
-  end
 
-  module FormBuilder
-    def region_select(methods, options = {}, html_options = {})
-      @template.region_select(@object_name, methods, options = options, html_options = html_options)
+    module FormBuilder
+      def region_select(methods, options = {}, html_options = {})
+        @template.region_select(@object_name, methods, objectify_options(options), @default_options.merge(html_options))
+      end
     end
   end
-end
+end

data/lib/china_region_fu/helpers/simple_form.rb

@@ -1,23 +1,24 @@
-require 'china_region_fu/helpers/utilities'
+require 'china_region_fu/helpers/utils'
 
 module ChinaRegionFu
   module SimpleForm
-    class RegionInput < ::SimpleForm::Inputs::CollectionInput
-      include ChinaRegionFu::Utilities
+    class RegionInput < ::SimpleForm::Inputs::CollectionSelectInput
+      include ChinaRegionFu::Utils
+      def input_html_options
+        append_html_options(attribute_name, sub_region, super)
+      end
 
-      def input
-        label_method, value_method = detect_collection_methods
-        append_region_class(input_html_options)
-        set_html_options(object_name, attribute_name, input_html_options, input_options.delete(:sub_region)) if input_options.key?(:sub_region)
-        region_collection = collection
-        region_collection = [] if region_collection == ::SimpleForm::Inputs::CollectionInput.boolean_collection
-        @builder.collection_select(
-          attribute_name, region_collection, value_method, label_method,
-          input_options, input_html_options
-        )
+      def collection
+        @collection ||= options.delete(:collection) || []
       end
+
+      private
+
+        def sub_region
+          @sub_region ||= input_options.delete(:sub_region)
+        end
     end
   end
 end
 
-::SimpleForm::FormBuilder.map_type :region, to: ChinaRegionFu::SimpleForm::RegionInput
+::SimpleForm::FormBuilder.map_type :region, to: ChinaRegionFu::SimpleForm::RegionInput

data/lib/china_region_fu/helpers/utils.rb

@@ -0,0 +1,82 @@
+require 'active_support/core_ext/object/deep_dup'
+require 'active_support/core_ext/string/output_safety'
+
+module ChinaRegionFu
+  module Utils
+    def china_region_fu_js
+      js = <<-JAVASCRIPT
+        <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 = $(event.currentTarget),
+                  $subRegionDom = $('[data-region-name="' + $self.data('sub-region') + '"]'),
+                  subName = $self.data('sub-region'),
+                  parentName = $self.data('region-name'),
+                  parentId = $self.val();
+                if ($subRegionDom.size() > 0 && subName && parentName && parentId) {
+                  $.getJSON('/china_region_fu/fetch_options', {
+                      columns: window.chinaRegionFu.fetchColumns || 'id,name',
+                      sub_name: subName,
+                      parent_name: parentName,
+                      parent_id: parentId
+                    }, 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>
+      JAVASCRIPT
+      js.html_safe
+    end
+
+    def append_html_class_option(html_options)
+      _html_options = html_options.deep_dup
+      _html_options[:class] ||= ''
+      _html_options[:class] << ' china-region-select' unless _html_options[:class].include?('china-region-select')
+      _html_options
+    end
+
+    def append_html_data_option(current_region, sub_region, html_options)
+      _html_options = html_options.deep_dup
+      _html_options[:data] ||= {}
+      _html_options[:data][:region_name] = current_region
+      if sub_region
+        _html_options[:data][:sub_region] = sub_region
+      else
+        _html_options[:data].delete(:sub_region)
+      end
+      _html_options
+    end
+
+    def append_html_options(current_region, sub_region, html_options)
+      _html_options = html_options.deep_dup
+      _html_options = append_html_class_option(_html_options)
+      _html_options = append_html_data_option(current_region, sub_region, _html_options)
+      _html_options
+    end
+
+    def append_prompt(current_region, options)
+      current_name = current_region.to_s.sub(/_id\Z/, '')
+      options_without_prompt = options.except(:province_prompt, :city_prompt, :district_prompt)
+      options_without_prompt[:prompt] = options["#{current_name}_prompt".to_sym]
+      options_without_prompt
+    end
+  end
+end

data/lib/china_region_fu/version.rb

@@ -1,3 +1,3 @@
 module ChinaRegionFu
-  VERSION = "0.0.6"
+  VERSION = '0.1.0'
 end

data/lib/generators/china_region_fu/models/USAGE

@@ -7,4 +7,4 @@ Example:
     This will create:
         app/models/province.rb
         app/models/city.rb
-        app/models/district.rb
+        app/models/district.rb

data/lib/generators/china_region_fu/models/models_generator.rb

@@ -3,9 +3,9 @@ module ChinaRegionFu
     source_root File.expand_path('../../../../../app', __FILE__)
 
     def copy_model_files
-      copy_file "models/province.rb", "app/models/province.rb"
-      copy_file "models/city.rb", "app/models/city.rb"
-      copy_file "models/district.rb", "app/models/district.rb"
+      copy_file 'models/province.rb', 'app/models/province.rb'
+      copy_file 'models/city.rb', 'app/models/city.rb'
+      copy_file 'models/district.rb', 'app/models/district.rb'
     end
   end
 end