sinatra_wms 0.0.2 → 0.1.0

data/README.rdoc

@@ -11,7 +11,7 @@ Another way would be to use a Google Map or something and use a JavaScript to ad
 You could zoom in and out an such - but you'd have to care about getting your data to JavaScript to add the markers. And it won't be that fast once you reach some kind of limit.
 
 The solution for this problem: WMS (Web Map Service).  
-This gem helps you to provide a WMS to be used with OpenLayers. OpenLayers will display the OpenStreetMap at a configurable Opacity and add your data on top of it. Whenever you scroll or zoom around the map, OpenLayers will request images of a part of the visible screen. Your code has to generate them on-the-fly and deliver them back.
+This gem helps you to provide a WMS to be used with OpenLayers. OpenLayers will display a baselayer (OpenStreetMap or Google Maps) at a configurable Opacity and add your data on top of it. Whenever you scroll or zoom around the map, OpenLayers will request images of a part of the visible screen. Your code has to generate them on-the-fly and deliver them back.
 
 
 == How do I use SinatraWMS?
@@ -50,8 +50,11 @@ In my example, I will use SinatraWMS to display the locations of my geolocated t
   # This is the main entry point for this app.
   # This code just outputs generic HTML code to load OpenLayers, show the OSM
   # as transparent background and our WMS stuff on top of that.
+  # +:baselayer+ defined which source is used as a map underneath your data.
+  # You could replace +:osm+ by e.g. +:google_streets+ to show Google's street
+  # maps.
   get '/' do
-      SinatraWMS::get_html_for_map_at url("/wms"), :opacity=>0.3, :title=>"My Tweets"
+      SinatraWMS::get_html_for_map_at url("/wms"), :opacity=>0.3, :title=>"My Tweets", :baselayer=>:osm
   end
   
   # This code gets run for every image requested by OpenLayers. It is given a

data/Rakefile

@@ -1,7 +1,12 @@
 require 'rdoc/task'
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RDoc::Task.new do |r|
 	r.main = "README.rdoc"
 	r.rdoc_files.include("README.rdoc", "lib/**/*.rb")
 end
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default=>:spec

data/lib/sinatra_wms/rmagick_extension.rb

@@ -4,29 +4,28 @@ require 'RMagick'
 # Monkeypatching RMagick to add some methods to +Magick::Draw+.
 module Magick
 	class Draw
-		##
-		# Which methods with one coordinates as parameter to add +_wgs84+ method to
-		WMS_FUNCTIONS_SINGLE = %w(color matte point text bigpoint)
-		##
-		# Which methods with two coordinates as parameter to add +_wgs84+ method to
-		WMS_FUNCTIONS_DOUBLE = %w(circle ellipse line rectangle roundrectangle)
+		## Wrapper for +color+, but with coordinates given in WGS84.
+		def color_wgs84(x, y, *args);     args.unshift(* latlon_to_pixels(x, y)); color(*args);    end
+		## Wrapper for +point+, but with coordinates given in WGS84.
+		def point_wgs84(x, y, *args);     args.unshift(* latlon_to_pixels(x, y)); point(*args);    end
+		## Wrapper for +matte+, but with coordinates given in WGS84.
+		def matte_wgs84(x, y, *args);     args.unshift(* latlon_to_pixels(x, y)); matte(*args);    end
+		## Wrapper for +text+, but with coordinates given in WGS84.
+		def text_wgs84(x, y, *args);      args.unshift(* latlon_to_pixels(x, y)); text(*args);     end
+		## Wrapper for +bigpoint+, but with coordinates given in WGS84.
+		def bigpoint_wgs84(x, y, *args);  args.unshift(* latlon_to_pixels(x, y)); bigpoint(*args); end
+		## Wrapper for +ellipse+, but with coordinates given in WGS84.
+		def ellipse_wgs84(x, y, *args);   args.unshift(* latlon_to_pixels(x, y)); ellipse(*args);  end
 		
