on_the_map 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,47 @@
+source "http://rubygems.org"
+
+gem 'mongoid',    '>= 4',     github: 'mongoid/mongoid'
+gem 'sugar-high', '~> 0.7.3', github: 'kristianmandrup/sugar-high'
+
+gem 'hashie',     '~> 1.2'
+gem 'concerned',  '~> 0.1.3'
+
+gem "rspec",      ">= 2.12.0", group: [:test, :development]
+
+group :test do
+  gem 'rails', '>= 4.0.0.beta1', github: 'rails/rails' # '>= 3.1' #
+  gem 'geocoder'
+  gem 'mongoid_geospatial'
+  gem 'mongoid_indexing',   '~> 0.1.2'
+
+  gem 'gmaps4rails',        '>= 2.0.0.pre', github: 'apneadiving/Google-Maps-for-Rails'
+  # gem 'gmaps-autocomplete-rails'  
+
+  # time travel
+  # gem 'timecop',  '~> 0.3.5', :git => 'git://github.com/change/timecop.git'
+  gem 'delorean', '~> 1.1.1'
+
+  gem 'cutter',   '~> 0.8.2'
+
+  # data store
+  gem 'database_cleaner',   '>= 0.8'
+
+  gem 'factory_girl'
+
+  # Fake data
+  gem 'ffaker', '>= 1.14'
+  gem 'fakeweb'
+
+  gem 'shoulda'         
+  gem 'shoulda-matchers'
+
+  # http://railsapps.github.com/tutorial-rails-mongoid-devise.html
+  # gem 'mongoid-rspec', '>= 1.7', github: 'evansagge/mongoid-rspec'
+end
+
+group :development do
+  gem "rdoc",     ">= 3.1"
+  gem "bundler",  ">= 1.1.0"
+  gem "jeweler",  ">= 1.8.4"
+  gem "simplecov",">= 0.5"
+end

data/Gemfile.lock

