chinese_regions_rails 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e933b807fcedf6ee8230a031d6be1f1bb979da7
-  data.tar.gz: 825ad0828019ce5afa37dfed3d6f2cfbc75f4f0a
+  metadata.gz: 188854b0a371acfad97c2d8df7fbe21d36b76bfd
+  data.tar.gz: 2dd67aa17a6a79e74967448b0721953b7b9a0a35
 SHA512:
-  metadata.gz: 79cdf218d01ac23951200d769465f04f8ba99adbf2b64b3c2fef45acb76b9ee394426dee43f79fcc0f51b637cf90276a8936e12b1872cccfa930f6987a8bd363
-  data.tar.gz: 562fef857c263117954c6f7c1b281456455a68610c56809b0a755de8690e1371b57f88f3407326857bd37b2d0ccf11122cb16349e176a514ad45a746a3636632
+  metadata.gz: 5f376ad65d7bc3d4ce3c176270523a96db196a8f921e554167cc489f51787dbea963d32f91c158235cd1666957eafa797c364ebc41c1b42788663a7394636f6f
+  data.tar.gz: 78c0c16f824babd5c5de679b7f51e27e3abdc975aa670bf9b95e840ac7e550ba91c200fe39f8e7710cf46cdf9e3b45d24c2daa4c43f8acd03e6a43b8416a9941

data/README.md

@@ -4,7 +4,7 @@
 数据来源 https://github.com/xixilive/chinese_regions_db 。
 支持 active_record 和 mongoid 。
 
-## 使用
+## 安装
 
 Gemfile
 
@@ -12,7 +12,7 @@ Gemfile
 gem 'chinese_regions_rails'
 ```
 
-generate `Region` model
+Copy migrations
 
 ```
 rails g chinese_regions:install
@@ -25,13 +25,80 @@ rake db:migrate
 rake db:seed:regions
 ```
 
-## Region 包含的属性
+## 使用
+
+直接使用 Region model
+
+```ruby
+class User < ActiveRecord::Base
+  belongs_to :city, class_name: "ChineseRegions::Region"
+end
+```
+
+#### 使用 [city-picker](https://github.com/tshi0912/city-picker) 作为表单输入
+
+application.css 添加下面代码
+```
+*= require city-picker
+```
+
+application.js 中在 jQuery 后面引入文件
+```
+//= require city-picker.data
+//= require city-picker
+//= require chinese-regions
+```
+
+表单里可以使用 `city_picker_tag(method, value, options)` 和 `city_picker(method, options)`, 这两个标签只是简单的封装，options 可以传入任何东西, 比如 city-picer 的 level 和 simple 选项可以通过 data 传入 `data: { level: :city, simple: true }`。
+```erb
+<%= form_tag do %>
+  <div style="position: relative;">
+    # Region model
+    <%= city_picker_tag :city_id, @user.city %>
+    # Regoin id
+    <%= city_picker_tag :city_id, "610101", data: { level: :city } %>
+  </div>
+<% end %>
 
-* code
-* parent_code
+<% form_for @user do |f| %>
+  <div style="position: relative;">
+    <%= f.city_pciker :city_id %>
+  </div>
+<% end %>
+```
+
+## Region model
+
+```ruby
+class ChineseRegions::Region < ActiveRecord
+  belogns_to :parent # 上级 region
+  has_many :children # 下级 region
+end
+```
+
+model 包含的属性
+* id
+* parent_id
 * level
 * name
 * alias
 * pinyin
 * abbr
 * zip
+
+### Change log
+
+* v1.0.0
+
+    **Break Change**
+
+    * 直接使用 engine 里的 ChineseRegions::Region model，而不是添加 model 到用户项目
+    * 引入 city-picker
+
+* v0.1.*
+
+    修改 Sqlite3 数据源到 json
+
+* v0.0.*
+
+    生成 Region model 到用户项目

data/lib/chinese_regions_rails.rb

@@ -3,5 +3,5 @@ require "chinese_regions_rails/json_data_source"
 require "chinese_regions_rails/db" if defined? SQLite3
 
 module ChineseRegionsRails
-  require "chinese_regions_rails/railtie" if defined?(Rails)
+  require "chinese_regions_rails/engine" if defined?(Rails)
 end

data/lib/chinese_regions_rails/engine.rb

@@ -0,0 +1,17 @@
+require "rails"
+require "chinese_regions_rails/helper"
+
+module ChineseRegions
+
+  class Engine < Rails::Engine
+    isolate_namespace ChineseRegions
+
+    initializer "chinese_regions_rails.helper_and_builder" do
+      ActiveSupport.on_load :action_view do
+        include ChineseRegionsRails::Helper
+        ActionView::Helpers::FormBuilder.send(:include, ChineseRegionsRails::Builder)
+      end
+    end
+  end
+
+end

data/lib/chinese_regions_rails/helper.rb

@@ -0,0 +1,79 @@
+require 'securerandom'
+
+module ChineseRegionsRails
+  module Helper
+    def city_picker_tag(name, value = nil, options = {})
+      HelperUtil.setup_options(options)
+
+      _raw_label = HelperUtil.raw_label(value)
+      _raw_value = HelperUtil.raw_value(value)
+
+
+      output = ActiveSupport::SafeBuffer.new
+      output << text_field_tag(nil, _raw_label, options)
+      output << hidden_field_tag(name, _raw_value, {
+                                   data: { "city-picker-value-for" =>  options[:data][:id] }
+                                })
+    end
+  end
+
+  module Builder
+    def city_picker(method, options = {})
+      HelperUtil.setup_options(options)
+
+      options[:name] = nil
+
+      value = retrive_value(method)
+      _raw_label = HelperUtil.raw_label(value)
+      _raw_value = HelperUtil.raw_value(value)
+
+      options[:value] = _raw_label
+
+      output = ActiveSupport::SafeBuffer.new
+      output << text_field(nil, options)
+      output << hidden_field(method, {
+                               value: _raw_value,
+                               data: { "city-picker-value-for" => options[:data][:id] }
+                             })
+    end
+
+    private
+    def retrive_value(method)
+      object = self.instance_variable_get("@object")
+      object.public_send(method) if object
+    end
+  end
+
+  module HelperUtil
+    def self.setup_options(options)
+      input_identifer = SecureRandom.hex(8)
+      if data = options[:data]
+        data.merge!(toggle: "city-picker", id: input_identifer)
+      else
+        data = {toggle: "city-picker", id: input_identifer}
+        options[:data] = data
+      end
+      options.merge!(readonly: true)
+    end
+
+    def self.raw_label(value)
+      return unless value
+
+      if value.is_a?(ChineseRegions::Region)
+        value.full_name("/")
+      else
+        ChineseRegions::Region.find_by(id: value).full_name("/")
+      end
+    end
+
+    def self.raw_value(value)
+      return unless value
+
+      if value.is_a?(ChineseRegions::Region)
+        value.id
+      else
+        value
+      end
+    end
+  end
+end

data/lib/chinese_regions_rails/version.rb

@@ -1,3 +1,3 @@
 module ChineseRegionsRails
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/generators/chinese_regions/install_generator.rb

@@ -3,12 +3,10 @@ require "rails/generators"
 module ChineseRegions
   class InstallGenerator < Rails::Generators::Base
 
-    desc "Generate region model. Default model name is 'Region'"
-
+    desc "Generate region model migration."
     def install
-      class_name = "region"
-      generate "model", "#{class_name} code:string parent_code:string name:string alias:string pinyin:string abbr:string zip:string level:integer"
+      rake 'railties:install:migrations'
     end
 
   end
-end
+end

data/lib/regions.json

@@ -20813,7 +20813,7 @@
     "code": "450000",
     "parent_code": null,
     "name": "广西壮族自治区",
-    "alias": "广西壮族",
+    "alias": "广西",
     "pinyin": "GuangXiZhuangZu",
     "abbr": "GXZZ",
     "zip": "530000",
@@ -27924,7 +27924,7 @@
     "parent_code": null,
     "name": "陕西省",
     "alias": "陕西",
-    "pinyin": "ShanXi",
+    "pinyin": "ShaanXi",
     "abbr": "SX",
     "zip": "710000",
     "level": 1
@@ -30553,7 +30553,7 @@
     "code": "640000",
     "parent_code": null,
     "name": "宁夏回族自治区",
-    "alias": "宁夏回族",
+    "alias": "宁夏",
     "pinyin": "NingXiaHuiZu",
     "abbr": "NXHZ",
     "zip": "750000",
@@ -30833,7 +30833,7 @@
     "code": "650000",
     "parent_code": null,
     "name": "新疆维吾尔自治区",
-    "alias": "新疆维吾尔",
+    "alias": "新疆",
     "pinyin": "XinJiangWeiWuEr",
     "abbr": "XJWWE",
     "zip": "830000",
@@ -33189,4 +33189,4 @@
     "zip": "833418",
     "level": 3
   }
-]
+]

data/lib/tasks/seed.rake

@@ -1,8 +1,5 @@
-# default model regions
 # rake db:seed:regions
 
-# TODO: rake db:seed:regions xxx_regions
-# custom model to xxx_regions
 require 'active_support/core_ext/string/inflections'
 require "chinese_regions_rails"
 
@@ -13,12 +10,12 @@ namespace :db do
 
     desc "seed regions data to db"
     task regions: :environment do
-      args ||= {}
-      args[:model_class] = 'region'
-      region_class = args[:model_class].classify.constantize
+      region_class = ChineseRegions::Region
 
       ChineseRegionsRails::JsonDataSource.query_regions do |region_param|
-        region_class.create(region_param)
+        region_param["id"] = region_param.delete("code")
+        region_param["parent_id"] = region_param.delete("parent_code")
+        region_class.create!(region_param)
       end
 
       puts "insert regions"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chinese_regions_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Basten Gao
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-description: "中国省市区县数据库，包含 行政编码，邮政编码，地区拼音和简拼。 数据来源 https://github.com/xixilive/chinese_regions_db"
+description: 中国省市区县数据库，包含 行政编码，邮政编码，地区拼音和简拼。 数据来源 https://github.com/xixilive/chinese_regions_db
 email: bastengao@gmail.com
 executables: []
 extensions: []
@@ -35,8 +35,9 @@ files:
 - Rakefile
 - lib/chinese_regions_rails.rb
 - lib/chinese_regions_rails/db.rb
+- lib/chinese_regions_rails/engine.rb
+- lib/chinese_regions_rails/helper.rb
 - lib/chinese_regions_rails/json_data_source.rb
-- lib/chinese_regions_rails/railtie.rb
 - lib/chinese_regions_rails/version.rb
 - lib/dump_json.rb
 - lib/generators/chinese_regions/install_generator.rb
@@ -66,12 +67,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: "中国省市区县数据库"
+summary: 中国省市区县数据库
 test_files:
 - spec/chinese_regions_rails/db_spec.rb
 - spec/chinese_regions_rails/json_data_source_spec.rb
 - spec/helper.rb
-has_rdoc: 

data/lib/chinese_regions_rails/railtie.rb

@@ -1,12 +0,0 @@
-require "rails"
-
-module ChineseRegionsRails
-
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      # 加载 /lib/tasks/***.rake 文件
-      Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each { |f| load f }
-    end
-  end
-
-end