notam 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82e0d9749642d667ef8b547cb0fea44184dd695889258798302ca5875b019947
+  data.tar.gz: 7a7b5ebd3fe9fcd0b8368e66911b24228672283048d3e83cfc87ab2c923e1805
+SHA512:
+  metadata.gz: a98c7ae52e81387a1699c3d668e1fae0536112ef6cbc5ae071f5a98d4c096c33f0a71a25174c9c4c6bec6a183f75a7ebc03aa23ff44de87033895b7746ff4a28
+  data.tar.gz: 72811552016bbd955f52cab2fac066ffbafae6683eefb4f19f738c9186d736db6b4948b30dab04440d9b08f4e863d00e74af517bb0f20f45e9b438da277b8d76

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## Main
+
+Nothing so far
+
+## 0.1.0
+
+#### Initial Implementation
+* Require Ruby 3.0
+* `NOTAM::Message` and `NOTAM::Item` (Header, Q, A-G, Footer)
+* `NOTAM::Schedule` with useful tools like `slice` and `resolve`
+* Expansion of contractions on E item
+* Tests against live NOTAM

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Sven Schwyn
+
+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,223 @@
+[![Version](https://img.shields.io/gem/v/notam.svg?style=flat)](https://rubygems.org/gems/notam)
+[![Tests](https://img.shields.io/github/workflow/status/svoop/notam/Test.svg?style=flat&label=tests)](https://github.com/svoop/notam/actions?workflow=Test)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/notam/notam.svg?style=flat)](https://codeclimate.com/github/svoop/notam/)
+[![Donorbox](https://img.shields.io/badge/donate-on_donorbox-yellow.svg)](https://donorbox.org/bitcetera)
+
+# NOTAM
+
+Parser for [NOTAM (Notice to Airmen)](https://www.icao.int/safety/istars/pages/notams.aspx) messages in Ruby.
+
+* [Homepage](https://github.com/svoop/notam)
+* [API](https://www.rubydoc.info/gems/notam)
+* Author: [Sven Schwyn - Bitcetera](https://bitcetera.com)
+
+## Install
+
+### Security
+
+This gem is [cryptographically signed](https://guides.rubygems.org/security/#using-gems) in order to assure it hasn't been tampered with. Unless already done, please add the author's public key as a trusted certificate now:
+
+```
+gem cert --add <(curl -Ls https://raw.github.com/svoop/notam/main/certs/svoop.pem)
+```
+
+### Bundler
+
+Add the following to the `Gemfile` or `gems.rb` of your [Bundler](https://bundler.io) powered Ruby project:
+
+```ruby
+gem notam
+```
+
+And then install the bundle:
+
+```
+bundle install --trust-policy MediumSecurity
+```
+
+## Usage
+
+```ruby
+raw_notam_text_message = <<~END
+  W0902/22 NOTAMN
+  Q) LSAS/QRRCA/V/BO/W/000/148/4624N00702E004
+  A) LSAS B) 2204110900 C) 2205131400 EST
+  D) APR 11 SR MINUS15-1900, 20-21 26-28 MAY 03-05 10-12 0530-2100, APR
+  14 22 29 MAY 06 13 0530-1400, APR 19 25 MAY 02 09 0800-2100
+  E) R-AREA LS-R7 HONGRIN ACT DUE TO FRNG.
+  F) GND
+  G) 14800FT AMSL
+  CREATED: 11 Apr 2022 06:10:00
+  SOURCE: LSSNYNYX
+END
+
+notam = NOTAM.parse(raw_notam_text_message)
+notam.data    # => Hash
+```
+
+The resulting hash for this example looks as follows:
+
+```ruby
+{
+  id: "W0902/22",
+  id_series: "W",
+  id_number: 902,
+  id_year: 2022,
+  new?: true,
+  fir: "LSAS",
+  subject: :restricted_area,
+  condition: :activated,
+  traffic: :vfr,
+  purpose: [:operational_significance, :flight_operations],
+  scope: [:navigation_warning],
+  lower_limit: #<AIXM::Z 14800 ft QNH>,
+  upper_limit: #<AIXM::Z 0 ft QFE>,
+  center_point: #<AIXM::XY 46.40000000N 007.03333333E>,
+  radius: #<AIXM::D 4.0 nm>,
+  locations: ["LSAS"],
+  part_index: 1,
+  part_index_max: 1,
+  effective_at: 2022-04-11 09:00:00 UTC,
+  expiration_at: 2022-05-13 14:00:00 UTC,
+  estimated_expiration?: false,
+  no_expiration?: true,
+  schedules: [
+    #<NOTAM::Schedule actives: [2022-04-11], times: [sunrise-15min..19:00 UTC], inactives: []>,
+    #<NOTAM::Schedule actives: [2022-04-20..2022-04-21, 2022-04-26..2022-04-28, 2022-05-03..2022-05-05, 2022-05-10..2022-05-12], times: [05:30 UTC..21:00 UTC], inactives: []>,
+    #<NOTAM::Schedule actives: [2022-04-14, 2022-04-22, 2022-04-29, 2022-05-06, 2022-05-13], times: [05:30 UTC..14:00 UTC], inactives: []>,
+    #<NOTAM::Schedule actives: [2022-04-19, 2022-04-25, 2022-05-02, 2022-05-09], times: [08:00 UTC..21:00 UTC], inactives: []>
+  ],
+  five_day_schedules: [
+    #<NOTAM::Schedule actives: [2022-04-11], times: [04:35 UTC..19:00 UTC], inactives: []>,
+    #<NOTAM::Schedule actives: [2022-04-14], times: [05:30 UTC..14:00 UTC], inactives: []>
+  ],
+  content: "R-AREA LS-R7 HONGRIN ACT DUE TO FRNG.",
+  translated_content: "R-AREA LS-R7 HONGRIN ACTIVE DUE TO FRNG.",
+  created: 2022-04-11 06:10:00 UTC,
+  source: "LSSNYNYX"
+}
+```
+
+A few highlights to note here:
+
+* Value classes of the [AIXM gem](https://rubygems.org/gems/aixm) are used to ease further processing.
+* Schedules can be pretty complex, therefore a simpler `five_day_schedule` is calculated for the day the NOTAM becomes effective and the four subsequent days. This short term schedule does not contain exceptions nor events such as sunrises anymore. Furthermore, you can calculate different custom sub-schedules using `slice` and `resolve`.
+* Content is processed to `translated_content`. As of now, known english contractions are expanded. Feel free to contribute non-english locale files read by the [I18n gem](https://rubygems.org/gems/i18n).
+
+Since NOTAM may contain a certain level of redundancy, the parser does some integrity checks, fixes the payload if possible and issues a warning.
+
+You get a `NOTAM::ParseError` in case the raw NOTAM text message fails to be parsed. If you're sure the NOTAM is correct, please [submit an issue](#development) or fix the bug and [submit a pull request](#development).
+
+See the [API documentation](https://www.rubydoc.info/gems/notam) for more.
+
+⚠️ Only NOTAM compatible with the ICAO annex 15 are supported for now. Most notably in the USA other NOTAM formats exist which cannot be parsed using this gem.
+
+### FIR
+
+Four letter FIR codes assigned by the ICAO follow some logic, albeit there exist exceptions and inconsistencies e.g. for historical reasons. Let's take an easy example:
+
+```
+L F M M
+┬ ┬ ─┬─
+│ │  └─ global area: L => lower Europe
+│ └──── geopolitical unit: F => France
+└────── subsection: MM => Marseille
+```
+
+The informal use of only the first two letters often stands for a combination of all subsections contained therein. Example: `LF` is a combination of `LFBB`, `LFEE`, `LFFF`, `LFMM` and `LFRR`.
+
+FIR codes ending with `XX` specify more than one subsection. Example: `LFXX` is a combination of two subsections with in `LF`. In NOTAM, this notation may be used on the Q item if (and only if) the affected subsections are listed on the A item.
+
+### Series
+
+The first letter of the NOTAM ID is identifying the series. The following example is part of series `S`:
+
+```
+S0054/02 NOTAMN
+```
+
+AIS are free to define series as they please, however, a few conventions have emerged:
+
+* **Series A**<br>General rules, en-route navigation and communication facilities, airspace restrictions and activities taking place above FL 245 as well as information concerning major international aerodromes.
+* **Series B**<br>Information on airspace restrictions, on activities taking place at or below FL 245 and on other international aerodromes at which IFR flights are permitted.
+* **Series C**<br>Information on other international aerodromes at which only VFR flights are permitted.
+* **Series D**<br>Information on national aerodromes
+* **Series E**<br>Information on heliports
+* **Series S** (aka: SNOWTAM)<br>Surface condition reports
+* **Series T**<br>Reserved for NOTAM processing units in cases when basic operational information was not triggered by the issuing AIS.
+* **Series V** (aka: ASHTAM)<br>Volcano ash condition reports
+
+### Special NOTAM
+
+#### Checklist
+
+Checklist NOTAM are periodically issued lists of all currently effective NOTAM. They are used for cross checking and can usually be ignored for flight planning. Their Q item contain `Q..KK` which is decoded as "condition: :checklist", here's an example:
+
+```
+Q) EDXX/QKKKK/K /K  /K /000/999/5123N01018E999
+```
+
+#### Trigger
+
+Trigger NOTAM are referring to another source of information such as AIP SUP (AIP supplement). Their Q item contain `Q..TT` which is decoded as "condition: :trigger", here's an example:
+
+```
+Q) LFXX/QRTTT/IV/BO /W /000/035/4708N00029E010
+```
+
+Note: Trigger NOTAM are never published as series `T`.
+
+### Schedules
+
+For compatibility, schedule dates and times are expressed using the corresponding classes from the [AIXM gem](https://rubygems.org/gems/aixm):
+
+* [Date](https://www.rubydoc.info/gems/aixm/AIXM/Schedule/Date)
+* [Day](https://www.rubydoc.info/gems/aixm/AIXM/Schedule/Day)
+* [Time](https://www.rubydoc.info/gems/aixm/AIXM/Schedule/Time)
+
+### References
+
+* [ICAO Annex 15 on NOTAM](https://www.bazl.admin.ch/bazl/en/home/specialists/regulations-and-guidelines/legislation-and-directives/anhaenge-zur-konvention-der-internationalen-zivilluftfahrtorgani.html)
+* [NOTAM Q Codes](https://www.faa.gov/air_traffic/publications/atpubs/notam_html/appendix_b.html)
+* [Guide de la consultation NOTAM (fr)](https://www.sia.aviation-civile.gouv.fr/pub/media/news/file/g/u/guide_de_la_consultation_notam_05-10-2017-1.pdf)
+* [NOTAM Contractions](https://www.notams.faa.gov/downloads/contractions.pdf)
+* [NOTAM format cheat sheet](http://vat-air.dk/files/ICAO%20NOTAM%20format.pdf)
+* [Introduction on Wikipedia](https://en.wikipedia.org/wiki/NOTAM)
+
+## Translations
+
+You find the translations for each available language in `lib/locales/`. Additional translations are very welcome provided you have sufficient aeronautical background knowledge.
+
+Please [create a translation request issue](https://github.com/svoop/notam/issues), then duplicate the `lib/locales/en.yml` reference language file and translate it.
+
+## Tests and Fixtures
+
+The test suite may run against live NOTAM if you set the `SPEC_SCOPE` environment variable:
+
+```
+export SPEC_SCOPE=all        # run against all NOTAM fixtures
+export SPEC_SCOPE=all-fast   # run against all NOTAM fixtures but exit on the first failure
+export SPEC_SCOPE=W0214/22   # run against given NOTAM fixture only
+```
+
+The NOTAM fixtures are written to `spec/fixtures`, you can manage them using a Rake tasks:
+
+```
+rake --tasks fixtures
+```
+
+## Development
+
+To install the development dependencies and then run the test suite:
+
+```
+bundle install
+bundle exec rake    # run tests once
+bundle exec guard   # run tests whenever files are modified
+```
+
+You're welcome to [submit issues](https://github.com/svoop/notam/issues) and contribute code by [forking the project and submitting pull requests](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).