ruby_mapnik 0.1 → 0.1.2

data/README.rdoc

@@ -11,13 +11,13 @@ https://github.com/mapnik/Ruby-Mapnik
 == Description
 
 A set of bindings between Ruby and Mapnik. Supports many of the common uses for 
-Mapnik, and one day, might support al of them. Rundering is available using
-the plain agg library, or via Cairo, if the rcairo gem is installed and 
-Mapnik has been compiled with Cairo support.
+Mapnik, and one day, might support all of them. Rendering is available using
+the standard AGG library, or additionally via Cairo, if the rcairo gem is 
+installed and Mapnik has been compiled with Cairo support.
 
 == Installation
 
-Coming Soon!
+  gem install ruby_mapnik
 
 Note: on osx the default rake compile will try to build universal, and your
 mapnik install is unlikely built universal. Check the architecture of libmapnik2.dylib like:

data/Rakefile

@@ -28,7 +28,7 @@ Hoe.plugin :bundler, :rubygems, :doofus, :git
 Hoe.spec 'ruby_mapnik' do
   developer('Elliot Laster', 'elliotlaster@gmail.com')
   self.readme_file   = 'README.rdoc'
-  # self.history_file  = 'CHANGELOG.rdoc'
+  self.history_file  = 'History.txt'
   self.extra_deps << ['rice', '>= 1.4.2']
   self.extra_dev_deps << ['rake-compiler', '>= 0']
 

data/ext/ruby_mapnik/_mapnik_feature.rb.cpp

@@ -30,15 +30,9 @@ SOFTWARE.
 #include <mapnik/wkt/wkt_factory.hpp>
 #include <mapnik/feature.hpp>
 
