aixm 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efe8ab0dda077e481484589c0e2943b6417cefb5386e16d872692161b46add3f
-  data.tar.gz: f7fb02c428760481b9159d81c93baec8e4e2d1ef1267e1884f02422d44af7b9b
+  metadata.gz: d13df653e543e46983fa5d15d841afae85142eb249e0272ecfa9e440047f8998
+  data.tar.gz: 988b5d2736771137ba4764b320c886d456576ecdea0c1115d3dde4d9ab33dbb4
 SHA512:
-  metadata.gz: 1dcee1f3e19c58ada30b66bfa48201bae02a382bb6a8746b6f144de6c3280ef58ce2e6b6dc25ba5343ff9cfc9589e81e2217573bdfce642623f73530bf626e56
-  data.tar.gz: 1cf3f783adfa14e2af626d97810c8bfbd3e776718a207e70343ed1bf1f2f5ccbaa52142aa5ab32727af99a8c07733d056817536f3157b171878c0d03b9363208
+  metadata.gz: 86b872de155b94fd83a331b7935e4496a8558fdff94e60d64fcceb9973e1ce21acf7f08a52e5955f03352990f0a818b3844fda3ad598e394bcf83aabb7b5dd0e
+  data.tar.gz: da0e8ab2566abb6530085c632a4e84bc7628ec2aa42cc93566c0b35c2768657f7c42764848b9a0b5149d15617aa25990bb0c5a7a368f39f67cc19f17d702ebc4

data/.gitignore

@@ -1,5 +1,5 @@
 .DS_Store
