unidom-geo-china 0.3.2 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c19904dace0585855d7b4eaab8f6aeafe5927de6
-  data.tar.gz: e3b4b154e6d62ffd228469132fa4d432745dbfa6
+  metadata.gz: 52810a4565400a8aef20f4bd31a99ca22e24d71c
+  data.tar.gz: 67f3ed45ab394f6ef0b0b5a5b1e448c8b3452f2b
 SHA512:
-  metadata.gz: 4773966eaa6c75d68a6c321186893deb575d527b5b3a854b91a9bcb037b782d33c5305ddc0a3a202aa6812879ade8aa471adca20871706e26b1b8cf3bc6ca76d
-  data.tar.gz: 9c5c243018947ee645d5270401b8c78962202e24125d5b57b5d3933b0e65f96624697d25f1013a36aa1bd4054dd9e87408f40c2feb2c7d24b5d7d96df1fa2b4c
+  metadata.gz: 25ab5059fac40274cad8b47112d1f0ee9745da664880b5bd9a7d89e000e5df3ba37e673a6e2b0771d10a071bddae4b8d7a0d912ed63712ae9d31386c6125343f
+  data.tar.gz: 0245d3e995dfd93c8f6359d13e11f158e295bb1815f347a12415063f0ca3a6af97fb266f373cebe16200b1bb64895115895f92b779d008d3906c55eb4519ca06

data/README.md

@@ -6,28 +6,43 @@
 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 (统一领域对象模型)是一系列的领域模型引擎。中国地理领域模型引擎包括中国大陆的行政区划模型及其数据迁移脚本。
 
+
+
 ## Recent Update
+
 Check out the [Road Map](ROADMAP.md) to find out what's the next.
 Check out the [Change Log](CHANGELOG.md) to find out what's new.
 
+
+
 ## Usage in Gemfile
+
 ```ruby
 gem 'unidom-geo-china'
 ```
 
+
+
 ## Run the Database Migration
+
 ```shell
 rake db:migrate
 ```
 The migration versions start with 2001049156.
 
+
+
 ## Import Data
+
 ```shell
 bundle exec rake unidom:geo:china:region:import file=/china-region-data/NBS-county/20141031.csv from_date=2014-10-31 scheme_id= scheme_type=
 bundle exec rake unidom:geo:china:town:import file=/china-region-data/NBS-town/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 (天津)
@@ -35,3 +50,30 @@ Unidom::Geo::China::Region.numeric_coded_as('120000').valid_at.alive.first # Tia
 active_locations = region.locations.valid_at.alive
 active_towns     = region.towns.valid_at.alive
 ```
+
+The Region model has a lot of domain knowlegde of the China regions.
+- ```region.numeric_code_middle_empty?``` indicates whether the ```region``` is a province. 判断行政区划是否是一个省、直辖市、或者自治区。
+- ```!region.numeric_code_middle_empty?&&region.numeric_code_suffix_empty?``` indicates whether the ```region``` is a city. 判断行政区划是否是一个地级市、地区、自治州、盟。
+- ```!region..numeric_code_suffix_empty?``` indicates whether the ```region``` is a county. 判断行政区划是否是一个自治县、县级市、旗、自治旗、市辖区、林区、特区。
+- ```region.mducg?``` indicates whether the ```region``` is a municipality direct under central government. 判断行政区划是否是一个直辖市。
+- 
+```region.under_mducg?``` indicates whether the ```region``` is under any municipality direct under central government. 判断行政区划是否是一个直辖市的下级行政区划。
+- ```region.under? another_region``` indicates the ```region``` is under the given another_region. 判断行政区划是否是一个给定行政区划的下级（含直接和间接下级）。
+- ```region.super_regions``` returns a scope for the super regions of the ```region```. 返回找到 ```region``` 直接上级行政区划的查询 scope。
+- ```region.sub_regions``` returns a scope for the sub regions of the ```region```. 返回找到 ```region``` 直接下级行政区划的查询 scope。
+
+
+
+## Include the Concerns
+```ruby
+include Unidom::Geo::China::Concerns::AsInferiorRegion
+include Unidom::Geo::China::Concerns::AsSuperiorRegion
+```
+
+### As Inferior Region
+The As Inferior Region do the following tasks for the includer automatically:  
+1. Define the #super_regions method as: ``super_regions``
+
+### As Superior Region
+The As Superior Region do the following tasks for the includer automatically:  
+1. Define the #sub_regions method as: ``sub_regions``

data/app/models/unidom/geo/china/concerns/as_inferior_region.rb

@@ -0,0 +1,16 @@
+module Unidom::Geo::China::Concerns::AsInferiorRegion
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    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
+
+  end
+
+  module ClassMethods
+  end
+
+end

data/app/models/unidom/geo/china/concerns/as_superior_region.rb

@@ -0,0 +1,23 @@
+module Unidom::Geo::China::Concerns::AsSuperiorRegion
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    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
+
+  end
+
+  module ClassMethods
+  end
+
+end

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

@@ -27,6 +27,8 @@ class Unidom::Geo::China::Region < ActiveRecord::Base
 
   include Unidom::Common::Concerns::ModelExtension
   include Unidom::Geo::Concerns::AsRegion
+  include Unidom::Geo::China::Concerns::AsInferiorRegion
+  include Unidom::Geo::China::Concerns::AsSuperiorRegion
 
   validates :numeric_code,    numericality: { integer_only: true }
   validates :alphabetic_code, allow_blank:  true, length: { minimum: 2 }
@@ -34,9 +36,6 @@ class Unidom::Geo::China::Region < ActiveRecord::Base
 
   belongs_to :scheme, polymorphic: true
 
-  #has_many :locations, class_name: 'Unidom::Geo::Location', as:     :region
-  #has_many :locatings, through:    :locations,              source: :locatings
-
   has_many :towns, class_name: 'Unidom::Geo::China::Town'
 
   scope :scheme_is,      ->(scheme) { scheme.present? ? where(scheme: scheme) : scheme_id_is.scheme_type_is }
@@ -80,6 +79,7 @@ class Unidom::Geo::China::Region < ActiveRecord::Base
     under_mducg? && numeric_code_middle_empty? && numeric_code_suffix_empty?
   end
 
+=begin
   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
@@ -94,6 +94,7 @@ class Unidom::Geo::China::Region < ActiveRecord::Base
       self.class.none
     end
   end
+=end
 
   def full_name(separator = ' ')
     final_name     = self.name

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-geo-china
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: '0.4'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unidom-common
@@ -40,6 +40,8 @@ files:
 - 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/concerns/as_inferior_region.rb
+- app/models/unidom/geo/china/concerns/as_superior_region.rb
 - app/models/unidom/geo/china/region.rb
 - app/models/unidom/geo/china/town.rb
 - app/views/layouts/unidom/geo/china/application.html.erb