notam 0.1.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b793dbd67af43de50525171950c176860cb7095b865e2362d1aaf31c4a4e737c
-  data.tar.gz: e3915a6680b06eb3a43270012dfb552b84443605a21dafd44f7c72597973a3de
+  metadata.gz: 45b4ce39f423833013299133d3b54d3ee759d701aa6a53d0075e8546bd48dfa2
+  data.tar.gz: f4a86ad18546f654becd05db944a2c9b22213f4095794c20dc911dccdfa93be8
 SHA512:
-  metadata.gz: cccba536bce34a893bdc717ba2b4983bf09e66d499acc33cec4ec949a52bb4685319c36fe99c30ee73ba82e91d33a8c5446a96f7ba18abf468c5fd6dc147daa1
-  data.tar.gz: 1acee0ea83919ed99d2825d81ea34d1e0fba3464a31c68706e870baa8e72c8e2e05c5ac282410bf09cde59be5a01b809c8fe780771c12197bee7331b13d9318b
+  metadata.gz: c62bd682d3849093fb96d887f16933159945ecc60edae31da0415cc35f8c2bd4e30655d336a5134eddc0cb9443e7b492aae99f3868dad09c47d3731d7f69bb17
+  data.tar.gz: a52c3ccb305e863d5cd8dc4bd2ff345406ca9a73ae4493cbc4445b8f7f3d63ab98371f219689b236e2c0257aab503b86700b1a770abd2bebc3a1fbd3a92a0e3a

checksums.yaml.gz.sig

@@ -1 +1,3 @@
-�p:��a>t����>E�i8�	�����K[�W�А�}	k�Lw�:v3��n��{h�IE���0i\/���"CǿtN�mӛza�sژI�i�"�7ص}���r3s����s�Keu�� �������G�E�	z���N�W�8zt��*����e��A�]1�JwfKͥJ ���i#�CN3C�b���Xr�7��,���P��x�{ zlO�#��UCխu<�7�׊�b����&�1���W�����
+���3Ƈ�3�*�P���3g��X�).5W��}!ҕ� �ږ!�pTmش���v�z���4m���ڤU���]X�HFK���a��i��r�Dj��`������9f��$$�����?z/����]�o��Z5��L/��Tbt�8jπ����������3>ε�1C��9z#�E��ޅ�y�r5a�+��,
+���љt�u���A$2)�D�Vh��B��^���4,��(�T�I���jHV��
+�ϛ�5�@�u�

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 Nothing so far
 
+## 1.1.0
+
+#### Additions
+* Extract subject group and condition group on Q item
+
+## 1.0.0
+
+#### Breaking Changes
+* `NOTAM::Schedule.parse` now returns an array of `NOTAM_Schedule` instances
+  instead of just a single one.
+
+#### Changes
+* Edge case tolerant extraction of `PART n OF n` and `END PART n OF n` markers
+
+#### Additions
+* Support for datetime ranges (i.e. `1 APR 2000-20 MAY 2000`) as well as times
+  across midnight (i.e. `1 APR 1900-0500`) on D items.
+* Wrap all exceptions raised while parsing items.
+
 ## 0.1.3
 
 #### Fixes

data/README.md

@@ -41,12 +41,13 @@ bundle install --trust-policy MediumSecurity
 raw_notam_text_message = <<~END
   W0902/22 NOTAMN
   Q) LSAS/QRRCA/V/BO/W/000/148/4624N00702E004
-  A) LSAS B) 2204110900 C) 2205131400 EST
+  A) LSAS PART 2 OF 3 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
+  END PART 2 OF 3
   CREATED: 11 Apr 2022 06:10:00
   SOURCE: LSSNYNYX
 END
@@ -65,7 +66,9 @@ The resulting hash for this example looks as follows:
   id_year: 2022,
   new?: true,
   fir: "LSAS",
+  subject_group: :airspace_restrictions,
   subject: :restricted_area,
+  condition_group: :changes,
   condition: :activated,
   traffic: :vfr,
   purpose: [:operational_significance, :flight_operations],
@@ -75,8 +78,8 @@ The resulting hash for this example looks as follows:
   center_point: #<AIXM::XY 46.40000000N 007.03333333E>,
   radius: #<AIXM::D 4.0 nm>,
   locations: ["LSAS"],
-  part_index: 1,
-  part_index_max: 1,
+  part_index: 2,
+  part_index_max: 3,
   effective_at: 2022-04-11 09:00:00 UTC,
   expiration_at: 2022-05-13 14:00:00 UTC,
   estimated_expiration?: false,
@@ -106,7 +109,12 @@ A few highlights to note here:
 
 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).
+You get a `NOTAM::ParseError` in case the raw NOTAM text message fails to be parsed. This error object features two notable methods:
+
+* `item` – the faulty item (if already available)
+* `cause` – the underlying error object (if any)
+
+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.
 
@@ -114,8 +122,9 @@ See the [API documentation](https://www.rubydoc.info/gems/notam) for more.
 
 ### Anatomy of a NOTAM message
 
-A NOTAM message consists of a header followed by the following items:
+A NOTAM message consists of the following items in order:
 
+* Header: ID and type of NOTAM
 * [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
@@ -124,6 +133,9 @@ A NOTAM message consists of a header followed by the following items:
 * [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)
+* Footer: Any number of lines with metadata such as `CREATED` and `SOURCE`
+
+Furthermore, oversized NOTAM may be split into several partial messages which contain with `PART n OF n` and `END PART n OF n` markers. This is an unofficial extension and therefore the markers may be found in different places such as on the A item, on the E item or even somewhere in between.
 
 ### FIR
 
@@ -190,11 +202,18 @@ For compatibility, schedule dates and times are expressed using the correspondin
 * [Day](https://www.rubydoc.info/gems/aixm/AIXM/Schedule/Day)
 * [Time](https://www.rubydoc.info/gems/aixm/AIXM/Schedule/Time)
 
+Raw and parsed NOTAM schedule times differ in how the "end of day" is encoded:
+
+NOTAM  | Beginning of Day | End of Day | Remarks
+-------|------------------|------------|--------
+Raw    | `"0000"`         | `"2359"`   | `"2400"` is considered illegal
+Parsed | `00:00`          | `24:00`    | the Ruby way
+
 ### 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)
+* [ICAO Doc 8126: Aeronautical Information Services Manual](https://www.icao.int/NACC/Documents/eDOCS/AIM/8126_unedited_en%20Jul2021.pdf)
+* [EUROCONTROL Guidelines Operating Procedures AIS Dynamic Data (OPADD)](https://www.eurocontrol.int/sites/default/files/2021-07/eurocontrol-guidelines-opadd-ed4-1.pdf)
 * [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)
@@ -207,12 +226,13 @@ Please [create a translation request issue](https://github.com/svoop/notam/issue
 
 ## Tests and Fixtures
 
-The test suite may run against live NOTAM if you set the `SPEC_SCOPE` environment variable:
+The test suite may run against live NOTAM depending on whether and how you set the `SPEC_SCOPE` environment variable:
 
 ```
+export SPEC_SCOPE=none       # don't run against any NOTAM fixtures (default)
+export SPEC_SCOPE=W0214/22   # run against given NOTAM fixture only
 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:

data/lib/locales/en.yml

@@ -307,6 +307,22 @@ en:
     ZSHA: "Shanghai ACC"
     ZWUQ: "Urumqi ACC"
     ZYSH: "Shenyang ACC"
+  subject_groups:
+    airspace_organization: "airspace organization"
+    communications_and_surveillance_facilities: "communications and surveillance facilities"
+    facilities_and_services: "facilities and services"
+    gnss_services: "GNSS services"
+    instrument_and_microwave_landing_system: "instrument and microwave landing system"
+    checklist: "checklist"
+    lighting_facilities: "lighting facilities"
+    movement_and_landing_area: "movement and landing area"
+    terminal_and_en_route_navigation_facilities: "terminal and en route navigation facilities"
+    other_information: "other information"
+    air_traffic_procedures: "air traffic procedures"
+    airspace_restrictions: "airspace restrictions"
+    air_traffic_and_volmet_services: "air traffic and VOLMET services"
+    warning: "warning"
+    other: "other"
   subjects:
     minimum_altitude: "minimum altitude"
     class_bcde_surface_area: "class B/C/D/E surface area"
@@ -488,6 +504,14 @@ en:
     aerial_survey: "aerial survey"
     model_flying: "model flying"
     other: "other"
+  condition_groups:
+    availability: "availabiity"
+    changes: "changes"
+    hazard_conditions: "hazard conditions"
+    checklist: "checklist"
+    limitations: "limitations"
+    trigger: "trigger"
+    other: "other"
   conditions:
     withdrawn_for_maintenance: "withdrawn for maintenance"
     available_for_daylight_operation: "available for daylight operation"

data/lib/notam/errors.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
 module NOTAM
-  ParseError = Class.new(StandardError)
+  class ParseError < StandardError
+    attr_reader :item
+
+    def initialize(message, item: nil)
+      @item = item
+      super(message)
+    end
+  end
 end

data/lib/notam/item/a.rb

@@ -9,7 +9,6 @@ module NOTAM
       \A
       A\)\s?
       (?<locations>(?:#{ICAO_RE}\s?)+)
-      (?<parts>(?<part_index>\d+)\s+OF\s+(?<part_index_max>\d+))?
       \z
     )x.freeze
 
@@ -18,19 +17,9 @@ module NOTAM
       captures['locations'].split(/\s/)
     end
 
-    # @return [Integer, nil]
-    def part_index
-      captures['parts'] ? captures['part_index'].to_i : 1
-    end
-
-    # @return [Integer, nil]
-    def part_index_max
-      captures['parts'] ? captures['part_index_max'].to_i : 1
-    end
-
     # @see NOTAM::Item#merge
     def merge
-      super(:locations, :part_index, :part_index_max)
+      super(:locations)
     end
 
   end

data/lib/notam/item/d.rb

@@ -14,10 +14,12 @@ module NOTAM
     # @see NOTAM::Item#parse
     def parse
       base_date = AIXM.date(data[:effective_at])
-      @schedules = cleanup(text).split(',').map do |string|
+      @schedules = text.sub(/\AD\)/, '').split(',').flat_map do |string|
         Schedule.parse(string, base_date: base_date)
       end
       self
+    rescue
+      fail! 'invalid D item'
     end
 
     # Whether the D item is active at the given time.
@@ -54,15 +56,5 @@ module NOTAM
       @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
-        .gsub(/\s+/, ' ')           # collapse whitespaces to single space
-        .gsub(/ ?([-,]) ?/, '\1')   # remove spaces around dashes and commas
-        .sub(/\AD\) /, '')          # remove item identifier
-        .strip
-    end
-
   end
 end

data/lib/notam/item/header.rb

@@ -59,6 +59,8 @@ module NOTAM
       super
       fail! "invalid operation" unless (new? && !captures['old_id']) || replaces || cancels
       self
+    rescue
+      fail! 'invalid Header item'
     end
 
     # @see NOTAM::Item#merge

data/lib/notam/item/q.rb

@@ -26,11 +26,21 @@ module NOTAM
       captures['fir']
     end
 
+    # @return [Symbol]
+    def subject_group
+      NOTAM.subject_group_for(captures['subject'][0,1])
+    end
+
     # @return [Symbol]
     def subject
       NOTAM.subject_for(captures['subject'])
     end
 
+    # @return [Symbol]
+    def condition_group
+      NOTAM.condition_group_for(captures['condition'][0,1])
+    end
+
     # @return [Symbol]
     def condition
       NOTAM.condition_for(captures['condition'])
@@ -82,7 +92,7 @@ module NOTAM
 
     # @see NOTAM::Item#merge
     def merge
-      super(:fir, :subject, :condition, :traffic, :purpose, :scope, :lower_limit, :upper_limit, :center_point, :radius)
+      super(:fir, :subject_group, :subject, :condition_group, :condition, :traffic, :purpose, :scope, :lower_limit, :upper_limit, :center_point, :radius)
     end
 
   end

data/lib/notam/item.rb

@@ -91,8 +91,12 @@ module NOTAM
     # @return [self]
     def parse
       if match_data = self.class::RE.match(text)
-        @captures = match_data.named_captures
-        self
+        begin
+          @captures = match_data.named_captures
+          self
+        rescue
+          fail! "invalid #{self.class.to_s.split('::').last} item"
+        end
       else
         fail! 'text does not match regexp'
       end
@@ -124,7 +128,7 @@ module NOTAM
     # @param message [String] optional error message
     # @raise [NOTAM::ParseError]
     def fail!(message=nil)
-      fail(NOTAM::ParseError, [message, text].compact.join(': '))
+      fail ParseError.new([message, text].compact.join(': '), item: self)
     end
 
     # @return [String]

data/lib/notam/message.rb

@@ -4,17 +4,22 @@ module NOTAM
 
   # NOTAM messages are plain text and consist of several ordered items:
   #
-  #   WDDDD/DD ...   <- Header line (mandatory)
-  #   Q) ...         <- Q line: context (mandatory)
-  #   A) ...         <- A line: locations (mandatory)
-  #   B) ...         <- B line: effective from (mandatory)
-  #   C) ...         <- C line: effective until (optional)
-  #   D) ...         <- D line: timesheets (optional, may contain newlines)
-  #   E) ...         <- E line: description (mandatory, may contain newlines)
-  #   F) ...         <- F line: upper limit (optional)
-  #   G) ...         <- G line: lower limit (optional)
+  #   WDDDD/DD ...   <- Header (mandatory)
+  #   Q) ...         <- Q item: context (mandatory)
+  #   A) ...         <- A item: locations (mandatory)
+  #   B) ...         <- B item: effective from (mandatory)
+  #   C) ...         <- C item: effective until (optional)
+  #   D) ...         <- D item: timesheets (optional, may contain newlines)
+  #   E) ...         <- E item: description (mandatory, may contain newlines)
+  #   F) ...         <- F item: upper limit (optional)
+  #   G) ...         <- G item: lower limit (optional)
   #   CREATED: ...   <- Footer (optional)
   #   SOURCE: ...    <- Footer (optional)
