unidom-geo-china 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4c698cb0b5f946d24d256fd7be15bbae5f4dc2e
+  data.tar.gz: 8a17f513dcdf0d8b31f971d39a0b8c8aadcaacf5
+SHA512:
+  metadata.gz: 6d26eb0dd473d5b37d42a81c1233007efdb67ecc88a93c44b6b9baca93e25b898fa72fe9b4d20027764ee71ddfbac17272ccca70a9e084607b78e813f641e345
+  data.tar.gz: 5bc709580f3ecfb7f9a7ed498d2739e0fd7014f7c021105091f5065d5ed12e39ac67b9809817d1fd03a66ff235c49e301e0dbf69e771de00da94ca81ef7830da

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Topbit Du
+
+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.md

@@ -0,0 +1,28 @@
+# Unidom Geo China 中国地理领域模型引擎
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/unidom-geo-china.svg)](https://badge.fury.io/rb/unidom-geo-china)
+
+Unidom (UNIfied Domain Object Model) is a series of domain model engines. The China Geo domain model engine includes the Region model and its migration.
+Unidom (统一领域对象模型)是一系列的领域模型引擎。中国地理领域模型引擎包括中国大陆的行政区划模型及其数据迁移脚本。
+
+## Usage in Gemfile
+```ruby
+gem 'unidom-geo-china'
+```
+
+## Run the Database Migration
+```shell
+rake db:migrate
+```
+
+## Import Data
+```shell
+bundle exec rake unidom:geo:china:import file=/china-region-data/NBS-county/20141031.csv from_date=2014-10-31 scheme_id= scheme_type=
+```
+
+## Call the Model
+```ruby
+Unidom::Geo::China::Region.root_level # All the 31 province-level regions including Beijing, Tianjin, etc.
+Unidom::Geo::China::Region.numeric_coded_as('120000').valid_at.alive.first # Tianjin (天津)
+```

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Unidom Geo China'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/unidom/geo/china/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/unidom/geo/china/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/unidom/geo/china/application_controller.rb

@@ -0,0 +1,2 @@
+class Unidom::Geo::China::ApplicationController < ActionController::Base
+end

data/app/helpers/unidom/geo/china/application_helper.rb

@@ -0,0 +1,2 @@
+module Unidom::Geo::China::ApplicationHelper
+end

data/app/models/unidom/geo/china/region.rb

@@ -0,0 +1,112 @@
+# Region 是中国行政区划。
+# 《GB/T 2260-2007 中华人民共和国行政区划代码》
+# 数字码采用三层六位层次码结构，按层次分别表示我国各
+#   省（自治区，直辖市，特别行政区）、
+#   市（地区，自治州，盟）、
+#   县（自治县、县级市、旗、自治旗、市辖区、林区、特区）。
+#   第1、2位数字：所在省份编码，表示省、自治区、直辖市、特别行政区。 
+#   第3、4位数字：所在省级市（县）编码，表示市、地区、自治州、盟、直辖市所辖市辖区、县汇总码、省（自治区）直辖县级行政区划汇总码。 
+#     01~20、51~70表示市，直辖市则01表示市区，02以后表示直辖市辖区内的郊县；
+#     21~50表示地区、自治州、盟；
+#     90表示省（自治区）直辖县级行政区划汇总码。
+#   第5、6位数字：所在地级县（市）编码，表示县、自治县、县级市、旗、自治旗、市辖区、林区、特区。
+#     01~20表示市辖区、地区（自治州、盟）辖县级市、市辖特区以及省（自治区）直辖县级行政区划中的县级市，01通常表示辖区汇总码；
+#     21~80表示县、自治县、旗、自治旗、林区、地区辖特区；
+#     81~99表示省（自治区）辖县级市。
+# 字母代码的编制原则和结构
+#   行政区划字母代码(简称字母码)遵循科学性、统一性、实用性编码原则，参照县及县以上行政区划名称的罗马字母拼写，取相应的字母编制。
+#   省、自治区、直辖市、特别行政区的字母码用两位大写字母表示。
+#   市、地区、自治州、盟、县、自治县、县级市、旗、自治旗、市辖区、林区、特区的字母码用三位大写字母表示。
+
+class Unidom::Geo::China::Region < ActiveRecord::Base
+
+  # MDUCG = MUNICIPALITY DIRECT UNDER CENTRAL GOVERNMENT
+  MDUCG_CODES = [ '11', '12', '31', '50' ].freeze
+
+  self.table_name = 'unidom_china_regions'
+
+  validates :numeric_code,    numericality: { integer_only: true }
+  validates :alphabetic_code, allow_blank: true, length: { minimum: 2 }
+  validates :name,            presence:    true, length: { maximum: self.columns_hash['name'].limit }
+
+  belongs_to :scheme,    polymorphic: true
+  has_many   :locations, class_name: 'Unidom::Geo::Location', as: :region
+
+  scope :scheme_is,      ->(scheme) { scheme.present? ? where(scheme: scheme) : scheme_id_is.scheme_type_is }
+  scope :scheme_id_is,   ->(scheme_id   = ::Unidom::Common::NULL_UUID) { where scheme_id:   scheme_id   }
+  scope :scheme_type_is, ->(scheme_type = ''                         ) { where scheme_type: scheme_type }
+
+  scope :name_is,       ->(name)           { where name:    name    }
+  scope :being_virtual, ->(virtual = true) { where virtual: virtual }
+
+  scope :root_level, -> { numeric_code_ending_with '0000' }
+
+  include Unidom::Common::Concerns::ModelExtension
+
+  def numeric_code_prefix
+    numeric_code[0..1]
+  end
+
+  def numeric_code_middle
+    numeric_code[2..3]
+  end
+
+  def numeric_code_suffix
+    numeric_code[4..5]
+  end
+
+  def numeric_code_middle_empty?
+    '00'==numeric_code_middle
+  end
+
+  def numeric_code_suffix_empty?
+    '00'==numeric_code_suffix
+  end
+
+  def district?
+    numeric_code_suffix.to_i<20
+  end
+
+  def under_mducg?
+    self.class::MDUCG_CODES.include? numeric_code_prefix
+  end
+
+  def mducg?
+    under_mducg? && numeric_code_middle_empty? && numeric_code_suffix_empty?
+  end
+
+  def super_regions
+    numeric_code_suffix_empty? ? (numeric_code_middle_empty? ? self.class.none : self.class.numeric_coded_as("#{numeric_code_prefix}0000")) : self.class.numeric_coded_as("#{numeric_code_prefix}#{numeric_code_middle}00")
+  end
+
+  def sub_regions
+    if numeric_code_suffix_empty?
+      prefix  = numeric_code_middle_empty? ? numeric_code_prefix : "#{numeric_code_prefix}#{numeric_code_middle}"
+      regions = self.class.numeric_code_starting_with(prefix).not_numeric_coded_as(numeric_code)
+      regions = regions.numeric_code_ending_with('00') if numeric_code_middle_empty?
+      regions
+    else
+      self.class.none
+    end
+  end
+
+  def full_name(separator = ' ')
+    final_name     = self.name
+    current_region = self
+    count          = 0
+    while current_region = current_region.super_regions.first
+      count += 1
+      final_name = "#{current_region.name}#{separator}#{final_name}" unless current_region.virtual?
+      break if count>5
+    end
+    final_name
+  end
+
+  def under?(region)
+    return false unless region.numeric_code_prefix==numeric_code_prefix
+    return false if     numeric_code_middle_empty?
+    return true  if     region.numeric_code_middle_empty?
+    numeric_code_suffix_empty? ? false : region.numeric_code_suffix_empty?
+  end
+
+end

data/app/views/layouts/unidom/geo/china/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Unidom Geo China</title>
+  <%= stylesheet_link_tag    'unidom/geo/china/application', media: 'all' %>
+  <%= javascript_include_tag 'unidom/geo/china/application' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Unidom::Geo::China::Engine.routes.draw do
+end

data/db/migrate/20010491560010_create_unidom_china_regions.rb

@@ -0,0 +1,35 @@
+class CreateUnidomChinaRegions < ActiveRecord::Migration
+
+  def change
+
+    create_table :unidom_china_regions, id: :uuid do |t|
+
+      t.references :scheme, type: :uuid, null: false,
+        polymorphic: { null: false, default: '', limit: 200 }
+
+      t.column :numeric_code, 'char(6)', null: false, default: '0'*6
+      t.string :alphabetic_code,         null: true,  default: nil, limit: 3
+
+      t.string  :name,    null: false, default: '', limit: 200
+      t.boolean :virtual, null: false, default: false
+
+      t.text :instruction
+      t.text :description
+
+      t.column   :state, 'char(1)', null: false, default: 'C'
+      t.datetime :opened_at,        null: false, default: ::Time.utc(1970)
+      t.datetime :closed_at,        null: false, default: ::Time.utc(3000)
+      t.boolean  :defunct,          null: false, default: false
+      t.jsonb    :notation,         null: false, default: {}
+
+      t.timestamps null: false
+
+    end
+
+    add_index :unidom_china_regions, :scheme_id
+    add_index :unidom_china_regions, [ :numeric_code,    :scheme_id, :scheme_type ], unique: true, name: 'index_unidom_china_regions_on_numeric_code_and_scheme'
+    add_index :unidom_china_regions, [ :alphabetic_code, :scheme_id, :scheme_type ], unique: true, name: 'index_unidom_china_regions_on_alphabetic_code_and_scheme'
+
+  end
+
+end

data/lib/tasks/data_tasks.rake

@@ -0,0 +1,64 @@
+desc 'unidom:geo:china:import Rake Task imports China regions from the given CSV file.'
+
+namespace :unidom do
+  namespace :geo do
+    namespace :china do
+
+      # bundle exec rake unidom:geo:china:import
+      #   file=/data.csv
+      #   from_date=2020-01-01
+      #   scheme_id=
+      #   scheme_type=
+      task import: :environment do
+
+        include ::Unidom::Common::DataHelper
+
+        file_name   = ENV['file']
+        scheme_id   = ENV['scheme_id']||::Unidom::Common::NULL_UUID
+        scheme_type = ENV['scheme_type']||''
+        opened_at   = parse_time ENV['from_date']
+
+        updated_count = 0
+        created_count = 0
+
+        region_entities = ::Unidom::Geo::China::Region.scheme_id_is(scheme_id).scheme_type_is(scheme_type).select('id, name, virtual, numeric_code, alphabetic_code, scheme_id, scheme_type, opened_at, closed_at, defunct, updated_at').to_a
+
+        each_csv_row file_name do |region|
+
+          numeric_code    = region['numeric_code']
+          alphabetic_code = region['alphabetic_code']
+
+          attributes = { name: region['name'], virtual: region['virtual'], scheme_id: scheme_id, scheme_type: scheme_type, opened_at: opened_at }
+          attributes[:alphabetic_code] = alphabetic_code if alphabetic_code.present?
+
+          if region_entities.present?
+            found_region_entities = region_entities.select { |region_entity| region_entity.numeric_code==numeric_code }
+            if found_region_entities.present?
+              found_region_entities.each do |found_region_entity|
+                found_region_entity.assign_attributes attributes
+                if found_region_entity.changed?
+                  found_region_entity.save!
+                  updated_count += 1
+                end
+              end
+            else
+              attributes[:numeric_code] = numeric_code
+              ::Unidom::Geo::China::Region.create! attributes
+              created_count += 1
+            end
+          else
+            attributes[:numeric_code] = numeric_code
+            ::Unidom::Geo::China::Region.create! attributes
+            created_count += 1
+          end
+
+        end
+
+        puts "#{created_count} China Regions were created. #{updated_count} China Regions were updated per CSV."
+        puts "#{created_count+updated_count} China Regions were handled totally."
+
+      end
+
+    end
+  end
+end

data/lib/unidom/geo/china.rb

@@ -0,0 +1,8 @@
+require 'unidom/geo/china/engine'
+
+module Unidom
+  module Geo
+    module China
+    end
+  end
+end

data/lib/unidom/geo/china/engine.rb

@@ -0,0 +1,17 @@
+module Unidom
+  module Geo
+    module China
+
+      class Engine < ::Rails::Engine
+
+        isolate_namespace ::Unidom::Geo::China
+
+        initializer :append_migrations do |app|
+          config.paths['db/migrate'].expanded.each { |expanded_path| app.config.paths['db/migrate'] << expanded_path } unless app.root.to_s.match root.to_s
+        end
+
+      end
+
+    end
+  end
+end

data/lib/unidom/geo/china/version.rb

@@ -0,0 +1,7 @@
+module Unidom
+  module Geo
+    module China
+      VERSION = '0.1'.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: unidom-geo-china
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Topbit Du
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unidom-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Unidom (UNIfied Domain Object Model) is a series of domain model engines.
+  The China Contact domain model engine includes Mobile Phone Number and its relative
+  models. Unidom (统一领域对象模型)是一系列的领域模型引擎。中国地理领域模型引擎包括中国大陆的行政区划及其相关的模型。
+email:
+- topbit.du@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/unidom/geo/china/application.js
+- app/assets/stylesheets/unidom/geo/china/application.css
+- app/controllers/unidom/geo/china/application_controller.rb
+- app/helpers/unidom/geo/china/application_helper.rb
+- app/models/unidom/geo/china/region.rb
+- app/views/layouts/unidom/geo/china/application.html.erb
+- config/routes.rb
+- db/migrate/20010491560010_create_unidom_china_regions.rb
+- lib/tasks/data_tasks.rake
+- lib/unidom/geo/china.rb
+- lib/unidom/geo/china/engine.rb
+- lib/unidom/geo/china/version.rb
+homepage: https://github.com/topbitdu/unidom-geo-china
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Unidom China Geo Domain Model Engine 中国地理领域模型引擎
+test_files: []