aixm 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c00283d4f8eeb7bc39a916e5d71778bcb9398ccd27d8bd0dd118b452f4d897b6
-  data.tar.gz: 3d8c7cdf302994e590add9864ac684e98147fdc546e5ca3983bd5f68d498e3ea
+  metadata.gz: bd29f2661b79750343e05d494102c232fa91ffa861038eb4fe2b147fe2a01bd2
+  data.tar.gz: 657c897f48236120da2c82b833f65e8e540585176c46c939b1b9a73a594f13fd
 SHA512:
-  metadata.gz: 0adb07ef827f44488bb89739155ee4c038a300f18590ba652d1a06771fefb4b8b72d50a203c4790d3d8a551f4c5992fcca8d73de68c50cd6c1d4732505ffeb1f
-  data.tar.gz: a3f7cc1facbbae82eddf970e0eb240753c46f0cc4194c477ff44a0537ff5724764179a09ab9366cdf37665b5df7e2dfb2dae9431f4c8d0500aa1144a4a4b6437
+  metadata.gz: a356611cb807985b0dba0cde0fc5ced0ec07b84a9be92608145f32ea736a6d87f283d523855276e8902bb420575e80acca2d9f2109d424348f2c8771593c1a05
+  data.tar.gz: 0d98d537ced8fdea59cae71328bb684144e4c52c684f895b076a401ca39138f64683b796e8ba6486244f326662be9df30851fbf3c7819f4a8489b0c1315edeb0

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.2.0
+
+* Additions:
+  * Frequency
+  * Navigational aids
+  * `AIXM::Z#qfe?` and friends
+* Breaking major changes:
+  * Symbols such as :qnh, :ofm or :mhz are downcased now
+
+## 0.1.4
+
+* Breaking minor changes:
+  * `AIXM.z(alt: 123, code: :QNE)` is now `AIXM.z(123, :QNE)`
+
 ## 0.1.3
 
 * Breaking major changes:

data/README.md

@@ -31,13 +31,13 @@ You can initialize all elements either traditionally or by use of shorter
 AIXM class methods:
 
 ```ruby
-AIXM::Feature::Airspace.new(...)
+AIXM.airspace(...)
 AIXM.airspace(...)
 ```
 
 ### Fundamentals
 
-All fundamentals are bundled at the root of the module `AIXM`.
+All fundamentals are subclasses of `AIXM::Base`.
 
 ### Document
 
@@ -77,14 +77,20 @@ AIXM.xy(lat: 11.375955555555556, long: -111.37595555555555)
 Altitudes and heights exist in three different forms:
 
 ```ruby
-AIXM.z(alt: 1000, code: :QFE)   # height: 1000ft above ground
-AIXM.z(alt: 2000, code: :QNH)   # altitude: of 2000ft above mean sea level
-AIXM.z(alt: 45, code: :QNE)     # altitude: flight level 45
+AIXM.z(1000, :qfe)   # height: 1000ft above ground
+AIXM.z(2000, :qnh)   # altitude: of 2000ft above mean sea level
+AIXM.z(45, :qne)     # altitude: flight level 45
+```
+
+#### Frequency
+
+```ruby
+AIXM.f(123.35, :mhz)
 ```
 
 ### Features
 
-All features are subclasses of `AIXM::Feature`.
+All features are subclasses of `AIXM::Feature::Base`.
 
 #### Airspace
 
@@ -97,9 +103,72 @@ All features are subclasses of `AIXM::Feature`.
   * class_layers << AIXM.class_layer
   * remarks = String
 
+#### Navigational Aids
+
+##### Designated Point
+
+* AIXM.designated_point
+  * id: String
+  * name: String
+  * xy: AIXM.xy
+  * z: AIXM.z or *nil*
+  * type: :icao, :adhp, :coordinates or :other
+  * remarks = String
+
+##### DME
+
+* AIXM.dme
+  * id: String
+  * name: String
+  * xy: AIXM.xy
+  * z: AIXM.z or *nil*
+  * channel: String
+  * remarks = String
+
+##### NDB
+
+* AIXM.ndb
+  * id: String
+  * name: String
+  * xy: AIXM.xy
+  * z: AIXM.z or *nil*
+  * f: AIXM.f
+  * remarks = String
+
+##### Marker
+
+* AIXM.marker
+  * id: String
+  * name: String
+  * xy: AIXM.xy
+  * z: AIXM.z or *nil*
+  * remarks = String
+
+##### TACAN
+
+* AIXM.tacan
+  * id: String
+  * name: String
+  * xy: AIXM.xy
+  * z: AIXM.z or *nil*
+  * channel: String
+  * remarks = String
+
+##### VOR and DVOR
+
+* AIXM.vor
+  * id: String
+  * name: String
+  * xy: AIXM.xy
+  * z: AIXM.z or *nil*
+  * type: :vor or :vordme
+  * f: AIXM.f
+  * north: :geographic or :magnetic
+  * remarks = String
+
 ### Components
 
-All components are subclasses of `AIXM::Component`.
+All components are subclasses of `AIXM::Component::Base`.
 
 #### Schedule
 
@@ -148,16 +217,21 @@ For a geometry to be complete, it must be comprised of either:
 
 ## Validation
 
-* Use `AIXM::Document#complete?` to check whether all mandatory information is
+Use `AIXM::Document#complete?` to check whether all mandatory information is
 present. Airspaces, geometries etc have `complete?` methods as well.
-* Use `AIXM::Document#valid?` to validate the resulting AIXM against the XSD
-schema. If any, you find the errors in `AIXM::Document#errors`.
+
+Use `AIXM::Document#valid?` to validate the resulting AIXM against the XSD
+schema. If any, you find the errors in `AIXM::Document#errors`. Since the data
+model is not fully implemented, some associations cannot be assigned and have
+to be left empty. The resulting validation errors are silently ignored:
+
+* OrgUid - organizations may be empty tags
 
 ## Rendering
 
 ```ruby
 document.to_xml         # render AIXM 4.5 compliant XML
-document.to_xml(:OFM)   # render AIXM 4.5 + OFM extensions XML
+document.to_xml(:ofm)   # render AIXM 4.5 + OFM extensions XML
 ```
 
 ## Constants
@@ -170,6 +244,7 @@ document.to_xml(:OFM)   # render AIXM 4.5 + OFM extensions XML
 
 By `using AIXM::Refinements` you get the following general purpose methods:
 
+* `Hash#lookup(key, default)`<br>Similar to `fetch` but falls back to values
 * `String#indent(number)`<br>Indent every line of a string with *number* spaces
 * `String#uptrans`<br>upcase and transliterate to match the reduced character set for names
 * `String#to_dd`<br>Convert DMS angle to DD or `nil` if the format is not recognized
@@ -177,6 +252,9 @@ By `using AIXM::Refinements` you get the following general purpose methods:
 * `Float#trim`<br>Convert whole numbers to Integer and leave all other untouched
 * `Float#to_km(from: unit)`<br>Convert a distance from *unit* (:km, :m, :nm or :ft) to km
 
+See the [source code](https://github.com/svoop/aixm/blob/master/lib/aixm/refinements.rb)
+for more explicit descriptions and examples.
+
 ## Extensions
 
 ### OFM
@@ -194,6 +272,8 @@ originative suite:
 
 * [AIXM](http://aixm.aero)
 * [AIXM on Wikipedia](https://en.wikipedia.org/wiki/AIXM)
+* [AIXM 4.5 Specification](http://aixm.aero/document/aixm-45-specification)
+* [AICM 4.5 Entity-Relationship](https://www.ead.eurocontrol.int/SystemHelp/mergedProjects/SDO/aixm/)
 * [Open Flightmaps](https://openflightmaps.org)
 
 ## Tests

data/lib/aixm.rb

@@ -8,9 +8,11 @@ require 'time'
 require_relative 'aixm/version'
 require_relative 'aixm/refinements'
 
+require_relative 'aixm/base'
 require_relative 'aixm/document'
 require_relative 'aixm/xy'
 require_relative 'aixm/z'
+require_relative 'aixm/f'
 
 require_relative 'aixm/component/base'
 require_relative 'aixm/component/geometry'
@@ -22,6 +24,14 @@ require_relative 'aixm/component/class_layer'
 require_relative 'aixm/component/vertical_limits'
 require_relative 'aixm/component/schedule'
 
+require_relative 'aixm/feature/base'
 require_relative 'aixm/feature/airspace'
+require_relative 'aixm/feature/navigational_aid/base'
+require_relative 'aixm/feature/navigational_aid/designated_point'
+require_relative 'aixm/feature/navigational_aid/dme'
+require_relative 'aixm/feature/navigational_aid/marker'
+require_relative 'aixm/feature/navigational_aid/ndb'
+require_relative 'aixm/feature/navigational_aid/tacan'
+require_relative 'aixm/feature/navigational_aid/vor'
 
 require_relative 'aixm/shortcuts'

data/lib/aixm/base.rb

@@ -0,0 +1,10 @@
+module AIXM
+  class Base
+    using AIXM::Refinements
+
+    def format_for(*extensions)
+      extensions >> :ofm ? :ofm : :aixm
+    end
+
+  end
+end

data/lib/aixm/component/base.rb

@@ -1,6 +1,6 @@
 module AIXM
   module Component
-    class Base
+    class Base < AIXM::Base
     end
   end
 end

data/lib/aixm/component/class_layer.rb

@@ -34,9 +34,6 @@ module AIXM
 
       ##
       # Render AIXM
-      #
-      # Extensions:
-      # * +:OFM+ - Open Flightmaps
       def to_xml(*extensions)
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.codeClass(self.class.to_s) if self.class

data/lib/aixm/component/geometry.rb

@@ -47,9 +47,6 @@ module AIXM
 
       ##
       # Render AIXM
-      #
-      # Extensions:
-      # * +:OFM+ - Open Flightmaps
       def to_xml(*extensions)
         @result_array.map { |h| h.to_xml(*extensions) }.join
       end

data/lib/aixm/component/geometry/arc.rb

@@ -31,19 +31,15 @@ module AIXM
 
         ##
         # Render AIXM
-        #
-        # Extensions:
-        # * +:OFM+ - Open Flightmaps
         def to_xml(*extensions)
-          format = extensions >> :OFM ? :OFM : :AIXM
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Avx do |avx|
             avx.codeType(clockwise? ? 'CWA' : 'CCA')
-            avx.geoLat(xy.lat(format))
-            avx.geoLong(xy.long(format))
+            avx.geoLat(xy.lat(format_for(*extensions)))
+            avx.geoLong(xy.long(format_for(*extensions)))
             avx.codeDatum('WGE')
-            avx.geoLatArc(center_xy.lat(format))
-            avx.geoLongArc(center_xy.long(format))
+            avx.geoLatArc(center_xy.lat(format_for(*extensions)))
+            avx.geoLongArc(center_xy.long(format_for(*extensions)))
           end
         end
       end

data/lib/aixm/component/geometry/base.rb

@@ -0,0 +1,8 @@
+module AIXM
+  module Component
+    class Geometry
+      class Base < AIXM::Component::Base
+      end
+    end
+  end
+end

data/lib/aixm/component/geometry/border.rb

@@ -23,19 +23,14 @@ module AIXM
 
         ##
         # Render AIXM
-        #
-        # Extensions:
-        # * +:OFM+ - Open Flightmaps
         def to_xml(*extensions)
-          format = extensions >> :OFM ? :OFM : :AIXM
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Avx do |avx|
             avx.codeType('FNT')
-            avx.geoLat(xy.lat(format))
-            avx.geoLong(xy.long(format))
+            avx.geoLat(xy.lat(format_for(*extensions)))
+            avx.geoLong(xy.long(format_for(*extensions)))
             avx.codeDatum('WGE')
-            # TODO: Find examples how to do this with vanilla AIXM
-            if extensions >> :OFM
+            if extensions >> :ofm
               avx.GbrUid do |gbruid|
                 gbruid.txtName(name.to_s)
               end

data/lib/aixm/component/geometry/circle.rb

@@ -4,7 +4,7 @@ module AIXM
 
       ##
       # Circles are defined by a +center_xy+ and a +radius+ in kilometers.
-      class Circle
+      class Circle < Base
         using AIXM::Refinements
 
         attr_reader :center_xy, :radius
@@ -22,19 +22,15 @@ module AIXM
 
         ##
         # Render AIXM
-        #
-        # Extensions:
-        # * +:OFM+ - Open Flightmaps
         def to_xml(*extensions)
-          format = extensions >> :OFM ? :OFM : :AIXM
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Avx do |avx|
             avx.codeType('CWA')
-            avx.geoLat(north_xy.lat(format))
-            avx.geoLong(north_xy.long(format))
+            avx.geoLat(north_xy.lat(format_for(*extensions)))
+            avx.geoLong(north_xy.long(format_for(*extensions)))
             avx.codeDatum('WGE')
-            avx.geoLatArc(center_xy.lat(format))
-            avx.geoLongArc(center_xy.long(format))
+            avx.geoLatArc(center_xy.lat(format_for(*extensions)))
+            avx.geoLongArc(center_xy.long(format_for(*extensions)))
           end
         end
 

data/lib/aixm/component/geometry/point.rb

@@ -4,9 +4,12 @@ module AIXM
 
       ##
       # Points are defined by +xy+ coordinates.
-      class Point
+      class Point < Base
+        extend Forwardable
         using AIXM::Refinements
 
+        def_delegators :xy, :to_digest
+
         attr_reader :xy
 
         def initialize(xy:)
@@ -14,24 +17,14 @@ module AIXM
           @xy = xy
         end
 
-        ##
-        # Digest to identify the payload
-        def to_digest
-          [xy.lat, xy.long].to_digest
-        end
-
         ##
         # Render AIXM
-        #
-        # Extensions:
-        # * +:OFM+ - Open Flightmaps
         def to_xml(*extensions)
-          format = extensions >> :OFM ? :OFM : :AIXM
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Avx do |avx|
             avx.codeType('GRC')
-            avx.geoLat(xy.lat(format))
-            avx.geoLong(xy.long(format))
+            avx.geoLat(xy.lat(format_for(*extensions)))
+            avx.geoLong(xy.long(format_for(*extensions)))
             avx.codeDatum('WGE')
           end
         end

data/lib/aixm/component/schedule.rb

@@ -12,20 +12,18 @@ module AIXM
       using AIXM::Refinements
 
       CODES = {
-        continuous: :H24,
-        sunrise_to_sunset: :HJ,
-        sunset_to_sunrise: :HN,
-        unspecified: :HX,
-        operational_request: :HO,
-        notam: :NOTAM
+        H24: :continuous,
+        HJ: :sunrise_to_sunset,
+        HN: :sunset_to_sunrise,
+        HX: :unspecified,
+        HO: :operational_request,
+        NOTAM: :notam
       }.freeze
 
       attr_reader :code
 
       def initialize(code:)
-        @code = code&.to_sym
-        @code = CODES[code] unless CODES.has_value? code
-        fail(ArgumentError, "code `#{code}' not recognized") unless @code
+        @code = CODES.lookup(code&.to_sym, nil) || fail(ArgumentError, "invalid code")
       end
 
       ##
@@ -37,7 +35,7 @@ module AIXM
       ##
       # Render AIXM
       def to_xml(*extensions)
-        Builder::XmlMarkup.new(indent: 2).codeWorkHr(code.to_s)
+        Builder::XmlMarkup.new(indent: 2).codeWorkHr(CODES.key(code).to_s)
       end
     end
 

data/lib/aixm/component/vertical_limits.rb

@@ -16,7 +16,7 @@ module AIXM
       using AIXM::Refinements
 
       TAGS = { upper: :Upper, lower: :Lower, max: :Max, min: :Mnm }.freeze
-      CODES = { QFE: :HEI, QNH: :ALT, QNE: :STD }.freeze
+      CODES = { qfe: :HEI, qnh: :ALT, qne: :STD }.freeze
 
       attr_reader :upper_z, :lower_z, :max_z, :min_z
 
@@ -36,9 +36,6 @@ module AIXM
 
       ##
       # Render AIXM
-      #
-      # Extensions:
-      # * +:OFM+ - Open Flightmaps
       def to_xml(*extensions)
         %i(upper lower max min).each_with_object(Builder::XmlMarkup.new(indent: 2)) do |limit, builder|
           if z = send(:"#{limit}_z")