+  #
+  # Furthermore, oversized NOTAM may be split into several partial messages
+  # which contain with +PART n OF n+ and +END PART n OF n+ markers. This is an
+  # unofficial extension and therefore the markers may be found in different
+  # places such as on the A item, on the E item or even somewhere in between.
   class Message
 
     UNSUPPORTED_FORMATS = %r(
@@ -24,6 +29,10 @@ module NOTAM
       \w{3}\s[A-Z]\d{4}/\d{2}\sMILITARY   # USA: military
     )xi.freeze
 
+    PART_RE = %r(
+      (?:END\s+)?PART\s+(?<part_index>\d+)\s+OF\s+(?<part_index_max>\d+)
+    )xim.freeze
+
     FINGERPRINTS = %w[Q) A) B) C) D) E) F) G) CREATED: SOURCE:].freeze
 
     # Raw NOTAM text message
@@ -44,10 +53,9 @@ module NOTAM
     def initialize(text)
       fail(NOTAM::ParserError, "unsupported format") unless self.class.supported_format? text
       @text, @items, @data = text, [], {}
-      itemize(text).each do |raw_item|
+      itemize(departition(@text)).each do |raw_item|
         item = NOTAM::Item.new(raw_item, data: @data).parse.merge
         @items << item
-        @data = item.data
       end
     end
 
@@ -96,6 +104,18 @@ module NOTAM
 
     private
 
+    # @return [String]
+    def departition(text)
+      text.gsub(PART_RE, '').tap do
+        if $~   # part marker found
+          @data.merge!(
+            part_index: $~[:part_index].to_i,
+            part_index_max: $~[:part_index_max].to_i
+          )
+        end
+      end
+    end
+
     # @return [Array]
     def itemize(text)
       lines = text.gsub(/\s(#{NOTAM::Item::RE})/, "\n\\1").split("\n")

data/lib/notam/schedule.rb

@@ -7,21 +7,24 @@ module NOTAM
   # Structure to accommodate individual schedules used on D items
   class Schedule
     EVENTS = { 'SR' => :sunrise, 'SS' => :sunset }.freeze
+    EVENT_HOURS = { sunrise: AIXM.time('06:00'), sunset: AIXM.time('18:00') }.freeze
     OPERATIONS = { 'PLUS' => 1, 'MINUS' => -1 }.freeze
     MONTHS = { 'JAN' => 1, 'FEB' => 2, 'MAR' => 3, 'APR' => 4, 'MAY' => 5, 'JUN' => 6, 'JUL' => 7, 'AUG' => 8, 'SEP' => 9, 'OCT' => 10, 'NOV' => 11, 'DEC' => 12 }.freeze
     DAYS = { 'MON' => :monday, 'TUE' => :tuesday, 'WED' => :wednesday, 'THU' => :thursday, 'FRI' => :friday, 'SAT' => :saturday, 'SUN' => :sunday, 'DAILY' => :any, 'DLY' => :any }.freeze
 
+    DATE_RE = /[0-2]\d|3[01]/.freeze
+    DAY_RE = /#{DAYS.keys.join('|')}/.freeze
+    MONTH_RE = /#{MONTHS.keys.join('|')}/.freeze
     H24_RE = /(?<h24>H24)/.freeze
     HOUR_RE = /(?<hour>[01]\d|2[0-4])(?<minute>[0-5]\d)/.freeze
     OPERATIONS_RE = /#{OPERATIONS.keys.join('|')}/.freeze
     EVENT_RE = /(?<event>SR|SS)(?:\s(?<operation>#{OPERATIONS_RE})(?<delta>\d+))?/.freeze
     TIME_RE = /#{HOUR_RE}|#{EVENT_RE}/.freeze
     TIME_RANGE_RE = /#{TIME_RE}-#{TIME_RE}|#{H24_RE}/.freeze
-    DATE_RE = /[0-2]\d|3[01]/.freeze
-    DAY_RE = /#{DAYS.keys.join('|')}/.freeze
-    MONTH_RE = /#{MONTHS.keys.join('|')}/.freeze
+    DATETIME_RE = /(?:(?<month>#{MONTH_RE}) )?(?<date>#{DATE_RE}) (?<time>#{TIME_RE})/.freeze
+    DATETIME_RANGE_RE = /#{DATETIME_RE}-#{DATETIME_RE}/.freeze
 
-    H24 = (AIXM.time('00:00')..AIXM.time('24:00')).freeze
+    H24 = (AIXM::BEGINNING_OF_DAY..AIXM::END_OF_DAY).freeze
 
     # Active dates or days
     #
@@ -46,8 +49,7 @@ module NOTAM
 
     # @!visibility private
     def initialize(actives, times, inactives, base_date:)
-      @actives, @times, @inactives = actives, times, inactives
-      @base_date ||= base_date.at(day: 1)
+      @actives, @times, @inactives, @base_date = actives, times, inactives, base_date
     end
 
     class << self
@@ -58,23 +60,156 @@ module NOTAM
       # @param string [String] raw schedule string
       # @param base_date [Date] month and year to assume when missing (day is
       #   force set to 1)
+      # @return [Array<NOTAM::Schedule>] array of at least one schedule object
       def parse(string, base_date:)
-        raw_actives, raw_times, raw_inactives = string.split(/((?: ?#{TIME_RANGE_RE.decapture})+)/).map(&:strip)
-        raw_inactives = raw_inactives&.sub(/^EXC /, '')
-        allocate.instance_eval do
-          @base_date = base_date.at(day: 1)
-          times = times_from(raw_times)
-          if raw_actives.empty? || raw_actives.match?(DAY_RE)   # actives are days
-            actives = days_from(raw_actives)
-            inactives = raw_inactives ? dates_from(raw_inactives) : Dates.new
+        @rules, @exceptions = cleanup(string).split(/ EXC /).map(&:strip)
+        @base_date = base_date.at(day: 1)
+        case @rules
+        when /^#{DATETIME_RANGE_RE}$/
+          parse_datetimes
+        when /^(#{DAY_RE}|#{TIME_RANGE_RE})/
+          parse_days
+        when /^(#{DATE_RE}|#{MONTH_RE})/
+          parse_dates
+        else
+          fail! "unrecognized schedule"
+        end
+      end
+
+      private
+
+      def parse_datetimes
+        from, to = @rules.split(/-/).map { datetime_from(_1) }
+        delta = to.date - from.date
+        fail! "invalid datetime" if delta < 1
+        inactives = days_from(@exceptions)
+        [
+          new(Dates[from.date], Times[(from.time..AIXM::END_OF_DAY)], inactives, base_date: @base_date),
+          (new(Dates[(from.date.next..to.date.prev)], Times[H24], inactives, base_date: @base_date) if delta > 1),
+          new(Dates[to.date], Times[(AIXM::BEGINNING_OF_DAY..to.time)], inactives, base_date: @base_date)
+        ].compact
+      end
+
+      %i(dates days).each do |active_unit|
+        inactive_unit = active_unit == :days ? :dates : :days
+        define_method("parse_#{active_unit}") do
+          raw_active_unit, raw_times, unmatched = @rules.split(/((?: ?#{TIME_RANGE_RE.decapture})+)/, 3)
+          fail! "unrecognized part after times" unless unmatched.empty?
+          actives = send("#{active_unit}_from", raw_active_unit.strip)
+          times = times_from(raw_times.strip)
+          inactives = send("#{inactive_unit}_from", @exceptions)
+          if times.any? &method(:across_midnight?)
+            times.each_with_object([]) do |time, array|
+              if across_midnight? time
+                array << new(actives, [(time.first..AIXM::END_OF_DAY)], inactives, base_date: @base_date)
+                array << new(actives.next, [(AIXM::BEGINNING_OF_DAY..time.last)], inactives, base_date: @base_date)
+              else
+                array << new(actives, [time], inactives, base_date: @base_date)
+              end
+            end
           else
-            actives = dates_from(raw_actives)
-            inactives = raw_inactives ? days_from(raw_inactives) : Days.new
+            [new(actives, times, inactives, base_date: @base_date)]
           end
-          initialize(actives, times, inactives, base_date: base_date)
-          self
         end
       end
+
+      # @return [String]
+      def cleanup(string)
+        string
+        .gsub(/\s+/, ' ')     # collapse whitespaces to single space
+        .gsub(/ *- */, '-')   # remove spaces around dashes
+        .strip
+      end
+
+      # @return [AIXM::Schedule::DateTime]
+      def datetime_from(string)
+        parts = string.match(DATETIME_RE).named_captures
+        parts['year'] = @base_date.year
+        parts['month'] = MONTHS[parts['month']] || @base_date.month
+        AIXM.datetime(
+          AIXM.date('%4d-%02d-%02d' % parts.slice('year', 'month', 'date').values.map(&:to_i)),
+          AIXM.time(parts['time'])
+        )
+      end
+
+      # @return [Array<Date, Range<Date>>]
+      def dates_from(string)
+        return Dates.new if string.nil?
+        array, index, base_date = [], 0, @base_date.dup
+        while index < string.length
+          case string[index..]
+          when /\A((?<from>#{DATE_RE})-(?:(?<month>#{MONTH_RE}) )?(?<to>#{DATE_RE}))/   # range of dates
+            month = $~[:month] ? MONTHS.fetch($~[:month]) : base_date.month
+            base_date = base_date.at(month: month, wrap: true).tap do |to_base_date|
+              array << (base_date.at(day: $~[:from].to_i)..to_base_date.at(day: $~[:to].to_i))
+            end
+          when /\A(?<day>#{DATE_RE})/   # single date
+            array << base_date.at(day: $~[:day].to_i)
+          when /\A(?<month>#{MONTH_RE})/
+            base_date = base_date.at(month: MONTHS.fetch($~[:month]), wrap: true)
+          else
+            fail! "unrecognized date"
+          end
+          index += $&.length + 1
+        end
+        Dates.new(array)
+      end
+
+      # @return [Array<AIXM::Schedule::Day, Range<AIXM::Schedule::Day>>]
+      def days_from(string)
+        return Days.new if string.nil?
+        array = if string.empty?   # no declared day implies any day
+          [AIXM::ANY_DAY]
+        else
+          string.split(' ').map do |token|
+            from, to = token.split('-')
+            if to   # range of days
+              (AIXM.day(DAYS.fetch(from))..AIXM.day(DAYS.fetch(to)))
+            else   # single day
+              AIXM.day(DAYS.fetch(from))
+            end
+          end
+        end
+        Days.new(array)
+      end
+
+      # @return [Array<Range<AIXM::Schedule::Time>>]
+      def times_from(string)
+        array = string.split(/ (?!#{OPERATIONS_RE})/).map { time_range_from(_1) }
+        Times.new(array)
+      end
+
+      # @return [Range<AIXM::Schedule::Time>]
+      def time_range_from(string)
+        case string
+        when H24_RE
+          H24
+        else
+          from, to = string.split('-')
+          (time_from(from)..time_from(to))
+        end
+      end
+
+      # @return [AIXM::Schedule::Time]
+      def time_from(string)
+        case string
+        when HOUR_RE
+          hour, minute = $~[:hour], $~[:minute]
+          AIXM.time([hour, minute].join(':'))
+        when EVENT_RE
+          event, operation, delta = $~[:event], $~[:operation], $~[:delta]&.to_i
+          AIXM.time(EVENTS.fetch(event), plus: delta ? OPERATIONS.fetch(operation) * delta : 0)
+        else
+          fail! "unrecognized time"
+        end
+      end
+
+      # @return [Boolean]
+      def across_midnight?(time_range)
+        from = time_range.first.time || EVENT_HOURS.fetch(time_range.first.event).time
+        to = time_range.last.time || EVENT_HOURS.fetch(time_range.last.event).time
+        from > to
+      end
     end
 
     # @return [String]
@@ -139,78 +274,6 @@ module NOTAM
       resolve(on: date, xy: xy).slice(date).times.cover? AIXM.time(at)
     end
 
-    private
-
-    # @return [Array<Date, Range<Date>>]
-    def dates_from(string)
-      array, index, base_date = [], 0, @base_date.dup
-      while index < string.length
-        case string[index..]
-        when /\A((?<from>#{DATE_RE})-(?:(?<month>#{MONTH_RE}) )?(?<to>#{DATE_RE}))/   # range of dates
-          month = $~[:month] ? MONTHS.fetch($~[:month]) : base_date.month
-          base_date = base_date.at(month: month, wrap: true).tap do |to_base_date|
-            array << (base_date.at(day: $~[:from].to_i)..to_base_date.at(day: $~[:to].to_i))
-          end
-        when /\A(?<day>#{DATE_RE})/   # single date
-          array << base_date.at(day: $~[:day].to_i)
-        when /\A(?<month>#{MONTH_RE})/
-          base_date = base_date.at(month: MONTHS.fetch($~[:month]), wrap: true)
-        else
-          fail! "unrecognized date"
-        end
-        index += $&.length + 1
-      end
-      Dates.new(array)
-    end
-
-    # @return [Array<AIXM::Schedule::Day, Range<AIXM::Schedue::Day>>]
-    def days_from(string)
-      array = if string.empty?   # no declared day implies any day
-        [AIXM.day(:any)]
-      else
-        string.split(' ').map do |token|
-          from, to = token.split('-')
-          if to   # range of days
-            (AIXM.day(DAYS.fetch(from))..AIXM.day(DAYS.fetch(to)))
-          else   # single day
-            AIXM.day(DAYS.fetch(from))
-          end
-        end
-      end
-      Days.new(array)
-    end
-
-    # @return [Array<Range<AIXM::Schedule::Time>>]
-    def times_from(string)
-      array = string.split(/ (?!#{OPERATIONS_RE})/).map { time_range_from(_1) }
-      Times.new(array)
-    end
-
-    # @return [Range<AIXM::Schedule::Time>]
-    def time_range_from(string)
-      case string
-      when H24_RE
-        H24
-      else
-        from, to = string.split('-')
-        (time_from(from)..time_from(to))
-      end
-    end
-
-    # @return [AIXM::Schedule::Time]
-    def time_from(string)
-      case string
-      when HOUR_RE
-        hour, minute = $~[:hour], $~[:minute]
-        AIXM.time([hour, minute].join(':'))
-      when EVENT_RE
-        event, operation, delta = $~[:event], $~[:operation], $~[:delta]&.to_i
-        AIXM.time(EVENTS.fetch(event), plus: delta ? OPERATIONS.fetch(operation) * delta : 0)
-      else
-        fail! "unrecognized time"
-      end
-    end
-
     # @abstract
     class ScheduleArray < Array
       # @return [String]
@@ -231,6 +294,19 @@ module NOTAM
       def cover?(object)
         any? { object.covered_by? _1 }
       end
+
+      # Step through all elements and shift all dates or days to the next day
+      #
+      # @return [ScheduleArray]
+      def next
+        entries.map do |entry|
+          if entry.instance_of? Range
+            (entry.first.next..entry.last.next)
+          else
+            entry.next
+          end
+        end.then { self.class.new(_1) }
+      end
     end
 
     class Dates < ScheduleArray
@@ -240,7 +316,7 @@ module NOTAM
       def cluster
         self.class.new(
           entries
-            .slice_when { _1.succ != _2 }
+            .slice_when { _1.next != _2 }
             .map { _1.count > 1 ? (_1.first.._1.last) : _1.first }
         )
       end

data/lib/notam/translation.rb

@@ -26,6 +26,14 @@ module NOTAM
       FIRS.fetch(fir)
     end
 
+    # Translates the NOTAM subject group code to human/machine readable symbol
+    #
+    # @param code [String] one letter subject group code
+    # @return [Symbol] value from {NOTAM::SUBJECT_GROUPS}
+    def subject_group_for(code)
+      SUBJECT_GROUPS.fetch(code)
+    end
+
     # Translates the NOTAM subject code to human/machine readable symbol
     #
     # @param code [String] two letter subject code
@@ -34,6 +42,14 @@ module NOTAM
       SUBJECTS.fetch(code)
     end
 
+    # Translates the NOTAM condition group code to human/machine readable symbol
+    #
+    # @param code [String] one letter condition group code
+    # @return [Symbol] value from {NOTAM::CONDITION_GROUPS}
+    def condition_group_for(code)
+      CONDITION_GROUPS.fetch(code)
+    end
+
     # Translates the NOTAM condition code to human/machine readable symbol
     #
     # @param code [String] two letter condition code
@@ -393,6 +409,27 @@ module NOTAM
     'ZYSH' => [:CH]
   }.freeze
 
+  # International NOTAM Q codes for subject groups
+  #
+  # @see https://www.faa.gov/air_traffic/publications/atpubs/notam_html/appendix_b.html
+  SUBJECT_GROUPS = {
+    'A' => :airspace_organization,
+    'C' => :communications_and_surveillance_facilities,
+    'F' => :facilities_and_services,
+    'G' => :gnss_services,
+    'I' => :instrument_and_microwave_landing_system,
+    'K' => :checklist,
+    'L' => :lighting_facilities,
+    'M' => :movement_and_landing_area,
+    'N' => :terminal_and_en_route_navigation_facilities,
+    'O' => :other_information,
+    'P' => :air_traffic_procedures,
+    'R' => :airspace_restrictions,
+    'S' => :air_traffic_and_volmet_services,
+    'W' => :warning,
+    'X' => :other
+  }.freeze
+
   # International NOTAM Q codes for subjects
   #
   # @see https://www.faa.gov/air_traffic/publications/atpubs/notam_html/appendix_b.html
@@ -579,6 +616,19 @@ module NOTAM
     'XX' => :other
   }.freeze
 
+  # International NOTAM Q codes for condition groups
+  #
+  # @see https://www.faa.gov/air_traffic/publications/atpubs/notam_html/appendix_b.html
+  CONDITION_GROUPS = {
+    'A' => :availability,
+    'C' => :changes,
+    'H' => :hazard_conditions,
+    'K' => :checklist,
+    'L' => :limitations,
+    'T' => :trigger,
+    'X' => :other
+  }.freeze
+
   # International NOTAM Q codes for conditions
   #
   # @see https://www.faa.gov/air_traffic/publications/atpubs/notam_html/appendix_b.html

data/lib/notam/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notam
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Sven Schwyn
@@ -10,27 +10,26 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MQ0wCwYDVQQDDARydWJ5
-  MRkwFwYKCZImiZPyLGQBGRYJYml0Y2V0ZXJhMRMwEQYKCZImiZPyLGQBGRYDY29t
-  MB4XDTIxMTEwODE0MzIyM1oXDTIyMTEwODE0MzIyM1owPzENMAsGA1UEAwwEcnVi
-  eTEZMBcGCgmSJomT8ixkARkWCWJpdGNldGVyYTETMBEGCgmSJomT8ixkARkWA2Nv
-  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANwuD4geNdhpSVNJTtHb
-  fmVAoPxmER4oyGgaVJSidn/OjU5PcpdypMI/WIxfvjfFizq6kQYAsJZbCr6fG+UN
-  2dZGMXcAC/uKQL5nYESjCPJ4IJP/SC+fiiEpxHQk7PNFoiUVRUieUZIAfHZAdnY3
-  ye1/niW7ud0vwKIMrysKWxjgkE0Y6Af1QLzV/6brVRRC5MvHIzYJd8BiSP+wY1O8
-  VElw1f6d90KEz2vaQfX7vCxrzIbvAnYiSvM0AIPy/zigTqpW6w3w4sQxQj81oQ9U
-  9vDYtQzXj0c9VrSLvb0DgiGug2cU2bDjA4L3cBE1szX4tbfo8syYqMq51/kTGDxW
-  YNUCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJ8r
-  wy1HraZDqg3Khf9UonMWMtJUMB0GA1UdEQQWMBSBEnJ1YnlAYml0Y2V0ZXJhLmNv
-  bTAdBgNVHRIEFjAUgRJydWJ5QGJpdGNldGVyYS5jb20wDQYJKoZIhvcNAQEFBQAD
-  ggEBACI7lJKRbnRjz0T4Wb9jH4SE0A2yaHAoBzj96luVDjNyoRT3688trEZS75Sg
-  GKfChxqKncBrSpxJ0YfWbymNHfUrKhcdSifJ/TtUrTasm6LSnJYLOnLKDO3v8eL3
-  gRTq8a5wA7Xtijx3MJEyzdeUh7N+UMKuPps/flPgH5yabUxgxrvuhrXF7Z96nrsP
-  EOmNMTc8H7wo4BAKfuMcI/Gh2oCf+tAhr0bGsXyBikmJ6XA45mrOMgv19M1+aMpn
-  1+2Y1+i+4jd1B7qxIgOLxQTNIJiwE0sqU1itFfuesfgUACS7M0IV9u9Bp4hBGNEw
-  5JcY2h7owdMxXIvgk1oakgldFJc=
+  MIIDODCCAiCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhydWJ5
+  L0RDPWJpdGNldGVyYS9EQz1jb20wHhcNMjIxMTA2MTIzNjUwWhcNMjMxMTA2MTIz
+  NjUwWjAjMSEwHwYDVQQDDBhydWJ5L0RDPWJpdGNldGVyYS9EQz1jb20wggEiMA0G
+  CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDcLg+IHjXYaUlTSU7R235lQKD8ZhEe
+  KMhoGlSUonZ/zo1OT3KXcqTCP1iMX743xYs6upEGALCWWwq+nxvlDdnWRjF3AAv7
+  ikC+Z2BEowjyeCCT/0gvn4ohKcR0JOzzRaIlFUVInlGSAHx2QHZ2N8ntf54lu7nd
+  L8CiDK8rClsY4JBNGOgH9UC81f+m61UUQuTLxyM2CXfAYkj/sGNTvFRJcNX+nfdC
+  hM9r2kH1+7wsa8yG7wJ2IkrzNACD8v84oE6qVusN8OLEMUI/NaEPVPbw2LUM149H
+  PVa0i729A4IhroNnFNmw4wOC93ARNbM1+LW36PLMmKjKudf5Exg8VmDVAgMBAAGj
+  dzB1MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBSfK8MtR62mQ6oN
+  yoX/VKJzFjLSVDAdBgNVHREEFjAUgRJydWJ5QGJpdGNldGVyYS5jb20wHQYDVR0S
+  BBYwFIEScnVieUBiaXRjZXRlcmEuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQAYG2na
+  ye8OE2DANQIFM/xDos/E4DaPWCJjX5xvFKNKHMCeQYPeZvLICCwyw2paE7Otwk6p
+  uvbg2Ks5ykXsbk5i6vxDoeeOLvmxCqI6m+tHb8v7VZtmwRJm8so0eSX0WvTaKnIf
+  CAn1bVUggczVdNoBXw9WAILKyw9bvh3Ft740XZrR74sd+m2pGwjCaM8hzLvrVbGP
+  DyYhlBeRWyQKQ0WDIsiTSRhzK8HwSTUWjvPwx7SEdIU/HZgyrk0ETObKPakVu6bH
+  kAyiRqgxF4dJviwtqI7mZIomWL63+kXLgjOjMe1SHxfIPo/0ji6+r1p4KYa7o41v
+  fwIwU1MKlFBdsjkd
   -----END CERTIFICATE-----
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aixm
@@ -41,7 +40,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -51,7 +50,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -258,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Parser for NOTAM (Notice to Airmen) messages