aixm 1.0.0 → 1.1.0

data/lib/aixm/document.rb

@@ -22,6 +22,7 @@ module AIXM
     # @!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]
@@ -58,6 +59,13 @@ module AIXM
       @effective_at = value&.to_time || created_at || Time.now
     end
 
+    # Regions used throughout this document.
+    #
+    # @return [Array<String>] white space separated list of region codes
+    def regions
+      features.map(&:region).uniq.sort
+    end
+
     # Compare all ungrouped obstacles and create new obstacle groups whose
     # members are located within +max_distance+ pairwise.
     #
@@ -110,6 +118,7 @@ module AIXM
         version: AIXM.schema(:version),
         origin: "rubygem aixm-#{AIXM::VERSION}",
         namespace: (namespace if AIXM.ofmx?),
+        regions: (regions.join(' '.freeze) if AIXM.ofmx?),
         created: @created_at.xmlschema,
         effective: @effective_at.xmlschema
       }.compact
@@ -117,7 +126,7 @@ module AIXM
       builder.instruct!
       builder.tag!(AIXM.schema(:root), meta) do |root|
         AIXM::Memoize.method :to_uid do
-          root << features.map { _1.to_xml }.join.indent(2)
+          root << features.map(&:to_xml).join.indent(2)
         end
       end
       if AIXM.ofmx? && AIXM.config.mid

data/lib/aixm/f.rb

@@ -32,7 +32,7 @@ module AIXM
 
     # @return [String] human readable representation (e.g. "123.35 mhz")
     def to_s
-      [freq, unit].join(' ')
+      [freq, unit].join(' '.freeze)
     end
 
     def freq=(value)

data/lib/aixm/feature/airport.rb

@@ -16,7 +16,7 @@ module AIXM
     #     xy: AIXM.xy
     #   )
     #   airport.gps = String or nil
-    #   airport.type = TYPES
+    #   airport.type = TYPES (other than AD, HP and AH only)
     #   airport.z = AIXM.z or nil
     #   airport.declination = Float or nil
     #   airport.transition_z = AIXM.z or nil
@@ -27,6 +27,8 @@ module AIXM
     #   airport.add_fato(AIXM.fato)
     #   airport.add_helipad(AIXM.helipad)
     #   airport.add_usage_limitation(UsageLimitation::TYPES)
+    #   airport.add_unit(AIXM.unit)
+    #   airport.add_service(AIXM.service)
     #   airport.add_address(AIXM.address)
     #
     # For airports without an +id+, you may assign the two character region
@@ -48,33 +50,30 @@ module AIXM
         LS: :landing_site
       }.freeze
 
-      # @!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]
@@ -82,16 +81,33 @@ module AIXM
 
       # @!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 services
+      #   @return [Array<AIXM::Component::Service>] services
+      #
+      # @!method add_service(service)
+      #   @param service [AIXM::Component::Service]
+      has_many :services
+
+      # @!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 organisation
       #   @return [AIXM::Feature::Organisation] superior organisation
       belongs_to :organisation, as: :member
@@ -144,8 +160,7 @@ module AIXM
 
       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
+        self.organisation, self.name, self.id, self.xy = organisation, name, id, xy   # name must be set before id
       end
 
       # @return [String]
@@ -293,6 +308,14 @@ module AIXM
           sequences[address.type] = (sequences[address.type] || 0) + 1
           builder << address.to_xml(as: :Aha, sequence: sequences[address.type])
         end
+        services.each do |service|
+          builder.Sah do |sah|
+            sah.SahUid do |sah_uid|
+              sah_uid << to_uid.indent(4)
+              sah_uid << service.to_uid.indent(4)
+            end
+          end
+        end
         builder.target!
       end
 
@@ -337,6 +360,7 @@ module AIXM
 
         # @!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]

data/lib/aixm/feature/airspace.rb

@@ -80,18 +80,21 @@ module AIXM
 
       # @!method geometry
       #   @return [AIXM::Component::Geometry] horizontal geometry shape
+      #
       # @!method geometry=(geometry)
       #   @param geometry [AIXM::Component::Geometry]
       has_one :geometry
 
       # @!method layers
       #   @return [Array<AIXM::Compoment::Layer>] vertical layers
+      #
       # @!method add_layer(layer)
       #   @param layer [AIXM::Compoment::Layer]
       has_many :layers
 
       # @note When assigning +nil+, a 4 byte hex derived from {#type}, {#name}
       #   and {#local_type} is written instead.
+      #
       # @return [String] published identifier (e.g. "LFP81")
       attr_reader :id
 

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

@@ -18,7 +18,8 @@ module AIXM
       #     name: String
       #     xy: AIXM.xy
       #     z: AIXM.z or nil
-      #     channel: String
+      #     channel: String   # either set channel directly
+      #     ghost_f: AIXM.f   # or set channel via VOR ghost frequency
       #   )
       #   dme.timetable = AIXM.timetable or nil
       #   dme.remarks = String or nil
@@ -31,6 +32,13 @@ module AIXM
 
         CHANNEL_RE = /\A([1-9]|[1-9]\d|1[0-1]\d|12[0-6])[XY]\z/.freeze
 
+        GHOST_MAP = {
+          108_00 => (17..59),
+          112_30 => (70..126),
+          133_30 => (60..69),
+          134_40 => (1..16)
+        }.freeze
+
         # @!method vor
         #   @return [AIXM::Feature::NavigationalAid::VOR, nil] associated VOR
         belongs_to :vor, readonly: true
@@ -38,9 +46,13 @@ module AIXM
         # @return [String] radio channel
         attr_reader :channel
 
-        def initialize(channel:, **arguments)
+        def initialize(channel: nil, ghost_f: nil, **arguments)
           super(**arguments)
-          self.channel = channel
+          case
+            when channel then self.channel = channel
+            when ghost_f then self.ghost_f = ghost_f
+            else fail(ArgumentError, "either channel or ghost_f must be set")
+          end
         end
 
         def channel=(value)
@@ -48,17 +60,24 @@ module AIXM
           @channel = value
         end
 
+        def ghost_f=(value)
+          fail(ArgumentError, "invalid ghost_f") unless value.is_a?(AIXM::F) && value.unit == :mhz
+          integer, letter = (value.freq * 100).round, 'X'
+          unless (integer % 10).zero?
+            integer -= 5
+            letter = 'Y'
+          end
+          base = GHOST_MAP.keys.reverse.bsearch { _1 <= integer }
+          number = ((integer - base) / 10) + GHOST_MAP[base].min
+          self.channel = "#{number}#{letter}"
+        end
+
         # @return [AIXM::F] ghost frequency matching the channel
         def ghost_f
           if channel
             number, letter = channel.split(/(?=[XY])/)
-            integer = case number.to_i
-              when (1..16) then 13430
-              when (17..59) then 10630
-              when (60..69) then 12730
-              when (70..126) then 10530
-            end
-            integer += number.to_i * 10
+            integer = GHOST_MAP.find { _2.include?(number.to_i) }.first
+            integer += (number.to_i - GHOST_MAP[integer].min) * 10
             integer += 5 if letter == 'Y'
             AIXM.f(integer.to_f / 100, :mhz)
           end

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

@@ -28,7 +28,7 @@ module AIXM
       # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#mkr-marker-beacon
       class Marker < NavigationalAid
         include AIXM::Memoize
-        
+
         public_class_method :new
 
         TYPES = {
@@ -46,7 +46,7 @@ module AIXM
         def initialize(type:, **arguments)
           super(**arguments)
           self.type = type
-          warn("WARNING: Maker is not fully implemented yet due to the lack of ILS")
+          warn("WARNING: Marker is not fully implemented yet due to the lack of ILS")
         end
 
         def type=(value)

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

@@ -17,7 +17,8 @@ module AIXM
       #     name: String
       #     xy: AIXM.xy
       #     z: AIXM.z or nil
-      #     channel: String
+      #     channel: String   # either set channel directly
+      #     ghost_f: AIXM.f   # or set channel via VOR ghost frequency
       #   )
       # tacan.timetable = AIXM.timetable or nil
       # tacan.remarks = String or nil
@@ -25,7 +26,7 @@ module AIXM
       # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#tcn-tacan
       class TACAN < DME
         include AIXM::Memoize
-        
+
         public_class_method :new
 
         # @return [String] UID markup

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

@@ -23,13 +23,13 @@ module AIXM
       #   )
       #   vor.timetable = AIXM.timetable or nil
       #   vor.remarks = String or nil
-      #   vor.associate_dme(channel: String)     # turns the VOR into a VOR/DME
-      #   vor.associate_tacan(channel: String)   # turns the VOR into a VORTAC
+      #   vor.associate_dme     # turns the VOR into a VOR/DME
+      #   vor.associate_tacan   # turns the VOR into a VORTAC
       #
       # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#vor-vor
       class VOR < NavigationalAid
         include AIXM::Memoize
-        
+
         public_class_method :new
 
         TYPES = {
@@ -47,12 +47,14 @@ module AIXM
 
         # @!method dme
         #   @return [AIXM::Feature::NavigationalAid::DME, nil] associated DME
+        #
         # @!method dme=(dme)
         #   @param dme [AIXM::Feature::NavigationalAid::DME, nil]
         has_one :dme, allow_nil: true
 
         # @!method tacan
         #   @return [AIXM::Feature::NavigationalAid::TACAN, nil] associated TACAN
+        #
         # @!method tacan=(tacan)
         #   @param tacan [AIXM::Feature::NavigationalAid::TACAN, nil]
         has_one :tacan, allow_nil: true
@@ -84,16 +86,33 @@ module AIXM
           @north = NORTHS.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid north")
         end
 
-        # Associate a DME which turns the VOR into a VOR/DME
-        def associate_dme(channel:)
-          self.dme = AIXM.dme(region: region, organisation: organisation, id: id, name: name, xy: xy, z: z, channel: channel)
-          dme.timetable, @dme.remarks = timetable, remarks
-        end
-
-        # Associate a TACAN which turns the VOR into a VORTAC
-        def associate_tacan(channel:)
-          self.tacan = AIXM.tacan(region: region, organisation: organisation, id: id, name: name, xy: xy, z: z, channel: channel)
-          tacan.timetable, @tacan.remarks = timetable, remarks
+        # @!method associate_dme
+        #   Build a DME associated to this VOR (which turns it into a VOR/DME)
+        #
+        #   @return [AIXM::Feature::NavigationalAid::DME] associated DME
+        #
+        # @!method dassociate_tacan
+        #   Build a TACAN associated to this VOR (which turns it into a VORTAC)
+        #
+        #   @return [AIXM::Feature::NavigationalAid::TACAN] associated TACAN
+        %i(dme tacan).each do |secondary|
+          define_method("associate_#{secondary}") do
+            send("#{secondary}=",
+              AIXM.send(secondary,
+                region: region,
+                source: source,
+                organisation: organisation,
+                id: id,
+                name: name,
+                xy: xy,
+                z: z,
+                ghost_f: f
+              ).tap do |navigational_aid|
+                navigational_aid.timetable = timetable
+                navigational_aid.remarks = remarks
+              end
+            )
+          end
         end
 
         # @return [String] UID markup

data/lib/aixm/feature/navigational_aid.rb

@@ -72,7 +72,7 @@ module AIXM
 
       # @return [String] fully descriptive combination of {#class} and {#type} key
       def kind
-        [self.class.name.split('::').last, type_key].compact.join(':')
+        [self.class.name.split('::').last, type_key].compact.join(':'.freeze)
       end
 
       private

data/lib/aixm/feature/obstacle.rb

@@ -155,7 +155,7 @@ module AIXM
       end
 
       def radius=(value)
-        fail(ArgumentError, "invalid radius") unless value.nil? || (value.is_a?(AIXM::D) && value.dist > 0)
+        fail(ArgumentError, "invalid radius") unless value.nil? || (value.is_a?(AIXM::D) && value.dim > 0)
         @radius = value
       end
 
@@ -178,7 +178,7 @@ module AIXM
       end
 
       def height=(value)
-        fail(ArgumentError, "invalid height") unless value.nil? || (value.is_a?(AIXM::D) && value.dist > 0)
+        fail(ArgumentError, "invalid height") unless value.nil? || (value.is_a?(AIXM::D) && value.dim > 0)
         @height = value
       end
 
@@ -267,21 +267,21 @@ module AIXM
           obs.txtDescrMarking(marking_remarks) if marking_remarks
           obs.codeDatum('WGE')
           if AIXM.aixm? && obstacle_group.xy_accuracy
-            obs.valGeoAccuracy(obstacle_group.xy_accuracy.dist.trim)
+            obs.valGeoAccuracy(obstacle_group.xy_accuracy.dim.trim)
             obs.uomGeoAccuracy(obstacle_group.xy_accuracy.unit.upcase.to_s)
           end
           obs.valElev(z.alt)
           if AIXM.aixm? && obstacle_group.z_accuracy
-            obs.valElevAccuracy(obstacle_group.z_accuracy.to_ft.dist.round)
+            obs.valElevAccuracy(obstacle_group.z_accuracy.to_ft.dim.round)
           end
-          obs.valHgt(height.to_ft.dist.round) if height
+          obs.valHgt(height.to_ft.dim.round) if height
           obs.uomDistVer('FT')
           if AIXM.ofmx? && !height_accurate.nil?
             obs.codeHgtAccuracy(height_accurate ? 'Y' : 'N')
           end
           if AIXM.ofmx?
             if radius
-              obs.valRadius(radius.dist.trim)
+              obs.valRadius(radius.dim.trim)
               obs.uomRadius(radius.unit.upcase.to_s)
             end
             if grouped? && linked?

data/lib/aixm/feature/obstacle_group.rb

@@ -45,6 +45,7 @@ module AIXM
 
       # @!method obstacles
       #   @return [Array<AIXM::Feature::Obstacle>] obstacles in this obstacle group
+      #
       # @!method add_obstacle(obstacle, linked_to: nil, link_type: nil)
       #   @param obstacle [AIXM::Feature::Obstacle] obstacle instance
       #   @param linked_to [Symbol, AIXM::Feature::Obstacle, nil] Either:
@@ -62,10 +63,13 @@ module AIXM
 
       # @!method source
       #   @return [String] reference to source of the feature data
+      #
       # @!method name
       #   @return [String] obstacle group name
+      #
       # @!method xy_accuracy
       #   @return [AIXM::D, nil] margin of error for circular base center point
+      #
       # @!method z_accuracy
       #   @return [AIXM::D, nil] margin of error for top point
       %i(source name xy_accuracy z_accuracy).each do |method|
@@ -126,11 +130,11 @@ module AIXM
             ogr << to_uid.indent(2)
             ogr.codeDatum('WGE')
             if xy_accuracy
-              ogr.valGeoAccuracy(xy_accuracy.dist.trim)
+              ogr.valGeoAccuracy(xy_accuracy.dim.trim)
               ogr.uomGeoAccuracy(xy_accuracy.unit.upcase.to_s)
             end
             if z_accuracy
-              ogr.valElevAccuracy(z_accuracy.to_ft.dist.round)
+              ogr.valElevAccuracy(z_accuracy.to_ft.dim.round)
               ogr.uomElevAccuracy('FT')
             end
             ogr.txtRmk(remarks) if remarks

data/lib/aixm/feature/organisation.rb

@@ -39,6 +39,7 @@ module AIXM
       #   @return [Array<AIXM::Feature::Airport,
       #     AIXM::Feature::Unit,
       #     AIXM::Feature::NavigationalAid>] aiports, units or navigational aids
+      #
       # @!method add_member(member)
       #   @param member [AIXM::Feature::Airport,
       #     AIXM::Feature::Unit,

data/lib/aixm/feature/unit.rb

@@ -82,6 +82,7 @@ module AIXM
 
       # @!method services
       #   @return [Array<AIXM::Component::Service>] services provided by this unit
+      #
       # @!method add_service(service)
       #   @param service [AIXM::Component::Service]
       has_many :services
@@ -169,7 +170,7 @@ module AIXM
       private
 
       def name_with_type
-        [name, TYPES.key(type)].join(' ')
+        [name, TYPES.key(type)].join(' '.freeze)
       end
     end
 

data/lib/aixm/feature.rb

@@ -6,6 +6,9 @@ module AIXM
 
     private_class_method :new
 
+    # @return [Object] freely usable e.g. to find_by foreign keys
+    attr_accessor :meta
+
     # @return [String] reference to source of the feature data
     attr_reader :source
 

data/lib/aixm/memoize.rb

@@ -8,6 +8,9 @@ module AIXM
   # independently. On the other hand, when calling the method with a block,
   # no memoization is performed at all.
   #
+  # Nested memoization of the same method is allowed and won't reset the
+  # memoization cache.
+  #
   # @example
   #   class Either
   #     include AIXM::Memoize
@@ -53,14 +56,15 @@ module AIXM
         unmemoized_method = :"unmemoized_#{method}"
         alias_method unmemoized_method, method
         define_method method do |*args, **kargs, &block|
-          if block || !AIXM::Memoize.cache
+          if block || !AIXM::Memoize.cache.has_key?(method)
             send(unmemoized_method, *args, **kargs, &block)
           else
+            cache = AIXM::Memoize.cache[method]
             id = object_id.hash ^ args.hash ^ kargs.hash
-            if AIXM::Memoize.cache.has_key?(id)
-              AIXM::Memoize.cache[id]
+            if cache.has_key?(id)
+              cache[id]
             else
-              AIXM::Memoize.cache[id] = send(unmemoized_method, *args, **kargs, &block)
+              cache[id] = send(unmemoized_method, *args, **kargs)
             end
           end
         end
@@ -68,22 +72,34 @@ module AIXM
     end
 
     class << self
+      attr_reader :cache
+
       def included(base)
         base.extend(ClassMethods)
         @cache = {}
       end
 
-      def method(method)
-        @method = method
-        @cache[@method] = {}
+      def method(method, &)
+        send(:"call_with#{:out if cached?(method)}_cache", method, &)
+      end
+
+      private
+
+      def cached?(method)
+        cache.has_key?(method)
+      end
+
+      def call_without_cache(method)
         yield
-      ensure
-        @method = nil
       end
 
-      def cache
-        (@cache[@method] ||= {}) if @method
+      def call_with_cache(method)
+        cache[method] = {}
+        yield
+      ensure
+        cache.delete(method)
       end
+
     end
   end
 end

data/lib/aixm/p.rb

@@ -2,7 +2,7 @@ using AIXM::Refinements
 
 module AIXM
 
-  # pressure
+  # Pressure
   #
   # @example
   #   AIXM.d(14, :bar)
@@ -39,7 +39,7 @@ module AIXM
 
     # @return [String] human readable representation (e.g. "14 bar")
     def to_s
-      [pres, unit].join(' ')
+      [pres, unit].join(' '.freeze)
     end
 
     def pres=(value)
@@ -58,6 +58,7 @@ module AIXM
     # @!method to_psi
     # @!method to_bar
     # @!method to_torr
+    #
     # @return [AIXM::P] convert pressure
     UNITS.each_key do |target_unit|
       define_method "to_#{target_unit}" do

data/lib/aixm/payload_hash.rb

@@ -44,7 +44,7 @@ module AIXM
     end
 
     def uuid_for(array)
-      ::Digest::MD5.hexdigest(array.flatten.map(&:to_s).join('|')).unpack("a8a4a4a4a12").join("-")
+      ::Digest::MD5.hexdigest(array.flatten.map(&:to_s).join('|'.freeze)).unpack("a8a4a4a4a12").join('-'.freeze)
     end
 
     # Insert OFMX-compliant payload hashes as mid attributes into an XML

data/lib/aixm/r.rb

@@ -0,0 +1,62 @@
+using AIXM::Refinements
+
+module AIXM
+
+  # Rectangle shape composed of two lengths
+  #
+  # @examples
+  #   AIXM.r(AIXM.d(25, :m), AIXM.d(20, :m))   # rectangle
+  #   AIXM.r(AIXM.d(25, :m))                   # square
+  class R
+
+    # @return [AIXM::D] rectangle length
+    attr_reader :length
+
+    # @return [AIXM::D] rectangle width
+    attr_reader :width
+
+    def initialize(length, width=nil)
+      self.length, self.width = length, (width || length)
+    end
+
+    # @return [String]
+    def inspect
+      %Q(#<#{self.class} #{to_s}>)
+    end
+
+    # @return [String] human readable representation (e.g. "25.0 m x 20.0 m")
+    def to_s
+      [length, width].join(' x ')
+    end
+
+    %i(length width).each do |dimension|
+      define_method("#{dimension}=") do |value|
+        fail(ArgumentError, "invalid dimension") unless value.is_a? AIXM::D
+        instance_variable_set(:"@#{dimension}", value)
+        @length, @width = @width, @length if @length && @width && @length < @width
+      end
+    end
+
+    # Calculate the surface in square meters
+    #
+    # @return [Float]
+    def surface
+      length.to_m.dim * width.to_m.dim
+    end
+
+    # @see Object#==
+    # @return [Boolean]
+    def ==(other)
+      self.class === other && length == other.length && width == other.width
+    end
+    alias_method :eql?, :==
+
+    # @see Object#hash
+    # @return [Integer]
+    def hash
+      to_s.hash
+    end
+
+  end
+
+end