map_layers 0.0.3

data/lib/map_layers/#geonames.rb#

@@ -0,0 +1,66 @@
+rere# GeoNames REST services
+# 
+# http://www.geonames.org/export/web-services.html
+#
+module Geonames
+
+  module JsonFormat # :nodoc:
+    extend self
+
+    def extension
+      "json"
+    end
+
+    def mime_type
+      "application/json"
+    end
+
+    def encode(hash)
+      hash.to_json
+    end
+
+    def decode(json)
+      h = ActiveSupport::JSON.decode(json)
+      h.values.flatten # Return type must be an array of hashes
+    end
+  end
+
+  # GeoNames REST services base class
+  class GeonamesResource < ActiveResource::Base
+    self.site = "http://ws.geonames.org/"
+    self.format = JsonFormat
+  end
+
+  # GeoNames Postalode REST services
+  class Postalcode < GeonamesResource
+    # Postal code search
+    # 
+    # http://www.geonames.org/export/web-services.html#postalCodeSearch
+    #
+    def self.search(placename, options = {:maxRows => 50})
+      self.find(:all, :from => "/postalCodeSearchJSON", :params => { :placename => placename }.merge(options))
+    end
+  end
+
+  # GeoNames Weather REST services
+  class Weather < GeonamesResource
+    # Weather stations with the most recent weather observation
+    # 
+    # Example: Geonames::Weather.weather(:north => 44.1, :south => -9.9, :east => -22.4, :west => 55.2)
+    # 
+    # http://www.geonames.org/export/JSON-webservices.html#weatherJSON
+    #
+    def self.weather(options)
+      self.find(:all, :from => "/weatherJSON", :params => options)
+    end
+
+    # Weather station and the most recent weather observation for the ICAO code
+    # 
+    # http://www.geonames.org/export/JSON-webservices.html#weatherIcaoJSON
+    #
+    def self.weatherIcao(icao, options = {})
+      self.find(:all, :from => "/weatherIcaoJSON", :params => { :ICAO => icao }.merge(options))
+    end
+  end
+ 
+end

data/lib/map_layers/geonames.rb

@@ -0,0 +1,66 @@
+# GeoNames REST services
+# 
+# http://www.geonames.org/export/web-services.html
+#
+module Geonames
+
+  module JsonFormat # :nodoc:
+    extend self
+
+    def extension
+      "json"
+    end
+
+    def mime_type
+      "application/json"
+    end
+
+    def encode(hash)
+      hash.to_json
+    end
+
+    def decode(json)
+      h = ActiveSupport::JSON.decode(json)
+      h.values.flatten # Return type must be an array of hashes
+    end
+  end
+
+  # GeoNames REST services base class
+  class GeonamesResource < ActiveResource::Base
+    self.site = "http://ws.geonames.org/"
+    self.format = JsonFormat
+  end
+
+  # GeoNames Postalode REST services
+  class Postalcode < GeonamesResource
+    # Postal code search
+    # 
+    # http://www.geonames.org/export/web-services.html#postalCodeSearch
+    #
+    def self.search(placename, options = {:maxRows => 50})
+      self.find(:all, :from => "/postalCodeSearchJSON", :params => { :placename => placename }.merge(options))
+    end
+  end
+
+  # GeoNames Weather REST services
+  class Weather < GeonamesResource
+    # Weather stations with the most recent weather observation
+    # 
+    # Example: Geonames::Weather.weather(:north => 44.1, :south => -9.9, :east => -22.4, :west => 55.2)
+    # 
+    # http://www.geonames.org/export/JSON-webservices.html#weatherJSON
+    #
+    def self.weather(options)
+      self.find(:all, :from => "/weatherJSON", :params => options)
+    end
+
+    # Weather station and the most recent weather observation for the ICAO code
+    # 
+    # http://www.geonames.org/export/JSON-webservices.html#weatherIcaoJSON
+    #
+    def self.weatherIcao(icao, options = {})
+      self.find(:all, :from => "/weatherIcaoJSON", :params => { :ICAO => icao }.merge(options))
+    end
+  end
+ 
+end

data/lib/map_layers/js_wrapper.rb