-Gemfile.lock
+gems.locked
 pkg/*
 *.gem
 .bundle

data/.travis.yml

@@ -2,3 +2,7 @@
 language: ruby
 rvm:
   - 2.6.3
+before_install:
+  - gem update --system
+  - gem install bundler
+  - bundle install

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.3.6
+
+#### Additions
+* `AIXM::Component::FATO`
+* `AIXM::Component::Helipad#helicopter_class` and `AIXM::Component::Helipad#marking`
+* `AIXM::XY#seconds?` to detect possibly rounded or estimated coordinates
+* `AIXM::Features::Airport#operator`
+* `AIXM::W` (weight)
+* `AIXM::P` (pressure)
+* `AIXM::Component::Lighting` for use with runways, helipads and FATOs
+* Surface details `siwl_weight`, `siwl_tire_pressure` and `auw_weight`
+
+#### Changes
+* Generate `Airport#id` from region and `Airport#name`
+
 ## 0.3.5
 
 #### Additions

data/README.md

@@ -1,14 +1,13 @@
 [![Version](https://img.shields.io/gem/v/aixm.svg?style=flat)](https://rubygems.org/gems/aixm)
 [![Continuous Integration](https://img.shields.io/travis/svoop/aixm/master.svg?style=flat)](https://travis-ci.org/svoop/aixm)
-[![Code Climate](https://img.shields.io/codeclimate/github/svoop/aixm.svg?style=flat)](https://codeclimate.com/github/svoop/aixm)
-[![Gitter](https://img.shields.io/gitter/room/svoop/aixm.svg?style=flat)](https://gitter.im/svoop/aixm)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/svoop/aixm.svg?style=flat)](https://codeclimate.com/github/svoop/aixm/)
 [![Donorbox](https://img.shields.io/badge/donate-on_donorbox-yellow.svg)](https://donorbox.org/bitcetera)
 
 # AIXM
 
 Partial implementation of the [Aeronautical Information Exchange Model (AIXM 4.5)](http://aixm.aero) and it's dialect [Open FlightMaps eXchange format (OFMX 0)](https://github.com/openflightmaps/ofmx) for Ruby.
 
-For now, only the parts needed to automize the AIP import of [Open Flightmaps](https://openflightmaps.org) are part of this gem. Most notably, the gem is only a builder for snapshot files and does not parse them.
+For now, only the parts needed to automize the AIP import of [open flightmaps](https://openflightmaps.org) are part of this gem. Most notably, the gem is only a builder for snapshot files and does not parse them.
 
 * [Homepage](https://github.com/svoop/aixm)
 * [API](http://www.rubydoc.info/gems/aixm)
@@ -105,6 +104,7 @@ AIXM.schema(:version)   # => 0
   * [Circle](http://www.rubydoc.info/gems/aixm/AIXM/Component/Circle.html)
 * [Runway](http://www.rubydoc.info/gems/aixm/AIXM/Component/Runway.html)
 * [Helipad](http://www.rubydoc.info/gems/aixm/AIXM/Component/Helipad.html)
+* [FATO](http://www.rubydoc.info/gems/aixm/AIXM/Component/FATO.html)
 * [Surface](http://www.rubydoc.info/gems/aixm/AIXM/Component/Surface.html)
 * [Layer](http://www.rubydoc.info/gems/aixm/AIXM/Component/Layer.html)
 * [Vertical limits](http://www.rubydoc.info/gems/aixm/AIXM/Component/VerticalLimits.html)
@@ -118,13 +118,13 @@ By `using AIXM::Refinements` you get a few handy [extensions to Ruby core classe
 
 ### AIXM
 * [AIXM](http://aixm.aero)
-* [AICM 4.5 Documentation](https://openflightmaps.github.io/ofmx/aixm/4.5/manual/aicm/)
-* [AIXM 4.5 Specification](http://aixm.aero/document/aixm-45-specification)
+* [AICM 4.5 documentation](https://openflightmaps.github.io/ofmx/aixm/4.5/manual/aicm/)
+* [AIXM 4.5 specification](http://aixm.aero/document/aixm-45-specification)
 
 ### OFMX
 * [OFMX](https://github.com/openflightmaps/ofmx)
-* [OFMX Documentation](https://github.com/openflightmaps/ofmx/wiki)
-* [Open Flightmaps](https://openflightmaps.org)
+* [OFMX documentation](https://github.com/openflightmaps/ofmx/wiki)
+* [open flightmaps](https://openflightmaps.org)
 
 ## Tests
 

data/aixm.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest-matchers'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'yard'
 
   spec.add_runtime_dependency 'builder', '~> 3'
   spec.add_runtime_dependency 'nokogiri', '~> 1'

data/lib/aixm.rb

@@ -19,6 +19,8 @@ require_relative 'aixm/z'
 require_relative 'aixm/d'
 require_relative 'aixm/f'
 require_relative 'aixm/a'
+require_relative 'aixm/w'
+require_relative 'aixm/p'
 
 require_relative 'aixm/component'
 require_relative 'aixm/component/frequency'
@@ -31,8 +33,10 @@ require_relative 'aixm/component/layer'
 require_relative 'aixm/component/vertical_limits'
 require_relative 'aixm/component/timetable'
 require_relative 'aixm/component/runway'
+require_relative 'aixm/component/fato'
 require_relative 'aixm/component/helipad'
 require_relative 'aixm/component/surface'
+require_relative 'aixm/component/lighting'
 
 require_relative 'aixm/feature'
 require_relative 'aixm/feature/address'

data/lib/aixm/component/fato.rb

@@ -0,0 +1,255 @@
+using AIXM::Refinements
+
+module AIXM
+  class Component
+
+    # FATO (final approach and take-off area) for vertical take-off aircraft
+    # such as helicopters.
+    #
+    # ===Cheat Sheet in Pseudo Code:
+    #   fato = AIXM.fato(
+    #     name: String
+    #   )
+    #   fato.length = AIXM.d or nil   # must use same unit as width
+    #   fato.width = AIXM.d or nil    # must use same unit as length
+    #   fato.surface = AIXM.surface
+    #   fato.marking = String or nil
+    #   fato.profile = String or nil
+    #   fato.status = STATUSES or nil
+    #   fato.remarks = String or nil
+    #   fato.add_direction(
+    #     name: String
+    #   ) do |direction|
+    #     direction.geographic_orientation = AIXM.a[precision=3] or nil
+    #     direction.remarks = String or nil
+    #   end
+    #
+    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#fto-fato
+    class FATO
+      STATUSES = {
+        CLSD: :closed,
+        WIP: :work_in_progress,          # e.g. construction work
+        PARKED: :parked_aircraft,        # parked or disabled aircraft on FATO
+        FAILAID: :visual_aids_failure,   # failure or irregular operation of visual aids
+        SPOWER: :secondary_power,        # secondary power supply in operation
+        OTHER: :other                    # specify in remarks
+      }.freeze
+
+      # @return [AIXM::Feature::Airport] airport this FATO belongs to
+      attr_reader :airport
+
+      # @return [String] full name (e.g. "H1")
+      attr_reader :name
+
+      # @return [AIXM::D, nil] length
+      attr_reader :length
+
+      # @return [AIXM::D, nil] width
+      attr_reader :width
+
+      # @return [AIXM::Component::Surface] surface of the FATO
+      attr_reader :surface
+
+      # @return [String, nil] markings
+      attr_reader :marking
+
+      # @return [String, nil] profile description
+      attr_reader :profile
+
+      # @return [Symbol, nil] status of the FATO (see {STATUSES}) or +nil+ for normal operation
+      attr_reader :status
+
+      # @return [String, nil] free text remarks
+      attr_reader :remarks
+
+      # @return [Hash{String => AIXM::Component::FATO::Direction}] maps added direction names to full FATO directions
+      attr_reader :directions
+
+      def initialize(name:)
+        self.name = name
+        @surface = AIXM.surface
+        @directions = {}
+      end
+
+      # @return [String]
+      def inspect
+        %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
+      end
+
+      def length=(value)
+        @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
+        end
+      end
+
+      def width=(value)
+        @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
+        end
+      end
+
+      def marking=(value)
+        @marking = value&.to_s
+      end
+
+      def profile=(value)
+        @profile = value&.to_s
+      end
+
+      def status=(value)
+        @status = value.nil? ? nil : (STATUSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid status"))
+      end
+
+      def remarks=(value)
+        @remarks = value&.to_s
+      end
+
+      def add_direction(name:)
+        direction = Direction.new(fato: self, name: name)
+        yield direction
+        @directions[name] = direction
+      end
+
+      # @return [String] UID markup
+      def to_uid
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.FtoUid do |fto_uid|
+          fto_uid << airport.to_uid.indent(2)
+          fto_uid.txtDesig(name)
+        end
+      end
+
+      # @return [String] AIXM or OFMX markup
+      def to_xml
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.Fto do |fto|
+          fto << to_uid.indent(2)
+          fto.valLen(length.dist.trim) if length
+          fto.valWid(width.dist.trim) if width
+          fto.uomDim(length.unit.to_s.upcase) if length
+          fto.uomDim(width.unit.to_s.upcase) if width && !length
+          unless  (xml = surface.to_xml).empty?
+            fto << xml.indent(2)
+          end
+          fto.txtProfile(profile) if profile
+          fto.txtMarking(marking) if marking
+          fto.codeSts(STATUSES.key(status).to_s) if status
+          fto.txtRmk(remarks) if remarks
+        end
+        directions.values.each do |direction|
+          builder << direction.to_xml
+        end
+        builder.target!
+      end
+
+      # FATO directions further describe each direction to and from the FATO.
+      #
+      # @see https://github.com/openflightmaps/ofmx/wiki/Airport#fdn-fato-direction
+      class Direction
+
+        # @return [AIXM::Component::FATO] FATO the FATO direction is further describing
+        attr_reader :fato
+
+        # @return [AIXM::A] name of the FATO direction (e.g. "12" or "16L")
+        attr_reader :name
+
+        # @return [AIXM::A, nil] geographic orientation (true bearing) in degrees
+        attr_reader :geographic_orientation
+
+        # @return [String, nil] free text remarks
+        attr_reader :remarks
+
+        # @return [Array<AIXM::Component::Lighting>] installed lighting systems
+        attr_reader :lightings
+
+        def initialize(fato:, name:)
+          self.fato, self.name = fato, name
+          @lightings = []
+        end
+
+        # @return [String]
+        def inspect
+          %Q(#<#{self.class} airport=#{fato&.airport&.id.inspect} name=#{name.inspect}>)
+        end
+
+        def fato=(value)
+          fail(ArgumentError, "invalid FATO") unless value.is_a? AIXM::Component::FATO
+          @fato = value
+        end
+        private :fato
+
+        def name=(value)
+          fail(ArgumentError, "invalid name") unless value.is_a? String
+          @name = AIXM.a(value)
+        end
+
+        def geographic_orientation=(value)
+          return @geographic_orientation = nil if value.nil?
+          fail(ArgumentError, "invalid geographic orientation") unless value.is_a? AIXM::A
+          @geographic_orientation = value
+        end
+
+        def remarks=(value)
+          @remarks = value&.to_s
+        end
+
+        # Add a lighting system to the FATO 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 && fato.airport.declination
+            geographic_orientation + fato.airport.declination
+          end
+        end
+
+        # @return [String] UID markup
+        def to_uid
+          builder = Builder::XmlMarkup.new(indent: 2)
+          builder.FdnUid do |fdn_uid|
+            fdn_uid << fato.to_uid.indent(2)
+            fdn_uid.txtDesig(name)
+          end
+        end
+
+        # @return [String] AIXM or OFMX markup
+        def to_xml
+          builder = Builder::XmlMarkup.new(indent: 2)
+          builder.Fdn do |fdn|
+            fdn << to_uid.indent(2)
+            fdn.valTrueBrg(geographic_orientation) if geographic_orientation
+            fdn.valMagBrg(magnetic_orientation) if magnetic_orientation
+            fdn.txtRmk(remarks) if remarks
+          end
+          lightings.each do |lighting|
+            builder << lighting.to_xml(as: :Fls)
+          end
+          builder.target!
+        end
+      end
+    end
+  end
+end

data/lib/aixm/component/helipad.rb

@@ -3,22 +3,33 @@ using AIXM::Refinements
 module AIXM
   class Component
 
-    # Helipads are TLOF (touch-down and lift-off areas) e.g. for helicopters.
+    # Helipads are TLOF (touch-down and lift-off areas) for vertical take-off
+    # aircraft such as helicopters.
     #
     # ===Cheat Sheet in Pseudo Code:
     #   helipad = AIXM.helipad(
     #     name: String
+    #     xy = AIXM.xy
     #   )
-    #   helipad.xy = AIXM.xy
     #   helipad.z = AIXM.z or nil
     #   helipad.length = AIXM.d or nil   # must use same unit as width
     #   helipad.width = AIXM.d or nil    # must use same unit as length
     #   helipad.surface = AIXM.surface
+    #   helipad.marking = String or nil
+    #   helipad.fato = AIXM.fato or nil
+    #   helipad.helicopter_class = HELICOPTER_CLASSES or nil
     #   helipad.status = STATUSES or nil
     #   helipad.remarks = String or nil
     #
     # @see https://github.com/openflightmaps/ofmx/wiki/Airport#tla-helipad-tlof
     class Helipad
+      HELICOPTER_CLASSES = {
+        '1': :'1',
+        '2': :'2',
+        '3': :'3',
+        OTHER: :other   # specify in remarks
+      }.freeze
+
       STATUSES = {
         CLSD: :closed,
         WIP: :work_in_progress,          # e.g. construction work
@@ -49,15 +60,28 @@ module AIXM
       # @return [AIXM::Component::Surface] surface of the helipad
       attr_reader :surface
 
+      # @return [String, nil] markings
+      attr_reader :marking
+
+      # @return [AIXM::Component::FATO, nil] FATO the helipad is situated on
+      attr_reader :fato
+
+      # @return [Integer, Symbol, nil] suitable helicopter class
+      attr_reader :helicopter_class
+
       # @return [Symbol, nil] status of the helipad (see {STATUSES}) or +nil+ for normal operation
       attr_reader :status
 
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      def initialize(name:)
-        self.name = name
+      # @return [Array<AIXM::Component::Lighting>] installed lighting systems
+      attr_reader :lightings
+
+      def initialize(name:, xy:)
+        self.name, self.xy = name, xy
         @surface = AIXM.surface
+        @lightings = []
       end
 
       # @return [String]
@@ -102,6 +126,19 @@ module AIXM
         end
       end
 
+      def marking=(value)
+        @marking = value&.to_s
+      end
+
+      def fato=(value)
+        fail(ArgumentError, "invalid FATO") unless value.nil? || value.is_a?(AIXM::Component::FATO)
+        @fato = value
+      end
+
+      def helicopter_class=(value)
+        @helicopter_class = value.nil? ? nil : (HELICOPTER_CLASSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid helicopter class"))
+      end
+
       def status=(value)
         @status = value.nil? ? nil : (STATUSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid status"))
       end
@@ -110,6 +147,17 @@ 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 [String] UID markup
       def to_uid
         builder = Builder::XmlMarkup.new(indent: 2)
@@ -124,6 +172,7 @@ module AIXM
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.Tla do |tla|
           tla << to_uid.indent(2)
+          tla << fato.to_uid.indent(2) if fato
           tla.geoLat(xy.lat(AIXM.schema))
           tla.geoLong(xy.long(AIXM.schema))
           tla.codeDatum('WGE')
@@ -138,9 +187,15 @@ module AIXM
           unless  (xml = surface.to_xml).empty?
             tla << xml.indent(2)
           end
+          tla.codeClassHel(HELICOPTER_CLASSES.key(helicopter_class).to_s) if helicopter_class
+          tla.txtMarking(marking) if marking
           tla.codeSts(STATUSES.key(status).to_s) if status
           tla.txtRmk(remarks) if remarks
         end
+        lightings.each do |lighting|
+          builder << lighting.to_xml(as: :Tls)
+        end
+        builder.target!
       end
     end
   end