ropenlayer 0.0.1 → 0.3.0

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.3.0 2011-02-27
+
+* Major release.
+  * include acts_as_map and acts_as_localizable_on class methods to Rails applications.
+  * make ropenlayer not js framework dependent.
+  * included form builder helpers to provide easily storage new nodes on map
+  * added Ropenlayer::Openlayer::Feature to provide drawing of nodes in map (at the moment, poing, lines and polygons are supported
+  * more facilities to Rails applications (migration and install generators)
+
 === 0.0.1 2011-01-11
 
 * 1 major enhancement:

data/Manifest.txt

@@ -1,23 +1,3 @@
-History.txt
-Manifest.txt
-PostInstall.txt
-README.rdoc
-Rakefile
-ropenlayer.gemspec
-lib/ropenlayer.rb
-lib/ropenlayer/control.rb
-lib/ropenlayer/js.rb
-lib/ropenlayer/map.rb
-lib/ropenlayer/layer/base.rb
-lib/ropenlayer/layer/elements_marker.rb
-lib/ropenlayer/layer/elements_vector.rb
-lib/ropenlayer/box_control/base.rb
-lib/ropenlayer/box_control/edit_map.rb
-lib/ropenlayer/box_control/layers_select.rb
-script/console
-script/destroy
-script/generate
-spec/
 
 
 

data/PostInstall.txt

@@ -1,5 +1,4 @@
-
-For more information on lidia, see http://lidia.rubyforge.org
+For more information of ropenlayer  see http://rubygems.org/gems/ropenlayer or project code git repo at http://gitorious.org/gnoxys/ropenlayer
 
 
 

data/README.rdoc

@@ -4,45 +4,186 @@
 * http://gitorious/gnoxys/ropenlayer
 * http://openlayers.org/
 
-== DESCRIPTION:
+== Description:
 
 Ropenlayer is a wrapper constructor for openlayer javascript library written in ruby. It aims to provide an easy way to build maps and display it on webs.
 
+Ropenlayer is also an ActsAs extend module for Rails. It provides acts_as_map and acts_as_localizable_on class methods to perform geolicalization maping of objects.
+
 At the moment, Ropenlayer gem comes with the following features.
 
- - Create a JS OpenLayer.Map object with some options from ruby methods.
+ - Create a JS Openlayer.Map object with some options from ruby methods.
  - Manage layers and controls displayed on the map.
- - Create, by default, a marker and vectors layers for render items with icons or differents features as polygons or lines. more will come.
- - Ropenlayer will namescope all the outpus so several maps on same screen are allowed.
+ - Create, by default, a marker and vectors layers for render items with icons or differents features as polygons, point or lines. more will come.
+ - Ropenlayer will namescope all the outpus so several maps, with differents options on same screen are allowed.
  - Set defaul latitude, longitude and zoom,
+ 
+Working on Rails will give also this helpers
+
+ - acts_as_map and acts_as_localizable_on methods which perform all database storage of localization data.
+ - form helpers to provide an easy way to draw and store localizations on the map.
 
 == Before use ropenlayer
 
 Ropenlayer is still in alpha stage, so, you should have some skills with javascript and  openlayers.
 
-Also, ropenlayer assumes you have included openlayers library in your website. For more information, go to openlayers home (http://openlayers.org/) or view the examples at http://openlayers.org/dev/examples/
+Ropenlayer comes with some rails 3 generator to download latest OpenLayer js and copy images and stylesheets on Rails applications. Also, ropenLayer has big dependencies of some rails classes (ActiveRecord and ActionView), so in order to user database backend or form helpers methods, you need to develops your application on Rails. 
+
+Ropenlayer can work alone without Rails context, but it is not the priority ATM.
+
+== Install
+
+On your rails application just define ropenlayer gem
+
+  config.gem 'ropenlayer', '~>0.3.0'
+
+In order to use acts_as_* behavior methods, generate installer and migration on your application
+
+  $ rails generate ropenlayer:migration
+  $ rake db:migrate
+
+Will create nodes and localizations table which are managed by Ropenlayer::Node and Ropenlayer::Localization classes, based on ActiveRecord
+
+  $ rails generate ropenlayer:install
+
+Will create an initializer stored on <your_app/config/initializers/ropenlayer.rb with some options. Will also download latest OpenLayer Js library, and copy default css style for map 'ropenlayer.css', and some images needed on styling and map operations.
+
+To start using Ropenlayer, include acts_as_map method on your mapper model, for example, team
+
+  class Team < ActiveRecord::Base
+
+     acts_as_map :default_layer => :google_streets,
+
+  end
+
+In your view
+
+  <%= @team.ropenlayer_map.to_js %>
+
+
+If you want to set starting latitude / longitude, zoom, default layer, you can pass it though options Hash. For example, team can have a main office.
+
+  class Team < ActiveRecord
+
+     has_many :offices
+     has_one  :main_office, :conditions => { :main => true }
+
+     acts_as_map :default_layer => :google_streets, :longitude => Proc.new{|t| t.main_office.longitude }, :latitude => Proc.new{|t| t.main_office.latitude }, :zoom => 5
+
+  end
+
+For more options see Ropenlayer::ActsAs::Mapper
+
+
+Ropenlayer also can include your relations models on the map. Just give to the nodeable model the ability to be localizable
+
+  class Office < ActiveRecord
+
+    belongs_to :team
+    
+    acts_as_localizable_on :team
 
-== Initialize
+  end
 
-Create a map object with parsed attributes. Ropenlayer manage two ids for each map.
+Now, in your mapper model, you can include this relation as nodeable.
 
- - js_div, use to scope all the variables names to draw js output.
- - div_id, the dom_id passed as argument to construtor. For example
 
-For example
+  class Team < ActiveRecord
 
-  m = Ropenlayer::Map.new('group_map')
-  => <Ropenlayer::Map:0xf7344fe8>
-  m.js_id
-  => "olObject_group_map"
-  n.div_id
-  => "group_map"
+     has_many :offices
+     has_one :main_office, :conditions => { :main => true }
 
-To draw map, just call to_js method. For example, in a rails 3.x application
+     acts_as_map :default_layer => :google_streets, :longitude => Proc.new{|t| t.main_office.longitude }, :latitude => Proc.new{|t| t.main_office.latitude }, :zoom => 5
+                 :nodes         => [ :offices ]
 
-  <%= raw javascript_tag(Ropenlayer::Map.new('group_map').to_js) %>
+  end
+
+Ropenlayer will displayed now on team map, offices that have enough localization info. See Ropenlayer::ActsAs::Nodeable for more info
+
+
+== Working with form
+
+Ropenlayer comes with some methods built on ActionView::Helpers::FormBuilder, so on your form.
+
+  <%= form_for @team do |f| %>
+    
+    <div>
+        <%= f.label :name %>
+        <%= f.input_field :name %>
+    </div>
+
+    <div>
+      <%= f.label :localization %>
+      <%= f.map_localization %>
+    </div>
+
+    <%= f.submit %>
+
+  <% end %>
+
+This will render a map with automatic localization callbacks to store in hidden fields the zoom, longitude and latitude of the current map state.
+
+To use this facility, :latitude, :longitude and :zoom options must point to a valid get and set methods on the mapper Class. For example
+
+  class Team < ActiveRecord
+
+     has_many :offices
+     has_one :main_office, :conditions => { :main => true }
+
+     acts_as_map :default_layer => :google_streets, :longitude => :main_office_longitude, :latitude => :main_office_latitude, :zoom => :main_office_zoom
+                 :nodes         => [ :offices ]
+
+     def main_office_longitude
+        main_office.longitude
+     end
+
+     def main_office_longitude=(value)
+       main_office_longitude = value
+     end
+
+     def main_office_latitude
+        main_office.latitude
+     end
+
+     def main_office_latitude=(value)
+       main_office.latitude = value
+     end
+
+     def main_office_longitude
+        main_office.longitude
+     end
+
+     def main_office_zoom=(value)
+       main_office.zoom = value
+     end
+
+  end
+
+Also, provides to a form builder method on nodeable class to draw instance position. For example
+
+  <%= form_for [@team, @office] do |f| %>
+    
+    <div>
+        <%= f.label :name %>
+        <%= f.input_field :name %>
+    </div>
+    
+    <div>
+        <%= f.label :address %>
+        <%= f.input_field :address %>
+    </div>
+
+    <div>
+      <%= f.label :localization %>
+      <%= f.map_nodes_editor :team %>
+    </div>
+
+    <%= f.submit %>
+
+  <% end %>
+
+This will render a map with automatic localization callbacks to store the position of the node in the map. At the moment, ropenlayer can draw points, lines and polygons. Circles will be next.
 
-For more information see Ropenlayer::Map
 
 == DEMO
 
@@ -51,10 +192,7 @@ You can take a look to cartac (http://cartac.gnoxys.net) a application we develo
 == REQUIREMENTS:
 
 * json_pure (~>1.2.3)
-
-== INSTALL:
-
-* gem install ropenLayer
+* rails (~>3.0.3)
 
 == LICENSE:
 

data/lib/generators/ropenlayer/install/INSTALL

@@ -0,0 +1,16 @@
+
+
+Ropenlayer INSTALLED!
+
+Remeber to include Js and CSS files in your layout
+
+  <%= javascript_include_tag 'OpenLayers' %>
+
+and
+
+  <%= stylesheet_link_tag 'ropenlayer' %>
+
+If you want to use Google Maps layer, you need to include it also. for example
+
+    <script src="http://maps.google.com/maps/api/js?v=3.2.4&sensor=true"></script>
+

data/lib/generators/ropenlayer/install/USAGE

@@ -0,0 +1,7 @@
+Ropenlayer
+==========
+
+# Copy Openlayers JS, CSS and Images to your public folder
+
+rails generate ropenlayer:install
+

data/lib/generators/ropenlayer/install/install_generator.rb

@@ -0,0 +1,20 @@
+module Ropenlayer
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+    
+      source_root File.expand_path('../templates', __FILE__)  
+      
+      def install
+          copy_file  "config/initializers/ropenlayer.rb"
+          
+          get        "http://openlayers.org/api/OpenLayers.js", "public/javascripts/OpenLayers.js"
+          copy_file  "public/stylesheets/ropenlayer.css"
+          directory  "public/images/ropenlayer"
+
+          readme "../INSTALL"
+    
+      end
+      
+    end
+  end
+end

data/lib/generators/ropenlayer/install/templates/config/initializers/ropenlayer.rb

@@ -0,0 +1,13 @@
+# Use this hook to configure Ropenlayer
+Ropenlayer.setup do |config|
+  # Default JS Helper
+  # Ropenlayer needs some extra Js functions in order to create and perform some operations over dom elements
+  # Ropenlayer comes with 2 Js helpers bases on both popular javascript frameworks: jquery and prototype
+  # By default, if none is set, Jquery is used. Set default_js_helper to Ropenlayer::JsHelper::Prototype to enable prototype
+  # Of course, you can use custom one. See Ropenlayer::JsHelper::Prototype or Ropenlayer::JsHelper::Jquery to see which methods are called 
+  # and configure your helper to provide this funcionality (almost are: hide and show elements, create div and a elements and update / insert html in dom  
+  # config.js_helper = Ropenlayer::JsHelper::Prototype
+end
+  
+  
+