map_print 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 423a53002a18daf1de1ba8cd5aabdcc9c17fb112
-  data.tar.gz: 49824e15480ccfffd1c89e48573c8e8fb7957ea7
+  metadata.gz: bcc0124c6e8b0ca5bae918c8306ff3057f8d400e
+  data.tar.gz: 0c47173c8d8a2079d54a6775ee738f3f9a50a233
 SHA512:
-  metadata.gz: 8ee96b45449be505392177a1a893295e0c844728d48b762f28945c2cda30cb368ea48ce12d81dc30720adc740fa973125c70759fe3061592043b3e8c320ff069
-  data.tar.gz: a3f083c06a7c3781c23362bde338748cadaf53cc9b0e057b212110ad56e2442f0452f88d10b293bb99a8cf972d2d36242b070f93dc1f59a68014b084b560c7f6
+  metadata.gz: 2a3fc9ee3d584924d37ac49a68319a9827f9c4b3a00718c5f77d81ee969b0ddacec7ba30626fca03fb04e527c68ee206c2cf3cc0fd5f0d4ff2a16f5c129f17da
+  data.tar.gz: 36f8e4882219e98149d3750d778e25292d277198a13b21c5e4b0f6c39d50486627105d2bba0bdfe1a6dc63967fb6dfee58892b3b854632f3f37df37dbbac1c26

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    map_print (1.0.1)
+    map_print (1.1.0)
       mini_magick (~> 4.3)
       parallel (~> 1.6)
       prawn (~> 2.0)

data/README.md

@@ -27,7 +27,7 @@ Or install it yourself as:
 
 ### Executable 
 
-`map_print print --south-west="-35.026862,-58.425003" --north-east="-29.980172,-52.959305" --zoom="10" --output="output.png"`
+`map_print print --south-west="-35.026862,-58.425003" --north-east="-29.980172,-52.959305" --width=500 --height=800 --zoom="10" --output="output.png"`
 
 Indicating southwest and northeast to determine the bounding box. Set the zoom at which the tiles should be requested.
 
@@ -210,7 +210,14 @@ map_configuration = {
       padding: {top: 5, right: 5, bottom: 5, left: 5},
       bar_height: 10,
       background_color: 'black',
-      background_opacity: 0.4
+      background_opacity: 0.4,
+      text_style: {
+        fill_color: '#ffffff',
+        color: '#000000',
+        font: 'Arial',
+        pointsize: '16',
+        gravity: 'NorthWest'
+      }
     }
   }
 ```

data/bin/map_print

@@ -10,8 +10,10 @@ class MapPrintCommand < Thor
 
   method_option :south_west, type: :string, required: true
   method_option :north_east, type: :string, required: true
-  method_option :output, type: :string, required: true
+  method_option :width, type: :numeric, required: true
+  method_option :height, type: :numeric, required: true
   method_option :zoom, type: :numeric, default: 10
+  method_option :output, type: :string, required: true
 
   method_option :provider, type: :string, default: 'osm',
                 enum: ['osm', 'bing']
@@ -25,8 +27,11 @@ class MapPrintCommand < Thor
     south_west = MapPrint::LatLng.new(*south_west_coordinate)
     north_east = MapPrint::LatLng.new(*north_east_coordinate)
 
+    png_options = {height: options[:height], width: options[:width]}
+
     map_options = {
       format: 'png',
+      png_options: png_options,
       map: {
         sw: {
           lat: south_west.lat,

data/lib/map_print/geo_json_handler.rb

@@ -38,30 +38,33 @@ module MapPrint
       end
     end
 
-    def feature(geometry, properties={})
+    def validate_feature(geometry, properties)
       raise NoGeometryPresent.new("No geometry present for this feature") if geometry.nil?
       case geometry['type']
+      when 'Point'
+        if properties.nil? || properties['image'].nil?
+          raise NoPointImage.new("Missing image in point geometry")
+        end
+      when 'MultiPoint', 'MultiLineString', 'MultiPolygon', 'GeometryCollection'
+        raise FeatureNotImplemented.new("Please consider contributing!")
+      else
+        Logger.warn "Feature type '#{geometry['type']}' not implemented!"
+      end
+    end
+
+    def feature(geometry, properties={})
+      validate_feature(geometry, properties)
+      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)
       when 'Polygon'
         polygon(geometry, properties)
-      when 'MultiPoint'
-        raise FeatureNotImplemented.new("Please consider contributing!")
-      when 'MultiLineString'
-        raise FeatureNotImplemented.new("Please consider contributing!")
-      when 'MultiPolygon'
-        raise FeatureNotImplemented.new("Please consider contributing!")
-      when 'GeometryCollection'
-        raise FeatureNotImplemented.new("Please consider contributing!")
-      else
-        Logger.warn "Feature type '#{geometry['type']}' not implemented!"
       end
     rescue GeoJSONHandlerError => ex
       Logger.warn ex
@@ -77,7 +80,7 @@ module MapPrint
       x = get_x(point['coordinates'][0])
       y = get_y(point['coordinates'][1])
 
-      if 0 <= x && x <= @width && 0 <= y && y <= @height
+      if point_inside_map?(x, y)
         point_image = MiniMagick::Image.open(image_path)
         x -= point_image.width / 2
         y -= point_image.height / 2
@@ -92,17 +95,7 @@ module MapPrint
     end
 
     def line_string(geometry, properties)
-      properties ||= {}
-      coords = geometry['coordinates']
-      coords = coords.first if coords.first.first.is_a?(Array)
-      points = coords.map do |coord|
-        x = get_x(coord[0])
-        y = get_y(coord[1])
-        if 0 <= x && x <= @width && 0 <= y && y <= @height
-          Logger.warn "Line coordinate outside map's boundaries!\ngeometry: #{geometry.inspect}\nproperties: #{properties.inspect}"
-        end
-        "#{x},#{y}"
-      end
+      points = generate_drawable_points(geometry, properties)
 
       draw_command = (0..(points.length - 2)).map do |i|
         "line #{points[i]} #{points[i+1]}"
@@ -115,17 +108,7 @@ module MapPrint
     end
 
     def polygon(geometry, properties)
-      properties ||= {}
-      coords = geometry['coordinates']
-      coords = coords.first if coords.first.first.is_a?(Array)
-      points = coords.map do |coord|
-        x = get_x(coord[0])
-        y = get_y(coord[1])
-        if 0 <= x && x <= @width && 0 <= y && y <= @height
-          Logger.warn "Polygon coordinate outside map's boundaries!\ngeometry: #{geometry.inspect}\nproperties: #{properties.inspect}"
-        end
-        "#{x},#{y}"
-      end
+      points = generate_drawable_points(geometry, properties)
 
       @image.combine_options do |c|
         c.density 300
@@ -133,20 +116,29 @@ module MapPrint
       end
     end
 
-    def draw_options(properties, line=true)
+    def stroke_options(properties)
       options = ''
       if properties['stroke'] || properties['stroke'].nil?
         options += "stroke #{properties['color'] || '#0033ff'} "
         options += "stroke-width #{properties['weight'] || 5} "
         options += "stroke-opacity #{properties['opacity'] || 0.5} "
       end
+      options
+    end
 
-      if properties['fill'] || (!line && properties['fill'].nil?)
+    def fill_options(properties, line)
+      options = ''
+      if properties['fill'] != false || !line
         options += "fill #{properties['fillColor'] || '#0033ff'} "
         options += "fill-opacity #{properties['fillOpacity'] || 0.2} "
         options += "fill-rule #{properties['fillRule'] || 'evenodd'} "
       end
+      options
+    end
 
+    def draw_options(properties, line=true)
+      options = stroke_options(properties)
+      options += fill_options(properties, line)
       options += "stroke-dasharray #{properties['dashArray']} " if properties['dashArray']
       options += "stroke-linecap #{properties['lineCap']} " if properties['lineCap']
       options += "stroke-linejoin #{properties['lineJoin']} " if properties['lineJoin']
@@ -160,5 +152,27 @@ module MapPrint
     def get_y(lat)
       @height * (@top_lat - lat) / @total_lat;
     end
+
+    def point_inside_map?(x, y)
+      0 <= x && x <= @width && 0 <= y && y <= @height
+    end
+
+    def consider_outside_boundaries(x, y, geometry, properties)
+      if !point_inside_map?(x, y)
+        Logger.warn "Coordinate outside map's boundaries!\ngeometry: #{geometry.inspect}\nproperties: #{properties.inspect}"
+      end
+    end
+
+    def generate_drawable_points(geometry, properties)
+      properties ||= {}
+      coords = geometry['coordinates']
+      coords = coords.first if coords.first.first.is_a?(Array)
+      coords.map do |coord|
+        x = get_x(coord[0])
+        y = get_y(coord[1])
+        consider_outside_boundaries(x, y, geometry, properties)
+        "#{x},#{y}"
+      end
+    end
   end
 end

data/lib/map_print/legend_handler.rb

@@ -6,12 +6,21 @@ module MapPrint
     include PngHandlers::Texts
     include Validations::Size
 
+    OVERFLOW = {
+      expand: 'expand',
+      compact: 'compact',
+      hidden: 'hidden'
+    }
+    VERTICAL = 'vertical'
+    HORIZONTAL = 'horizontal'
+
     def initialize(legend)
       @legend = legend
       validate_data!
+      overflow_option_adjustments
       @x_step = @legend[:size][:width] / @legend[:columns]
       @y_step = @legend[:size][:height] / @legend[:rows]
-      @elements_in_block = @legend[:orientation] == 'vertical' ? @legend[:rows] : @legend[:columns]
+      @elements_in_block = @legend[:orientation] == VERTICAL ? @legend[:rows] : @legend[:columns]
       @legend[:textbox_style] ||= {}
 
       if @legend[:textbox_size]
@@ -73,7 +82,7 @@ module MapPrint
     end
 
     def get_next_x_y(x, y, z)
-      if @legend[:orientation] == 'vertical'
+      if @legend[:orientation] == VERTICAL
         y, x = next_step(y, x, @y_step, @x_step, z)
       else
         x, y = next_step(x, y, @x_step, @y_step, z)
@@ -92,5 +101,61 @@ module MapPrint
 
       return small_step_value, big_step_value
     end
+
+    def overflow_hidden?
+      @legend[:overflow].nil? || @legend[:overflow].downcase == OVERFLOW[:hidden]
+    end
+
+    def overflow_expand?
+      @legend[:overflow].downcase == OVERFLOW[:expand]
+    end
+
+    def overflow_compact?
+      @legend[:overflow].downcase == OVERFLOW[:compact]
+    end
+
+    def vertical_orientation?
+      @legend[:orientation] == VERTICAL
+    end
+
+    def horizontal_orientation?
+      @legend[:orientation] == HORIZONTAL
+    end
+
+    def available_legend_spots
+      @legend[:columns] * @legend[:rows]
+    end
+
+    def overflow_option_adjustments
+      return unless @legend[:elements].size > available_legend_spots
+      case
+      when overflow_hidden?
+        @legend[:elements] = @legend[:elements][0..(available_legend_spots-1)]
+      when overflow_expand?
+        expand_adjustments
+      when overflow_compact?
+        compact_adjustments
+      end
+    end
+
+    def expand_adjustments
+      if vertical_orientation?
+        column_width = @legend[:size][:width] / @legend[:columns]
+        compact_adjustments
+        @legend[:size][:width] = @legend[:columns] * column_width
+      elsif horizontal_orientation?
+        row_height = @legend[:size][:height] / @legend[:rows]
+        compact_adjustments
+        @legend[:size][:height] = @legend[:rows] * row_height
+      end
+    end
+
+    def compact_adjustments
+      if vertical_orientation?
+        @legend[:columns] = (@legend[:elements].size / @legend[:rows].to_f).ceil
+      elsif horizontal_orientation?
+        @legend[:rows] = (@legend[:elements].size / @legend[:columns].to_f).ceil
+      end
+    end
   end
 end

data/lib/map_print/pdf_handler.rb

@@ -19,12 +19,12 @@ module MapPrint
 
       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]]
+        print_image(scalebar_image.path, @context.scalebar[:position])
       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]]
+        print_image(legend_image.path, @context.legend[:position])
       end
 
       @pdf.render_file(@context.output_path)
@@ -42,5 +42,9 @@ module MapPrint
       position = @context.map[:position] || {}
       @pdf.image map_image.path, at: [position[:x] || 0, @pdf.bounds.top - (position[:y] || 0)], fit: size.values
     end
+
+    def print_image(image_path, position)
+      @pdf.image image_path, at: [position[:x], @pdf.bounds.top - position[:y]]
+    end
   end
 end

data/lib/map_print/scalebar_handler.rb

@@ -54,20 +54,17 @@ module MapPrint
       quarter = (size[:width] - @padding_left - @padding_right) / 4
 
       y_position = size[:height] - (@scalebar[:bar_height] || 10) - @padding_bottom
+      orig_y = size[:height] - @padding_bottom
       image.combine_options do |c|
         c.density 300
         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}"
+        (0..3).each do |i|
+          c.fill (i % 2 == 0 ? 'white' : 'black')
+          c.draw "rectangle #{@padding_left + i*quarter},#{orig_y} #{@padding_left + (i+1)*quarter},#{y_position}"
+        end
       end
 
-      text_options = { pointsize: 4, gravity: 'NorthWest' }
+      text_options = { pointsize: 4, gravity: 'NorthWest' }.merge(@scalebar[:text_style] || {})
       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'))

data/lib/map_print/version.rb

@@ -1,3 +1,3 @@
 module MapPrint
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: map_print
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Andreas Fast
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler