ruby_mapscript 0.3.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby-mapscript.gemspec
+gemspec

data/README.rst

@@ -0,0 +1,64 @@
+Ruby MapScript API extensions
+=============================
+
+This gem extends the `SWIG MapScript API <http://mapserver.org/mapscript/mapscript.html>`_
+of `UMN MapServer <http://mapserver.org/>`_ with Ruby-like iterators and other API methods.
+
+Installation
+------------
+
+ruby_mapscript requires the MapScript API library to be installed.
+On Debian/Ubuntu systems::
+
+  sudo apt-get install libmapscript-ruby
+
+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')
+
+
+*Copyright (c) 2012 Pirmin Kalberer, Sourcepole AG*

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+#Test::Unit
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+ t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/mapscript/mapscript_extensions.rb

@@ -0,0 +1,252 @@
+# Ruby Mapscript API extensions
+
+require "mapscript"
+
+module Mapscript
+
+  # Generic iterator for Mapscript collections
+  class MapscriptEnumerable
+    include Enumerable
+
+    def initialize(parent, size_method, getter)
+      @parent, @size_method, @getter  = parent, size_method, getter
+    end
+
+    def size
+      @parent.send(@size_method)
+    end
+
+    def each
+      0.upto(size-1) do |idx|
+        yield @parent.send(@getter, idx)
+      end
+    end
+
+    def [](idx)
+      case idx
+        when Fixnum
+          if idx >= 0
+            @parent.send(@getter, idx)
+          else
+            @parent.send(@getter, size+idx)
+          end
+        when Range
+          to_a[idx]
+        else
+          raise TypeError, "Unsupported type for index"
+      end
+    end
+
+  end
+
+  # LayerObj iterator
+  class MapLayers < MapscriptEnumerable
+
+    def initialize(map)
+      super(map, :numlayers, :getLayer)
+      @map = map
+    end
+
+    def [](idx)
+      case idx
+        when Fixnum
+          if idx >= 0
+            @map.getLayer(idx)
+          else
+            @map.getLayer(@map.numlayers+idx)
+          end
+        when Range
+          to_a[idx]
+        when String
+          @map.getLayerByName(idx)
+        else
+          raise TypeError, "Unsupported type for index"
+      end
+    end
+
+    def <<(layer)
+      @map.insertLayer(layer, @map.numlayers-1)
+    end
+  end
+
+  # ClassObj iterator
+  class LayerClasses < MapscriptEnumerable
+
+    def initialize(layer)
+      super(layer, :numclasses, :getClass)
+      @layer = layer
+    end
+ 
+    def [](idx)
+      case idx
+        when Fixnum
+          if idx >= 0
+            @layer.getClass(idx)
+          else
+            @layer.getClass(@layer.numclasses+idx)
+          end
+        when Range
+          to_a[idx]
+        when String
+          find { |cls| cls.name == idx }
+        else
+          raise TypeError, "Unsupported type for index"
+      end
+    end
+
+    def <<(newclass)
+      @layer.insertClass(newclass, @layer.numclasses-1)
+    end
+  end
+
+
+  # ClassObj extensions
+  class ClassObj
+    # Return StyleObj iterator
+    def styles
+      @styles ||= MapscriptEnumerable.new(self, :numstyles, :getStyle)
+    end
+  end
+
+  # HashTableObj extensions
+  class HashTableObj
+    include Enumerable
+
+    def [](key)
+      get(key)
+    end
+
+    def []=(key, value)
+      set(key, value)
+    end
+
+    def each_key
+      key = nextKey(nil)
+      while key
+        yield key
+        key = nextKey(key)
+      end
+    end
+
+    def has_key?(key)
+      !get(key).nil?
+    end
+
+    alias :key? :has_key?
+    alias :include? :has_key?
+
+    def keys
+      ary = []
+      each_key { |key| ary << key }
+      ary
+    end
+
+    alias :length :numitems
+    alias :size :numitems
+
+    def empty?
+      numitems == 0
+    end
+
+    alias :delete :remove
+
+    def each_pair
+      key = nextKey(nil)
+      while key
+        yield key, get(key)
+        key = nextKey(key)
+      end
+    end
+
+    alias :each :each_pair
+
+    def to_hash
+      h = {}
+      each_pair { |key, value| h[key] = value }
+      h
+    end
+
+    def inspect
+      to_hash.inspect
+    end
+
+  end
+
+  # LabelObj extensions
+  class LabelObj
+    # Return styleObj iterator
+    def styles
+      @styles ||= MapscriptEnumerable.new(self, :numstyles, :getStyle)
+    end
+  end
+
+  # LayerObj extensions
+  class LayerObj
+    # Return ClassObj iterator
+    def classes
+      @classes ||= LayerClasses.new(self)
+    end
+
+    # Return string iterator
+    def processings
+      @processings ||= MapscriptEnumerable.new(self, :numprocessing, :getProcessing)
+    end
+
+    def visible?
+      isVisible == MS_TRUE
+    end
+  end
+
+  # LineObj extensions
+  class LineObj
+    # Return pointObj iterator
+    def points
+      @points ||= MapscriptEnumerable.new(self, :numpoints, :get)
+    end
+  end
+
+  # MapObj extensions
+  class MapObj
+    # Return LayerObj iterator
+    def layers
+      @map_layers ||= MapLayers.new(self)
+    end
+  end
+
+  # ResultCacheObj extensions
+  class ResultCacheObj
+    # Return resultCacheObj iterator
+    def results
+      @results ||= MapscriptEnumerable.new(self, :numresults, :getResult)
+    end
+  end
+
+  # ShapefileObj extensions
+  class ShapefileObj
+    # Return shapeObj iterator
+    def shapes
+      @shapes ||= MapscriptEnumerable.new(self, :numshapes, :getShape)
+    end
+  end
+
+  # ShapeObj extensions
+  class ShapeObj
+    # Return lineObj iterator
+    def lines
+      @lines ||= MapscriptEnumerable.new(self, :numlines, :get)
+    end
+
+    # Return shape attribute (string) iterator
+    def values
+      @values ||= MapscriptEnumerable.new(self, :numvalues, :getValue)
+    end
+  end
+
+  # SymbolSetObj extensions
+  class SymbolSetObj
+    # Return symbolObj iterator
+    def symbols
+      @symbols ||= MapscriptEnumerable.new(self, :numsymbols, :getSymbol) #:getSymbolByName
+    end
+  end
+end

data/lib/ruby_mapscript.rb

@@ -0,0 +1,2 @@
+require "ruby_mapscript/version"
+require "mapscript/mapscript_extensions"

data/lib/ruby_mapscript/mapserver.rb

@@ -0,0 +1,37 @@
+# OGC compliant map server Rack Application
+# OWS requests include WMS, WFS, WCS and SOS requests supported by MapServer
+
+require "mapscript"
+
+module RubyMapscript
+
+class Mapserver
+
+  def initialize(mapfile)
+    @wms = Mapscript::MapObj.new(mapfile)
+  end
+
+  def call(env)
+    req = Mapscript::OWSRequest.new
+    %w(REQUEST_METHOD QUERY_STRING HTTP_COOKIE).each do |var|
+      ENV[var] = env[var]
+    end
+    req.loadParams
+    #Returns the number of name/value pairs collected.
+    #Warning: most errors will result in a process exit!
+
+    # redirect stdout & handle request
+    Mapscript::msIO_installStdoutToBuffer()
+    retval = @wms.OWSDispatch(req)
+    #Returns MS_DONE (2) if there is no valid OWS request in the req object,
+    # MS_SUCCESS (0) if an OWS request was successfully processed and
+    # MS_FAILURE (1) if an OWS request was not successfully processed.
+    content_type = Mapscript::msIO_stripStdoutBufferContentType()
+    map_image = Mapscript::msIO_getStdoutBufferBytes()
+    Mapscript::msIO_resetHandlers()
+
+    [200, {'Content-Type' => content_type}, map_image]
+  end
+end
+
+end

data/lib/ruby_mapscript/version.rb

@@ -0,0 +1,3 @@
+module RubyMapscript
+  VERSION = "0.3.0"
+end

data/ruby_mapscript.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby_mapscript/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby_mapscript"
+  s.version     = RubyMapscript::VERSION
+  s.authors     = ["Pirmin Kalberer"]
+  s.email       = ["pka@sourcepole.ch"]
+  s.homepage    = "https://github.com/sourcepole/ruby_mapscript"
+  s.summary     = %q{Ruby Mapscript API extensions}
+  s.description = %q{Ruby Mapscript API extensions}
+
+  s.rubyforge_project = "ruby_mapscript"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/empty.map

@@ -0,0 +1,17 @@
+MAP
+  NAME "Empty Map"
+  SIZE 600 600
+  EXTENT -180 -90 180 90
+  IMAGECOLOR 180 180 250
+  IMAGETYPE PNG
+
+  UNITS DD
+  PROJECTION
+    "init=epsg:4326"
+  END
+
+  WEB
+    IMAGEPATH "/tmp/"
+    IMAGEURL "/tmp/"
+  END
+END

data/test/test.map

