gooby 1.1.0 → 1.2.0

data/lib/gooby_google_map_generator.rb

@@ -0,0 +1,385 @@
+=begin
+
+Gooby = Google APIs + Ruby
+Gooby - Copyright 2007 by Chris Joakim.
+Gooby is available under GNU General Public License (GPL) license.
+
+=end
+
+module Gooby
+
+=begin rdoc
+  Instances of this class represent a <Run> aggregate object from a
+  Forerunner XML file.  
+
+  Additionally, there is distance, pace, and Google Map generation logic 
+  in this class.
+=end
+  
+  class GoogleMapGenerator < GoobyObject 
+  
+    attr_reader :csv_file, :csv_lines, :dttm_idx, :num_idx, :lat_idx, :lng_idx, :alt_idx, :cdist_idx
+    attr_reader :run, :tkpts, :content_hash, :center_longitude, :center_latitude, :gpoint_array, :overlay_points, :notes    
+    attr_reader :center_longitude, :center_latitude
+    
+    # The default csv input file format is as follows:
+    # 1 | 2006-01-15T18:31:10Z | 1279 | 33.42601 | -111.92927 | 347.654 | 26.3514930151813
+    # 1 | 2004-11-13T13:05:20Z | 2 | 37.54318 | -77.43636 | -58.022 | 0.00297286231747969 
+    
+    def initialize(csv_file, dttm_idx=1, num_idx=4, lat_idx=5, lng_idx=6, alt_idx=7, cdist_idx=8)
+      @csv_file  = csv_file
+      @dttm_idx  = dttm_idx
+      @num_idx   = num_idx
+      @lat_idx   = lat_idx
+      @lng_idx   = lng_idx
+      @alt_idx   = alt_idx
+      @cdist_idx = cdist_idx
+            
+      # Override default csv value indices if specified in the configuration yaml file.
+      @configuration =  Gooby::Configuration.get_config
+      @dttm_idx  = @configuration.get('csv_dttm_idx')  if @configuration.get('csv_dttm_idx')
+      @num_idx   = @configuration.get('csv_num_idx')   if @configuration.get('csv_num_idx')
+      @lat_idx   = @configuration.get('csv_lat_idx')   if @configuration.get('csv_lat_idx')
+      @lng_idx   = @configuration.get('csv_lng_idx')   if @configuration.get('csv_lng_idx')
+      @alt_idx   = @configuration.get('csv_alt_idx')   if @configuration.get('csv_alt_idx')
+      @title     = @configuration.get("#{@csv_file}")  
+            
+      @content_hash = Hash.new('')
+      @run   = Gooby::Run.new(1)
+      @track = Gooby::Track.new(1)
+      @run.add_track(@track)
+      @tkpts = Array.new
+      @icon_url_base = @configuration.get('gmap_icon_url_base')
+      
+      list = Array.new
+      list << @csv_file
+      @csv_reader = Gooby::CsvReader.new(list)
+      @csv_points = @csv_reader.read
+      @csv_points.each { |csv_point| 
+        tkpt = csv_point.as_trackpoint
+        if tkpt
+          @track.add_trackpoint(tkpt)
+        end
+      }
+      @run.finish
+    end
+    
+=begin
+Returns a Hash with specific generated content at the following keys:
+=end
+    def generate(configuration)
+      if (configuration == nil)
+        @configuration = Gooby::Configuration.get_config
+      else
+        @configuration = configuration
+      end  
+      @content_hash['when_generated'] = Time.now
+      @content_hash['title'] = @title
+      @icon_url_base = @configuration.get('gmap_icon_url_base')               
+      filter_trackpoints  
+      compute_center_point
+      generate_key_js
+      generate_map_div
+      generate_messages_div
+      generate_main_js_start
+      generate_main_js_route_overlay
+      generate_main_js_checkpoint_overlays
+      generate_main_js_map_clicked_listeners      
+      generate_main_js_end    
+      @content_hash
+    end
+
+    def filter_trackpoints        
+      count, @tkpts = 0, Array.new
+      firstTkpt = @configuration.get('gmap_first_tkpt_number')
+      lastTkpt  = @configuration.get('gmap_last_tkpt_number')
+      @run.tracks.each { |trk| 
+        trk.trackpoints.each { |tkpt|
+          count = count + 1
+          if ((count >= firstTkpt) && (count <= lastTkpt))
+            @tkpts.push(tkpt)
+          end
+        }
+      }   
+    end
+    
+=begin
+Returns a Hash with specific generated content at the following keys:
+=end 
+    def generate_page(configuration)
+
+      # puts "generate_page #{@csv_file} #{@csv_lines.size}"
+      content_hash = generate(nil)
+      s = String.new(@csv_file)
+      s.gsub("/", " ")
+      tokens = tokenize(s, nil)
+      out_file = "#{tokens[-2]}.html"
+      #content_hash.keys.sort.each { | key | puts key }
+
+s = <<HERE
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
+    <meta name="description" content="Google Map generated with #{project_embedded_comment}">
+    <meta name="keywords" content="Google Map #{project_embedded_comment} GPS">
+    <title> Google Map by Gooby </title>
+    #{content_hash['key_js']}
+    #{content_hash['main_js_start']}
+    #{content_hash['main_js_route_overlay']}  
+    #{content_hash['main_js_checkpoint_overlays']}  
+    #{content_hash['main_js_map_clicked_listeners']}  
+    #{content_hash['main_js_end']}
+  </head>
+  <body onload="load()" onunload="GUnload()">
+    <center>
+    <h3> #{@title} </h3>
+    <h5> Generated by Gooby #{content_hash['when_generated']} <br> Gooby = Google APIs + Ruby </h5>    
+    #{content_hash['map_div']}    
+    #{content_hash['messages_div']}   
+    </center>
+  </body>
+</html>
+HERE
+      puts s   # Redirect output via shell.
+    end
+    
+    private
+    
+    def compute_center_point            
+      highLat  = -999.0
+      highLong = -999.0
+      lowLat   =  999.0      
+      lowLong  =  999.0
+      @tkpts.each { |tkpt|
+        highLat  = tkpt.latitude_as_float  if tkpt.latitude_as_float  > highLat
+        lowLat   = tkpt.latitude_as_float  if tkpt.latitude_as_float  < lowLat  
+        highLong = tkpt.longitude_as_float if tkpt.longitude_as_float > highLong
+        lowLong  = tkpt.longitude_as_float if tkpt.longitude_as_float < lowLong  
+      }
+      @center_longitude = (highLong + lowLong) / 2
+      @center_latitude  = (highLat  + lowLat)  / 2
+      @content_hash['center_longitude'] = @center_longitude
+      @content_hash['center_latitude']  = @center_latitude       
+    end
+          
+    def generate_key_js              
+      key  = @configuration.get('gmap_key')    
+      key.strip!
+      # <script src="http://maps.google.com/maps?file=api&v=2&key=<%= @gmap_key -%>"  type="text/javascript"></script>
+      s  = "<script src='http://maps.google.com/maps?file=api&v=2&key=" 
+      s << key
+      s << "' type='text/javascript'></script>"
+      @content_hash['key_js'] = s
+    end
+    
+    def generate_map_div
+      width  = @configuration.get('gmap_width')
+      height = @configuration.get('gmap_height')
+      id     = @configuration.get('gmap_map_element_id')      
+      s = '<div id="'
+      s << id
+      s << '" style="width: '
+      s << width
+      s << '; height: '
+      s << height
+      s << '"></div>'
+      @content_hash['map_width']  = width  
+      @content_hash['map_height'] = height          
+      @content_hash['map_div']    = s            
+    end
+
+    def generate_messages_div
+      s = "<div id=\"messages\"></div>"
+      @content_hash['messages_div'] = s            
+    end
+    
+    def generate_main_js_start
+      id       = @configuration.get('gmap_map_element_id')  
+      size     = @configuration.get('gmap_size_control')
+      type     = @configuration.get('gmap_type')
+      zoom     = @configuration.get('gmap_zoom_level')
+      title    = @configuration.get("#{@csv_file}") 
+      title    = '' if title == nil
+      zoom_tab = @configuration.get('gmap_zoom_tab') 
+      if size
+        if size == 'smallmap'
+          size = 'GSmallMapControl'
+        elsif size == 'smallzoom'
+          size = 'GSmallMapControl'          
+        else
+          size = 'GLargeMapControl'          
+        end          
+      end
+        
+      if type
+        if type == 'satellite'
+          type = 'G_SATELLITE_MAP'
+        elsif type == 'hybrid'
+          type = 'G_HYBRID_MAP'
+        else
+          type = 'G_NORMAL_MAP'
+        end
+      else
+        type = 'G_NORMAL_MAP'
+      end
+                         
+      s  =  '<script type="text/javascript">'
+      s << "\n"
+      s << "//<![CDATA[ \n"
+      s << "    function load() { \n"
+      s << "        if (GBrowserIsCompatible()) { \n"
+      s << '            var map = new GMap2(document.getElementById("'
+      s << id
+      s << '")); '
+      s << "\n"
+    
+      if size
+        s << '            map.addControl(new '
+        s << size
+        s << '());'
+        s << "\n"        
+      end
+      
+      if type
+        s << '            map.addControl(new GMapTypeControl());'
+        s << "\n"
+        # s << '            map.setMapType('
+        # s << type
+        # s << ');'
+        s << "\n"        
+      end   
+      s << "            var centerPoint = new GLatLng(#{@center_latitude}, #{@center_longitude}); // #{project_embedded_comment} \n"
+      s << "            map.setCenter(centerPoint, #{zoom}); \n"         
+      s << "\n"
+      @content_hash['main_js_start'] = s 
+      @content_hash['title'] = title
+    end
+    
+    def generate_main_js_route_overlay
+      tkpt_count   = @tkpts.size.to_f
+      app_max      = @configuration.get('gmap_approx_max_points').to_f
+      gen_comments = @configuration.get('gmap_gen_comments')   
+      ratio        = tkpt_count / app_max
+      @start_dttm  = nil
+      if ratio > 1.0
+        increment = (tkpt_count / app_max).to_i
+      else
+        increment = 1
+      end
+      curr_idx, next_idx, gpoint_count, last_idx = -1, 0, 0, @tkpts.size - 1
+      s = "        var points = new Array(); " 
+      @tkpts.each { |tkpt|
+        curr_idx = curr_idx + 1
+        if curr_idx == 0
+          @start_dttm = tkpt.dttm
+          @start_pos  = tkpt.point
+          
+          time        = Time.parse(@start_dttm.dateTime().to_s)
+        end
+        if ((curr_idx == next_idx) || (curr_idx == last_idx) || (tkpt.is_split()))
+          gpoint_count = gpoint_count + 1
+          s << tkpt.as_glatlng(false, gen_comments, tkpt_count, curr_idx, @start_dttm)
+          next_idx = curr_idx + increment
+        else
+          s << tkpt.as_glatlng(true, gen_comments, tkpt_count, curr_idx, @start_dttm)
+        end
+      }
+      s << "\n"
+      s << "\n            var routePolyline = new GPolyline(points); "
+      s << "\n            map.addOverlay(routePolyline); "      
+      @content_hash['main_js_route_overlay'] = s 
+      @content_hash['main_js_route_overlay_increment'] = increment                  
+    end
+    
+    def generate_main_js_checkpoint_overlays
+      s =  "\n            // Create a base icon for all of our markers that specifies the "
+      s << "\n            // shadow, icon dimensions, etc."
+      s << "\n            var baseIcon = new GIcon();"
+      s << "\n            baseIcon.shadow = \"#{@icon_url_base}shadow50.png\";"
+      s << "\n            baseIcon.iconSize = new GSize(20, 34);"
+      s << "\n            baseIcon.shadowSize = new GSize(37, 34);"
+      s << "\n            baseIcon.iconAnchor = new GPoint(9, 34);"
+      s << "\n            baseIcon.infoWindowAnchor = new GPoint(9, 2);"
+      s << "\n            baseIcon.infoShadowAnchor = new GPoint(18, 25);"
+      s << "\n"
+      
+      curr_idx  = -1
+      last_idx  = @tkpts.size - 1
+      next_checkpoint = 0.0
+      @start_dttm = nil
+      @tkpts.each { | tkpt |
+        curr_idx = curr_idx + 1
+        if curr_idx == 0
+          @start_dttm = tkpt.dttm           
+          info_window_html = tkpt.as_info_window_html('Start', @start_dttm)
+          s << "\n            var iconStart = new GIcon(baseIcon); "
+          s << "\n            iconStart.image = \"#{@icon_url_base}dd-start.png\";"
+          s << "\n            var pStart = new GPoint(#{tkpt.longitude_as_float}, #{tkpt.latitude_as_float});"
+          s << "\n            var mStart = new GMarker(pStart, iconStart);"
+          s << "\n            GEvent.addListener(mStart, \"click\", function() { "
+          s << "\n                mStart.openInfoWindowHtml(#{info_window_html});"
+          s << "\n            }); "
+          s << "\n            map.addOverlay(mStart);"
+          s << "\n " 
+          next_checkpoint = 1.0      
+        elsif curr_idx == last_idx
+          info_window_html = tkpt.as_info_window_html('Finish', @start_dttm)          
+          s << "\n            var iconFinish = new GIcon(baseIcon); "
+          s << "\n            iconFinish.image = \"#{@icon_url_base}dd-end.png\";"
+          s << "\n            var pFinish = new GPoint(#{tkpt.longitude_as_float}, #{tkpt.latitude_as_float});"
+          s << "\n            var mFinish = new GMarker(pFinish, iconFinish);"
+          s << "\n            GEvent.addListener(mFinish, \"click\", function() { "
+          s << "\n                mFinish.openInfoWindowHtml(#{info_window_html});"
+          s << "\n            }); "
+          s << "\n            map.addOverlay(mFinish);"
+          s << "\n " 
+          next_checkpoint = 999999
+        else
+          if (tkpt.cumulative_distance >= next_checkpoint)
+            integer = next_checkpoint.to_i
+            info_window_html = tkpt.as_info_window_html("#{integer}", @start_dttm)              
+            s << "\n            var icon#{integer} = new GIcon(baseIcon); "
+            s << "\n            icon#{integer}.image = \"#{@icon_url_base}marker#{integer}.png\";"
+            s << "\n            var p#{integer} = new GPoint(#{tkpt.longitude_as_float}, #{tkpt.latitude_as_float});"
+            s << "\n            var m#{integer} = new GMarker(p#{integer}, icon#{integer});"
+            s << "\n            GEvent.addListener(m#{integer}, \"click\", function() { "
+            s << "\n                m#{integer}.openInfoWindowHtml(#{info_window_html});"
+            s << "\n            }); "
+            s << "\n            map.addOverlay(m#{integer});"
+            s << "\n " 
+            next_checkpoint = next_checkpoint + 1.0   
+          end                         
+        end
+      }
+      s << "\n"    
+      @content_hash['main_js_checkpoint_overlays'] = s 
+    
+    end
+    
+    def generate_main_js_map_clicked_listeners
+      s =  "\n"
+      s << "\n            GEvent.addListener(map, \"click\", function() { "
+      s << "\n                var center = map.getCenter(); \n"
+      s << "\n                document.getElementById(\"messages\").innerHTML = 'click: ' + center.toString(); "
+      s << "\n            });"
+      s << "\n            GEvent.addListener(map, \"moveend\", function() { "
+      s << "\n                var center = map.getCenter(); \n"
+      s << "\n                document.getElementById(\"messages\").innerHTML = 'moveend: ' + center.toString(); "
+      s << "\n            });"
+      @content_hash['main_js_map_clicked_listeners'] = s 
+    end
+    
+    def generate_main_js_end
+      s =  "\n        } "
+      s << "\n    } "
+      s << "\n//]]> \n"        
+      s << "\n</script>" 
+       
+      @content_hash['main_js_end'] = s            
+    end
+
+  end
+
+end # end of module

data/lib/gooby_history.rb

@@ -0,0 +1,41 @@
+=begin
+
+Gooby = Google APIs + Ruby
+Gooby - Copyright 2007 by Chris Joakim.
+Gooby is available under GNU General Public License (GPL) license.
+
+=end
+
+module Gooby
+
+=begin rdoc
+  Instances of this class represent a <History> aggregate object from a
+  Forerunner XML file.
+=end
+    
+  class History < GoobyObject 
+  
+    attr_reader :runs
+  
+    def initialize
+      @runs = Array.new
+    end
+  
+  # Adds a Run during XML parsing.
+    def add_run(run)  
+      @runs.push(run)    
+    end
+  
+    def to_s
+      return "Hist: runs: #{@runs.size}"
+    end
+  
+    def print_string
+      s = "History: run count=#{@runs.size} \n"
+      runs.each { | run | s << run.print_string }
+      s
+    end
+
+  end 
+
+end # end of module

data/lib/gooby_kernel.rb

@@ -0,0 +1,163 @@
+=begin
+
+Gooby = Google APIs + Ruby
+Gooby - Copyright 2007 by Chris Joakim.
+Gooby is available under GNU General Public License (GPL) license.
+
+=end
+
+module Gooby
+
+=begin rdoc
+  This module is used to embed information about the Gooby project and
+  version into the codebase.
+=end
+  
+  module GoobyKernel
+  
+    def project_name
+      'Gooby'
+    end
+    
+    def project_version_number   
+      '1.2.0'
+    end
+
+  # Return a String date, like '2007/03/21'.  
+    def project_date       
+      '2007/07/22'
+    end
+
+    # Return a String containing the project author name.
+    def project_author
+      'Chris Joakim'
+    end
+  
+  # Return a String year, like '2007'. 
+    def project_year       
+      project_date[0...4]  # start, length
+    end
+ 
+  # Return a String containing copyright, year, and author.
+    def project_copyright
+      "Copyright (C) #{project_year} #{project_author}"
+    end
+
+    def project_embedded_comment
+      "#{project_name} #{project_version_number}"
+    end
+    
+  # Return a String containing GNU/GPL, and the gpl.html URL.  
+    def project_license    
+      'GNU General Public License (GPL).  See http://www.gnu.org/copyleft/gpl.html'
+    end
+
+  # Return an Array of lines in file, optionally stripped.  
+    def read_lines(filename, strip=false)  
+
+      array = IO.readlines(filename)
+      if strip
+        array = strip_lines(array)
+      end
+      return array
+    end
+ 
+  # Return an Array of lines in file per the given delimeter, optionally stripped.   
+    def read_as_ascii_lines(filename, delim=10, strip=false)  
+      
+      array = Array.new  
+      file  = File.new(filename)
+      currLine = ''
+      bytesRead = 0
+      linesRead = 0
+      
+      file.each_byte { |b| 
+        bytesRead = bytesRead + 1
+        if (b == delim) # delim is 13 for quicken, 10 for address book xml
+          array << currLine
+          currLine = ''
+          linesRead = linesRead + 1
+        else
+          if (b < 127)
+            currLine << "#{b.chr}"
+          end
+        end  
+      }
+    
+      if currLine.size > 0
+        array << currLine
+      end
+      if strip
+        array = strip_lines(array)
+      end
+      return array    
+    end
+
+  # Strip the lines/Strings; return a new Array.
+    def strip_lines(array)  
+ 
+      newArray = Array.new
+      if (array != nil)
+        array.each { |line| line.strip! ; newArray << line }
+      end
+      return newArray
+    end
+
+    def tokenize(string, delim=nil, strip=false)  
+      if string
+        tokens = string.split(delim)
+        if strip
+          tokens.each { |tok| tok.strip! }
+        end
+        tokens
+      else
+        Array.new
+      end
+    end
+    
+    def character_align(character, number, left_length, right_length)
+      tokens    = number.to_s.split("#{character}")
+      integer   = tokens[0].to_s
+      fraction  = tokens[1].to_s
+      lpad_size = left_length - integer.size
+      rpad_size = right_length - fraction.size
+      if lpad_size > 0  
+        lpad_size.times do |i|
+          integer  = " #{integer}"
+        end
+      end
+      if rpad_size > 0
+        rpad_size.times do |i|
+          fraction = "#{fraction} "
+        end
+      end
+       "#{integer}.#{fraction}"
+    end
+    
+    def default_delimiter
+      return '|'
+    end
+                
+    def invalid_time
+      return -99999999
+    end
+   
+    def invalid_latitude
+      return -1
+    end
+  
+    def invalid_longitude
+      return -1
+    end
+  
+    def invalid_altitude
+       return -1
+    end
+    
+    def invalid_heartbeat
+       return -1
+    end
+    
+  end
+
+end # end of module