aixm 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bad5f1c431575562810faf541c197660e815e3652213dc8d6fedc8cde897f9d4
-  data.tar.gz: f1a750f511dc13146af92a25aea066a89a67d358534f2f4a582e415919855ef4
+  metadata.gz: ca15626c3948c7f7914face0ccef421502a3b9103bba33bb9f8197696f083a2c
+  data.tar.gz: 8cd271b55758819f0593be1150d4a88484717a0221467c532f852aa011b270a9
 SHA512:
-  metadata.gz: f587e9d97f7a1fdb21e38f79c2be3567a9a8a8a4c0bc692b74c19305db8b0c2c8fb734d0b90b7ba488916ca9bc23a2a60ba4e836510be6984d1bd95055ffbe28
-  data.tar.gz: ac70ee0a8c63f20f0fb0277ba075c0880ed2ad39ae32e6c5e38d9fa76d80943a7c8efb394bb33af52f5c6ce00081d066e59d9df9a1105812bfaf8bafc2a23596
+  metadata.gz: edee618c607d2e67ac4705a26ff4401f6479958ba84313f9fffc0ca8a3003f3110e8ddfe6a877333c2f29395eaa85cfdf3245c57bd4f3867d8bf48d26f1dc112
+  data.tar.gz: 60fe778dcbf871980ce4b477819be4e1d8a8b4e055365c00837dab226646b714b40f42edd40906acc9726f0f9cd29b4144a1a7506538349ef7e8bb5743146509

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+        - 2.6.x
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build and test
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        SPEC_SCOPE=all bundle exec rake

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.4
+ruby-2.6.5

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.3.8
+
+#### Additions
+* `AIXM.config.mid_region` to generate `mid` attributes on all features
+* Refinement `String#insert_payload_hash`
+
+#### Changes
+* Fix calculation of magnetic bearing
+
 ## 0.3.7
 
 #### Additions
@@ -37,14 +46,17 @@
 * `Runway#preparation`, `Runway#condition` and `Runway#vfr_pattern`
 * `Service#guessed_unit_type`
 * Surface for `Runway|Helipad#surface`
-* Extracted `AIXM::MIN`, `AIXM::SEC` and `AIXM::DMS_RE` to scan for coordinates in texts
+* Extracted `AIXM::MIN`, `AIXM::SEC` and `AIXM::DMS_RE` to scan for coordinates
+  in texts
 * Refinement `String#payload_hash`
 
 #### Breaking Changes
 * Require Ruby 2.6
-* Renamed `AIXM::H` to `AIXM::A` (angle) and add simple arithmetics to make it more versatile
+* Renamed `AIXM::H` to `AIXM::A` (angle) and add simple arithmetics to make it
+  more versatile
 * `Runway|Helipad#composition` moved to `Runway|Helipad#surface`
-* DMS notation `{-}{DD}DMMSS{.SS}[NESW]` now requires compulsory cardinal direction (N, E, S or W) at the end
+* DMS notation `{-}{DD}DMMSS{.SS}[NESW]` now requires compulsory cardinal
+  direction (N, E, S or W) at the end
 
 #### Changes
 * Service is a feature now
@@ -56,7 +68,8 @@
 
 #### Changes
 * Updated OFMX schema URI
-* Added `eql?` and `hash` to `AIXM::XY|Z|D|H|F` to allow for instances of these classes to be used as Hash keys.
+* Added `eql?` and `hash` to `AIXM::XY|Z|D|H|F` to allow for instances of these
+  classes to be used as Hash keys.
 
 ## 0.3.2
 

data/README.md

@@ -1,5 +1,5 @@
 [![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)
+[![Tests](https://github.com/svoop/aixm/workflows/Test/badge.svg)](https://github.com/svoop/aixm/actions?workflow=Test)
 [![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)
 
@@ -15,7 +15,7 @@ For now, only the parts needed to automize the AIP import of [open flightmaps](h
 
 ## Install
 
-Add this to your `Gemfile`:
+Add this to your <tt>Gemfile</tt> or <tt>gems.rb</tt>:
 
 ```ruby
 gem aixm
@@ -47,11 +47,12 @@ See `AIXM::CLASSES` for the complete list of shorthand names.
 
 ## Configuration
 
-The following configuration options are available for setting and getting:
+### AIXM.config.schema
+
+The schema is either `:aixm` (default) or `:ofmx`:
 
 ```ruby
-AIXM.config.schema           # either :aixm (default) or :ofmx
-AIXM.config.ignored_errors   # ignore XML schema errors which match this regex
+AIXM.config.schema = :ofmx   # =>:ofmx
 ```
 
 There are shortcuts to set and get the schema:
@@ -65,6 +66,23 @@ AIXM.schema             # => :ofmx
 AIXM.schema(:version)   # => 0
 ```
 
+### AIXM.config.mid_region
+
+In order to insert [OFMX-compliant `mid` attributes]() for all `*Uid` elements, set this configuration option to the OFMX region the element belongs to. By default, no `mid` attributes are inserted.
+
+```ruby
+AIXM.config.mid_region          # => nil  - don't insert any mid attributes
+AIXM.config.mid_region = 'LF'   # => 'LF' - insert mid attributes for region LF
+```
+
+### AIXM.config.ignored_errors
+
+In case you want to ignore certain XML schema validation errors, set this configuration option to a regular expression which matches the error messages to ignore. By default, no errors are ignored.
+
+```ruby
+AIXM.config.ignored_errors = /invalid date/i
+```
+
 ## Validation
 
 `AIXM::Document#valid?` validates the resulting AIXM or OFMX against its XML schema. If any, you find the errors in `AIXM::Document#errors`.

data/lib/aixm/component/fato.rb

@@ -131,7 +131,7 @@ module AIXM
         builder.FtoUid do |fto_uid|
           fto_uid << airport.to_uid.indent(2)
           fto_uid.txtDesig(name)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup
@@ -222,7 +222,7 @@ module AIXM
         # @return [AIXM::A] magnetic orientation (magnetic bearing) in degrees
         def magnetic_orientation
           if geographic_orientation && fato.airport.declination
-            geographic_orientation + fato.airport.declination
+            geographic_orientation - fato.airport.declination
           end
         end
 
@@ -232,7 +232,7 @@ module AIXM
           builder.FdnUid do |fdn_uid|
             fdn_uid << fato.to_uid.indent(2)
             fdn_uid.txtDesig(name)
-          end
+          end.insert_payload_hash(region: AIXM.config.mid_region)
         end
 
         # @return [String] AIXM or OFMX markup

data/lib/aixm/component/frequency.rb

@@ -108,7 +108,7 @@ module AIXM
         builder.FqyUid do |fqy_uid|
           fqy_uid << service.to_uid.indent(2)
           fqy_uid.valFreqTrans(transmission_f.freq)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup

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

@@ -33,13 +33,19 @@ module AIXM
           @name = value
         end
 
+        # @return [String] UID markup
+        def to_uid(as: :GbrUid)
+          builder = Builder::XmlMarkup.new(indent: 2)
+          builder.tag!(as) do |tag|
+            tag.txtName(name.to_s)
+          end.insert_payload_hash(region: AIXM.config.mid_region)
+        end
+
         # @return [String] AIXM or OFMX markup
         def to_xml
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Avx do |avx|
-            avx.GbrUid do |gbr_uid|
-              gbr_uid.txtName(name.to_s)
-            end
+            avx << to_uid.indent(2)
             avx.codeType('FNT')
             avx.geoLat(xy.lat(AIXM.schema))
             avx.geoLong(xy.long(AIXM.schema))

data/lib/aixm/component/helipad.rb

@@ -164,7 +164,7 @@ module AIXM
         builder.TlaUid do |tla_uid|
           tla_uid << airport.to_uid.indent(2)
           tla_uid.txtDesig(name)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup

data/lib/aixm/component/lighting.rb

@@ -113,7 +113,7 @@ module AIXM
         builder.tag!(as) do |tag|
           tag << lightable.to_uid.indent(2)
           tag.codePsn(POSITIONS.key(position).to_s)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup

data/lib/aixm/component/runway.rb

@@ -138,7 +138,7 @@ module AIXM
         builder.RwyUid do |rwy_uid|
           rwy_uid << airport.to_uid.indent(2)
           rwy_uid.txtDesig(name)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup
@@ -277,7 +277,7 @@ module AIXM
         # @return [AIXM::A] magnetic orientation (magnetic bearing) in degrees
         def magnetic_orientation
           if geographic_orientation && runway.airport.declination
-            geographic_orientation + runway.airport.declination
+            geographic_orientation - runway.airport.declination
           end
         end
 
@@ -287,7 +287,7 @@ module AIXM
           builder.RdnUid do |rdn_uid|
             rdn_uid << runway.to_uid.indent(2)
             rdn_uid.txtDesig(name)
-          end
+          end.insert_payload_hash(region: AIXM.config.mid_region)
         end
 
         # @return [String] AIXM or OFMX markup
@@ -309,10 +309,7 @@ module AIXM
           if displaced_threshold
             builder.Rdd do |rdd|
               rdd.RddUid do |rdd_uid|
-                rdd_uid.RdnUid do |rdn_uid|
-                  rdn_uid << runway.to_uid.indent(6)
-                  rdn_uid.txtDesig(name)
-                end
+                rdd_uid << to_uid.indent(4)
                 rdd_uid.codeType('DPLM')
                 rdd_uid.codeDayPeriod('A')
               end

data/lib/aixm/config.rb

@@ -77,7 +77,8 @@ module AIXM
     # @return [OpenStruct]
     def initialize_config
       @@config = OpenStruct.new(
-        schema: :aixm
+        schema: :aixm,
+        mid: false
       )
     end
 

data/lib/aixm/document.rb

@@ -7,6 +7,7 @@ module AIXM
   #
   # ===Cheat Sheet in Pseudo Code:
   #   document = AIXM.document(
+  #     region: String
   #     namespace: String (UUID)
   #     created_at: Time or Date or String
   #     effective_at: Time or Date or String

data/lib/aixm/feature/address.rb

@@ -81,7 +81,7 @@ module AIXM
           tag << addressable.to_uid.indent(2) if addressable
           tag.codeType(TYPES.key(type).to_s.then_if(AIXM.aixm?) { |t| t.sub(/-\w+$/, '') })
           tag.noSeq(sequence)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup

data/lib/aixm/feature/airport.rb

@@ -74,6 +74,9 @@ module AIXM
       # declination represents the magnetic north is to the right (aka: east)
       # by this angle.
       #
+      # To convert a magnetic bearing to the corresponding geographic (aka:
+      # true) bearing, the declination has to be added.
+      #
       # @see https://en.wikipedia.org/wiki/Magnetic_declination
       # @return [Float, nil] magnetic declination in degrees
       attr_reader :declination
@@ -280,7 +283,15 @@ module AIXM
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.tag!(as) do |tag|
           tag.codeId(id)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
+      end
+
+      # @return [String] UID markup
+      def to_wrapped_uid(as: :AhpUid, with:)
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.tag!(with) do |tag|
+          tag << to_uid(as: as).indent(2)
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup
@@ -322,9 +333,7 @@ module AIXM
         end
         if usage_limitations.any?
           builder.Ahu do |ahu|
-            ahu.AhuUid do |ahu_uid|
-              ahu_uid << to_uid.indent(4)
-            end
+            ahu << to_wrapped_uid(with: :AhuUid).indent(2)
             usage_limitations.each do |usage_limitation|
               ahu << usage_limitation.to_xml.indent(2)
             end

data/lib/aixm/feature/airspace.rb

@@ -136,7 +136,15 @@ module AIXM
         builder.tag!(as) do |tag|
           tag.codeType(TYPES.key(type).to_s)
           tag.codeId(id)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
+      end
+
+      # @return [String] UID markup
+      def to_wrapped_uid(as: :AseUid, with:)
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.tag!(with) do |tag|
+          tag << to_uid(as: as).indent(2)
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @raise [AIXM::GeometryError] if the geometry is not closed
@@ -155,9 +163,7 @@ module AIXM
           end
         end
         builder.Abd do |abd|
-          abd.AbdUid do |abd_uid|
-            abd_uid << to_uid.indent(4)
-          end
+          abd << to_wrapped_uid(with: :AbdUid).indent(2)
           abd << geometry.to_xml.indent(2)
         end
         if layered?
@@ -169,9 +175,7 @@ module AIXM
               ase << layers[index].to_xml.indent(2)
             end
             builder.Adg do |adg|
-              adg.AdgUid do |adg_uid|
-                adg_uid << layer_airspace.to_uid.indent(4)
-              end
+              adg << layer_airspace.to_wrapped_uid(with: :AdgUid).indent(2)
               adg << to_uid(as: :AseUidSameExtent).indent(2)
             end
           end
@@ -184,7 +188,6 @@ module AIXM
       def layered?
         layers.count > 1
       end
-
     end
   end
 end

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

@@ -63,7 +63,7 @@ module AIXM
             dpn_uid.codeId(id)
             dpn_uid.geoLat(xy.lat(AIXM.schema))
             dpn_uid.geoLong(xy.long(AIXM.schema))
-          end
+          end.insert_payload_hash(region: AIXM.config.mid_region)
         end
 
         # @return [String] AIXM or OFMX markup

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

@@ -73,7 +73,7 @@ module AIXM
             dme_uid.codeId(id)
             dme_uid.geoLat(xy.lat(AIXM.schema))
             dme_uid.geoLong(xy.long(AIXM.schema))
-          end
+          end.insert_payload_hash(region: AIXM.config.mid_region)
         end
 
         # @return [String] AIXM or OFMX markup

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

@@ -57,7 +57,7 @@ module AIXM
             mkr_uid.codeId(id)
             mkr_uid.geoLat(xy.lat(AIXM.schema))
             mkr_uid.geoLong(xy.long(AIXM.schema))
-          end
+          end.insert_payload_hash(region: AIXM.config.mid_region)
         end
 
         # @return [String] AIXM or OFMX markup

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

@@ -59,7 +59,7 @@ module AIXM
             ndb_uid.codeId(id)
             ndb_uid.geoLat(xy.lat(AIXM.schema))
             ndb_uid.geoLong(xy.long(AIXM.schema))
-          end
+          end.insert_payload_hash(region: AIXM.config.mid_region)
         end
 
         # @return [String] AIXM or OFMX markup

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

@@ -32,7 +32,7 @@ module AIXM
             tcn_uid.codeId(id)
             tcn_uid.geoLat(xy.lat(AIXM.schema))
             tcn_uid.geoLong(xy.long(AIXM.schema))
-          end
+          end.insert_payload_hash(region: AIXM.config.mid_region)
         end
 
         # @return [String] AIXM or OFMX markup

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

@@ -96,7 +96,7 @@ module AIXM
             vor_uid.codeId(id)
             vor_uid.geoLat(xy.lat(AIXM.schema))
             vor_uid.geoLong(xy.long(AIXM.schema))
-          end
+          end.insert_payload_hash(region: AIXM.config.mid_region)
         end
 
         # @return [String] AIXM or OFMX markup

data/lib/aixm/feature/obstacle.rb

@@ -237,7 +237,7 @@ module AIXM
           tag << obstacle_group.to_uid.indent(2) if AIXM.ofmx?
           tag.geoLat((xy.lat(AIXM.schema)))
           tag.geoLong((xy.long(AIXM.schema)))
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup