gooby 1.2.0 → 2.0.0

data/lib/gooby_base_object.rb

@@ -0,0 +1,46 @@
+=begin
+
+Gooby = Google APIs + Ruby.  Copyright 2009 by Chris Joakim.
+Gooby is available under GNU General Public License (GPL) license.
+
+=end
+
+class GoobyBaseObject
+
+  include GoobyEnvironment
+  include GoobyIntrospection
+  include GoobyIO
+  
+  UOM_MILES           = "m"
+  UOM_KILOMETERS      = "k"
+  UOM_YARDS           = "y"
+  KILOMETERS_PER_MILE = 1.61290322581  
+  YARDS_PER_MILE      = 1760.0
+  MILES_PER_KILOMETER = 0.62
+  YARDS_PER_KILOMETER = 1091.2  
+  METERS_PER_FOOT     = 3.281  # see http://www.chrismanual.com/Intro/convfact.htm
+  SECONDS_PER_HOUR    = 3600.0
+    
+  @@config = nil
+  
+  def self.set_config(c)
+    @@config = c
+  end
+  
+  def self.get_config
+    @@config
+  end
+  
+  def self.config_value(name)
+    @@config[name]
+  end
+  
+  def self.boolean_config_value(name)
+    value = config_value(name)
+    return false if value.nil?
+    return true  if value ==  true
+    return true  if value == 'true'
+    false
+  end  
+  
+end 

data/lib/gooby_base_sax_parser.rb

@@ -0,0 +1,95 @@
+=begin
+
+Gooby = Google APIs + Ruby.  Copyright 2009 by Chris Joakim.
+Gooby is available under GNU General Public License (GPL) license.
+
+---
+
+This abstract class implements common SAX-event and error handling for XML parsers.
+'libxml-ruby' gem version 0.9.7 is required.
+
+=end
+  
+require 'libxml'
+  
+class GoobyBaseSaxParser
+  
+  include LibXML
+  include XML::SaxParser::Callbacks
+
+  attr_reader :xml, :list, :current_tagname, :mappings
+  attr_reader :exception, :end_reached, :error
+
+  def initialize
+    @parser = XML::SaxParser.new
+    @parser.callbacks = self     
+    @list, @current_text, @current_tagname = [], '', ''
+    @exception, @error, @end_reached = nil, nil, false
+    @mappings = {}
+    subclass_initialize
+    # XML::Error.set_handler do | e |
+    #   self.set_error(e)
+    # end
+  end
+  
+  def subclass_initialize
+    # subclasses should override this method.  set @mappings and other variables.
+  end
+  
+  def set_error(e)
+    @error = "#{e}"
+  end
+
+  def process_file(file)
+    process_xml(File.read(file))
+  end
+
+  def process_xml(xml_string)
+    begin
+      @xml = xml_string 
+      @parser.string = @xml
+      @parser.parse
+    rescue Exception => e
+      @exception = "#{e.class} #{e.message}"
+      raise e
+    end
+    @list
+  end
+
+  # Indicates if an Exception, though not necessarily an Error, has occurred.
+  def has_exception?
+    (@exception == nil) ? false : true
+  end
+
+  # Indicates if an Error, though not necessarily an Exception, has occurred.
+  def has_error?
+    (@error == nil) ? false : true
+  end
+
+  # Indicates if the ending 'on_end_document' handler method has been called or not.
+  def end_reached?
+    @end_reached
+  end
+
+  def on_characters(chars)
+    @current_text << chars  if chars
+  end
+
+  def on_cdata_block(cdata)
+    @current_text << cdata  if cdata
+  end
+
+  def get_current_text
+    (@current_text) ? @current_text.strip : ''
+  end
+  
+  def on_error(msg)
+    @error = "#{msg}"
+  end 
+
+  def on_end_document
+    @end_reached = true
+    XML::Error.reset_handler    
+  end
+
+end

data/lib/gooby_configuration.rb

@@ -1,123 +1,41 @@
 =begin
 
-Gooby = Google APIs + Ruby
-Gooby - Copyright 2007 by Chris Joakim.
+Gooby = Google APIs + Ruby.  Copyright 2009 by Chris Joakim.
 Gooby is available under GNU General Public License (GPL) license.
 
 =end
 
