aixm 0.3.7 → 1.0.0

data/lib/aixm/executables.rb

@@ -0,0 +1,85 @@
+using AIXM::Refinements
+
+module AIXM
+  module Executables
+
+    class Mkmid
+      def initialize(**options)
+        @options = options
+        OptionParser.new do |o|
+          o.banner = <<~END
+            Add mid attributes to a schema valid OFMX file.
+            Usage: #{File.basename($0)} infile.ofmx
+          END
+          o.on('-i', '--[no-]in-place', 'overwrite file instead of dumping to STDOUT (default: false)') { @options[:in_place] = _1 }
+          o.on('-f', '--[no-]force', 'ignore XML schema validation errors (default: false)') { @options[:force] = _1 }
+          o.on('-A', '--about', 'show author/license information and exit') { AIXM::Executables.about }
+          o.on('-V', '--version', 'show version and exit') { AIXM::Executables.version }
+        end.parse!
+        @infile = ARGV.shift
+      end
+
+      def run
+        fail 'cannot read file' unless @infile && File.readable?(@infile)
+        fail 'file ist not OFMX' unless @infile.match?(/\.ofmx$/)
+        AIXM.ofmx!
+        document = File.open(@infile) { Nokogiri::XML(_1) }
+        AIXM::PayloadHash::Mid.new(document).insert_mid
+        errors = Nokogiri::XML::Schema(File.open(AIXM.schema(:xsd))).validate(document)
+        case
+        when errors.any? && !@options[:force]
+          puts errors
+          fail "OFMX file is not schema valid"
+        when @options[:in_place]
+          File.write(@infile, document.to_xml)
+        else
+          puts document.to_xml
+        end
+      rescue => error
+        puts "ERROR: #{error.message}"
+        exit 1
+      end
+    end
+
+    class Ckmid
+      def initialize(**options)
+        OptionParser.new do |o|
+          o.banner = <<~END
+            Check mid attributes of an OFMX file.
+            Usage: #{File.basename($0)} infile.ofmx
+          END
+          o.on('-A', '--about', 'show author/license information and exit') { AIXM::Executables.about }
+          o.on('-V', '--version', 'show version and exit') { AIXM::Executables.version }
+        end.parse!
+        @infile = ARGV.shift
+      end
+
+      def run
+        fail 'cannot read file' unless @infile && File.readable?(@infile)
+        fail 'file ist not OFMX' unless @infile.match?(/\.ofmx$/)
+        AIXM.ofmx!
+        document = File.open(@infile) { Nokogiri::XML(_1) }
+        errors = Nokogiri::XML::Schema(File.open(AIXM.schema(:xsd))).validate(document)
+        errors += AIXM::PayloadHash::Mid.new(document).check_mid
+        if errors.any?
+          puts errors
+          fail "OFMX file has errors"
+        end
+      rescue => error
+        puts "ERROR: #{error.message}"
+        exit 1
+      end
+    end
+
+    def self.about
+      puts 'Written by Sven Schwyn (bitcetera.com) and distributed under MIT license.'
+      exit
+    end
+
+    def self.version
+      puts AIXM::VERSION
+      exit
+    end
+
+  end
+end

data/lib/aixm/f.rb

@@ -64,6 +64,34 @@ module AIXM
       to_s.hash
     end
 
+    # @return [Boolean] whether this frequency is part of the voice airband
+    #   for civil aviation using `AIXM.config.voice_channel_separation`
+    def voice?
+      return false unless unit == :mhz
+      case AIXM.config.voice_channel_separation
+        when 25 then voice_25?
+        when 833 then voice_833?
+        when :any then voice_25? || voice_833?
+        else fail(ArgumentError, "unknown voice channel separation")
+      end
+    end
+
+    private
+
+    # @return [Boolean] whether this frequency is part of the voice airband
+    #   for civil aviation using 25 kHz channel separation
+    def voice_25?
+      return false unless unit == :mhz && freq == freq.round(3) && freq.between?(118, 136.975)
+      ((freq * 1000).round % 25).zero?
+    end
+
+    # @return [Boolean] whether this frequency is part of the voice airband
+    #   for civil aviation using 8.33 kHz channel separation
+    def voice_833?
+      return false unless unit == :mhz && freq == freq.round(3) && freq.between?(118, 136.99)
+      [0.005, 0.01, 0.015].any? { |d| (((freq - d) * 1000).round % 25).zero? }
+    end
+
   end
 
 end

data/lib/aixm/feature/address.rb

@@ -9,12 +9,15 @@ module AIXM
     #   address = AIXM.address(
     #     source: String or nil
     #     type: TYPES
-    #     address: String
+    #     address: AIXM.f (type :radio_frequency) or String (other types)
     #   )
     #   service.remarks = String or nil
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#aha-airport-address
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#aha-airport-address
     class Address < Feature
+      include AIXM::Association
+      include AIXM::Memoize
+
       public_class_method :new
 
       TYPES = {
@@ -33,8 +36,9 @@ module AIXM
         OTHER: :other   # specify in remarks
       }
 
-      # @return [AIXM::Feature] addressable feature
-      attr_reader :addressable
+      # @!method addressable
+      #   @return [AIXM::Feature] addressable feature
+      belongs_to :addressable
 
       # @return [Symbol] type of address (see {TYPES})
       attr_reader :type
@@ -45,8 +49,8 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      def initialize(source: nil, type:, address:)
-        super(source: source)
+      def initialize(source: nil, region: nil, type:, address:)
+        super(source: source, region: region)
         self.type, self.address = type, address
       end
 
@@ -55,19 +59,19 @@ module AIXM
         %Q(#<#{self.class} type=#{type.inspect}>)
       end
 
-      def addressable=(value)
-        fail(ArgumentError, "invalid addressable") unless value.is_a? AIXM::Feature
-        @addressable = value
-      end
-      private :addressable=
-
       def type=(value)
         @type = TYPES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid type")
       end
 
       def address=(value)
-        fail(ArgumentError, "invalid address") unless value.is_a? String
-        @address = value&.to_s
+        case type
+        when :radio_frequency
+          fail(ArgumentError, "invalid address frequency") unless value.is_a?(AIXM::F)
+          @address = value
+        else
+          fail(ArgumentError, "invalid address") unless value
+          @address = value.to_s
+        end
       end
 
       def remarks=(value)
@@ -79,10 +83,11 @@ module AIXM
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.tag!(as) do |tag|
           tag << addressable.to_uid.indent(2) if addressable
-          tag.codeType(TYPES.key(type).to_s.then_if(AIXM.aixm?) { |t| t.sub(/-\w+$/, '') })
+          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:)

data/lib/aixm/feature/airport.rb

@@ -9,6 +9,7 @@ module AIXM
     # ===Cheat Sheet in Pseudo Code:
     #   airport = AIXM.airport(
     #     source: String or nil
+    #     region: String or nil
     #     organisation: AIXM.organisation
     #     id: String
     #     name: String
@@ -31,8 +32,11 @@ module AIXM
     # For airports without an +id+, you may assign the two character region
     # (e.g. "LF") which will be combined with an 8 character digest of +name+.
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#ahp-airport
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#ahp-airport
     class Airport < Feature
+      include AIXM::Association
+      include AIXM::Memoize
+
       public_class_method :new
 
       ID_RE = /^([A-Z]{3,4}|[A-Z]{2}[A-Z\d]{4,})$/.freeze
@@ -44,8 +48,53 @@ module AIXM
         LS: :landing_site
       }.freeze
 
-      # @return [AIXM::Feature::Organisation] superior organisation
-      attr_reader :organisation
+      # @!method addresses
+      #   @return [Array<AIXM::Feature::Address>] postal address, url, A/A or A/G frequency etc
+      # @!method add_address(address)
+      #   @param address [AIXM::Feature::Address]
+      #   @return [self]
+      has_many :addresses, as: :addressable
+
+      # @!method fatos
+      #   @return [Array<AIXM::Component::FATO>] FATOs present at this airport
+      # @!method add_fato(fato)
+      #   @param fato [AIXM::Component::FATO]
+      has_many :fatos
+
+      # @!method helipads
+      #   @return [Array<AIXM::Component::Helipad>] helipads present at this airport
+      # @!method add_helipad(helipad)
+      #   @param helipad [AIXM::Component::Helipad]
+      has_many :helipads
+
+      # @!method runways
+      #   @return [Array<AIXM::Component::Runway>] runways present at this airport
+      # @!method add_runway(runway)
+      #   @param runway [AIXM::Component::Runway]
+      has_many :runways
+
+      # @!method usage_limitations
+      #   @return [Array<AIXM::Feature::Airport::UsageLimitation>] usage limitations
+      # @!method add_usage_limitation
+      #   @yield [AIXM::Feature::Airport::UsageLimitation]
+      #   @return [self]
+      has_many :usage_limitations, accept: 'AIXM::Feature::Airport::UsageLimitation' do |usage_limitation, type:| end
+
+      # @!method designated_points
+      #   @return [Array<AIXM::Feature::NavigationalAid::DesignatedPoint>] designated points
+      # @!method add_designated_point(designated_point)
+      #   @param designated_point [AIXM::Feature::NavigationalAid::DesignatedPoint]
+      has_many :designated_points
+
+      # @!method units
+      #   @return [Array<AIXM::Feature::Unit>] units
+      # @!method add_unit(unit)
+      #   @param unit [AIXM::Feature::Unit]
+      has_many :units
+
+      # @!method organisation
+      #   @return [AIXM::Feature::Organisation] superior organisation
+      belongs_to :organisation, as: :member
 
       # ICAO indicator, IATA indicator or generated indicator
       #
@@ -74,6 +123,9 @@ module AIXM
       # declination represents the magnetic north is to the right (aka: east)
       # by this angle.
       #
+      # To convert a magnetic bearing to the corresponding geographic (aka:
+      # true) bearing, the declination has to be added.
+      #
       # @see https://en.wikipedia.org/wiki/Magnetic_declination
       # @return [Float, nil] magnetic declination in degrees
       attr_reader :declination
@@ -90,26 +142,10 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      # @return [Array<AIXM::Component::Runway>] runways present at this airport
-      attr_reader :runways
-
-      # @return [Array<AIXM::Component::FATO>] FATOs present at this airport
-      attr_reader :fatos
-
-      # @return [Array<AIXM::Component::Helipad>] helipads present at this airport
-      attr_reader :helipads
-
-      # @return [Array<AIXM::Feature::Airport::UsageLimitation>] usage limitations
-      attr_accessor :usage_limitations
-
-      # @return [Array<AIXM::Feature::Address>] postal address, url, A/A or A/G frequency etc
-      attr_reader :addresses
-
-      def initialize(source: nil, organisation:, id: nil, name:, xy:)
-        super(source: source)
+      def initialize(source: nil, region: nil, organisation:, id: nil, name:, xy:)
+        super(source: source, region: region)
         self.organisation, self.name, self.xy = organisation, name, xy
         self.id = id   # name must already be set
-        @runways, @fatos, @helipads, @usage_limitations, @addresses = [], [], [], [], []
       end
 
       # @return [String]
@@ -117,15 +153,10 @@ module AIXM
         %Q(#<#{self.class} id=#{id.inspect}>)
       end
 
-      def organisation=(value)
-        fail(ArgumentError, "invalid organisation") unless value.is_a? AIXM::Feature::Organisation
-        @organisation = value
-      end
-
       # For airports without an +id+, you may assign the two character region
       # (e.g. "LF") which will be combined with an 8 character digest of +name+.
       def id=(value)
-        value = [value, [name].to_digest].join.upcase if value&.upcase&.match? AIXM::Document::REGION_RE
+        value = [value, [name].to_digest].join.upcase if value&.upcase&.match? AIXM::Feature::REGION_RE
         fail(ArgumentError, "invalid id") unless value&.upcase&.match? ID_RE
         @id = value.upcase
       end
@@ -196,92 +227,22 @@ module AIXM
         @remarks = value&.to_s
       end
 
-      # Add a runway to the airport.
-      #
-      # @param runway [AIXM::Component::Runway] runway instance
-      # @return [self]
-      def add_runway(runway)
-        fail(ArgumentError, "invalid runway") unless runway.is_a? AIXM::Component::Runway
-        runway.send(:airport=, self)
-        @runways << runway
-        self
-      end
-
-      # Add a FATO to the airport.
-      #
-      # @param FATO [AIXM::Component::FATO] FATO instance
-      # @return [self]
-      def add_fato(fato)
-        fail(ArgumentError, "invalid FATO") unless fato.is_a? AIXM::Component::FATO
-        fato.send(:airport=, self)
-        @fatos << fato
-        self
-      end
-
-      # Add a helipad to the airport.
-      #
-      # @param helipad [AIXM::Component::Helipad] helipad instance
-      # @return [self]
-      def add_helipad(helipad)
-        fail(ArgumentError, "invalid helipad") unless helipad.is_a? AIXM::Component::Helipad
-        helipad.send(:airport=, self)
-        @helipads << helipad
-        self
-      end
-
-      # Add an airport usage limitation.
-      #
-      # See {AIXM::Feature::Airport::UsageLimitation::TYPES UsageLimitation::TYPES}
-      # for recognized limitations and {AIXM::Feature::Airport::UsageLimitation#add_condition UsageLimitation#add_condition}
-      # for recognized conditions.
-      #
-      # Multiple conditions are joined with an implicit *or* whereas the
-      # specifics of a condition (aircraft, rule etc) are joined with an
-      # implicit *and*.
-      #
-      # @example Limitation applying to any traffic
-      #   airport.add_usage_limitation(:permitted)
-      #
-      # @example Limitation applying to specific traffic
-      #   airport.add_usage_limitation(:reservation_required) do |reservation_required|
-      #     reservation_required.add_condition do |condition|
-      #       condition.aircraft = :glider
-      #     end
-      #     reservation_required.add_condition do |condition|
-      #       condition.rule = :ifr
-      #       condition.origin = :international
-      #     end
-      #     reservation_required.timetable = AIXM::H24
-      #     reservation_required.remarks = "Reservation 24 HRS prior to arrival"
-      #   end
-      #
-      # @yieldparam usage_limitation [AIXM::Feature::Airport::UsageLimitation]
-      # @return [self]
-      def add_usage_limitation(type)
-        usage_limitation = UsageLimitation.new(type: type)
-        yield(usage_limitation) if block_given?
-        @usage_limitations << usage_limitation
-        self
-      end
-
-      # Add an address (postal address, url, A/A or A/G frequency etc) to the airport.
-      #
-      # @params address [AIXM::Feature::Address] address instance
-      # @return [self]
-      def add_address(address)
-        fail(ArgumentError, "invalid address") unless address.is_a? AIXM::Feature::Address
-        address.send(:addressable=, self)
-        @addresses << address
-        self
-      end
-
       # @return [String] UID markup
       def to_uid(as: :AhpUid)
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.tag!(as) do |tag|
+        builder.tag!(as, ({ region: (region if AIXM.ofmx?) }.compact)) do |tag|
           tag.codeId(id)
         end
       end
+      memoize :to_uid
+
+      # @return [String] UID markup
+      def to_wrapped_uid(as: :AhpUid, with:)
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.tag!(with) do |tag|
+          tag << to_uid(as: as).indent(2)
+        end
+      end
 
       # @return [String] AIXM or OFMX markup
       def to_xml
@@ -322,9 +283,7 @@ module AIXM
         end
         if usage_limitations.any?
           builder.Ahu do |ahu|
-            ahu.AhuUid do |ahu_uid|
-              ahu_uid << to_uid.indent(4)
-            end
+            ahu << to_wrapped_uid(with: :AhuUid).indent(2)
             usage_limitations.each do |usage_limitation|
               ahu << usage_limitation.to_xml.indent(2)
             end
@@ -340,9 +299,35 @@ module AIXM
       # Limitations concerning the availability of an airport for certain flight
       # types, aircraft types etc during specific hours.
       #
+      # See {AIXM::Feature::Airport::UsageLimitation::TYPES UsageLimitation::TYPES}
+      # for recognized limitations and {AIXM::Feature::Airport::UsageLimitation#add_condition UsageLimitation#add_condition}
+      # for recognized conditions.
+      #
+      # Multiple conditions are joined with an implicit *or* whereas the
+      # specifics of a condition (aircraft, rule etc) are joined with an
+      # implicit *and*.
+      #
+      # @example Limitation applying to any traffic
+      #   airport.add_usage_limitation(type: :permitted)
+      #
+      # @example Limitation applying to specific traffic
+      #   airport.add_usage_limitation(type: :reservation_required) do |reservation_required|
+      #     reservation_required.add_condition do |condition|
+      #       condition.aircraft = :glider
+      #     end
+      #     reservation_required.add_condition do |condition|
+      #       condition.rule = :ifr
+      #       condition.origin = :international
+      #     end
+      #     reservation_required.timetable = AIXM::H24
+      #     reservation_required.remarks = "Reservation 24 HRS prior to arrival"
+      #   end
+      #
       # @see AIXM::Feature::Airport#add_usage_limitation
-      # @see https://github.com/openflightmaps/ofmx/wiki/Airport#ahu-airport-usage
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#ahu-airport-usage
       class UsageLimitation
+        include AIXM::Association
+
         TYPES = {
           PERMIT: :permitted,
           FORBID: :forbidden,
@@ -350,15 +335,20 @@ module AIXM
           OTHER: :other                    # specify in remarks
         }.freeze
 
-        # @return [AIXM::Feature::Airport] airport this usage limitation is assigned to
-        attr_reader :airport
+        # @!method conditions
+        #   @return [Array<AIXM::Feature::Airport::UsageLimitation::Condition>] conditions for this limitation to apply
+        # @!method add_condition
+        #   @yield [AIXM::Feature::Airport::UsageLimitation::Condition]
+        #   @return [self]
+        has_many :conditions, accept: 'AIXM::Feature::Airport::UsageLimitation::Condition' do |condition| end
+
+        # @!method airport
+        #   @return [AIXM::Feature::Airport] airport this usage limitation is assigned to
+        belongs_to :airport
 
         # @return [Symbol] type of limitation
         attr_reader :type
 
-        # @return [Array<AIXM::Feature::Airport::UsageLimitation::Condition>] conditions for this limitation to apply
-        attr_reader :conditions
-
         # @return [AIXM::Component::Timetable, nil] limitation application hours
         attr_reader :timetable
 
@@ -367,7 +357,6 @@ module AIXM
 
         def initialize(type:)
           self.type = type
-          @conditions = []
         end
 
         # @return [String]
@@ -379,17 +368,6 @@ module AIXM
           @type = TYPES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid type")
         end
 
-        # Add a condition to the usage limitation.
-        #
-        # @yieldparam condition [AIXM::Feature::Airport::UsageLimitation::Condition]
-        # @return [self]
-        def add_condition
-          condition = Condition.new
-          yield(condition)
-          @conditions << condition
-          self
-        end
-
         def timetable=(value)
           fail(ArgumentError, "invalid timetable") unless value.nil? || value.is_a?(AIXM::Component::Timetable)
           @timetable = value
@@ -416,8 +394,10 @@ module AIXM
         # limitation.
         #
         # @see AIXM::Feature::Airport#add_usage_limitation
-        # @see https://github.com/openflightmaps/ofmx/wiki/Airport#ahu-airport-usage
+        # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#ahu-airport-usage
         class Condition
+          include AIXM::Association
+
           AIRCRAFT = {
             L: :landplane,
             S: :seaplane,
@@ -463,6 +443,10 @@ module AIXM
             OTHER: :other               # specify in remarks
           }.freeze
 
+          # @!method usage_limitation
+          #   @return [AIXM::Feature::Airport::UsageLimitation] usage limitation the condition belongs to
+          belongs_to :usage_limitation
+
           # @return [Symbol, nil] kind of aircraft (see {AIRCRAFT})
           attr_reader :aircraft