aixm 0.3.7 → 0.3.8

data/lib/aixm/feature/obstacle_group.rb

@@ -114,7 +114,7 @@ module AIXM
           ogr_uid.txtName(name)
           ogr_uid.geoLat(obstacles.first.xy.lat(AIXM.schema))
           ogr_uid.geoLong(obstacles.first.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/organisation.rb

@@ -76,7 +76,7 @@ module AIXM
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.OrgUid do |org_uid|
           org_uid.txtName(name)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup

data/lib/aixm/feature/service.rb

@@ -197,7 +197,7 @@ module AIXM
           ser_uid << unit.to_uid.indent(2)
           ser_uid.codeType(TYPES.key(type).to_s)
           ser_uid.noSeq(@sequence)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup

data/lib/aixm/feature/unit.rb

@@ -160,7 +160,7 @@ module AIXM
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.UniUid do |uni_uid|
           uni_uid.txtName(name)
-        end
+        end.insert_payload_hash(region: AIXM.config.mid_region)
       end
 
       # @return [String] AIXM or OFMX markup

data/lib/aixm/refinements.rb

@@ -180,11 +180,11 @@ module AIXM
     end
 
     # @!method payload_hash(region:, element:)
-    #   Calculate the UUIDv3 hash of an OFMX XML string.
+    #   Calculate the UUIDv3 hash of an AIXM/OFMX XML string.
     #
     #   A word of warning: This is a minimalistic implementation for the AIXM
     #   gem and won't work unless the following conditions are met:
-    #   * the XML string must be OFMX
+    #   * the XML string must be AIXM/OFMX
     #   * the XML string must be valid
     #   * the XML string must be pretty-printed
     #
@@ -194,14 +194,21 @@ module AIXM
     #
     #   @note This is a refinement for +String+
     #   @param region [String] OFMX region (e.g. "LF")
-    #   @param element [String] tag to calculate the payload hash for
-    #   @return [String] UUID version 3
+    #   @param element [String] tag to calculate the payload hash for (default:
+    #     first element in the string)
+    #   @return [String] UUIDv3
+    #   @raise [ArgumentError] if the given element is not found or no element
+    #     at all
     refine String do
-      def payload_hash(region:, element:)
-        gsub(%r(mid="[^"]*"), '').   # remove existing mid attributes
+      def payload_hash(region:, element: nil)
+        element = $1 if element.nil? && match(/<([^?].*?)[\s>]/)
+        fail(ArgumentError, "no element found") unless element
+        fail(ArgumentError, "element `#{element}' not found") unless match? /<#{element}[\s>]/
+        gsub(%r((?:mid|source)="[^"]*"), '').   # remove existing mid and source attributes
           sub(%r(\A.*?(?=<#{element}))m, '').   # remove everything before first <element>
-          sub(%r(</#{element}>.*\z)m, '').   # remove everything after first </element>
-          scan(%r(<([\w-]+)([^>]*)>([^<]*))).each_with_object([region]) do |(e, a, t), m|
+          sub(%r(</#{element}>.*\z)m, '').   # remove everything after and including first </element>
+          sub(%r(\A(<\w+Uid)\w+), '\1').   # remove Uid name extension
+          scan(%r(<([\w-]+)([^>]*)>([^<]*))).each_with_object([region.upcase]) do |(e, a, t), m|
             m << e << a.scan(%r(([\w-]+)="([^"]*)")).sort.flatten << t
           end.
           flatten.
@@ -211,6 +218,30 @@ module AIXM
       end
     end
 
+    # @!method insert_payload_hash(region:, element:)
+    #   Calculate the UUIDv3 hash of an AIXM/OFMX XML string and insert it into
+    #   the AIXM/OFMX XML string as an mid attribute.
+    #
+    #   If the region is explicitly set to +nil+ or false, the AIXM/OFMX string
+    #   is returned unchanged.
+    #
+    #   @note This is a refinement for +String+
+    #   @see String#payload_hash
+    #   @param region [String] OFMX region (e.g. "LF")
+    #   @param element [String] tag to calculate the payload hash for (default:
+    #     first element in the string)
+    #   @return [String] AIXM/OFMX XML with UUIDv3 inserted as mid attribute
+    #   @raise [ArgumentError] if the given element is not found or no element
+    #     at all
+    refine String do
+      def insert_payload_hash(region:, element: nil)
+        return self unless region
+        element = $1 if element.nil? && match(/<([^?].*?)[\s>]/)
+        hash = payload_hash(region: region, element: element)
+        sub(/(<#{element})([^>]*?)(\s+mid=".*?")?/, %Q(\\1 mid="#{hash}"\\2))
+      end
+    end
+
     # @!method to_dd
     #   Convert DMS angle to DD or +nil+ if the notation is not recognized.
     #

data/lib/aixm/version.rb

@@ -1,3 +1,3 @@
 module AIXM
-  VERSION = "0.3.7".freeze
+  VERSION = "0.3.8".freeze
 end

data/rakefile.rb

@@ -9,14 +9,28 @@ Rake::TestTask.new do |t|
   t.warning = true
 end
 
-desc "Run local YARD documentation server"
-task :yard do
-  `rm -rf ./.yardoc`
-  Thread.new do
-    sleep 2
-    `open http://localhost:8808`
+namespace :schema do
+  desc "Update OFMX schema"
+  task :update do
+    `rm -rf schemas/ofmx/0/*`
+    `wget http://schema.openflightmaps.org/0/OFMX-CSV-Obstacle.json -P schemas/ofmx/0/ -q --show-progress`
+ 	  `wget http://schema.openflightmaps.org/0/OFMX-CSV.json -P schemas/ofmx/0/ -q --show-progress`
+ 	  `wget http://schema.openflightmaps.org/0/OFMX-DataTypes.xsd -P schemas/ofmx/0/ -q --show-progress`
+ 	  `wget http://schema.openflightmaps.org/0/OFMX-Features.xsd -P schemas/ofmx/0/ -q --show-progress`
+ 	  `wget http://schema.openflightmaps.org/0/OFMX-Snapshot.xsd -P schemas/ofmx/0/ -q --show-progress`
   end
-  `yard server -r`
-end  
+end
+
+namespace :yard do
+  desc "Run local YARD documentation server"
+  task :server do
+    `rm -rf ./.yardoc`
+    Thread.new do
+      sleep 2
+      `open http://localhost:8808`
+    end
+    `yard server -r`
+  end
+end
 
 task default: :test

data/spec/lib/aixm/a_spec.rb

@@ -11,22 +11,22 @@ describe AIXM::A do
 
   describe :initialize do
     it "fails on invalid values" do
-      -> { AIXM.a('foobar') }.must_raise ArgumentError
+      _{ AIXM.a('foobar') }.must_raise ArgumentError
     end
 
     it "parses String as angle with precision=2" do
       AIXM.a('34L').tap do |h|
-        h.deg.must_equal 340
-        h.precision.must_equal 2
-        h.suffix.must_equal :L
+        _(h.deg).must_equal 340
+        _(h.precision).must_equal 2
+        _(h.suffix).must_equal :L
       end
     end
 
     it "parses Numeric as angle with precision=3" do
       AIXM.a(12).tap do |h|
-        h.deg.must_equal 12
-        h.precision.must_equal 3
-        h.suffix.must_be :nil?
+        _(h.deg).must_equal 12
+        _(h.precision).must_equal 3
+        _(h.suffix).must_be :nil?
       end
     end
   end
@@ -34,43 +34,43 @@ describe AIXM::A do
   describe :to_s do
     context "precision=2" do
       it "rounds and zero-pad deg to length 2 and concats suffix" do
-        AIXM.a('05').to_s.must_equal '05'
-        AIXM.a('05').tap { |a| a.suffix = :L }.to_s.must_equal '05L'
-        AIXM.a('05').tap { |a| a.deg = 0 }.to_s.must_equal '36'
+        _(AIXM.a('05').to_s).must_equal '05'
+        _(AIXM.a('05').tap { |a| a.suffix = :L }.to_s).must_equal '05L'
+        _(AIXM.a('05').tap { |a| a.deg = 0 }.to_s).must_equal '36'
       end
     end
 
     context "precition=3" do
       it "rounds and zero-pad deg to length 3" do
-        AIXM.a(5).to_s.must_equal '005'
-        AIXM.a(5).tap { |a| a.deg = 0 }.to_s.must_equal '000'
+        _(AIXM.a(5).to_s).must_equal '005'
+        _(AIXM.a(5).tap { |a| a.deg = 0 }.to_s).must_equal '000'
       end
     end
   end
 
   describe :deg= do
     it "fails on invalid values" do
-      [:foobar, '1', -1, 361].wont_be_written_to subject_2, :deg
-      [:foobar, '1', -1, 361].wont_be_written_to subject_3, :deg
+      _([:foobar, '1', -1, 361]).wont_be_written_to subject_2, :deg
+      _([:foobar, '1', -1, 361]).wont_be_written_to subject_3, :deg
     end
 
     context "precision=2" do
       it "rounds to 10 degree steps" do
-        subject_2.tap { |s| s.deg = 0 }.deg.must_equal 0
-        subject_2.tap { |s| s.deg = 5 }.deg.must_equal 10
-        subject_2.tap { |s| s.deg = 154 }.deg.must_equal 150
-        subject_2.tap { |s| s.deg = 359 }.deg.must_equal 0
-        subject_2.tap { |s| s.deg = 360 }.deg.must_equal 0
+        _(subject_2.tap { |s| s.deg = 0 }.deg).must_equal 0
+        _(subject_2.tap { |s| s.deg = 5 }.deg).must_equal 10
+        _(subject_2.tap { |s| s.deg = 154 }.deg).must_equal 150
+        _(subject_2.tap { |s| s.deg = 359 }.deg).must_equal 0
+        _(subject_2.tap { |s| s.deg = 360 }.deg).must_equal 0
       end
     end
 
     context "precision=3" do
       it "accepts 1 degree steps" do
-        subject_3.tap { |s| s.deg = 0 }.deg.must_equal 0
-        subject_3.tap { |s| s.deg = 5 }.deg.must_equal 5
-        subject_3.tap { |s| s.deg = 154 }.deg.must_equal 154
-        subject_3.tap { |s| s.deg = 359 }.deg.must_equal 359
-        subject_3.tap { |s| s.deg = 360 }.deg.must_equal 0
+        _(subject_3.tap { |s| s.deg = 0 }.deg).must_equal 0
+        _(subject_3.tap { |s| s.deg = 5 }.deg).must_equal 5
+        _(subject_3.tap { |s| s.deg = 154 }.deg).must_equal 154
+        _(subject_3.tap { |s| s.deg = 359 }.deg).must_equal 359
+        _(subject_3.tap { |s| s.deg = 360 }.deg).must_equal 0
       end
     end
   end
@@ -78,21 +78,21 @@ describe AIXM::A do
   describe :suffix= do
     context "precision=2" do
       it "fails on invalid values" do
-        [123, 'r'].wont_be_written_to subject_2, :suffix
+        _([123, 'r']).wont_be_written_to subject_2, :suffix
       end
 
       it "accepts nil value" do
-        [nil].must_be_written_to subject_2, :suffix
+        _([nil]).must_be_written_to subject_2, :suffix
       end
 
       it "symbolizes valid values" do
-        subject_2.tap { |s| s.suffix = 'Z' }.suffix.must_equal :Z
+        _(subject_2.tap { |s| s.suffix = 'Z' }.suffix).must_equal :Z
       end
     end
 
     context "precision=3" do
       it "always fails" do
-        -> { subject_3.tap { |s| s.suffix = 'Z' } }.must_raise RuntimeError
+        _{ subject_3.tap { |s| s.suffix = 'Z' } }.must_raise RuntimeError
       end
     end
   end
@@ -100,47 +100,47 @@ describe AIXM::A do
   describe :invert do
     it "must calculate inverse deg correctly" do
       { 0 => 180, 90 => 270, 179 => 359, 180 => 0, 270 => 90, 359 => 179, 360 => 180 }.each do |from, to|
-        AIXM.a(from).invert.deg.must_equal to
+        _(AIXM.a(from).invert.deg).must_equal to
       end
     end
 
     it "must invert left/right suffix" do
-      AIXM.a('34L').invert.suffix.must_equal :R
+      _(AIXM.a('34L').invert.suffix).must_equal :R
     end
 
     it "must leave other suffixes untouched" do
-      AIXM.a('35X').invert.suffix.must_equal :X
+      _(AIXM.a('35X').invert.suffix).must_equal :X
     end
   end
 
   describe :inverse_of? do
     it "must return true for inverse pairs" do
-      AIXM.a('34L').inverse_of?(AIXM.a('16R')).must_equal true
+      _(AIXM.a('34L').inverse_of?(AIXM.a('16R'))).must_equal true
     end
 
     it "must return false for non-inverse pairs" do
-      AIXM.a('34L').inverse_of?(AIXM.a('12L')).must_equal false
+      _(AIXM.a('34L').inverse_of?(AIXM.a('12L'))).must_equal false
     end
   end
 
   describe :+ do
     context "precision=2" do
       it "adds degrees as Integer" do
-        (subject_2 + 14).must_equal AIXM.a('01')
-        (subject_2 + 16).must_equal AIXM.a('02')
-        (subject_2 + 370).must_equal AIXM.a('01')
-        (AIXM.a('05L') + 20).must_equal AIXM.a('07L')
+        _((subject_2 + 14)).must_equal AIXM.a('01')
+        _((subject_2 + 16)).must_equal AIXM.a('02')
+        _((subject_2 + 370)).must_equal AIXM.a('01')
+        _((AIXM.a('05L') + 20)).must_equal AIXM.a('07L')
       end
 
       it "adds another angle" do
-        (AIXM.a('10') + AIXM.a('08')).must_equal AIXM.a('18')
+        _((AIXM.a('10') + AIXM.a('08'))).must_equal AIXM.a('18')
       end
     end
 
     context "precision=3" do
       it "adds degrees as Integer" do
-        (subject_3 + 15).must_equal AIXM.a(15)
-        (subject_3 + 370).must_equal AIXM.a(10)
+        _((subject_3 + 15)).must_equal AIXM.a(15)
+        _((subject_3 + 370)).must_equal AIXM.a(10)
       end
     end
   end
@@ -148,56 +148,56 @@ describe AIXM::A do
   describe :- do
     context "precision=2" do
       it "subtracts degrees as Integer" do
-        (subject_2 - 14).must_equal AIXM.a('35')
-        (subject_2 - 16).must_equal AIXM.a('34')
-        (AIXM.a('05') - 20).must_equal AIXM.a('03')
-        (AIXM.a('05L') - 20).must_equal AIXM.a('03L')
+        _((subject_2 - 14)).must_equal AIXM.a('35')
+        _((subject_2 - 16)).must_equal AIXM.a('34')
+        _((AIXM.a('05') - 20)).must_equal AIXM.a('03')
+        _((AIXM.a('05L') - 20)).must_equal AIXM.a('03L')
       end
 
       it "subtracts another angle" do
-        (AIXM.a('10') - AIXM.a('08')).must_equal AIXM.a('02')
+        _((AIXM.a('10') - AIXM.a('08'))).must_equal AIXM.a('02')
       end
     end
 
     context "precision=3" do
       it "subtracts degrees as Integer" do
-        (subject_3 - 15).must_equal AIXM.a(345)
-        (AIXM.a(55) - 20).must_equal AIXM.a(35)
+        _((subject_3 - 15)).must_equal AIXM.a(345)
+        _((AIXM.a(55) - 20)).must_equal AIXM.a(35)
       end
     end
   end
 
   describe :== do
     it "recognizes angles with identical deg and suffix as equal" do
-      AIXM.a('34L').must_equal AIXM.a('34L')
+      _(AIXM.a('34L')).must_equal AIXM.a('34L')
     end
 
     it "recognizes angles with different deg or suffix as unequal" do
-      AIXM.a('34L').wont_equal AIXM.a('35L')
-      AIXM.a('34L').wont_equal AIXM.a('34R')
+      _(AIXM.a('34L')).wont_equal AIXM.a('35L')
+      _(AIXM.a('34L')).wont_equal AIXM.a('34R')
     end
 
     it "recognizes angles with different precision as unequal" do
-      AIXM.a('34').wont_equal AIXM.a(340)
+      _(AIXM.a('34')).wont_equal AIXM.a(340)
     end
 
     it "recognizes objects of different class as unequal" do
-      subject_2.wont_equal :oggy
+      _(subject_2).wont_equal :oggy
     end
   end
 
   describe :hash do
     it "returns an integer" do
-      subject_2.hash.must_be_instance_of Integer
+      _(subject_2.hash).must_be_instance_of Integer
     end
 
     it "returns different hashes for different precisions" do
-      subject_2.hash.wont_equal subject_3.hash
+      _(subject_2.hash).wont_equal subject_3.hash
     end
 
     it "allows for the use of instances as hash keys" do
       dupe = subject_2.dup
-      { subject_2 => true }[dupe].must_equal true
+      _({ subject_2 => true }[dupe]).must_equal true
     end
   end
 end

data/spec/lib/aixm/component/fato_spec.rb

@@ -7,31 +7,31 @@ describe AIXM::Component::FATO do
 
   describe :name= do
     it "fails on invalid values" do
-      [nil, :foobar, 123].wont_be_written_to subject, :name
+      _([nil, :foobar, 123]).wont_be_written_to subject, :name
     end
 
     it "upcases and transcodes valid values" do
-      subject.tap { |s| s.name = 'h1' }.name.must_equal 'H1'
+      _(subject.tap { |s| s.name = 'h1' }.name).must_equal 'H1'
     end
   end
 
   describe :length= do
     it "fails on invalid values" do
-      [:foobar, 0, 1, AIXM.d(0, :m)].wont_be_written_to subject, :length
+      _([:foobar, 0, 1, AIXM.d(0, :m)]).wont_be_written_to subject, :length
     end
 
     it "accepts nil value" do
-      [nil].must_be_written_to subject, :length
+      _([nil]).must_be_written_to subject, :length
     end
   end
 
   describe :width= do
     it "fails on invalid values" do
-      [:foobar, 0, 1, AIXM.d(0, :m)].wont_be_written_to subject, :width
+      _([:foobar, 0, 1, AIXM.d(0, :m)]).wont_be_written_to subject, :width
     end
 
     it "accepts nil value" do
-      [nil].must_be_written_to subject, :width
+      _([nil]).must_be_written_to subject, :width
     end
   end
 
@@ -41,27 +41,27 @@ describe AIXM::Component::FATO do
 
   describe :profile= do
     it "accepts nil value" do
-      [nil].must_be_written_to subject, :profile
+      _([nil]).must_be_written_to subject, :profile
     end
 
     it "stringifies valid values" do
-      subject.tap { |s| s.profile = 'foobar' }.profile.must_equal 'foobar'
-      subject.tap { |s| s.profile = 123 }.profile.must_equal '123'
+      _(subject.tap { |s| s.profile = 'foobar' }.profile).must_equal 'foobar'
+      _(subject.tap { |s| s.profile = 123 }.profile).must_equal '123'
     end
   end
 
   describe :status= do
     it "fails on invalid values" do
-      [:foobar, 123].wont_be_written_to subject, :status
+      _([:foobar, 123]).wont_be_written_to subject, :status
     end
 
     it "accepts nil value" do
-      [nil].must_be_written_to subject, :status
+      _([nil]).must_be_written_to subject, :status
     end
 
     it "looks up valid values" do
-      subject.tap { |s| s.status = :closed }.status.must_equal :closed
-      subject.tap { |s| s.status = :SPOWER }.status.must_equal :secondary_power
+      _(subject.tap { |s| s.status = :closed }.status).must_equal :closed
+      _(subject.tap { |s| s.status = :SPOWER }.status).must_equal :secondary_power
     end
   end
 
@@ -72,7 +72,7 @@ describe AIXM::Component::FATO do
   describe :xml= do
     it "builds correct complete OFMX" do
       AIXM.ofmx!
-      subject.to_xml.must_equal <<~END
+      _(subject.to_xml).must_equal <<~END
         <Fto>
           <FtoUid>
             <AhpUid>
@@ -114,7 +114,7 @@ describe AIXM::Component::FATO do
             <txtDesig>35</txtDesig>
           </FdnUid>
           <valTrueBrg>355</valTrueBrg>
-          <valMagBrg>356</valMagBrg>
+          <valMagBrg>354</valMagBrg>
           <txtRmk>Avoid flight over residental area</txtRmk>
         </Fdn>
         <Fls>
@@ -143,7 +143,7 @@ describe AIXM::Component::FATO do
       %i(length width profile marking status remarks).each { |a| subject.send(:"#{a}=", nil) }
       %i(composition preparation condition pcn siwl_weight siwl_tire_pressure auw_weight remarks).each { |a| subject.surface.send(:"#{a}=", nil) }
       subject.directions['35'].instance_eval { @lightings.clear }
-      subject.to_xml.must_equal <<~END
+      _(subject.to_xml).must_equal <<~END
         <Fto>
           <FtoUid>
             <AhpUid>
@@ -163,11 +163,18 @@ describe AIXM::Component::FATO do
             <txtDesig>35</txtDesig>
           </FdnUid>
           <valTrueBrg>355</valTrueBrg>
-          <valMagBrg>356</valMagBrg>
+          <valMagBrg>354</valMagBrg>
           <txtRmk>Avoid flight over residental area</txtRmk>
         </Fdn>
       END
     end
+
+    it "builds OFMX with mid" do
+      AIXM.ofmx!
+      AIXM.config.mid_region = 'LF'
+      _(subject.to_xml).must_match /<FtoUid mid="9753290e-774e-2600-9b16-f7f951e06e9d">/
+      _(subject.to_xml).must_match /<FdnUid mid="ac550e74-73e2-4feb-4934-d0b4aafccfe6">/
+    end
   end
 end
 
@@ -178,13 +185,13 @@ describe AIXM::Component::FATO::Direction do
 
   describe :name= do
     it "fails on invalid values" do
-      [nil, :foobar, 'OGGY'].wont_be_written_to subject, :name
+      _([nil, :foobar, 'OGGY']).wont_be_written_to subject, :name
     end
   end
 
   describe :geographic_orientation= do
     it "fails on invalid values" do
-      [:foobar, -1, 10].wont_be_written_to subject, :geographic_orientation
+      _([:foobar, -1, 10]).wont_be_written_to subject, :geographic_orientation
     end
   end
 
@@ -195,14 +202,14 @@ describe AIXM::Component::FATO::Direction do
   describe :magnetic_orientation do
     it "is calculated correctly" do
       subject.geographic_orientation = AIXM.a(16)
-      subject.magnetic_orientation.must_equal AIXM.a(17)
+      _(subject.magnetic_orientation).must_equal AIXM.a(15)
     end
   end
 
   describe :xml= do
     it "builds correct complete OFMX" do
       AIXM.ofmx!
-      subject.to_xml.must_equal <<~END
+      _(subject.to_xml).must_equal <<~END
         <Fdn>
           <FdnUid>
             <FtoUid>
@@ -214,7 +221,7 @@ describe AIXM::Component::FATO::Direction do
             <txtDesig>35</txtDesig>
           </FdnUid>
           <valTrueBrg>355</valTrueBrg>
-          <valMagBrg>356</valMagBrg>
+          <valMagBrg>354</valMagBrg>
           <txtRmk>Avoid flight over residental area</txtRmk>
         </Fdn>
         <Fls>
@@ -242,7 +249,7 @@ describe AIXM::Component::FATO::Direction do
       AIXM.ofmx!
       %i(geographic_orientation remarks).each { |a| subject.send(:"#{a}=", nil) }
       subject.instance_eval { @lightings.clear }
-      subject.to_xml.must_equal <<~END
+      _(subject.to_xml).must_equal <<~END
       <Fdn>
         <FdnUid>
           <FtoUid>