gooby 0.9.4 → 0.9.5

data/README

@@ -1,13 +1,6 @@
-= Gooby -- Google APIs + Ruby 
+= Gooby = Google APIs + Ruby 
 
-Version: 0.9.4
-
-RubyForge Release Notes:
-
-Gooby = Google APIs + Ruby.
-This release adds support for Garmin TrainingCenter TCX XML files, created by 
-the newer Garmin devices such as models 205 and 305.  For an example of a Google Map
-created with Gooby, see http://www.joakimsoftware.com/gmap/phoenix_marathon.html
+Version: 0.9.5
 
 ---
 
@@ -23,8 +16,6 @@ as created in one of the following three ways.
     See any of the 'data/*.csv' files in the distribution for an example
     of the CSV format. 
 
-Support for Garmin TrainingCenter *.tcx files was added in the 0.9.4 release.
-
 Google maps are applicable really to any outdoor activity for which GPS data 
 can be obtained.  The focus of Gooby is on running, because the author is a 
 marathon runner, and the Garmin Forerunner (I use both models 201 and 205) 
@@ -35,9 +26,9 @@ etc).
 Other activities, such as cycling, hiking, walking, driving, and even golfing
 are also well suited for Gooby.  Given a waterproof GPS receiver, sailing, and 
 swimming Google Maps can also be created with Gooby.  Please let me know how
-you use Gooby!
+you use Gooby!  Feedback is requested.
 
-All Gooby 0.9.4 functionality is intended to be invoked from a command line.  
+All Gooby functionality is intended to be invoked from a command line.  
 Web and Rails integration may be done in a later release.
 
 See the Goals/Requirements and Usage sections below for the complete list of
@@ -58,22 +49,17 @@ Gooby is available under GNU General Public License (GPL) license.
 == Download
 
 The latest version of gooby can be found at
-* http://rubyforge/
+* http://rubyforge.org/projects/gooby/
 
 == Installation
 
-Gooby is packaged and installed as a Gem.  
-
-== Development vs Gem Packaging
+Gooby is packaged and installed as a ruby 'gem'.  Download the latest gem to 
+your computer, then run the following command from your download directory.
+The -t flag will cause the Gooby regression test suite to be executed.
 
-In development, the coding standard for Gooby is to have a separate *.rb source
-file for each class or module.  There also a one-to-one mapping between 'base'
-code files and 'tc_*.rb' test case files.  The CVS repository contains these
-separate files.
-
-As of release 0.9.3 all gem-packaged code is merged into file 'gooby.rb',
-and all tests are merged into file 'ts_gooby.rb'.  The idea here is to simplify
-the eventual deployed gem and directory structure on the user's computer.
+gem install gooby-0.9.5.gem
+or
+gem install gooby-0.9.5.gem -t
 
 == Running the Gooby Test Suite
 
@@ -90,30 +76,23 @@ directory:
    Sample Gooby-generated Google Maps are at www.joakimsoftware.com, below:
 
    http://www.joakimsoftware.com/gmap/gps_point_capture.html
-   http://www.joakimsoftware.com/gmap/20041113_richmond_marathon.html
+
    http://www.joakimsoftware.com/gmap/20050305_corporate_cup_hm.html
    http://www.joakimsoftware.com/gmap/20050430_nashville_marathon.html
+   http://www.joakimsoftware.com/gmap/20060115_phoenix_marathon.html
+   http://www.joakimsoftware.com/gmap/20070310_corporate_cup_hm.html
    http://www.joakimsoftware.com/gmap/phoenix_marathon.html
-   http://www.joakimsoftware.com/gmap/run_2007_02_24_15_01_35.html
 
 
 === Road Map / TODO List
 
-*  IE BUG - Larger maps appear properly in Safari and Firefox browser, but not on
-   Inernet Explorer.
-
 *  IE or Google Bug - The Google Map v2 JavaScript has not run properly in
    Internet Explorer at times.  Script error after loading the map background,
    but before the map route is drawn.
  
-*  Incomplete, WIP - Google Map generation from your data/geo_data.txt file.
-
-*  Incomplete, WIP - Support sources of GPS data other than Garmin Forerunner 
-   XML from Forerunner Logbook.  Training Center and Forerunner 205 data is 
-   expected in March 2007.   
-
-*  BUG - TestGenerator adds two space lines to top-of-file upon test code
-   regeneration.
+*  Incomplete - Google Map generation from your data/geo_data.txt file.
+   You can, however, provide your own data as a CSV file per the current
+   map generation design.
 
 *  Add more regression tests.
 
@@ -130,9 +109,10 @@ a bug, on the Tracker page.
 
 = Usage
 
-See file 'bin/example_usage.rb' in the gem distribution.  Most of this file
-is shown below.  You will probably have to change the input filenames (yaml, 
-xml, csv) to your own filenames on your computer.
+See files 'bin/example_usage.sh' and 'bin/example_usage.rb' in the gem 
+distribution. Most of the *.rb file is shown below.  You will probably have to
+change the input filenames (yaml, xml, csv) to your own filenames on your 
+computer.
 
 Of course, you'll also have to obtain a Google Maps key for your web site.
 It's free, and has to be included in every page which displays a map.  See
@@ -141,7 +121,6 @@ into the generated html page.  Also see the Google Maps API site -
 http://www.google.com/apis/maps/
 
 	require 'gooby'
-
 	include REXML
 
 	# First, create a GoobyCommand object.
@@ -159,21 +138,21 @@ http://www.google.com/apis/maps/
 
 	# Split a large Garmin ForerunnerLogbook XML file into individual 'run' files.
 	# In this example, '/temp' is the output directory.
-	gooby.split_garmin_forerunner_logbook_xml('data/forerunner_2007.xml', '/temp') 
+	gooby.split_garmin_forerunner_logbook_xml('data/forerunner_2007.xml', '/temp') if true
 
 	# Split a large Garmin TrainingCenter TCX(XML) file into individual 'activity' files.
-	gooby.split_garmin_training_center_xml('data/2007_03_04.tcx', '/temp') 
+	gooby.split_garmin_training_center_xml('data/2007_03_10.tcx', '/temp') if true
 
 	# Parse a Garmin ForerunnerLogbook XML file, or previously 'split' subset, into CSV.
 	# You may want to redirect this output to a file.
-	gooby.parse_garmin_forerunner_logbook_xml 'data/run_2007_01_01_16_38_27.xml' 
+	gooby.parse_garmin_forerunner_logbook_xml 'data/run_2007_01_01_16_38_27.xml'  if true
 
 	# Parse a TrainingCenter TCX(XML) file, or previously 'split' subset, into CSV.
-	gooby.parse_garmin_training_center_xml 'data/activity_2007_03_04_15_22_36.xml'  
+	gooby.parse_garmin_training_center_xml 'data/activity_2007_03_04_15_22_36.xml'  if true
 
 	# Generate a Google Map from your CSV file data, and the Options per
 	# your yaml file.  You may also wish to redirect this output to a file.
-	gooby.generate_google_map('data/phx.csv', options)  
+	gooby.generate_google_map('data/phx.csv', options)  if true 
    
 
 == Goals / Requirements 
@@ -216,24 +195,16 @@ f5.   Provide the ability to generate Google Map HTML content from your GPS
 
       status = complete
 
-f6.   Provide the ability to define your own points-of-interest (POI), route
-      segments, and routes as a collection of GPS data in a simple text file.
-      Allow "routes" to be composed from "reusable route segments", and 
-      annotated with your own POI. 
-
-      status = in-progress
-
-f7.   Provide the ability to generate Google Maps (requirement f5) from your
-      collection of GPS data (requirement f6).
-
-      status = in-progress
-
-f8.   Provide the ability (i.e. - an Internet web page) for a user to easily
+f6.   Provide the ability (i.e. - an Internet web page) for a user to easily
       obtain GPS coordinates for their particular POI, segments, and routes.
 
-      status = complete.
+      See http://www.joakimsoftware.com/gmap/gps_point_capture.html and also
+      file gps_point_capture.html in the gem.  Modify this file for your site
+      as necessary.
 
-f9.   Provide the ability to alter appropriate Gooby behavior via a simple
+      status = complete
+
+f7.   Provide the ability to alter appropriate Gooby behavior via a simple
       configuration file (i.e. - gooby_options.yaml) rather than modifying 
       the source code.  Specific configuration requirements are:
       a.  Allow the user to specify roughly how many points appear on a map.
@@ -242,22 +213,31 @@ f9.   Provide the ability to alter appropriate Gooby behavior via a simple
 
       status = in-progress
 
-f10   Provide adequate user documentation and scripts, so that someone other 
+f8.   Provide adequate user documentation and scripts, so that someone other 
       than the author can actually use Gooby.
 
-      status = in-progress
+      status = complete, see example_usage.sh and example_usage.rb
 
-f11.  Provide sample files - xml, csv, images.
+f9.  Provide sample files - xml, csv, images.
 
       status = complete
 
-Currently out-of-scope but intended for a future release:
----------------------------------------------------------
+Currently out-of-scope; but may be implemented at a future date.
+----------------------------------------------------------------
+
+f40.  Provide the ability to define your own points-of-interest (POI), route
+      segments, and routes as a collection of GPS data in a simple text file.
+      Allow "routes" to be composed from "reusable route segments", and 
+      annotated with your own POI. 
+
+f41.  Provide the ability to generate Google Maps (requirement f5) from your
+      collection of GPS data (requirement f40).
 
 f51.  Other Google APIs, such as Google Earth.
 
 f52.  Rails framework integration.
 
+
 === Technical Requirements
 
 t1.   Conform to consistent coding and naming standards throughout the code.
@@ -293,3 +273,4 @@ t8.   Implement a Ruby-standard packaging mechanism, so that users can easily
 This software is provided "as is" and without any express or implied warranties, 
 including, without limitation, the implied warranties of merchantibility and 
 fitness for a particular purpose.
+

data/bin/20050305_corporate_cup_hm_to_csv.rb

@@ -0,0 +1,9 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+gooby.parse_garmin_forerunner_logbook_xml 'data/20050305_corporate_cup_hm.xml'
+  

data/bin/20050430_nashville_marathon_to_csv.rb

@@ -0,0 +1,9 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+gooby.parse_garmin_forerunner_logbook_xml 'data/20050430_nashville_marathon.xml'
+  

data/bin/20060115_phoenix_marathon_to_csv.rb

@@ -0,0 +1,9 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+gooby.parse_garmin_forerunner_logbook_xml 'data/20060115_phoenix_marathon.xml'
+  

data/bin/activity_2007_03_10_13_02_32.xml_to_csv.rb

@@ -0,0 +1,9 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+gooby.parse_garmin_training_center_xml 'data/activity_2007_03_10_13_02_32.xml'
+  

data/bin/{tests_gen.rb → code_scan.rb}

@@ -1,16 +1,18 @@
-require 'gooby'
-
 =begin
 
 Gooby - Copyright 2007 by Chris Joakim.
 Gooby is available under GNU General Public License (GPL) license.
 
 Example command line:
-ruby bin/tests_gen.rb  
+ruby bin/code_scan.rb
 
 =end
 
 # The following prefixes ../lib to the active ruby load path
 $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+puts '$LOAD_PATH is now:'
+puts $LOAD_PATH
+
+require 'gooby'
 
-generator = Gooby::TestGenerator.new 
+generator = Gooby::CodeScanner.new(ARGV)

data/bin/example_usage.rb

@@ -11,7 +11,6 @@ to your own filenames on your computer.
 $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
 
 require 'gooby'
-
 include REXML
 
 # First, create a GoobyCommand object.
@@ -32,7 +31,7 @@ puts "option '#{n}' = #{v}"
 gooby.split_garmin_forerunner_logbook_xml('data/forerunner_2007.xml', '/temp') if true
 
 # Split a large Garmin TrainingCenter TCX(XML) file into individual 'activity' files.
-gooby.split_garmin_training_center_xml('data/2007_03_04.tcx', '/temp') if true
+gooby.split_garmin_training_center_xml('data/2007_03_10.tcx', '/temp') if true
 
 # Parse a Garmin ForerunnerLogbook XML file, or previously 'split' subset, into CSV.
 # You may want to redirect this output to a file.
@@ -43,5 +42,5 @@ gooby.parse_garmin_training_center_xml 'data/activity_2007_03_04_15_22_36.xml'
 
 # Generate a Google Map from your CSV file data, and the Options per
 # your yaml file.  You may also wish to redirect this output to a file.
-gooby.generate_google_map('data/phx.csv', options)  if false
+gooby.generate_google_map('data/phx.csv', options)  if true
   

data/bin/example_usage.sh

@@ -0,0 +1,52 @@
+
+echo splitting forerunner logbook 2007 file
+ruby bin/split_forerunner_logbook_2007.rb
+echo
+
+echo splitting training center 2007 file
+ruby bin/split_training_center_2007.rb
+echo
+
+echo parsing data/20050305_corporate_cup_hm.xml
+ruby bin/20050305_corporate_cup_hm_to_csv.rb > data/20050305_corporate_cup_hm.csv
+head -3 data/20050305_corporate_cup_hm.csv
+echo ...
+tail -3 data/20050305_corporate_cup_hm.csv
+echo 
+
+echo parsing data/20050430_nashville_marathon.xml
+ruby bin/20050430_nashville_marathon_to_csv.rb > data/20050430_nashville_marathon.csv
+head -3 data/20050430_nashville_marathon.csv
+echo ...
+tail -3 data/20050430_nashville_marathon.csv
+echo
+
+echo parsing data/20060115_phoenix_marathon.xml
+ruby bin/20060115_phoenix_marathon_to_csv.rb > data/20060115_phoenix_marathon.csv
+head -3 data/20060115_phoenix_marathon.csv
+echo ...
+tail -3 data/20060115_phoenix_marathon.csv
+echo
+
+echo parsing data/activity_2007_03_10_13_02_32.csv
+ruby bin/activity_2007_03_10_13_02_32.xml_to_csv.rb > data/activity_2007_03_10_13_02_32.csv
+head -3 data/activity_2007_03_10_13_02_32.csv
+echo ...
+tail -3 data/activity_2007_03_10_13_02_32.csv
+echo
+
+echo generating corporate cup hm 2005 map
+ruby bin/gen_gmap_cc_2005.rb   > samples/20050305_corporate_cup_hm.html
+
+echo generating nashville marathon map
+ruby bin/gen_gmap_nashville.rb > samples/20050430_nashville_marathon.html
+
+echo generating phoenix marthon map
+ruby bin/gen_gmap_phx.rb       > samples/20060115_phoenix_marathon.html
+
+echo generating corporate cup hm 2007 map
+ruby bin/gen_gmap_cc_2007.rb   > samples/20070310_corporate_cup_hm.html
+
+echo done
+
+

