notam 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af3eeb358f7926b26df44bbc63fad3609d67b624c26007418bfd1d534e88fb13
-  data.tar.gz: de019922c1df754396cec3707d0306bdd820053c1fc28b095ccbed3dfcb8f5f0
+  metadata.gz: 92a3fd49f8ffbc96bcb45d19f890837af01c255d69d4c083a883c8f446e1758d
+  data.tar.gz: 5fa45d97e28d3bed19a20ec3e841e815b93cb94f3b686172fb9abc5c50cc7118
 SHA512:
-  metadata.gz: 29466f5ea8d2ccb99d2ee9e970940e4a629c60dc8b761b20a5d0ecdb42088a196228ad6830119e2acbb58c97d673fbeb4b5058355430c82459aadc25870220f4
-  data.tar.gz: 8d74558a051b08e1161c0765eda985c9067c40cf74ce2487a9f98b54315fd1b657daf99042a9f8a1218d9e9d2784a905dfd0c78d776273c400ec1ce06e9b47fe
+  metadata.gz: 42503973261da835cab991b6272b1b12ac17adac8f8a670de29d7b55f5650b35cb4e38d5eddc145c78ba03f81f4247f398cb0aec82d2366205b90a6fb6c96842
+  data.tar.gz: 9f84f55bc3b42c40e7670e72683c05b32d71a8d401a197b38481eeaa56b173d16e62e3279a40134bf48cadb0e227fb30ba68ff5766a9c96ece9d66fe8e1f3a71

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Nothing so far
 
+## 0.1.2
+
+#### Changes
+* The five day schedules are calculated starting today if `effective_at` is
+  in the past.
+
 ## 0.1.1
 
 #### Changes

data/README.md

@@ -1,6 +1,6 @@
 [![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/)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/svoop/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
@@ -26,7 +26,7 @@ gem cert --add <(curl -Ls https://raw.github.com/svoop/notam/main/certs/svoop.pe
 Add the following to the `Gemfile` or `gems.rb` of your [Bundler](https://bundler.io) powered Ruby project:
 
 ```ruby
-gem notam
+gem 'notam'
 ```
 
 And then install the bundle:
@@ -112,6 +112,19 @@ 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.
 
+### Anatomy of a NOTAM message
+
+A NOTAM message consists of a header followed by the following items:
+
+* [Q item](https://www.rubydoc.info/gems/notam/NOTAM/Q): Essential information such as purpose or center point and radius
+* [A item](https://www.rubydoc.info/gems/notam/NOTAM/A): Affected locations
+* [B item](https://www.rubydoc.info/gems/notam/NOTAM/B): When the NOTAM becomes effective
+* [C item](https://www.rubydoc.info/gems/notam/NOTAM/C): When the NOTAM expires
+* [D item](https://www.rubydoc.info/gems/notam/NOTAM/D): Activity schedules (optional)
+* [E item](https://www.rubydoc.info/gems/notam/NOTAM/E): Free text description
+* [F item](https://www.rubydoc.info/gems/notam/NOTAM/F): Upper limit (optional)
+* [G item](https://www.rubydoc.info/gems/notam/NOTAM/G): Lower limit (optional)
+
 ### 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:
@@ -119,14 +132,14 @@ Four letter FIR codes assigned by the ICAO follow some logic, albeit there exist
 ```
 L F M M
 ┬ ┬ ─┬─
-│ │  └─ global area: L => lower Europe
+│ │  └─ subsection: MM => Marseille
 │ └──── geopolitical unit: F => France
-└────── subsection: MM => Marseille
+└────── global area: L => lower Europe
 ```
 
 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.
+FIR codes ending with `XX` specify more than one subsection. Example: `LFXX` can be any combination of at least two subsections within `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
 
@@ -151,18 +164,20 @@ AIS are free to define series as they please, however, a few conventions have em
 
 #### 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:
+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 `QKKKK` 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:
+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`.

data/lib/notam/item/d.rb

@@ -28,11 +28,17 @@ module NOTAM
       schedules.any? { _1.active?(at: at, xy: data[:center_point]) }
     end
 
+    # Calculate the relevant, consolidated schedules for five days.
+    #
+    # The beginning of the five day window is either today (if +effective_at+
+    # is in the past) or +effective_at+ (otherwise).
+    #
+    # @return [Array<NOTAM::Schedule>]
     def five_day_schedules
       schedules.map do |schedule|
         schedule
-          .slice(AIXM.date(data[:effective_at]), AIXM.date(data[:effective_at] + 4 * 86_400))
-          .resolve(on: data[:effective_at], xy: data[:center_point])
+          .slice(AIXM.date(five_day_base), AIXM.date(five_day_base + 4 * 86_400))
+          .resolve(on: AIXM.date(five_day_base), xy: data[:center_point])
       end.map { _1 unless _1.empty? }.compact
     end
 
@@ -43,6 +49,12 @@ module NOTAM
 
     private
 
+    # @return [Time]
+    def five_day_base
+      @five_day_base ||= [data[:effective_at], Time.now.utc.round].max
+    end
+
+    # @params string [String] string to clean up
     # @return [String]
     def cleanup(string)
       string

data/lib/notam/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NOTAM
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notam
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sven Schwyn
@@ -30,7 +30,7 @@ cert_chain:
   1+2Y1+i+4jd1B7qxIgOLxQTNIJiwE0sqU1itFfuesfgUACS7M0IV9u9Bp4hBGNEw
   5JcY2h7owdMxXIvgk1oakgldFJc=
   -----END CERTIFICATE-----
-date: 2022-04-23 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aixm
@@ -258,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.14
 signing_key:
 specification_version: 4
 summary: Parser for NOTAM (Notice to Airmen) messages