aixm 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f5f953610761dad1816bb0a390155538205afc41fc53d677f9d433a53de5f6
-  data.tar.gz: ba6b9edea4dc9ffe27239021f28fb3b2cb816bba568286f0108bf070a7108a73
+  metadata.gz: da3e3c10902d2c8b47bea41e1056a5447890e1ebeb9d7fb651115cc894f10067
+  data.tar.gz: dc2edb38a94804aa7c2c89d2cfcad6872a909598e77ac266fafebf2c39f7deb0
 SHA512:
-  metadata.gz: b0947e0e79962e86e21f96833d47944c012fd1be4fa28a2fbf1aa3d82e2549195bafdcb32d9b3e6fd65f8f63ede53000d7218c6afaa5393549768d1ad0d6b569
-  data.tar.gz: 4358cb754979f06efd3c62d0288a41db984573d6de47f021c585ab056f801c71de480c1258969eeed33db287cc13137355c016f7e911c91e555a499067d9f15c
+  metadata.gz: 70a1af692e7141c60c49b3c2426be8037f030acc7808a3ec12029bc8df5bc62681396eb3b8e42add5aff92c10d010156a4cc920f8febf0b70a576a1fb5bd7ac2
+  data.tar.gz: c5dc5a92ebef4b7dea61928c794dd2d38c64c9d6a83fc305cb6b6105dff3adb7cb34b4c5eccb95501a14dbb89317c311924c5928a84fa333c165112cda63f820

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.1
+ruby-2.5.3

data/CHANGELOG.md

@@ -1,101 +1,125 @@
+## 0.3.1
+
+#### Additions
+* `AIXM::Error` base error which reveals the `subject`
+* Consider single point geometries to be closed
+* Calculate `DME#ghost_f` from `DME#channel`
+* `Layer#location_indicator` and `Layer#activity`
+
+#### Breaking Changes
+* Renamed `Airport#code` to `Airport#id`
+* Renamed `Airspace#short_name` to `Airspace#local_type`
+* Moved `region` attribute from features to Document 
+
+#### Changes
+* Be more permissive on `Airport#id` in order to accomodate generated codes
+  built by concatting the `region` and `Airport#gps`.
+
 ## 0.3.0
 
-* Breaking additions:
-  * Global configuration with `AIXM.config`
-* Breaking changes:
-  * Switch from "AIXM with OFM extensions" to OFMX
-  * `to_aixm` renamed to `to_xml` again
-  * Removed signature `to_xml(extension)` in favor of `AIXM.schema`
-  * Removed `Array#to_digest`
-  * Removed `Document#complete?`
-  * Renamed Schedule to Timetable
-  * Timetable and remarks moved from Airspace to to Layer (formerly known as
-    class layer)
-* Additions
-  * Organization and Unit features
-  * Airport feature
-  * Refinement `Float#to_rad`
-  * Distance calculation with `AIXM::XY#distance`
-  * `Schedule#remarks`
+#### Breaking Additions
+* Global configuration with `AIXM.config`
+
+#### Breaking Changes
+* Switch from "AIXM with OFM extensions" to OFMX
+* `to_aixm` renamed to `to_xml` again
+* Removed signature `to_xml(extension)` in favor of `AIXM.schema`
+* Removed `Array#to_digest`
+* Removed `Document#complete?`
+* Renamed Schedule to Timetable
+* Timetable and remarks moved from Airspace to to Layer (formerly known as class layer)
+
+#### Additions
+* Organization and Unit features
+* Airport feature
+* Refinement `Float#to_rad`
+* Distance calculation with `AIXM::XY#distance`
+* `Schedule#remarks`
 
 ## 0.2.3
 
-* Breaking changes:
-  * VOR types renamed from :vor to :conventional and :doppler_vor to :doppler
-  * NBR types added
-  * Marker types added
-* Changes:
-  * "mid" attributes on all navigational aid features
+#### Breaking Changes
+* VOR types renamed from `:vor` to `:conventional` and `:doppler_vor` to `:doppler`
+* NBR types added
+* Marker types added
+
+#### Changes
+* `mid` attributes on all navigational aid features
 
 ## 0.2.2
 
-* Changes:
-  * Bad error classes fixed
-  * Allow navigational aids without name
+#### Changes
+* Bad error classes fixed
+* Allow navigational aids without name
 
 ## 0.2.1
 
-* Breaking changes:
-  * DVOR and VORDME confusion fixed
-  * VOR can be associated with DME (-> VOR/DME) or TACAN (-> VORTAC) now
-  * `to_xml` renamed to `to_aixm` everywhere
-  * Removed :other from all value lists
-* Changes:
-  * Schedule added to navigational aids
+#### Breaking Changes
+* DVOR and VORDME confusion fixed
+* VOR can be associated with DME (-> VOR/DME) or TACAN (-> VORTAC) now
+* `to_xml` renamed to `to_aixm` everywhere
+* Removed `:other` from all value lists
+
+#### Changes
+* Schedule added to navigational aids
 
 ## 0.2.0
 
-* Breaking changes:
-  * Symbols such as :qnh, :ofm or :mhz are downcased now
-* Additions:
-  * Frequency
-  * Navigational aids features
-  * `AIXM::Z#qfe?` and friends
+#### Breaking Changes
+* Symbols such as `:qnh`, `:ofm` or `:mhz` are downcased now
+
+#### Additions
+* Frequency
+* Navigational aids features
+* `AIXM::Z#qfe?` and friends
 
 ## 0.1.4
 
-* Breaking changes:
-  * `AIXM.z(alt: 123, code: :QNE)` is now `AIXM.z(123, :QNE)`
+#### Breaking Changes
+* `AIXM.z(alt: 123, code: :QNE)` is now `AIXM.z(123, :QNE)`
 
 ## 0.1.3
 
-* Breaking changes:
-  * Re-organization of classes in features and components
-* Additions:
-  * Shortcut initializers e.g. `AIXM.airspace(...)`
+#### Breaking Changes
+* Re-organization of classes in features and components
+
+#### Additions
+* Shortcut initializers e.g. `AIXM.airspace(...)`
 
 ## 0.1.2
 
-* Breaking additions:
-  * Class layers
-* Breaking changes:
-  * Use `document.features << (feature)` instead of `document << (feature)`
+#### Breaking Additions
+* Class layers
+
+#### Breaking Changes
+* Use `document.features << (feature)` instead of `document << (feature)`
 
 ## 0.1.1
 
-* Additions:
-  * Schedule (all but `TIMSH`)
-  * Refinement `Float#to_km` and `String#uptrans`
-  * Shortcut constants `AIXM::UNLIMITED` and `AIXM::H24`
-  * `Airspace#short_name`
-* Changes:
-  * `Document#created_at` and `#effective_at` accept Time, Date, String or *nil*
-  * Separate `AIXM::Document#valid?` from `#complete?`
-  * Write coordinates in DD if extension `:OFM` is set
-  * `Array#to_digest` returns Integer which fits in signed 32bit
+#### Additions
+* Schedule (all but `TIMSH`)
+* Refinement `Float#to_km` and `String#uptrans`
+* Shortcut constants `AIXM::UNLIMITED` and `AIXM::H24`
+* `Airspace#short_name`
+
+#### Changes
+* `Document#created_at` and `#effective_at` accept Time, Date, String or *nil*
+* Separate `AIXM::Document#valid?` from `#complete?`
+* Write coordinates in DD if extension `:OFM` is set
+* `Array#to_digest` returns Integer which fits in signed 32bit
 
 ## 0.1.0
 
-* Initial implementation to import D/R/P zones to OFM:
-  * XY Coordinate
-  * Z Altitude
-  * AIXM-Snapshot 4.5 Document
-  * Airspace feature
-  * Vertical Limits
-  * Geometry
-    * Point
-    * Arc
-    * Border
-    * Circle
-  * Shortcut constant `AIXM::GROUND`
-  * Refinements
+#### Initial Implementation
+* XY Coordinate
+* Z Altitude
+* AIXM-Snapshot 4.5 Document
+* Airspace feature
+* Vertical Limits
+* Geometry
+  * Point
+  * Arc
+  * Border
+  * Circle
+* Shortcut constant `AIXM::GROUND`
+* Refinements

data/README.md

@@ -50,7 +50,6 @@ The following configuration options are available for setting and getting:
 
 ```ruby
 AIXM.config.schema           # either :aixm (default) or :ofmx
-AIXM.config.region           # fallback region
 AIXM.config.ignored_errors   # ignore XML schema errors which match this regex
 ```
 

data/lib/aixm/component/geometry.rb

@@ -8,6 +8,7 @@ module AIXM
     # has to be a point with the same coordinates as the first).
     #
     # For a geometry to be valid, it must be comprised of either:
+    # * exactly one point
     # * exactly one circle
     # * at least three points, arcs or borders (the last of which a point with
     #   identical coordinates as the first)
@@ -53,17 +54,22 @@ module AIXM
 
       # @return [Boolean] whether the geometry is closed
       def closed?
-        circle? || polygon?
+        point? || circle? || polygon?
       end
 
       # @return [String] AIXM or OFMX markup
       def to_xml
-        fail(GeometryError, "geometry is not closed") unless closed?
+        fail(GeometryError.new("geometry is not closed", self)) unless closed?
         @result_array.map { |h| h.to_xml }.join
       end
 
       private
 
+      def point?
+        @result_array.size == 1 &&
+          @result_array.first.is_a?(AIXM::Component::Geometry::Point)
+      end
+
       def circle?
         @result_array.size == 1 &&
           @result_array.first.is_a?(AIXM::Component::Geometry::Circle)

data/lib/aixm/component/layer.rb

@@ -9,8 +9,10 @@ module AIXM
     # ===Cheat Sheet in Pseudo Code:
     #   layer = AIXM.layer(
     #     class: String or nil
+    #     location_indicator: String or nil
     #     vertical_limits: AIXM.vertical_limits
     #   )
+    #   layer.activity = String or nil
     #   layer.timetable = AIXM.timetable or nil
     #   layer.selective = true or false (default)
     #   layer.remarks = String or nil
@@ -19,18 +21,86 @@ module AIXM
     class Layer
       CLASSES = (:A..:G).freeze
 
+      ACTIVITIES = {
+        ACCIDENT: :accident_investigation,
+        ACROBAT: :acrobatics,
+        AIRGUN: :aerial_gunnery,
+        AIRSHOW: :air_show,
+        ANTIHAIL: :anti_hail_rocket,
+        ARTILERY: :artillary_firing,
+        ASCENT: :probe,
+        ATS: :air_traffic_services,
+        BALLOON: :balloon,
+        BIRD: :bird_hazard,
+        'BIRD-MGR': :bird_migration,
+        BLAST: :blasting_operation,
+        DROP: :dropping,
+        DUSTING: :crop_dusting,
+        EQUIPMENT: :special_equipment_required,
+        'EQUIPMENT-833': :radio_8_33_required,
+        'EQUIPMENT-RNAV': :rnav_equipment_required,
+        'EQUIPMENT-RSVM': :rsvm_equipment_required,
+        EXERCISE: :combat_exercise,
+        FAUNA: :sensitive_fauna,
+        FIRE: :fire_suppression,
+        FIREWORK: :fireworks,
+        GAZ: :gaz_field,
+        GLIDER: :gliding,
+        HANGGLIDER: :hanggliding,
+        'HI-LIGHT': :high_intensity_light,
+        'HI-RADIO': :high_intensity_radio,
+        'IND-CHEM': :chemical_plant,
+        'IND-NUCLEAR': :nuclear_activity,
+        'IND-OIL': :oil_refinery,
+        JETCLIMB: :jet_climb,
+        LASER: :laser_light,
+        MILOPS: :military_operation,
+        MISSILES: :guided_missiles,
+        NATURE: :natural_reserve,
+        NAVAL: :ship_exercise,
+        'NO-NOISE': :noise_abatement,
+        OIL: :oil_field,
+        PARACHUTE: :parachuting,
+        PARAGLIDER: :paragliding,
+        POPULATION: :highly_populated,
+        PROCEDURE: :special_procedure,
+        REFUEL: :refuelling,
+        SHOOT: :shooting_from_ground,
+        SPACEFLT: :space_flight,
+        SPORT: :sport,
+        TECHNICAL:  :technical_activity,
+        'TFC-AD': :aerodrome_traffic,
+        'TFC-HELI': :helicopter_traffic,
+        TOWING: :winch_activity,
+        TRG: :training,
+        UAV: :drone,
+        ULM: :ultra_light_flight,
+        VIP: :vip,
+        'VIP-PRES': :president,
+        'VIP-VICE': :vice_president,
+        WATERBLAST: :underwater_explosion,
+        WORK: :aerial_work,
+        OTHER: :other
+      }.freeze
+
+      # @return [String, nil] four letter location identifier as published in the ICAO DOC 7910
+      attr_reader :location_indicator
+
       # @return [AIXM::Component::VerticalLimits] vertical limits of this layer
       attr_reader :vertical_limits
 
+      # @return [String, nil] primary activity (e.g. "GLIDER")
+      attr_reader :activity
+
       # @return [AIXM::Component::Timetable, nil] activation hours
       attr_reader :timetable
 
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      def initialize(class: nil, vertical_limits:)
+      def initialize(class: nil, location_indicator: nil, vertical_limits:)
         self.class = binding.local_variable_get(:class)
-        self.vertical_limits = vertical_limits
+        self.location_indicator, self.vertical_limits = location_indicator, vertical_limits
         self.selective = false
       end
 
@@ -50,11 +120,20 @@ module AIXM
         fail(ArgumentError, "invalid class") unless @klass.nil? || CLASSES.include?(@klass)
       end
 
+      def location_indicator=(value)
+        fail(ArgumentError, "invalid location indicator") unless value.nil? || (value.is_a?(String) && value.length == 4)
+        @location_indicator = value&.uptrans
+      end
+
       def vertical_limits=(value)
         fail(ArgumentError, "invalid vertical limits") unless value.is_a? AIXM::Component::VerticalLimits
         @vertical_limits = value
       end
 
+      def activity=(value)
+        @activity = value.nil? ? nil : ACTIVITIES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid activity")
+      end
+
       def timetable=(value)
         fail(ArgumentError, "invalid timetable") unless value.nil? || value.is_a?(AIXM::Component::Timetable)
         @timetable = value
@@ -79,6 +158,8 @@ module AIXM
       def to_xml
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.codeClass(self.class.to_s) if self.class
+        builder.codeLocInd(location_indicator) if location_indicator
+        builder.codeActivity(ACTIVITIES.key(activity).to_s) if activity
         builder << vertical_limits.to_xml
         builder << timetable.to_xml(as: :Att) if timetable
         builder.codeSelAvbl(selective? ? 'Y' : 'N') if AIXM.ofmx?

data/lib/aixm/document.rb

@@ -17,6 +17,9 @@ module AIXM
   class Document
     NAMESPACE_PATTERN = /\A[a-f\d]{8}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{12}\z/.freeze
 
+    # @return [String] OFMX region all features in this document belong to
+    attr_reader :region
+
     # @return [String] UUID to namespace the data contained in this document
     attr_reader :namespace
 
@@ -29,8 +32,8 @@ module AIXM
     # @return [Array<AIXM::Feature>] airspaces, airports and other features
     attr_accessor :features
 
-    def initialize(namespace: nil, created_at: nil, effective_at: nil)
-      self.namespace, self.created_at, self.effective_at = namespace, created_at, effective_at
+    def initialize(region: nil, namespace: nil, created_at: nil, effective_at: nil)
+      self.region, self.namespace, self.created_at, self.effective_at = region, namespace, created_at, effective_at
       @features = []
     end
 
@@ -39,6 +42,11 @@ module AIXM
       %Q(#<#{self.class} created_at=#{created_at.inspect}>)
     end
 
+    def region=(value)
+      fail(ArgumentError, "invalid region") unless value.nil? || value.is_a?(String)
+      @region = value&.upcase
+    end
+
     def namespace=(value)
       fail(ArgumentError, "invalid namespace") unless value.nil? || value.match?(NAMESPACE_PATTERN)
       @namespace = value || SecureRandom.uuid
@@ -76,6 +84,7 @@ module AIXM
         'xmlns:xsi': AIXM.schema(:namespace),
         version: AIXM.schema(:version),
         origin: "rubygem aixm-#{AIXM::VERSION}",
+        region: (region if AIXM.ofmx?),
         namespace: (namespace if AIXM.ofmx?),
         created: @created_at.xmlschema,
         effective: @effective_at.xmlschema

data/lib/aixm/errors.rb

@@ -1,11 +1,23 @@
 module AIXM
 
+  # Extension of StandardError which contains the subject of the error.
+  #
+  # @abstract
+  class Error < StandardError
+    attr_reader :subject
+
+    def initialize(message, subject=nil)
+      @subject = subject
+      super message
+    end
+  end
+
   # @see AIXM::Component::Geometry
   # @see AIXM::Feature::Airspace#to_xml
-  class GeometryError < StandardError; end
+  class GeometryError < Error; end
 
   # @see AIXM::Component::Layer
   # @see AIXM::Feature::Airspace#to_xml
-  class LayerError < StandardError; end
+  class LayerError < Error; end
 
 end