File: README — Documentation for ruby

Ruby MapScript API extensions

This gem extends the ‘SWIG MapScript API <mapserver.org/mapscript/mapscript.html>`_ of `UMN MapServer <mapserver.org/>`_ with Ruby-like iterators and other API methods.

Installation

ruby_mapscript requires the MapScript API library to be installed.

A Mapserver binary (CGI) is not required for executing ruby_mapscript code.

To use the gem, add it to your Gemfile or install it manually: gem install ruby_mapscript

Usage

To use ruby_mapscript, require the gem and include Mapscript in your class/module or globally

require “rubygems” require “ruby_mapscript” include Mapscript

ruby_mapscript provides a Ruby-like iterator interface to MapScript collections

map.layers.each do |layer|

puts layer.name

end

With the native SWIG API this would be something like

0.upto(map.numlayers-1) do |i|

layer = map.getLayer(i)
puts layer.name

end

ruby_mapscript iterators include Enumerable which gives you the same methods as Ruby Arrays and Hashes have

wms_layers = map.layers.select { |layer| layer.connectiontype == MS_WMS }

To run a MapScript based WMS server as a Rack application create config.ru

require “ruby_mapscript/mapserver”

run RubyMapscript::Mapserver.new(‘test.map’)

and call

rackup config.ru

To include a WMS server in a Rails application, require “ruby_mapscript/mapserver” and add a line to your routes.rb

match “/wms” => RubyMapscript::Mapserver.new(‘test.map’)