aixm 0.3.7 → 1.0.0

data/lib/aixm/component/runway.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
 
     # Runways are landing and takeoff strips for forward propelled aircraft.
     #
@@ -44,8 +44,11 @@ module AIXM
     #   runway.forth.geographic_orientation = 165
     #   runway.back = nil
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#rwy-runway
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#rwy-runway
     class Runway
+      include AIXM::Association
+      include AIXM::Memoize
+
       STATUSES = {
         CLSD: :closed,
         WIP: :work_in_progress,          # e.g. construction work
@@ -55,8 +58,21 @@ module AIXM
         OTHER: :other                    # specify in remarks
       }
 
-      # @return [AIXM::Feature::Airport] airport the runway belongs to
-      attr_reader :airport
+      # @!method forth
+      #   @return [AIXM::Component::Runway::Direction] main direction
+      # @!method forth=(forth)
+      #   @param forth [AIXM::Component::Runway::Direction]
+      has_one :forth, accept: 'AIXM::Component::Runway::Direction'
+
+      # @!method back
+      #   @return [AIXM::Component::Runway::Direction, nil] reverse direction
+      # @!method back=(back)
+      #   @param back [AIXM::Component::Runway::Direction, nil]
+      has_one :back, accept: 'AIXM::Component::Runway::Direction', allow_nil: true
+
+      # @!method airport
+      #   @return [AIXM::Feature::Airport] airport the runway belongs to
+      belongs_to :airport
 
       # @return [String] full name of runway (e.g. "12/30" or "16L/34R")
       attr_reader :name
@@ -76,18 +92,12 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      # @return [AIXM::Component::Runway::Direction] main direction
-      attr_accessor :forth
-
-      # @return [AIXM::Component::Runway::Direction] reverse direction
-      attr_accessor :back
-
       def initialize(name:)
         self.name = name
-        @name.split("/").tap do |forth, back|
-          @forth = Direction.new(runway: self, name: AIXM.a(forth))
-          @back = Direction.new(runway: self, name: AIXM.a(back)) if back
-          fail(ArgumentError, "invalid name") unless !@back || @back.name.inverse_of?(@forth.name)
+        @name.split("/").tap do |forth_name, back_name|
+          self.forth = Direction.new(name: AIXM.a(forth_name))
+          self.back = Direction.new(name: AIXM.a(back_name)) if back_name
+          fail(ArgumentError, "invalid name") unless !back || back.name.inverse_of?(@forth.name)
         end
         @surface = AIXM.surface
       end
@@ -97,12 +107,6 @@ module AIXM
         %Q(#<#{self.class} airport=#{airport&.id.inspect} name=#{name.inspect}>)
       end
 
-      def airport=(value)
-        fail(ArgumentError, "invalid airport") unless value.is_a? AIXM::Feature::Airport
-        @airport = value
-      end
-      private :airport=
-
       def name=(value)
         fail(ArgumentError, "invalid name") unless value.is_a? String
         @name = value.uptrans
@@ -112,7 +116,7 @@ module AIXM
         @length = if value
           fail(ArgumentError, "invalid length") unless value.is_a?(AIXM::D) && value.dist > 0
           fail(ArgumentError, "invalid length unit") if width && width.unit != value.unit
-          @length = value
+          value
         end
       end
 
@@ -120,7 +124,7 @@ module AIXM
         @width = if value
           fail(ArgumentError, "invalid width") unless value.is_a?(AIXM::D)  && value.dist > 0
           fail(ArgumentError, "invalid width unit") if length && length.unit != value.unit
-          @width = value
+          value
         end
       end
 
@@ -140,6 +144,7 @@ module AIXM
           rwy_uid.txtDesig(name)
         end
       end
+      memoize :to_uid
 
       # @return [String] AIXM or OFMX markup
       def to_xml
@@ -167,16 +172,27 @@ module AIXM
       # Runway directions further describe each direction {#forth} and {#back}
       # of a runway.
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Airport#rdn-runway-direction
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#rdn-runway-direction
       class Direction
+        include AIXM::Association
+        include AIXM::Memoize
+
         VFR_PATTERNS = {
           L: :left,
           R: :right,
           E: :left_or_right
         }
 
-        # @return [AIXM::Component::Runway] runway the runway direction is further describing
-        attr_reader :runway
+        # @!method lightings
+        #   @return [Array<AIXM::Component::Lighting>] installed lighting systems
+        # @!method add_lighting(lighting)
+        #   @param lighting [AIXM::Component::Lighting]
+        #   @return [self]
+        has_many :lightings, as: :lightable
+
+        # @!method runway
+        #   @return [AIXM::Component::Runway] runway the runway direction is further describing
+        belongs_to :runway, readonly: true
 
         # @return [AIXM::A] partial name of runway (e.g. "12" or "16L")
         attr_reader :name
@@ -201,12 +217,8 @@ module AIXM
         # @return [String, nil] free text remarks
         attr_reader :remarks
 
-        # @return [Array<AIXM::Component::Lighting>] installed lighting systems
-        attr_reader :lightings
-
-        def initialize(runway:, name:)
-          self.runway, self.name = runway, name
-          @lightings = []
+        def initialize(name:)
+          self.name = name
         end
 
         # @return [String]
@@ -214,12 +226,6 @@ module AIXM
           %Q(#<#{self.class} airport=#{runway&.airport&.id.inspect} name=#{name.inspect}>)
         end
 
-        def runway=(value)
-          fail(ArgumentError, "invalid runway") unless value.is_a? AIXM::Component::Runway
-          @runway = value
-        end
-        private :runway
-
         def name=(value)
           fail(ArgumentError, "invalid name") unless value.is_a? AIXM::A
           @name = value
@@ -263,21 +269,10 @@ module AIXM
           @remarks = value&.to_s
         end
 
-        # Add a lighting system to the runway direction.
-        #
-        # @param lighting [AIXM::Component::Lighting] lighting instance
-        # @return [self]
-        def add_lighting(lighting)
-          fail(ArgumentError, "invalid lighting") unless lighting.is_a? AIXM::Component::Lighting
-          lighting.send(:lightable=, self)
-          @lightings << lighting
-          self
-        end
-
         # @return [AIXM::A] magnetic orientation (magnetic bearing) in degrees
         def magnetic_orientation
           if geographic_orientation && runway.airport.declination
-            geographic_orientation + runway.airport.declination
+            geographic_orientation - runway.airport.declination
           end
         end
 
@@ -289,6 +284,7 @@ module AIXM
             rdn_uid.txtDesig(name)
           end
         end
+        memoize :to_uid
 
         # @return [String] AIXM or OFMX markup
         def to_xml
@@ -309,10 +305,7 @@ module AIXM
           if displaced_threshold
             builder.Rdd do |rdd|
               rdd.RddUid do |rdd_uid|
-                rdd_uid.RdnUid do |rdn_uid|
-                  rdn_uid << runway.to_uid.indent(6)
-                  rdn_uid.txtDesig(name)
-                end
+                rdd_uid << to_uid.indent(4)
                 rdd_uid.codeType('DPLM')
                 rdd_uid.codeDayPeriod('A')
               end

data/lib/aixm/{feature → component}/service.rb

@@ -1,22 +1,22 @@
 using AIXM::Refinements
 
 module AIXM
-  class Feature
+  module Component
 
     # Service provided by a unit.
     #
     # ===Cheat Sheet in Pseudo Code:
     #   service = AIXM.service(
-    #     source: String or nil
     #     type: TYPES
     #   )
     #   service.timetable = AIXM.timetable or nil
     #   service.remarks = String or nil
     #   service.add_frequency(AIXM.frequency)
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Organisation#ser-service
-    class Service < Feature
-      public_class_method :new
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Organisation#ser-service
+    class Service
+      include AIXM::Association
+      include AIXM::Memoize
 
       TYPES = {
         ACS: :area_control_service,
@@ -125,10 +125,21 @@ module AIXM
         :vhf_direction_finding_service => :vdf_direction_finding_station,
         :volmet_service => :meteorological_office,
         :other => :other
-}
+      }.freeze
+
+      # @!method frequencies
+      #   @return [Array<AIXM::Component::Frequency>] frequencies used by this service
+      # @!method add_frequency(frequency)
+      #   @param frequency [AIXM::Component::Frequency]
+      has_many :frequencies
 
-      # @return [AIXM::Feature::Unit] unit providing this service
-      attr_reader :unit
+      # @!method unit
+      #   @return [AIXM::Feature::Unit] unit providing this service
+      belongs_to :unit
+
+      # @!method layer
+      #   @return [AIXM::Component::Layer] airspace layer this service is provided within
+      belongs_to :layer
 
       # @return [Symbol] type of service (see {TYPES})
       attr_reader :type
@@ -139,13 +150,9 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      # @return [Array<AIXM::Component::Frequency>] frequencies used by this service
-      attr_reader :frequencies
-
-      def initialize(source: nil, type:)
-        super(source: source)
+      def initialize(type:)
         self.type = type
-        @frequencies = []
+        @sequence = 1
       end
 
       # @return [String]
@@ -153,12 +160,6 @@ module AIXM
         %Q(#<#{self.class} type=#{type.inspect}>)
       end
 
-      def unit=(value)
-        fail(ArgumentError, "invalid unit") unless value.is_a? AIXM::Feature::Unit
-        @unit = value
-      end
-      private :unit=
-
       def type=(value)
         @type = TYPES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid type")
       end
@@ -172,17 +173,6 @@ module AIXM
         @remarks = value&.to_s
       end
 
-      # Add a frequency used by this service
-      #
-      # @param frequency [AIXM::Component::Frequency] frequency instance
-      # @return [self]
-      def add_frequency(frequency)
-        fail(ArgumentError, "invalid frequency") unless frequency.is_a? AIXM::Component::Frequency
-        frequency.send(:service=, self)
-        @frequencies << frequency
-        self
-      end
-
       # Guess the unit type for this service
       #
       # @return [Symbol, nil] guessed unit type or +nil+ if unmappable
@@ -192,6 +182,7 @@ module AIXM
 
       # @return [String] UID markup
       def to_uid
+        resequence!
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.SerUid do |ser_uid|
           ser_uid << unit.to_uid.indent(2)
@@ -199,13 +190,13 @@ module AIXM
           ser_uid.noSeq(@sequence)
         end
       end
+      memoize :to_uid
 
       # @return [String] AIXM or OFMX markup
-      def to_xml(sequence:)
-        @sequence = sequence
+      def to_xml
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.comment! ["Service: #{TYPES.key(type)}", unit&.name].compact.join(' by ')
-        builder.Ser({ source: (source if AIXM.ofmx?) }.compact) do |ser|
+        builder.comment! ["Service: #{TYPES.key(type)}", unit&.send(:name_with_type)].compact.join(' by ')
+        builder.Ser do |ser|
           ser << to_uid.indent(2)
           ser << timetable.to_xml(as: :Stt).indent(2) if timetable
           ser.txtRmk(remarks) if remarks
@@ -215,6 +206,16 @@ module AIXM
         end
         builder.target!
       end
+
+      private
+
+      def resequence!
+        unit.services.sort { |a, b| a.type <=> b.type }.each.with_object({}) do |service, sequences|
+          sequences[service.type] = (sequences[service.type] || 0) + 1
+          service.instance_variable_set(:@sequence, sequences[service.type])
+        end
+      end
+
     end
 
   end

data/lib/aixm/component/surface.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
 
     # Surface of a runway, helipad etc
     #
@@ -21,7 +21,7 @@ module AIXM
     # * +AIXM::PCN_RE+ - regular expression to match PCN notations
     #
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#rwy-runway
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#rwy-runway
     class Surface
       COMPOSITIONS = {
         ASPH: :asphalt,
@@ -109,7 +109,7 @@ module AIXM
       def pcn=(value)
         return @pcn = {} if value.nil?
         fail(ArgumentError, "invalid PCN") unless match = value.to_s.upcase.match(PCN_RE)
-        @pcn = match.named_captures.reject{ |k| k == 'pcn' }
+        @pcn = match.named_captures.reject{ _1 == 'pcn' }
       end
 
       def siwl_weight=(value)

data/lib/aixm/component/timetable.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
 
     # Timetables define activity time windows.
     #
@@ -17,7 +17,7 @@ module AIXM
     # * +AIXM::H24+ - continuous, all day and all night
     # * +AIXM::H_RE+ - pattern matching working hour codes
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Timetable#predefined-timetable
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Timetable#predefined-timetable
     class Timetable
       CODES = {
         H24: :continuous,           # all day and all night
@@ -45,7 +45,9 @@ module AIXM
       end
 
       def code=(value)
-        @code = CODES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid code")
+        @code = if value
+          CODES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid code")
+        end
       end
 
       def remarks=(value)

data/lib/aixm/component/{vertical_limits.rb → vertical_limit.rb}

@@ -1,9 +1,9 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
 
-    # Vertical limits define a 3D airspace vertically. They are often noted in
+    # Vertical limit defines a 3D airspace vertically. It is often noted in
     # AIP as follows:
     #
     #   upper_z
@@ -13,7 +13,7 @@ module AIXM
     #   (min_z)   whichever is lower
     #
     # ===Cheat Sheet in Pseudo Code:
-    #   vertical_limits = AIXM.vertical_limits(
+    #   vertical_limit = AIXM.vertical_limit(
     #     upper_z: AIXM.z
     #     max_z: AIXM.z or nil
     #     lower_z: AIXM.z
@@ -24,14 +24,20 @@ module AIXM
     # * +AIXM::GROUND+ - surface expressed as "0 ft QFE"
     # * +AIXM::UNLIMITED+ - no upper limit expressed as "FL 999"
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Airspace#ase-airspace
-    class VerticalLimits
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace#ase-airspace
+    class VerticalLimit
+      include AIXM::Association
+
       # @api private
       TAGS = { upper_z: :Upper, lower_z: :Lower, max_z: :Max, min_z: :Mnm }.freeze
 
       # @api private
       CODES = { qfe: :HEI, qnh: :ALT, qne: :STD }.freeze
 
+      # @!method layer
+      #   @return [AIXM::Component::Layer] layer to which this vertical limit applies
+      belongs_to :layer
+
       # @return [AIXM::Z] upper limit
       attr_reader :upper_z
 
@@ -50,7 +56,7 @@ module AIXM
 
       # @return [String]
       def inspect
-        payload = %i(upper_z max_z lower_z min_z).map { |l| %Q(#{l}="#{send(l)}") if send(l) }.compact
+        payload = %i(upper_z max_z lower_z min_z).map { %Q(#{_1}="#{send(_1)}") if send(_1) }.compact
         %Q(#<#{self.class} #{payload.join(' ')}>)
       end
 

data/lib/aixm/config.rb

@@ -9,8 +9,8 @@ module AIXM
     },
     ofmx: {
       version: '0',
-      namespace: 'http://schema.openflightmaps.org/0/OFMX-Snapshot.xsd',
-      xsd: Pathname(__dir__).join('..', '..', 'schemas', 'ofmx', '0', 'OFMX-Snapshot.xsd'),
+      namespace: 'http://schema.openflightmaps.org/0.1/OFMX-Snapshot.xsd',
+      xsd: Pathname(__dir__).join('..', '..', 'schemas', 'ofmx', '0.1', 'OFMX-Snapshot.xsd'),
       root: 'OFMX-Snapshot'
     }
   }.freeze
@@ -77,7 +77,10 @@ module AIXM
     # @return [OpenStruct]
     def initialize_config
       @@config = OpenStruct.new(
-        schema: :aixm
+        schema: :aixm,
+        voice_channel_separation: :any,
+        mid: false,
+        inflector: Dry::Inflector.new
       )
     end
 

data/lib/aixm/document.rb

@@ -11,16 +11,21 @@ module AIXM
   #     created_at: Time or Date or String
   #     effective_at: Time or Date or String
   #   )
-  #   document.features << AIXM::Feature
+  #   document.add_feature(AIXM::Feature)
   #
-  # @see https://github.com/openflightmaps/ofmx/wiki/Snapshot
+  # @see https://gitlab.com/openflightmaps/ofmx/wikis/Snapshot
   class Document
-    REGION_RE = /\A[A-Z]{2}\z/.freeze
+    include AIXM::Association
 
     NAMESPACE_RE = /\A[a-f\d]{8}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{12}\z/.freeze
 
-    # @return [String] OFMX region all features in this document belong to
-    attr_reader :region
+    # @!method features
+    #   @return [Array<AIXM::Feature>] features (e.g. airport or airspace) present
+    #     in this document
+    # @!method add_feature(feature)
+    #   @param feature [AIXM::Feature]
+    #   @return [self]
+    has_many :features, accept: ['AIXM::Feature']
 
     # @return [String] UUID to namespace the data contained in this document
     attr_reader :namespace
@@ -31,12 +36,8 @@ module AIXM
     # @return [Time] effective after date and time (default: {#created_at} or now)
     attr_reader :effective_at
 
-    # @return [Array<AIXM::Feature>] airspaces, airports and other features
-    attr_accessor :features
-
-    def initialize(region: nil, namespace: nil, created_at: nil, effective_at: nil)
-      self.region, self.namespace, self.created_at, self.effective_at = region, namespace, created_at, effective_at
-      @features = []
+    def initialize(namespace: nil, created_at: nil, effective_at: nil)
+      self.namespace, self.created_at, self.effective_at = namespace, created_at, effective_at
     end
 
     # @return [String]
@@ -44,11 +45,6 @@ module AIXM
       %Q(#<#{self.class} created_at=#{created_at.inspect}>)
     end
 
-    def region=(value)
-      fail(ArgumentError, "invalid region") unless value.nil? || value&.upcase&.match?(REGION_RE)
-      @region = value&.upcase
-    end
-
     def namespace=(value)
       fail(ArgumentError, "invalid namespace") unless value.nil? || value.match?(NAMESPACE_RE)
       @namespace = value || SecureRandom.uuid
@@ -62,50 +58,30 @@ module AIXM
       @effective_at = value&.to_time || created_at || Time.now
     end
 
-    # Search features and return those matching the given class and attribute
-    # values
-    #
-    # @example
-    #   select_features(:airport, id: "LFNT")
-    #
-    # @param klass [Class, Symbol] feature class like AIXM::Feature::Airport or
-    #   AIXM::Feature::NavigationalAid::VOR, shorthand notations as symbols
-    #   e.g. :airport or :vor as listed in AIXM::CLASSES are recognized as well
-    # @param attributes [Hash] search attributes by their values
-    # @return [Array<AIXM::Feature>]
-    def select_features(klass, attributes={})
-      if klass.is_a? Symbol
-        klass = AIXM::CLASSES.fetch(klass, nil)
-        fail(ArgumentError, "unknown feature shortcut") unless klass
-      end
-      features.select do |feature|
-        if feature.is_a? klass
-          attributes.reduce(true) do |memo, (attribute, value)|
-            memo && feature.send(attribute) == value
-          end
-        end
-      end
-    end
-
     # Compare all ungrouped obstacles and create new obstacle groups whose
     # members are located within +max_distance+ pairwise.
     #
+    # @note OFMX requires every obstacle, even single ones, to be part of an
+    #   obstacle group which has a region assigned. For this to work, you must
+    #   assure every obstacle has a region assigned when using this method.
+    #
     # @param max_distance [AIXM::D] max distance between obstacle group member
     #   pairs (default: 1 NM)
     # @return [Integer] number of obstacle groups added
     def group_obstacles!(max_distance: AIXM.d(1, :nm))
-      obstacles, list = select_features(:obstacle), {}
-      while subject = obstacles.shift
+      obstacles, list = features.find_by(:obstacle), {}
+      while subject = obstacles.send(:shift)
         obstacles.each do |obstacle|
           if subject.xy.distance(obstacle.xy) <= max_distance
-            [subject, obstacle].each { |o| list[o] = list[subject] || SecureRandom.uuid }
+            [subject, obstacle].each { list[_1] = list[subject] || SecureRandom.uuid }
           end
         end
       end
       list.group_by(&:last).each do |_, grouped_list|
-        obstacle_group = AIXM.obstacle_group(source: grouped_list.first.first.source)
-        grouped_list.each { |o, _| obstacle_group.obstacles << features.delete(o) }
-        features << obstacle_group
+        first_obstacle = grouped_list.first.first
+        obstacle_group = AIXM.obstacle_group(source: first_obstacle.source, region: first_obstacle.region)
+        grouped_list.each { |o, _| obstacle_group.add_obstacle features.send(:delete, o) }
+        add_feature obstacle_group
       end.count
     end
 
@@ -133,7 +109,6 @@ module AIXM
         'xmlns:xsi': AIXM.schema(:namespace),
         version: AIXM.schema(:version),
         origin: "rubygem aixm-#{AIXM::VERSION}",
-        region: (region if AIXM.ofmx?),
         namespace: (namespace if AIXM.ofmx?),
         created: @created_at.xmlschema,
         effective: @effective_at.xmlschema
@@ -141,7 +116,14 @@ module AIXM
       builder = Builder::XmlMarkup.new(indent: 2)
       builder.instruct!
       builder.tag!(AIXM.schema(:root), meta) do |root|
-        root << features.map { |f| f.to_xml }.join.indent(2)
+        AIXM::Memoize.method :to_uid do
+          root << features.map { _1.to_xml }.join.indent(2)
+        end
+      end
+      if AIXM.ofmx? && AIXM.config.mid
+        AIXM::PayloadHash::Mid.new(builder.target!).insert_mid.to_xml
+      else
+        builder.target!
       end
     end