aixm 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33661b6ab9022c54a9d41dad531b0f1c53f39eaf053a6c4b8361c50543b9ae01
-  data.tar.gz: add22919257222a6f06dae9de21f0f71c2b941a67e6bc52dba14bde5fbae6c9a
+  metadata.gz: af33154acb182006b0c9f4e048c305b2489cba22d15ee1bc9aa724ddec70ceab
+  data.tar.gz: 44c42b5e93537e33cb2623a19a043216853664358d5c616f59aa884ee4c3e80c
 SHA512:
-  metadata.gz: c1fb317e1791098f127c769e5f680bbf0c30ab823c73c48f392d6ea918f1ba4c6396d4e5cb43357ef1c867bad73e475d25be95b274bad7fd9ee17ce297dbbb6f
-  data.tar.gz: 904a2fa5c84b80bf14a67536fa2c0f2ab26b6d34dc3dc789e272116812994f86b9c3aff92b08d1cda9b3d3495abfe990eb922f0579fd779a1602963ba28ded59
+  metadata.gz: e960a18401dd58557db667b01cb3f15683728798f3aee736fda794a18519d7b3fb99e0725154a01b564a4e35658cdde5310402fd1c2b6f2e4550880cf47db98b
+  data.tar.gz: 2855fb8f01ca9dd515e8c05b60e79d80f4d4af77b48f1b03cc4baaadd1451810b877c92cd9364cb5d84b80f6d99ebda3b8c21d2445143f9d078a9e4e7ef2cc76

data/CHANGELOG.md

@@ -1,7 +1,37 @@
+## Main
+
+Nothing so far
+
+## 1.3.0
+
+#### Breaking Changes
+* `Document#created_at` no longer falls back to `Document#effective_at`
+
+#### Additions
+* Refinement to pretty print Nokogiri XML documents
+* XML comments on features (e.g. to include raw NOTAM)
+* `Document#expiration_at` for OFMX
+* Generic features as raw XML (e.g. extracted from another AIXM/OFMX file)
+
+## 1.2.1
+
+#### Additions
+* Rounding of `AIXM::Schedule::Time`
+
+## 1.2.0
+
+#### Additions
+* `Timesheet` to add custom schedules to `Timetable`
+* `AIXM::Schedule::(Date|Day|Time)` for custom timetables
+* Interface to allow most class instances as Hash keys
+
+#### Fixes
+* Fix typo in `GUESSED_UNIT_TYPES_MAP`
+
 ## 1.1.0
 
 #### Breaking Changes
-* `AIXM::Association:Array#duplicates` now returns an array of arrays which
+* `AIXM::Concerns::Association:Array#duplicates` now returns an array of arrays which
   group all duplicates together.
 * `VOR#associate_dme` and `VOR#associate_tacan` no longer take the channel
   as argument but calculate it from the (ghost) frequency of the VOR.
@@ -55,10 +85,10 @@
 
 #### Additions
 * Proper `has_many` and `has_one` associations
-* `AIXM::Association:Array#find_by|find|duplicates` on `has_many` associations
+* `AIXM::Concerns::Association:Array#find_by|find|duplicates` on `has_many` associations
 * `AIXM.config.mid` now defines whether `mid` attributes are inserted or not
   provided the selected schema is OFMX
-* `AIXM::Memoize` module
+* `AIXM::Concerns::Memoize` module
 * `AIXM::PayloadHash` class
 * `mkmid` executable to insert `mid` attributes into valid OFMX file
 * `ckmid` executable to check `mid` attributes in an OFMX file

data/README.md

@@ -11,7 +11,7 @@ For now, only the parts needed to automize the AIP import of [open flightmaps](h
 
 * [Homepage](https://github.com/svoop/aixm)
 * [API](https://www.rubydoc.info/gems/aixm)
-* Author: [Sven Schwyn - Bitcetera](http://www.bitcetera.com)
+* Author: [Sven Schwyn - Bitcetera](https://bitcetera.com)
 
 ## Install
 
@@ -28,7 +28,7 @@ gem cert --add <(curl -Ls https://raw.github.com/svoop/aixm/main/certs/svoop.pem
 Add the following to the <tt>Gemfile</tt> or <tt>gems.rb</tt> of your [Bundler](https://bundler.io) powered Ruby project:
 
 ```ruby
-gem aixm
+gem 'aixm'
 ```
 
 And then install the bundle:
@@ -163,6 +163,7 @@ AIXM.config.ignored_errors = /invalid date/i
 * [Organisation](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Organisation.html)
 * [Service](https://www.rubydoc.info/gems/aixm/AIXM/Component/Service.html)
 * [Unit](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Unit.html)
+* [Generic](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Generic.html)
 
 ### Components
 
@@ -182,6 +183,7 @@ AIXM.config.ignored_errors = /invalid date/i
 * [Service](https://www.rubydoc.info/gems/aixm/AIXM/Component/Service.html)
 * [Surface](https://www.rubydoc.info/gems/aixm/AIXM/Component/Surface.html)
 * [Timetable](https://www.rubydoc.info/gems/aixm/AIXM/Component/Timetable.html)
+* [Timesheet](https://www.rubydoc.info/gems/aixm/AIXM/Component/Timesheet.html)
 * [VASIS](https://www.rubydoc.info/gems/aixm/AIXM/Component/VASIS.html)
 * [Vertical limit](https://www.rubydoc.info/gems/aixm/AIXM/Component/VerticalLimit.html)
 
@@ -189,7 +191,7 @@ AIXM.config.ignored_errors = /invalid date/i
 
 The different models are interwoven with [`has_many` and `has_one` associations](https://www.rubydoc.info/gems/aixm/AIXM/Association).
 
-Please note that `has_many` associations are instances `AIXM::Association::Array` which mostly behave like normal arrays. However, you must not add or remove elements on the array directly but use the corresponding method on the associating model instead:
+Please note that `has_many` associations are instances `AIXM::Concerns::Association::Array` which mostly behave like normal arrays. However, you must not add or remove elements on the array directly but use the corresponding method on the associating model instead:
 
 ```ruby
 document.features << airport   # => NoMethodError
@@ -229,6 +231,33 @@ Equally on `has_many` associations, use `duplicates` to find identical or equal
 document.features.duplicates   # => [#<AIXM::Feature::Unit>, #<AIXM::Component::Service>, ...]
 ```
 
+## XML Comments
+
+All features implement the `comment` attribute which accepts any object and converts it `#to_s`. When set, an XML comment is inserted right after the opening tag of the feature. This comes in handy e.g. in case you want to include source data facsimile such as NOTAM. Oneline and multiline comments are inserted differently:
+
+```xml
+<Ase>
+  <!--
+    B0330/22 NOTAMR B1756/21
+    Q) LSAS/QAFLT/V/NBO/E/000/050/4734N00841E005
+    A) LSAS B) 2203170746 C) 2206242359 EST
+  -->
+  <AseUid>
+    <codeType>RAS</codeType>
+    <codeId>B0330/22</codeId>
+  </AseUid>
+  (...)
+</Ase>
+
+<Org>
+  <!-- Generic organisation -->
+  <OrgUid>
+    <txtName>FRANCE</txtName>
+  </OrgUid>
+  (...)
+</Org>
+```
+
 ## Payload Hash
 
 OFMX defines a [payload hash function](https://gitlab.com/openflightmaps/ofmx/wikis/Functions) used to facilitate association and modification tracking. It is used internally, but you can also use it in your own code:
@@ -274,6 +303,7 @@ ckmid --help
 ### AIXM
 * [AIXM](http://aixm.aero)
 * [AICM 4.5 documentation](https://openflightmaps.gitlab.io/ofmx/aixm/4.5/manual/aicm/)
+* [AICM 4.5 manual](https://www.aixm.aero/sites/aixm.aero/files/imce/library/aicm_manual_4-5.pdf)
 * [AIXM 4.5 specification](http://aixm.aero/document/aixm-45-specification)
 
 ### OFMX

data/exe/ckmid

@@ -1,11 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'bundler/inline'
-
-gemfile do
-  source 'https://rubygems.org'
-  ruby '>= 3.0'
-  gem 'aixm', '~> 0'
-end
+require 'aixm'
 
 AIXM::Executables::Ckmid.new.run

data/exe/mkmid

@@ -1,11 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'bundler/inline'
-
-gemfile do
-  source 'https://rubygems.org'
-  ruby '>= 3.0'
-  gem 'aixm', '~> 0'
-end
+require 'aixm'
 
 AIXM::Executables::Mkmid.new.run

data/lib/aixm/a.rb

@@ -24,6 +24,8 @@ module AIXM
   #   a.invert             # => #<AIXM::A -137.8° "22R">
   #   a.to_s(:runway)      # => "22R"
   class A
+    include AIXM::Concerns::HashEquality
+
     SUFFIX_INVERSIONS = {
       R: :L,
       L: :R
@@ -31,12 +33,23 @@ module AIXM
 
     RUNWAY_RE = /\A(0[1-9]|[12]\d|3[0-6])([A-Z])?\z/
 
-    # @return [Integer] angle in the range of -360 < angle < 360
+    # Angle in the range of -360 < angle < 360.
+    #
+    # @overload deg
+    #   @return [Integer]
+    # @overload deg=(value)
+    #   @param value [Integer]
     attr_reader :deg
 
-    # @return [Symbol, nil] one-letter suffix
+    # One-letter suffix.
+    #
+    # @overload suffix
+    #   @return [Symbol, nil]
+    # @overload suffix=(value)
+    #   @param value [Symbol, nil]
     attr_reader :suffix
 
+    # See the {overview}[AIXM::A] for examples.
     def initialize(value)
       case value
       when String
@@ -54,12 +67,16 @@ module AIXM
       %Q(#<#{self.class} #{to_s} #{to_s(:runway).inspect}>)
     end
 
-    # @return [Integer] within 0..359
+    # Degrees in the range of 0..359
+    #
+    # @return [Integer]
     def to_i
       (deg.round + 360) % 360
     end
 
-    # @return [Float] within 0.0..359.9~
+    # Degrees in the range of 0.0...360.0
+    #
+    # @return [Float]
     def to_f
       ((deg + 360) % 360).to_f
     end
@@ -96,20 +113,20 @@ module AIXM
       @suffix = value&.to_s&.to_sym
     end
 
-    # Invert an angle by 180 degrees
+    # Invert an angle by 180 degrees.
     #
     # @example
     #   AIXM.a(120).invert     # (300°)
     #   AIXM.a("34L").invert   # (160° suffix "R")
     #
-    # @return [AIXM::A] inverted angle
+    # @return [AIXM::A]
     def invert
       self.class.new(deg.negative? ? deg - 180 : deg + 180).tap do |angle|
         angle.suffix = SUFFIX_INVERSIONS.fetch(suffix, suffix)
       end
     end
 
-    # Check whether +other+ angle is the inverse
+    # Whether other angle is the inverse.
     #
     # @example
     #   AIXM.a(120).inverse_of? AIXM.a(300)       # => true
@@ -117,19 +134,19 @@ module AIXM
     #   AIXM.a("33X").inverse_of? AIXM.a("33X")   # => true
     #   AIXM.a("16R").inverse_of? AIXM.a("16L")   # => false
     #
-    # @return [Boolean] whether the inverted angle or not
+    # @return [Boolean]
     def inverse_of?(other)
       invert == other
     end
 
-    # Negate degrees
+    # Negate degrees.
     #
     # @return [AIXM::A]
     def -@
       deg.zero? ? self : self.class.new(-deg).tap { _1.suffix = suffix }
     end
 
-    # Add degrees
+    # Add degrees.
     #
     # @param value [Numeric, AIXM::A]
     # @return [AIXM::A]
@@ -144,7 +161,7 @@ module AIXM
       end
     end
 
-    # Subtract degrees
+    # Subtract degrees.
     #
     # @param value [Numeric, AIXM::A]
     # @return [AIXM::A]
@@ -153,16 +170,13 @@ module AIXM
     end
 
     # @see Object#==
-    # @return [Boolean]
     def ==(other)
       self.class === other  && deg == other.deg && suffix == other.suffix
     end
-    alias_method :eql?, :==
 
     # @see Object#hash
-    # @return [Integer]
     def hash
-      [deg, suffix].join.hash
+      [self.class, deg, suffix].join.hash
     end
   end
 

data/lib/aixm/classes.rb

@@ -11,6 +11,9 @@ module AIXM
     a: 'AIXM::A',
     w: 'AIXM::W',
     p: 'AIXM::P',
+    date: 'AIXM::Schedule::Date',
+    day: 'AIXM::Schedule::Day',
+    time: 'AIXM::Schedule::Time',
     address: 'AIXM::Component::Address',
     approach_lighting: 'AIXM::Component::ApproachLighting',
     organisation: 'AIXM::Feature::Organisation',
@@ -41,7 +44,9 @@ module AIXM
     obstacle: 'AIXM::Feature::Obstacle',
     obstacle_group: 'AIXM::Feature::ObstacleGroup',
     timetable: 'AIXM::Component::Timetable',
-    vasis: 'AIXM::Component::VASIS'
+    timesheet: 'AIXM::Component::Timesheet',
+    vasis: 'AIXM::Component::VASIS',
+    generic: 'AIXM::Feature::Generic'
   }.freeze
 
 end

data/lib/aixm/component/address.rb

@@ -14,8 +14,8 @@ module AIXM
     #
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#aha-airport-address
     class Address < Component
-      include AIXM::Association
-      include AIXM::Memoize
+      include AIXM::Concerns::Association
+      include AIXM::Concerns::Remarks
 
       public_class_method :new
 
@@ -39,15 +39,24 @@ module AIXM
       #   @return [AIXM::Feature] addressable feature
       belongs_to :addressable
 
-      # @return [Symbol] type of address (see {TYPES})
+      # Type of address
+      #
+      # @overload type
+      #   @return [Symbol] any of {TYPES}
+      # @overload type=(value)
+      #   @param value [Symbol] any of {TYPES}
       attr_reader :type
 
-      # @return [String] postal address, phone number, radio frequency etc
+      # Postal address, phone number, radio frequency etc
+      #
+      # @overload address
+      #   @return [String]
+      # @overload address=(value)
+      #   @param value [String]
       attr_reader :address
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::Address] for examples on how to
+      # create instances of this class.
       def initialize(type:, address:)
         self.type, self.address = type, address
       end
@@ -72,30 +81,24 @@ module AIXM
         end
       end
 
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
-      # @return [String] UID markup
-      def to_uid(as:, sequence:)
-        builder = Builder::XmlMarkup.new(indent: 2)
-        builder.tag!(as) do |tag|
-          tag << addressable.to_uid.indent(2) if addressable
+      # @!visibility private
+      def add_uid_to(builder, as:, sequence:)
+        builder.send(as) do |tag|
+          addressable.add_uid_to(tag) if addressable
           tag.codeType(TYPES.key(type).to_s.then_if(AIXM.aixm?) { _1.sub(/-\w+$/, '') })
           tag.noSeq(sequence)
         end
       end
-      memoize :to_uid
 
-      # @return [String] AIXM or OFMX markup
-      def to_xml(as:, sequence:)
-        builder = Builder::XmlMarkup.new(indent: 2)
-        builder.comment! ["Address: #{TYPES.key(type)}", addressable&.id].compact.join(' for ')
-        builder.tag!(as) do |tag|
-          tag << to_uid(as: :"#{as}Uid", sequence: sequence).indent(2)
+      # @!visibility private
+      def add_to(builder, as:, sequence:)
+        builder.comment ["Address: #{TYPES.key(type)}", addressable&.id].compact.join(' for ').dress
+        builder.text "\n"
+        builder.send(as) do |tag|
+          add_uid_to(tag, as: :"#{as}Uid", sequence: sequence)
           case type
           when :radio_frequency
-            tag.txtAddress(address.freq.to_s)
+            tag.txtAddress(address.freq)
           else
             tag.txtAddress(address)
           end

data/lib/aixm/component/approach_lighting.rb

@@ -17,8 +17,9 @@ module AIXM
     #
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#rda-runway-direction-approach-lighting
     class ApproachLighting < Component
-      include AIXM::Association
-      include AIXM::Memoize
+      include AIXM::Concerns::Association
+      include AIXM::Concerns::Intensity
+      include AIXM::Concerns::Remarks
 
       TYPES = {
         A: :cat_1,
@@ -41,35 +42,44 @@ module AIXM
         OTHER: :other   # specify in remarks
       }.freeze
 
-      INTENSITIES = {
-        LIL: :low,
-        LIM: :medium,
-        LIH: :high,
-        OTHER: :other   # specify in remarks
-      }.freeze
-
       # @!method approach_lightable
       #   @return [AIXM::Component::Runway::Direction, AIXM::Component::FATO::Direction] approach lighted entity
       belongs_to :approach_lightable
 
-      # @return [Symbol, nil] type of the approach lighting system (see {TYPES})
+      # Type of the approach lighting system
+      #
+      # @overload type
+      #   @return [Symbol] any of {TYPES}
+      # @overload type=(value)
+      #   @param value [Symbol] any of {TYPES}
       attr_reader :type
 
-      # @return [AIXM::D, nil] length
+      # Length
+      #
+      # @overload length
+      #   @return [AIXM::D, nil]
+      # @overload length=(value)
+      #   @param value [AIXM::D, nil]
       attr_reader :length
 
-      # @return [Symbol, nil] intensity of lights (see {INTENSITIES})
-      attr_reader :intensity
-
-      # @return [Boolean, nil] whether sequenced flash is available
+      # Whether sequenced flash is available
+      #
+      # @overload sequenced_flash
+      #   @return [Boolean, nil] +nil+ means unknown
+      # @overload sequenced_flash=(value)
+      #   @param value [Boolean, nil] +nil+ means unknown
       attr_reader :sequenced_flash
 
-      # @return [String, nil] description of the flash sequence
+      # Description of the flash sequence
+      #
+      # @overload flash_description
+      #   @return [String, nil]
+      # @overload flash_description=(value)
+      #   @param value [String, nil]
       attr_reader :flash_description
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::ApproachLighting] for examples on
+      # how to create instances of this class.
       def initialize(type:)
         self.type = type
       end
@@ -88,10 +98,6 @@ module AIXM
         @length = value
       end
 
-      def intensity=(value)
-        @intensity = value.nil? ? nil : INTENSITIES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid intensity")
-      end
-
       def sequenced_flash=(value)
         fail(ArgumentError, "invalid sequenced flash") unless [true, false, nil].include? value
         @sequenced_flash = value
@@ -101,35 +107,27 @@ module AIXM
         @flash_description = value&.to_s
       end
 
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
-      # @return [String] UID markup
-      def to_uid(as:)
-        builder = Builder::XmlMarkup.new(indent: 2)
-        builder.tag!(as) do |tag|
-          tag << approach_lightable.to_uid.indent(2)
-          tag.codeType(TYPES.key(type).to_s)
+      # @!visibility private
+      def add_uid_to(builder, as:)
+        builder.send(as) do |tag|
+          approach_lightable.add_uid_to(tag)
+          tag.codeType(TYPES.key(type))
         end
       end
-      memoize :to_uid
 
-      # @return [String] AIXM or OFMX markup
-      def to_xml(as:)
-        builder = Builder::XmlMarkup.new(indent: 2)
-        builder.tag!(as) do |tag|
-          tag << to_uid(as: "#{as}Uid").indent(2)
+      # @!visibility private
+      def add_to(builder, as:)
+        builder.send(as) do |tag|
+          add_uid_to(tag, as: "#{as}Uid")
           if length
             tag.valLen(length.dim.round)
             tag.uomLen(length.unit.to_s.upcase)
           end
-          tag.codeIntst(INTENSITIES.key(intensity).to_s) if intensity
+          tag.codeIntst(INTENSITIES.key(intensity)) if intensity
           tag.codeSequencedFlash(sequenced_flash ? 'Y' : 'N') unless sequenced_flash.nil?
           tag.txtDescrFlash(flash_description) if flash_description
           tag.txtRmk(remarks) if remarks
         end
-        builder.target!
       end
     end
   end