data/bin/gen_gap_phx.rb

@@ -0,0 +1,10 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+options_file = 'gooby_options.yaml'
+options = gooby.options(options_file)
+gooby.generate_google_map('data/phx.csv', options)  

data/bin/gen_gmap_cc_2005.rb

@@ -0,0 +1,10 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+options_file = 'gooby_options.yaml'
+options = gooby.options(options_file)
+gooby.generate_google_map('data/20050305_corporate_cup_hm.csv', options)

data/bin/gen_gmap_cc_2007.rb

@@ -0,0 +1,10 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+options_file = 'gooby_options.yaml'
+options = gooby.options(options_file)
+gooby.generate_google_map('data/activity_2007_03_10_13_02_32.csv', options)  

data/bin/gen_gmap_nashville.rb

@@ -0,0 +1,10 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+options_file = 'gooby_options.yaml'
+options = gooby.options(options_file)
+gooby.generate_google_map('data/20050430_nashville_marathon.csv', options)  

data/bin/gen_gmap_phx.rb

@@ -0,0 +1,10 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+options_file = 'gooby_options.yaml'
+options = gooby.options(options_file)
+gooby.generate_google_map('data/20060115_phoenix_marathon.csv', options)  

data/bin/phx_to_csv.rb

@@ -0,0 +1,47 @@
+=begin rdoc
+
+This file contains examples of how to use Gooby.
+
+You will probably have to change the input filenames (yaml, xml, csv)
+to your own filenames on your computer.
+
+=end
+
+# The following prefixes ../lib to the active ruby load path
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+
+include REXML
+
+# First, create a GoobyCommand object.
+gooby = Gooby::GoobyCommand.new
+
+# Next, create an Options object from the given yaml file - see the sample 
+# 'gooby_options.yaml' file in the distribution.
+options_file = 'gooby_options.yaml'
+options = gooby.options(options_file)
+
+# Optionally display some of its values.
+n = 'gmap_approx_max_points'
+v = options.get(n)
+puts "option '#{n}' = #{v}"
+
+# Split a large Garmin ForerunnerLogbook XML file into individual 'run' files.
+# In this example, '/temp' is the output directory.
+gooby.split_garmin_forerunner_logbook_xml('data/forerunner_2007.xml', '/temp') if true
+
+# Split a large Garmin TrainingCenter TCX(XML) file into individual 'activity' files.
+gooby.split_garmin_training_center_xml('data/2007_03_10.tcx', '/temp') if true
+
+# Parse a Garmin ForerunnerLogbook XML file, or previously 'split' subset, into CSV.
+# You may want to redirect this output to a file.
+gooby.parse_garmin_forerunner_logbook_xml 'data/run_2007_01_01_16_38_27.xml'  if true
+
+# Parse a TrainingCenter TCX(XML) file, or previously 'split' subset, into CSV.
+gooby.parse_garmin_training_center_xml 'data/activity_2007_03_04_15_22_36.xml'  if true
+
+# Generate a Google Map from your CSV file data, and the Options per
+# your yaml file.  You may also wish to redirect this output to a file.
+gooby.generate_google_map('data/phx.csv', options)  if true
+  

data/bin/split_forerunner_logbook_2007.rb

@@ -0,0 +1,10 @@
+
+# The following prefixes ../lib to the active ruby load path
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+gooby.split_garmin_forerunner_logbook_xml('data/forerunner_2007.xml', '/temp') 
+  

data/bin/split_training_center_2007.rb

@@ -0,0 +1,8 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'gooby'
+include REXML
+
+gooby = Gooby::GoobyCommand.new
+gooby.split_garmin_training_center_xml('data/2007_03_10.tcx', '/temp')