@@ -0,0 +1,178 @@
+module MapLayers
+
+  #The module where all the Ruby-to-JavaScript conversion takes place.
+  #Based on Ym4r::GmPlugin::MappingObject from Guilhem Vellut
+  module JsWrapper
+    #The name of the variable in JavaScript space.
+    attr_reader :variable
+
+    #Creates javascript code for missing methods + takes care of listeners
+    def method_missing(name,*args)
+      str_name = name.to_s
+      args.collect! do |arg|
+        JsWrapper.javascriptify_variable(arg)
+      end
+      JsExpr.new("#{to_javascript}.#{JsWrapper.javascriptify_method(str_name)}(#{args.join(",")})")
+    end
+
+    # Creates javascript code for method calls
+    def javascriptify_method_call(name,*args)
+      args.collect! do |arg|
+        JsWrapper.javascriptify_variable(arg)
+      end
+      JsExpr.new("#{to_javascript}.#{JsWrapper.javascriptify_method(name.to_s)}(#{args.join(",")})")
+    end
+
+    #Creates javascript code for array or hash indexing
+    def [](index) #index could be an integer or string
+      return JsExpr.new("#{to_javascript}[#{JsWrapper.javascriptify_variable(index)}]")
+    end
+
+    #Transforms a Ruby object into a JavaScript string : JsWrapper, String, Array, Hash and general case (using to_s)
+    def self.javascriptify_variable(arg)
+      if arg.is_a?(JsWrapper)
+        arg.to_javascript
+      elsif arg.is_a?(String)
+        "\"#{JsWrapper.escape_javascript(arg)}\""
+      elsif arg.is_a?(Array)
+        "[" + arg.collect{ |a| JsWrapper.javascriptify_variable(a)}.join(",") + "]"
+      elsif arg.is_a?(Hash)
+        "{" + arg.to_a.collect do |v|
+          "#{JsWrapper.javascriptify_method(v[0].to_s)} : #{JsWrapper.javascriptify_variable(v[1])}"
+        end.join(",") + "}"
+      elsif arg.nil?
+        "undefined"
+      else
+        arg.to_s
+      end
+    end
+
+    #Escape string to be used in JavaScript. Lifted from rails.
+    def self.escape_javascript(javascript)
+      javascript.gsub(/\r\n|\n|\r/, "\\n").gsub("\"") { |m| "\\#{m}" }
+    end
+
+    #Transform a ruby-type method name (like add_overlay) to a JavaScript-style one (like addOverlay).
+    def self.javascriptify_method(method_name)
+      method_name.gsub(/_(\w)/){|s| $1.upcase}
+    end
+
+    #Declares a Mapping Object bound to a JavaScript variable of name +variable+.
+    def declare(variable)
+      @variable = variable
+      "var #{@variable} = #{create};"
+    end
+
+    #declare with a random variable name
+    def declare_random(init,size = 8)
+      s = init.clone
+      6.times { s << (i = Kernel.rand(62); i += ((i < 10) ? 48 : ((i < 36) ? 55 : 61 ))).chr }
+      declare(s)
+    end
+
+    #Checks if the MappinObject has been declared
+    def declared?
+      !@variable.nil?
+    end
+
+    #Binds a Mapping object to a previously declared JavaScript variable of name +variable+.
+    def assign_to(variable)
+      @variable = variable
+      "#{@variable} = #{create};"
+    end
+
+    #Assign the +value+ to the +property+ of the JsWrapper
+    def set_property(property, value)
+      "#{to_javascript}.#{JsWrapper.javascriptify_method(property.to_s)} = #{JsWrapper.javascriptify_variable(value)}"
+    end
+
+    #Returns the code to get a +property+ from the JsWrapper
+    def get_property(property)
+      JsExpr.new("#{to_javascript}.#{JsWrapper.javascriptify_method(property.to_s)}")
+    end
+
+    #Returns a Javascript code representing the object
+    def to_javascript
+      unless @variable.nil?
+        @variable
+      else
+        create
+      end
+    end
+
+    #To cheat JavaScriptGenerator::GeneratorMethods::javascript_object_for
+    def to_json(options = {})
+      to_javascript
+    end
+
+    #Creates a Mapping Object in JavaScript.
+    #To be implemented by subclasses if needed
+    def create
+    end
+  end
+
+  #A valid JavaScript expression that has a value.
+  class JsExpr
+    include JsWrapper
+
+    def initialize(expr)
+      @variable = expr
+    end
+    #Returns the javascript expression contained in the object.
+    def create
+      @variable
+    end
+    def to_s
+      @variable
+    end
+
+    UNDEFINED = JsExpr.new("undefined")
+  end
+
+
+  #Used to bind a ruby variable to an already existing JavaScript one.
+  class JsVar < JsExpr
+  end
+
+
+  #Minimal Wrapper around a Javascript class
+  class JsClass
+    include JsWrapper
+
+    def self.const_missing(sym)
+      if self.const_defined?(sym)
+        k = self.const_get(sym)
+      else
+        k = self.const_set(sym, Class.new(JsClass))
+      end
+    end
+ 
+    def initialize(*args)
+      @args = args
+    end
+
+    def create
+      jsclass = self.class.to_s.split(/::/)[1..-1]
+      jsclass.insert(0, 'OpenLayers') unless jsclass[0] == 'OpenLayers'
+      args = @args.collect{ |arg| JsWrapper.javascriptify_variable(arg) }
+      JsExpr.new("new #{jsclass.join('.')}(#{args.join(',')})")
+    end
+
+  end
+
+  class JsGenerator # :nodoc:
+    def initialize()
+      @lines = ''
+    end
+    def <<(javascript)
+      @lines << (javascript.is_a?(JsWrapper) ? javascript.to_javascript : javascript) << ";\n"
+    end
+    def assign(variable, value)
+      @lines << "#{variable} = #{JsWrapper::javascriptify_variable(value)};\n"
+    end
+    def to_s
+      @lines
+    end
+  end
+
+end

data/lib/map_layers/map.rb

@@ -0,0 +1,89 @@
+module MapLayers
+
+  GOOGLE = OpenLayers::Layer::Google.new("Google Street")
+  GOOGLE_SATELLITE = OpenLayers::Layer::Google.new("Google Satelite", {:type => :G_SATELLITE_MAP})
+  GOOGLE_HYBRID = OpenLayers::Layer::Google.new("Google Hybrid", {:type => :G_HYBRID_MAP})
+  GOOGLE_PHYSICAL = OpenLayers::Layer::Google.new("Google Physical", {:type => :G_PHYSICAL_MAP})
+  VE_ROAD = OpenLayers::Layer::VirtualEarth.new("Virtual Earth Raods", {:type => JsExpr.new('VEMapStyle.Road')})
+  VE_AERIAL = OpenLayers::Layer::VirtualEarth.new("Virtual Earth Aerial", {:type => JsExpr.new('VEMapStyle.Aerial')})
+  VE_HYBRID = OpenLayers::Layer::VirtualEarth.new("Virtual Earth Hybrid", {:type => JsExpr.new('VEMapStyle.Hybrid')})
+  YAHOO =  OpenLayers::Layer::Yahoo.new("Yahoo Street")
+  YAHOO_SATELLITE = OpenLayers::Layer::Yahoo.new("Yahoo Satelite", {:type => :YAHOO_MAP_SAT})
+  YAHOO_HYBRID = OpenLayers::Layer::Yahoo.new("Yahoo Hybrid", {:type => :YAHOO_MAP_HYB})
+  MULTIMAP = OpenLayers::Layer::MultiMap.new("MultiMap")
+  OSM_MAPNIK = OpenLayers::Layer::OSM.new("OpenStreetMap")
+  OSM_TELASCIENCE = OpenLayers::Layer::WMS.new("OpenStreetMap",
+    [
+      "http://t1.hypercube.telascience.org/tiles?",
+      "http://t2.hypercube.telascience.org/tiles?",
+      "http://t3.hypercube.telascience.org/tiles?",
+      "http://t4.hypercube.telascience.org/tiles?"
+    ],
+    {:layers => 'osm-4326', :format => 'image/png' } )
+  GEOPOLE_OSM = OpenLayers::Layer::TMS.new("Geopole Street Map",
+    "http://tms.geopole.org/",
+    {:layername => 'geopole_street', :type => 'png', :maxResolution => 0.703125,
+     :attribution => 'Map data <a href="http://creativecommons.org/licenses/by-sa/2.0/">CCBYSA</a> 2009 <a href="http://openstreetmap.org/">OpenStreetMap.org</a>'})
+  NASA_GLOBAL_MOSAIC = OpenLayers::Layer::WMS.new("NASA Global Mosaic",
+    [
+      "http://t1.hypercube.telascience.org/cgi-bin/landsat7",
+      "http://t2.hypercube.telascience.org/cgi-bin/landsat7",
+      "http://t3.hypercube.telascience.org/cgi-bin/landsat7",
+      "http://t4.hypercube.telascience.org/cgi-bin/landsat7"
+    ],
+    {:layers => 'landsat7'} )
+  BLUE_MARBLE_NG = OpenLayers::Layer::WMS.new("Blue Marble NG",
+    "http://wms.telascience.org/cgi-bin/ngBM_wms",
+    {:layers => 'world_topo_bathy'} )
+  METACARTA_VMAP0 = OpenLayers::Layer::WMS.new("OpenLayers WMS",
+    "http://labs.metacarta.com/wms/vmap0",
+    {:layers => 'basic'} )
+  WORLDWIND = OpenLayers::Layer::WorldWind.new("World Wind LANDSAT",
+    "http://worldwind25.arc.nasa.gov/tile/tile.aspx", 2.25, 4, {:T => "105"}, {:tileSize => OpenLayers::Size.new(512,512)})
+  WORLDWIND_URBAN = OpenLayers::Layer::WorldWind.new("World Wind Urban",
+    "http://worldwind25.arc.nasa.gov/tile/tile.aspx", 0.8, 9, {:T => "104"}, {:tileSize => OpenLayers::Size.new(512,512)})
+  WORLDWIND_BATHY = OpenLayers::Layer::WorldWind.new("World Wind Bathymetry",
+    "http://worldwind25.arc.nasa.gov/tile/tile.aspx", 36, 4, {:T => "bmng.topo.bathy.200406"}, {:tileSize => OpenLayers::Size.new(512,512)})
+
+
+  #Map viewer main class
+  class Map
+    include JsWrapper
+
+    def initialize(map, options = {}, &block)
+      @container = map
+      @variable = map
+      @options = {:theme => false}.merge(options)
+      @js = JsGenerator.new
+      yield(self, @js) if block_given?
+    end
+
+    #Outputs in JavaScript the creation of a OpenLayers.Map object
+    def create
+      "new OpenLayers.Map('#{@container}', #{JsWrapper::javascriptify_variable(@options)})"
+    end
+
+    #Outputs the initialization code for the map
+    def to_html(options = {})
+      no_script_tag = options[:no_script_tag]
+      no_declare = options[:no_declare]
+      no_global = options[:no_global]
+
+      html = ""
+      html << "<script defer=\"defer\" type=\"text/javascript\">\n" if !no_script_tag
+      #put the functions in a separate javascript file to be included in the page
+      html << "var #{@variable};\n" if !no_declare and !no_global
+
+      if !no_declare and no_global
+        html << "#{declare(@variable)}\n"
+      else
+        html << "#{assign_to(@variable)}\n"
+      end
+      html << @js.to_s
+      html << "</script>\n" if !no_script_tag
+
+      html
+    end
+  end
+
+end

data/lib/map_layers/open_layers.rb

@@ -0,0 +1,11 @@
+module OpenLayers
+
+   def self.const_missing(sym)
+     if OpenLayers.const_defined?(sym)
+       OpenLayers.const_get(sym)
+     else
+       OpenLayers.const_set(sym, Class.new(MapLayers::JsClass))
+     end
+   end
+
+end

data/lib/map_layers/version.rb

@@ -0,0 +1,3 @@
+module MapLayers
+  VERSION = "0.0.3"
+end

data/lib/map_layers/view_helpers.rb

@@ -0,0 +1,48 @@
+module MapLayers
+  # Provides methods to generate HTML tags and JavaScript code
+  module ViewHelpers
+    # Insert javascript include tags
+    #
+    # * options[:google] with GMAPS Key: Include Google Maps
+    # * options[:multimap] with MultiMap Key: Include MultiMap
+    # * options[:virtualearth]: Include VirtualEarth
+    # * options[:yahoo] with Yahoo appid: Include Yahoo! Maps
+    # * options[:proxy] with name of controller with proxy action. Defaults to current controller.
+    def map_layers_includes(options = {})
+      options.assert_valid_keys(:google, :multimap, :openstreetmap, :virtualearth, :yahoo, :proxy,:img_path)
+      html = ''
+      if options.has_key?(:google)
+        html << "<script type=\"text/javascript\" src=\"http://maps.google.com/maps?file=api&amp;v=2&amp;key=#{options[:google]}\"></script>"
+      end
+      if options.has_key?(:multimap)
+        html << "<script type=\"text/javascript\" src=\"http://clients.multimap.com/API/maps/1.1/#{options[:multimap]}\"></script>"
+      end
+      if options.has_key?(:virtualearth)
+        html << "<script type=\"text/javascript\" src=\"http://dev.virtualearth.net/mapcontrol/v3/mapcontrol.js\"></script>"
+      end
+      if options.has_key?(:yahoo)
+        html << "<script type=\"text/javascript\" src=\"http://api.maps.yahoo.com/ajaxymap?v=3.0&appid=#{options[:yahoo]}\"></script>"
+      end
+      img_path = '/images/OpenLayers/'
+      if options.has_key?(:img_path)
+        img_path = options[:img_path]
+      end
+      if RAILS_ENV == "development" && File.exist?(File.join(RAILS_ROOT, 'public/javascripts/lib/OpenLayers.js'))
+        html << '<script src="/javascripts/lib/Firebug/firebug.js"></script>'
+        html << '<script src="/javascripts/lib/OpenLayers.js"></script>'
+      else
+        html << javascript_include_tag('OpenLayers')
+      end
+
+
+      html << stylesheet_link_tag("map")
+      img_path=(Pathname(ActionController::Base.relative_url_root||"") +img_path).cleanpath.to_s
+      html << javascript_tag("OpenLayers.ImgPath='"+ img_path  + "/';")
+      proxy = options.has_key?(:proxy) ? options[:proxy] : controller.controller_name
+      html << javascript_tag("OpenLayers.ProxyHost='/#{proxy}/proxy?url=';")
+
+      html
+    end
+  end
+
+end