on_the_map 0.1.0

data/on_the_map.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "on_the_map"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = "2013-03-04"
+  s.description = "Makes it easy to add functionality to models related to geocoding, addressing and placing them as pins on a map"
+  s.email = "kmandrup@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/address.rb",
+    "lib/on_the_map.rb",
+    "lib/on_the_map/addressable.rb",
+    "lib/on_the_map/geo_locatable.rb",
+    "lib/on_the_map/mappable.rb",
+    "lib/on_the_map/positionable.rb",
+    "on_the_map.gemspec",
+    "spec/address_spec.rb",
+    "spec/on_the_map/addressable_spec.rb",
+    "spec/on_the_map/geo_locatable_spec.rb",
+    "spec/on_the_map/geo_locatable_valid_spec.rb",
+    "spec/on_the_map/mappable_spec.rb",
+    "spec/on_the_map/positionable_spec.rb",
+    "spec/on_the_map_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/gmaps_lookup_stubs.rb"
+  ]
+  s.homepage = "http://github.com/kristianmandrup/on_the_map"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Pre-baked Mongoid concerns to put models on the map"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongoid>, [">= 4"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.7.3"])
+      s.add_runtime_dependency(%q<hashie>, ["~> 1.2"])
+      s.add_runtime_dependency(%q<concerned>, ["~> 0.1.3"])
+      s.add_development_dependency(%q<rspec>, [">= 2.12.0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.1"])
+      s.add_development_dependency(%q<bundler>, [">= 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0.5"])
+    else
+      s.add_dependency(%q<mongoid>, [">= 4"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.7.3"])
+      s.add_dependency(%q<hashie>, ["~> 1.2"])
+      s.add_dependency(%q<concerned>, ["~> 0.1.3"])
+      s.add_dependency(%q<rspec>, [">= 2.12.0"])
+      s.add_dependency(%q<rdoc>, [">= 3.1"])
+      s.add_dependency(%q<bundler>, [">= 1.1.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0.5"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, [">= 4"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.7.3"])
+    s.add_dependency(%q<hashie>, ["~> 1.2"])
+    s.add_dependency(%q<concerned>, ["~> 0.1.3"])
+    s.add_dependency(%q<rspec>, [">= 2.12.0"])
+    s.add_dependency(%q<rdoc>, [">= 3.1"])
+    s.add_dependency(%q<bundler>, [">= 1.1.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0.5"])
+  end
+end
+

data/spec/address_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Address do
+  pending 'todo'
+end

data/spec/on_the_map/addressable_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'on_the_map/addressable'
+
+class MyAddress
+  include Mongoid::Document
+  include OnTheMap::Addressable
+end
+
+class MyGeoCodedAddress
+  include Mongoid::Document  
+  include OnTheMap::Addressable
+
+  def perform_geocoding
+  end
+end
+
+describe OnTheMap::Addressable do
+  subject { address }
+
+  context 'blank/empty address' do
+    let(:address) { MyGeoCodableAddress.create street: '', city: ''  }
+
+    it 'should have a blank full address' do
+      expect(subject.address.full).to be_blank
+    end
+
+    it 'should not be geolocatable' do
+      expect(subject.geolocatable?).to be false
+    end
+  end
+
+  let(:address) { MyAddress.create street: 'maglekildevej 18, 4th', city: '1853 Frederiksberg C'  }
+
+  context 'without geocoding' do
+    Address.address_fields.each do |fname|
+      describe fname do
+        it 'should return value' do
+          expect { subject.send fname }.to_not raise_error
+        end
+      end    
+
+      describe "#{fname}=" do
+        it 'should set value' do
+          subject.send("#{fname}=", 'hello')
+          expect(subject.send fname).to eq 'hello'
+        end
+      end    
+    end
+
+    describe 'region' do
+      it 'should use the field' do
+        subject.state = 'denmark'
+        expect(subject.region).to match /denmark/
+      end
+    end
+
+    describe 'full_address' do
+      it 'should use the field' do
+        subject.street = 'denmark'
+        expect(subject.full_address).to match /denmark/
+      end
+    end
+
+    describe 'set_address' do
+      it 'should set the fields' do
+        subject.set_address(city: 'barcelona')
+        expect(subject.city).to eq 'barcelona'
+      end
+    end
+  end
+end

data/spec/on_the_map/geo_locatable_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'on_the_map/geo_locatable'
+
+class MyGeoCodableAddress
+  include Mongoid::Document
+  include OnTheMap::GeoLocatable
+end
+
+
+describe OnTheMap::GeoLocatable do
+  subject { address }
+
+  context 'empty address' do
+    let(:address) { MyGeoCodableAddress.create street: '', city: ''  }
+
+    it 'should have a blank full address' do
+      expect(subject.address.full).to be_blank
+    end
+
+    it 'should not be geolocatable' do
+      expect(subject.geolocatable?).to be false
+    end
+
+    it 'should not be geocoded?' do
+      expect(subject.geocoded?).to be false
+    end
+  end
+
+  context 'invalid address' do
+    let(:address) { MyGeoCodableAddress.create street: 'blip blab', city: 'blop'  }
+
+    it 'should be geolocatable' do
+      expect(subject.geolocatable?).to be_true
+    end
+
+    it 'should not calculate a position' do
+      expect(subject.position.to_a).to be_blank
+    end
+
+    it 'should not be geocoded?' do
+      expect(subject.geocoded?).to be false
+    end    
+  end
+end

data/spec/on_the_map/geo_locatable_valid_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'on_the_map/geo_locatable'
+
+class MyGeoCodableAddress
+  include Mongoid::Document
+  include OnTheMap::GeoLocatable
+end
+
+describe OnTheMap::GeoLocatable do
+  subject { address }
+
+  context 'valid address' do
+    let(:address) { MyGeoCodableAddress.create street: street, city: city  }
+
+    let(:city)    { 'Frederiksberg' }
+    let(:street)  { 'Maglekildevej 18, 4th' }
+
+    describe 'creation' do
+      its(:city)    { should == city }
+      its(:street)  { should == street }    
+
+      it 'should be geocoded?' do
+        expect(subject.geocoded?).to be true
+      end
+
+      its('position.to_a') { should_not be_empty }
+
+      it 'should geocode and calculate latitude' do
+        expect(subject.latitude).to be_within(1).of 55
+      end
+
+      it 'should geocode and calculate longitude' do
+        expect(subject.longitude).to be_within(1).of 12
+      end
+
+      context 'after update of street address' do
+        before do
+          @old_address = subject.dup
+          subject.street = 'Gammel kongevej 123'
+        end
+
+        describe 'calculated new position' do
+          it 'has been updated' do
+            expect(subject.position.to_a).to_not eq @old_address.position.to_a
+          end
+
+          it 'has new latitude' do
+            expect(subject.latitude).to_not eq @old_address.latitude
+          end
+
+          it 'has longitude' do
+            expect(subject.longitude).to_not eq @old_address.longitude
+          end      
+        end
+      end
+    end
+  end
+end

data/spec/on_the_map/mappable_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+require 'rails'
+require 'gmaps4rails'
+
+require 'on_the_map/mappable'
+
+
+class MyMappableAddress
+  include Mongoid::Document
+#  include OnTheMap::GeoLocatable
+  include OnTheMap::Mappable
+end
+
+
+describe OnTheMap::Mappable do
+  subject { address }
+
+  context 'empty address' do
+    let(:address) { MyMappableAddress.create street: '', city: ''  }
+
+    it 'should have a blank full address' do
+      expect(subject.address.full).to be_blank
+    end
+
+    it 'should not be geolocatable' do
+      expect(subject.geolocatable?).to be false
+    end
+
+    it 'should not be geocoded?' do
+      expect(subject.geocoded?).to be false
+    end
+
+    it 'should not have a gmaps' do
+      expect(subject.gmaps).to_not be true
+    end
+
+    it 'should not have a normalized address' do
+      expect(subject.normalized_address).to be_blank
+    end
+  end
+
+  context 'invalid address' do
+    let(:address) { MyMappableAddress.create street: 'blip blab', city: 'blop'  }
+
+    it 'should be geolocatable' do
+      expect(subject.geolocatable?).to be_true
+    end
+
+    it 'should not calculate a position' do
+      expect(subject.position.to_a).to be_blank
+    end
+
+    it 'should not be geocoded?' do
+      expect(subject.geocoded?).to be false
+    end 
+
+    it 'should not have a gmaps' do
+      expect(subject.gmaps).to_not be_true
+    end
+
+    it 'should not have a normalized address' do
+      expect(subject.normalized_address).to be_blank
+    end       
+  end
+
+  context 'valid address' do
+    let(:address) { MyMappableAddress.create street: street, city: city  }
+
+    let(:city)    { 'Frederiksberg' }
+    let(:street)  { 'Maglekildevej 18, 4th' }
+
+    describe 'creation' do
+      its(:city)    { should == city }
+      its(:street)  { should == street }
+
+      # leave geocoding to geocoder!
+      its(:gmaps_geocode?)  { should be_false }    
+
+      # geocoder sets gmaps when position has been calculated
+      its(:gmaps)   { should be_true }
+    end
+  end
+end

data/spec/on_the_map/positionable_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+require 'on_the_map/positionable'
+
+require 'rails'
+require 'mongoid'
+require 'rails/mongoid'
+
+module Dummy
+  class Application < Rails::Application
+  end
+end
+
+require 'mongoid_indexing'
+
+class MyPositionableAddress
+  include Mongoid::Document
+#  include OnTheMap::GeoLocatable
+  include OnTheMap::Positionable
+end
+
+describe OnTheMap::Positionable do
+  subject { address }
+
+  before :suite do
+    Mongoid.logger = Logger.new($stdout)
+    Moped.logger   = Logger.new($stdout)
+  end
+
+  context 'empty address' do
+    let(:address) {   }
+
+    before do
+      5.times do |n|
+        MyPositionableAddress.create position: [rand(n), n*4]
+      end
+
+      ::Mongoid::Indexing.create_indexes
+    end
+
+    describe 'positions' do
+      before do
+        @nearby = MyPositionableAddress.nearby(MyPositionableAddress.first.position)
+        # puts "nearby: #{@nearby.to_a.inspect}"
+      end
+
+      it 'should have all nearby' do
+        expect(@nearby).to have(5).items
+      end
+    end
+  end
+end

data/spec/on_the_map_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe "OnTheMap" do
+  pending 'TODO'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'rspec'
+require 'on_the_map'
+
+require 'hashie'
+require 'concerned'
+
+require 'mongoid'
+require 'moped'
+
+require 'factory_girl'
+
+require 'geocoder'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  Mongoid.configure do |mongoid_config|
+    mongoid_config.connect_to('mongoid_map_test')
+  end  
+
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  config.include FactoryGirl::Syntax::Methods
+
+  # == Mock Framework
+  config.mock_with :rspec
+
+  config.include Mongoid::Matchers
+
+  # Clean up the database
+  require 'database_cleaner'
+  config.before(:suite) do
+    DatabaseCleaner[:mongoid].strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.clean
+  end
+end    

data/spec/support/gmaps_lookup_stubs.rb

@@ -0,0 +1,86 @@
+Geocoder.configure(:lookup => :test)
+
+Invalid_adr = {
+  'latitude'     => nil,
+  'longitude'    => nil,
+  'address'      => nil,
+  'state'        => nil,
+  'state_code'   => nil,
+  'country'      => nil,
+  'country_code' => nil
+}
+
+# Invalid
+
+Geocoder::Lookup::Test.add_stub(
+  "blip blab", [Invalid_adr]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  "blip blab, blop", [Invalid_adr]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  "blip blab, blop, DK", [Invalid_adr]
+)
+
+Maglekildevej = {
+  'latitude'     => 55.677069,
+  'longitude'    => 12.513321,
+  'address'      => 'Maglekildevej 18, 4th, Frederiksberg, Copenhagen, Denmark',
+  'state'        => '',
+  'state_code'   => '',
+  'country'      => 'Denmark',
+  'country_code' => 'DK'
+}
+
+Gammel_kongevej = {
+  'latitude'     => 55.67616169999999,
+  'longitude'    => 12.5422907,
+  'address'      => 'Gammel kongevej 123, Frederiksberg, Copenhagen, Denmark',
+  'state'        => '',
+  'state_code'   => '',
+  'country'      => 'Denmark',
+  'country_code' => 'DK'
+}
+
+# Gammel kongevej
+
+Geocoder::Lookup::Test.add_stub(
+  "Gammel kongevej 123, Frederiksberg", [Gammel_kongevej]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  "Gammel kongevej 123", [Gammel_kongevej]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  "Gammel kongevej 123, Frederiksberg, DK", [Gammel_kongevej]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  "Gammel kongevej 123, Frederiksberg, Denmark, DK", [Gammel_kongevej]
+)
+
+
+# Maglekildevej
+
+Geocoder::Lookup::Test.add_stub(
+  "Maglekildevej 18, 4th, Frederiksberg", [Maglekildevej]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  "Maglekildevej 18, 4th", [Maglekildevej]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  "Maglekildevej 18, 4th, Denmark, DK", [Maglekildevej]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  "Maglekildevej 18, 4th, Frederiksberg, Denmark, DK", [Maglekildevej]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  "Maglekildevej 18, 4th, Frederiksberg, DK", [Maglekildevej]
+)