-module Gooby
-
-=begin
-
-This is a singleton class whose values are loaded from a YAML file when your
-GoobyCommand class is created.  The default filename is 'gooby_config.yaml"'.
-
-The YAML file contains configuration parameters, such as your Google Map key,
-map HTML options, points of interest, and courses.
- 
-=end
-  class Configuration < GoobyObject
-
-    @@singleton_instance = nil
-    
-    attr_reader :yaml_filename, :configuration
-  
-    private_class_method :new
-    
-    def Configuration.init(yaml_filename='gooby_config.yaml')
-      return @@singleton_instance if  @@singleton_instance
-       @@singleton_instance = new(yaml_filename)      
-    end
-    
-    def self.get_config
-      @@singleton_instance
-    end
-    
-    def initialize(yaml_filename) 
-      @yaml_filename = yaml_filename
-      File.open("#{@yaml_filename}") { |fn| @configuration = YAML::load(fn) }
-    end
-    
-    def get(name)    
-      if name == nil
-        return ''
-      end
-      s = @configuration["#{name}"]
-    
-      # Provide "sensible defaults".
-      if s == nil
-        if (name == '') 
-          return ''
-        elsif (name == 'english_metric')  
-          return 'english'
-        elsif (name == 'gmap_first_tkpt_number')  
-          return 1
-        elsif (name == 'gmap_last_tkpt_number')   
-          return 5000
-        elsif (name == 'gmap_map_element_id')     
-          return 'map'  
-        elsif (name == 'gmap_height')             
-          return '600'
-        elsif (name == 'gmap_icon_url_base')             
-          return 'http://www.your-web-site.com/gicons/'          
-        elsif (name == 'gmap_key')                
-          return 'enter your Google Map Key here'       
-        elsif (name == 'gmap_type_control')       
-          return true
-        elsif (name == 'gmap_approx_max_points')  
-          return '200'
-        elsif (name == 'gmap_gen_comments')       
-          return true
-        elsif (name == 'gmap_size_control')       
-          return nil
-        elsif (name == 'gmap_type')               
-          return 'G_NORMAL_MAP'  
-        elsif (name == 'gmap_zoom_level')         
-          return 5 
-        else 
-          return ''
-        end
-      end
-      s
-    end
-
-    def print_all
-      @configuration.keys.sort.each { |key| 
-        value = get(key)
-        puts "#{key}: #{value}" 
-      }
-    end
-
-    def print_all_poi
-      @configuration.keys.sort.each { |key|
-        if (key.match(/poi[\.]/))
-          val = @configuration["#{key}"]
-          poi = Point.new(val)
-          puts poi.to_s
-        end
-      }
-    end
-    
-    def get_poi(number)
-      val = @configuration["poi.#{number}"]
-      (val) ? Point.new(val) : nil
-    end
-    
-    def get_course(number)
-      val = @configuration["course.#{number}"]
-      (val) ? Course.new(val) : nil
-    end
-    
-    def size
-      @configuration.size
-    end
+module GoobyConfiguration
      
-  # Return a String containing yaml filename and entry count.  
-    def to_s
-      return "# Configuration: filename: #{@yaml_filename} entries: #{@configuration.size}"
+  def gooby_home
+    ENV['GOOBY_HOME']
+  end
+       
+  def read_configuration(additional_config_file)
+    
+    # First load the base config file into @configuration
+    base_config_file = "#{gooby_home}/config/gooby_config.yaml"
+    if File.exist?(base_config_file)
+      puts "loading base configuration file #{base_config_file}"
+      File.open(base_config_file) { | f | @configuration = YAML::load(f) }
+    else
+      puts "ERROR: the base configuration file does not exist - #{base_config_file}"
+    end
+    
+    # Optionally load a second map-specific config file and overlay any
+    # values in the base configuration.
+    if (additional_config_file) && (File.exist?(additional_config_file))
+      puts "loading additional configuration file #{additional_config_file}"      
+      File.open(additional_config_file) { | f | @additional_config = YAML::load(f) }
+      @additional_config.keys.each { | key |
+        value = @additional_config[key]
+        @configuration[key] = value
+        # puts "'#{key}' overlaid with '#{value}'"
+      }
+    else
+      puts "ERROR: the additional configuration file does not exist - #{additional_config_file}"
     end
-    
-  end 
-
-end # end of module
+    GoobyBaseObject.set_config(@configuration)
+  end
+  
+end 

data/lib/gooby_counter_hash.rb

@@ -1,95 +1,36 @@
 =begin
 
-Gooby = Google APIs + Ruby
-Gooby - Copyright 2007 by Chris Joakim.
+Gooby = Google APIs + Ruby.  Copyright 2009 by Chris Joakim.
 Gooby is available under GNU General Public License (GPL) license.
 
 =end
 
-module Gooby
-
-=begin rdoc
-  This class wrappers a Hash object and provides increment/decrement functionality 
-  for a given key.  It is used to sum the number of things (i.e. - xml tags) in a 
-  collection.
-=end
-    
-  class CounterHash < GoobyObject
-
-    def initialize
-      @hash = Hash.new(0)  
-    end
-    
-    def size
-      @hash.size
-    end
- 
-  # Return the Integer count for the given key; zero default.  
-    def value(key)   
-      (@hash.has_key?(key)) ? @hash[key] : 0  
-    end
- 
-  # Increment the count for the given key.  
-    def increment(key) 
-      if key == nil
-        return
-      end       
-      if (@hash.has_key?(key)) 
-        val = @hash[key]
-        @hash[key] = val + 1  
-      else
-        @hash[key] = 1
-      end  
-    end
-    
-    def increment_tokens(text)
-      tokens = tokenize(text)
-      tokens.each { |token| increment(token) }
-    end
-
-  # Decrement the count for the given key.  
-    def decrement(key) 
-      if key == nil
-        return
-      end      
-      if (@hash.has_key?(key)) 
-        val = @hash[key]
-        @hash[key] = val - 1
-      else
-        @hash[key] = -1
-      end    
-    end
- 
-  # Return an Array of the sorted keys.  
-    def sorted_keys        
-      @hash.keys.sort
-    end
- 
-  # Return a String containing all key=val pairs.  
-    def to_s               
-      s = "CHash:"
-      sorted_keys.each { |key|
-        val = @hash[key]
-        s << " key: [#{key}] val: [#{val}]\n"
-      }
-      s
-    end
- 
-  # Return an XML String containing all key=val pairs, optionally aligned.  
-    def to_xml(aligned=false)  
-      s = "<CHash>"
-      sorted_keys.each { |key|
-        val = @hash[key]
-        (aligned) ? s << "\n " : s << ''
-        s << " <entry key='#{key}' value='#{val}'/>"
-      }
-      if aligned
-        s << "\n "
-      end    
-      s << " </CHash>"
-      s   
-    end  
+class GoobyCounterHash
+  
+  attr_reader :hash
 
+  def initialize
+    @hash = Hash.new(0)
   end
-
-end # end of module
+  
+  def increment(key)
+    new_value  = @hash[key] + 1
+    @hash[key] = new_value
+    new_value
+  end
+  
+  def decrement(key)
+    new_value  = @hash[key] - 1
+    @hash[key] = new_value
+    new_value
+  end
+  
+  def value(key)
+    @hash[key]
+  end
+  
+  def sorted_keys
+    @hash.keys.sort
+  end
+  
+end

data/lib/gooby_dttm.rb

@@ -1,87 +1,109 @@
 =begin
 
-Gooby = Google APIs + Ruby
-Gooby - Copyright 2007 by Chris Joakim.
+Gooby = Google APIs + Ruby.  Copyright 2009 by Chris Joakim.
 Gooby is available under GNU General Public License (GPL) license.
 
-=end
+---
 
-module Gooby
+Instances of this class represent a Date and Time as parsed from a value 
+such as '2006-01-15T13:41:40Z' in an XML file produced by a GPS device.
+It wrappers a Time object.
 
-=begin rdoc
-  Instances of this class represent a Date and Time as parsed from a value 
-  such as '2006-01-15T13:41:40Z' in an XML file produced by a GPS device.
-  It wrappers both a DateTime and Time object.
 =end
+
+
   
-  class DtTm < GoobyObject  
-    
-    attr_accessor :rawdata, :dateTime, :time, :valid
+class GoobyDtTm < GoobyBaseObject  
   
-  # Constructor; arg is a String like '2006-01-15T13:41:40Z'.  
-    def initialize(raw)  
-      if raw
-        @rawdata = raw.strip
-        if @rawdata.size > 18
-          @date_time = DateTime.parse(@rawdata[0..18])
-          @time  = Time.parse(@date_time.to_s)
-          @valid = true
-        else
-          @valid = false
-        end     
-      else
-        @rawdata = ''
-        @valid   = false          
-      end
-    end
+  @@months = Hash.new('')
   
-    public
- 
-  # Return @time.to_i  
-    def to_i() 
-      (@time) ? @time.to_i : invalid_time
+  attr_accessor :time, :valid
+
+  def lookup_month(m)
+    if @@months.size == 0
+      @@months = Hash.new('') # 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
+      @@months['01'] = 'jan'
+      @@months['02'] = 'feb'
+      @@months['03'] = 'mar'
+      @@months['04'] = 'apr'
+      @@months['05'] = 'may'
+      @@months['06'] = 'jun'     
+      @@months['07'] = 'jul'
+      @@months['08'] = 'aug'
+      @@months['09'] = 'sep'
+      @@months['10'] = 'oct'
+      @@months['11'] = 'nov'
+      @@months['12'] = 'dec'                               
     end
+    @@months[m]
+  end
   
-  # Calculates and returns diff between another instance.  
-    def seconds_diff(anotherDtTm)  
-      if anotherDtTm
-        to_i - anotherDtTm.to_i
-      else
-        invalid_time
+  # The arg is a String like '2006-01-15T13:41:40Z'.
+  def initialize(raw)  
+    @valid = false
+    if raw
+      a = raw.tr('TZ\-\:', ' ').strip.split
+      if a.size > 5
+        @time  = Time.utc(a[0].to_i, lookup_month(a[1]), a[2].to_i, a[3].to_i, a[4].to_i, a[5].to_i)
+        @valid = true if @time
       end
     end
-  
-    def yyyy_mm_dd
-      @time.strftime("%Y-%m-%d")
-    end
-  
-    def yyyy_mm_dd_hh_mm_ss(delim=' ')
-      @time.strftime("%Y-%m-%d#{delim}%H:%M:%S")
-    end
-      
-    def hh_mm_ss
-      @time.strftime("%H:%M:%S")
+  end
+
+  def to_i
+    (@time) ? @time.to_i : invalid_time
+  end
+
+  def invalid_time
+    return -99999999
+  end
+
+  def yyyy_mm_dd
+    time.strftime("%Y-%m-%d")
+  end
+
+  def yyyy_mm_dd_hh_mm_ss(delim=' ')
+    time.strftime("#{yyyy_mm_dd}#{delim}#{hh_mm_ss}")
+  end
+    
+  def hh_mm_ss
+    time.strftime("%H:%M:%S")
+  end
+
+  def seconds_diff(another_dttm)  
+    if another_dttm
+      to_i - another_dttm.to_i
+    else
+      invalid_time
     end
+  end
   
-  # Calculate and return time diff in 'hh:mm:ss' format.
-    def hhmmss_diff(anotherDtTm)  
-      if anotherDtTm  
-        t = @time - (anotherDtTm.to_i)
-        t.strftime("%H:%M:%S")
-      else
-        '00:00:00'  
-      end
+  def hhmmss_diff(another_dttm)  
+    if another_dttm  
+      secs = seconds_diff(another_dttm).abs
+      hh   = (secs / SECONDS_PER_HOUR).to_i
+      rem  = secs - (hh * SECONDS_PER_HOUR)
+      mm   = (rem / 60).to_i
+      ss   = rem - (mm * 60).to_i
+      ss   = 59 if ss > 59
+      "#{hh}:#{zero_pad(mm)}:#{zero_pad(ss.to_i)}"
+    else
+      '00:00:00'  
     end
+  end
+
+  def to_s
+    "#{yyyy_mm_dd} #{hh_mm_ss} #{to_i}"
+  end
   
-    def to_s
-      "#{@rawdata}"
-    end
+  private
   
-  # Return a String with state values for debugging.
-    def print_string  
-      "DtTm: #{yyyy_mm_dd_hh_mm_ss} #{to_i} #{@rawdata}"
+  def zero_pad(val)    
+    if (val.to_i < 10)
+      return '0' + val.to_s
+    else
+      return '' + val.to_s
     end
+  end  
 
-  end
-
-end # end of module
+end