gmaps4rails 0.7.9 → 0.8.0

data/README.rdoc

@@ -21,10 +21,11 @@ See screencasts here: http://www.youtube.com/user/TheApneadiving
 In your model, add:
 
 	acts_as_gmappable
-
-	def gmaps4rails_address
-	  self.address #describe how to retrieve the address from your model
-	end
+	
+		def gmaps4rails_address
+		  #describe how to retrieve the address from your model, if you use directly a db column, you can dry your code, see wiki
+		  "#{self.street}, #{self.city}, #{self.country}" 
+		end
 
 Create a migration and add the following fields to your table (here users):
 
@@ -77,4 +78,4 @@ MIT license.
 
 Authors: Benjamin Roth, David Ruyer
 
-Contributor: Alex Vorobiev
+Contributors: Mircea Pricop, Alex Vorobiev

data/lib/acts_as_gmappable/base.rb

@@ -11,16 +11,7 @@ module Gmaps4rails
   class DirectionStatus < StandardError; end
   class DirectionNetStatus < StandardError; end
   class DirectionInvalidQuery < StandardError; end
-  
-#   def Gmaps4rails.create_json(object)
-#     unless object[object.gmaps4rails_options[:lat_column]].blank? && object[object.gmaps4rails_options[:lng_column]].blank?
-# "{
-# \"description\": \"#{object.gmaps4rails_infowindow}\", \"title\": \"#{object.gmaps4rails_title}\", \"sidebar\": \"#{object.gmaps4rails_sidebar}\",
-# \"longitude\": \"#{object[object.gmaps4rails_options[:lng_column]]}\", \"latitude\": \"#{object[object.gmaps4rails_options[:lat_column]]}\", \"picture\": \"#{object.gmaps4rails_marker_picture['picture']}\", \"width\": \"#{object.gmaps4rails_marker_picture['width']}\", \"height\": \"#{object.gmaps4rails_marker_picture['height']}\"
-# } ,"
-#     end
-#   end  
-  
+
   def Gmaps4rails.create_json(object)
     unless object[object.gmaps4rails_options[:lat_column]].blank? && object[object.gmaps4rails_options[:lng_column]].blank?
 "{#{Gmaps4rails.description(object)}#{Gmaps4rails.title(object)}#{Gmaps4rails.sidebar(object)}\"longitude\": \"#{object[object.gmaps4rails_options[:lng_column]]}\", \"latitude\": \"#{object[object.gmaps4rails_options[:lat_column]]}\"#{Gmaps4rails.picture(object)}},\n"
@@ -114,7 +105,7 @@ module Gmaps4rails
           if output == "pretty"
             #polylines contain levels data, which are not that useful.
             polylines.map{|poly| poly.delete("levels")}
-            #creat valid json from all polylines, this could be directly passed to javascript for display
+            #create valid json from all polylines, this could be directly passed to javascript for display
             json = polylines.map { |poly| {"coded_array" => poly["points"]} }.to_json
             #merge results in legs
             legs.last.merge!({ "polylines" => json })
@@ -146,18 +137,20 @@ module Gmaps4rails
         
       def process_geocoding
         #to prevent geocoding each time a save is made
-        return true if gmaps4rails_options[:check_process] == true && self[gmaps4rails_options[:checker]] == true
-        
+        return true if gmaps4rails_options[:check_process] == true && self.send(gmaps4rails_options[:checker]) == true
         begin
-          coordinates = Gmaps4rails.geocode(self.gmaps4rails_address)
-        rescue GeocodeStatus #adress was invalid, add error to base.
-          errors[:base] << gmaps4rails_options[:msg] if gmaps4rails_options[:validation]
+          coordinates = Gmaps4rails.geocode(self.send(gmaps4rails_options[:address]))
+        rescue GeocodeStatus #address was invalid, add error to base.
+          errors[gmaps4rails_options[:address]] << gmaps4rails_options[:msg] if gmaps4rails_options[:validation]
         rescue GeocodeNetStatus => e #connection error, No need to prevent save.
           logger.warn(e)
           #TODO add customization here?
         else #if no exception
           self[gmaps4rails_options[:lng_column]] = coordinates.first[:lng]
           self[gmaps4rails_options[:lat_column]] = coordinates.first[:lat]
+          unless gmaps4rails_options[:normalized_address].nil?
+            self.send(gmaps4rails_options[:normalized_address].to_s+"=", coordinates.first[:matched_address])
+          end
           if gmaps4rails_options[:check_process] == true
             self[gmaps4rails_options[:checker]] = true
           end
@@ -173,28 +166,23 @@ module Gmaps4rails
     end
     
     module ClassMethods
-      mattr_accessor :gmaps4rails_options
       
       def acts_as_gmappable args = {}          
         unless args[:process_geocoding] == false
           validate :process_geocoding
         end
-
-        # [:lat, :lng, :check_process, :checker, :msg, :validation].each do |sym|
-        #   Gmaps4rails::ActsAsGmappable.gmaps4rails_options[sym] = args[sym] unless args[sym].nil?
-        # end
-        
-        Gmaps4rails::ActsAsGmappable::ClassMethods.gmaps4rails_options = args        
         
         #instance method
         define_method "gmaps4rails_options" do
           {
-            :lat_column     => args[:lat]                 || "latitude",
-            :lng_column     => args[:lng]                 || "longitude",
-            :check_process  => args[:check_process].nil?  ?   true : args[:check_process],
-            :checker        => args[:checker]             || "gmaps",
-            :msg            => args[:msg]                 || "Address invalid",
-            :validation     => args[:validation].nil?     ?   true : args[:validation]
+            :lat_column         => args[:lat]                    || "latitude",
+            :lng_column         => args[:lng]                    || "longitude",
+            :check_process      => args[:check_process].nil?     ?   true : args[:check_process],
+            :checker            => args[:checker]                || "gmaps",
+            :msg                => args[:msg]                    || "Address invalid",
+            :validation         => args[:validation].nil?        ?   true  : args[:validation],
+            :normalized_address => args[:normalized_address],
+            :address            => args[:address]                || "gmaps4rails_address"
             #TODO: address as a proc?
           }
         end

data/lib/gmaps4rails.rb

@@ -1,7 +1,7 @@
 if defined?(Rails) && Rails::VERSION::MAJOR == 3
   module Gmaps4rails
     require "rails"
-    require "action_controller"
+    #require "action_controller"
     require 'array'
     require 'hash'  
     require 'application_helper'

data/test/dummy/app/models/user.rb

@@ -2,28 +2,28 @@ class User < ActiveRecord::Base
   acts_as_gmappable
   
   def gmaps4rails_address
-    address
-  end
-  
-  def gmaps4rails_infowindow
-    "My Beautiful Name: #{name}"
-  end
-  
-  def gmaps4rails_marker_picture
-    {
-    "picture" => "http://www.blankdots.com/img/github-32x32.png",
-    "width" => "32",
-    "height" => "32"
-    }
-  end
-  
-  def gmaps4rails_title
-    "Sweet Title"
-  end
-  
-  def gmaps4rails_sidebar
-    "sidebar content"
+    sec_address
   end
+  # 
+  # def gmaps4rails_infowindow
+  #   "My Beautiful Name: #{name}"
+  # end
+  # 
+  # def gmaps4rails_marker_picture
+  #   {
+  #   "picture" => "http://www.blankdots.com/img/github-32x32.png",
+  #   "width" => "32",
+  #   "height" => "32"
+  #   }
+  # end
+  # 
+  # def gmaps4rails_title
+  #   "Sweet Title"
+  # end
+  # 
+  # def gmaps4rails_sidebar
+  #   "sidebar content"
+  # end
   # def gmaps4rails_sidebar
   #   "<b>#{name}</b>"
   # end

data/test/dummy/db/migrate/20110430081624_add_addresses_to_users.rb

@@ -0,0 +1,11 @@
+class AddAddressesToUsers < ActiveRecord::Migration
+  def self.up
+    add_column :users, :norm_address, :string
+    add_column :users, :sec_address, :string
+  end
+
+  def self.down
+    remove_column :users, :sec_address
+    remove_column :users, :norm_address
+  end
+end

data/test/dummy/db/migrate/20110430083824_remove_address_from_users.rb

@@ -0,0 +1,9 @@
+class RemoveAddressFromUsers < ActiveRecord::Migration
+  def self.up
+    remove_column :users, :address
+  end
+
+  def self.down
+    add_column :users, :address, :string
+  end
+end

data/test/dummy/db/schema.rb

@@ -10,11 +10,10 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20110306182914) do
+ActiveRecord::Schema.define(:version => 20110430083824) do
 
   create_table "users", :force => true do |t|
     t.string   "name"
-    t.string   "address"
     t.text     "description"
     t.string   "picture"
     t.float    "lat_test"
@@ -25,6 +24,8 @@ ActiveRecord::Schema.define(:version => 20110306182914) do
     t.boolean  "bool_test"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.string   "norm_address"
+    t.string   "sec_address"
   end
 
 end

data/test/dummy/spec/factories.rb

@@ -1,20 +1,25 @@
 Factory.define :user do |f|  
   f.name    "me"
-  f.address "Toulon, France"
+  f.sec_address "Toulon, France"
 end
 
 Factory.define :user_paris, :parent => :user do |f|
   f.name    "me"
-  f.address "Paris, France"
+  f.sec_address "Paris, France"
 end
 
 Factory.define :user_with_pic, :parent => :user do |f|
   f.name    "me"
-  f.address "Toulon, France"
+  f.sec_address "Toulon, France"
   f.picture "http://www.blankdots.com/img/github-32x32.png"
 end
 
 Factory.define :invalid_user, :parent => :user do |f|
   f.name    "me"
-  f.address "home"
+  f.sec_address "home"
 end
+
+Factory.define :user_incomplete_address, :parent => :user do |f|
+  f.name    "me"
+  f.sec_address "Toulon, PACA, France"
+end

data/test/dummy/spec/models/user_spec.rb

@@ -12,13 +12,10 @@ describe "Acts as gmappable" do
           :check_process  => true,
           :checker        => "gmaps",
           :msg            => "Address invalid",
-          :validation     => true
+          :validation     => true,
+          :address    => "gmaps4rails_address"
         }
       end
-      
-      def gmaps4rails_address
-        address
-      end
     end
   end
   
@@ -46,14 +43,14 @@ describe "Acts as gmappable" do
     end
     
     it "should not geocode again after address changes if checker is true" do
-      @user.address = "paris, France"
+      @user.sec_address = "paris, France"
       @user.save
       @user.latitude.should  == 43.1251606
       @user.longitude.should == 5.9311119
     end
     
     it "should geocode after address changes if checker is false" do
-      @user.address = "paris, France"
+      @user.sec_address = "paris, France"
       @user.gmaps = false
       @user.save
       @user.latitude.should  == 48.8566667
@@ -77,12 +74,69 @@ describe "Acts as gmappable" do
   end
   
   
-  describe "model customization" do 
+  describe "model customization" do
     
     it "should render a valid json even if there is no instance in the db" do
       User.all.to_gmaps4rails.should == "[]"
     end
     
+    it "should use indifferently a db column for address if passed in config" do
+      User.class_eval do
+        def gmaps4rails_options
+          {
+            :lat_column     => "latitude",
+            :lng_column     => "longitude",
+            :check_process  => true,
+            :checker        => "gmaps",
+            :msg            => "Address invalid",
+            :validation     => true,
+            :address    => "sec_address"
+          }
+        end
+      end
+      @user = Factory(:user)
+      @user.latitude.should  == 43.1251606
+      @user.longitude.should == 5.9311119
+    end
+    
+    it "should save the normalized address if requested" do
+      User.class_eval do
+        def gmaps4rails_options
+          {
+            :lat_column     => "latitude",
+            :lng_column     => "longitude",
+            :check_process  => true,
+            :checker        => "gmaps",
+            :msg            => "Address invalid",
+            :validation     => true,
+            :normalized_address => "norm_address",
+            :address    => "gmaps4rails_address"
+          }
+        end
+      end
+      @user = Factory(:user)
+      @user.norm_address.should == "Toulon, France"
+    end
+    
+    it "should override user's address with normalized address if requested" do
+      User.class_eval do
+        def gmaps4rails_options
+          {
+            :lat_column     => "latitude",
+            :lng_column     => "longitude",
+            :check_process  => true,
+            :checker        => "gmaps",
+            :msg            => "Custom Address invalid",
+            :validation     => true,
+            :normalized_address => "sec_address",
+            :address    => "gmaps4rails_address"
+          }
+        end
+      end
+      @user = Factory.build(:user)
+      @user.sec_address.should == "Toulon, France"
+    end
+    
     it "should display the proper error message when address is invalid" do
       User.class_eval do
         def gmaps4rails_options
@@ -92,7 +146,8 @@ describe "Acts as gmappable" do
             :check_process  => true,
             :checker        => "gmaps",
             :msg            => "Custom Address invalid",
-            :validation     => true
+            :validation     => true,
+            :address    => "gmaps4rails_address"
           }
         end
       end
@@ -109,7 +164,8 @@ describe "Acts as gmappable" do
             :check_process  => true,
             :checker        => "gmaps",
             :msg            => "Address invalid",
-            :validation     => false
+            :validation     => false,
+            :address    => "gmaps4rails_address"
           }
         end
       end
@@ -126,7 +182,8 @@ describe "Acts as gmappable" do
             :check_process  => true,
             :checker        => "gmaps",
             :msg            => "Address invalid",
-            :validation     => true
+            :validation     => true,
+            :address    => "gmaps4rails_address"
           }
         end
       end
@@ -146,7 +203,8 @@ describe "Acts as gmappable" do
             :check_process  => false,
             :checker        => "gmaps",
             :msg            => "Address invalid",
-            :validation     => true
+            :validation     => true,
+            :address    => "gmaps4rails_address"
           }
         end
       end
@@ -163,12 +221,13 @@ describe "Acts as gmappable" do
             :check_process  => false,
             :checker        => "gmaps",
             :msg            => "Address invalid",
-            :validation     => true
+            :validation     => true,
+            :address    => "gmaps4rails_address"
           }
         end
       end
       @user = Factory(:user)
-      @user.address = "paris, France"
+      @user.sec_address = "paris, France"
       @user.save
       @user.latitude.should  == 48.8566667
       @user.longitude.should == 2.3509871
@@ -183,7 +242,8 @@ describe "Acts as gmappable" do
             :check_process  => true,
             :checker        => "bool_test",
             :msg            => "Address invalid",
-            :validation     => true
+            :validation     => true,
+            :address    => "gmaps4rails_address"
           }
         end
       end

data/test/dummy/spec/requests/users_spec.rb

@@ -1,23 +1,23 @@
-# require File.dirname(__FILE__) + '/../spec_helper'
-# 
-# describe "list creation", :js => true do
-#   
-#   it "should create the sidebar with list of users" do
-#     
-#     #first setup what the list should display    
-#     User.class_eval do
-#       def gmaps4rails_sidebar
-#         name
-#       end
-#     end
-#     
-#     Factory(:user, :name => "User1")
-#     Factory(:user, :name => "User2")
-#     
-#     visit test_list_path
-#     page.should have_content("User1")
-#     page.should have_content("User2")
-#   end
-#   
-# end
-# 
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "list creation", :js => true do
+  
+  it "should create the sidebar with list of users" do
+    
+    #first setup what the list should display    
+    User.class_eval do
+      def gmaps4rails_sidebar
+        name
+      end
+    end
+    
+    Factory(:user, :name => "User1")
+    Factory(:user, :name => "User2")
+    
+    visit test_list_path
+    page.should have_content("User1")
+    page.should have_content("User2")
+  end
+  
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gmaps4rails
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 9
-  version: 0.7.9
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Benjamin Roth
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-27 00:00:00 +02:00
+date: 2011-04-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,10 +43,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files: 
-- app/controllers/gmaps4rails/gmaps_controller.rb
-- app/helpers/gmaps4rails/gmaps_helper.rb
 - app/views/gmaps4rails/_gmaps4rails.html.erb
-- config/routes.rb
 - lib/acts_as_gmappable/base.rb
 - lib/application_helper.rb
 - lib/array.rb
@@ -81,6 +78,8 @@ files:
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/routes.rb
 - test/dummy/db/migrate/20110306182914_create_users.rb
+- test/dummy/db/migrate/20110430081624_add_addresses_to_users.rb
+- test/dummy/db/migrate/20110430083824_remove_address_from_users.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/seeds.rb
 - test/dummy/spec/base/base_spec.rb
@@ -142,6 +141,8 @@ test_files:
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/routes.rb
 - test/dummy/db/migrate/20110306182914_create_users.rb
+- test/dummy/db/migrate/20110430081624_add_addresses_to_users.rb
+- test/dummy/db/migrate/20110430083824_remove_address_from_users.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/seeds.rb
 - test/dummy/spec/base/base_spec.rb

data/app/controllers/gmaps4rails/gmaps_controller.rb

@@ -1,22 +0,0 @@
-module Gmaps4rails
-  class GmapsController < ApplicationController
-    # unloadable    
-    # 
-    # def index
-    #   @model = params["model"]
-    #   @scope = params["scope"]
-    #   @model = @model.constantize
-    #   
-    #   # The split returns the array [scope_name, arg1, arg2, ...]
-    #   if @scope && !@scope.empty? && @model.gmaps4rails_trusted_scopes.include?(@scope.split(/\(| *, *|\)/)[0])
-    #     object = eval("#{@model}.#{@scope}") # Cannot use send with lambda scope 
-    #                                          # because the arguments have to be separated
-    #     @objects = object.to_gmaps4rails
-    #   else
-    #     @objects = @model.all.to_gmaps4rails
-    #   end 
-    #   
-    #   render :json => @objects
-    # end        
-  end
-end

data/app/helpers/gmaps4rails/gmaps_helper.rb

@@ -1,5 +0,0 @@
-module Gmaps4rails
-  module GmapsHelper
-    
-  end
-end

data/config/routes.rb

@@ -1,5 +0,0 @@
-# Rails.application.routes.draw do 
-# 
-#   resources :gmaps, :only => [ :index ], :controller => "gmaps4rails/gmaps"
-# 
-# end