-// A cop out of sorts. I'll need to do more research on how to transfer ownership
-// via rice.
-void add_geometry(mapnik::Feature * self, std::string wkt){
-  std::pair<bool,mapnik::geometry_type*> result = mapnik::from_wkt(wkt);
-  if (result.first){
-    self->add_geometry(result.second);
-  } else {
-    throw std::runtime_error("Failed to parse WKT");
-  }
+void add_geometries_from_wkt(mapnik::Feature * self, std::string wkt){
+  bool result = mapnik::from_wkt(wkt, self->paths());
+  if (!result) throw std::runtime_error("Failed to parse WKT");
 }
 
 void register_feature(Rice::Module rb_mapnik){
@@ -52,5 +46,5 @@ void register_feature(Rice::Module rb_mapnik){
   rb_cfeature.define_method("number_of_geometries", &mapnik::Feature::num_geometries);
   rb_cfeature.define_method("envelope", &mapnik::Feature::envelope);
   
-  rb_cfeature.define_method("add_geometry", &add_geometry, Rice::Arg("geom"));  
+  rb_cfeature.define_method("add_geometries_from_wkt", &add_geometries_from_wkt, Rice::Arg("geom"));  
 }

data/ext/ruby_mapnik/_mapnik_geometry.rb.cpp

@@ -32,14 +32,25 @@ SOFTWARE.
 #include <mapnik/wkt/wkt_factory.hpp>
 
 namespace{
+
+  typedef boost::ptr_vector<mapnik::geometry_type> path_type;
+
   // Borrowed from the python bindings...
-  mapnik::geometry_type * make_from_wkt(std::string const& wkt) {
+  void from_wkt_impl(path_type& p, std::string const& wkt)
+  {
+      bool result = mapnik::from_wkt(wkt, p);
+      if (!result) throw std::runtime_error("Failed to parse WKT");
+  }
+
+/*
+  mapnik::geometry_type * from_wkt_impl(std::string const& wkt) {
     std::pair<bool,mapnik::geometry_type*> result = mapnik::from_wkt(wkt);
     if (result.first){
       return result.second;
     }
     throw std::runtime_error("Failed to parse WKT");
   }
+*/
 
 }
 
@@ -65,9 +76,11 @@ void register_geometry(Rice::Module rb_mapnik){
   geometry_enum.define_value("MultiPolygon",mapnik::MultiPolygon);
   
   Rice::Data_Type< mapnik::geometry_type > rb_cgeometry2d = Rice::define_class_under< mapnik::geometry_type >(rb_mapnik, "Geometry2d");
-  rb_cgeometry2d.define_singleton_method("from_wkt", &make_from_wkt, Rice::Arg("wkt"));
   rb_cgeometry2d.define_method("envelope", &mapnik::geometry_type::envelope);
   rb_cgeometry2d.define_method("type", &mapnik::geometry_type::type);
   rb_cgeometry2d.define_method("area", &mapnik::geometry_type::area);
+
+  Rice::Data_Type< path_type > rb_cpath = Rice::define_class_under< path_type >(rb_mapnik, "Path");
+  rb_cpath.define_singleton_method("from_wkt", &from_wkt_impl, Rice::Arg("wkt"));
 }
 

data/ext/ruby_mapnik/_mapnik_map.rb.cpp

@@ -163,13 +163,25 @@ namespace {
 void register_map(Rice::Module rb_mapnik){
   /*
     @@Module_var rb_mapnik = Mapnik
+    Document-class: Mapnik::Map
+    
+    Maps are exactly what they sound like: the reason you are using mapnik. Maps
+    have layers, which wrap a datasource, and styles, which contain instructions
+    on how to render those layers. 
+
+    Maps can be rendered to basic image formats (jpg, png), as well as to cairo
+    surfaces and contexts, if mapnik has been compiled with cairo support, and if 
+    the rcairo gem is installed. 
+  
   */
   Rice::Data_Type< mapnik::Map > rb_cmap = Rice::define_class_under< mapnik::Map >(rb_mapnik, "Map");
   
   /* 
   * Document-method: new
+  * Instantiates a new map object. The map is yielded if a block is given.
   * @return [Mapnik::Map] a new map object
   * @yield [map] the new map object
+
   */
   rb_cmap.define_constructor(Rice::Constructor< mapnik::Map >());
   
@@ -235,6 +247,7 @@ void register_map(Rice::Module rb_mapnik){
   
   /*
   * Document-method: height
+  * The height of the rendered image in pixels.
   * @return [Integer]
   */
   rb_cmap.define_method("height", &mapnik::Map::height);
@@ -243,7 +256,8 @@ void register_map(Rice::Module rb_mapnik){
   * Document-method: height=
   * call-seq:
   *   height=(height_in_pixels) 
-  * @param [Integer]
+  * Sets the height of the rendered image.
+  * @param [Integer] height_in_pixels
   * @return [nil]
   */
   rb_cmap.define_method("height=", &mapnik::Map::set_height);
@@ -265,6 +279,8 @@ void register_map(Rice::Module rb_mapnik){
   
   /*
   * Document-method: srs
+  * The spatial reference system string for the map. It does not need to match 
+  * the srs of any of the layers.
   * @return [String]
   */
   rb_cmap.define_method("srs", &mapnik::Map::srs);
@@ -273,6 +289,9 @@ void register_map(Rice::Module rb_mapnik){
   * Document-method: srs=
   * call-seq:
   *   srs=(new_srs)
+  * Sets the spatial reference system that will be used to render the map. All
+  * layers will have thier data reprojected to this srs behind the scenes. 
+  *
   * @param [String]
   * @return [nil]
   */
@@ -280,14 +299,16 @@ void register_map(Rice::Module rb_mapnik){
   
   /*
   * Document-method: width
+  * The width of the image in pixels.
   * @return [Integer]
   */
   rb_cmap.define_method("width", &mapnik::Map::width);
   
   /*
-  * Document-method width=
+  * Document-method: width=
   * call-seq:
   *  width=(new_width)
+  * Sets the width of the image.
   * @param [Integer] new_width in pixels
   * @return [nil]
   */
@@ -327,6 +348,7 @@ void register_map(Rice::Module rb_mapnik){
   
   /*
   * Document-method: zoom_all
+  * Zooms the map so that all of the envelopes of the layers are visible.
   * @return [nil]
   */
   rb_cmap.define_method("zoom_all", &mapnik::Map::zoom_all);
@@ -335,6 +357,9 @@ void register_map(Rice::Module rb_mapnik){
   * Document-method: zoom_to_box
   * call-seq:
   *   zoom_to_box(envelope)
+  * Zooms the map such that the envelope provided is all that will be rendered.
+  * The height and width of the map will stay the same, but the content will be 
+  * zoomed.
   * @param [Mapnik::Envelope] envelope
   * @return [nil]
   */
@@ -344,6 +369,7 @@ void register_map(Rice::Module rb_mapnik){
   * Document-method: resize
   * call-seq:
   *   resize(new_width, new_height)
+  * Resizes the height and width of the map in one step.
   * @param [Integer] new_width in pixels
   * @param [Integer] new_height in pixels
   * @return [nil]

data/ext/ruby_mapnik/extconf.rb

@@ -39,7 +39,9 @@ LIBDIR = Config::CONFIG['libdir']
 INCLUDEDIR = Config::CONFIG['includedir'] 
 
 $LDFLAGS += " -lmapnik2 "
-$CFLAGS += %x{mapnik-config --cflags}
+
+# force whitespace padding to avoid: https://github.com/mapnik/Ruby-Mapnik/issues/7
+$CFLAGS += " " + %x{mapnik-config --cflags} + " "
 
 #------------------------------------------------------------------------------#
 # Ruby-Mapnik configuration
@@ -75,4 +77,4 @@ if RUBY_PLATFORM =~ /darwin/
     append_ld_flags '-all_load'
 end
 
-create_makefile("ruby_mapnik")
+create_makefile("ruby_mapnik/ruby_mapnik")

data/lib/ruby_mapnik/mapnik/layer.rb

@@ -62,7 +62,6 @@ module Mapnik
       styles
     end
     
-    private :__style_list__, :__append_style__
     
   end
   

data/lib/ruby_mapnik/mapnik/map.rb

@@ -86,6 +86,7 @@ module Mapnik
     
     class << self
       
+      # Loads a map from an xml string.
       # @return [Mapnik::Map]
       def from_xml(xml, strict = false, base_path = "")
         map = new
@@ -93,15 +94,25 @@ module Mapnik
         map
       end
       
+      # Loads a map from an xml file. 
       # @return [Mapnik::Map]
-      def from_file(filename, strict = false)
+      # @param [File, String] file Can be a string representing a file path, or a file object
+      def from_file(file, strict = false)
+        if file.is_a?(File)
+          path = File.expand_path(file.path)
+        else
+          path = file
+        end
         map = new
-        __load_map__(map, filename, strict)
+        __load_map__(map, path, strict)
         map
       end
             
     end
     
+    # Creates and yeilds a new style object, then adds that style to the 
+    # map's collection of styles, under the name passed in. Makes no effort
+    # to de-dupe style name collisions.
     # @return [Mapnik::Style]
     def style(name)
       style = Mapnik::Style.new
@@ -109,6 +120,7 @@ module Mapnik
       styles[name] = style
     end
     
+    # The styles for this map.
     # @return [Mapnik::StyleContainer]
     def styles
       styles = MapStyleContainer[__styles__]
@@ -116,6 +128,9 @@ module Mapnik
       styles
     end
     
+    # Creates and yields a new layer object, then adds that layer to the map's 
+    # collection of layers. If the srs is not provided in the initial call,
+    # it will need to be provided in the block.
     # @return [Mapnik::Layer]
     def layer(name, srs = nil)
       layer = Mapnik::Layer.new(name, srs)
@@ -124,20 +139,22 @@ module Mapnik
       layers << layer
     end
     
+    # The layers associated with this map
     # @return [Mapnik::MapLayerContainer]
     def layers
       layers = MapLayerContainer.new(__layers__)
       layers.map = self
       layers
     end
-    
-    # @return [nil]
+
+    # Renders the map to a file. Returns true or false depending if the
+    # render was successful. The image type is inferred from the filename.
+    # @param [String] filename Should end in one of "png", "jpg", or "tiff"
+    # @return [Boolean]
     def render_to_file(filename)
       __render_to_file__(filename)
+      return File.exists?(filename)
     end
-      
-    private :__styles__, :__insert_style__, :__remove_style__, :__layers__, 
-            :__add_layer__, :__remove_layer__
     
   end
   

data/lib/ruby_mapnik/mapnik/projection.rb

@@ -39,8 +39,6 @@ module Mapnik
         __inverse_pt__(obj)
       end
     end
-    
-    private :__forward_pt__, :__forward_env__, :__inverse_pt__, :__inverse_env__
-    
+        
   end
 end

data/lib/ruby_mapnik/mapnik/rule.rb

@@ -99,9 +99,7 @@ module Mapnik
       symbol_container.rule = self
       symbol_container
     end
-    
-    private :__symbols__, :__append_symbol__, :__remove_symbol__
-    
+        
   end
 end
 

data/lib/ruby_mapnik/mapnik/stroke.rb

@@ -50,9 +50,7 @@ module Mapnik
       dashes.stroke = self
       dashes
     end
-    
-    private :__dashes__, :__add_dash__
-    
+        
   end
   
 end

data/lib/ruby_mapnik/mapnik/style.rb

@@ -58,9 +58,7 @@ module Mapnik
       rules.style = self
       rules
     end
-    
-    private :__rules__, :__add_rule__
-    
+
   end
   
 end

data/lib/ruby_mapnik.rb

@@ -23,7 +23,7 @@ require 'forwardable'
 
 path = File.expand_path(File.dirname(__FILE__))
 
-require 'ruby_mapnik_config'
+require "#{path}/ruby_mapnik_config"
 require "#{path}/ruby_mapnik/ruby_mapnik"
 require "#{path}/ruby_mapnik/mapnik/rule"
 require "#{path}/ruby_mapnik/mapnik/style"
@@ -37,7 +37,7 @@ require "#{path}/ruby_mapnik/mapnik/tile"
 
 
 module Mapnik
-  VERSION = '0.1'
+  VERSION = '0.1.2'
   
   FontEngine.register_fonts(FONT_PATH)
   DatasourceCache.register(INPUT_PLUGIN_PATH)

data/test/test_helper.rb

@@ -20,7 +20,9 @@
  ******************************************************************************
 =end
 require "test/unit"
-require "ruby_mapnik"
+
+CURRENT_PATH = File.expand_path(File.dirname(__FILE__))
+require File.join(CURRENT_PATH, '..', 'lib', 'ruby_mapnik')
 
 unless defined?(SHAPEFILE)
   SHAPEFILE = "#{File.expand_path(File.dirname(__FILE__))}/data/TM_WORLD_BORDERS_SIMPL_0.3_MOD"

data/test/test_mapnik_feature.rb

@@ -26,7 +26,7 @@ class TestMapnikFeature < Test::Unit::TestCase
   def test_should_add_a_geometry
     feature = Mapnik::Feature.new(1)
     assert_equal(0, feature.number_of_geometries)
-    feature.add_geometry("POINT(30 10)")
+    feature.add_geometries_from_wkt("POINT(30 10)")
     assert_equal(1, feature.number_of_geometries)
   end
   

data/test/test_mapnik_geometry.rb

@@ -2,6 +2,8 @@ require "test_helper"
 
 class TestMapnikGeometry < Test::Unit::TestCase
   
+  STATEMENT = "Geometry tests no longer valid. See https://github.com/mapnik/Ruby-Mapnik/issues/11"
+
   def test_presence
     assert Mapnik::GeometryType
     assert Mapnik::Geometry2d
@@ -13,60 +15,72 @@ class TestMapnikGeometry < Test::Unit::TestCase
   end
   
   def test_should_make_point_from_wkt
-    point = Mapnik::Geometry2d.from_wkt("POINT(30 10)")
-    assert_equal Mapnik::GeometryType::Point, point.type
-    assert_equal 30, point.envelope.min_x
-    assert_equal 30, point.envelope.max_x
-    assert_equal 10, point.envelope.max_y
-    assert_equal 10, point.envelope.min_y
-    assert_equal 0, point.area
+    omit(STATEMENT)
+    # point = Mapnik::Geometry2d.from_wkt("POINT(30 10)")
+    # assert_equal Mapnik::GeometryType::Point, point.type
+    # assert_equal 30, point.envelope.min_x
+    # assert_equal 30, point.envelope.max_x
+    # assert_equal 10, point.envelope.max_y
+    # assert_equal 10, point.envelope.min_y
+    # assert_equal 0, point.area
   end
   
   def test_should_make_linestring_from_wkt
-    linestring = Mapnik::Geometry2d.from_wkt("LINESTRING (29 11, 12 30, 41 40)")
-    assert_equal Mapnik::GeometryType::LineString, linestring.type
-    assert_equal 12, linestring.envelope.min_x
-    assert_equal 41, linestring.envelope.max_x
-    assert_equal 40, linestring.envelope.max_y
-    assert_equal 11, linestring.envelope.min_y
+    omit(STATEMENT)
+    # linestring = Mapnik::Geometry2d.from_wkt("LINESTRING (29 11, 12 30, 41 40)")
+    # assert_equal Mapnik::GeometryType::LineString, linestring.type
+    # assert_equal 12, linestring.envelope.min_x
+    # assert_equal 41, linestring.envelope.max_x
+    # assert_equal 40, linestring.envelope.max_y
+    # assert_equal 11, linestring.envelope.min_y
     # assert_equal 0, linestring.area -> Not sure what the correct value is here  
   end
   
   def test_should_make_polygon_from_wkt
-    polygon = Mapnik::Geometry2d.from_wkt("POLYGON ((30 10, 10 20, 20 40, 40 40, 30 10))")
-    assert_equal Mapnik::GeometryType::Polygon, polygon.type
-    assert_equal 10, polygon.envelope.min_x
-    assert_equal 40, polygon.envelope.max_x
-    assert_equal 40, polygon.envelope.max_y
-    assert_equal 10, polygon.envelope.min_y
+    omit(STATEMENT)
+    # polygon = Mapnik::Geometry2d.from_wkt("POLYGON ((30 10, 10 20, 20 40, 40 40, 30 10))")
+    # assert_equal Mapnik::GeometryType::Polygon, polygon.type
+    # assert_equal 10, polygon.envelope.min_x
+    # assert_equal 40, polygon.envelope.max_x
+    # assert_equal 40, polygon.envelope.max_y
+    # assert_equal 10, polygon.envelope.min_y
     # assert_equal 0, polygon.area
   end
   
   def test_should_make_multipoint_from_wkt
-    multipoint = Mapnik::Geometry2d.from_wkt("MULTIPOINT (10 40, 40 30, 20 20, 30 10)")
-    assert_equal Mapnik::GeometryType::MultiPoint, multipoint.type
-    assert_equal 10, multipoint.envelope.min_x
-    assert_equal 40, multipoint.envelope.max_x
-    assert_equal 40, multipoint.envelope.max_y
-    assert_equal 10, multipoint.envelope.min_y
+    omit(STATEMENT)
+    # multipoint = Mapnik::Geometry2d.from_wkt("MULTIPOINT (10 40, 40 30, 20 20, 30 10)")
+    # assert_equal Mapnik::GeometryType::MultiPoint, multipoint.type
+    # assert_equal 10, multipoint.envelope.min_x
+    # assert_equal 40, multipoint.envelope.max_x
+    # assert_equal 40, multipoint.envelope.max_y
+    # assert_equal 10, multipoint.envelope.min_y
   end
   
   def test_should_make_multilinestring_from_wkt
-    multi_line = Mapnik::Geometry2d.from_wkt("MULTILINESTRING ((10 10, 20 20, 10 40), (40 40, 30 30, 40 20, 30 10))")
-    assert_equal Mapnik::GeometryType::MultiLineString, multi_line.type
-    assert_equal 10, multi_line.envelope.min_x
-    assert_equal 40, multi_line.envelope.max_x
-    assert_equal 40, multi_line.envelope.max_y
-    assert_equal 10, multi_line.envelope.min_y
+    omit(STATEMENT)
+    # multi_line = Mapnik::Geometry2d.from_wkt("MULTILINESTRING ((10 10, 20 20, 10 40), (40 40, 30 30, 40 20, 30 10))")
+    # assert_equal Mapnik::GeometryType::MultiLineString, multi_line.type
+    # assert_equal 10, multi_line.envelope.min_x
+    # assert_equal 40, multi_line.envelope.max_x
+    # assert_equal 40, multi_line.envelope.max_y
+    # assert_equal 10, multi_line.envelope.min_y
   end
   
   def test_should_make_multipolygon_from_wkt
-    multi_polygon = Mapnik::Geometry2d.from_wkt("MULTIPOLYGON (((30 20, 10 40, 45 40, 30 20)), ((15 5, 40 10, 10 20, 5 10, 15 5)))")
-    assert_equal Mapnik::GeometryType::MultiPolygon, multi_polygon.type
-    assert_equal 5, multi_polygon.envelope.min_x
-    assert_equal 45, multi_polygon.envelope.max_x
-    assert_equal 40, multi_polygon.envelope.max_y
-    assert_equal 5, multi_polygon.envelope.min_y
+    omit(STATEMENT)
+    # multi_polygon = Mapnik::Geometry2d.from_wkt("MULTIPOLYGON (((30 20, 10 40, 45 40, 30 20)), ((15 5, 40 10, 10 20, 5 10, 15 5)))")
+    # assert_equal Mapnik::GeometryType::MultiPolygon, multi_polygon.type
+    # assert_equal 5, multi_polygon.envelope.min_x
+    # assert_equal 45, multi_polygon.envelope.max_x
+    # assert_equal 40, multi_polygon.envelope.max_y
+    # assert_equal 5, multi_polygon.envelope.min_y
   end
+
+private
   
+  def omit(str)
+    puts str
+  end
+
 end

data/test/test_mapnik_map.rb

@@ -147,7 +147,8 @@ class TestMapnikMap < Test::Unit::TestCase
     map = build_complete_map
     filename = File.join(File.expand_path(File.dirname(__FILE__)), "../tmp/world.png")
     assert_equal 0, File.size(filename) if File.exists?(filename)
-    map.render_to_file(filename)
+    assert map.render_to_file(filename)
+    assert File.exists?(filename)
     File.delete(filename)
   end
   
@@ -158,15 +159,23 @@ class TestMapnikMap < Test::Unit::TestCase
     assert_equal map_1.srs, map_2.srs
   end
   
-  def test_should_load_from_file
+  def test_should_load_from_file_path_string
     file_path = File.join(File.expand_path(File.dirname(__FILE__)), "data", "test_map.xml")
     map = Mapnik::Map.from_file(file_path)
     assert map.layers.any?
     assert map.styles['My Style']
   end
   
-private
+  def test_should_load_from_file
+    file = File.open(File.join(File.expand_path(File.dirname(__FILE__)), "data", "test_map.xml"))
+    map = Mapnik::Map.from_file(file)
+    assert map.layers.any?
+    assert map.styles['My Style']
+  end
   
+
+private
+
   def build_complete_map
     map = Mapnik::Map.new
     map.width = 600

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_mapnik
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  version: "0.1"
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Elliot Laster
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-09 00:00:00 -04:00
+date: 2011-10-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,9 +65,9 @@ dependencies:
   version_requirements: *id003
 description: |-
   A set of bindings between Ruby and Mapnik. Supports many of the common uses for 
-  Mapnik, and one day, might support al of them. Rundering is available using
-  the plain agg library, or via Cairo, if the rcairo gem is installed and 
-  Mapnik has been compiled with Cairo support.
+  Mapnik, and one day, might support all of them. Rendering is available using
+  the standard AGG library, or additionally via Cairo, if the rcairo gem is 
+  installed and Mapnik has been compiled with Cairo support.
 email: 
 - elliotlaster@gmail.com
 executables: []