jeti-log 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04da93b8a9eabaf8b587c469631301aae286f207
-  data.tar.gz: ca2a8bca18917c71bf88541e41812e3bbcbd7e55
+  metadata.gz: de49fe101044ddafde5ef329ef51cafa420d3be5
+  data.tar.gz: b002d696dd02ae2e55ce77e8bee898f4d1e14300
 SHA512:
-  metadata.gz: 25a3bcee62b232c6eec9e18a52e4a90d79d123986df5a953dda412a6f402175f2255606c75bd866cde5ffd8a9fd07a563225b0cf8cdb87302a2b6544a3fb205a
-  data.tar.gz: 3a589b209b0f5733b4b18741477accdf875fe8d699ecee6a034cbf970fed0cd79de70dea70f5d8b3483d80c54da86d8183db882b9d2439aeaaa34ec662c148e8
+  metadata.gz: c7336c1217fb00756ac9eaad2dae1a37235e521f990ed8c5234ba901ebb864b158b19f3e50527e4c1c2e9ae1f5c2b27050ea17eb70c04126fbab710c19eae126
+  data.tar.gz: 56b6bd68b68c69ede250932309c8bc6763cf13787652b7ab50b4cdaac548b1ce6e3d2cd17da9f9ebe0202041a2a8b21b547ceea112e333540702043e3b1d8afb

data/.rspec

@@ -1 +1,2 @@
 --color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -1,6 +1,7 @@
 rvm:
- - 1.9.3
- - 2.0.0
+ - 2.1.10
+ - 2.2.5
+ - 2.3.1
 
 notifications:
  disabled: true

data/Rakefile

@@ -1,6 +1,11 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
-task :default => :spec
+task default: :spec
+
+if ENV['GENERATE_REPORTS'] == 'true'
+  require 'ci/reporter/rake/rspec'
+  task spec: 'ci:setup:rspec'
+end

data/jeti-log.gemspec

@@ -4,28 +4,33 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jeti/log/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jeti-log"
+  spec.name          = 'jeti-log'
   spec.version       = Jeti::Log::VERSION
-  spec.authors       = ["Nick Veys"]
-  spec.email         = ["nick@codelever.com"]
+  spec.authors       = ['Nick Veys']
+  spec.email         = ['nick@codelever.com']
   spec.description   = %q{Read and interpret Jeti telemetry log files.}
   spec.summary       = %q{Jeti telemetry log file reader}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.homepage      = 'http://github.com/code-lever/jeti-log'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'ci_reporter', '= 1.8.4'
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'ci_reporter_rspec', '~> 1.0'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'rspec-collection_matchers'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-checkstyle_formatter'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-gem-adapter'
   spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'yard'
 
   spec.add_dependency 'ruby_kml', '~> 0.1'
 end

data/lib/jeti/log/data/composite_dataset_builder.rb

@@ -1,20 +1,12 @@
-module Jeti; module Log; module Data;
+module Jeti; module Log; module Data
 
   class CompositeDatasetBuilder
 
     def self.build(file, clazz, device, primary, *others)
-      primaries = if primary.is_a? Array
-                    file.value_dataset(device, primary[0], primary[1])
-                  else
-                    file.value_dataset(device, primary)
-                  end
+      primaries = file.value_dataset(device, primary)
 
       other_data = others.map do |other|
-        if other.is_a? Array
-          file.value_dataset(device, other[0], other[1])
-        else
-          file.value_dataset(device, other)
-        end
+        file.value_dataset(device, other)
       end
 
       primaries.map do |raw|

data/lib/jeti/log/data/mezon_data.rb

@@ -1,4 +1,4 @@
-module Jeti; module Log; module Data;
+module Jeti; module Log; module Data
 
   class MezonData
 
@@ -33,10 +33,8 @@ module Jeti; module Log; module Data;
   class MezonDataBuilder
 
     def self.build(file)
-      div10 = ->(val) { val / 10.0 }
-      CompositeDatasetBuilder.build(file, MezonData, /Mezon/i, [/U Battery/, div10],
-                                    /I Battery/, [/U BEC/, div10], /I BEC/, /Capacity/,
-                                    /Revolution/, /Temp/, /Run Time/, /PWM/)
+      CompositeDatasetBuilder.build(file, MezonData, /Mezon/i, /U Battery/, /I Battery/,
+        /U BEC/, /I BEC/, /Capacity/, /Revolution/, /Temp/, /Run Time/, /PWM/)
     end
 
   end

data/lib/jeti/log/data/mgps_data.rb

@@ -1,4 +1,4 @@
-module Jeti; module Log; module Data;
+module Jeti; module Log; module Data
 
   class MGPSData
 

data/lib/jeti/log/data/mui_data.rb

@@ -1,4 +1,4 @@
-module Jeti; module Log; module Data;
+module Jeti; module Log; module Data
 
   class MuiData
 
@@ -19,9 +19,7 @@ module Jeti; module Log; module Data;
   class MuiDataBuilder
 
     def self.build(file)
-      div10 = ->(val) { val / 10.0 }
-      CompositeDatasetBuilder.build(file, MuiData, /MUI/, [/Voltage/, div10],
-                                    [/Current/, div10], /Capacity/, /Run time/)
+      CompositeDatasetBuilder.build(file, MuiData, /MUI/, /Voltage/, /Current/, /Capacity/, /Run time/)
     end
 
   end

data/lib/jeti/log/data/rx_data.rb

@@ -1,4 +1,4 @@
-module Jeti; module Log; module Data;
+module Jeti; module Log; module Data
 
   class RxData
 
@@ -19,8 +19,7 @@ module Jeti; module Log; module Data;
   class RxDataBuilder
 
     def self.build(file)
-      div100 = ->(val) { val / 100.0 }
-      CompositeDatasetBuilder.build(file, RxData, /Rx/, [/U Rx/, div100], /A1/, /A2/, /Q/)
+      CompositeDatasetBuilder.build(file, RxData, /Rx/, /U Rx/, /A1/, /A2/, /Q/)
     end
 
   end

data/lib/jeti/log/data/tx_data.rb

@@ -1,4 +1,4 @@
-module Jeti; module Log; module Data;
+module Jeti; module Log; module Data
 
   class TxData
 

data/lib/jeti/log/entry.rb

@@ -1,4 +1,4 @@
-module Jeti; module Log;
+module Jeti; module Log
 
   class Entry
 
@@ -24,7 +24,7 @@ module Jeti; module Log;
       raw = detail(sensor_id)
       case raw[1]
       when '0','1','4','8'
-        raw[3].to_i
+        format_float(raw[2].to_i, raw[3].to_i)
       when '5'
         min = (raw[3].to_i & 0xFF00) >> 8
         sec = (raw[3].to_i & 0x00FF)
@@ -56,6 +56,13 @@ module Jeti; module Log;
       degrees * (((dec >> 1) & 1) == 1 ? -1 : 1)
     end
 
-  end
+    def format_float(factor, val)
+      if val > 0xFFFFFF
+        # negative values
+        val = val - 0xFFFFFFFF
+      end
 
+      val * (10 ** -factor)
+    end
+  end
 end; end

data/lib/jeti/log/file.rb

@@ -1,214 +1,230 @@
 require 'open-uri'
 require 'ruby_kml'
 
-module Jeti; module Log;
+module Jeti
 
-  class File
+  module Log
 
-    attr_reader :name
+    class File
 
-    # Determines if the file at the given URI is a Jeti telemetry log file.
-    #
-    # @param uri URI to file to read
-    # @return [Jeti::Log::File] loaded file if the file is a Jeti log file, nil otherwise
-    def self.jeti?(uri)
-      File.new(uri) rescue nil
-    end
+      attr_reader :name
+
+      # Determines if the file at the given URI is a Jeti telemetry log file.
+      #
+      # @param uri URI to file to read
+      # @return [Jeti::Log::File] loaded file if the file is a Jeti log file, nil otherwise
+      def self.jeti?(uri)
+        File.new(uri) rescue nil
+      end
 
-    def initialize(uri)
+      def initialize(uri)
 
-      open(uri, 'rb') do |file|
-        lines = file.readlines.map(&:strip).group_by do |line|
-          line.start_with?('#') ? :comments : :rows
-        end
-        @name = /^#(.*)/.match(lines.fetch(:comments, ['# Unknown']).first)[1].strip
-
-        @headers = []
-        @entries = []
-        lines[:rows].each_with_object(';').map(&:split).each do |line|
-          if '000000000' == line.first
-            if line.length == 4
-              line << ''
-            elsif line.length == 5
-              # do nothing
+        open(uri, 'rb') do |file|
+          lines = file.readlines.map(&:strip).group_by do |line|
+            line.start_with?('#') ? :comments : :rows
+          end
+          @name = /^#(.*)/.match(lines.fetch(:comments, ['# Unknown']).first)[1].strip
+
+          @headers = []
+          @entries = []
+          lines[:rows].each_with_object(';').map(&:split).each do |line|
+            if '000000000' == line.first
+              if line.length == 4
+                line << ''
+              elsif line.length == 5
+                # do nothing
+              else
+                raise RuntimeError, "Unexpected header length (#{line.length})"
+              end
+              @headers << Header.new(line[0], line[1], line[2..4])
             else
-              raise RuntimeError, "Unexpected header length (#{line.length})"
+              @entries << Entry.new(line[0], line[1], line[2..-1])
             end
-            @headers << Header.new(line[0], line[1], line[2..4])
-          else
-            @entries << Entry.new(line[0], line[1], line[2..-1])
           end
+
+          raise RuntimeError, 'No headers found in log file' if @headers.empty?
+          raise RuntimeError, 'No entries found in log file' if @entries.empty?
         end
 
-        raise RuntimeError, 'No headers found in log file' if @headers.empty?
-        raise RuntimeError, 'No entries found in log file' if @entries.empty?
+      rescue => e
+        raise ArgumentError, "File does not appear to be a Jeti log (#{e})"
       end
 
-    rescue => e
-      raise ArgumentError, "File does not appear to be a Jeti log (#{e})"
-    end
-
-    # Gets the duration of the session, in seconds.
-    #
-    # @return [Float] duration of the session, in seconds
-    def duration
-      (@entries.last.time - @entries.first.time) / 1000.0
-    end
+      # Gets the duration of the session, in seconds.
+      #
+      # @return [Float] duration of the session, in seconds
+      def duration
+        (@entries.last.time - @entries.first.time) / 1000.0
+      end
 
-    def mgps_data?
-      device_present?(/MGPS/)
-    end
+      def mgps_data?
+        device_present?(/MGPS/)
+      end
 
-    def mgps_data
-     @mgps_data ||= Data::MGPSDataBuilder.build(self)
-    end
+      def mgps_data
+        @mgps_data ||= Data::MGPSDataBuilder.build(self)
+      end
 
-    def mezon_data?
-      device_present?(/Mezon/i)
-    end
+      def mezon_data?
+        device_present?(/Mezon/i)
+      end
 
-    def mezon_data
-      @mezon_data ||= Data::MezonDataBuilder.build(self)
-    end
+      def mezon_data
+        @mezon_data ||= Data::MezonDataBuilder.build(self)
+      end
 
-    def mui_data?
-      device_present?(/MUI/)
-    end
+      def mui_data?
+        device_present?(/MUI/)
+      end
 
-    def mui_data
-      @mui_data ||= Data::MuiDataBuilder.build(self)
-    end
+      def mui_data
+        @mui_data ||= Data::MuiDataBuilder.build(self)
+      end
 
-    def rx_data?
-      device_present?(/Rx/)
-    end
+      def rx_data?
+        device_present?(/Rx/)
+      end
 
-    def rx_data
-      @rx_data ||= Data::RxDataBuilder.build(self)
-    end
+      def rx_data
+        @rx_data ||= Data::RxDataBuilder.build(self)
+      end
 
-    def tx_data?
-      device_present?(/Tx/)
-    end
+      def tx_data?
+        device_present?(/Tx/)
+      end
 
-    def tx_data
-      @tx_data ||= Data::TxDataBuilder.build(self)
-    end
+      def tx_data
+        @tx_data ||= Data::TxDataBuilder.build(self)
+      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_data?
-    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_data?
+      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 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')
-              )
+      # 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
+          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_data.map { |l| [l.longitude, l.latitude, l.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(' ')
+      # 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_data.map { |l| [l.longitude, l.latitude, l.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
+        )
+      end
 
-    def value_dataset(device, sensor, modifier = ->(val) { val })
-      headers, entries = headers_and_entries_for_device(device)
-      sensor_id = (headers.select { |h| sensor =~ h.name })[0].sensor_id
-      entries.reject! { |e| e.detail(sensor_id).nil? }
-      entries.map { |e| [e.time, modifier.call(e.value(sensor_id))] }
-    end
+      def value_dataset(device, sensor)
+        headers, entries = headers_and_entries_for_device(device)
+        sensor_id = (headers.select { |h| sensor =~ h.name })[0].sensor_id
+        entries.reject! { |e| e.detail(sensor_id).nil? }
+        entries.map { |e| [e.time, e.value(sensor_id)] }
+      end
 
-    private
+      def headers(id = nil)
+        return @headers if id.nil?
+        return @headers.select { |h| h.id == id }
+      end
 
-    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 device_present?(device)
+        @headers.any? { |h| device =~ h.name }
+        # XXX improve, make sure there are entries
+      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 sensor_present?(device, sensor)
+        headers, _entries = headers_and_entries_for_device(device)
+        sensor_headers = (headers.select { |h| sensor =~ h.name })
 
-    def device_present?(device)
-      @headers.any? { |h| device =~ h.name }
-      # XXX improve, make sure there are entries
-    end
+        return sensor_headers.count > 0 && sensor_headers.first.sensor_id
+      end
+
+      private
 
-    def headers_and_entries_for_device(device)
-      headers = @headers.select { |h| device =~ h.name }
-      return [[],[]] if headers.empty?
+      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 headers_and_entries_for_device(device)
+        headers = @headers.select { |h| device =~ h.name }
+        return [[],[]] if headers.empty?
+
+        id = headers.first.id
+        headers = @headers.select { |h| h.id == id }
+        entries = @entries.select { |e| e.id == id }
+        [headers, entries]
+      end
 
-      id = headers.first.id
-      headers = @headers.select { |h| h.id == id }
-      entries = @entries.select { |e| e.id == id }
-      [headers, entries]
     end
 
   end
 
-end; end
+end