unidom-geo 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de985c80fc44a553c419760277bd898648418822
-  data.tar.gz: 054d7ae8e6270cd72999fb9437f172124807add3
+  metadata.gz: ec75e08c0307987c1cacab5fea9dbf31588fcd50
+  data.tar.gz: b86578703813ca367aad0f47f46023b2661e2c4f
 SHA512:
-  metadata.gz: 832ea4737e1ecb94dd8f3d1dbdfe4e17b560a09cd189e0dfa7ec9f3c10a160c38c642656f23fe0bc2c90d0bb2c134498da4615732aaa4890ab0dd0596e1ad656
-  data.tar.gz: e2dad2bc6c0c2ba21b31c30356a30a22e6d5cf4b71c1517cce315d59a15ebb5eae0d50b84b3e84987323d5507b7d0fa69e278427717bc19b7012ae1b9abb3a8f
+  metadata.gz: 6234b6e1cf61e8437a1bde7ff3c270bc62d3665fcbf47e3259deef7dee7be212cd35620ab528993b19a982251cb4c7ae31b62b56ef8dee333a778e1bcc7557d2
+  data.tar.gz: 375120d30f4cc6941e003b389516ec8041529d6097063c579fc39fb26a0fc0503052608f39ae900da2d3289cf4d73b6ec70aa29f6ed38bda0d95ef7a5b5feca4

data/README.md

@@ -1,6 +1,8 @@
 # Unidom Geo 地理领域模型引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/unidom-geo/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/unidom-geo.svg)](https://badge.fury.io/rb/unidom-geo)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/unidom-geo.svg)](https://gemnasium.com/github.com/topbitdu/unidom-geo)
 
@@ -61,21 +63,37 @@ include Unidom::Geo::Concerns::AsRegion
 
 ### As Located concern
 
-The As Located concern do the following tasks for the includer automatically:  
-1. Define the has_many :locatings macro as: ``has_many :locatings, class_name: 'Unidom::Geo::Locating', as: :located``  
-2. Define the has_many :locations macro as: ``has_many :locations, through: :locatings, source: :location``  
-3. Define the #is_located! method as: ``is_located!(to: nil, by: nil, at: Time.now)``  
+The As Located concern do the following tasks for the includer automatically:
+1. Define the has_many :locatings macro as: ``has_many :locatings, class_name: 'Unidom::Geo::Locating', as: :located``
+2. Define the has_many :locations macro as: ``has_many :locations, through: :locatings, source: :location``
+3. Define the #is_located! method as: ``is_located!(to: nil, by: nil, at: Time.now)``
 4. Define the #is_located? method as: ``is_located?(to: nil, at: Time.now)``
 
 ### As Locator concern
 
-The As Locator concern do the following tasks for the includer automatically:  
-1. Define the has_many :locatings macro as: ``has_many :locatings, class_name: 'Unidom::Geo::Locating', as: :locator``  
-2. Define the has_many :locations macro as: ``has_many :locations, through: :locatings, source: :location``  
+The As Locator concern do the following tasks for the includer automatically:
+1. Define the has_many :locatings macro as: ``has_many :locatings, class_name: 'Unidom::Geo::Locating', as: :locator``
+2. Define the has_many :locations macro as: ``has_many :locations, through: :locatings, source: :location``
 3. Define the #locate! method as: ``locate!(it, to: nil, at: Time.now)``
 
 ### As Region concern
 
-The As Region concern do the following tasks for the includer automatically:  
-1. Define the has_many :locations macro as: ``has_many :locations, class_name: 'Unidom::Geo::Location'``  
+The As Region concern do the following tasks for the includer automatically:
+1. Define the has_many :locations macro as: ``has_many :locations, class_name: 'Unidom::Geo::Location'``
 2. Define the has_many :locatings macro as: ``has_many :locatings, through: :locations, source: :locatings``
+
+
+
+## Disable the Model & Migration
+
+If you only need the app components other than models, the migrations should be neglected, and the models should not be loaded.
+```ruby
+# config/initializers/unidom.rb
+Unidom::Common.configure do |options|
+
+  options[:neglected_namespaces] = %w{
+    Unidom::Geo
+  }
+
+end
+```

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

@@ -1,3 +1,6 @@
+##
+# Application controller 是模块内所有控制器的基类。
+
 class Unidom::Geo::ApplicationController < ActionController::Base
   protect_from_forgery with: :exception
 end

data/app/jobs/unidom/geo/application_job.rb

@@ -1,2 +1,5 @@
+##
+# Application job 是模块内所有异步任务的基类。
+
 class Unidom::Geo::ApplicationJob < ActiveJob::Base
 end

data/app/mailers/unidom/geo/application_mailer.rb

@@ -1,3 +1,6 @@
+##
+# Application mailer 是模块内所有电子邮件发送类的基类。
+
 class Unidom::Geo::ApplicationMailer < ActionMailer::Base
   default from: 'from@example.com'
   layout 'mailer'

data/app/models/unidom/geo/application_record.rb

@@ -1,3 +1,6 @@
+##
+# Application record 是模块内所有模型的抽象基类。
+
 class Unidom::Geo::ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 end

data/app/models/unidom/geo/concerns/as_located.rb

@@ -10,10 +10,18 @@ module Unidom::Geo::Concerns::AsLocated
     has_many :locatings, class_name: 'Unidom::Geo::Locating', as:     :located
     has_many :locations, through:    :locatings,              source: :location
 
+    ##
+    # 将当前位置与地标 to 关联起来。如：
+    # location = Unidom::Geo::Location.first
+    # shop.is_located! to: location, by: current_person
     def is_located!(to: nil, by: nil, at: Time.now)
       locatings.location_is(to).valid_at(now: at).alive.first_or_create! locator: by, opened_at: at
     end
 
+    ##
+    # 检查当前位置与地标 to 在指定的时间 at （缺省是当前时间）是否关联起来了。
+    # location = Unidom::Geo::Location.first
+    # 如： shop.is_located? to: location, at: Time.now
     def is_located?(to: nil, at: Time.now)
       locatings.location_is(to).valid_at(now: at).alive.exists?
     end

data/app/models/unidom/geo/locating.rb

@@ -29,4 +29,4 @@ class Unidom::Geo::Locating < Unidom::Geo::ApplicationRecord
     self.located_is(located).location_is(location).valid_at.alive.first_or_create! attributes
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Geo::Locating'

data/app/models/unidom/geo/location.rb

@@ -39,4 +39,4 @@ class Unidom::Geo::Location < Unidom::Geo::ApplicationRecord
     locatings.located_is(located).valid_at(now: at).alive.exists?
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Geo::Location'

data/lib/unidom/geo/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Geo
-    VERSION = '1.4.4'.freeze
+    VERSION = '1.4.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-geo
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.5
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unidom-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
 description: Unidom (UNIfied Domain Object Model) is a series of domain model engines.
   The Geo domain model engine includes Region, Town, and Location models. Unidom (统一领域对象模型)是一系列的领域模型引擎。地理领域模型引擎包括行政区划、乡镇和街道地址的模型。
 email: