tileup 0.1.3 → 0.1.4

data/CHANGES.md

@@ -0,0 +1,34 @@
+Tileup Change Log
+=================
+
+v0.1.4
+------
+
+- Fix: Background color for extended tiles (now transparent instead of white,
+       which would clobber transparent backgrounds)
+
+v0.1.3
+------
+
+- New: Functionality to automatically pad tiles that are not tile_width x tile_height
+- New: CLI switch to disable functionality (`dont-extend-incomplete-tiles`)
+
+v0.1.2
+------
+
+- Lost to history
+
+v0.1.1
+------
+
+- Lost to history
+
+v0.1.0
+------
+
+- Lost to history
+
+v0.0.1
+------
+
+- Lost to history

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Oliver Marriott
+
+MIT License
+
+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,73 @@
+Tile Up
+=======
+
+*Tile Up* is a ruby Ruby gem that splits a large image into a set of tiles to use with javascript mapping libraries such as [Leaflet.js](http://leafletjs.com) or [Modest Maps](http://modestmaps.com/). You can also use *Tile Up* to make tiles for `CATiledLayer` (or anything else really...).
+
+Installation
+------------
+
+`gem install tileup`
+
+`tileup` requires `rmagick` for image manipulation, which depends on `imagemagick`. `imagemagick` is avaliable through `homebrew`.
+
+Usage
+-----
+
+### Basics
+
+To generate some tiles from a large image, you'll probably use something like:
+
+```
+tileup --in huge_image.png --output-dir image_tiles \
+        --prefix my_tiles --verbose
+```
+
+Which will split `huge_image.png` up into `256x256` (default) sized tiles, and save them into the directory `image_tiles`. The images will be saved as `my_tiles_[COLUMN]_[ROW].png`
+
+```
+image_tiles/my_tiles_0_0.png
+image_tiles/my_tiles_0_1.png
+image_tiles/my_tiles_0_2.png
+...
+```
+
+### Auto zooming
+
+`tileup` can also scale your image for a number of zoom levels (max 20 levels). This is done by *scaling down* the original image, so make sure its pretty big.
+
+*(Auto zooming is an experimental hack, it should work fine for smaller increments, but may be unreliable at higher levels. E.g. `--auto-zoom 4` should work fine, `--auto-zoom 20` might not work so well.)*
+
+```
+tileup --in really_huge_image.png --auto-zoom 4 \
+       --output-dir map_tiles
+```
+
+`--auto-zoom 4` means, make 4 levesl of zoom, starting from `really_huge_image.png` at zoom level 20, then scale that down for 19, etc.
+
+You should see something like:
+
+```
+map_tiles/20/map_tile_0_0.png
+map_tiles/20/map_tile_0_1.png
+map_tiles/20/map_tile_0_2.png
+...
+map_tiles/19/map_tile_0_0.png
+map_tiles/19/map_tile_0_1.png
+map_tiles/19/map_tile_0_2.png
+...
+```
+*(where `20` is zoom level 20, the largest zoom, `19` is half the size of `20`, `18` is half the size of `19`, …)*
+
+
+### Getting help
+
+You can get help by running `tileup -h`.
+
+Contributing
+------------
+
+Fixes and patches welcome, to contribute:
+
+1. Fork this project
+1. Create a feature or fix branch *off the develop branch*
+1. Submit a pull request on that branch

data/bin/tileup

@@ -3,12 +3,6 @@
 require 'tileup'
 require 'optparse'
 
-# auto zoom bigmap.png down 4 times, output to map-tiles dir with map-tile-X-Y.png filename
-# maw --in "bigmap.png" --auto-zoom --auto-zoom-levels 4 --output-dir "map-tiles" --filename-prefx="map-tile"
-
-# maw --in "bigmap.png" --output-dir "map-tiles/20/" --filename-prefix="map-tile" --tile-width 256 --tile-height 256
-
-
 options = {
   tile_width: 256,
   tile_height: 256,
@@ -20,19 +14,24 @@ options = {
 }
 
 OptionParser.new do |o|
-  o.on('--in=input_file', " Required input file, your large image to tile up.") { |input_filename| options[:input_filename] = input_filename }
+  o.on('--in=input_file', "Required input file, your large image to tile up.") { |input_filename| options[:input_filename] = input_filename }
   o.on('--prefix=map_tile', "Prefix to append to tile files, e.g. --prefix=my_tile => my_tile_[XN]_[YN].png.") { |prefix| options[:filename_prefix] = prefix }
   o.on('--tile-width=256', "Tile width, should normally equal tile height.") { |width| options[:tile_width] = width }
   o.on('--tile-height=256', "Tile height, should normally equal tile width.") { |height| options[:tile_height] = height }
   o.on('--auto-zoom=', Integer, "Automatically scale input image N times, must be a number."){ |zooms| options[:auto_zoom_levels] = zooms }
   o.on('--output-dir=', "Output directory (will be created if it doesn't exist).") { |output_dir| options[:output_dir] = output_dir }
   o.on('--dont-extend-incomplete-tiles',
-       "Do not extend edge tiles if they do not fill an entire tile_width x tile_height. By default tileup will extend tiles to tile_width x tile_height if required.") {|e|options[:extend_incomplete_tiles] = false}
+       "Do not extend edge tiles if they do not fill an entire tile_width x tile_height. " +
+       "By default tileup will extend tiles to tile_width x tile_height if required.") {|e|options[:extend_incomplete_tiles] = false}
   o.on('-v', '--verbose', "Enable verbose logging.") { |verbose| options[:verbose] = true }
   o.on('-h', '--help', "You're looking at it.") { puts o; exit }
+  o.on('--version', "Version information (v#{TileUp::VERSION})") { puts TileUp::VERSION; exit }
   begin
     o.parse!
+  rescue SystemExit => e
+    exit
   rescue Exception => e
+    puts e.class
     puts "Argument error, #{e.message}. Try running '#{File.basename($PROGRAM_NAME)} -h'"
     exit
   end  
@@ -43,4 +42,9 @@ if options[:input_filename].nil?
   exit 1
 end
 
-TileUp::Tiler.new(options[:input_filename], options)
+begin
+  TileUp::Tiler.new(options[:input_filename], options)
+rescue Interrupt
+  puts "\n\nInterrupt received, exiting.\n"
+  exit
+end

data/lib/tileup.rb

@@ -1,151 +1,2 @@
-require 'ostruct'
-require 'RMagick'
-require 'fileutils'
-
-module TileUp
-
-  class Tiler
-
-    def initialize(image_filename, options)
-      default_options = {
-        auto_zoom_levels: nil,
-        tile_width: 256,
-        tile_height: 256,
-        filename_prefix: "map_tile",
-        output_dir: ".",
-        extend_incomplete_tiles: true,
-        verbose: false
-      }
-      @options = OpenStruct.new(default_options.merge(options))
-      @options.tile_width = @options.tile_width.to_i unless !@options.tile_width.respond_to? :to_i
-      @options.tile_height = @options.tile_height.to_i unless !@options.tile_height.respond_to? :to_i
-      @extension = image_filename.split(".").last
-      @filename_prefix = @options.filename_prefix
-
-      begin
-        @image = Magick::Image::read(image_filename).first
-      rescue Magick::ImageMagickError => e
-        puts "Could not open image #{image_filename}."
-        exit
-      end
-
-      if @options.auto_zoom_levels && @options.auto_zoom_levels > 20
-        puts "Warning: auto zoom levels hard limited to 20."
-        @options.auto_zoom_levels = 20
-      end
-      if @options.auto_zoom_levels && @options.auto_zoom_levels <= 0
-        @options.auto_zoom_levels = nil
-      end
-
-      puts "Opened #{image_filename}, #{@image.columns} x #{@image.rows}"
-
-      # pre-process our inputs to work out what we're supposed to do
-      tasks = []
-
-      if @options.auto_zoom_levels.nil?
-        # if we have no auto zoom request, then
-        # we dont shrink or scale, and save directly to the output
-        # dir.
-        tasks << {
-          output_dir: @options.output_dir, # normal output dir
-          scale: 1.0 # dont scale
-        }
-      else
-        # do have zoom levels, so construct those tasks
-        zoom_name = 20
-        scale = 1.0
-        tasks << {
-          output_dir: File.join(@options.output_dir, zoom_name.to_s),
-          scale: scale
-        }
-        (@options.auto_zoom_levels-1).times do |level|
-          scale = scale / 2.0
-          zoom_name = zoom_name - 1
-          tasks << {
-            output_dir: File.join(@options.output_dir, zoom_name.to_s),
-            scale: scale
-          }
-        end
-      end
-
-      # run through tasks list
-      tasks.each do |task|
-        image = @image
-        image_path = File.join(task[:output_dir], @filename_prefix)
-        if task[:scale] != 1.0
-          # if scale required, scale image
-          begin
-            image = @image.scale(task[:scale])
-          rescue RuntimeError => e
-            message = "Failed to scale image, are you sure the original image "\
-                      "is large enough to scale down this far (#{scale}) with this "\
-                      "tilesize (#{@options.tile_width}x#{@options.tile_height})?"
-            puts message
-            exit
-          end
-        end
-        # make output dir
-        make_path(task[:output_dir])
-        self.make_tiles(image, image_path, @options.tile_width, @options.tile_height)
-        image = nil
-      end
-
-      puts "Finished."
-
-    end
-
-    def make_path(directory_path)
-      FileUtils.mkdir_p directory_path
-    end
-
-    def make_tiles(image, filename_prefix, tile_width, tile_height)
-      # find image width and height
-      # then find out how many tiles we'll get out of
-      # the image, then use that for the xy offset in crop.
-      num_columns = (image.columns/tile_width.to_f).ceil
-      num_rows = (image.rows/tile_height.to_f).ceil
-      x,y,column,row = 0,0,0,0
-      crops = []
-
-      puts "Tiling image into columns: #{num_columns}, rows: #{num_rows}"
-
-      while true
-        x = column * tile_width
-        y = row * tile_height
-        crops << {
-          x: x,
-          y: y,
-          row: row,
-          column: column
-        }
-        column = column + 1
-        if column >= num_columns
-          column = 0
-          row = row + 1
-        end
-        if row >= num_rows
-          break
-        end
-      end
-
-      crops.each do |c|
-        ci = image.crop(c[:x], c[:y], tile_width, tile_height, true);
-
-        # unless told to do otherwise, extend tiles in the last row and column
-        # if they do not fill an entire tile width and height.
-        if @options.extend_incomplete_tiles && (c[:row] == num_rows - 1 || c[:column] == num_columns - 1)
-          # fill to width height, start from top left corner.
-          ci = ci.extent(tile_width, tile_height, 0, 0)
-        end
-
-        print "Saving tile: #{c[:row]}, #{c[:column]}..." if @options.verbose
-        ci.write("#{filename_prefix}_#{c[:column]}_#{c[:row]}.#{@extension}")
-        print "\rSaving tile: #{c[:row]}, #{c[:column]}... saved\n" if @options.verbose
-
-        ci = nil
-      end
-    end
-
-  end
-
-end
+require 'tileup/tiler'
+require 'tileup/version'

data/lib/tileup/logger.rb

@@ -0,0 +1,96 @@
+require 'logger'
+require 'ostruct'
+
+module TileUp
+
+  # Base logger class, subclass this, do not use directly.
+  class TileUpLogger
+
+    def self.sym_to_severity(sym)
+      severities =  {
+        :debug   => Logger::DEBUG,
+        :info    => Logger::INFO,
+        :warn    => Logger::WARN,
+        :error   => Logger::ERROR,
+        :fatal   => Logger::FATAL
+      }
+      severity = severities[sym] || Logger::UNKNOWN
+    end
+
+    # create logger set to given level
+    # where level is a symbol (:debug, :info, :warn, :error, :fatal)
+    # options may specifiy verbose, which will log more info messages
+    def initialize(level, options)
+      @severity = level
+      default_options = {
+        verbose: false
+      }
+      @options = OpenStruct.new(default_options.merge(options))
+    end
+
+    def level
+      @level
+    end
+
+    def level=(severity)
+      logger.level = TileUpLogger.sym_to_severity(severity)
+    end
+
+    # log an error message
+    def error(message)
+      # note, we always log error messages
+      add(:error, message)
+    end
+
+    # log a regular message
+    def info(message)
+      add(:info, message)
+    end
+
+    def warn(message)
+      add(:warn, message)
+    end
+
+    # log a verbose message
+    def verbose(message)
+      add(:info, message) if verbose?
+    end
+
+    private
+
+    # add message to log
+    def add(severity, message)
+      severity = TileUpLogger.sym_to_severity(severity)
+      logger.add(severity, message)
+    end
+
+    # is logger in verbose mode?
+    def verbose?
+      @options.verbose
+    end
+
+    # create or return a logger
+    def logger
+      @logger ||= create_logger
+    end
+
+    # subclasses should overwrite this method, creating what ever
+    # logger they want to
+    def create_logger
+      raise "You should create your own `create_logger` method"
+    end
+
+  end
+
+  # Log to console logger
+  class ConsoleLogger < TileUpLogger
+    private
+    def create_logger
+      @logger = Logger.new(STDOUT)
+      @logger.formatter = Proc.new do |sev, time, prg, msg|
+        "#{time.strftime('%H:%M:%S').to_s} => #{msg}\n"
+      end
+      @logger
+    end
+  end
+end

data/lib/tileup/tiler.rb

@@ -0,0 +1,160 @@
+require 'ostruct'
+require 'RMagick'
+require 'fileutils'
+require 'tileup/logger'
+
+module TileUp
+
+  class Tiler
+
+    def initialize(image_filename, options)
+      default_options = {
+        auto_zoom_levels: nil,
+        tile_width: 256,
+        tile_height: 256,
+        filename_prefix: "map_tile",
+        output_dir: ".",
+        extend_incomplete_tiles: true,
+        verbose: false
+      }
+      @options = OpenStruct.new(default_options.merge(options))
+      @options.tile_width = @options.tile_width.to_i unless !@options.tile_width.respond_to? :to_i
+      @options.tile_height = @options.tile_height.to_i unless !@options.tile_height.respond_to? :to_i
+      @extension = image_filename.split(".").last
+      @filename_prefix = @options.filename_prefix
+      @logger = ConsoleLogger.new(:info, {verbose: @options.verbose})
+
+      begin
+        @image = Magick::Image::read(image_filename).first
+      rescue Magick::ImageMagickError => e
+        @logger.error "Could not open image #{image_filename}."
+        exit
+      end
+
+      if @options.auto_zoom_levels && @options.auto_zoom_levels > 20
+        @logger.warn "Warning: auto zoom levels hard limited to 20."
+        @options.auto_zoom_levels = 20
+      end
+      if @options.auto_zoom_levels && @options.auto_zoom_levels <= 0
+        @options.auto_zoom_levels = nil
+      end
+
+      @logger.info "Opened #{image_filename}, #{@image.columns} x #{@image.rows}"
+
+      # pre-process our inputs to work out what we're supposed to do
+      tasks = []
+
+      if @options.auto_zoom_levels.nil?
+        # if we have no auto zoom request, then
+        # we dont shrink or scale, and save directly to the output
+        # dir.
+        tasks << {
+          output_dir: @options.output_dir, # normal output dir
+          scale: 1.0 # dont scale
+        }
+      else
+        # do have zoom levels, so construct those tasks
+        zoom_name = 20
+        scale = 1.0
+        tasks << {
+          output_dir: File.join(@options.output_dir, zoom_name.to_s),
+          scale: scale
+        }
+        (@options.auto_zoom_levels-1).times do |level|
+          scale = scale / 2.0
+          zoom_name = zoom_name - 1
+          tasks << {
+            output_dir: File.join(@options.output_dir, zoom_name.to_s),
+            scale: scale
+          }
+        end
+      end
+
+      # run through tasks list
+      tasks.each do |task|
+        image = @image
+        image_path = File.join(task[:output_dir], @filename_prefix)
+        if task[:scale] != 1.0
+          # if scale required, scale image
+          begin
+            image = @image.scale(task[:scale])
+          rescue RuntimeError => e
+            message = "Failed to scale image, are you sure the original image "\
+                      "is large enough to scale down this far (#{scale}) with this "\
+                      "tilesize (#{@options.tile_width}x#{@options.tile_height})?"
+            @logger.error message
+            exit
+          end
+        end
+        # make output dir
+        make_path(task[:output_dir])
+        self.make_tiles(image, image_path, @options.tile_width, @options.tile_height)
+        image = nil
+      end
+
+      @logger.info "Finished."
+
+    end
+
+    def make_path(directory_path)
+      FileUtils.mkdir_p directory_path
+    end
+
+    def make_tiles(image, filename_prefix, tile_width, tile_height)
+      # find image width and height
+      # then find out how many tiles we'll get out of
+      # the image, then use that for the xy offset in crop.
+      num_columns = (image.columns/tile_width.to_f).ceil
+      num_rows = (image.rows/tile_height.to_f).ceil
+      x,y,column,row = 0,0,0,0
+      crops = []
+
+      @logger.info "Tiling image into columns: #{num_columns}, rows: #{num_rows}"
+
+      while true
+        x = column * tile_width
+        y = row * tile_height
+        crops << {
+          x: x,
+          y: y,
+          row: row,
+          column: column
+        }
+        column = column + 1
+        if column >= num_columns
+          column = 0
+          row = row + 1
+        end
+        if row >= num_rows
+          break
+        end
+      end
+
+      crops.each do |c|
+        @logger.verbose "Crop: x: #{c[:x]}, y: #{c[:y]}, w: #{tile_width}, h: #{tile_height}"
+        ci = image.crop(c[:x], c[:y], tile_width, tile_height, true);
+
+        # unless told to do otherwise, extend tiles in the last row and column
+        # if they do not fill an entire tile width and height.
+        
+        is_edge = (c[:row] == num_rows - 1 || c[:column] == num_columns - 1)
+        needs_extension = ci.rows != tile_height || ci.columns != tile_width
+        if @options.extend_incomplete_tiles && is_edge && needs_extension
+          # defaults to white background color, but transparent is probably 
+          # a better default for our purposes.
+          ci.background_color = "none"
+          # fill to width height, start from top left corner.
+          ci = ci.extent(tile_width, tile_height, 0, 0)
+        end
+
+        @logger.verbose "Saving tile: #{c[:row]}, #{c[:column]}..."
+        ci.write("#{filename_prefix}_#{c[:column]}_#{c[:row]}.#{@extension}")
+        @logger.verbose "Saving tile: #{c[:row]}, #{c[:column]}... saved"
+
+        ci = nil
+      end
+    end
+
+  end
+
+end

data/lib/tileup/version.rb

@@ -0,0 +1,3 @@
+module TileUp
+  VERSION = '0.1.4'
+end

data/tileup.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tileup/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'tileup'
+  spec.version     = TileUp::VERSION
+  spec.date        = Date.today.to_s
+  spec.summary     = "Turn an image into an X,Y tile set for use with JS mapping libraries"
+  spec.description = spec.summary
+  spec.authors     = ["Oliver Marriott"]
+  spec.email       = 'hello@omarriott.com'
+  spec.homepage    = 'http://github.com/rktjmp/tileup'
+  spec.license     = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  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.add_runtime_dependency "rmagick", ["~> 2.13.2"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tileup
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -27,6 +27,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Turn an image into an X,Y tile set for use with JS mapping libraries
 email: hello@omarriott.com
 executables:
@@ -34,10 +66,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/tileup.rb
+- CHANGES.md
+- LICENCE.txt
+- README.md
 - bin/tileup
+- lib/tileup.rb
+- lib/tileup/logger.rb
+- lib/tileup/tiler.rb
+- lib/tileup/version.rb
+- tileup.gemspec
 homepage: http://github.com/rktjmp/tileup
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -61,3 +101,4 @@ signing_key:
 specification_version: 3
 summary: Turn an image into an X,Y tile set for use with JS mapping libraries
 test_files: []
+has_rdoc: