aixm 0.3.3 → 0.3.4

data/lib/aixm/feature/navigational_aid/dme.rb

@@ -26,7 +26,7 @@ module AIXM
       class DME < NavigationalAid
         public_class_method :new
 
-        CHANNEL_PATTERN = /\A([1-9]|[1-9]\d|1[0-1]\d|12[0-6])[XY]\z/.freeze
+        CHANNEL_RE = /\A([1-9]|[1-9]\d|1[0-1]\d|12[0-6])[XY]\z/.freeze
 
         # @return [String] radio channel
         attr_reader :channel
@@ -40,7 +40,7 @@ module AIXM
         end
 
         def channel=(value)
-          fail(ArgumentError, "invalid channel") unless value.is_a?(String) && value.match?(CHANNEL_PATTERN)
+          fail(ArgumentError, "invalid channel") unless value.is_a?(String) && value.match?(CHANNEL_RE)
           @channel = value
         end
 

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

@@ -1,13 +1,13 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  class Feature
 
     # Service provided by a unit.
     #
     # ===Cheat Sheet in Pseudo Code:
     #   service = AIXM.service(
-    #     name: String
+    #     source: String or nil
     #     type: TYPES
     #   )
     #   service.timetable = AIXM.timetable or nil
@@ -15,7 +15,9 @@ module AIXM
     #   service.add_frequency(AIXM.frequency)
     #
     # @see https://github.com/openflightmaps/ofmx/wiki/Organisation#ser-service
-    class Service
+    class Service < Feature
+      public_class_method :new
+
       TYPES = {
         ACS: :area_control_service,
         ADS: :automatic_dependent_surveillance_service,
@@ -77,12 +79,57 @@ module AIXM
         OTHER: :other   # specify in remarks
       }.freeze
 
+      # Map service types to guessed unit types
+      GUESSED_UNIT_TYPES_MAP = {
+        :advisory_service => :advisory_centre,
+        :aerodrome_control_tower_service => :aerodrome_control_tower,
+        :aerodrome_flight_information_service => :aerodrome_control_tower,
+        :aeronautical_information_service => :aeronautical_information_services_office,
+        :air_route_traffic_control_centre_service => :air_route_traffic_control_centre,
+        :air_traffic_control_service => :air_traffic_control_centre,
+        :air_traffic_flow_management_service => :air_traffic_flow_management_unit,
+        :air_traffic_management_service => :air_traffic_management_unit,
+        :air_traffic_service => :air_traffic_services_unit,
+        :approach_control_service => :approach_control_office,
+        :approach_control_service_for_arrival => :arrivals_approach_control_office,
+        :approach_control_service_for_departure => :depatures_approach_control_office,
+        :area_control_service => :area_control_centre,
+        :automated_terminal_information_service => :aerodrome_control_tower,
+        :automated_terminal_information_service_for_arrival => :aerodrome_control_tower,
+        :automated_terminal_information_service_for_departure => :aerodrome_control_tower,
+        :automatic_dependent_surveillance_service => :automatic_dependent_surveillance_unit,
+        :briefing_service => :briefing_office,
+        :commercial_broadcasting_service => :commercial_broadcasting_station,
+        :communications_service => :communications_office,
+        :flight_information_service => :flight_information_centre,
+        :flight_service_station_service => :flight_service_station,
+        :forecasting_service => :forecasting_office,
+        :ground_controlled_approach_service => :ground_controlled_approach_systems_office,
+        :international_notam_service => :international_notam_office,
+        :meteorological_service => :meteorological_office,
+        :oceanic_area_control_service => :oceanic_control_centre,
+        :precision_approach_radar_service => :precision_approach_radar_centre,
+        :radar_service => :radar_office,
+        :regional_area_forecasting_service => :regional_area_forecast_centre,
+        :rescue_coordination_service => :rescue_coordination_centre,
+        :search_and_rescue_service => :search_and_rescue_centre,
+        :secondary_surveillance_radar_service => :secondary_surveillance_radar_centre,
+        :sigmet_service => :meteorological_office,
+        :surface_movement_control_service => :surface_movement_control_office,
+        :surface_movement_radar_service => :surface_movement_radar_office,
+        :surveillance_radar_approach_service => :surveillance_radar_approach_centre,
+        :terminal_area_radar_service => :terminal_area_surveillance_radar_centre,
+        :transcribed_weather_broadcast_service => :meteorological_office,
+        :uhf_direction_finding_service => :uhf_direction_finding_station,
+        :upper_area_control_service => :upper_area_control_centre,
+        :vhf_direction_finding_service => :vdf_direction_finding_station,
+        :volmet_service => :meteorological_office,
+        :other => :other
+}
+
       # @return [AIXM::Feature::Unit] unit providing this service
       attr_reader :unit
 
-      # @return [String] full name
-      attr_reader :name
-
       # @return [Symbol] type of service (see {TYPES})
       attr_reader :type
 
@@ -95,8 +142,9 @@ module AIXM
       # @return [Array<AIXM::Component::Frequency>] frequencies used by this service
       attr_reader :frequencies
 
-      def initialize(name:, type:)
-        self.name, self.type = name, type
+      def initialize(source: nil, type:)
+        super(source: source)
+        self.type = type
         @frequencies = []
       end
 
@@ -111,11 +159,6 @@ module AIXM
       end
       private :unit=
 
-      def name=(value)
-        fail(ArgumentError, "invalid name") unless value.is_a? String
-        @name = value.uptrans
-      end
-
       def type=(value)
         @type = TYPES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid type")
       end
@@ -129,7 +172,7 @@ module AIXM
         @remarks = value&.to_s
       end
 
-      # Add a frequency used by this service.
+      # Add a frequency used by this service
       #
       # @param frequency [AIXM::Component::Frequency] frequency instance
       # @return [self]
@@ -140,6 +183,13 @@ module AIXM
         self
       end
 
+      # Guess the unit type for this service
+      #
+      # @return [Symbol, nil] guessed unit type or +nil+ if unmappable
+      def guessed_unit_type
+        GUESSED_UNIT_TYPES_MAP[type]
+      end
+
       # @return [String] UID markup
       def to_uid
         builder = Builder::XmlMarkup.new(indent: 2)
@@ -151,10 +201,11 @@ module AIXM
       end
 
       # @return [String] AIXM or OFMX markup
-      def to_xml(sequence=1)
+      def to_xml(sequence:)
         @sequence = sequence
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.Ser do |ser|
+        builder.comment! ["Service: #{TYPES.key(type)}", unit&.name].compact.join(' by ')
+        builder.Ser({ source: (source if AIXM.ofmx?) }.compact) do |ser|
           ser << to_uid.indent(2)
           ser << timetable.to_xml(as: :Stt).indent(2) if timetable
           ser.txtRmk(remarks) if remarks

data/lib/aixm/feature/unit.rb

@@ -24,16 +24,50 @@ module AIXM
 
       TYPES = {
         ACC: :area_control_centre,
+        ADSU: :automatic_dependent_surveillance_unit,
+        ADVC: :advisory_centre,
+        ALPS: :alerting_post,
+        AOF: :aeronautical_information_services_office,
         APP: :approach_control_office,
-        ARO: :ats_reporting_office,
+        'APP-ARR': :arrivals_approach_control_office,
+        'APP-DEP': :depatures_approach_control_office,
+        ARO: :air_traffic_service_reporting_office,
+        ARTCC: :air_route_traffic_control_centre,
+        ATCC: :air_traffic_control_centre,
+        ATFMU: :air_traffic_flow_management_unit,
+        ATMU: :air_traffic_management_unit,
         ATSU: :air_traffic_services_unit,
+        BOF: :briefing_office,
+        BS: :commercial_broadcasting_station,
         COM: :communications_office,
+        FCST: :forecasting_office,
         FIC: :flight_information_centre,
         FSS: :flight_service_station,
+        GCA: :ground_controlled_approach_systems_office,
         MET: :meteorological_office,
+        MIL: :military_station,
+        MILOPS: :military_flight_operations_briefing_office,
+        MWO: :meteorological_watch_office,
         NOF: :international_notam_office,
+        OAC: :oceanic_control_centre,
+        PAR: :precision_approach_radar_centre,
         RAD: :radar_office,
+        RAFC: :regional_area_forecast_centre,
+        RCC: :rescue_coordination_centre,
+        RSC: :rescue_sub_centre,
+        SAR: :search_and_rescue_centre,
+        SMC: :surface_movement_control_office,
+        SMR: :surface_movement_radar_office,
+        SRA: :surveillance_radar_approach_centre,
+        SSR: :secondary_surveillance_radar_centre,
+        TAR: :terminal_area_surveillance_radar_centre,
+        TRACON: :terminal_radar_approach_control,
         TWR: :aerodrome_control_tower,
+        UAC: :upper_area_control_centre,
+        UDF: :uhf_direction_finding_station,
+        UIC: :upper_information_centre,
+        VDF: :vdf_direction_finding_station,
+        WAFC: :world_area_forecast_centre,
         OTHER: :other                       # specify in remarks
       }.freeze
 
@@ -104,19 +138,19 @@ module AIXM
 
       # Add a service provided by this unit.
       #
-      # @param service [AIXM::Component::Service] service instance
+      # @param service [AIXM::Feature::Service] service instance
       # @return [self]
       def add_service(service)
-        fail(ArgumentError, "invalid service") unless service.is_a? AIXM::Component::Service
+        fail(ArgumentError, "invalid service") unless service.is_a? AIXM::Feature::Service
         service.send(:unit=, self)
         @services << service
         self
       end
 
       # @!attribute [r] services
-      # @return [Array<AIXM::Component::Service>] services provided by this unit
+      # @return [Array<AIXM::Feature::Service>] services provided by this unit
       def services
-        @services.sort { |a, b| [a.type, a.name] <=> [b.type, b.name] }
+        @services.sort { |a, b| a.type <=> b.type }
       end
 
       # @return [String] UID markup
@@ -141,7 +175,7 @@ module AIXM
         end
         services.each.with_object({}) do |service, sequences|
           sequences[service.type] = (sequences[service.type] || 0) + 1
-          builder << service.to_xml(sequences[service.type])
+          builder << service.to_xml(sequence: sequences[service.type])
         end
         builder.target!
       end

data/lib/aixm/refinements.rb

@@ -1,7 +1,9 @@
 module AIXM
   module Refinements
 
-    UPTRANS_FILTER = %r{[^A-Z0-9, !"&#$%'\(\)\*\+\-\./:;<=>\?@\[\\\]\^_\|\{\}]}.freeze
+    UPTRANS_FILTER = %r(
+      [^A-Z0-9, !"&#$%'\(\)\*\+\-\./:;<=>\?@\[\\\]\^_\|\{\}]
+    )x.freeze
 
     UPTRANS_MAP = {
       'Ä' => 'AE',
@@ -132,6 +134,19 @@ module AIXM
       end
     end
 
+    # @!method decapture
+    #   Replace all groups with non-caputuring groups
+    #
+    #   @example
+    #     /^(foo)(?<name>bar)/.decapture   # => /^(?:foo)(?:bar)/
+    #
+    #   @note This is a refinement for +Regexp+
+    refine Regexp do
+      def decapture
+        Regexp.new(to_s.gsub(/\(\?<\w+>|(?<![^\\]\\)\((?!\?)/, '(?:'))
+      end
+    end
+
     # @!method indent(number)
     #   Indent every line of a string with +number+ spaces.
     #
@@ -149,26 +164,68 @@ module AIXM
       end
     end
 
+    # @!method payload_hash(region:, element:)
+    #   Calculate the UUIDv3 hash of an OFMX XML string.
+    #
+    #   A word of warning: This is a minimalistic implementation for the AIXM
+    #   gem and won't work unless the following conditions are met:
+    #   * the XML string must be OFMX
+    #   * the XML string must be valid
+    #   * the XML string must be pretty-printed
+    #
+    #   @example from https://github.com/openflightmaps/ofmx/wiki/Functions
+    #     xml.payload_hash(region: 'LF', element: 'Ser')
+    #     # => "269b1f18-cabe-3c9e-1d71-48a7414a4cb9"
+    #
+    #   @note This is a refinement for +String+
+    #   @param region [String] OFMX region (e.g. "LF")
+    #   @param element [String] tag to calculate the payload hash for
+    #   @return [String] UUID version 3
+    refine String do
+      def payload_hash(region:, element:)
+        gsub(%r(mid="[^"]*"), '').   # remove existing mid attributes
+          sub(%r(\A.*?(?=<#{element}))m, '').   # remove everything before first <element>
+          sub(%r(</#{element}>.*\z)m, '').   # remove everything after first </element>
+          scan(%r(<([\w-]+)([^>]*)>([^<]*))).each_with_object([region]) do |(e, a, t), m|
+            m << e << a.scan(%r(([\w-]+)="([^"]*)")).sort.flatten << t
+          end.
+          flatten.
+          keep_if { |s| s.match?(/[^[:space:]]/m) }.
+          compact.
+          to_uuid
+      end
+    end
+
     # @!method to_dd
     #   Convert DMS angle to DD or +nil+ if the notation is not recognized.
     #
     #   @example
     #     %q(43°12'77.92").to_dd
     #     # => 43.22164444444445
+    #     "431277.92S".to_dd
+    #     # => -43.22164444444445
     #     %q(-123).to_dd
     #     # => nil
     #
     #   Supported notations:
-    #   * +{-}{DD}D°MM'SS{.SS}"+
-    #   * +{-}{DD}D MM SS{.SS}+
-    #   * +{-}{DD}DMMSS{.SS}+
+    #   * +{-}{DD}D°MM'SS{.SS}"{[NESW]}+
+    #   * +{-}{DD}D MM SS{.SS} {[NESW]}+
+    #   * +{-}{DD}DMMSS{.SS}[NESW]+
+    #
+    #   Quite a number of typos are tolerated such as the wrong use of
+    #   minute +'+ and second +"+ markers as well as the use of decimal
+    #   comma +,+ instead of dot +.+.
     #
     #   @note This is a refinement for +String+
     #   @return [Float] angle in DD notation
     refine String do
       def to_dd
-        if self =~ /\A(-)?(\d{1,3})[° ]?(\d{2})[' ]?(\d{2}\.?\d{0,2})"?\z/
-          ("#{$1}1".to_i * ($2.to_f + ($3.to_f/60) + ($4.to_f/3600)))
+        if match = self.match(DMS_RE)
+          "#{match['sgn']}1".to_i * "#{:- if match['hem_sw']}1".to_i * (
+            match['deg'].to_f +
+            match['min'].to_f/60 +
+            match['sec'].tr(',', '.').to_f/3600
+          )
         end
       end
     end

data/lib/aixm/shortcuts.rb

@@ -1,19 +1,22 @@
 module AIXM
 
-  ELEMENTS = {
+  # List of shorthand names and their corresponding AIXM classes
+  CLASSES = {
     document: Document,
     xy: XY,
     z: Z,
     d: D,
     f: F,
-    h: H,
+    a: A,
+    address: Feature::Address,
     organisation: Feature::Organisation,
     unit: Feature::Unit,
-    service: Component::Service,
+    service: Feature::Service,
     frequency: Component::Frequency,
     airport: Feature::Airport,
     runway: Component::Runway,
     helipad: Component::Helipad,
+    surface: Component::Surface,
     airspace: Feature::Airspace,
     layer: Component::Layer,
     geometry: Component::Geometry,
@@ -33,14 +36,19 @@ module AIXM
     timetable: Component::Timetable
   }.freeze
 
-  ELEMENTS.each do |element, klass|
+  CLASSES.each do |element, klass|
     define_singleton_method(element) do |*arguments|
       klass.new(*arguments)
     end
   end
 
+  # Ground level
   GROUND = z(0, :qfe).freeze
+
+  # Max flight level used to signal "no upper limit"
   UNLIMITED = z(999, :qne).freeze
+
+  # Timetable used to signal "always active"
   H24 = timetable(code: :H24).freeze
 
 end

data/lib/aixm/version.rb

@@ -1,3 +1,3 @@
 module AIXM
-  VERSION = "0.3.3".freeze
+  VERSION = "0.3.4".freeze
 end

data/lib/aixm/xy.rb

@@ -14,6 +14,11 @@ module AIXM
   #   AIXM.xy(lat: %q(11°22'33.44N"), long: %q(111°22'33.44W"))
   #   AIXM.xy(lat: '112233.44N', long: '1112233.44W')
   #
+  # ===Constants:
+  # * +AIXM::MIN+ - characters recognized as DMS minute symbols
+  # * +AIXM::SEC+ - characters recognized as DMS second symbols
+  # * +AIXM::DMS_RE+ - regular expression to match DMS coordinate notations
+  #
   # @see https://github.com/openflightmaps/ofmx/wiki/Coordinates
   class XY
     EARTH_RADIUS = 6_371_008.8
@@ -98,7 +103,7 @@ module AIXM
     def float_for(value)
       case value
         when Numeric then value.to_f
-        when String then value[0..-2].to_dd * (value.match?(/[SW]$/) ? -1 : 1)
+        when String then value.to_dd
         else fail(ArgumentError, "invalid value class `#{value.class}'")
       end
     rescue

data/lib/aixm/z.rb

@@ -13,8 +13,14 @@ module AIXM
   # * +AIXM::GROUND+ - surface expressed as "0 ft QFE"
   # * +AIXM::UNLIMITED+ - no upper limit expressed as "FL 999"
   class Z
+    extend Forwardable
+
     CODES = %i(qfe qnh qne).freeze
 
+    # @!method zero?
+    #   @return [Boolean] whether height, elevation or altitude is zero
+    def_delegator :@alt, :zero?
+
     # @return [Integer] altitude or elevation value
     attr_reader :alt
 

data/schemas/ofmx/0/OFMX-DataTypes.xsd

@@ -87,7 +87,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       <xsd:documentation>Reference to the source AIP document.</xsd:documentation>
     </xsd:annotation>
     <xsd:restriction base="xsd:string">
-      <xsd:pattern value="[A-Z]{2,4}\|(GEN|ENR|AD|AIRAC)\|.{3,}\|[\d-]+\|\d+"/>
+      <xsd:pattern value="[A-Z]{2,4}\|(GEN|ENR|AD|AIRAC|VAC)\|.+\|[\d-]+\|\d+"/>
     </xsd:restriction>
   </xsd:simpleType>
   <xsd:simpleType name="codeAcftEngineNoBase">
@@ -3398,6 +3398,10 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       <xsd:enumeration value="ICAO"/>
       <xsd:enumeration value="ADHP"/>
       <xsd:enumeration value="COORD"/>
+      <xsd:enumeration value="VFR-RP"/>
+      <xsd:enumeration value="VFR-MRP"/>
+      <xsd:enumeration value="VFR-ENR"/>
+      <xsd:enumeration value="VFR-GLD"/>
       <xsd:enumeration value="OTHER"/>
     </xsd:restriction>
   </xsd:simpleType>
@@ -4028,7 +4032,6 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   </xsd:complexType>
   <xsd:simpleType name="codeTypeSerAdBase">
     <xsd:restriction base="xsd:string">
-      <xsd:enumeration value="INFO"/>
       <xsd:enumeration value="FIRE"/>
       <xsd:enumeration value="CUST"/>
       <xsd:enumeration value="SAN"/>