@@ -0,0 +1,187 @@
+GIT
+  remote: git://github.com/apneadiving/Google-Maps-for-Rails.git
+  revision: 3ff52deb455e1077c9f60660486fcd38f78e737f
+  specs:
+    gmaps4rails (2.0.0.pre)
+
+GIT
+  remote: git://github.com/kristianmandrup/sugar-high.git
+  revision: a664566b1ae94a404553c2fe2434165e0c5f550b
+  specs:
+    sugar-high (0.7.3)
+
+GIT
+  remote: git://github.com/mongoid/mongoid.git
+  revision: c2170560124b95c11f03f0753b0b9cc89ff80719
+  specs:
+    mongoid (4.0.0)
+      activemodel (~> 4.0.0.beta)
+      moped (~> 1.4.2)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+
+GIT
+  remote: git://github.com/rails/rails.git
+  revision: b359c5db9f0e7dfb2cbf34362a9b310cf5aadd3a
+  specs:
+    actionmailer (4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      mail (~> 2.5.3)
+    actionpack (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+    activerecord (4.0.0.beta1)
+      activemodel (= 4.0.0.beta1)
+      activerecord-deprecated_finders (~> 0.0.3)
+      activesupport (= 4.0.0.beta1)
+      arel (~> 4.0.0.beta1)
+    activesupport (4.0.0.beta1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.33)
+    rails (4.0.0.beta1)
+      actionmailer (= 4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      activerecord (= 4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0.beta1)
+      sprockets-rails (~> 2.0.0.rc3)
+    railties (4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.17.0, < 2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord-deprecated_finders (0.0.3)
+    arel (4.0.0.beta1)
+    atomic (1.0.1)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    builder (3.1.4)
+    chronic (0.9.1)
+    colorize (0.5.8)
+    concerned (0.1.5)
+    cutter (0.8.9)
+      colorize (>= 0.5)
+    database_cleaner (0.9.1)
+    delorean (1.1.1)
+      chronic
+    diff-lcs (1.2.1)
+    erubis (2.7.0)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    fakeweb (1.3.0)
+    ffaker (1.15.0)
+    geocoder (1.1.6)
+    git (1.2.5)
+    hashie (1.2.0)
+    hike (1.2.1)
+    i18n (0.6.4)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    mime-types (1.21)
+    minitest (4.6.2)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    mongoid_geospatial (2.7.2)
+      activesupport (>= 3.2)
+      mongoid (>= 3.0.0)
+    mongoid_indexing (0.1.2)
+      mongoid (>= 3)
+      moped (>= 1.4)
+      rails (>= 3.1)
+    moped (1.4.3)
+    multi_json (1.6.1)
+    origin (1.0.11)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sprockets (2.9.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0.rc3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.17.0)
+    thread_safe (0.1.0)
+      atomic
+    tilt (1.3.4)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.36)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.1.0)
+  concerned (~> 0.1.3)
+  cutter (~> 0.8.2)
+  database_cleaner (>= 0.8)
+  delorean (~> 1.1.1)
+  factory_girl
+  fakeweb
+  ffaker (>= 1.14)
+  geocoder
+  gmaps4rails (>= 2.0.0.pre)!
+  hashie (~> 1.2)
+  jeweler (>= 1.8.4)
+  mongoid (>= 4)!
+  mongoid_geospatial
+  mongoid_indexing (~> 0.1.2)
+  rails (>= 4.0.0.beta1)!
+  rdoc (>= 3.1)
+  rspec (>= 2.12.0)
+  shoulda
+  shoulda-matchers
+  simplecov (>= 0.5)
+  sugar-high (~> 0.7.3)!

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Kristian Mandrup
+
+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,70 @@
+# On The Map
+
+Mongoid concerns for putting models "on the map".
+
+Contains various useful concern modules for: 
+
+* position
+* address
+* geo-coding
+* placing model on a map
+* geo spatial indexing of position
+* geo spatial searching on position
+
+* Adressable
+
+### Adressable
+
+* embeds an address on the model
+* adds delegate methods to all embedded address fields
+* adds `full_address` method that returns full adress from concatenation of all fields
+
+### GeoLocatable
+
+* includes `addressable` and `positionable` concerns
+* performs geocoding after an address is created or updated
+* adds `latitude` and `longitude` methods to model
+
+### Mappable
+
+* include `Gmaps4rails::ActsAsGmappable`
+* adds field `normalized_address` to store address calculated and returned by Google Maps geo-coding
+* adds method `gmaps4rails_address` which returns main adress for use in geo-coding
+
+### Positionable
+
+* includes `Mongoid::Geospatial` into the model to make GeoSpatial helpers available directly on the model
+* Adds geo_field `position` (macro from Mongoid GeoSpatial)
+* adds spatial indexing for position field
+
+* positon field is indexed and used in geo-searches (fx find points near a point)
+
+## Usage
+
+```ruby
+  include_concerns :addressable,    from: :on_the_map
+  include_concerns :mappable,       from: :on_the_map
+  include_concerns :positionable,   from: :on_the_map
+
+  include_concerns :geo_locatable,  from: :on_the_map
+```
+
+See the specs for examples on how to use these concerns. 
+
+Note: There is room for improvement ;)
+
+## Contributing to on_the_map
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "on_the_map"
+  gem.homepage = "http://github.com/kristianmandrup/on_the_map"
+  gem.license = "MIT"
+  gem.summary = %Q{Pre-baked Mongoid concerns to put models on the map}
+  gem.description = %Q{Makes it easy to add functionality to models related to geocoding, addressing and placing them as pins on a map}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "on_the_map #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/address.rb

@@ -0,0 +1,71 @@
+class Address
+  # include BasicDocument
+  include Mongoid::Document
+  include Mongoid::Dirty
+
+  after_update :perform_geocoding
+
+  def self.geo_address_fields
+    %w{city state state_code province province_code postal_code country country_code}
+  end
+
+  def self.all_geo_address_fields
+    geo_address_fields + %w{latitude longitude}
+  end
+  
+  def self.address_fields
+    %w{street number floor_adr} + geo_address_fields
+  end
+
+  address_fields.each do |name|
+    field name, type: String    
+  end
+
+  field :full, type: String, default: ""
+
+  embedded_in :addressable, polymorphic: true
+
+  # validates :street, presence: true
+
+  before_create :set_defaults
+
+  def floor
+    floor_adr.to_i
+  end
+
+  def region
+    state || province
+  end
+
+  def xtra_fields
+    [:floor_adr]
+  end
+
+  def to_s
+    Address.address_fields.inject("") do |res, name|
+      res << "#{name}: #{send(name)}\n"
+    end
+  end
+
+  def geolocatable?
+    !full.blank?
+  end
+
+  def perform_geocoding
+    return unless geolocatable?
+    addressable.perform_geocoding if addressable.respond_to? :perform_geocoding
+  end
+  alias_method :perform_geocoding!, :perform_geocoding  
+
+  protected
+
+  def set_defaults
+    write_attribute :country_code, 'DK'
+  end
+
+  def set_full
+    self.full = Address.address_fields.select do |name|
+      !send(name).blank?
+    end.map{|name| send(name) }.join(', ')
+  end
+end

data/lib/on_the_map/addressable.rb

@@ -0,0 +1,62 @@
+require 'address'
+
+module OnTheMap
+  module Addressable
+    extend ActiveSupport::Concern
+
+    included do
+  		embeds_one :address,  as: :addressable
+
+      Address.address_fields.each do |fname|
+        delegate fname, to: :address
+
+        meth_name = "#{fname}="
+
+        define_method meth_name do |value|
+          # create new empty address if none defined
+          self.address ||= Address.new 
+
+          unless value.to_s.strip.blank?
+            # set address field
+            self.address.send(meth_name, value)
+
+            # update full address
+            self.address.send :set_full
+
+            perform_geocoding if perform_geocoding? fname
+
+            address.save!
+          end
+        end
+      end
+
+      delegate :region, to: :address              
+    end
+
+    def perform_geocoding? name
+      return unless respond_to? :perform_geocoding
+      geocode_field?(name)    
+    end
+
+    def set_address hash
+      adr = Hashie::Mash.new hash
+      Address.address_fields.each do |name|
+        self.send("#{name}=", adr.send(name)) if adr.send(name)
+      end
+    end
+
+    def full_address
+      self.address.full
+    end  
+
+    def floor_adr= adr
+      self.address.floor_adr = adr if address
+    end
+
+    protected
+
+    def geocode_field? name
+      [:city, :region].include? name.to_sym
+    end
+  end
+end

data/lib/on_the_map/geo_locatable.rb

@@ -0,0 +1,95 @@
+require 'on_the_map/addressable'
+require 'on_the_map/positionable'
+
+module OnTheMap
+  module GeoLocatable
+    extend ActiveSupport::Concern
+
+    included do
+      include_concerns :addressable, :positionable, from: 'OnTheMap'
+      
+      include Geocoder::Model::Mongoid
+
+      after_create :perform_geocoding
+      after_update :perform_geocoding
+
+      field :geocoded, type: Boolean, default: false
+      alias_method :geocoded?, :geocoded
+
+      geocoded_by :full_address, coordinates: :position, skip_index: true do |obj,results|
+        if geo = results.first 
+          if geo.latitude && geo.longitude
+            obj.send(:geocoding_started!)
+
+            Address.geo_address_fields.each do |fname|
+              geo_value = geo.send(fname)
+              obj.send("#{fname}=", geo_value) unless geo_value.blank?
+            end
+
+            obj.position = [geo.longitude, geo.latitude]
+
+            obj.geocoded = true
+
+            if obj.respond_to? :gmaps
+              obj.gmaps = true 
+            end
+
+            obj.send(:geocoding_done!)
+          end
+        end        
+      end
+
+      # after_validation :geocode
+
+      # reverse_geocoded_by :latitude, :longitude #, :address => :full_address
+
+      # FROM: https://github.com/alexreisner/geocoder
+
+      # reverse_geocoded_by :coordinates
+      # after_validation :reverse_geocode  # auto-fetch address
+      # Once you've set up your model you'll need to create the necessary spatial indices in your database:
+
+      # rake db:mongoid:create_indexes
+      # Be sure to read Latitude/Longitude Order in the Notes on MongoDB section below on how to properly retrieve latitude/longitude coordinates from your objects.      
+    end
+
+    def latitude
+      perform_geocoding unless position
+      position[1] if position
+    end
+    alias_method :lat, :latitude
+
+    def longitude
+      perform_geocoding unless position
+      position[0] if position
+    end
+    alias_method :lng, :longitude
+
+    def geocodable?
+      !position && geolocatable? || address.changed?
+    end
+
+    def geolocatable?
+      address && address.geolocatable?
+    end
+
+    def perform_geocoding
+      geocode if geocodable? && !geocoding?
+    end
+    alias_method :perform_geocoding!, :perform_geocoding
+
+    def geocoding?
+      @geocoding_started == true
+    end
+
+    protected
+
+    def geocoding_started!
+      @geocoding_started = true
+    end
+
+    def geocoding_done!
+      @geocoding_started = false
+    end
+  end
+end

data/lib/on_the_map/mappable.rb

@@ -0,0 +1,47 @@
+module OnTheMap
+  module Mappable  
+    extend ActiveSupport::Concern
+
+    included do
+      include ::Gmaps4rails::ActsAsGmappable
+
+      include_concerns :geo_locatable, :positionable, from: 'OnTheMap'
+
+      # see https://github.com/apneadiving/Google-Maps-for-Rails/wiki/Model-Customization
+      # https://github.com/apneadiving/Google-Maps-for-Rails/wiki/Mongo%C3%AFd
+      acts_as_gmappable position: :position,
+                        process_geocoding: :gmaps_geocode?, # 
+                        address:"gmaps4rails_address", normalized_address: "normalized_address",
+                        msg: "Sorry, not even Google could figure out where that is"
+
+      field :gmaps, type: Boolean
+
+      field :normalized_address # used to save address matched by Google
+    end
+
+    # When Geo Coding is to be performed by Gmaps4rails
+    # Leave it up to geocoder!
+    def gmaps_geocode?
+      # has_address? && (has_position? || has_geo_coords?) && 
+      false # (!address.blank? && (lat.blank? || lng.blank?)) || position_changed?      
+    end
+
+    def has_geo_coords?
+      respond_to?(:latitude) && latitude && respond_to?(:longitude) && longitude
+    end
+
+    def has_position?
+      respond_to?(:position) && position
+    end
+
+    def has_address?
+      respond_to?(:address) && address
+    end
+
+    #describe how to retrieve the address from your model, if you use directly a db column, you can dry your code, see wiki 
+    def gmaps4rails_address
+      return address_str if respond_to? :address_str # Use GeoLocatable if such exists
+      "#{address.street}, #{address.city}, #{address.country}" 
+    end  
+  end
+end

data/lib/on_the_map/positionable.rb

@@ -0,0 +1,29 @@
+require 'mongoid_geospatial'
+
+module OnTheMap
+  module Positionable
+    extend ActiveSupport::Concern
+
+    included do
+      include Mongoid::Geospatial
+
+      geo_field :position, :delegate => true
+
+      spatial_index :position
+      spatial_scope :position
+    end
+
+    def configure_positionable
+    end
+
+    protected
+
+    def longitude= x
+      position.x = x
+    end
+
+    def latitude= y
+      position.y = y
+    end
+  end
+end