-		##
-		# We use method_missing to catch calls to the +_wgs84+ methods.
-		def method_missing(sym, *args, &block)
-			result = sym.to_s.match /^([a-z0-9_]+)_(?:wgs84)$/
-			if result && respond_to?(result[1]) && @wms_settings
-				if WMS_FUNCTIONS_SINGLE.include?(result[1])
-					args[0], args[1] = latlon_to_pixels(args[0], args[1])
-				elsif WMS_FUNCTIONS_DOUBLE.include?(result[1])
-					args[0], args[1] = latlon_to_pixels(args[0], args[1])
-					args[2], args[3] = latlon_to_pixels(args[2], args[3])
-				end
-				send(result[1], *args, &block)
-			else
-				super(sym, *args, &block)
-			end
-		end
+		
+		## Wrapper for +circle+, but with coordinates given in WGS84.
+		def circle_wgs84         (x1, y1, x2, y2, *args); args.unshift(* latlon_to_pixels(x2, y2)).unshift(* latlon_to_pixels(x1, y1)); cirle(*args);          end
+		## Wrapper for +line+, but with coordinates given in WGS84.
+		def line_wgs84           (x1, y1, x2, y2, *args); args.unshift(* latlon_to_pixels(x2, y2)).unshift(* latlon_to_pixels(x1, y1)); line(*args);           end
+		## Wrapper for +rectangle+, but with coordinates given in WGS84.
+		def rectangle_wgs84      (x1, y1, x2, y2, *args); args.unshift(* latlon_to_pixels(x2, y2)).unshift(* latlon_to_pixels(x1, y1)); rectangle(*args);      end
+		## Wrapper for +roundrectangle+, but with coordinates given in WGS84.
+		def roundrectangle_wgs84 (x1, y1, x2, y2, *args); args.unshift(* latlon_to_pixels(x2, y2)).unshift(* latlon_to_pixels(x1, y1)); roundrectangle(*args); end
 		
 		##
 		# This method gets the data from +SinatraExtension+ and does some calculations
@@ -45,13 +44,6 @@ module Magick
 			rectangle(x-1, y-1, x+1, y+1)
 		end
 		
-		##
-		# See +method_missing+
-		def respond_to?(sym)
-			result = sym.to_s.match /^([a-z0-9_]+)_(?:wgs84)$/
-			(result && super(result[1]) && @wms_settings) || super(sym)
-		end
-		
 		private
 		##
 		# Converts WGS84 coordinates to pixel values.

data/lib/sinatra_wms/version.rb

@@ -1,3 +1,4 @@
 module SinatraWMS
-  VERSION = "0.0.2"
+  ## Current Version of this gem
+  VERSION = "0.1.0"
 end

data/lib/sinatra_wms.rb

@@ -13,7 +13,7 @@ module SinatraWMS
 	end
 	
 	##
-	# Returns generic HTML code to display a transparent OSM map and images from the WMS.
+	# Returns generic HTML code to display a transparent basemap (OSM or Google Maps) and images from the WMS.
 	#
 	# * +url+ has to be the full URL to the WMS. Since this module can't use Sinatra's helper,
 	#   please call it using this helper, e.g. +url("/wms")+.
@@ -21,15 +21,32 @@ module SinatraWMS
 	#   * +:title+ - Sets the HTML title attribute.
 	#   * +:opacity:+ - Sets the opacity of the OSM map in the background.
 	#   * +:datasource_name+ - Sets the name of the WMS source in the layer selector menu.
+	#   * +:baselayer+ - Which baselayer to use. Supported values are:
+	#     * +:osm+ (default)
+	#     * +:google_streets+
+	#     * +:google_satellite+
+	#     * +:google_hybrid+
+	#     * +:google_terrain+
 	def self.get_html_for_map_at(url, options={})
 		options[:title] ||= "Sinatra-WMS"
 		options[:opacity] ||= 1
 		options[:datasource_name] ||= "WMS-Data"
+		options[:baselayer] ||= :osm
+		
+		baselayer_definition = case options[:baselayer]
+			when :osm then "new OpenLayers.Layer.OSM()"
+			when :google_streets then 'new OpenLayers.Layer.Google("Google Streets")'
+			when :google_satellite then 'new OpenLayers.Layer.Google("Google Satellite", {type: google.maps.MapTypeId.SATELLITE})'
+			when :google_hybrid then 'new OpenLayers.Layer.Google("Google Hybrid", {type: google.maps.MapTypeId.HYBRID})'
+			when :google_terrain then 'new OpenLayers.Layer.Google("Google Terrain", {type: google.maps.MapTypeId.TERRAIN})'
+			else raise "Unknown value for baselayer: #{options[:baselayer]}"
+		end
 
 		%Q{
 		<html>
 			<head>
 				<title>#{options[:title]}</title>
+				#{options[:baselayer].to_s[0..6]=='google_'  ?  '<script src="http://maps.google.com/maps/api/js?v=3.2&sensor=false"></script>'  :  '' }
 				<script src="http://openlayers.org/api/OpenLayers.js"></script>
 				<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
 			</head>
@@ -41,9 +58,10 @@ module SinatraWMS
 					var map = new OpenLayers.Map('map');
 					map.addControl(new OpenLayers.Control.LayerSwitcher());
 
-					var osm_layer = new OpenLayers.Layer.OSM();
-					osm_layer.setOpacity(#{options[:opacity]});
-					map.addLayer(osm_layer);
+					var base_layer = #{baselayer_definition};
+					map.addLayer(base_layer);
+					base_layer.setOpacity(#{options[:opacity]});
+					
 
 					var layer = new OpenLayers.Layer.WMS("#{options[:datasource_name]}", "#{url}", {transparent: true}, {maxExtent: imagebounds});
 

data/sinatra_wms.gemspec

@@ -10,12 +10,14 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/fabianonline/sinatra_wms"
   s.summary     = "Extends Sinatra to allow the developer to easily build a WMS server"
   s.description = %q(A WMS (Web Map Service) is a great way to show lots of geolocated data on a map. Instead of generating static images (which will either be huge or don't have enough resolution), a WMS allows you to dynamically zoom in and out of your dataset.
-This gem allows you to very easily represent your data via a WMS. On one hand it extends Sinatra to give it a method called "wms" to process WMS-requests; on the other hand it extends RMagick to allow the developer to use coordinates in the methods used for drawing.)
+This gem allows you to very easily represent your data via a WMS. On one hand it extends Sinatra to give it a method called "wms" to process WMS-requests; on the other hand it extends RMagick to allow the developer to use coordinates in the methods used for drawing.
+Convenient methods to easily generate HTML code to show your WMS data on top of OpenStreetMaps or Google Maps are also included.)
 
   s.rubyforge_project = "sinatra_wms"
 
   s.add_dependency('sinatra', '>=1.0.0')
   s.add_dependency('rmagick')
+  s.add_development_dependency('rspec', '~> 2.9')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/sinatra_wms_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'sinatra_wms'
+
+describe SinatraWMS do
+	describe 'merc_to_latlon' do
+		it 'should work at the center of the coordinate system' do
+			SinatraWMS::merc_to_latlon(0, 0).should == [0.0, 0.0]
+		end
+		
+		it 'should work for other coordinates' do
+			coords = SinatraWMS::merc_to_latlon(-626172.13571216376, 6887893.4928337997)
+			(coords[0]*100000000).round.should == 5248278022
+			(coords[1]*1000).round.should  == -5625
+		end
+	end
+	
+	describe 'get_html_for_map_at' do
+		it 'should include the correct URL' do
+			SinatraWMS::get_html_for_map_at('/test').should =~ /new OpenLayers.Layer.WMS\("[^"]+", "\/test"/
+		end
+		
+		it 'shouldn\'t load Google Maps unless necessary' do
+			SinatraWMS::get_html_for_map_at('/test').should_not =~ /maps.google.com\/maps\/api\/js/
+		end
+		
+		it 'should load Google Maps when necessary' do
+			SinatraWMS::get_html_for_map_at('/test', :baselayer=>:google_streets).should =~ /maps.google.com\/maps\/api\/js/
+			SinatraWMS::get_html_for_map_at('/test', :baselayer=>:google_satellite).should =~ /maps.google.com\/maps\/api\/js/
+			SinatraWMS::get_html_for_map_at('/test', :baselayer=>:google_hybrid).should =~ /maps.google.com\/maps\/api\/js/
+			SinatraWMS::get_html_for_map_at('/test', :baselayer=>:google_terrain).should =~ /maps.google.com\/maps\/api\/js/
+		end
+		
+		it 'should raise an error when an unknown baselayer is to be set' do
+			expect {SinatraWMS::get_html_for_map_at('/test', :baselayer=>:foo)}.to raise_error
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+
+RSpec.configure do |config|
+	config.color_enabled = true
+	config.formatter = 'documentation'
+end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Fabian Schlenz (@fabianonline)
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-23 00:00:00 +02:00
+date: 2012-04-24 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,9 +48,25 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 2
+        - 9
+        version: "2.9"
+  type: :development
+  version_requirements: *id003
 description: |-
   A WMS (Web Map Service) is a great way to show lots of geolocated data on a map. Instead of generating static images (which will either be huge or don't have enough resolution), a WMS allows you to dynamically zoom in and out of your dataset.
   This gem allows you to very easily represent your data via a WMS. On one hand it extends Sinatra to give it a method called "wms" to process WMS-requests; on the other hand it extends RMagick to allow the developer to use coordinates in the methods used for drawing.
+  Convenient methods to easily generate HTML code to show your WMS data on top of OpenStreetMaps or Google Maps are also included.
 email: 
 - mail@fabianonline.de
 executables: []
@@ -69,6 +85,8 @@ files:
 - lib/sinatra_wms/sinatra_extension.rb
 - lib/sinatra_wms/version.rb
 - sinatra_wms.gemspec
+- spec/sinatra_wms_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/fabianonline/sinatra_wms
 licenses: []