mapsnatcher 0.1.2 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15abc2e7d72ccee7fbc1d86065724bde5ac5eac4bd3312638e4dade03ea4bed2
-  data.tar.gz: 9aaa5ef18519acaeae3c08f1149cab60ea39a86258b1307b2b5f3d109a191200
+  metadata.gz: 569c978c8a3045d6d9b2203105cfaad3178d58dec9781094a86cd7b11b39d1d1
+  data.tar.gz: c587c7ef882865ca5ae803a3ed631286b70c4fa356a022a2b25f293c7d0c1e85
 SHA512:
-  metadata.gz: 54d9e64a64d4fbcd84e30cad8ebcb379fe93cc8062e02f2fb030f377c8f617bead2a5c781b49f3fe4cd8bd9287c872ecb30605099ab5e92abab01a0d1fa64176
-  data.tar.gz: ca3d48e227460f0cbd8628f4b0a2f24268313dd2508452a4e0d266c2a4e0d937da22c069eee9da1f0c7f56b5302cc477d93c9db13de147501a4001d92c8f2090
+  metadata.gz: 290990c16ada0ff0482988e41b980decfa448e8f945ffea7e7e3fc741969d60ae2680cf5ccc01135f95fa12be7deab1579b7e0154cbde7e4fb02d419624feff0
+  data.tar.gz: a2eba1fa908f53eb2e9fe5238f09cfa87ac792d23e92b16808db75c8872728a46ea8e4a441b62ea24123872c8e676ea20a33cea51ae3ae7821e45f006a74815f

data/README.md

@@ -27,16 +27,27 @@ policies in `/etc/ImageMagick-6/policy.xml`.
 
 Usage is as follows:
 
-```mapsnatcher "http://mapwebsite.com/0/XXX/YYY.png"```
+```mapsnatcher http://mapwebsite.com/0/xxx/yyy.png```
 
 Place `XXX` and `YYY` (case-insensitive) where the respective coordinate
 numbers would be in the URL. You will then be prompted to enter the X and Y
 boundaries that you would like to capture.
 
-```mapsnatcher -b "http://mapwebsite.com/0/XXX/YYY.png"```
+```mapsnatcher -b http://mapwebsite.com/0/xxx/yyy.png```
 
 If you are unsure of the boundaries and would like to capture the entire map,
 add the `-b` argument and you will only need to enter one valid coordinate;
 `mapsnatcher` will do the rest.
 
 If you would like to save the tiles, add the `-s` argument.
+
+Coordinates can be passed into `mapsnatcher` as arguments:
+
+```mapsnatcher http://mapwebsite.com/0/xxx/yyy.png -x 200-300 -y 200-250```
+```mapsnatcher http://mapwebsite.com/0/xxx/yyy.png -b -x 200 -y 200```
+
+And the output file may be specified with `-o`:
+
+```mapsnatcher http://mapwebsite.com/0/xxx/yyy.png -o map.jpg```
+
+If coordinates and output are not specified, you will be prompted for them.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2

data/bin/mapsnatcher

@@ -1,14 +1,66 @@
 #!/usr/bin/env ruby
 
+require "optimist"
 require "fileutils"
 require "open-uri"
 require "net/http"
+require "yaml"
 require "rmagick"
 include Magick
 
 TEMP_DIR = "./.ms.tmp"
+COORDS_FILE = "#{TEMP_DIR}/coords"
 TILES_DIR = "./tiles"
 
+opts = Optimist::options do
+  version "mapsnatcher #{File.read(File.expand_path("../../VERSION", __FILE__)).strip}"
+  banner self.version
+  banner "Usage:"
+  banner "  mapsnatcher [options] http://mapwebsite.com/0/xxx/yyy.png"
+  banner "  Place XXX and YYY in place of where the respective coordinate numbers would be"
+  banner "  in the URL. The first number is typically the zoom level, which is constant."
+  banner "\n  Inputs may be given through the CLI, or with flags:"
+  banner "  mapsnatcher <url> -x 0-500 -y 0-300"
+  banner "  mapsnatcher -b <url> -x 200 -y 200"
+  banner "\nOptions:"
+  opt :bounds, "find outer boundaries of the map automatically"
+  opt :save, "save tiles to a directory ./tiles/"
+  opt :version, "display version number"
+  opt :help, "display this message"
+  banner "I/O:"
+  opt :x, "x-coordinate range, (or x-coordinate if using -b)", type: :string
+  opt :y, "y-coordinate range, (or y-coordinate if using -b)", type: :string
+  opt :output, "output file name & location", type: :string
+  educate_on_error
+end
+
+x_range = y_range = nil
+xy_in = opts.values_at(:x, :y)
+using_xy_in = opts[:x] or opts[:y] # or, if missing one it'll throw this:
+if using_xy_in
+  if xy_in.map { |o| o =~ /\A\d+#{/-\d+/ unless opts[:bounds]}\z/ }.include? nil
+    puts "Error: Invalid coordinate input."
+    puts
+    Optimist::educate
+  end
+
+  # Parse X/Y input into something we can use later
+  if opts[:bounds]
+    xy_in.map! &:to_i
+  else
+    x_range, y_range = xy_in.map { |r| Range.new *r.split("-").map(&:to_i) }
+  end
+end
+
+Optimist::educate if ARGV.empty?
+if ARGV.first !~ /\A#{URI::regexp(["http", "https"])}\z/
+  puts "Error: Invalid URL."
+  puts
+  Optimist::educate
+end
+
+url = ARGV.first
+
 # False if URL returns a 200
 #
 # @param url [String] the url to be checked
@@ -27,42 +79,27 @@ def build_url(url, x, y)
   url.gsub(/xxx/i, x.to_s).gsub(/yyy/i, y.to_s)
 end
 
-if ARGV.empty? or %w[-h --help].include? ARGV.first
-  puts 'Usage: mapsnatcher "http://mapwebsite.com/0/XXX/YYY.png"'
-  puts
-  puts "       Place XXX and YYY in place of where the respective coordinate numbers would be"
-  puts "       in the URL. The first number is typically the zoom level, which is constant."
-  puts
-  puts "  [-b] find outer bounds of map automatically"
-  puts "  [-s] save tiles to a directory ./tiles/"
-  exit 0
-end
-
-if %w[-v --version].include? ARGV.first
-  puts "mapsnatcher #{File.read(File.expand_path("../../VERSION", __FILE__)).strip}"
-  exit 0
-end
-
 # Load/create temp directory
-if !File.exists? TEMP_DIR
+using_saved_xy = false
+if !File.exist? TEMP_DIR
   Dir.mkdir TEMP_DIR
 elsif !Dir.empty? TEMP_DIR
   print "It looks like mapsnatcher didn't close properly. Use backed up files? [Y/n] "
-  FileUtils.rm_f(Dir.glob("#{TEMP_DIR}/*")) if STDIN.gets.chomp =~ /n.*/i
+  if STDIN.gets.chomp =~ /n.*/i
+    FileUtils.rm_f(Dir.glob("#{TEMP_DIR}/*"))
+  elsif [x_range, y_range].include?(nil) and File.exist? COORDS_FILE
+    print "Use coordinate range from last time? [Y/n] "
+    if STDIN.gets.chomp !~ /n.*/i
+      x_range, y_range = YAML.load_file(COORDS_FILE, permitted_classes: [Range])
+      using_saved_xy = true
+    end
+  end
   puts
 end
 
-save_tiles = false
-if (args = ARGV).include? "-s"
-  args -= ["-s"]
-  save_tiles = true
-end
-
-if args.include? "-b"
+if opts[:bounds]
   # Automatic boundary mode
 
-  url = (args - ["-b"]).first
-
   # CLI input function
   #
   # @return [Array] user input coordinates
@@ -72,47 +109,44 @@ if args.include? "-b"
     print "Enter valid Y coordinate [0]: "
     y_in = STDIN.gets.chomp.to_i
 
-    print "\nLoading...\r"
+    print "\nLoading..."
 
     [x_in, y_in]
   end
 
-  valid_x, valid_y = get_coords
+  valid_x, valid_y = using_xy_in ? xy_in : get_coords
 
+  print "\rLoading..."
   while invalid? build_url(url, valid_x, valid_y)
-    puts "Invalid coordinate! Try again."
+    puts "\rInvalid coordinate! Try again."
     puts
     valid_x, valid_y = get_coords
   end
 
   x_low = x_high = valid_x
   until invalid? build_url(url, x_low - 1, valid_y)
-    print "Checking X value: #{x_low}     \r"
+    print "\r\e[KChecking X value: #{x_low}\r"
     x_low -= 1
   end
   until invalid? build_url(url, x_high + 1, valid_y)
-    print "Checking X value: #{x_high}     \r"
+    print "\r\e[KChecking X value: #{x_high}\r"
     x_high += 1
   end
 
   y_low = y_high = valid_y
   until invalid? build_url(url, valid_x, y_low - 1)
-    print "Checking Y value: #{y_low}     \r"
+    print "\r\e[KChecking Y value: #{y_low}\r"
     y_low -= 1
   end
   until invalid? build_url(url, valid_x, y_high + 1)
-    print "Checking Y value: #{y_high}     \r"
+    print "\r\e[KChecking Y value: #{y_high}\r"
     y_high += 1
   end
 
-  puts "Found Coordinate Range: [#{x_low}-#{x_high}], [#{y_low}-#{y_high}]"
-
   x_range, y_range = (x_low..x_high), (y_low..y_high)
 else
   # User input coordinate mode
 
-  url = args.first
-
   # CLI input function
   #
   # @return [Array] user input coordinate ranges
@@ -127,29 +161,35 @@ else
     print "End of Y range: "
     y_range_in = (y_start..STDIN.gets.chomp.to_i)
 
-    print "\nLoading...\r"
+    print "\nLoading..."
 
     [x_range_in, y_range_in]
   end
 
-  x_range, y_range = get_coords
+  x_range, y_range = get_coords unless using_xy_in
 
+  print "\rLoading..."
   while invalid?(build_url url, x_range.first, y_range.first) or
         invalid?(build_url url, x_range.first, y_range.last)  or
         invalid?(build_url url, x_range.last, y_range.first)  or
         invalid?(build_url url, x_range.last, y_range.last)
-    puts "\nError: Boundaries incorrect."
+    puts "\rError: Boundaries incorrect."
     puts "Use `mapsnatcher -b` for help finding the boundaries of the image."
     puts
     x_range, y_range = get_coords
   end
 end
 
+puts "\rUsing #{'Saved ' if using_saved_xy}Coordinate Range: [#{x_range.first}-#{x_range.last}], [#{y_range.first}-#{y_range.last}]"
+
+File.open(COORDS_FILE, "w") { |f| f.write [x_range, y_range].to_yaml }
+
 # Use the tile at 0, 0 to calculate final image size
+print "\rChecking dimensions..."
 sample = Image.from_blob(URI.open(build_url url, x_range.first, y_range.first).read).first
 final_size = {x: sample.columns * x_range.size, y: sample.rows * y_range.size}
 format = sample.format
-puts "Image found, #{format} size #{final_size[:x]}x#{final_size[:y]}"
+puts "\rImage found, #{format} size #{final_size[:x]}x#{final_size[:y]}"
 puts
 
 dl_counter = 0
@@ -158,11 +198,12 @@ dl_total = x_range.size * y_range.size
 stitch = ImageList.new
 y_range.each do |y|
   row = ImageList.new
+
   x_range.each do |x|
     print "Downloading... [#{dl_counter += 1}/#{dl_total}]\r"
 
-    temp = "#{TEMP_DIR}/#{x}_#{y}.#{format.downcase}"
-    if File.exists? temp
+    temp = "#{TEMP_DIR}/#{x}_#{y}.#{format == "JPEG" ? "jpg" : format.downcase}"
+    if File.exist? temp
       # Load the backup file
       img = Image.read(temp).first
     else
@@ -177,6 +218,8 @@ y_range.each do |y|
   stitch.push row.append(false)
 end
 
+thread = Thread.new { stitch = stitch.append(true) }
+
 puts "\nDone!"
 
 # Warnings for incompatible formats for large image sizes
@@ -193,15 +236,20 @@ elsif final_size.values.max > WEBP_MAX
   puts
 end
 
-print "Enter file name for map: "
-filename = STDIN.gets.chomp
-print "Saving, this may take a minute..."
-stitch.append(true).write filename
-puts "\nImage written to: #{filename}"
+unless filename = opts[:output]
+  print "Enter file name for map: "
+  filename = STDIN.gets.chomp
+end
 
-if save_tiles
-  File.rename TEMP_DIR, TILES_DIR
-  puts "Tiles saved to: #{TILES_DIR.match /\w+/}/"
+print "Saving, this may take a minute..."
+thread.join # Wait for ImageMagick thread to finish joining rows
+stitch.write filename
+puts "\n\nImage written to: #{filename}"
+
+if opts[:save]
+  FileUtils.rm COORDS_FILE
+  FileUtils.mv TEMP_DIR, TILES_DIR
+  puts "Tiles saved to: #{TILES_DIR.match(/\w+/)}/"
 else
   FileUtils.rm_rf TEMP_DIR
 end

data/mapsnatcher.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
 
   gem.license = "MIT"
 
-  gem.summary = "Downloads and combines tiles from QGIS maps into an image."
+  gem.summary = "QGIS map downloading and tiling."
   gem.description = "Downloads and combines tiles from QGIS maps into an image."
 
   gem.bindir = "bin"
@@ -22,4 +22,5 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = "~> 3.0"
 
   gem.add_dependency "rmagick", "~> 5.1"
+  gem.add_dependency "optimist", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mapsnatcher
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: '0.2'
 platform: ruby
 authors:
 - Vinny Diehl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Downloads and combines tiles from QGIS maps into an image.
 email: vinny.diehl@gmail.com
 executables:
@@ -58,5 +72,5 @@ requirements: []
 rubygems_version: 3.3.5
 signing_key:
 specification_version: 4
-summary: Downloads and combines tiles from QGIS maps into an image.
+summary: QGIS map downloading and tiling.
 test_files: []