igc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5b777bf1ad64d5f6aff66fbc145891d0e534d63dafe531a8d7dcf92fee2abea
+  data.tar.gz: 1435504cd86eede5245597371a46ef0093878374de6ac55a5538b026e0a1917e
+SHA512:
+  metadata.gz: 93145a9bb546aaebe2b9f44acc46be27dbe72d2a0558abf14c34147bbf5cc31d452aa542c95f7238c68c310fe3af051eaf46f9f6926a4b52981e7cb5a3f58d82
+  data.tar.gz: c922a2021aa53e4054ec3a6266668347720cf4133d035c78b3b7dc045b61ede49c9f053153e25a4e6a2bd5c863f6bf1f9214909405a9a2873e0dd8ee1a7843dc

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/FrozenStringLiteralComment:
+  SafeAutoCorrect: true
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-01
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in igc.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "snapshot_testing"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    igc (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    snapshot_testing (0.3.4)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  igc!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  snapshot_testing
+
+BUNDLED WITH
+   2.4.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Alberto Restifo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# IGC Parser
+
+[![Gem Version](https://badge.fury.io/rb/igc.svg)](https://badge.fury.io/rb/igc)
+[![Build Status](https://github.com/wefly-world/igc/actions/workflows/main.yml/badge.svg)](https://github.com/wefly-world/igc/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+
+IGC is a Ruby library for parsing International Gliding Commission (IGC) files. It is fully compliant with the IGC specification and allows you to easily extract flight data from IGC files.
+
+IGC files are used to record flight data such as GPS coordinates, altitude, and timestamps from gliders, paragliders, and other free-flying aircraft.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'igc'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install igc
+```
+
+## Usage
+
+Using the IGC library is simple. You can parse an IGC file with just one line of code:
+
+```ruby
+flight = IGC.parse("path_to_file.igc")
+```
+
+Example
+
+```ruby
+require 'igc'
+
+# Parse an IGC file
+flight = IGC.parse("path_to_file.igc")
+
+# Access flight data
+puts "Pilot: #{flight.pilot}"
+puts "Glider Type: #{flight.glider_type}"
+puts "Glider ID: #{flight.glider_id}"
+puts "Date: #{flight.date}"
+
+# Iterate through fixes
+flight.fixes.each do |fix|
+  puts "Time: #{fix.time} Latitude: #{fix.location.latitude} Longitude: #{fix.location.longitude} Altitude: #{fix.gps_altitude}"
+end
+```

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/igc.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/igc/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "igc"
+  spec.version = IGC::VERSION
+  spec.authors = ["Alberto Restifo"]
+  spec.email = ["alberto@restifo.dev"]
+
+  spec.summary = "IGC flight log parser"
+  spec.description = "Parses IGC flight log files according to the latest IGC specification"
+  spec.homepage = "https://github.com/wefly-world/igc"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/wefly-world/igc"
+  spec.metadata["changelog_uri"] = "https://github.com/wefly-world/igc/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/igc/fix.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module IGC
+  # IGC::Fix represents a single fix in a recorder flight
+  class Fix
+    attr_accessor :location,
+                  :time,
+                  :validity,
+                  :pressure_altitude,
+                  :gps_altitude,
+                  :extensions,
+                  :magnetic_heading,
+                  :true_heading,
+                  :air_speed,
+                  :satellite_in_use,
+                  :wind_direction,
+                  :wind_speed,
+                  :horizontal_accuracy,
+                  :vertical_accuracy,
+                  :compensated_variomenter,
+                  :uncompensated_variometer
+
+    def initialize
+      @extensions = {}
+    end
+
+    def assign_known_extensions!
+      @extensions.each do |key, value|
+        case key
+        when "HDM"
+          @magnetic_heading = value.to_i
+        when "HDT"
+          @true_heading = value.to_i
+        when "IAS"
+          @air_speed = value.to_i
+        when "SIU"
+          @satellite_in_use = value.to_i
+        when "WDI"
+          @wind_direction = value.to_i
+        when "WSP"
+          @wind_speed = value.to_i
+        when "FXA"
+          @horizontal_accuracy = value.to_i
+        when "VXA"
+          @vertical_accuracy = value.to_i
+        when "VAT"
+          @compensated_variomenter = value.to_i / 100
+        when "VAR"
+          @uncompensated_variometer = value.to_i / 100
+        end
+      end
+    end
+  end
+end

data/lib/igc/flight.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module IGC
+  # IGC::Flight represents a the fligth as recorder in the IGC file
+  class Flight
+    attr_accessor :reorder_id,
+                  :raw_headers,
+                  :gps_altitude_ref,
+                  :pressure_altitude_ref,
+                  :competition_class,
+                  :competition_id,
+                  :flight_recorder_type,
+                  :glider_id,
+                  :glider_type,
+                  :pilot,
+                  :pressure_sensor,
+                  :firmware_version,
+                  :hardware_version,
+                  :timezone,
+                  :date,
+                  :flight_number,
+                  :fix_extensions,
+                  :data_extensions,
+                  :fixes
+
+    def initialize
+      @raw_headers = {}
+      @fix_extensions = {}
+      @data_extensions = {}
+      @fixes = []
+    end
+  end
+end

data/lib/igc/location.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module IGC
+  # IGC::Location represents a location in the world using WGS84 coordinates
+  class Location
+    attr_accessor :latitude,
+                  :longitude
+
+    def initialize(latitude:, longitude:)
+      @latitude = latitude
+      @longitude = longitude
+    end
+  end
+end

data/lib/igc/parser.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require "strscan"
+require "date"
+
+module IGC
+  # :nodoc:
+  class Parser
+    def initialize(file)
+      @buffer = StringScanner.new(file)
+      @flight = Flight.new
+    end
+
+    def parse
+      parse_line until @buffer.eos?
+      @flight
+    end
+
+    private
+
+    def parse_line
+      case @buffer.peek(1)
+      when "A"
+        skip
+        @flight.reorder_id = read_to_eol
+      when "H"
+        parse_header_line
+      when "B"
+        parse_fix_line
+      when "I"
+        parse_extension_line
+      when "J"
+        parse_extension_line
+      else
+        # Skip the line
+        read_to_eol
+      end
+    end
+
+    # Reads the buffer until the end of the line,
+    # leaving the buffer at the beginning of the next line
+    def read_to_eol
+      @buffer.scan_until(/\n/).chomp
+    end
+
+    # Advances the buffer to the next char
+    def skip(n = 1)
+      n.times { @buffer.getch }
+    end
+
+    # Consumes n characters from the buffer
+    def take(n = 1)
+      res = ""
+      n.times do
+        res += @buffer.getch
+      end
+      res
+    end
+
+    # Parses a header definition line
+    def parse_header_line
+      skip(2) # HF
+
+      short_code = take(3)
+      subject = parse_header_subject
+      value = read_to_eol
+
+      # Assign the raw headers
+      @flight.raw_headers[short_code] = { subject: subject, value: value }
+      assign_known_header(short_code, value)
+    end
+
+    def parse_header_subject
+      start_pos = @buffer.pos
+
+      # Check and see if we have a `:` before reaching end of line
+      subject = @buffer.scan_until(/[\r\n]|:/)
+
+      # If we have a `:`, then we have a subject
+      return subject.chop if subject.include?(":")
+
+      # Otherwise resert to the initial position as we don't have a subject
+      @buffer.pos = start_pos
+      nil
+    end
+
+    def assign_known_header(short_code, value)
+      case short_code
+      when "ALG"
+        @flight.gps_altitude_ref = value
+      when "ALP"
+        @flight.pressure_altitude_ref = value
+      when "CCL"
+        @flight.competition_class = value
+      when "CID"
+        @flight.competition_id = value
+      when "FTY"
+        @flight.flight_recorder_type = value
+      when "GID"
+        @flight.glider_id = value
+      when "GTY"
+        @flight.glider_type = value
+      when "PLT"
+        @flight.pilot = value
+      when "PRS"
+        @flight.pressure_sensor = value
+      when "RFW"
+        @flight.firmware_version = value
+      when "RHW"
+        @flight.hardware_version = value
+      when "TZN"
+        @flight.timezone = value
+      when "DTE"
+        parse_date(value)
+      end
+    end
+
+    def parse_date(value)
+      day = value[0..1].to_i
+      month = value[2..3].to_i
+      year = value[4..5].to_i
+
+      @flight.date = Date.new(2000 + year, month, day)
+
+      return unless value.length > 5
+
+      @flight.flight_number = value[6..]
+    end
+
+    def parse_extension_line
+      kind = take(1) == "I" ? :fix_extensions : :data_extensions
+
+      nr_extensions = take(2).to_i
+      nr_extensions.times do
+        start_byte = take(2).to_i
+        end_byte = take(2).to_i
+        short_code = take(3)
+
+        # Assign the range to the extension map
+        @flight.send(kind)[short_code] = start_byte..end_byte
+      end
+    end
+
+    def parse_fix_line
+      # Read the entire line, this will make it easier to parse the extensions
+      # later on, but we also reset the position of the buffer to the beginning
+      current_pos = @buffer.pos
+      fix_line = read_to_eol
+      @buffer.pos = current_pos
+
+      skip
+
+      fix = Fix.new
+
+      hours = take(2).to_i
+      minutes = take(2).to_i
+      seconds = take(2).to_i
+
+      fix.time = Time.utc(@flight.date.year, @flight.date.month, @flight.date.day, hours, minutes, seconds)
+      fix.location = parse_location
+      fix.validity = take(1)
+      fix.pressure_altitude = take(5).to_i
+      fix.gps_altitude = take(5).to_i
+      fix.extensions = read_extensions_values(fix_line, @flight.fix_extensions.clone)
+      fix.assign_known_extensions!
+
+      @flight.fixes << fix
+    end
+
+    # kind here is either :lat or :lon
+    def parse_coord(kind)
+      size = kind == :lat ? 2 : 3
+      degrees = take(size).to_f
+      minutes = take(5).to_f / 1000
+
+      pole = take(1)
+      sign = %w[N E].include?(pole) ? 1 : -1
+
+      sign * (degrees + minutes / 60)
+    end
+
+    def parse_location
+      lat = parse_coord(:lat)
+      lon = parse_coord(:lon)
+      Location.new(latitude: lat, longitude: lon)
+    end
+
+    def read_extensions_values(line, extensions)
+      extensions.transform_values! { |range| line[range] }
+    end
+  end
+end

data/lib/igc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IGC
+  VERSION = "0.1.0"
+end

data/lib/igc.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "igc/version"
+require_relative "igc/flight"
+require_relative "igc/location"
+require_relative "igc/fix"
+require_relative "igc/parser"
+
+# IGC is a library to parse IGC files
+#
+#     IGC.parse_file("path/to/file.igc")
+#
+module IGC
+  class Error < StandardError; end
+
+  def self.parse(str)
+    Parser.new(str).parse
+  end
+
+  def self.parse_file(path)
+    parse(File.read(path))
+  end
+end

data/sig/igc.rbs

@@ -0,0 +1,4 @@
+module IGC
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: igc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alberto Restifo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-01 00:00:00.000000000 Z
+dependencies: []
+description: Parses IGC flight log files according to the latest IGC specification
+email:
+- alberto@restifo.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- igc.gemspec
+- lib/igc.rb
+- lib/igc/fix.rb
+- lib/igc/flight.rb
+- lib/igc/location.rb
+- lib/igc/parser.rb
+- lib/igc/version.rb
+- sig/igc.rbs
+homepage: https://github.com/wefly-world/igc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wefly-world/igc
+  source_code_uri: https://github.com/wefly-world/igc
+  changelog_uri: https://github.com/wefly-world/igc/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.9
+signing_key:
+specification_version: 4
+summary: IGC flight log parser
+test_files: []