ym4r 0.2.2 → 0.3.1

data/README

@@ -1,5 +1,5 @@
 =YM4R
-This is YM4R 0.2.2. The goal of YM4R (which naturally means Yellow Maps For Ruby...) is to ease the use of the Google Maps (including the Geocoding API) and Yahoo! Maps API's (including the Geocoding, Map Image, Traffic and Local Search API's) from Ruby and Rails.
+This is YM4R 0.3.1. The goal of YM4R (which naturally means Yellow Maps For Ruby...) is to ease the use of the Google Maps (including the Geocoding API) and Yahoo! Maps API's (including the Geocoding, Map Image, Traffic and Local Search API's) from Ruby and Rails.
 
 ==Operations
 ===Google Maps
@@ -54,6 +54,30 @@ For example, if you want to add a marker to the map, you need to do a few things
 What is sent to the browser will be the fllowing JavaScript code:
 	map.addOverlay(new GMarker(new GLatLng(123123.1,12313.76),{title:\"Hello again!\"}))
 
+====GMarkerGroup
+A new type of GOverlay is available, called GMarkerGroup. To use it you would have to include in your HTML template the JavaScript file markerGroup.js found in the <tt>lib/ym4r/google_maps/javascript</tt> directory of the distribution.
+
+It is useful in 2 situations:
+- Display and undisplay a group of markers without referencing all of them. You just declare your marker group globally and call +activate+ and +deactivate+ on this group in response, for example, to clicks on links on your page..
+- Keeping an index of markers, for example, in order to show one of these markers in reponse to a click on a link (the way Google Local does with the results of the search).
+
+Here is how you would use it from your Ruby code:
+	@map = GMap.new("map_div")
+	marker1 = GMarker.new([123.55,123.988],:info_window => "Hello from 1!")
+	marker2 = GMarker.new([87.123,18.9],:info_window =>"Hello from 2!")
+	@map.overlay_global_init(GMarkerGroup.new(true,
+					1 => marker1,
+					2 => marker2),"myGroup")
+Here I have created an active (ie which is going to be displayed when the map is created) marker group called +myGroup+ with 2 markers, which I want to reference later. If I did not want to reference them later (I just want to be able to display and undisplay the marker group), I could have passed an array instead of the hash.
+
+Then in your template, you could have that:
+	<a href="#" onclick="myGroup.showMarker(1);return false;">Click here to display marker1</a>
+	<a href="#" onclick="myGroup.showMarker(2);return false;">Click here to display marker2</a>
+	<%= @map.to_div %>
+When you click on one of the links, the corresponding marker has its info window displayed.
+
+You can call +activate+ and +deactivate+ to display or undisplay a group of markers. You can add new markers with +addMarker(marker,id)+. Again if you don't care about referencing the marker, you don't need to pass an id. If the marker group is active, the newly added marker will be displayed immediately. Otherwise it will be displayed the next time the group is activated. Finally, since it is an overlay, the group will be removed when calling clearOverlays on the GMap object.
+
 ====Adding new map types
 It is now possible to easily add new map types, on top of the already existing ones, like G_SATELLITE_MAP or G_NORMAL_MAP. The imagery for these new map types can come from layers of the standard map types or can be taken either from a WMS server or from pretiled images on a server (that can be generated with a tool that comes with the library). 
 
@@ -91,7 +115,7 @@ If you want to wipe out the existing map types (for example the 3 default ones),
 The YM4R library provides 2 tools to generate tiles. They are in the +tools+ directory of the YM4R distribution. These tools can naturally be used to generate tiles even if you don't use the YM4R library to manipulate your Google Maps. You will just have to write the code to fetch the tiles by yourself.
 
 =====tile_wms.rb
-This is to generate tiles from an already existing WMS server. It can be useful if you don't want to setup a permanent WMS server but still want to display your geographic data files (any format compatible with your WMS server can then be used). It can also be used to cache data from public servers, which can sometimes be very slow to answer requests. Run "ruby tile_wms.rb" to know what the options are. These are very similar to the ones passed to the WMSTiler constructor, although the <tt>-g</tt> (<tt>--gmap-setting</tt>) needs to be explained in more details. It uses the data that comes from this tool: http://www.onnyturf.com/google/latlontotile.html. Basically you need to center the map at the zoom you need to get your desired extent. When you are satisfied, the tool will give you the following data: the X and Y values of the upper left corner tile, 17 minus the zoom level (this is because the V2 of the Google Maps API reversed the zoom order), the number of horizontal and vertical tiles that you want. You will then pass to the <tt>-g</tt> options 5 integers in the order previously described, for example:
+This is to generate tiles from an already existing WMS server. It can be useful if you don't want to setup a permanent WMS server but still want to display your geographic data files (any format compatible with your WMS server can then be used). It can also be used to cache data from public servers, which can sometimes be very slow to answer requests. Run "ruby tile_wms.rb" to know what the options are. These are very similar to the ones passed to the WMSTiler constructor, although the <tt>-g</tt> (<tt>--gmap-setting</tt>) needs to be explained in more details. It uses the data that comes from this tool: http://www.onnyturf.com/google/latlontotile.html. Basically you need to center the map at the zoom you need to get your desired extent. When you are satisfied, the tool will give you the following data: the X and Y values of the upper left corner tile, 17 minus the zoom level (this is because the V2 of the Google Maps API reversed the zoom order), the number of horizontal and vertical tiles that you want. You will then pass to the <tt>-g</tt> option 5 integers in the order previously described, for example:
 	-g 300,383,7,3,2
 About the zoom level, if the tools tells you 7, you should pass 10 (17 - 7) to the <tt>-g</tt> option.
 

data/lib/ym4r/google_maps/geocoding/geocoding.rb

@@ -25,7 +25,7 @@ module Ym4r
         end
         
         doc = REXML::Document.new(xml) 
-                
+                        
         response = doc.elements['//Response']
         placemarks = Placemarks.new(response.elements['name'].text,response.elements['Status/code'].text.to_i)
         response.elements.each("Placemark") do |placemark|
@@ -34,6 +34,7 @@ module Ym4r
           data_administrative = data['//AdministrativeAreaName']
           data_sub_administrative = data['//SubAdministrativeAreaName']
           data_locality = data['//LocalityName']
+          data_dependent_locality = data['//DependentLocalityName']
           data_thoroughfare = data['//ThoroughfareName']
           data_postal_code = data['//PostalCodeNumber']
           placemarks << Geocoding::Placemark.new(data['address'].text,
@@ -41,6 +42,7 @@ module Ym4r
                                                  data_administrative.nil? ? "" : data_administrative.text,
                                                  data_sub_administrative.nil? ? "" : data_sub_administrative.text,
                                                  data_locality.nil? ? "" : data_locality.text,
+                                                 data_dependent_locality.nil? ? "" : data_dependent_locality.text,
                                                  data_thoroughfare.nil? ? "" : data_thoroughfare.text,
                                                  data_postal_code.nil? ? "" : data_postal_code.text,
                                                  *(data['//coordinates'].text.split(",")[0..1].collect {|l| l.to_f }))
@@ -60,7 +62,7 @@ module Ym4r
       end
 
       #A result from the Geocoding service.
-      class Placemark < Struct.new(:address,:country_code,:administrative_area,:sub_administrative_area,:locality,:thoroughfare,:postal_code,:longitude,:latitude)
+      class Placemark < Struct.new(:address,:country_code,:administrative_area,:sub_administrative_area,:locality,:dependent_locality,:thoroughfare,:postal_code,:longitude,:latitude)
         def lonlat
           [longitude,latitude]
         end

data/lib/ym4r/google_maps/javascript/markerGroup.js

@@ -0,0 +1,104 @@
+function GMarkerGroup(active, markers, markersById) {
+    this.active = active;
+    this.markers = markers || new Array();
+    this.markersById = markersById || new Object();
+}
+
+GMarkerGroup.prototype = new GOverlay();
+
+GMarkerGroup.prototype.initialize = function(map) {
+    this.map = map;
+    
+    if(this.active){
+	for(var i = 0 , len = this.markers.length; i < len; i++) {
+	    this.map.addOverlay(this.markers[i]);
+	}
+	for(var id in this.markersById){
+	    this.map.addOverlay(this.markersById[id]);
+	}
+    }
+}
+
+//If not already done (ie if not inactive) remove all the markers from the map
+GMarkerGroup.prototype.remove = function() {
+    this.deactivate();
+}
+
+GMarkerGroup.prototype.redraw = function(force){
+    //Nothing to do : markers are already taken care of
+}
+
+//Copy the data to a new Marker Group
+GMarkerGroup.prototype.copy = function() {
+    var overlay = new GMarkerGroup(this.active);
+    overlay.markers = this.markers; //Need to do deep copy
+    overlay.markersById = this.markersById; //Need to do deep copy
+    return overlay;
+}
+
+//Inactivate the Marker group and clear the internal content
+GMarkerGroup.prototype.clear = function(){
+    //deactivate the map first (which removes the markers from the map)
+    this.deactivate;
+    //Clear the internal content
+    this.markers = new Array();
+    this.markersById = new Object();
+}
+
+//Add a marker to the GMarkerGroup ; Adds it now to the map if the GMarkerGroup is active ; Should only be used AFTER the group overlay has been added to the map
+GMarkerGroup.prototype.addMarker = function(marker,id){
+    if(id == undefined){
+	this.markers.push(marker);
+    }else{
+	this.markersById[id] = marker;
+    }
+    if(this.active && this.map != undefined ){
+	this.map.addOverlay(marker);
+    }
+}
+
+//Open the info window (or info window tabs) of a marker
+GMarkerGroup.prototype.showMarker = function(id){
+    var marker = this.markersById[id];
+    if(marker != undefined){
+	//Check if I can just send the click event to the marker
+	GEvent.trigger(marker,"click");
+
+    }
+}
+
+//Activate (or deactivate depending on the argument) the GMarkerGroup
+GMarkerGroup.prototype.activate = function(active){
+    active = (active == undefined) ? true : active;
+    if(!active){
+	if(this.active){
+	    if(this.map != undefined){
+		for(var i = 0 , len = this.markers.length; i < len; i++){
+		    this.map.removeOverlay(this.markers[i])
+		}
+		for(var id in this.markersById){
+		    this.map.removeOverlay(this.markersById[id]);
+		}
+	    }
+	    this.active = false;
+	}
+    }else{
+	if(!this.active){
+	    if(this.map != undefined){
+		for(var i = 0 , len = this.markers.length; i < len; i++){
+		    this.map.addOverlay(this.markers[i]);
+		}
+		for(var id in this.markersById){
+		    this.map.addOverlay(this.markersById[id]);
+		}
+	    }
+	    this.active = true;
+	}
+    }
+}
+
+//Deactivate the Group Overlay (convenience method)
+GMarkerGroup.prototype.deactivate = function(){
+    this.activate(false);
+}
+

data/lib/ym4r/google_maps/map.rb

@@ -16,6 +16,7 @@ module Ym4r
         @variable = variable
         @init = []
         @init_end = [] #for stuff that must be initialized at the end (controls)
+        @init_begin = [] #for stuff that must be initialized at the beginning (center + zoom)
         @global_init = []
       end
 
@@ -54,9 +55,9 @@ module Ym4r
       #Initializes the initial center and zoom of the map. +center+ can be both a GLatLng object or a 2-float array.
       def center_zoom_init(center, zoom)
         if center.is_a?(GLatLng)
-          @init << set_center(center,zoom)
+          @init_begin << set_center(center,zoom)
         else
-          @init << set_center(GLatLng.new(center),zoom)
+          @init_begin << set_center(GLatLng.new(center),zoom)
         end
       end
 
@@ -83,17 +84,28 @@ module Ym4r
         @global_init << code
       end
       
-      #Initializes an icon  and makes it globally accessible through the JavaScript variable of name +variable+.
+      #Deprecated. Use icon_global_init instead.
       def icon_init(icon , name)
+        icon_global_init(icon , name)
+      end
+      
+      #Initializes an icon  and makes it globally accessible through the JavaScript variable of name +variable+.
+      def icon_global_init(icon , name)
         declare_global_init(icon,name)
       end
+      
+      #Declares the overlay globally with name +name+
+      def overlay_global_init(overlay,name)
+        declare_global_init(overlay,name)
+        @init << add_overlay(overlay)
+      end
 
       #Globally declare a MappingObject with variable name "name"
       def declare_global_init(variable,name)
         @global_init << variable.declare(name)
       end
       
-      #Outputs the initialization code for the map. By default, it outputs the script tags, performs the initialization inside a function called +load+ and makes the map globally available.
+      #Outputs the initialization code for the map. By default, it outputs the script tags, performs the initialization in reponse to the onload event of the window and makes the map globally available.
       def to_html(options = {})
         no_load = options[:no_load]
         no_script_tag = options[:no_script_tag]
@@ -114,6 +126,7 @@ module Ym4r
         else
           html << "#{assign_to(@variable)}\n"
         end
+        html << @init_begin * "\n"
         html << @init * "\n"
         html << @init_end * "\n"
         html << "\n}\n}\n" if !no_load
@@ -128,7 +141,6 @@ module Ym4r
       end
     end
 
-    
   end
 end
 

data/lib/ym4r/google_maps/mapping.rb

@@ -5,12 +5,21 @@ module Ym4r
       #The name of the variable in JavaScript space.
       attr_reader :variable
       
-      #Creates javascript code for missing methods
+      #Creates javascript code for missing methods + takes care of listeners
       def method_missing(name,*args)
-        args.collect! do |arg|
-          MappingObject.javascriptify_variable(arg)
+        str_name = name.to_s
+        if str_name =~ /^on_(.*)/
+          if args.length != 1
+            raise ArgumentError("Only 1 argument is allowed on on_ methods");
+          else
+            Variable.new("GEvent.addListener(#{to_javascript},\"#{javascriptify_method($1)}\",#{args[0]})")
+          end
+        else
+          args.collect! do |arg|
+            MappingObject.javascriptify_variable(arg)
+          end
+          Variable.new("#{to_javascript}.#{MappingObject.javascriptify_method(str_name)}(#{args.join(",")})")
         end
-        Variable.new("#{to_javascript}.#{MappingObject.javascriptify_method(name.to_s)}(#{args.join(",")})")
       end
             
       #Creates javascript code for array or hash indexing

data/lib/ym4r/google_maps/overlay.rb

@@ -94,9 +94,28 @@ module Ym4r
         a << ",#{MappingObject.javascriptify_variable(@opacity)}" if @opacity
         a << ")"
       end
-      
     end
 
+    class GMarkerGroup
+      include MappingObject
+      attr_accessor :active, :markers, :markers_by_id
+
+      def initialize(active = true , markers = nil)
+        @active = active
+        @markers = []
+        @markers_by_id = {}
+        if markers.is_a?(Array)
+          @markers = markers
+        elsif markers.is_a?(Hash)
+          @markers_by_id = markers
+        end
+      end
+      
+      def create
+        "new GMarkerGroup(#{MappingObject.javascriptify_variable(@active)},#{MappingObject.javascriptify_variable(@markers)},#{MappingObject.javascriptify_variable(@markers_by_id)})"
+      end
+    end
+    
     #A basic Latitude/longitude point.
     class GLatLng 
       include MappingObject

data/rakefile.rb

@@ -24,7 +24,7 @@ spec = Gem::Specification::new do |s|
   s.platform = Gem::Platform::RUBY
 
   s.name = 'ym4r'
-  s.version = "0.2.2"
+  s.version = "0.3.1"
   s.summary = "Using Google Maps and Yahoo! Maps from Ruby and Rails"
   s.description = <<EOF
 EOF

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: ym4r
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
-date: 2006-06-13 00:00:00 +05:00
+  version: 0.3.1
+date: 2006-06-18 00:00:00 +05:00
 summary: Using Google Maps and Yahoo! Maps from Ruby and Rails
 require_paths: 
 - lib
@@ -59,6 +59,7 @@ files:
 - lib/ym4r/yahoo_maps/flash/tool.rb
 - lib/ym4r/yahoo_maps/flash/widget.rb
 - lib/ym4r/google_maps/config/config.yml
+- lib/ym4r/google_maps/javascript/markerGroup.js
 - lib/ym4r/google_maps/javascript/wms-gs.js
 - tools/tile_image.rb
 - tools/tile_wms.rb