RubyGems - mapnik_legendary - Versions diffs - 0.3.0 - Mend

mapnik_legendary 0.3.0

Files changed (11) hide show

data/LICENSE.md +19 -0
data/README.md +39 -0
data/bin/mapnik_legendary +44 -0
data/lib/mapnik_legendary/docwriter.rb +60 -0
data/lib/mapnik_legendary/feature.rb +27 -0
data/lib/mapnik_legendary/geometry.rb +39 -0
data/lib/mapnik_legendary/part.rb +27 -0
data/lib/mapnik_legendary/tags.rb +11 -0
data/lib/mapnik_legendary/version.rb +5 -0
data/lib/mapnik_legendary.rb +93 -0
metadata +120 -0

data/LICENSE.md ADDED Viewed

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Andy Allan
+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 ADDED Viewed

@@ -0,0 +1,39 @@
+# Mapnik Legendary
+[Mapnik Legendary](https://github.com/gravitystorm/mapnik-legendary) is a small utility to help with generating legends (aka map keys) from Mapnik stylesheets. You describe in a config file which attributes, and which zoom level(s) you want an image for, and it reads the stylesheet and spits out .png files. It uses the ruby-mapnik bindings to load the stylesheets and mess around with the datasources, so you don't actually need any of the shapefiles or database connections to make this work.
+## Requirements
+* [Ruby-Mapnik bindings](https://github.com/mapnik/Ruby-Mapnik) >= 0.2.0
+* mapnik 2.x and ruby (both required for Ruby-Mapnik)
+## Installation
+In the future (i.e. when I make a packaged release) you'll be able to use rubygems. Until then:
+`git clone https://github.com/gravitystorm/mapnik-legendary`
+If you want to install the gem locally, run
+```
+gem build mapnik_legendary.gemspec
+gem install mapnik_legendary-0.x.x.gem
+```
+## Running
+To run locally, without installing a gem, run:
+`ruby -Ilib bin/mapnik_legendary`
+If you've installed the gem, `mapnik_legendary` will be in your path.
+For full options, run
+`mapnik_legendary -h`
+## Examples
+`mapnik_legendary examples/openstreetmap-carto-legend.yml osm-carto.xml`
+See [examples/openstreetmap-carto-legend.yml](examples/openstreetmap-carto-legend.yml)

data/bin/mapnik_legendary ADDED Viewed

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+require 'mapnik_legendary'
+require 'mapnik_legendary/version'
+require 'optparse'
+require 'ostruct'
+options = OpenStruct.new
+options.overwrite = false
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: mapnik_legendary [options] <legend_filename> <stylesheet_filename>'
+  opts.on('-z', '--zoom Z', Float, 'Override the zoom level stated in the legend file') do |z|
+    options.zoom = z
+  end
+  opts.on('--overwrite', 'Overwrite existing output files') do |o|
+    options.overwrite = o
+  end
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+  opts.on_tail('--version', 'Show version') do
+    puts MapnikLegendary::VERSION
+    exit
+  end
+end
+optparse.parse!
+# Check required conditions
+if ARGV.length != 2
+  optparse.abort('Error: Two input filenames required')
+  exit(-1)
+end
+legend_file = ARGV[0]
+map_file = ARGV[1]
+MapnikLegendary.generate_legend(legend_file, map_file, options)

data/lib/mapnik_legendary/docwriter.rb ADDED Viewed

@@ -0,0 +1,60 @@
+# encoding: utf-8
+require 'prawn/table'
+require 'prawn'
+module MapnikLegendary
+  class Docwriter
+    attr_accessor :image_width
+    def initialize
+      @entries = []
+      @image_width = 100
+    end
+    def add(image, description)
+      @entries << [image, description]
+    end
+    def to_html
+      doc = '<html><head></head><body><table>' + "\n"
+      @entries.each do |entry|
+        doc += "<tr><td><img src=\"#{entry[0]}\"></td><td>#{entry[1]}</td></tr>\n"
+      end
+      doc += '</table></body></html>' + "\n"
+      doc
+    end
+    def to_pdf(filename, title)
+      entries = @entries
+      image_width = @image_width
+      Prawn::Document.generate(filename, page_size: 'A4') do
+        font_families.update(
+          'Ubuntu' => { bold: '/usr/share/fonts/truetype/ubuntu-font-family/Ubuntu-B.ttf',
+                        italic: '/usr/share/fonts/truetype/ubuntu-font-family/Ubuntu-RI.ttf',
+                        normal: '/usr/share/fonts/truetype/ubuntu-font-family/Ubuntu-R.ttf' }
+        )
+        font 'Ubuntu'
+        font_size 12
+        text title, style: :bold, size: 24, align: :center
+        move_down(40)
+        data = Array.new
+        image_scale = 0.5
+        entries.each do |entry|
+          data << { image: File.join(File.dirname(filename), entry[0]),
+                    scale: image_scale,
+                    position: :center,
+                    vposition: :center }
+          data << entry[1]
+        end
+        columns = image_width >= 200 ? 2 : 3
+        table(data.each_slice(columns * 2).to_a, cell_style: { border_width: 0.1 }) do
+          (0..columns - 1).each do |n|
+            column(n * 2).width = image_width * image_scale
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mapnik_legendary/feature.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'mapnik_legendary/part'
+module MapnikLegendary
+  # A feature has a name, description, and one or more parts holding geometries, tags and layers
+  class Feature
+    attr_reader :name, :parts, :description
+    def initialize(feature, zoom, map, extra_tags)
+      @name = feature['name']
+      @description = feature.key?('description') ? feature['description'] : @name.capitalize
+      @parts = []
+      if feature.key? 'parts'
+        feature['parts'].each do |part|
+          @parts << Part.new(part, zoom, map, extra_tags)
+        end
+      else
+        @parts << Part.new(feature, zoom, map, extra_tags)
+      end
+    end
+    def envelope
+      @parts.first.geom.envelope
+    end
+  end
+end

data/lib/mapnik_legendary/geometry.rb ADDED Viewed

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module MapnikLegendary
+  class Geometry
+    def initialize(type, zoom, map)
+      proj = Mapnik::Projection.new(map.srs)
+      width_of_world_in_pixels = 2**zoom * 256
+      width_of_world_in_metres = proj.forward(Mapnik::Coord2d.new(180, 0)).x - proj.forward(Mapnik::Coord2d.new(-180, 0)).x
+      width_of_image_in_metres = map.width.to_f / width_of_world_in_pixels * width_of_world_in_metres
+      height_of_image_in_metres = map.height.to_f / width_of_world_in_pixels * width_of_world_in_metres
+      @max_x = width_of_image_in_metres
+      @max_y = height_of_image_in_metres
+      @min_x = 0
+      @min_y = 0
+      @geom = case type
+              when 'point' then "POINT(#{@max_x / 2} #{@max_y / 2})"
+              when 'point75' then "POINT(#{@max_x * 0.5} #{@max_y * 0.75})"
+              when 'polygon' then "POLYGON((0 0, #{@max_x} 0, #{@max_x} #{@max_y}, 0 #{@max_y}, 0 0))"
+              when 'linestring-with-gap' then "MULTILINESTRING((0 0, #{@max_x * 0.45} #{@max_y * 0.45}),(#{@max_x * 0.55} #{@max_y * 0.55},#{@max_x} #{@max_y}))"
+              when 'polygon-with-hole' then "POLYGON((#{0.7 * @max_x} #{0.2 * @max_y}, #{0.9 * @max_x} #{0.9 * @max_y}" +
+                                            ", #{0.3 * @max_x} #{0.8 * @max_y}, #{0.2 * @max_x} #{0.4 * @max_y}" +
+                                            ", #{0.7 * @max_y} #{0.2 * @max_y}),( #{0.4 * @max_x} #{0.6 * @max_y}" +
+                                            ", #{0.7 * @max_x} #{0.7 * @max_y}, #{0.6 * @max_x} #{0.4 * @max_y}" +
+                                            ", #{0.4 * @max_x} #{0.6 * @max_y}))"
+              else "LINESTRING(0 0, #{@max_x} #{@max_y})"
+              end
+    end
+    def to_csv
+      %("#{@geom}")
+    end
+    def envelope
+      Mapnik::Envelope.new(@min_x, @min_y, @max_x, @max_y)
+    end
+  end
+end

data/lib/mapnik_legendary/part.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'mapnik_legendary/tags'
+require 'mapnik_legendary/geometry'
+module MapnikLegendary
+  # A part is a combination of tags, geometry and layers.
+  class Part
+    attr_reader :tags, :geom, :layers
+    def initialize(h, zoom, map, extra_tags)
+      @tags = Tags.merge_nulls(h['tags'], extra_tags)
+      @geom = Geometry.new(h['type'], zoom, map)
+      if h['layer']
+        @layers = [h['layer']]
+      else
+        @layers = h['layers']
+      end
+    end
+    def to_csv
+      csv = ''
+      csv << @tags.keys.push('wkt').join(',') + "\n"
+      csv << @tags.values.push(@geom.to_csv).join(',') + "\n"
+    end
+  end
+end

data/lib/mapnik_legendary/tags.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# encoding: utf-8
+module MapnikLegendary
+  class Tags
+    def self.merge_nulls(tags, extras)
+      tags = {} if tags.nil?
+      extras = [] if extras.nil?
+      Hash[extras.map { |t| [t, 'null'] }].merge(tags)
+    end
+  end
+end

data/lib/mapnik_legendary/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# encoding: utf-8
+module MapnikLegendary
+  VERSION = '0.3.0'
+end

data/lib/mapnik_legendary.rb ADDED Viewed

@@ -0,0 +1,93 @@
+# encoding: utf-8
+require 'mapnik'
+require 'yaml'
+require 'fileutils'
+require 'logger'
+require 'mapnik_legendary/feature'
+require 'mapnik_legendary/docwriter'
+module MapnikLegendary
+  DEFAULT_ZOOM = 17
+  def self.generate_legend(legend_file, map_file, options)
+    log = Logger.new(STDERR)
+    legend = YAML.load(File.read(legend_file))
+    if legend.key?('fonts_dir')
+      Mapnik::FontEngine.register_fonts(legend['fonts_dir'])
+    end
+    map = Mapnik::Map.from_xml(File.read(map_file), false, File.dirname(map_file))
+    map.width = legend['width']
+    map.height = legend['height']
+    map.srs = '+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over'
+    if legend.key?('background')
+      map.background = Mapnik::Color.new(legend['background'])
+    end
+    layer_styles = []
+    map.layers.each do |l|
+      layer_styles.push(name: l.name,
+                        style: l.styles.map { |s| s } # get them out of the collection
+                        )
+    end
+    docs = Docwriter.new
+    docs.image_width = legend['width']
+    legend['features'].each_with_index do |feature, idx|
+      # TODO: use a proper csv library rather than .join(",") !
+      zoom = options.zoom || feature['zoom'] || DEFAULT_ZOOM
+      feature = Feature.new(feature, zoom, map, legend['extra_tags'])
+      map.zoom_to_box(feature.envelope)
+      map.layers.clear
+      feature.parts.each do |part|
+        if part.layers.nil?
+          log.warn "Can't find any layers defined for a part of #{feature.name}"
+          next
+        end
+        part.layers.each do |layer_name|
+          ls = layer_styles.select { |l| l[:name] == layer_name }
+          if ls.empty?
+            log.warn "Can't find #{layer_name} in the xml file"
+            next
+          else
+            ls.each do |layer_style|
+              l = Mapnik::Layer.new(layer_name, map.srs)
+              datasource = Mapnik::Datasource.create(type: 'csv', inline: part.to_csv)
+              l.datasource = datasource
+              layer_style[:style].each do |style_name|
+                l.styles << style_name
+              end
+              map.layers << l
+            end
+          end
+        end
+      end
+      FileUtils.mkdir_p('output')
+      # map.zoom_to_box(Mapnik::Envelope.new(0,0,1,1))
+      id = feature.name || "legend-#{idx}"
+      filename = File.join(Dir.pwd, 'output', "#{id}-#{zoom}.png")
+      i = 0
+      while File.exist?(filename) && !options.overwrite
+        i += 1
+        filename = File.join(Dir.pwd, 'output', "#{id}-#{zoom}-#{i}.png")
+      end
+      map.render_to_file(filename, 'png256:t=2')
+      docs.add File.basename(filename), feature.description
+    end
+    f = File.open(File.join(Dir.pwd, 'output', 'docs.html'), 'w')
+    f.write(docs.to_html)
+    f.close
+    title = legend.key?('title') ? legend['title'] : 'Legend'
+    docs.to_pdf(File.join(Dir.pwd, 'output', 'legend.pdf'), title)
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: mapnik_legendary
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease:
+platform: ruby
+authors:
+- Andy Allan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mapnik
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Creating legends by hand is tedious. This software allows you to generate
+  them automatically.
+email: andy@gravitystorm.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mapnik_legendary/tags.rb
+- lib/mapnik_legendary/geometry.rb
+- lib/mapnik_legendary/feature.rb
+- lib/mapnik_legendary/part.rb
+- lib/mapnik_legendary/version.rb
+- lib/mapnik_legendary/docwriter.rb
+- lib/mapnik_legendary.rb
+- bin/mapnik_legendary
+- LICENSE.md
+- README.md
+homepage: https://github.com/gravitystorm/mapnik-legendary
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.23
+signing_key:
+specification_version: 3
+summary: Create legends (map keys) for mapnik stylesheets
+test_files: []