fdc 0.0.2 → 0.0.3

data/lib/fdc.rb

@@ -1,4 +1,4 @@
-# Ruby stdlib
+# Ruby core and stdlib
 require 'date'
 require 'pathname'
 

data/lib/fdc/converter.rb

@@ -4,281 +4,256 @@ require 'builder'
 require 'fdc/utilities'
 require 'fdc/exceptions'
 
-module Fdc
+# Class to convert IGC files to KML.
+# 
+# @!attribute [r] kml
+#   @return [String] The KML document
+# 
+# @example
+#   converter = Converter.new
+#   converter.parse(path/to/file.igc)
+#   converter.compile
+#   converter.export(output/dir)
+class Fdc::Converter
 
-  # Class to convert IGC files to KML.
-  # 
-  # @!attribute [r] kml
-  #   @return [String] The KML document
+  # FileLoader mixing
+  include Fdc::FileLoader
+
+  # The compiled KML document
+  attr_reader :kml
+
+  # Load and parse an IGC file from the supplied path.
   # 
-  # @example
-  #   converter = Converter.new
-  #   converter.parse(path/to/file.igc)
-  #   converter.compile
-  #   converter.export(output/dir)
-  class Converter
+  # @param [String] file The path to the IGC file
+  # @param [String] encoding The encoding of the input file
+  # @raise [Fdc::FileReadError] If file could not be loaded
+  # @raise [Fdc::FileFormatError] If the file format is invalid
+  def parse(file, encoding="ISO-8859-1")
   
-    # The compiled KML document
-    attr_accessor :kml
+    load(file, encoding)
+    parse_file
   
-    # Load and parse an IGC file from the supplied path.
-    # 
-    # @param [String] file The path to the IGC file
-    # @param [String] encoding The encoding of the input file
-    # @raise [Fdc::FileReadError] If file could not be loaded
-    # @raise [Fdc::FileFormatError] If the file format is invalid
-    def parse(file, encoding="ISO-8859-1")
-    
-      # Update state
-      @path = Pathname.new(file)
-      @encoding = encoding
-    
-      # Do work
-      load_file
-      parse_file
-    
-    end
+  end
+
+  # Compile the KML document from the parsed IGC file.
+  # 
+  # @param [Boolean] clamp Whether the track should be clamped to the ground
+  # @param [Boolean] extrude Whether the track should be extruded to the ground
+  # @param [Boolean] gps Whether GPS altitude information should be used
+  # @raise [RuntimeError] If {#parse} was not called before
+  def compile(clamp=false, extrude=false, gps=false)
   
-    # Compile the KML document from the parsed IGC file.
-    # 
-    # @param [Boolean] clamp Whether the track should be clamped to the ground
-    # @param [Boolean] extrude Whether the track should be extruded to the ground
-    # @param [Boolean] gps Whether GPS altitude information should be used
-    # @raise [RuntimeError] If {#parse} was not called before
-    def compile(clamp=false, extrude=false, gps=false)
-    
-      # State assertion
-      raise RuntimeError, "Cannot compile before successfull parse" if @igc.nil? or @date.nil?
-    
-      # Build HTML for balloon description
-      html = Builder::XmlMarkup.new(:indent => 2)
-      html.div :style => "width: 250;" do
-        html.p do
-          unless @a_records[3].nil? then 
-            html.strong "Device:"
-            html.dfn @a_records[3].strip
+    # State assertion
+    raise RuntimeError, "Cannot compile before successfull parse" if @file.nil? or @date.nil?
+  
+    # Build HTML for balloon description
+    html = Builder::XmlMarkup.new(:indent => 2)
+    html.div :style => "width: 250;" do
+      html.p do
+        unless @a_records[3].nil? then 
+          html.strong "Device:"
+          html.dfn @a_records[3].strip
+          html.br 
+        end
+      end
+      html.p do
+        @h_records.each do |h|
+          if h.include? "PLT" and not h[2].strip.empty? then 
+            html.strong "Pilot:"
+            html.dfn h[2].strip
+            html.br
+          end
+          if h.include? "CID" and not h[2].strip.empty? then 
+            html.strong "Competition ID:"
+            html.dfn h[2].strip
+            html.br
+          end
+          if h.include? "GTY" and not h[2].strip.empty? then 
+            html.strong "Glider:"
+            html.dfn h[2].strip
+            html.br
+          end
+          if h.include? "GID" and not h[2].strip.empty? then
+            html.strong "Glider ID:"
+            html.dfn h[2].strip
+            html.br
+          end
+          if h.include? "CCL" and not h[2].strip.empty? then 
+            html.strong "Competition class:"
+            html.dfn h[2].strip
             html.br 
           end
-        end
-        html.p do
-          @h_records.each do |h|
-            if h.include? "PLT" and not h[2].strip.empty? then 
-              html.strong "Pilot:"
-              html.dfn h[2].strip
-              html.br
-            end
-            if h.include? "CID" and not h[2].strip.empty? then 
-              html.strong "Competition ID:"
-              html.dfn h[2].strip
-              html.br
-            end
-            if h.include? "GTY" and not h[2].strip.empty? then 
-              html.strong "Glider:"
-              html.dfn h[2].strip
-              html.br
-            end
-            if h.include? "GID" and not h[2].strip.empty? then
-              html.strong "Glider ID:"
-              html.dfn h[2].strip
-              html.br
-            end
-            if h.include? "CCL" and not h[2].strip.empty? then 
-              html.strong "Competition class:"
-              html.dfn h[2].strip
-              html.br 
-            end
-            if h.include? "SIT" and not h[2].strip.empty? then 
-              html.strong "Site:"
-              html.dfn h[2].strip
-              html.br
-            end
+          if h.include? "SIT" and not h[2].strip.empty? then 
+            html.strong "Site:"
+            html.dfn h[2].strip
+            html.br
           end
-        
-          html.strong "Date:"
-          html.dfn @date[3..5].join(".")
-          html.br
         end
       
-        # Manufacturer-dependent L records
-        case @a_records[1]
-        when "XSX"
-          @l_records.each do |l|
-            if matches = l[1].scan(/(\w*):(-?\d+.?\d+)/) then 
-              html.p do
-                matches.each do |match|
-                  case match[0]
-                  when "MC"
-                    html.strong "Max. climb:"
-                    html.dfn match[1] << " m/s"
-                    html.br
-                  when "MS"
-                    html.strong "Max. sink:"
-                    html.dfn match[1] << " m/s"
-                    html.br
-                  when "MSP"
-                    html.strong "Max. speed:"
-                    html.dfn match[1] << " km/h"
-                    html.br
-                  when "Dist"
-                    html.strong "Track distance:"
-                    html.dfn match[1] << " km"
-                    html.br
-                  end
+        html.strong "Date:"
+        html.dfn @date[3..5].join(".")
+        html.br
+      end
+    
+      # Manufacturer-dependent L records
+      case @a_records[1]
+      when "XSX"
+        @l_records.each do |l|
+          if matches = l[1].scan(/(\w*):(-?\d+.?\d+)/) then 
+            html.p do
+              matches.each do |match|
+                case match[0]
+                when "MC"
+                  html.strong "Max. climb:"
+                  html.dfn match[1] << " m/s"
+                  html.br
+                when "MS"
+                  html.strong "Max. sink:"
+                  html.dfn match[1] << " m/s"
+                  html.br
+                when "MSP"
+                  html.strong "Max. speed:"
+                  html.dfn match[1] << " km/h"
+                  html.br
+                when "Dist"
+                  html.strong "Track distance:"
+                  html.dfn match[1] << " km"
+                  html.br
                 end
               end
             end
           end
         end
-      
       end
     
-      # Build KML
-      xml = Builder::XmlMarkup.new(:indent => 2)
-      xml.instruct!
-      xml.kml "xmlns" => "http://www.opengis.net/kml/2.2", "xmlns:gx" => "http://www.google.com/kml/ext/2.2" do
-        xml.Placemark {
-          xml.name @path.basename(@path.extname)
-          xml.Snippet :maxLines => "2" do
-            xml.text! snippet
+    end
+  
+    # Build KML
+    xml = Builder::XmlMarkup.new(:indent => 2)
+    xml.instruct!
+    xml.kml "xmlns" => "http://www.opengis.net/kml/2.2", "xmlns:gx" => "http://www.google.com/kml/ext/2.2" do
+      xml.Placemark {
+        xml.name @path.basename(@path.extname)
+        xml.Snippet :maxLines => "2" do
+          xml.text! snippet
+        end
+        xml.description do
+          xml.cdata! html.target!
+        end
+        xml.Style do
+          xml.IconStyle do
+            xml.Icon do 
+              xml.href "http://earth.google.com/images/kml-icons/track-directional/track-0.png"
+            end
           end
-          xml.description do
-            xml.cdata! html.target!
+          xml.LineStyle do
+            xml.color "99ffac59"
+            xml.width "4"
           end
-          xml.Style do
-            xml.IconStyle do
-              xml.Icon do 
-                xml.href "http://earth.google.com/images/kml-icons/track-directional/track-0.png"
-              end
-            end
-            xml.LineStyle do
-              xml.color "99ffac59"
-              xml.width "4"
-            end
+        end
+        xml.gx:Track do
+        
+          clamp ? xml.altitudeMode("clampToGround") : xml.altitudeMode("absolute")
+          extrude ? xml.extrude("1") : xml.extrude("0")
+        
+          @b_records.each do |b_record|
+             time = DateTime.new(2000 + @date[5].to_i, @date[4].to_i, @date[3].to_i, 
+              b_record[1].to_i, b_record[2].to_i, b_record[3].to_i)
+             xml.when time
           end
-          xml.gx:Track do
-          
-            clamp ? xml.altitudeMode("clampToGround") : xml.altitudeMode("absolute")
-            extrude ? xml.extrude("1") : xml.extrude("0")
-          
-            @b_records.each do |b_record|
-               time = DateTime.new(2000 + @date[5].to_i, @date[4].to_i, @date[3].to_i, 
-                b_record[1].to_i, b_record[2].to_i, b_record[3].to_i)
-               xml.when time
-            end
-            @b_records.each do |b_record|
-              coords = Fdc::GeoLocation.to_dec(b_record[5], b_record[4])
-              gps ? coords << b_record[8].to_f : coords << b_record[7].to_f
-              xml.gx :coord, coords.join(" ")
-            end
+          @b_records.each do |b_record|
+            coords = Fdc::GeoLocation.to_dec(b_record[5], b_record[4])
+            gps ? coords << b_record[8].to_f : coords << b_record[7].to_f
+            xml.gx :coord, coords.join(" ")
           end
-        }
-      end
-    
-      @kml = xml.target!
+        end
+      }
     end
   
