simple_mapnik 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8d3175e317ae4772b41f5d8ac4f9a0781d4432a
+  data.tar.gz: 46eaac32355da4efb010299a5a99bd799a27f468
+SHA512:
+  metadata.gz: 03a3e4d5bdbe20771aeddb586cdeb7604b89071be85d89a6266bd02be35887d0b6c9d76405235cb57d98ea664cf02df5e09c30e3141e981db0f504e42081e662
+  data.tar.gz: c1a9cedff9a7c3f7af5073246aac47ce058646e6b3b0730098ecc7385b99cf283437d653930b9a243c5810dc2d4add3e9a6acfd1900b1d5810840121decd8d8e

data/.gitignore

@@ -0,0 +1,8 @@
+Gemfile.lock
+/pkg
+*.gem
+*.dylib
+*.so
+.bundle/
+.byebug_history
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+Metrics/LineLength:
+  Max: 100
+
+Style/ClassAndModuleCamelCase:
+  Exclude:
+    - 'lib/simple_mapnik.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'Rakefile'

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+sudo: true
+matrix:
+  include:
+    - os: linux
+      compiler: clang
+      env: MAPNIK_VERSION="2.3"
+    - os: linux
+      compiler: gcc
+      env: MAPNIK_VERSION="2.3"
+
+before_install:
+ - sudo apt-add-repository --yes ppa:mapnik/nightly-${MAPNIK_VERSION}
+ - sudo apt-get update -y
+
+install:
+ - sudo apt-get -y install wget build-essential make libmapnik=${MAPNIK_VERSION}* mapnik-utils=${MAPNIK_VERSION}* libmapnik-dev=${MAPNIK_VERSION}* mapnik-input-plugin*=${MAPNIK_VERSION}*
+
+before_script:
+ - gem install bundler -v 1.12.3
+ - bundle install
+
+script:
+ - rake spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Eliot Jordan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE-ffi-mapnik

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Scooter Wadsworth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+SimpleMapnik
+==========
+[![Build Status](https://travis-ci.org/geoconcerns/simple_mapnik.svg)](https://travis-ci.org/geoconcerns/simple_mapnik)
+[![Coverage Status](https://coveralls.io/repos/github/geoconcerns/simple_mapnik/badge.svg?branch=master)](https://coveralls.io/github/geoconcerns/simple_mapnik?branch=master)
+
+Simple ruby access to the Mapnik library using [ruby-ffi](https://github.com/ffi/ffi) and [mapnik-c-api](https://github.com/springmeyer/mapnik-c-api). Adapted from [ffi-mapnik](https://github.com/scooterw/ffi-mapnik).
+
+## Prerequisites
+
+SimpleMapnik requires that Mapnik 3.x or 2.x be installed at `/usr/local/lib/libmapnik.*`. In addition, a C++ compiler and build environment is needed for the c api extension.
+
+On Mac OS X:
+
+- https://github.com/mapnik/mapnik/wiki/MacInstallation or ```brew install mapnik```
+- Build environment: [Xcode](https://developer.apple.com/xcode/)
+
+On Linux:
+- https://github.com/mapnik/mapnik/wiki/LinuxInstallation
+- Build environment: [gcc](https://help.ubuntu.com/community/InstallingCompilers) or clang
+
+## Installation
+
+Install from the latest tagged release:
+```
+$ gem install simple_mapnik
+```
+
+Or, add it to the Gemfile of an existing project:
+```
+gem 'simple_mapnik'
+```
+
+Then run:
+```
+$ bundle install
+```
+
+## Usage
+
+Open an IRB session, or run `bin/mapnik_console`:
+
+```ruby
+require './lib/simple_mapnik' # not necessary if using bin/mapnik_console
+
+SimpleMapnik.register_datasources '/usr/local/lib/mapnik/input'
+
+map = SimpleMapnik::Map.new 256, 256
+map.load 'spec/fixtures/sample/stylesheet.xml'
+map.zoom_all
+map.to_file '~/Desktop/sample_output.png'
+```
+
+## Testing
+
+```
+$ bundle install
+$ rake spec
+```

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: utf-8
+begin
+  require 'bundler/setup'
+  require 'bundler/gem_tasks'
+rescue
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rspec/core/rake_task'
+  require 'rubocop/rake_task'
+
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.requires << 'rubocop-rspec'
+    task.fail_on_error = true
+  end
+  task spec: :rubocop do
+    RSpec::Core::RakeTask.new(:spec)
+  end
+rescue LoadError
+end
+
+require './lib/simple_mapnik/api.rb'
+
+task :install do
+  SimpleMapnik::Api.new.install
+end
+
+task default: :install

data/bin/mapnik_console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'simple_mapnik'))
+require 'irb'
+
+IRB.start

data/coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/lib/simple_mapnik/api.rb

@@ -0,0 +1,75 @@
+require 'open-uri'
+require 'zip'
+
+module SimpleMapnik
+  class Api
+    attr_accessor :output_dir
+    attr_writer :lib, :url, :src_directory_name
+
+    def initialize(output_dir = './')
+      @output_dir = output_dir
+    end
+
+    def check_and_install
+      lib_exist = File.exist? File.expand_path(File.join(output_dir, lib))
+      install unless lib_exist
+    end
+
+    def install
+      download
+      unzip
+      build
+      clean
+    end
+
+    def lib
+      @lib ||= "libmapnik_c.#{::FFI::Platform::LIBSUFFIX}"
+    end
+
+    def url
+      @url ||= 'https://github.com/geoconcerns/mapnik-c-api/archive/master.zip'
+    end
+
+    def src_directory_name
+      @src_directory_name ||= 'mapnik-c-api-master'
+    end
+
+    protected
+
+    def zip_path
+      File.expand_path(File.join(output_dir, 'mapnik_api.zip'))
+    end
+
+    def source_directory
+      File.expand_path(File.join(output_dir, src_directory_name))
+    end
+
+    def download
+      open(url) do |io|
+        IO.copy_stream(io, zip_path)
+      end
+    end
+
+    def unzip
+      Zip::File.open(zip_path) do |zip_file|
+        zip_file.each do |f|
+          f_path = File.join(output_dir, f.name)
+          FileUtils.mkdir_p(File.dirname(f_path))
+          zip_file.extract(f, f_path) unless File.exist?(f_path)
+        end
+      end
+    end
+
+    def build
+      path = source_directory
+      system("make -C #{path} && mv #{path}/$(ls #{path}/ | grep -E '(.dylib|.so)') #{output_dir}.")
+    end
+
+    def clean
+      [zip_path, source_directory].each do |item|
+        FileUtils.remove_dir(item) if Dir.exist?(item)
+        File.delete(item) if File.exist?(item)
+      end
+    end
+  end
+end

data/lib/simple_mapnik/bounds.rb

@@ -0,0 +1,23 @@
+module SimpleMapnik
+  class Bounds
+    include SimpleMapnik::FFI
+
+    attr_accessor :x_min, :y_min, :x_max, :y_max, :ptr
+
+    def initialize(x_min, y_min, x_max, y_max)
+      @x_min = x_min
+      @y_min = y_min
+      @x_max = x_max
+      @y_max = y_max
+      ptr = mapnik_bbox x_min, y_min, x_max, y_max
+      @ptr = ::FFI::AutoPointer.new ptr, self.class.method(:release)
+      @ptr.autorelease = false
+    end
+
+    def self.release; end
+
+    def free
+      mapnik_bbox_free @ptr
+    end
+  end
+end

data/lib/simple_mapnik/coordinate.rb

@@ -0,0 +1,16 @@
+module SimpleMapnik
+  class Coordinate
+    include SimpleMapnik::FFI
+
+    attr_accessor :x, :y, :ptr
+
+    def initialize(x, y)
+      @x = x
+      @y = y
+      coord_struct = MAPNIK_COORD_T.new
+      coord_struct[:x] = x
+      coord_struct[:y] = y
+      @ptr = coord_struct.to_ptr
+    end
+  end
+end

data/lib/simple_mapnik/map.rb

@@ -0,0 +1,47 @@
+module SimpleMapnik
+  class Map
+    include SimpleMapnik::FFI
+
+    attr_accessor :width, :height, :ptr
+
+    def initialize(width, height)
+      @width = width
+      @height = height
+      ptr = mapnik_map width, height
+      @ptr = ::FFI::AutoPointer.new ptr, self.class.method(:release)
+      @ptr.autorelease = false
+    end
+
+    def self.release; end
+
+    def free
+      mapnik_map_free @ptr
+    end
+
+    def load(style)
+      style = File.expand_path style
+      mapnik_map_load @ptr, style
+    end
+
+    def zoom_all
+      mapnik_map_zoom_all @ptr
+    end
+
+    def zoom_to(bounds)
+      mapnik_map_zoom_to_box @ptr, bounds.ptr
+    end
+
+    def to_image
+      mapnik_map_render_to_image @ptr
+    end
+
+    def to_png
+      mapnik_image_to_png_blob to_image
+    end
+
+    def to_file(file)
+      file = File.expand_path file
+      mapnik_map_render_to_file @ptr, file
+    end
+  end
+end

data/lib/simple_mapnik/version.rb

@@ -0,0 +1,3 @@
+module SimpleMapnik
+  VERSION = '0.0.1'.freeze
+end

data/lib/simple_mapnik.rb

@@ -0,0 +1,79 @@
+require 'ffi'
+
+module SimpleMapnik
+  MAPNIK_BASE = File.join(File.dirname(__FILE__), 'simple_mapnik')
+
+  autoload :Map, File.join(MAPNIK_BASE, 'map')
+  autoload :Coordinate, File.join(MAPNIK_BASE, 'coordinate')
+  autoload :Bounds, File.join(MAPNIK_BASE, 'bounds')
+  autoload :Api, File.join(MAPNIK_BASE, 'api')
+
+  module FFI
+    def self.find_lib(lib)
+      File.expand_path File.join('.', "#{lib}.#{::FFI::Platform::LIBSUFFIX}")
+    end
+
+    def self.mapnik_c_api_path
+      find_lib 'libmapnik_c'
+    end
+
+    class MAPNIK_COORD_T < ::FFI::Struct
+      layout :x, :double,
+             :y, :double
+    end
+
+    MAPNIK_FUNCTIONS = {
+      mapnik_register_datasources: [[:string, :pointer], :int],
+      mapnik_register_fonts: [[:string, :pointer], :int],
+      mapnik_map: [[:uint, :uint], :pointer],
+      mapnik_map_free: [[:pointer], :void],
+      # mapnik_map_reset_last_error: [[:pointer], :void],
+      mapnik_map_get_srs: [[:pointer], :string],
+      mapnik_map_set_srs: [[:pointer, :string], :int],
+      mapnik_map_load: [[:pointer, :string], :int],
+      mapnik_map_zoom_all: [[:pointer], :int],
+      mapnik_map_render_to_file: [[:pointer, :string], :int],
+      mapnik_map_resize: [[:pointer, :uint, :uint], :void],
+      mapnik_map_set_buffer_size: [[:pointer, :int], :void],
+      mapnik_map_last_error: [[:pointer], :string],
+      mapnik_map_projection: [[:pointer], :pointer], # needs struct
+      mapnik_projection_free: [[:pointer], :void],
+      mapnik_projection_forward: [[:pointer, MAPNIK_COORD_T.by_value], :pointer],
+      mapnik_bbox: [[:double, :double, :double, :double], :pointer],
+      mapnik_bbox_free: [[:pointer], :void],
+      mapnik_map_zoom_to_box: [[:pointer, :pointer], :void],
+      mapnik_image_free: [[:pointer], :void],
+      mapnik_map_render_to_image: [[:pointer], :pointer],
+      mapnik_image_blob_free: [[:pointer], :void],
+      mapnik_image_to_png_blob: [[:pointer], :pointer]
+    }.freeze
+
+    extend ::FFI::Library
+
+    def self.attach_functions
+      ffi_lib mapnik_c_api_path
+
+      MAPNIK_FUNCTIONS.each do |func, params|
+        attach_function func, params.first, params.last
+      end
+    rescue LoadError, NoMethodError
+      raise LoadError.new('Could not load Mapnik library and / or C API')
+    end
+
+    attach_functions
+  end
+
+  class << self
+    def error_ptr
+      ::FFI::MemoryPointer.new :char, 65
+    end
+
+    def register_datasources(sources)
+      SimpleMapnik::FFI.mapnik_register_datasources sources, nil
+    end
+
+    def register_fonts(fonts)
+      SimpleMapnik::FFI.mapnik_register_fonts fonts, nil
+    end
+  end
+end

data/simple_mapnik.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_mapnik/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'simple_mapnik'
+  spec.version = SimpleMapnik::VERSION
+  spec.authors = ['Eliot Jordan']
+  spec.email = ['eliotj@princeton.edu']
+  spec.description = 'Simple FFI wrapper for Mapnik'
+  spec.summary = 'Simple access to Mapnik library from Ruby'
+  spec.homepage = 'https://github.com/geoconcerns/simple_mapnik'
+  spec.license = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.extensions = ['Rakefile']
+
+  spec.add_dependency 'ffi', '~> 1.9.0'
+  spec.add_dependency 'rubyzip', '~> 1.2.0'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop', '~> 0.39'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.4.1'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+end

data/spec/fixtures/sample/missing_attribute.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" background-color="steelblue">
+
+    <Style name="style">
+        <Rule>
+            <PolygonSymbolizer fill="white" />
+            <LineSymbolizer stroke="grey" stroke-width=".2" />
+            <TextSymbolizer face-name="Unifont" placement="point" fill="#444444" halo-fill="rgba(255, 255, 255, 0.75)" halo-radius="2" line-spacing="2" wrap-width="30" ><![CDATA[[doesnotexist]]]></TextSymbolizer>
+        </Rule>
+    </Style>
+
+    <Layer name="world" srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over">
+        <StyleName>style</StyleName>
+        <Datasource>
+            <Parameter name="file">world_merc.shp</Parameter>
+            <Parameter name="encoding">iso-8859-1</Parameter>
+            <Parameter name="type">shape</Parameter>
+        </Datasource>
+    </Layer>
+
+</Map>

data/spec/fixtures/sample/stylesheet.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" background-color="steelblue">
+
+    <Style name="style">
+        <Rule>
+            <PolygonSymbolizer fill="white" />
+            <LineSymbolizer stroke="grey" stroke-width=".2" />
+        </Rule>
+    </Style>
+
+    <Layer name="world" srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over">
+        <StyleName>style</StyleName>
+        <Datasource>
+            <Parameter name="file">world_merc.shp</Parameter>
+            <Parameter name="encoding">iso-8859-1</Parameter>
+            <Parameter name="type">shape</Parameter>
+        </Datasource>
+    </Layer>
+</Map>