jeti-log 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38361a302d8cd7e19d45e89e48e8d5af3f686a41
-  data.tar.gz: 7deb13061c54865fe749dd77228da253e5b8078a
+  metadata.gz: 158deb9294114c12180cf33b96f0647c6d17caf3
+  data.tar.gz: c55a6188529118570b4e1e2e7a0abe9d2c104fa9
 SHA512:
-  metadata.gz: 84298116c3e25340210dbeff80248da90d3f599a70a87df7fa52f89de1b6c54060af4b4ca8451a7a92694cdd6ba908d433116381e89333e0413249657b4c77c3
-  data.tar.gz: 83f65303d59422265e7564ec15b803552a034a0b2104f1f66bfa2ac67d95c1fddcf450f15d8e8bdf828588838c21344d4634a6fc0788fe3c6bbf35b801b12843
+  metadata.gz: ee311d71497959b42d29dc478ea3401b01a44617fdbbcf9fed02dbbc18fff4d7c8c703f8d9cdee2668d68686034323762fe570ec3178492d004233a3ec24732d
+  data.tar.gz: 2d6a18756da1256761b7fc24d65f1f9a614d09b13a828c225b32b22f36023bac0d71e5e95d8fc910e4678311a8ba80e1715460cc88f5038de99793a90083a9af

data/lib/jeti/log/file.rb

@@ -1,4 +1,5 @@
 require 'open-uri'
+require 'ruby_kml'
 
 module Jeti; module Log;
 
@@ -94,8 +95,98 @@ module Jeti; module Log;
      @mgps_locations ||= build_mgps_locations
     end
 
+    # Determines if KML methods can be called for this session.
+    #
+    # @return [Boolean] true if KML can be generated for this session, false otherwise
+    def to_kml?
+      mgps_locations?
+    end
+
+    # Converts the session into a KML document containing a placemark.
+    #
+    # @param file_options [Hash] hash containing options for file
+    # @param placemark_options [Hash] hash containing options for placemark
+    # @return [String] KML document for the session
+    # @see #to_kml_file file options
+    # @see #to_kml_placemark placemark options
+    def to_kml(file_options = {}, placemark_options = {})
+      raise RuntimeError, 'No coordinates available for KML generation' unless to_kml?
+      to_kml_file(file_options, placemark_options).render
+    end
+
+    # Converts the session into a KMLFile containing a placemark.
+    #
+    # @param file_options [Hash] hash containing options for file
+    # @option file_options [String] :name name option of KML::Document
+    # @option file_options [String] :description name option of KML::Document
+    # @option file_options [String] :style_id id option of KML::Style
+    # @param placemark_options [Hash] hash containing options for placemark
+    # @return [KMLFile] file for the session
+    # @see #to_kml_placemark placemark options
+    def to_kml_file(file_options = {}, placemark_options = {})
+      raise RuntimeError, 'No coordinates available for KML generation' unless to_kml?
+      options = apply_default_file_options(file_options)
+
+      kml = KMLFile.new
+      kml.objects << KML::Document.new(
+          :name => options[:name],
+          :description => options[:description],
+          :styles => [
+              KML::Style.new(
+                  :id => options[:style_id],
+                  :line_style => KML::LineStyle.new(:color => '7F00FFFF', :width => 4),
+                  :poly_style => KML::PolyStyle.new(:color => '7F00FF00')
+              )
+          ],
+          :features => [ to_kml_placemark(placemark_options) ]
+      )
+      kml
+    end
+
+    # Converts the session into a KML::Placemark containing GPS coordinates.
+    #
+    # @param options [Hash] hash containing options for placemark
+    # @option options [String] :altitude_mode altitude_mode option of KML::LineString
+    # @option options [Boolean] :extrude extrude option of KML::LineString
+    # @option options [String] :name name option of KML::Placemark
+    # @option options [String] :style_url style_url option of KML::Placemark
+    # @option options [Boolean] :tessellate tessellate option of KML::LineString
+    # @return [KML::Placemark] placemark for the session
+    def to_kml_placemark(options = {})
+      raise RuntimeError, 'No coordinates available for KML generation' unless to_kml?
+      options = apply_default_placemark_options(options)
+
+      coords = mgps_locations.map { |l| [l[1][:longitude], l[1][:latitude], l[1][:altitude]] }
+      KML::Placemark.new(
+          :name => options[:name],
+          :style_url => options[:style_url],
+          :geometry => KML::LineString.new(
+              :altitude_mode => options[:altitude_mode],
+              :extrude => options[:extrude],
+              :tessellate => options[:tessellate],
+              :coordinates => coords.map { |c| c.join(',') }.join(' ')
+          )
+      )
+    end
+
     private
 
+    def apply_default_file_options options
+      options = { :name => 'Jeti MGPS Path' }.merge(options)
+      options = { :description => 'Session paths for GPS log data' }.merge(options)
+      options = { :style_id => 'default-poly-style' }.merge(options)
+      options
+    end
+
+    def apply_default_placemark_options options
+      options = { :altitude_mode => 'absolute' }.merge(options)
+      options = { :extrude => true }.merge(options)
+      options = { :name => "Session (#{duration.round(1)}s)" }.merge(options)
+      options = { :style_url => '#default-poly-style' }.merge(options)
+      options = { :tessellate => true }.merge(options)
+      options
+    end
+
     def build_mgps_locations
       lats = build_value_dataset('MGPS', 'Latitude')
       lons = build_value_dataset('MGPS', 'Longitude')

data/lib/jeti/log/version.rb

@@ -1,5 +1,5 @@
 module Jeti
   module Log
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/spec/file_spec.rb

@@ -52,6 +52,14 @@ describe Jeti::Log::File do
 
     its(:mgps_locations?) { should be_false }
 
+    its(:to_kml?) { should be_false }
+
+    specify { expect { subject.to_kml }.to raise_error }
+
+    specify { expect { subject.to_kml_file }.to raise_error }
+
+    specify { expect { subject.to_kml_placemark }.to raise_error }
+
   end
 
   context 'with data file gps-crash.log' do
@@ -129,6 +137,20 @@ describe Jeti::Log::File do
       expect(loc[1][:course]).to eql(0)
     end
 
+    its(:to_kml?) { should be_true }
+
+    its(:to_kml) { should be_a(String) }
+
+    its(:to_kml_file) { should be_a(KMLFile) }
+
+    it 'should take options for file and placemark' do
+      kml = subject.to_kml_file({ :name => 'File Name' }, { :name => 'Placemark Name' })
+      kml.objects[0].name.should eql('File Name')
+      kml.objects[0].features[0].name.should eql('Placemark Name')
+    end
+
+    its(:to_kml_placemark) { should be_a(KML::Placemark) }
+
   end
 
   it 'should raise for invalid or missing files' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeti-log
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick Veys