map_print 0.3.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73eaf58e1ffe788eac9f34f197ba18e682548f15
-  data.tar.gz: 3746ee55d0e44f920ce4db99259bf544451abf2e
+  metadata.gz: 071baa0acdcea17783abc5c2a0cd40b5a7bead82
+  data.tar.gz: 397e7e367a66af93f2abc590aaf462fb4afa94d5
 SHA512:
-  metadata.gz: 9a44c54c8f966d3253229399532f431f04b1e56c1d5489af27799075700db9dd2677de5b8f292d50f56f89016aa70fade5fd743cc242207d393b8b512e1e04a2
-  data.tar.gz: 838a40807d303bda6cf4d11fc361959909d1c115e83167512a9b728831f176ac14ae04ea449bc2e543c76edfa4f28910437876bc5f25163c845c914a68046eda
+  metadata.gz: e77dcb704714848b51dc7a2bde3f0e0c42557a0735284f005cccdf3608395e33b93f7ac2bfaefa27e508d26a947c5e71d971bff3f3032060829a4d2d0836fccc
+  data.tar.gz: 4afb485eb8225eec40a8d50d8853f4f8d456df08e1b87a610b9acf6fc89f833873a6d81fc80e71f8afc52a182a01bd1e50d81c6bfed58fba10e0f9f92899d63b

data/.gitignore

@@ -1,5 +1,7 @@
 *.gem
+*.log
 *.rbc
+/cache/
 /.config
 /coverage/
 /InstalledFiles

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in map_print.gemspec
 gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    map_print (0.2.1)
-      geo-distance (~> 0.1)
+    map_print (0.9.0)
       mini_magick (~> 4.3)
       parallel (~> 1.6)
       prawn (~> 2.0)
@@ -12,30 +11,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.5)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    geo-distance (0.2.0)
-      geo_point (~> 0.2.5)
-      geo_units (~> 0.2.4.1)
-    geo_calc (0.7.6)
-      activesupport (>= 3.0.1)
-      geo_units (~> 0.2.1)
-      i18n
-      require_all (~> 1.2.0)
-      sugar-high (~> 0.4.6.3)
-    geo_point (0.2.5)
-      geo_calc (~> 0.7.5)
-      geo_units (~> 0.2.1)
-    geo_units (0.2.4.1)
-      sugar-high (~> 0.4.6.2)
-    i18n (0.7.0)
+    addressable (2.4.0)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    hashdiff (0.2.3)
     json (1.8.3)
-    mini_magick (4.3.6)
-    minitest (5.8.2)
+    mini_magick (4.4.0)
+    minitest (5.8.4)
     parallel (1.6.1)
     pdf-core (0.6.0)
     prawn (2.0.2)
@@ -44,24 +29,31 @@ GEM
     prawn-fast-png (0.2.3)
       prawn
       rmagick
-    rake (10.4.2)
-    require_all (1.2.1)
+    rake (10.5.0)
     rmagick (2.15.4)
-    sugar-high (0.4.6.4)
+    safe_yaml (1.0.4)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     thor (0.19.1)
-    thread_safe (0.3.5)
     ttfunk (1.4.0)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
+    webmock (1.22.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.10)
+  codeclimate-test-reporter
   map_print!
   minitest (~> 5.8)
   rake (~> 10.0)
+  webmock (= 1.22.6)
 
 BUNDLED WITH
    1.10.6

data/README.md

@@ -1,6 +1,9 @@
 # MapPrint
 
 [![Gem Version](https://badge.fury.io/rb/map_print.svg)](https://badge.fury.io/rb/map_print)
+[![Build Status](https://travis-ci.org/afast/map_print.svg)](https://travis-ci.org/afast/map_print)
+[![Code Climate](https://codeclimate.com/github/afast/map_print/badges/gpa.svg)](https://codeclimate.com/github/afast/map_print)
+[![Test Coverage](https://codeclimate.com/github/afast/map_print/badges/coverage.svg)](https://codeclimate.com/github/afast/map_print/coverage)
 
 MapPrint allows for exporting many map sources and GeoJSON to a pdf file. Allowing to specify map element, text/image elements as well as printing a legend with the reference and a scale bar.
 
@@ -34,15 +37,62 @@ This is intended to be more of a testing method as it doesn't support all the op
 
 ### In ruby code
 
-The mos common usage you'll be expecting is to create a new instance with the map configuration and then call `print` with the output path. MapPrint will take the map configuration, generate the map and write the output to the output path. In the example below `./map.png`.
+The most common usage will be creating a new instance with the map configuration and then call `print` with the output path. MapPrint will take the map configuration, generate the map and write the output to the output path. In the example below `./map.png`.
 
 ```ruby
-MapPrint::Core.new(map_configuration).print('./map.png')```
+MapPrint::Core.new(map_configuration).print('./map.png')
+```
+
+`map_configuration` is a hash which contains all the necessary fields to print a map.
+For detailed information about what `map_print` expects in a hash please look at the [wiki](https://github.com/afast/map_print/wiki).
+
+The minimum hash to generate a PNG:
+
+```ruby
+map_configuration = {
+  png_options: {
+    width: 800,
+    height: 1000
+  },
+  map: {
+    sw: {
+      lat: -35.026862,
+      lng: -58.425003
+    },
+    ne: {
+      lat: -29.980172,
+      lng: -52.959305
+    },
+    zoom: 9,
+    layers: [{type: 'osm'}]
+  }
+}
+```
+
+The minimum hash to generate a PDF:
 
-`map_configuration` is a hash with the following options:
+```ruby
+map_configuration = {
+  format: 'pdf',
+  map: {
+    sw: {
+      lat: -35.026862,
+      lng: -58.425003
+    },
+    ne: {
+      lat: -29.980172,
+      lng: -52.959305
+    },
+    zoom: 9,
+    layers: [{type: 'osm'}]
+  }
+}
+```
+
+A full example showing all the available options:
 
 ```ruby
-BASIC_MAP = {
+map_configuration = {
     format: 'pdf', # pdf or png
     pdf_options: {
       page_size: 'A4', # A0-10, B0-10, C0-10
@@ -123,12 +173,29 @@ BASIC_MAP = {
         text: "some text",
         position: {x: 50, y: 50 },
         box_size: {width: 50, height: 50},
-        options: {}
+        options: {
+          fill_color: '#ffffff',
+          color: '#000000',
+          font: 'Arial',
+          pointsize: '16',
+          gravity: 'NorthWest',
+        }
       }
     ],
-    legend: { # not supported yet
+    legend: {
       position: {x: 50, y: 50},
       size: {width: 50, height: 50},
+      image_size: {width: 16, height: 16},
+      textbox_size: {width: 40, height: 16},
+      textbox_style: {
+        fill_color: '#ffffff',
+        color: '#000000',
+        font: 'Arial',
+        pointsize: '16',
+        gravity: 'NorthWest',
+      },
+      orientation: 'horizontal', # horizontal, vertical
+      overflow: 'hidden', # expand, hidden, compact
       columns: 5,
       rows: 5,
       elements: [{
@@ -136,10 +203,14 @@ BASIC_MAP = {
         text: 'text'
       }]
     },
-    scalebar: { # not supported yet
+    scalebar: {
       unit: 'meters', # meters, km, miles, feet
-      position: {x: 50, y: 50},
-      size: {width: 50, height: 50}
+      position: {x: 500, y: 550},
+      size: {width: 200, height: 40},
+      padding: {top: 5, right: 5, bottom: 5, left: 5},
+      bar_height: 10,
+      background_color: 'black',
+      background_opacity: 0.4
     }
   }
 ```

data/lib/map_print/core.rb

@@ -1,3 +1,4 @@
+require_relative 'logger'
 require_relative 'lat_lng'
 require_relative 'tiles/tile'
 require_relative 'tiles/tile_factory'
@@ -29,6 +30,10 @@ module MapPrint
       @texts = args[:texts]
       @legend = args[:legend]
       @scalebar = args[:scalebar]
+      raise ParameterError.new("Please indicate the southwest point for the map ({map: {sw: {lat: -35.026862, lng: -58.425003}}})") unless @map && @map[:sw] && @map[:sw][:lat] && @map[:sw][:lng]
+      raise ParameterError.new("Please indicate the northeast point for the map ({map: {ne: {lat: -29.980172, lng: -52.959305}}})") unless @map[:ne] && @map[:ne][:lat] && @map[:ne][:lng]
+      raise ParameterError.new("Please indicate the zoom level for the map ({map: {zoom: 9})") unless @map[:zoom]
+      raise ParameterError.new("Please indicate layers to be printed for the map ({map: {layers: [{type: 'osm'}]})") unless @map[:layers].is_a?(Array)
     end
 
     def print(output_path)
@@ -36,10 +41,9 @@ module MapPrint
 
       if @format == 'pdf'
         handler = PdfHandler.new(self)
-      elsif @format == 'png'
-        handler = PngHandler.new(self)
       else
-        raise "Unsupported format: #{@format}"
+        Logger.warn 'Did not specify format, defaulting to png'
+        handler = PngHandler.new(self)
       end
 
       handler.print
@@ -47,11 +51,7 @@ module MapPrint
     end
 
     def print_layers
-      file = LayerHandler.new(@map[:layers], @map[:sw], @map[:ne], @map[:zoom]).process
-
-      FileUtils.cp file.path, 'layers.png' if defined?(DEBUG)
-
-      file
+      LayerHandler.new(@map[:layers], @map[:sw], @map[:ne], @map[:zoom]).process
     end
 
     def print_geojson(map_image)
@@ -67,12 +67,15 @@ module MapPrint
     end
 
     def print_scalebar
+      if @scalebar
+        ScalebarHandler.new(@scalebar, @map[:zoom]).process
+      end
     end
 
-    def print_legend_on_pdf(pdf)
-    end
-
-    def print_legend_on_png(png)
+    def print_legend
+      if @legend
+        LegendHandler.new(@legend).process
+      end
     end
   end
 end

data/lib/map_print/exceptions.rb

@@ -0,0 +1,20 @@
+module MapPrint
+  class GeoJSONHandlerError < StandardError; end
+  class InvalidGeoJSON < GeoJSONHandlerError; end
+  class NoPointImage < GeoJSONHandlerError; end
+  class NoGeometryPresent < GeoJSONHandlerError; end
+  class FeatureNotImplemented < GeoJSONHandlerError; end
+
+  class LegendHandlerError < StandardError; end
+  class NoLegendData < LegendHandlerError; end
+  class InvalidSize < LegendHandlerError; end
+  class MissingLayoutInformation < LegendHandlerError; end
+
+  class ScalebarHandlerError < StandardError; end
+  class NoScalebarData < ScalebarHandlerError; end
+  class InvalidScalebarSize < ScalebarHandlerError; end
+  class InvalidScalebarZoom < ScalebarHandlerError; end
+
+  class CoreError < StandardError; end
+  class ParameterError < CoreError; end
+end

data/lib/map_print/geo_json_handler.rb

@@ -10,6 +10,8 @@ module MapPrint
       @height = height
       @width = width
       @geojson = JSON[geojson]
+    rescue JSON::GeneratorError, JSON::ParserError
+      raise InvalidGeoJSON.new("Invalid GeoJSON: #{geojson.inspect}")
     end
 
     def process
@@ -25,23 +27,26 @@ module MapPrint
       tempfile.close
     end
 
+    private
     def draw_geojson
       if @geojson['type'] == 'Feature'
         feature(@geojson['geometry'], @geojson['properties'])
       elsif @geojson['type'] == 'FeatureCollection'
         feature_collection(@geojson['features'])
       else
-        puts "Warning, expected type Feature with #{@geojson['type']} inside geometry and drawing properties, like: {'type': 'Feature', 'geometry':#{@geojson.to_json}, 'properties':{'image': 'path/or/url/to/image'}}"
+        Logger.warn "Warning, expected type Feature with #{@geojson['type'].inspect} inside geometry and drawing properties, like: {'type': 'Feature', 'geometry':#{@geojson.to_json}, 'properties':{'image': 'path/or/url/to/image'}}"
       end
     end
 
     def feature(geometry, properties={})
+      raise NoGeometryPresent.new("No geometry present for this feature") if geometry.nil?
       case geometry['type']
       when 'Feature'
         feature(geometry['geometry'], geometry['properties'])
       when 'FeatureCollection'
         feature_collection(geometry['features'])
       when 'Point'
+        raise NoPointImage.new("Missing image in point geometry") unless properties && properties['image']
         point(geometry, properties['image'])
       when 'LineString'
         line_string(geometry, properties)
@@ -55,7 +60,11 @@ module MapPrint
         multi_polygon(geometry, properties)
       when 'GeometryCollection'
         geometry_collection(geometry, properties)
+      else
+        Logger.warn "Feature type '#{geometry['type']}' not implemented!"
       end
+    rescue GeoJSONHandlerError => ex
+      Logger.warn ex
     end
 
     def feature_collection(features)
@@ -103,7 +112,22 @@ module MapPrint
       end
     end
 
-    private
+    def multi_point(geometry, properties)
+      raise FeatureNotImplemented.new("Please consider contributing!")
+    end
+
+    def multi_line_string(geometry, properties)
+      raise FeatureNotImplemented.new("Please consider contributing!")
+    end
+
+    def multi_polygon(geometry, properties)
+      raise FeatureNotImplemented.new("Please consider contributing!")
+    end
+
+    def geometry_collection(geometry, properties)
+      raise FeatureNotImplemented.new("Please consider contributing!")
+    end
+
     def draw_options(properties, line=true)
       options = ''
       if properties['stroke'] || properties['stroke'].nil?

data/lib/map_print/lat_lng.rb

@@ -1,7 +1,30 @@
 module MapPrint
   class LatLng
+    EARTH_RADIUS_IN_METERS = 6_376_772.71
+
     attr_accessor :lat, :lng
 
+    class << self
+      def distance_between(from, to)
+        return 0.0 if from == to # fixes a "zero-distance" bug
+
+        distance_between_sphere(from, to)
+      end
+
+      def distance_between_sphere(from, to)
+        lat_sin = Math.sin(deg2rad(from.lat)) * Math.sin(deg2rad(to.lat))
+        lat_cos = Math.cos(deg2rad(from.lat)) * Math.cos(deg2rad(to.lat))
+        lng_cos = Math.cos(deg2rad(to.lng) - deg2rad(from.lng))
+        EARTH_RADIUS_IN_METERS * Math.acos(lat_sin + lat_cos * lng_cos)
+      rescue Errno::EDOM
+        0.0
+      end
+
+      def deg2rad(degrees)
+        degrees.to_f / 180.0 * Math::PI
+      end
+    end
+
     def initialize(lat, lng)
       @lat = lat
       @lng = lng
@@ -18,7 +41,9 @@ module MapPrint
       @get_slippy_map_tile_number = {x: x.to_i, y: y.to_i, offset: {x: x - x.to_i, y: y - y.to_i}}
     end
 
-    def diff_in_meters(lat_lng)
+    def distance_to(other)
+      self.class.distance_between(self, other)
     end
+    alias_method :distance_from, :distance_to
   end
 end

data/lib/map_print/layer_handler.rb

@@ -1,21 +1,21 @@
 module MapPrint
   class LayerHandler
     PROVIDERS = {
-      'bing' => MapPrint::Providers::Bing,
-      'osm'  => MapPrint::Providers::OpenStreetMap
+      'bing' => Providers::Bing,
+      'osm'  => Providers::OpenStreetMap
     }
 
     def initialize(layers, south_west, north_east, zoom)
       @layers = layers.sort_by { |layer| layer[:level] }
-      @south_west = MapPrint::LatLng.new(south_west[:lat], south_west[:lng])
-      @north_east = MapPrint::LatLng.new(north_east[:lat], north_east[:lng])
+      @south_west = LatLng.new(south_west[:lat], south_west[:lng])
+      @north_east = LatLng.new(north_east[:lat], north_east[:lng])
       @zoom = zoom
     end
 
     def process
       @layers.each do |layer|
         provider_class = PROVIDERS[layer[:type]]
-        provider = provider_class.new(@south_west, @north_east, @zoom, layer[:urls].first)
+        provider = provider_class.new(@south_west, @north_east, @zoom, layer[:urls] && layer[:urls].first)
         layer[:image] = provider.download
       end
 

data/lib/map_print/legend_handler.rb

@@ -1,9 +1,108 @@
 module MapPrint
   class LegendHandler
-    def initialize(legend, file)
+    def initialize(legend)
+      @legend = legend
+      validate_data!
     end
 
     def process
+      size = @legend[:size]
+      tempfile = Tempfile.new ['legend', '.png']
+      `convert -size #{size[:width]}x#{size[:height]} xc:white #{tempfile.path}`
+      image = MiniMagick::Image.new tempfile.path
+
+      x_step = size[:width] / @legend[:columns]
+      y_step = size[:height] / @legend[:rows]
+      image_geometry = ''
+      textbox_offset = 0
+      text_size = "#{@legend[:textbox_size][:width]}x#{@legend[:textbox_size][:height]}" if @legend[:textbox_size]
+
+      if @legend[:image_size]
+        image_geometry += "#{@legend[:image_size][:width]}x#{@legend[:image_size][:height]}"
+        textbox_offset += @legend[:image_size][:width] if @legend[:image_size][:width]
+      end
+      textbox_offset += @legend[:textbox_offset] if @legend[:textbox_offset]
+
+      if @legend[:orientation] == 'vertical'
+        print_vertical(image, x_step, y_step, image_geometry, textbox_offset, text_size)
+      else
+        print_horizontal(image, x_step, y_step, image_geometry, textbox_offset, text_size)
+      end
+      image
+    end
+
+    private
+    def validate_data!
+      raise NoLegendData.new('No legend data present') if @legend.nil? || @legend.empty?
+      raise InvalidSize.new('No legend width present') unless @legend[:size] && @legend[:size][:width]
+      raise InvalidSize.new('No legend height present') unless @legend[:size][:height]
+      raise MissingLayoutInformation.new('Missing column layout information') unless @legend[:columns]
+      raise MissingLayoutInformation.new('Missing rows layout information') unless @legend[:rows]
+    end
+
+    def print_vertical(legend_image, x_step, y_step, image_geometry, textbox_offset, text_size)
+      return unless @legend[:elements].is_a?(Array)
+      x = 0
+      y = 0
+      z = 1
+
+      @legend[:elements].each do |legend_item|
+        image_file = MiniMagick::Image.open(legend_item[:image])
+        result = legend_image.composite(image_file) do |c|
+          c.geometry image_geometry + "+#{x}+#{y}"
+        end
+        result.write legend_image.path
+
+        position = "#{x + textbox_offset},#{y}"
+        draw_text(legend_image, legend_item[:text], position, text_size)
+
+        if z % @legend[:rows] == 0
+          x += x_step
+          y = 0
+        else
+          y += y_step
+        end
+        z += 1
+      end
+    end
+
+    def print_horizontal(legend_image, x_step, y_step, image_geometry, textbox_offset, text_size)
+      return unless @legend[:elements].is_a?(Array)
+      x = 0
+      y = 0
+      z = 1
+
+      @legend[:elements].each do |legend_item|
+        image_file = MiniMagick::Image.open(legend_item[:image])
+        result = legend_image.composite(image_file) do |c|
+          c.geometry image_geometry + "+#{x}+#{y}"
+        end
+        result.write legend_image.path
+
+        position = "#{x + textbox_offset},#{y}"
+        draw_text(legend_image, legend_item[:text], position, text_size)
+
+        if z % @legend[:columns] == 0
+          y += y_step
+          x = 0
+        else
+          x += x_step
+        end
+        z += 1
+      end
+    end
+
+    def draw_text(image, text, position, text_size)
+      options = @legend[:textbox_style] || {}
+      image.combine_options do |c|
+        c.fill options[:fill_color] if options[:fill_color]
+        c.stroke options[:color] if options[:color]
+        c.font options[:font] || 'Arial'
+        c.pointsize options[:pointsize] if options[:pointsize]
+        c.gravity options[:gravity] || 'NorthWest'
+        c.size text_size
+        c.draw "text #{position} '#{text}'"
+      end
     end
   end
 end

data/lib/map_print/logger.rb

@@ -0,0 +1,52 @@
+require 'singleton'
+require 'logger'
+
+module MapPrint
+  class Logger
+    include Singleton
+
+    def initialize
+      @logger = ::Logger.new File.new('map_print.log', 'a+')
+    end
+
+    def debug(*args)
+      @logger.debug *args
+    end
+
+    def info(*args)
+      @logger.info *args
+    end
+
+    def warn(*args)
+      @logger.warn *args
+    end
+
+    def error(*args)
+      @logger.error *args
+    end
+
+    def fatal(*args)
+      @logger.fatal *args
+    end
+
+    def self.debug(*args)
+      self.instance.debug *args
+    end
+
+    def self.info(*args)
+      self.instance.info *args
+    end
+
+    def self.warn(*args)
+      self.instance.warn *args
+    end
+
+    def self.error(*args)
+      self.instance.error *args
+    end
+
+    def self.fatal(*args)
+      self.instance.fatal *args
+    end
+  end
+end

data/lib/map_print/pdf_handler.rb

@@ -16,19 +16,31 @@ module MapPrint
       print_map
       print_images(@context.images, @pdf)
       print_texts(@context.texts, @pdf)
-      # print_legend_on_pdf(@pdf)
+
+      scalebar_image = @context.print_scalebar
+      if scalebar_image
+        @pdf.image scalebar_image.path, at: [@context.scalebar[:position][:x], @pdf.bounds.top - @context.scalebar[:position][:y]]
+      end
+
+      legend_image = @context.print_legend
+      if legend_image
+        @pdf.image legend_image.path, at: [@context.legend[:position][:x], @pdf.bounds.top - @context.legend[:position][:y]]
+      end
 
       @pdf.render_file(@context.output_path)
     end
 
+    private
     def print_map
       map_image = @context.print_layers
       map_image = @context.print_geojson(MiniMagick::Image.new(map_image.path))
 
-      size = @context.map[:size]
+      size = @context.map[:size] || {}
       size[:width] ||= map_image.width
       size[:height] ||= map_image.height
-      @pdf.image map_image.path, at: [@context.map[:position][:x], @pdf.bounds.top - @context.map[:position][:y]], fit: size.values
+
+      position = @context.map[:position] || {}
+      @pdf.image map_image.path, at: [position[:x] || 0, @pdf.bounds.top - (position[:y] || 0)], fit: size.values
     end
   end
 end

data/lib/map_print/pdf_handlers/images.rb

@@ -2,7 +2,7 @@ module MapPrint
   module PdfHandlers
     module Images
       def print_images(images, pdf)
-        images.each do |image|
+        (images || []).each do |image|
           if image[:path] =~ /https?:\/\//
             image_file = open(image[:path])
           else

data/lib/map_print/pdf_handlers/texts.rb

@@ -2,7 +2,7 @@ module MapPrint
   module PdfHandlers
     module Texts
       def print_texts(texts, pdf)
-        texts.each do |text|
+        (texts || []).each do |text|
           pdf.text_box text[:text], text_options(text)
         end
       end

data/lib/map_print/png_handler.rb

@@ -11,14 +11,25 @@ module MapPrint
     end
 
     def print
-      `convert -size #{@context.png_options[:width]}x#{@context.png_options[:height]} xc:#{@context.png_options[:background_color]} #{@context.output_path}`
+      raise ParameterError.new('Missing png_options width attribute') unless @context.png_options && @context.png_options[:width]
+      raise ParameterError.new('Missing png_options height attribute') unless @context.png_options[:height]
+      `convert -size #{@context.png_options[:width]}x#{@context.png_options[:height]} xc:#{@context.png_options[:background_color] || 'transparent'} #{@context.output_path}`
       @png = MiniMagick::Image.new @context.output_path
 
       print_map
 
       print_images(@context.images, @png)
       print_texts(@context.texts, @png)
-      # print_legend_on_png
+
+      scalebar_image = @context.print_scalebar
+      if scalebar_image
+        overlay_image(MiniMagick::Image.new(scalebar_image.path), @context.scalebar[:position])
+      end
+
+      legend_image = @context.print_legend
+      if legend_image
+        overlay_image(MiniMagick::Image.new(legend_image.path), @context.legend[:position])
+      end
     end
 
     def print_map
@@ -33,12 +44,16 @@ module MapPrint
         geometry += size[:height].to_s if size[:height]
       end
 
-      if @context.map[:position]
-        geometry += "+#{@context.map[:position][:x] || 0}+#{@context.map[:position][:y] || 0}"
-      end
+      overlay_image(map_image, @context.map[:position], geometry)
+    end
+
+    private
+    def overlay_image(image, position, size_geometry='')
+      geometry = size_geometry
+      geometry += "+#{position[:x] || 0}+#{position[:y] || 0}" if position
 
-      result = @png.composite(map_image) do |c|
-        c.geometry geometry
+      result = @png.composite(image) do |c|
+        c.geometry geometry unless geometry.nil? || geometry.empty?
       end
       result.write @context.output_path
     end

data/lib/map_print/png_handlers/images.rb

@@ -2,7 +2,7 @@ module MapPrint
   module PngHandlers
     module Images
       def print_images(images, png)
-        images.each do |image|
+        (images || []).each do |image|
           image_file = MiniMagick::Image.open(image[:path])
 
           geometry = ''

data/lib/map_print/png_handlers/texts.rb

@@ -2,7 +2,7 @@ module MapPrint
   module PngHandlers
     module Texts
       def print_texts(texts, png)
-        texts.each do |text|
+        (texts || []).each do |text|
           position = "#{text[:position][:x]},#{text[:position][:y]}"
 
           draw_text(png, text[:text], position, text[:options])

data/lib/map_print/providers/base.rb

@@ -2,12 +2,9 @@ require 'tempfile'
 
 module MapPrint
   module Providers
-
     class Base
 
-      attr_accessor :provider
-
-      attr_accessor :south_west, :north_east, :zoom
+      attr_accessor :provider, :south_west, :north_east, :zoom
 
       def initialize(south_west, north_east, zoom, base_url=nil)
         @south_west, @north_east, @zoom = south_west, north_east, zoom
@@ -48,8 +45,6 @@ module MapPrint
         file.close
         result_file
       end
-
     end
-
   end
 end

data/lib/map_print/scalebar_handler.rb

@@ -1,9 +1,111 @@
+require_relative 'png_handlers/texts'
 module MapPrint
   class ScalebarHandler
-    def initialize(scalebar, file)
+    include MapPrint::PngHandlers::Texts
+
+    ZOOM_METERS_PER_PIXEL = {
+      0 => 156543.03,
+      1 => 78271.52,
+      2 => 39135.76,
+      3 => 19567.88,
+      4 => 9783.94,
+      5 => 4891.97,
+      6 => 2445.98,
+      7 => 1222.99,
+      8 => 611.50,
+      9 => 305.75,
+      10 => 152.87,
+      11 => 76.437,
+      12 => 38.219,
+      13 => 19.109,
+      14 => 9.5546,
+      15 => 4.7773,
+      16 => 2.3887,
+      17 => 1.1943,
+      18 => 0.5972
+    }
+    def initialize(scalebar, zoom)
+      @scalebar = scalebar
+      @zoom = zoom
+      if @scalebar[:padding]
+        @padding_left = @scalebar[:padding][:left] || 0
+        @padding_right = @scalebar[:padding][:right] || 0
+        @padding_top = @scalebar[:padding][:top] || 0
+        @padding_bottom = @scalebar[:padding][:bottom] || 0
+      else
+        @padding_left = 0
+        @padding_right = 0
+        @padding_top = 0
+        @padding_bottom = 0
+      end
+      validate_data!
     end
 
     def process
+      size = @scalebar[:size]
+      tempfile = Tempfile.new ['scalebar', '.png']
+      `convert -alpha on -channel a -evaluate set #{(@scalebar[:background_opacity] || 1) *100}% -density 300 -size #{size[:width]}x#{size[:height]} xc:#{@scalebar[:background_color] || 'transparent'} #{tempfile.path}`
+      image = MiniMagick::Image.new tempfile.path
+
+      pixels_for_distance = get_distance_in_units
+      quarter = (size[:width] - @padding_left - @padding_right) / 4
+
+      y_position = size[:height] - (@scalebar[:bar_height] || 10) - @padding_bottom
+      image.combine_options do |c|
+        c.stroke 'black'
+        c.fill 'white'
+        c.draw "rectangle #{@padding_left},#{size[:height] - @padding_bottom} #{@padding_left + quarter},#{y_position}"
+        c.fill 'black'
+        c.draw "rectangle #{@padding_left + quarter},#{size[:height] - @padding_bottom} #{@padding_left + 2*quarter},#{y_position}"
+        c.fill 'white'
+        c.draw "rectangle #{@padding_left + 2*quarter},#{size[:height] - @padding_bottom} #{@padding_left + 3*quarter},#{y_position}"
+        c.fill 'black'
+        c.draw "rectangle #{@padding_left + 3*quarter},#{size[:height] - @padding_bottom} #{@padding_left + 4*quarter},#{y_position}"
+      end
+
+      text_options = { pointsize: 12, gravity: 'NorthWest' }
+      draw_text(image, "0", "#{@padding_left},#{@padding_top}", text_options)
+      draw_text(image, (pixels_for_distance/4).round(-2).to_s, "#{-quarter + @padding_left - @padding_right},#{@padding_top}", text_options.merge(gravity: 'North'))
+      draw_text(image, (pixels_for_distance/2).round(-2).to_s, "#{@padding_left - @padding_right},#{@padding_top}", text_options.merge(gravity: 'North'))
+      draw_text(image, (pixels_for_distance*0.75).round(-2).to_s + distance_units_to_s, "#{@padding_right},#{@padding_top}", text_options.merge(gravity: 'NorthEast'))
+
+      image
+    end
+
+    private
+    def validate_data!
+      raise NoScalebarData.new('No scalebar data present') if @scalebar.nil? || @scalebar.empty?
+      raise InvalidScalebarSize.new('No scalebar width present') unless @scalebar[:size] && @scalebar[:size][:width]
+      raise InvalidScalebarSize.new('No scalebar height present') unless @scalebar[:size][:height]
+      raise InvalidScalebarZoom.new('Zoom must be between 0..18') unless (0..18).include?(@zoom)
+    end
+
+    def get_distance_in_units
+      padding = @padding_left + @padding_right
+      meters = (@scalebar[:size][:width] - padding) * ZOOM_METERS_PER_PIXEL[@zoom]
+      case @scalebar[:units]
+      when 'km'
+        meters / 1000
+      when 'miles'
+        meters * 0.0006213712
+      when 'feet'
+        meters * 3.28084
+      else # asssume meters
+        meters
+      end
+    end
+
+    def distance_units_to_s
+      case @scalebar[:units]
+      when 'km'
+        'km'
+      when 'miles'
+        'mi'
+      when 'feet'
+        'ft'
+      else
+        'm'
+      end
     end
   end
 end

data/lib/map_print/tiles/osm_tile.rb

@@ -1,7 +1,5 @@
 module MapPrint
-
   class OSMTile < Tile
-
     def provider_name
       'osm'
     end
@@ -15,7 +13,5 @@ module MapPrint
     def tile_url
       @base_url.gsub('${x}', @x.to_s).gsub('${y}', @y.to_s).gsub('${z}', @z.to_s)
     end
-
   end
-
 end

data/lib/map_print/tiles/tile.rb

@@ -54,14 +54,9 @@ module MapPrint
 
     def get_pixel_difference(lat_lng)
       tile_lat_lng = tile_number_to_lat_lng
-      puts '================'
-      puts lat_lng.lat
-      puts lat_lng.lng
-      puts tile_lat_lng
-      puts '================'
-
-      x_pixels = GeoDistance.distance(lat_lng.lat, lat_lng.lng, lat_lng.lat, tile_lat_lng[:lng]).meters.number / METERS_PER_PIXELS[@z]
-      y_pixels = GeoDistance.distance(lat_lng.lat, lat_lng.lng, tile_lat_lng[:lat], lat_lng.lng).meters.number / METERS_PER_PIXELS[@z]
+
+      x_pixels = lat_lng.distance_to(LatLng.new(lat_lng.lat, tile_lat_lng[:lng])) / METERS_PER_PIXELS[@z]
+      y_pixels = lat_lng.distance_to(LatLng.new(tile_lat_lng[:lat], lat_lng.lng)) / METERS_PER_PIXELS[@z]
 
       { x: x_pixels, y: y_pixels }
     end

data/lib/map_print/tiles/tile_factory.rb

@@ -30,6 +30,14 @@ module MapPrint
       end
     end
 
+    def x_size
+      x_array.size
+    end
+
+    def y_size
+      y_array.size
+    end
+
     def tiles
       return @tiles if @tiles
 
@@ -43,14 +51,7 @@ module MapPrint
       @tiles
     end
 
-    def x_size
-      x_array.size
-    end
-
-    def y_size
-      y_array.size
-    end
-
+    private
     def ne_offset
       @ne_lat_lng.get_slippy_map_tile_number(@zoom)[:offset]
     end
@@ -75,16 +76,12 @@ module MapPrint
       @y_array ||= y1 < y2 ? y1..y2 : (y2..y1).to_a
     end
 
-    private
-
     def tile_class
       if @type == 'osm'
         OSMTile
-      elsif @type =~ 'bing'
+      elsif @type =~ /bing/
         BingTile
       end
     end
-
   end
-
 end

data/lib/map_print/version.rb

@@ -1,3 +1,3 @@
 module MapPrint
-  VERSION = '0.3.0'
+  VERSION = '0.9.0'
 end

data/lib/map_print.rb

@@ -1,8 +1,8 @@
 require 'prawn'
 require 'mini_magick'
-require 'geo-distance'
 require 'parallel'
 
 require_relative 'base'
 require_relative 'map_print/version'
+require_relative 'map_print/exceptions'
 require_relative 'map_print/core'

data/map_print.gemspec

@@ -30,10 +30,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'webmock', '1.22.6'
   spec.add_dependency 'prawn', '~> 2.0'
   spec.add_dependency 'prawn-fast-png', '~> 0.2.3'
   spec.add_dependency 'mini_magick', '~> 4.3'
-  spec.add_dependency 'geo-distance', '~> 0.1'
   spec.add_dependency 'parallel', '~> 1.6'
   spec.add_dependency 'thor', '~> 0.19'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: map_print
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Andreas Fast
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-02 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.22.6
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
-- !ruby/object:Gem::Dependency
-  name: geo-distance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,7 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -161,12 +162,12 @@ files:
 - lib/base.rb
 - lib/map_print.rb
 - lib/map_print/core.rb
+- lib/map_print/exceptions.rb
 - lib/map_print/geo_json_handler.rb
 - lib/map_print/lat_lng.rb
 - lib/map_print/layer_handler.rb
 - lib/map_print/legend_handler.rb
-- lib/map_print/osm/tile.rb
-- lib/map_print/osm/tile_factory.rb
+- lib/map_print/logger.rb
 - lib/map_print/pdf_handler.rb
 - lib/map_print/pdf_handlers/images.rb
 - lib/map_print/pdf_handlers/texts.rb
@@ -183,7 +184,7 @@ files:
 - lib/map_print/tiles/tile_factory.rb
 - lib/map_print/version.rb
 - map_print.gemspec
-- marker.png
+- minimum_map.pdf
 homepage: http://github.com/afast/map_print
 licenses:
 - MIT

data/lib/map_print/osm/tile.rb

@@ -1,125 +0,0 @@
-require 'open-uri'
-require 'fileutils'
-
-module MapPrint
-  module OSM
-    class Tile
-
-      BIT_TO_QUADKEY = { [false, false] => "0", [false, true] => "1", [true, false] => "2", [true, true] => "3"}
-
-      METERS_PER_PIXELS = {
-        0 => 26862156543.031,
-        1 => 8078271.521,
-        2 => 7739135.761,
-        3 => 6919567.881,
-        4 => 889783.941,
-        5 => 214891.9771,
-        6 => 222445.9801721,
-        7 => 161731222.991,
-        8 => 11611.5001,
-        9 => 52305.751,
-        10 => 152.871,
-        11 => 76.4371,
-        12 => 38.2191,
-        13 => 519.1091,
-        14 => 9.55461,
-        15 => 4.77731,
-        16 => 2.38871,
-        17 => 1.19431,
-        18 => 0.5972
-      }
-
-      class << self
-
-        def meters_per_pixel(zoom)
-          METERS_PER_PIXELS[zoom]
-        end
-
-      end
-
-      def initialize(x, y, z, base_url)
-        @base_url = base_url
-        @x = x
-        @y = y
-        @z = z
-      end
-
-      def coords
-        {x: @x, y: @y, z: @z}
-      end
-
-      def download
-        unless File.exists?(file_path)
-          content = open(get_url).read
-          write_file(content)
-        end
-      end
-
-      def get_pixel_difference(lat_lng)
-        tile_lat_lng = tile_number_to_lat_lng
-
-        x_pixels = GeoDistance.distance(lat_lng.lat, lat_lng.lng, lat_lng.lat, tile_lat_lng[:lng]).meters.number / METERS_PER_PIXELS[@z]
-        y_pixels = GeoDistance.distance(lat_lng.lat, lat_lng.lng, tile_lat_lng[:lat], lat_lng.lng).meters.number / METERS_PER_PIXELS[@z]
-
-        { x: x_pixels, y: y_pixels }
-      end
-
-      def tile_number_to_lat_lng
-        n = 2.0 ** @z
-        lon_deg = @x / n * 360.0 - 180.0
-        lat_rad = Math::atan(Math::sinh(Math::PI * (1 - 2 * @y / n)))
-        lat_deg = 180.0 * (lat_rad / Math::PI)
-
-        { lat: lat_deg, lng: lon_deg }
-      end
-
-      def file_path
-        File.join(folder_name, "#{@y}.png")
-      end
-
-      def tile2quad
-        quadkey_chars = []
-
-        tx = @x.to_i
-        ty = @y.to_i
-
-        @z.times do
-          quadkey_chars.push BIT_TO_QUADKEY[[ty.odd?, tx.odd?]] # bit order y,x
-          tx >>= 1 ; ty >>= 1
-        end
-
-        quadkey_chars.join.reverse
-      end
-
-      private
-
-      def write_file(content)
-        FileUtils.mkdir_p(folder_name)
-
-        File.open file_path, 'wb' do |f|
-          f.write content
-        end
-      end
-
-      def provider_name
-        if @base_url =~ /openstreetmap/
-          'osm'
-        elsif @base_url =~ /virtualearth/
-          'bing'
-        end
-      end
-
-      def folder_name
-        "cache/#{provider_name}/#{@z}/#{@x}"
-      end
-
-      def get_url
-        if provider_name == 'osm'
-          @base_url.gsub('${x}', @x.to_s).gsub('${y}', @y.to_s).gsub('${z}', @z.to_s)
-        elsif provider_name == 'bing'
-          @base_url.gsub('${quadkey}', tile2quad)
-        end
-      end
-    end
-  end
-end

data/lib/map_print/osm/tile_factory.rb

@@ -1,75 +0,0 @@
-module MapPrint
-  module OSM
-    class TileFactory
-
-      def initialize(base_url, sw_lat_lng, ne_lat_lng, zoom)
-        @base_url = base_url
-        @sw_lat_lng = sw_lat_lng
-        @ne_lat_lng = ne_lat_lng
-        @zoom = zoom
-      end
-
-      def px_offset
-        return @px_offset if @px_offset
-        offset = {}
-
-        offset[:top] = (ne_offset[:y] * 256).to_i
-        offset[:right] = 256 - (ne_offset[:x] * 256).to_i
-        offset[:bottom] = 256 - (sw_offset[:y] * 256).to_i
-        offset[:left] = (sw_offset[:x] * 256).to_i
-        @px_offset = offset
-      end
-
-      def download
-        Parallel.each(tiles, in_processes: 20) do |tile|
-          tile.download
-        end
-      end
-
-      def tiles
-        return @tiles if @tiles
-
-        @tiles = []
-        y_array.each do |y|
-          x_array.each do |x|
-            @tiles << Tile.new(x, y, @zoom, @base_url)
-          end
-        end
-
-        @tiles
-      end
-
-      def x_size
-        x_array.size
-      end
-
-      def y_size
-        y_array.size
-      end
-
-      def ne_offset
-        @ne_lat_lng.get_slippy_map_tile_number(@zoom)[:offset]
-      end
-
-      def sw_offset
-        @sw_lat_lng.get_slippy_map_tile_number(@zoom)[:offset]
-      end
-
-      def x_array
-        return @x_array if @x_array
-
-        x1 = @sw_lat_lng.get_slippy_map_tile_number(@zoom)[:x]
-        x2 = @ne_lat_lng.get_slippy_map_tile_number(@zoom)[:x]
-        @x_array ||= x1 < x2 ? x1..x2 : (x2..x1).to_a
-      end
-
-      def y_array
-        return @y_array if @y_array
-
-        y1 = @sw_lat_lng.get_slippy_map_tile_number(@zoom)[:y]
-        y2 = @ne_lat_lng.get_slippy_map_tile_number(@zoom)[:y]
-        @y_array ||= y1 < y2 ? y1..y2 : (y2..y1).to_a
-      end
-    end
-  end
-end