fdc 0.0.3 → 0.0.4

data/lib/fdc.rb

@@ -1,11 +1,6 @@
-# Ruby core and stdlib
-require 'date'
-require 'pathname'
-
-# Gems
-require 'builder'
-
 # Fdc
 require 'fdc/utilities'
 require 'fdc/converter'
-require 'fdc/exceptions'
+require 'fdc/exceptions'
+require 'fdc/parser'
+require 'fdc/compiler'

data/lib/fdc/compiler.rb

@@ -0,0 +1,170 @@
+require 'builder'
+require 'date'
+require 'fdc/parser'
+
+# Compile KML documents from a {Fdc::Parser}
+class Fdc::Compiler
+  
+  # The compiled KML document
+  attr_reader :kml
+  attr_accessor :parser
+  
+  # Create a new instance
+  # 
+  # @param [Fdc::Parser] parser A parser from which the KML document should be compiled.
+  def initialize(parser)
+    @parser = parser
+  end
+  
+  # Compile the KML document from the parsed IGC file.
+  # 
+  # @param [String] track_name The name of the KML track
+  # @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 the supplied parser is not ready
+  def compile(track_name, clamp=false, extrude=false, gps=false)
+    
+    raise RuntimeError, "Parser not ready" unless @parser.ready?
+    
+    # Build HTML for balloon description
+    html = Builder::XmlMarkup.new(:indent => 2)
+    html.div :style => "width: 250;" do
+      html.p do
+        unless @parser.a_record[3].nil? then 
+          html.strong "Device:"
+          html.dfn @parser.a_record[3].strip
+          html.br 
+        end
+      end
+      html.p do
+        @parser.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
+        end
+      
+        html.strong "Date:"
+        html.dfn @parser.date_record[3..5].join(".")
+        html.br
+      end
+    
+      # Manufacturer-dependent L records
+      case @parser.a_record[1]
+      when "XSX"
+        @parser.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
+    
+    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 track_name
+        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.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")
+        
+          @parser.b_records.each do |b_record|
+             time = DateTime.new(2000 + @parser.date_record[5].to_i, @parser.date_record[4].to_i, @parser.date_record[3].to_i, 
+              b_record[1].to_i, b_record[2].to_i, b_record[3].to_i)
+             xml.when time
+          end
+          @parser.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
+      }
+    end
+  
+    @kml = xml.target!
+  end
+  
+  private
+
+  # Generate Snippet tag content
+  def snippet
+    summary = "Flight"
+    @parser.h_records.each do |h|
+      if h.include? "SIT" and not h[2].strip.empty? then 
+        summary << " from #{h[2].strip}" 
+      end
+    end
+    summary << " on #{@parser.date_record[3..5].join(".")}"
+  end
+  
+end

data/lib/fdc/converter.rb

@@ -1,10 +1,11 @@
-require 'date'
 require 'pathname'
-require 'builder'
+
 require 'fdc/utilities'
 require 'fdc/exceptions'
+require 'fdc/parser'
+require 'fdc/compiler'
 
-# Class to convert IGC files to KML.
+# Convert IGC Files to KML
 # 
 # @!attribute [r] kml
 #   @return [String] The KML document
@@ -16,11 +17,14 @@ require 'fdc/exceptions'
 #   converter.export(output/dir)
 class Fdc::Converter
 
-  # FileLoader mixing
+  # Mixins
   include Fdc::FileLoader
-
-  # The compiled KML document
-  attr_reader :kml
+  include Fdc::FileWriter
+  
+  def initialize
+    @parser = Fdc::Parser.new
+    @compiler = Fdc::Compiler.new @parser
+  end
 
   # Load and parse an IGC file from the supplied path.
   # 
@@ -29,9 +33,11 @@ class Fdc::Converter
   # @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")
-  
-    load(file, encoding)
-    parse_file
+    
+    path = Pathname.new(file)
+    load(path, encoding)
+    raise Fdc::FileReadError, "Invalid file extension: #{path.to_s}" unless path.extname == ".igc"
+    @parser.parse @file
   
   end
 
@@ -44,133 +50,11 @@ class Fdc::Converter
   def compile(clamp=false, extrude=false, gps=false)
   
     # 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
-          if h.include? "SIT" and not h[2].strip.empty? then 
-            html.strong "Site:"
-            html.dfn h[2].strip
-            html.br
-          end
-        end
-      
-        html.strong "Date:"
-        html.dfn @date[3..5].join(".")
-        html.br
-      end
+    raise RuntimeError, "Cannot compile without preceding parse" unless @parser.ready?
     
-      # 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
-    
-    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.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
-          @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
-      }
-    end
+    name = @path.basename(@path.extname)
+    @compiler.compile name, clamp, extrude, gps
   
-    @kml = xml.target!
   end
 
   # Export the compiled KML document
@@ -183,77 +67,17 @@ class Fdc::Converter
   def export(dir = nil)
   
     # Assert state
-    raise RuntimeError, "Cannot export before compile was called" unless @kml
+    raise RuntimeError, "Cannot export before compile was called" unless @compiler.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
+    write Pathname.new(dir) + (@path.basename(@path.extname).to_s << ".kml"), @compiler.kml
   
   end
-
-  private
-
-  # 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
-
-  # Parse igc file content
-  def parse_file
-  
-    begin
-  
-      # 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
-  
-  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
-    summary << " on #{@date[3..5].join(".")}"
+  # Get the compiled KML document
+  # @return [String] The compiled KML document
+  def kml
+    @compiler.kml
   end
 
 end

data/lib/fdc/parser.rb

@@ -0,0 +1,65 @@
+# Parse record types from IGC file data
+class Fdc::Parser
+  
+  attr_reader :date_record
+  attr_reader :a_record
+  attr_reader :h_records
+  attr_reader :b_records
+  attr_reader :l_records
+  
+  def initialize
+    @ready = false
+  end
+  
+  # Parse the supplied IGC file content
+  # 
+  # @param [String] igc_file The IGC file content
+  # @raise [Fdc::FileFormatError] If the file format is invalid
+  def parse(igc_file)
+    
+    begin
+      # parse utc date
+      unless @date_record = igc_file.match(REGEX_H_DTE) then
+        @ready = false
+        raise Fdc::FileFormatError, "Invalid file format - header date is missing"
+      end
+  
+      # parse a records
+      unless @a_record = igc_file.match(REGEX_A) then
+        @ready = false
+        raise Fdc::FileFormatError, "Invalid file format" unless @a_record
+      end
+  
+      # parse h records
+      @h_records = igc_file.scan(REGEX_H)
+  
+      # parse b records
+      @b_records = igc_file.scan(REGEX_B)
+  
+      # parse l records
+      @l_records = igc_file.scan(REGEX_L)
+          
+    rescue ArgumentError => e
+      @ready = false
+      raise Fdc::FileFormatError, "Wrong file encoding: #{e.message}"
+    end
+    
+    @ready = true
+    
+  end
+
+  # @return [Boolean] true if {#parse} was successfully called
+  def ready?
+    return @ready
+  end
+  
+  private
+  
+  # Regular expressions for parsing igc records
+  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

data/lib/fdc/utilities.rb

@@ -32,7 +32,7 @@ module Fdc
      
    end
    
-   # Module for file loading
+   # Common file loading operations
    module FileLoader
      
      # Loaded file content
@@ -48,32 +48,51 @@ module Fdc
      
      # Load a file from the supplied path
      # 
-     # @param [String] file The path to the file
+     # @param [Pathname] path 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)
+     def load(path, encoding)
        
-       # The path of the file
-       @path = Pathname.new(file)
-       
-       # The file encoding
+       @path = path
        @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)
+        @file = f.read
        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}"
+       ensure
+         if f then f.close end
        end
-       # The loaded file
-       @file = f.read
-       f.close
      end
      
    end
+   
+   # Common file writing operations
+   module FileWriter
+     
+     private
+     # Write a file to the file system
+     # 
+     # @param [Pathname] path The path for the file
+     # @param [String] data The data of the file
+     # @raise [Fdc::FileWriteError] If dirname is not a directory or write protected
+     def write(path, data)
+       begin
+         file = File.new(path, "w:UTF-8")
+         file.write(data)
+       rescue Errno::EACCES => e
+         raise Fdc::FileWriteError, "Destination is write-protected: #{path.to_s}"
+       rescue Errno::ENOTDIR => e
+         raise Fdc::FileWriteError, "Destination is not a directory: #{path.to_s}"
+       rescue Errno::ENOENT => e
+         raise Fdc::FileWriteError, "Destination does not exist: #{path.to_s}"
+       ensure 
+         if file then file.close end
+       end
+     end
+   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fdc
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -51,8 +51,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/fdc/compiler.rb
 - lib/fdc/converter.rb
 - lib/fdc/exceptions.rb
+- lib/fdc/parser.rb
 - lib/fdc/utilities.rb
 - lib/fdc.rb
 - bin/fdc