unidom-geo

Unidom Geo 地理领域模型引擎

Unidom (UNIfied Domain Object Model) is a series of domain model engines. The Geo domain model engine includes Town and Location models. Unidom (统一领域对象模型)是一系列的领域模型引擎。地理领域模型引擎包括乡镇和街道地址的模型。

Recent Update

Check out the Road Map to find out what's the next. Check out the Change Log to find out what's new.

Usage in Gemfile:

gem 'unidom-geo'

Run the Database Migration:

rake db:migrate

The migration versions start with 200104.

Call the Model:

Unidom::Geo::Location.valid_at.alive.first.region

active_locatings = location.locatings.valid_at.alive

# Locate: associate a shop, an estate, or a facility with a location
location.locate! shop, by: person
# or
Unidom::Geo::Locating.locate! location: location, located: shop

# Determine whether a shop was located to a given location at a given time.
location.locate? shop, at: Time.now

Include the Concerns:

include Unidom::Geo::Concerns::AsLocated
include Unidom::Geo::Concerns::AsLocator
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)
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
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'
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.

# config/initializers/unidom.rb
Unidom::Common.configure do |options|

  options[:neglected_namespaces] = %w{
    Unidom::Geo
  }

end

RSpec examples

RSpec example manifest (run automatically)

# spec/models/unidom_spec.rb
require 'unidom/geo/models_rspec'

# spec/types/unidom_spec.rb
require 'unidom/geo/types_rspec'

# spec/validators/unidom_spec.rb
require 'unidom/geo/validators_rspec'

RSpec shared examples (to be integrated)

# lib/unidom.rb
def initialize_unidom

  Unidom::Party::Person.class_eval do
    include Unidom::Geo::Concerns::AsLocator
  end

  Unidom::Party::Shop.class_eval do
    include Unidom::Geo::Concerns::AsLocated
  end

  Unidom::Geo::China::Region.class_eval do
    include Unidom::Geo::Concerns::AsRegion
  end

end

# spec/rails_helper.rb
require 'unidom'
initialize_unidom

# spec/support/unidom_rspec_shared_examples.rb
require 'unidom/geo/rspec_shared_examples'

# spec/models/unidom/party/person_spec.rb
describe Unidom::Party::Person, type: :model do

  context do

    model_attributes = {
      name: 'Tim'
    }

    located_attributes = {
      name: 'Walmart'
    }
    located = Unidom::Party::Shop.create! located_attributes

    it_behaves_like 'Unidom::Geo::Concerns::AsLocator', model_attributes, located

  end

end

# spec/models/unidom/party/shop_spec.rb
describe Unidom::Party::Shop, type: :model do

  context do

    model_attributes = {
      name: 'Some Shop'
    }

    location_attributes = {
      postal_address: '#1 Some Street',
      postal_code:    '610000',
      region_id:      SecureRandom.uuid,
      region_type:    'Unidom::Geo::Region::Mock'
    }
    location = Unidom::Geo::Location.create! location_attributes

    locator_attributes = {
      name: 'Tim'
    }
    locator = Unidom::Party::Person.create! locator_attributes

    it_behaves_like 'Unidom::Geo::Concerns::AsLocated', model_attributes, location, locator

  end

end

# spec/models/unidom/geo/china/region_spec.rb
describe Unidom::Geo::China::Region, type: :model do

  context do

    model_attributes = {
      numeric_code: '999897',
      name:         'Some Region',
      scheme_id:    SecureRandom.uuid,
      scheme_type:  'Unidom::Geo::China::Scheme::Mock'
    }

    it_behaves_like 'Unidom::Geo::Concerns::AsRegion', model_attributes

  end

end