@@ -0,0 +1,69 @@
+MAP
+  NAME "Test Map"
+  SIZE 600 600
+  EXTENT -180 -90 180 90
+  IMAGECOLOR 180 180 250
+  IMAGETYPE PNG
+
+  #CONFIG "MS_ERRORFILE" "stderr" # http://mapserver.org/optimization/debugging.html#step-1-set-the-ms-errorfile-variable
+  #DEBUG 5 # http://mapserver.org/optimization/debugging.html#step-2-set-the-debug-level
+  #CONFIG "CPL_DEBUG" "ON" # http://mapserver.org/optimization/debugging.html#step-3-turn-on-cpl-debug-optional
+  #CONFIG "PROJ_DEBUG" "ON" # http://mapserver.org/optimization/debugging.html#step-4-turn-on-proj-debug-optional
+
+  UNITS DD
+  PROJECTION
+    "init=epsg:4326"
+  END
+
+  WEB
+    IMAGEPATH "/tmp/"
+    IMAGEURL "/tmp/"
+    METADATA
+      "wms_srs" "EPSG:4326"
+      "wms_onlineresource"      "http://localhost:9292/"
+      "ows_enable_request"      "*"
+      "wms_feature_info_mime_type"      "text/html"
+      "wms_title"       "Rackup Test WMS"
+    END # METADATA
+  END # WEB
+
+  LAYER
+    NAME "wms_layer"
+    TYPE RASTER
+    STATUS OFF
+    CONNECTIONTYPE WMS
+    CONNECTION "http://iceds.ge.ucl.ac.uk/cgi-bin/icedswms?"
+    METADATA
+      "wms_title" "WMS Layer"
+      "wms_extent" "-180 -90 180 90"
+      "wms_srs" "EPSG:4326"
+      "wms_name" "landsat5,landsat,GRID"
+      "wms_server_version" "1.1.1"
+      "wms_format" "image/jpeg"
+    END
+  END
+
+  LAYER
+    NAME shppoly
+    TYPE line
+    DATA "data/world_testpoly.shp"
+    STATUS ON
+    CLASSITEM "FID"
+    CLASS
+      NAME "test1"
+      STYLE
+          COLOR 20 20 20
+          WIDTH 5
+      END
+      STYLE
+          COLOR 50 50 255
+          WIDTH 3
+      END
+      STYLE
+          COLOR 255 255 0
+          WIDTH 1
+          PATTERN 4 4 END
+      END
+    END
+  END
+END

data/test/test_mapscript_extensions.rb

@@ -0,0 +1,166 @@
+require 'test/unit'
+require "ruby_mapscript"
+include Mapscript
+
+class TestMapscriptExtension < Test::Unit::TestCase
+  def setup
+    mapfile = File.join(File.dirname(__FILE__), 'test.map')
+    @map = MapObj.new(mapfile)
+  end
+
+  def test_arrays
+    assert_equal 0, @map.getLayersDrawingOrder[0]
+    style = @map.layers['shppoly'].classes.first.styles[-1]
+    assert_equal SWIG::TYPE_p_double, style.pattern.class
+    if defined?(Doublearray)
+      pattern = Doublearray.frompointer(style.pattern)
+      assert_equal 4.0, pattern[0]
+      assert_equal 4.0, pattern[style.patternlength-1]
+    else
+      puts "Warning: Mapscript library does not support Doublearray"
+    end
+  end
+
+  def test_hashtable
+    layer = @map.layers['wms_layer']
+    metadata = layer.metadata
+
+    assert metadata.has_key?("wms_title")
+    assert metadata.key?("wms_title")
+    assert metadata.include?("wms_title")
+    assert !metadata.key?("XXX")
+
+    assert_equal 6, metadata.numitems
+    assert_equal metadata.numitems, metadata.length
+    assert_equal metadata.numitems, metadata.keys.size
+
+    assert metadata.keys.include?("wms_title")
+    assert_equal "WMS Layer", metadata["wms_title"]
+
+    metadata.each do |k, v|
+      assert_equal metadata[k], v
+    end
+
+    #Update entry
+    metadata["wms_title"] = "New Title"
+    assert_equal "New Title", metadata["wms_title"]
+
+    #Add new entry
+    metadata["new_key"] = "New Value"
+    assert_equal 7, metadata.numitems
+
+    metadata.delete("new_key")
+    assert_equal 6, metadata.numitems
+
+    assert_equal "EPSG:4326", metadata.to_hash["wms_srs"]
+
+    #Enumerable
+    assert_equal metadata.keys, metadata.collect { |k, v| k }
+    assert_equal ["wms_srs", "EPSG:4326"], metadata.to_a.first
+
+    #Test Empty Hash
+    metadata = @map.web.metadata
+    assert !metadata.key?("wms_title")
+    assert_equal 0, metadata.numitems
+    assert_equal metadata.numitems, metadata.length
+    assert_equal metadata.numitems, metadata.keys.size
+    assert metadata.keys.empty?
+    assert_nil metadata["wms_title"]
+    metadata.each {}
+    metadata["new_key"] = "New Value"
+    assert_equal 1, metadata.numitems
+    metadata.delete("new_key")
+    assert_equal 0, metadata.numitems
+    assert_equal({}, metadata.to_hash)
+  end
+
+  def test_layer_access
+    assert_equal @map.numlayers, @map.layers.size
+    assert_equal @map.numlayers, @map.layers.count #From Enumerable
+    assert_equal @map.numlayers, @map.layers.to_a.size #to_a from Enumerable
+    assert_equal @map.numlayers, @map.layers[0..-1].size
+    assert_equal 0, @map.layers.first.index
+    @map.layers.each_with_index do |l, i|
+      assert_equal i, @map.layers[i].index
+    end
+    assert_equal 'wms_layer', @map.layers[0].name
+    assert_equal 'wms_layer', @map.layers[-@map.numlayers].name
+    assert_nil @map.layers[99]
+    assert_equal 'wms_layer', @map.layers['wms_layer'].name
+    assert_nil @map.layers['xxx']
+    oldcnt = @map.numlayers
+    @map.layers << @map.layers.first
+    assert_equal oldcnt+1, @map.numlayers
+    assert_equal @map.numlayers, @map.layers.to_a.size
+    assert_equal @map.numlayers, @map.layers[0..-1].size
+
+    assert !@map.layers.first.visible?
+  end
+
+  def test_class_access
+    layer = @map.layers['shppoly']
+    assert_equal layer.numclasses, layer.classes.to_a.size
+    assert_equal layer.numclasses, layer.classes[0..-1].size
+    assert_equal 'test1', layer.classes[0].name
+    assert_equal 'test1', layer.classes[-layer.numclasses].name
+    assert_nil layer.classes[99]
+    assert_equal 'test1', layer.classes['test1'].name
+    assert_nil layer.classes['xxx']
+    oldcnt = layer.numclasses
+    layer.classes << layer.classes.first
+    assert_equal oldcnt+1, layer.numclasses
+    assert_equal layer.numclasses, layer.classes.to_a.size
+    assert_equal layer.numclasses, layer.classes[0..-1].size
+  end
+
+  def test_iterators
+    assert_equal 0, LabelObj.new.styles.size
+
+    assert_equal 0, ResultCacheObj.new.results.size
+
+    shapefile = File.join(File.dirname(__FILE__), 'data', 'world_testpoly.shp')
+    shapefile_obj = ShapefileObj.new(shapefile)
+    assert_equal 4, shapefile_obj.shapes.size
+    shape = shapefile_obj.shapes[0]
+    assert_equal 0, shape.index
+    assert_equal 1, shape.lines.size
+    lines = shape.lines[0]
+    assert_equal 0, shape.values.size
+    assert_equal 5, lines.points.size
+    point = lines.points[0]
+    assert_not_nil point
+
+    symbol_set = SymbolSetObj.new
+    assert_equal 1, symbol_set.symbols.size
+    assert_not_nil symbol_set.symbols[0]
+  end
+
+  def test_empty_map
+    mapfile = File.join(File.dirname(__FILE__), 'empty.map')
+    @map = MapObj.new(mapfile)
+    assert_equal 0, @map.layers.to_a.size
+    assert_nil @map.layers[0]
+    assert_nil @map.layers[-1]
+    assert_nil @map.layers['wms_layer']
+    @map.layers.each { }
+  end
+
+  def test_draw
+    mapimage = @map.draw
+    assert mapimage.getSize >= 2338
+  end
+
+  def test_examples
+    map = @map
+    map.layers.each do |layer|
+      #puts layer.name
+    end
+    0.upto(map.numlayers-1) do |i|
+      layer = map.getLayer(i)
+      #puts layer.name
+    end
+    wms_layers = map.layers.select { |layer| layer.connectiontype == MS_WMS }
+    assert_equal 1, wms_layers.size
+  end
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: ruby_mapscript
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Pirmin Kalberer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-24 00:00:00 Z
+dependencies: []
+
+description: Ruby Mapscript API extensions
+email: 
+- pka@sourcepole.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rst
+- Rakefile
+- lib/mapscript/mapscript_extensions.rb
+- lib/ruby_mapscript.rb
+- lib/ruby_mapscript/mapserver.rb
+- lib/ruby_mapscript/version.rb
+- ruby_mapscript.gemspec
+- test/data/world_testpoly.dbf
+- test/data/world_testpoly.shp
+- test/data/world_testpoly.shx
+- test/empty.map
+- test/test.map
+- test/test_mapscript_extensions.rb
+homepage: https://github.com/sourcepole/ruby_mapscript
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ruby_mapscript
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Ruby Mapscript API extensions
+test_files: []
+