pr2gpx 0.1.1 → 0.1.2

data/lib/pr2gpx.rb

@@ -1,13 +1,15 @@
-require 'nokogiri'
-require 'nokogiri/xml'
-require 'pr2gpx/parser'
 require 'pr2gpx/options'
+require 'pr2gpx/parser'
+require 'pr2gpx/gpx'
 
+# Creates an Enumerable with one entry for every file in search_path,
+# containing the files content.
 def enumerate_files search_path
   Enumerator.new do |e|
     Dir
       .glob(search_path)
       .each do |filename|
+        $stderr.puts "Reading #{filename}" if $verbose
         File.open filename do |file|
           e.yield file.read()
       end
@@ -15,6 +17,13 @@ def enumerate_files search_path
   end
 end
 
+# Runs each element of content_enum through ReportParser::parse,
+# receiving an Enumerable of PositionReport. If the report passes
+# through the filter, it is added to the hash of the station, if
+# no other report with the same date exists.
+#
+# Those hashes are stored in another hash, indexed by callsign,
+# which gets returned.
 def load_data content_enum, filter
   reportParser = ReportParser.new
   stations = Hash.new
@@ -24,16 +33,25 @@ def load_data content_enum, filter
     if reports
       reports.each do |report|
         if filter.include? report
+          $stderr.print 'o' if $verbose
           stations[report.callsign] = Hash.new unless stations.has_key? report.callsign
           stations[report.callsign][report.date] = report unless stations[report.callsign].has_key? report.date
+        else
+          $stderr.print '.' if $verbose
         end
       end
     end
+    $stderr.puts if $verbose
   end
 
   stations
 end
 
+# Converts the reports the entries of the stations-hash, which are
+# hashes indexed by date, into arrays sorted by date.
+#
+# The parameter last can be used to limit the reports to the N
+# most recent ones.
 def filter_data! stations, last
   stations.each do |callsign, reports|
     stations[callsign] = reports.values
@@ -46,52 +64,16 @@ def filter_data! stations, last
   end
 end
 
-def build_gpx stations, create_trk, create_wpt
-  builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
-    xml.gpx(xmlns: 'http://www.topografix.com/GPX/1/1') do
-      if create_trk
-        stations.each do |callsign, reports|
-          xml.trk do
-            xml.name callsign
-            xml.trkseg do
-              reports.each do |report|
-                xml.send('trkpt', lat: report.position.latitude, lon: report.position.longitude) do
-                  xml.name report.comment
-                  xml.time report.date.strftime('%FT%TZ')
-                end
-              end
-            end
-          end
-        end
-      end
-      if create_wpt
-        stations.each do |callsign, reports|
-          last = reports.last
-          reports.each do |report|
-            xml.send('wpt', lat: report.position.latitude, lon: report.position.longitude) do
-              xml.name report.callsign
-              xml.desc report.comment
-              xml.time report.date.strftime('%FT%TZ')
-              xml.type 'WPT'
-              xml.sym report == last ? 'triangle' : 'circle'
-            end
-          end
-        end
-      end
-    end
-  end
-  builder.to_xml
-end
-
-def write_gpx filename, gpx
-  File.open filename, 'w:UTF-8' do |file|
-    file.write gpx
-  end
-end
-
 options = parse_options ARGV
 exit if not options
 
+errors = validate_options(options)
+if errors
+  $stderr.puts errors
+  exit
+end
+
+# normalize path separators
 options[:input].gsub!('\\', '/')
 options[:output].gsub!('\\', '/') if options[:output]
 
@@ -103,7 +85,7 @@ filter = ReportFilter.new options[:callsign]
 stations = load_data(enumerate_files(search_path), filter)
 filter_data! stations, options[:last]
 
-if options[:split]
+if options[:split] # create one document for each station
   stations.each do |callsign, reports|
     gpx = build_gpx({ callsign => reports }, options[:create_trk], options[:create_wpt])
 
@@ -113,7 +95,7 @@ if options[:split]
       puts gpx
     end
   end
-else
+else # create one document for all data
   gpx = build_gpx(stations, options[:create_trk], options[:create_wpt])
 
   if options[:output] then

data/lib/pr2gpx/gpx.rb

@@ -0,0 +1,53 @@
+require 'nokogiri'
+require 'nokogiri/xml'
+
+# Creates the GPX document from the stations hash.
+#
+# If create_trk is true, one trk per station gets created.
+#
+# If create_wpt is true, one waypoint for every report of every
+# station gets created.
+def build_gpx stations, create_trk, create_wpt
+  builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+    xml.gpx(xmlns: 'http://www.topografix.com/GPX/1/1') do
+      if create_trk
+        stations.each do |callsign, reports|
+          xml.trk do
+            xml.name callsign
+            xml.trkseg do
+              reports.each do |report|
+                xml.send('trkpt', lat: report.position.latitude, lon: report.position.longitude) do
+                  xml.name report.comment
+                  xml.time report.date.strftime('%FT%TZ')
+                end
+              end
+            end
+          end
+        end
+      end
+      if create_wpt
+        stations.each do |callsign, reports|
+          last = reports.last
+          reports.each do |report|
+            xml.send('wpt', lat: report.position.latitude, lon: report.position.longitude) do
+              xml.name report.callsign
+              xml.desc report.comment
+              xml.time report.date.strftime('%FT%TZ')
+              xml.type 'WPT'
+              xml.sym report == last ? 'triangle' : 'circle'
+            end
+          end
+        end
+      end
+    end
+  end
+  builder.to_xml
+end
+
+# Writes the gpx document with UTF-8 encoding to filename.
+def write_gpx filename, gpx
+  $stderr.puts "Writing #{filename}" if $verbose
+  File.open filename, 'w:UTF-8' do |file|
+    file.write gpx
+  end
+end

data/lib/pr2gpx/options.rb

@@ -1,5 +1,6 @@
 require 'optparse'
 
+# If options are valid, returns a hash of options, otherwise nil.
 def parse_options argv
   options = {}
   mandatory = [:input]
@@ -95,4 +96,31 @@ def parse_options argv
   end
 
   options
+end
+
+# If errors are encountered, returns an array of error messages, otherwise nil.
+def validate_options options
+  errors = []
+
+  if not File.exists?(options[:input])
+    errors << 'Path specified in --input does not exist.'
+  elsif not File.directory?(options[:input])
+    errors << 'Path specified in --input is not a directory.'
+  end
+
+  if options[:split]
+    if not File.exists?(options[:output])
+      errors << 'Path specified in --output does not exist.'
+    elsif not File.directory?(options[:output])
+      errors << 'Path specified in --output is not a directory.'
+    end
+  else
+    if not File.exists?(File.dirname(options[:output]))
+      errors << 'Path specified in --output does not exist.'
+    elsif File.directory?(options[:output])
+      errors << 'Path specified in --output is a directory.'
+    end
+  end
+
+  errors if errors.length > 0
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pr2gpx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -37,6 +37,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/pr2gpx/gpx.rb
 - lib/pr2gpx/options.rb
 - lib/pr2gpx/parser.rb
 - lib/pr2gpx.rb