gmaps4rails 0.0.14 → 0.1.0

data/README.rdoc

@@ -1,22 +1,20 @@
 == Gmaps4rails
 
-GEM NOT READY YET.
-It's still in heavy dev and I have a bug with engines (I can't find enough doc on this topic). See http://github.com/krschacht/rails_3_engine_demo/issues/issue/3/ for the bug report.
-
-Gmaps4rails is developed to simply create a map with model instances (say Users).
-
+Gmaps4rails is developped to simply create a map with model instances (say Users).
+It's based on Rails 3 Engines.
+It works properly but I still have something to correct: making it work without resorting to the serve_static_assets to true in production.
 
 == Installation
 
 	gem install gmaps4rails
 
 == Requirements
-- jQuery (for ajax json)
+- jQuery (used for ajax json)
 - <%= yield :head %> in your header
+- config.serve_static_assets = true  (in your production.rb)
 
-== Examples
-
-=== In your model	
+== Quickstart
+In your model	
 	acts_as_gmappable
 	
   def gmaps4rails_address
@@ -28,23 +26,71 @@ Gmaps4rails is developed to simply create a map with model instances (say Users)
   end
 
   def gmaps4rails_description
-    self.name #could be html
+    self.name #could be html it's rendered when user clicks on the markers on the map
   end
 
-=== Create a migration and add the following fields to your table:
+Create a migration and add the following fields to your table:
   t.string   "gmaps4rails_latitude"
   t.string   "gmaps4rails_longitude"
   t.boolean  "gmaps"
 
-=== In your view
+In your view
 	<%= render :partial => 'gmaps4rails/gmaps4rails', :locals => { :model => "User"}	 %>
 
+
+== Options
+
+=== Setting Map Center
+	<%= render :partial => 'gmaps4rails/gmaps4rails', :locals => { :model => "User", :ref_latitude => 0 , :ref_longitude => 0 }	 %>
+
+=== Scopes (displays a dropdown list enabling you to filter the map content)
+In your model:
+  # Whatever scope you want
+	scope :low_height, lambda {|height| 
+  	where("users.height <= ?", height)
+  }
+	scope :high_height, lambda {|height| 
+  	where("users.height >= ?", height)
+	}
+	
+	# method to fill in the dropdown list: provide scope argument, variable to pass to it, and text you want to display
+  def self.gmaps4rails_filters
+    [
+     {"filter" => "All", "options" => "", "display" => "All"}, 
+     {"filter" => "low", "options" => "130", "display" => "People Under 130cm"}, 
+     {"filter" => "low", "options" => "100", "display" => "People Under 100cm"}, 
+     {"filter" => "high", "options" =>"190", "display" => "People Above 190cm"},
+     {"filter" => "high", "options" =>"200", "display" => "People Above 200cm"}
+    ]
+  end
+  
+	# method to filter your requests given the parameters you provided above
+  def self.gmaps4rails_filter(filter, options)
+    case filter
+      when 'low' then self.low_height(options)
+      when 'high' then self.high_height(options)
+      else self.all
+    end
+  end
+
+In your view:
+	<%=raw gmaps4rails_filters_display("User") %>
+
+=== Styling your Marker
+In your model, add the following:
+
+	def self.gmaps4rails_markers_pic
+	  { "picture" => "http://www.ci.burlington.vt.us/planning/images/google_maps_marker.png",
+	  "width" => 22,
+	  "length" => 32 }
+	end
+
 == Todo
-Many customization  will be available (at least, those already developed but not written here):
-- Marker Cluster available
-- integration of scopes to decide what you want to display precisely
+Still much more customization to provide, some ideas:
+- direct integration of scopes to decide what you want to display precisely
 - distance filter
 
+Feel free ton contact me, you have your say. I hope I'll have time enough to improve it.
 == Copyright
 
 Copyright (c) 2010 apneadiving. See LICENSE for details.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gmaps4rails
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 14
-  version: 0.0.14
+  version: 0.1.0
 platform: ruby
 authors: 
 - Benjamin Roth
@@ -32,7 +32,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: IN HEAVY DEV. Will enable easy display of items (taken from a model) on a Google Map. Uses Javascript API V3.
+description: Enables easy display of items (taken from a model) on a Google Map. Uses Javascript API V3.
 email: apnea.diving.deep@gmail.com
 executables: []
 
@@ -94,7 +94,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: IN HEAVY DEV. Will enable easy display of items (taken from a model) on a Google Map. Uses Javascript API V3.
+summary: Enables easy display of items (taken from a model) on a Google Map. Uses Javascript API V3.
 test_files: 
 - test/test_helper.rb
 - test/unit/gmaps4rails_widget_test.rb