columbus3 0.4.0 → 0.5.0

data/lib/columbus3.rb

@@ -1,7 +1,12 @@
-require "columbus3/version"
-require "columbus3/metadata/query_parser.tab"
-require "columbus3/metadata/sidecar"
-require "columbus3/v900track/v900track"
-require "columbus3/v900track/v900waypoint"
-require "columbus3/renderer/leaflet_renderer"
-require "columbus3/renderer/flot_renderer"
+require 'columbus3/metadata/query_parser.tab'
+require 'columbus3/metadata/sidecar'
+require 'columbus3/v900track/gpx2v900'
+require 'columbus3/v900track/v900track'
+require 'columbus3/v900track/v900waypoint'
+require 'columbus3/renderer/leaflet_renderer'
+require 'columbus3/renderer/flot_renderer'
+
+require 'columbus3/cli/command_syntax'
+require 'columbus3/cli/command_semantics'
+
+require 'columbus3/version'

data/lib/columbus3/cli/command_semantics.rb

@@ -0,0 +1,352 @@
+require 'columbus3/version'
+require 'find'
+require 'readline'
+
+module Columbus3
+  module CommandSemantics
+    APPNAME = 'columbus3'
+    VERSION = Columbus3::VERSION
+    MAN = <<EOS
+NAME
+  #{APPNAME} -- manage Columbus V900 and V990 tracks from the command line
+
+SYNOPSYS
+  #{APPNAME} [-h|-v]
+  #{APPNAME} command [options] [args]
+
+DESCRIPTION
+
+columbus3 manages Columbus V900 and V990 tracks from the command line,
+allowing a user to associate a sidecar file with the main information
+about a track, searching tracks (through sidecar files), displaying
+tracks on a map. 
+
+EXAMPLES
+
+    #{APPNAME} -h                            # get syntax of each command
+    columbus3 process 11010101.CSV           # generate a sidecar file
+    columbus3 search 'location ~ "USA"'      # get tracks in the USA
+    columbus3 show 11010101.CSV 11010201.CSV # show tracks on a map (_show.html)
+    columbus3 graph 11010101.CSV             # show info about a track (_graph.html)
+
+if you do not want to type columbus3 each type, you can invoke a console:
+
+    columbus3 console
+    columbus3:000> process 11010101.CSV
+    columbus3:001> show 11010101.CSV
+    columbus3:002>
+
+columbus3 also has a function to convert a GPX into a bunch of CSV
+files (which you can then process with the other commands), with some
+limitations (see below).
+
+The command is useful if you are using different loggers for generating your
+tracks:
+
+    columbus3 convert file.gpx
+
+will generate
+
+     file-1.csv
+     file-2.csv
+     ...
+
+one per track in the GPX file.
+
+**CSV export limitations** The Columbus V900 format has fields with fixed width,
+and uses ^@ as a filler.  The CSV file generated by the convert command generates fields
+of variable width (standard CSV files, I dare say).  The heading field is not computed
+and the field is filled with -1.
+
+Piping commands. You can pipe the output of a search command to show, using
+the following syntax:
+
+  columbus3 search 'location ~ "USA"' --fields path | columbus3 show --sidecar
+
+The option --fields shows only the pathname of the files found; the option
+--sidecar removes the .yaml extension from the list of files found.
+
+SEARCH SYNTAX
+
+  >>> DON'T FORGET TO EMBED YOUR QUERY IN SINGLE QUOTES <<<
+
+Terms you can search for:
+
+  location, start_location, end_location
+  date, start_date, end_date
+  year
+  duration
+  max_speed
+  min_height
+  max_height
+
+Numerical operators:  
+  <, <=, ==, >=, >
+
+String operators (locations):
+  ~ (contains), == (is exactly)
+
+Complex Terms:
+  Use "and" and "or" to build complex queries
+
+Examples of simple searches
+  'location ~ "USA"'     any track whose start or end location contains USA
+  'date > 2015-02-14'    any track whose start or end date is after Feb 14, 2015
+  'year == 2015'         any track whose start or end date is in 2015
+  'duration <= 01:02:03' any track with a duration of less than 1h, 2min, and 3secs
+  'max_speed > 120'      any track with a max speed greater than 120 km/h
+  'min_height == 10'     any track with a min height lower than 10 meters
+
+Examples of complex searches
+  'location ~ "USA" and start_date >= 2015-01-01' tracks in the USA after or on Jan 1, 2015
+  'start_location ~ "Trenton" and end_location ~ "New York"'  trips from Trenton to New York
+
+List of supported fields in output
+  path           -> relative path of the CSV file
+  filename       -> basename of the CSV file
+  start_location -> start location
+  end_location   -> end location
+  start_date     -> start date (and time)
+  end_date       -> end date (and time)
+  duration       -> duration in seconds
+  min_speed      -> minimum speed in km/h
+  max_speed      -> maximum speed in km/h
+  min_height     -> minimum height in meters
+  max_height     -> maximum height in meters
+
+VERSION
+  This is version #{VERSION}
+
+LICENSE
+  MIT
+
+  Columbus3 uses leaflet, leafleft-providers, flot, and jquery.  They
+  are distributed under a different license: see their websites for more
+  details (or have a look at the license file shipped with the Gem)
+
+SEE ALSO
+  If you are looking for a full graphical client, you might want to
+  download Columbus from http://www.minimalbit.com
+
+  https://github.com/avillafiorita/columbus3
+EOS
+
+    #
+    # Main App Starts Here!
+    #
+    def self.version opts = nil, argv = []
+      puts "#{APPNAME} version #{VERSION}"
+    end
+
+    def self.man opts = nil, argv = []
+      puts MAN
+    end
+
+    def self.help opts = nil, argv = []
+      all_commands = CommandSyntax.commands
+      
+      if argv != []
+        argv.map { |x| puts all_commands[x.to_sym][0] }
+      else
+        puts "#{APPNAME} command [options] [args]"
+        puts ""
+        puts "Available commands:"
+        puts ""
+        all_commands.keys.each do |key|
+          puts "  " + all_commands[key][0].banner
+        end
+      end
+    end
+
+    def self.console opts, argv = []
+      all_commands = CommandSyntax.commands
+      all_commands.delete(:console)
+      
+      i = 0
+      while true
+        string = Readline.readline("#{APPNAME}:%03d> " % i, true)
+        string.gsub!(/^#{APPNAME} /, "") # as a courtesy, remove any leading appname string
+        if string == "exit" or string == "quit" or string == "." then
+          exit 0
+        end
+        reps all_commands, string.split(' ')
+        i = i + 1
+      end
+    end
+
+
+    #
+    # APP SPECIFIC COMMANDS
+    #
+    def self.process opts, argv
+      force = opts[:force]
+      
+      argv.each do |arg|
+        track = V900Track.new filename: arg
+        sidecar = Columbus3::Sidecar.new arg
+        if sidecar.exist? and not force
+          puts "Sidecar file for #{track.filename} already exists. Use --force if you want to overwrite it."
+        else
+          printf "Processing %s ...", track.filename
+          sidecar.metadata = track.metadata
+          sidecar.save
+          puts " done!"
+        end
+      end
+    end
+
+    def self.search opts, argv
+      debug = opts[:debug]
+      directory = opts[:dir] || "."
+      recurse = opts[:recurse]
+      fields = opts[:fields].any? ? opts[:fields].map { |x| x.to_sym } : [:path, :filename, :start_location, :end_location, :start_date, :end_date, :duration, :min_speed, :max_speed, :min_height, :max_height] 
+
+      if recurse then
+        files = Find.find(directory).select { |e| File.extname(e) == ".yaml" }
+      else
+        files = Dir.glob(File.join(directory, "*.yaml"))
+      end
+      query = QueryParser.new.parse(argv.join(" "))
+
+      if debug then
+        puts "Searched files: #{files.join(",")}"
+        puts "Searched files count: #{files.size}"
+        puts "Processed query: #{query}"
+        puts "Fields: #{fields}"
+      else
+        sidecar_search = Columbus3::SidecarSearch.new
+        sidecar_search.load files
+        match = sidecar_search.search query
+        match.each do |m|
+          string = fields.map { |x| "#{m[x]}" }.join("\t")
+          printf "%s\n", string
+        end
+      end
+    end
+
+    def self.show opts, args
+      filename = opts[:filename] || "_show.html"
+      force = opts[:force]
+      sidecar = opts[:sidecar]
+
+      # build the argument list, which are either provided from the command line
+      # or, if args, is empty, from the standard input
+      files = args == [] ? STDIN.read.split("\n") : args
+
+      # remove .yaml from files, if required to do so
+      pruned_args = sidecar ? files.map { |x| x.gsub(/\.(YAML|yaml)$/, '') } : files
+
+      pruned_args.each do |arg|
+        # generate the js file(s), if not already existing or forced to
+        # do so by the force directive
+        if force or not File.exist? arg
+          printf "Creating json file for #{arg} ..."
+          complete = true
+        else
+          puts "Json file for #{arg} already exists (--force to force updating)"
+          complete = false
+        end
+        Columbus3::LeafletRenderer::to_leaflet arg, force
+        puts "done!" if complete
+      end
+      if force or not File.exist? filename
+        printf "Creating #{filename} ..."
+        complete = true
+      else
+        puts "#{filename} already exists (--force to force updating)"
+        complete = false
+      end
+      Columbus3::LeafletRenderer::show(filename, pruned_args) if args
+      puts "done!" if complete
+      puts "You might now want to open #{filename}."
+    end
+
+    def self.graph opts, args
+      filename = opts[:filename] || "_graph.html"
+      force = opts[:force]
+
+      input_filename = args[0]
+      if input_filename
+        if force or not File.exist? input_filename
+          printf "Creating javascript graph data for #{input_filename} ..."
+          complete = true
+        else
+          puts "Javascript graph data for #{input_filename} already exists (--force to force updating)"
+          complete = false
+        end
+        Columbus3::FlotRenderer::to_graph_data input_filename, force
+        puts "done!" if complete
+
+        if force or not File.exist? arg
+          printf "Creating #{filename} ..."
+          complete = true
+        else
+          puts "#{filename} already exists (--force to force updating)"
+          complete = false
+        end
+        Columbus3::FlotRenderer::show filename, input_filename
+        puts "done!" if complete
+        puts "You might now want to open #{filename}."
+      else
+        puts "Error: please specify a track file"
+      end
+    end
+
+    def self.convert opts, args
+      force = opts[:force]
+
+      input_filename = args[0]
+
+      if input_filename
+        tracks = GPX2V900::gpx2v900 input_filename
+        tracks.each do |track|
+          if File.exist?(track.filename) and not force
+            puts "Error: #{track.filename} already exists (--force to force updating)"
+          else
+            track.save
+            puts "Track #{track.filename} created"
+          end
+        end
+      else
+        puts "Error: please specify a track file"
+      end
+    end
+
+    def self.split opts, args
+    end
+
+    def self.export opts, args
+    end
+    
+    # read-eval-print step
+    def self.reps all_commands, argv
+      if argv == []
+        CommandSemantics.help
+        exit 0
+      else
+        command = argv[0]
+        syntax_and_semantics = all_commands[command.to_sym]
+        if syntax_and_semantics
+          opts = syntax_and_semantics[0]
+          function = syntax_and_semantics[1]
+          
+          begin
+            parser = Slop::Parser.new(opts)
+
+            result = parser.parse(argv[1..-1])
+            options = result.to_hash
+            arguments = result.arguments
+
+            eval "CommandSemantics::#{function}(options, arguments)"
+          rescue Slop::Error => e
+            puts "#{APPNAME}: #{e}"
+          rescue Exception => e
+            puts e
+          end
+        else
+          puts "#{APPNAME}: '#{command}' is not a valid command. See '#{APPNAME} help'"
+        end
+      end
+    end
+  end
+end

data/lib/columbus3/cli/command_syntax.rb

@@ -0,0 +1,103 @@
+require 'slop'
+
+module Columbus3
+  module CommandSyntax
+    # return a hash with all the commands and their options 
+    def self.commands
+      h = Hash.new
+      self.methods.each do |method|
+        if method.to_s.include?("_opts") then
+          h = h.merge(eval(method.to_s))
+        end
+      end
+      return h
+    end
+
+    private
+
+    def self.version_opts
+      opts = Slop::Options.new
+      opts.banner = "version -- print version information"
+      return { :version => [opts, :version] }
+    end
+
+    def self.console_opts
+      opts = Slop::Options.new
+      opts.banner = "console [options] -- Enter the console"
+      opts.string "-f", "--filename", "Password file to encrypt. Write to <file>.enc"
+      return { :console => [opts, :console] } 
+    end
+
+    def self.man_opts
+      opts = Slop::Options.new
+      opts.banner = "man -- print a manual page"
+      return { :man => [opts, :man] }
+    end
+
+    def self.help_opts
+      opts = Slop::Options.new
+      opts.banner = "help [command] -- print usage string"
+      return { :help => [opts, :help] }
+    end
+
+    def self.process_opts
+      opts = Slop::Options.new
+      opts.banner = "process [track ...] -- generate sidecar files for given tracks"
+      opts.boolean "-f", "--force", "Overwrite existing sidecar file"
+      
+      return { process: [opts, :process] }
+    end    
+
+    def self.search_opts
+      opts = Slop::Options.new
+      opts.banner = "search [-r] [--dir directory] [--fields fields] query -- search for tracks matching query"
+
+      opts.boolean "--debug", "Show how the query is processed"
+      opts.boolean "-r", "--recurse", "Recurse in subdirectories"
+      opts.string "-d", "--dir", "Directory to search"
+      opts.array "--fields", "Comma separated list of fields to print"
+
+      return { search: [opts, :search] }
+    end
+
+    def self.show_opts
+      opts = Slop::Options.new
+      opts.banner = "show [--filename filename] [--force] [track ...] -- view one or more tracks (use stdin if no track)"
+
+      opts.string "-f", "--filename=", "Output filename (default is _show.html)"
+      opts.boolean "--force", "Force rewriting of the js file, even if it already exists"
+      opts.boolean "--sidecar", "Pass sidecar files rather than CSV files (use it when piping searches)"
+
+      return { show: [opts, :show] }
+    end
+
+    def self.graph_opts
+      opts = Slop::Options.new
+      opts.banner = "graph [--filename filename] [--force] track -- plot speed and height profile of track"
+
+      opts.boolean "--force", "Force rewriting of the js file, even if it already exists"
+
+      return { graph: [opts, :graph] }
+    end
+
+    def self.convert_opts
+      opts = Slop::Options.new
+      opts.banner = "convert track -- convert a GPX into a set of CSV files"
+      opts.boolean "--force", "Force rewriting of the csv files, even if it already exists"
+
+      return { convert: [opts, :convert] }
+    end
+
+
+    # def self.split_opts
+    #   opts = Slop::Options.new
+    #   opts.banner "split [--help] [--point N] track -- split a track"
+    #   opts.integer "--point", "Split at point N"
+
+    #   return { split: [opts, :split] }
+    # end
+
+    # def self.export_opts
+    # end
+  end
+end