-    # Export the compiled KML document
-    # 
-    # @param [String] dir The alternative output directory. 
-    #   If nothing is supplied the files are written to the same location 
-    #   as the IGC input file.
-    # @raise [RuntimeError] If {#parse} and {#compile} were not called before
-    # @raise [Fdc::FileWriteError] If dirname is not a directory or write protected
-    def export(dir = nil)
-    
-      # Assert state
-      raise RuntimeError, "Cannot export before compile was called" unless @kml
-    
-      dir = @path.dirname.to_s unless dir
-    
-      # Create Pathname for easier handling
-      dest = Pathname.new(dir)
-    
-      # Create output file name
-      dest += @path.basename(@path.extname)
-    
-      begin
-        file = File.new(dest.to_s << ".kml", "w:UTF-8")
-      rescue Errno::EACCES => e
-        raise Fdc::FileWriteError, "Destination is write-protected: #{dir.to_s}"
-      rescue Errno::ENOTDIR => e
-        raise Fdc::FileWriteError, "Destination is not a directory: #{dir.to_s}"
-      rescue Errno::ENOENT => e
-        raise Fdc::FileWriteError, "Destination does not exist: #{dir.to_s}"
-      end
-    
-      file.write(@kml)
-      file.close
-    
+    @kml = xml.target!
+  end
+
+  # Export the compiled KML document
+  # 
+  # @param [String] dir The alternative output directory. 
+  #   If nothing is supplied the files are written to the same location 
+  #   as the IGC input file.
+  # @raise [RuntimeError] If {#parse} and {#compile} were not called before
+  # @raise [Fdc::FileWriteError] If dirname is not a directory or write protected
+  def export(dir = nil)
+  
+    # Assert state
+    raise RuntimeError, "Cannot export before compile was called" unless @kml
+  
+    dir = @path.dirname.to_s unless dir
+  
+    # Create Pathname for easier handling
+    dest = Pathname.new(dir)
+  
+    # Create output file name
+    dest += @path.basename(@path.extname)
+  
+    begin
+      file = File.new("#{dest.to_s}.kml", "w:UTF-8")
+    rescue Errno::EACCES => e
+      raise Fdc::FileWriteError, "Destination is write-protected: #{dir.to_s}"
+    rescue Errno::ENOTDIR => e
+      raise Fdc::FileWriteError, "Destination is not a directory: #{dir.to_s}"
+    rescue Errno::ENOENT => e
+      raise Fdc::FileWriteError, "Destination does not exist: #{dir.to_s}"
     end
   
-    private
+    file.write(@kml)
+    file.close
   
-    # Load igc file from supplied path
-    def load_file
-
-      raise Fdc::FileReadError, "Invalid file extension: #{@path.to_s}" unless @path.extname == ".igc"
+  end
 
-      # Load file
-      begin
-       file = File.new(@path, "r", :encoding => @encoding)
-      rescue Errno::EISDIR => e
-       raise Fdc::FileReadError, "Input file is a directory: #{@path.to_s}"
-      rescue Errno::ENOENT => e
-       raise Fdc::FileReadError, "Input file does not exist: #{@path.to_s}"
-      end
+  private
 
-      @igc = file.read
-      file.close
+  # Regular expressions for file parsing
+  REGEX_A = /^[a]([a-z\d]{3})([a-z\d]{3})?(.*)$/i
+  REGEX_H = /^[h][f|o|p]([\w]{3})(.*):(.*)$/i
+  REGEX_H_DTE = /^hf(dte)((\d{2})(\d{2})(\d{2}))/i
+  REGEX_B = /^(B)(\d{2})(\d{2})(\d{2})(\d{7}[NS])(\d{8}[EW])([AV])(\d{5})(\d{5})/
+  REGEX_L = /^l([a-z0-9]{3}|[plt]|[pfc])(.*)/i
 
-    end
+  # Parse igc file content
+  def parse_file
   
-    # Regular expressions for file parsing
-    REGEX_A = /^[a]([a-z\d]{3})([a-z\d]{3})?(.*)$/i
-    REGEX_H = /^[h][f|o|p]([\w]{3})(.*):(.*)$/i
-    REGEX_H_DTE = /^hf(dte)((\d{2})(\d{2})(\d{2}))/i
-    REGEX_B = /^(B)(\d{2})(\d{2})(\d{2})(\d{7}[NS])(\d{8}[EW])([AV])(\d{5})(\d{5})/
-    REGEX_L = /^l([a-z0-9]{3}|[plt]|[pfc])(.*)/i
+    begin
   
-    # Parse igc file content
-    def parse_file
-    
-      begin
-    
-        # parse utc date
-        @date = @igc.match(REGEX_H_DTE)
-        raise Fdc::FileFormatError, "Invalid file format - header date is missing: #{@path.to_s}" unless @date
-    
-        # parse a records
-        @a_records = @igc.match(REGEX_A)
-        raise Fdc::FileFormatError, "Invalid file format: #{@path.to_s}" unless @a_records
-    
-        # parse h records
-        @h_records = @igc.scan(REGEX_H)
-    
-        # parse b records
-        @b_records = @igc.scan(REGEX_B)
-    
-        # parse l records
-        @l_records = @igc.scan(REGEX_L)
-    
-      rescue ArgumentError => e
-        raise Fdc::FileFormatError, "Wrong file encoding: #{e.message}"
-      end
-    
+      # parse utc date
+      @date = @file.match(REGEX_H_DTE)
+      raise Fdc::FileFormatError, "Invalid file format - header date is missing: #{@path.to_s}" unless @date
+  
+      # parse a records
+      @a_records = @file.match(REGEX_A)
+      raise Fdc::FileFormatError, "Invalid file format: #{@path.to_s}" unless @a_records
+  
+      # parse h records
+      @h_records = @file.scan(REGEX_H)
+  
+      # parse b records
+      @b_records = @file.scan(REGEX_B)
+  
+      # parse l records
+      @l_records = @file.scan(REGEX_L)
+  
+    rescue ArgumentError => e
+      raise Fdc::FileFormatError, "Wrong file encoding: #{e.message}"
     end
   
-    # Generate Snippet tag content
-    def snippet
-      summary = "Flight"
-      @h_records.each do |h|
-        if h.include? "SIT" and not h[2].strip.empty? then 
-          summary << " from #{h[2].strip}" 
-        end
+  end
+
+  # Generate Snippet tag content
+  def snippet
+    summary = "Flight"
+    @h_records.each do |h|
+      if h.include? "SIT" and not h[2].strip.empty? then 
+        summary << " from #{h[2].strip}" 
       end
-      summary << " on #{@date[3..5].join(".")}"
     end
-  
+    summary << " on #{@date[3..5].join(".")}"
   end
-  
+
 end

data/lib/fdc/utilities.rb

@@ -1,7 +1,10 @@
-# Utility classes used by {IGCConverter}
+require 'pathname'
+require 'fdc/exceptions'
+
+# Utility modules used by {Fdc::Converter}
 module Fdc
   
-   # Module with helper functions for geocoordinate conversion
+   # Helper functions for geocoordinate conversion
    module GeoLocation
 
      # Convert geocoordinates from mindec notation of IGC to dec notation
@@ -28,5 +31,49 @@ module Fdc
      end
      
    end
+   
+   # Module for file loading
+   module FileLoader
+     
+     # Loaded file content
+     attr_reader :file
+     
+     # Loaded file path
+     attr_reader :path
+     
+     # Loaded file encoding
+     attr_reader :encoding
+     
+     private
+     
+     # Load a file from the supplied path
+     # 
+     # @param [String] file The path to the file
+     # @param [String] encoding The encoding of the file
+     # @raise [Fdc::FileReadError] If file could not be loaded
+     def load(file, encoding)
+       
+       # The path of the file
+       @path = Pathname.new(file)
+       
+       # The file encoding
+       @encoding = encoding
+       
+       raise Fdc::FileReadError, "Invalid file extension: #{@path.to_s}" unless @path.extname == ".igc"
+
+       # Load file
+       begin
+        f = File.new(@path, "r", :encoding => @encoding)
+       rescue Errno::EISDIR => e
+        raise Fdc::FileReadError, "Input file is a directory: #{@path.to_s}"
+       rescue Errno::ENOENT => e
+        raise Fdc::FileReadError, "Input file does not exist: #{@path.to_s}"
+       end
+       # The loaded file
+       @file = f.read
+       f.close
+     end
+     
+   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fdc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000 Z
+date: 2012-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -81,3 +81,4 @@ signing_key:
 specification_version: 3
 summary: Convert flight data format files (IGC) to keyhole markup language (KML)
 test_files: []
+has_rdoc: