Pr0d1r2-active_record_geocodable 1.0.0 → 1.0.3

data/VERSION

@@ -0,0 +1 @@
+1.0.3

data/active_record_geocodable.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_record_geocodable}
+  s.version = "1.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marcin Nowicki"]
+  s.date = %q{2009-09-23}
+  s.description = %q{Allow any active record model to be geocoded by geokit gem and contain geodata}
+  s.email = %q{pr0d1r2@ragnarson.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "active_record_geocodable.gemspec",
+     "lib/active_record_geocodable.rb",
+     "lib/active_record_geocodable/base.rb",
+     "lib/active_record_geocodable/model.rb",
+     "spec/active_record_geocodable_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/Pr0d1r2/active_record_geocodable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{ActiveRecord is_geocodable method}
+  s.test_files = [
+    "spec/active_record_geocodable_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/lib/active_record_geocodable/base.rb

@@ -0,0 +1,23 @@
+module ActiveRecord
+  module Geocodable
+    module Base
+
+      def is_geocodable(options = {})
+        include ActiveRecord::Geocodable::Model
+        options = {:geocode => true}.merge(options)
+        if options[:require]
+          validates_presence_of :lat
+          validates_presence_of :lng
+          validates_numericality_of :lat
+          validates_numericality_of :lng
+          options[:geocode] = true
+        end
+        before_validation :geocode_complete_address if options[:geocode]
+        named_scope :geocoded, :conditions => "#{table_name}.lat IS NOT NULL AND #{table_name}.lng IS NOT NULL"
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.extend(ActiveRecord::Geocodable::Base)

data/lib/active_record_geocodable/model.rb

@@ -0,0 +1,76 @@
+require 'geokit'
+
+module ActiveRecord
+  module Geocodable
+    module Model
+
+      def geo
+        @geo ||= geocoder.geocode(complete_address)
+      end
+
+      def geocoding_occured?
+        !@geo.nil?
+      end
+
+      def geocoding_successful?
+        geocoding_occured? && geo.success
+      end
+
+      def lat?
+        !lat.nil?
+      end
+
+      def lng?
+        !lng.nil?
+      end
+
+      def geocoded?
+        lat? && lng?
+      end
+
+      def geocoder
+        Geokit::Geocoders::MultiGeocoder
+      end
+
+      def geocode_complete_address
+        if geocode? && geocode_complete_address?
+          if runned_geocoding_successful?
+            set_geocode_data && true
+          else
+            geocode_complete_address_error
+            false
+          end
+        end
+      end
+
+      def runned_geocoding_successful?
+        geo && geocoding_successful?
+      end
+
+      def set_geocode_data
+        !(self.lat = geo.lat).nil? && !(self.lng = geo.lng).nil?
+      end
+
+      def geocode_complete_address_error
+        errors.add(:complete_address, geocode_complete_address_error_messsage)
+      end
+
+      def geocode_complete_address_error_messsage
+        "Cannot geocode complete address: #{complete_address}"
+      end
+
+      def geocode_complete_address?
+        complete_address_changed? && complete_address?
+      end
+
+      def complete_address?
+        !complete_address.blank?
+      end
+
+      def geocode?
+        true
+      end
+
+    end
+  end
+end

data/spec/active_record_geocodable_spec.rb

@@ -2,38 +2,75 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'active_record_connectionless'
 
 class GeocodableModel < ActiveRecord::Base
+  emulate_attribute :lat, :lng
   is_geocodable
 end
 
+class GeocodableModelWithoutGeocode < ActiveRecord::Base
+  emulate_attribute :lat, :lng
+  is_geocodable :geocode => false
+end
+
+class GeocodableModelWithRequire < ActiveRecord::Base
+  emulate_attribute :lat, :lng
+  is_geocodable :require => true
+end
+
 
 describe GeocodableModel do
 
   before(:each) do
     @geocodable_model = GeocodableModel.new
+    @geocoder = mock(Geokit::Geocoders::MultiGeocoder)
+    @geo = mock(Geokit::GeoLoc)
   end
 
-  it 'geo should return geocoded address from multigeocoder' do
-    @geocodable_model.should_receive(:address).and_return(:address)
-    Geokit::Geocoders::MultiGeocoder.should_receive(:geocode).with(:address).and_return(:geo)
+  it 'geo should return geocoded complete_address from multigeocoder' do
+    @geocoder.should_receive(:geocode).with(:complete_address).and_return(:geo)
+    @geocodable_model.should_receive(:geocoder).and_return(@geocoder)
+    @geocodable_model.should_receive(:complete_address).and_return(:complete_address)
     @geocodable_model.geo.should == :geo
   end
 
   describe 'geocoding_occured?' do
     it 'should be true when geocoding occured' do
-      Geokit::Geocoders::MultiGeocoder.should_receive(:geocode).and_return(:geo)
-      @geocodable_model.stub!(:address)
+      @geocoder.should_receive(:geocode).and_return(:geo)
+      @geocodable_model.should_receive(:geocoder).and_return(@geocoder)
+      @geocodable_model.stub!(:complete_address)
       @geocodable_model.geo
       @geocodable_model.geocoding_occured?.should be_true
     end
 
     it 'should be false when geocoding not occured' do
-      Geokit::Geocoders::MultiGeocoder.should_receive(:geocode).and_return(nil)
-      @geocodable_model.stub!(:address)
+      @geocoder.should_receive(:geocode).and_return(nil)
+      @geocodable_model.should_receive(:geocoder).and_return(@geocoder)
+      @geocodable_model.stub!(:complete_address)
       @geocodable_model.geo
       @geocodable_model.geocoding_occured?.should be_false
     end
   end
 
+  describe 'geocoding_successful?' do
+    it 'should be true when geocoding occured and was successful' do
+      @geocodable_model.should_receive(:geocoding_occured?).and_return(true)
+      @geocodable_model.should_receive(:geo).and_return(@geo)
+      @geo.should_receive(:success).and_return(true)
+      @geocodable_model.geocoding_successful?.should be_true
+    end
+
+    it 'should be false when geocoding not occured' do
+      @geocodable_model.should_receive(:geocoding_occured?).and_return(false)
+      @geocodable_model.geocoding_successful?.should be_false
+    end
+
+    it 'should be false when geocoding occured but was not successful' do
+      @geocodable_model.should_receive(:geocoding_occured?).and_return(true)
+      @geocodable_model.should_receive(:geo).and_return(@geo)
+      @geo.should_receive(:success).and_return(false)
+      @geocodable_model.geocoding_successful?.should be_false
+    end
+  end
+
   describe 'lat?' do
     it 'should be true when lat is not nil' do
       @geocodable_model.should_receive(:lat).and_return(47)
@@ -58,23 +95,177 @@ describe GeocodableModel do
     end
   end
 
-  describe 'success?' do
+  describe 'geocoded?' do
     it 'should be true when lat and lng are ok' do
       @geocodable_model.should_receive(:lat?).and_return(true)
       @geocodable_model.should_receive(:lng?).and_return(true)
-      @geocodable_model.success?.should be_true
+      @geocodable_model.geocoded?.should be_true
     end
 
     it 'should be false when lng is not ok' do
       @geocodable_model.should_receive(:lat?).and_return(true)
       @geocodable_model.should_receive(:lng?).and_return(false)
-      @geocodable_model.success?.should be_false
+      @geocodable_model.geocoded?.should be_false
     end
 
     it 'should be false when lat is not ok' do
       @geocodable_model.should_receive(:lat?).and_return(false)
-      @geocodable_model.success?.should be_false
+      @geocodable_model.geocoded?.should be_false
+    end
+  end
+
+  it 'geocoder should return Geokit::Geocoders::MultiGeocoder' do
+    @geocodable_model.geocoder.should == Geokit::Geocoders::MultiGeocoder
+  end
+
+  describe 'geocode_complete_address' do
+    it 'should do nothing when we prevent geocoding' do
+      @geocodable_model.should_receive(:geocode?).and_return(false)
+      @geocodable_model.geocode_complete_address.should be_nil
+    end
+
+    it 'should do nothing when complete address not ready for geocoding' do
+      @geocodable_model.should_receive(:geocode?).and_return(true)
+      @geocodable_model.should_receive(:geocode_complete_address?).and_return(false)
+      @geocodable_model.geocode_complete_address.should be_nil
+    end
+
+    it 'should set_geocode_data when geocoding was successful' do
+      @geocodable_model.should_receive(:geocode?).and_return(true)
+      @geocodable_model.should_receive(:geocode_complete_address?).and_return(true)
+      @geocodable_model.should_receive(:runned_geocoding_successful?).and_return(true)
+      @geocodable_model.should_receive(:set_geocode_data).and_return(true)
+      @geocodable_model.geocode_complete_address.should be_true
+    end
+
+    it 'should set error for complete address when geocoding was not successful' do
+      @geocodable_model.should_receive(:geocode?).and_return(true)
+      @geocodable_model.should_receive(:geocode_complete_address?).and_return(true)
+      @geocodable_model.should_receive(:runned_geocoding_successful?).and_return(false)
+      @geocodable_model.should_receive(:geocode_complete_address_error)
+      @geocodable_model.geocode_complete_address.should be_false
+    end
+  end
+
+  describe 'set_geocode_data' do
+    it 'should set data from geo and return true' do
+      @geo.should_receive(:lat).and_return(84)
+      @geo.should_receive(:lng).and_return(72)
+      @geocodable_model.should_receive(:geo).twice.and_return(@geo)
+      @geocodable_model.set_geocode_data.should be_true
+      @geocodable_model.lat.should == 84
+      @geocodable_model.lng.should == 72
+    end
+
+    it 'should return false when not both lat and lng was set' do
+      @geo.should_receive(:lat).and_return(84)
+      @geo.should_receive(:lng).and_return(nil)
+      @geocodable_model.should_receive(:geo).twice.and_return(@geo)
+      @geocodable_model.set_geocode_data.should be_false
+    end
+  end
+
+  it 'geocode_complete_address_error should add error to complete_address' do
+    @geocodable_model.should_receive(:geocode_complete_address_error_messsage).and_return(:geocode_complete_address_error_messsage)
+    errors = mock(ActiveRecord::Errors)
+    errors.should_receive(:add).with(:complete_address, :geocode_complete_address_error_messsage)
+    @geocodable_model.should_receive(:errors).and_return(errors)
+    @geocodable_model.geocode_complete_address_error
+  end
+
+  it 'geocode_complete_address_error_messsage should have proper message' do
+    @geocodable_model.should_receive(:complete_address).and_return('complete_address')
+    @geocodable_model.geocode_complete_address_error_messsage.should == "Cannot geocode complete address: complete_address"
+  end
+
+  describe 'geocode_complete_address?' do
+    it 'should be true when complete_address changed and it is not blank' do
+      @geocodable_model.should_receive(:complete_address_changed?).and_return(true)
+      @geocodable_model.should_receive(:complete_address?).and_return(true)
+      @geocodable_model.geocode_complete_address?.should be_true
+    end
+
+    it 'should be false when complete_address changed but it is blank' do
+      @geocodable_model.should_receive(:complete_address_changed?).and_return(true)
+      @geocodable_model.should_receive(:complete_address?).and_return(false)
+      @geocodable_model.geocode_complete_address?.should be_false
     end
+
+    it 'should be false when complete_address not changed' do
+      @geocodable_model.should_receive(:complete_address_changed?).and_return(false)
+      @geocodable_model.geocode_complete_address?.should be_false
+    end
+  end
+
+  describe 'complete_address?' do
+    it 'should be true when complete_address is not blank' do
+      @geocodable_model.should_receive(:complete_address).and_return('complete address')
+      @geocodable_model.complete_address?.should be_true
+    end
+
+    it 'should be false when complete_address is blank' do
+      @geocodable_model.should_receive(:complete_address).and_return('')
+      @geocodable_model.complete_address?.should be_false
+    end
+  end
+
+  it 'geocode? should be true unless You want to disable geocoding' do
+    @geocodable_model.geocode?.should be_true
+  end
+
+  it 'should validate geocode_complete_address' do
+    @geocodable_model.should_receive(:geocode_complete_address).and_return(true)
+    @geocodable_model.should be_valid
+  end
+
+  it 'should provide geocoded named_scope' do
+    GeocodableModel.should_receive(:find).and_return([])
+    GeocodableModel.geocoded.should == []
+  end
+
+end
+
+
+describe GeocodableModelWithoutGeocode do
+
+  it 'should not validate geocode_complete_address' do
+    geocodable_model = GeocodableModelWithoutGeocode.new
+    geocodable_model.should_not_receive(:geocode_complete_address)
+    geocodable_model.should be_valid
+  end
+
+end
+
+
+describe GeocodableModelWithRequire do
+
+  before(:each) do
+    @geocodable_model = GeocodableModelWithRequire.new(:lat => 84, :lng => 72)
+    @geocodable_model.should_receive(:geocode_complete_address).and_return(true)
+  end
+
+  it 'should be valid with all ok' do
+    @geocodable_model.should be_valid
+  end
+
+  it 'should not be valid with empty lat' do
+    @geocodable_model.lat = nil
+    @geocodable_model.should_not be_valid
+  end
+
+  it 'should not be valid with empty lng' do
+    @geocodable_model.lng = nil
+    @geocodable_model.should_not be_valid
+  end
+
+  it 'should not be valid with not numeric lat' do
+    @geocodable_model.lat = 'a'
+    @geocodable_model.should_not be_valid
+  end
+
+  it 'should not be valid with not numeric lng' do
+    @geocodable_model.lng = 'a'
+    @geocodable_model.should_not be_valid
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Pr0d1r2-active_record_geocodable
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors: 
 - Marcin Nowicki
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-22 00:00:00 -07:00
+date: 2009-09-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,7 +37,11 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- VERSION
+- active_record_geocodable.gemspec
 - lib/active_record_geocodable.rb
+- lib/active_record_geocodable/base.rb
+- lib/active_record_geocodable/model.rb
 - spec/active_record_geocodable_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true