aixm 0.1.0 → 0.1.3

data/lib/aixm/refinements.rb

@@ -1,11 +1,38 @@
 module AIXM
   module Refinements
 
+    UPTRANS_FILTER = %r{[^A-Z0-9, !"&#$%'\(\)\*\+\-\./:;<=>\?@\[\\\]\^_\|\{\}]}.freeze
+
+    UPTRANS_MAP = {
+      'Ä' => 'AE',
+      'Ö' => 'OE',
+      'Ü' => 'UE',
+      'Æ' => 'AE',
+      'Œ' => 'OE',
+      "Å" => "Aa",
+      "Ø" => "Oe"
+    }.freeze
+
+    KM_FACTORS = {
+      km: 1,
+      m: 0.001,
+      nm: 1.852,
+      ft: 0.0003048
+    }.freeze
+
     refine Array do
       ##
-      # Build 8 character upcase hex digest from payload (one or more strings)
+      # Shortcut for +include?+
+      #
+      # Example:
+      #   extensions.include?(:OFM)   # => true
+      #   extensions >> :OFM          # => true
+      alias_method :>>, :include?
+
+      ##
+      # Build a 1 to 9 digit integer digest (which fits in signed 32bit) from payload
       def to_digest
-        ::Digest::MD5.hexdigest(join('|'))[0, 8].upcase
+        ::Digest::SHA512.hexdigest(flatten.join('|')).gsub(/\D/, '')[0, 9].to_i
       end
     end
 
@@ -17,6 +44,18 @@ module AIXM
         gsub(/^/, whitespace)
       end
 
+      ##
+      # Upcase and transliterate to match the reduced character set for
+      # AIXM names and titles
+      def uptrans
+        self.dup.tap do |string|
+          string.upcase!
+          string.gsub!(/(#{UPTRANS_MAP.keys.join('|')})/, UPTRANS_MAP)
+          string.unicode_normalize!(:nfd)
+          string.gsub!(UPTRANS_FILTER, '')
+        end
+      end
+
       ##
       # Convert DMS angle to DD or +nil+ if the format is not recognized
       #
@@ -56,6 +95,14 @@ module AIXM
           seconds.abs
         ]
       end
+
+      ##
+      # Convert a distance +from+ unit (+:km+, +:m+, +:nm+ or +:ft+) to kilometers
+      def to_km(from:)
+        self * KM_FACTORS.fetch(from.downcase.to_sym)
+      rescue KeyError
+        raise(ArgumentError, "unit `#{from}' not supported")
+      end
     end
   end
 end

data/lib/aixm/shortcuts.rb

@@ -0,0 +1,30 @@
+module AIXM
+
+  SCHEMA = Pathname(__dir__).join('schemas', '4.5', 'AIXM-Snapshot.xsd').freeze
+
+  GROUND = Z.new(alt: 0, code: :QFE).freeze
+  UNLIMITED = Z.new(alt: 999, code: :QNE).freeze
+  H24 = Component::Schedule.new(code: :H24).freeze
+
+  ELEMENTS = {
+    document: Document,
+    xy: XY,
+    z: Z,
+    airspace: Feature::Airspace,
+    class_layer: Component::ClassLayer,
+    geometry: Component::Geometry,
+    schedule: Component::Schedule,
+    vertical_limits: Component::VerticalLimits,
+    arc: Component::Geometry::Arc,
+    border: Component::Geometry::Border,
+    circle: Component::Geometry::Circle,
+    point: Component::Geometry::Point
+  }.freeze
+
+  ELEMENTS.each do |element, klass|
+    define_singleton_method(element) do |*arguments|
+      klass.new(*arguments)
+    end
+  end
+
+end

data/lib/aixm/version.rb

@@ -1,3 +1,3 @@
 module AIXM
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.3".freeze
 end

data/spec/factory.rb

@@ -3,51 +3,68 @@ module AIXM
     class << self
 
       def vertical_limits
-        AIXM::Vertical::Limits.new(
-          upper_z: AIXM::Z.new(alt: 65, code: :QNE),
-          lower_z: AIXM::Z.new(alt: 45, code: :QNE),
-          max_z: AIXM::Z.new(alt: 6000, code: :QNH),
-          min_z: AIXM::Z.new(alt: 3000, code: :QFE)
+        AIXM.vertical_limits(
+          upper_z: AIXM.z(alt: 65, code: :QNE),
+          lower_z: AIXM.z(alt: 45, code: :QNE),
+          max_z: AIXM.z(alt: 6000, code: :QNH),
+          min_z: AIXM.z(alt: 3000, code: :QFE)
+        )
+      end
+
+      def class_layer
+        AIXM.class_layer(
+          class: :C,
+          vertical_limits: vertical_limits
         )
       end
 
       def polygon_geometry
-        AIXM::Geometry.new.tap do |geometry|
-          geometry << AIXM::Horizontal::Arc.new(
-            xy: AIXM::XY.new(lat: %q(47°51'33"N), long: %q(007°33'36"E)),
-            center_xy: AIXM::XY.new(lat: %q(47°54'15"N), long: %q(007°33'48"E)),
+        AIXM.geometry.tap do |geometry|
+          geometry << AIXM.arc(
+            xy: AIXM.xy(lat: %q(47°51'33"N), long: %q(007°33'36"E)),
+            center_xy: AIXM.xy(lat: %q(47°54'15"N), long: %q(007°33'48"E)),
             clockwise: true
           )
-          geometry << AIXM::Horizontal::Border.new(
-            xy: AIXM::XY.new(lat: %q(47°56'37"N), long: %q(007°35'45"E)),
+          geometry << AIXM.border(
+            xy: AIXM.xy(lat: %q(47°56'37"N), long: %q(007°35'45"E)),
             name: 'FRANCE_GERMANY'
           )
-          geometry << AIXM::Horizontal::Point.new(
-            xy: AIXM::XY.new(lat: %q(47°51'33"N), long: %q(007°33'36"E))
+          geometry << AIXM.point(
+            xy: AIXM.xy(lat: %q(47°51'33"N), long: %q(007°33'36"E))
           )
         end
       end
 
       def circle_geometry
-        AIXM::Geometry.new.tap do |geometry|
-          geometry << AIXM::Horizontal::Circle.new(
-            center_xy: AIXM::XY.new(lat: %q(47°35'00"N), long: %q(004°53'00"E)), 
+        AIXM.geometry.tap do |geometry|
+          geometry << AIXM.circle(
+            center_xy: AIXM.xy(lat: %q(47°35'00"N), long: %q(004°53'00"E)),
             radius: 10
           )
         end
       end
 
-      def polygon_airspace
-        AIXM::Feature::Airspace.new(name: 'POLYGON AIRSPACE', type: 'D').tap do |airspace|
-          airspace.vertical_limits = vertical_limits
+      def polygon_airspace(short_name: 'POLYGON', schedule: :H24)
+        AIXM.airspace(
+          name: 'POLYGON AIRSPACE',
+          short_name: short_name,
+          type: 'D'
+        ).tap do |airspace|
+          airspace.schedule = AIXM.schedule(code: schedule) if schedule
+          airspace.class_layers << class_layer
           airspace.geometry = polygon_geometry
           airspace.remarks = 'polygon airspace'
         end
       end
 
-      def circle_airspace
-        AIXM::Feature::Airspace.new(name: 'CIRCLE AIRSPACE', type: 'D').tap do |airspace|
-          airspace.vertical_limits = vertical_limits
+      def circle_airspace(short_name: 'CIRCLE', schedule: :H24)
+        AIXM.airspace(
+          name: 'CIRCLE AIRSPACE',
+          short_name: short_name,
+          type: 'D'
+        ).tap do |airspace|
+          airspace.schedule = AIXM.schedule(code: schedule) if schedule
+          airspace.class_layers << class_layer
           airspace.geometry = circle_geometry
           airspace.remarks = 'circle airspace'
         end
@@ -55,9 +72,9 @@ module AIXM
 
       def document
         time = Time.parse('2018-01-18 12:00:00 +0100')
-        AIXM::Document.new(created_at: time, effective_at: time).tap do |document|
-          document << AIXM::Factory.polygon_airspace
-          document << AIXM::Factory.circle_airspace
+        AIXM.document(created_at: time, effective_at: time).tap do |document|
+          document.features << AIXM::Factory.polygon_airspace
+          document.features << AIXM::Factory.circle_airspace
         end
       end
 

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

@@ -0,0 +1,74 @@
+require_relative '../../../spec_helper'
+
+describe AIXM::Component::ClassLayer do
+  describe :initialize do
+    it "won't accept invalid arguments" do
+      -> { AIXM::Component::ClassLayer.new(class: 'X', vertical_limits: AIXM::Factory.vertical_limits ) }.must_raise ArgumentError
+      -> { AIXM::Component::ClassLayer.new(class: 'A', vertical_limits: 'foobar') }.must_raise ArgumentError
+    end
+  end
+
+  context "with class" do
+    subject do
+      AIXM::Component::ClassLayer.new(class: :C, vertical_limits: AIXM::Factory.vertical_limits)
+    end
+
+    describe :to_digest do
+      it "must return digest of payload" do
+        subject.to_digest.must_equal 612555203
+      end
+    end
+
+    describe :to_xml do
+      it "must build correct XML" do
+        subject.to_xml.must_equal <<~END
+          <codeClass>C</codeClass>
+          <codeDistVerUpper>STD</codeDistVerUpper>
+          <valDistVerUpper>65</valDistVerUpper>
+          <uomDistVerUpper>FL</uomDistVerUpper>
+          <codeDistVerLower>STD</codeDistVerLower>
+          <valDistVerLower>45</valDistVerLower>
+          <uomDistVerLower>FL</uomDistVerLower>
+          <codeDistVerMax>ALT</codeDistVerMax>
+          <valDistVerMax>6000</valDistVerMax>
+          <uomDistVerMax>FT</uomDistVerMax>
+          <codeDistVerMnm>HEI</codeDistVerMnm>
+          <valDistVerMnm>3000</valDistVerMnm>
+          <uomDistVerMnm>FT</uomDistVerMnm>
+        END
+      end
+    end
+  end
+
+  context "without class" do
+    subject do
+      AIXM::Component::ClassLayer.new(vertical_limits: AIXM::Factory.vertical_limits)
+    end
+
+    describe :to_digest do
+      it "must return digest of payload" do
+        subject.to_digest.must_equal 486148039
+      end
+    end
+
+    describe :to_xml do
+      it "must build correct XML" do
+        subject.to_xml.must_equal <<~END
+          <codeDistVerUpper>STD</codeDistVerUpper>
+          <valDistVerUpper>65</valDistVerUpper>
+          <uomDistVerUpper>FL</uomDistVerUpper>
+          <codeDistVerLower>STD</codeDistVerLower>
+          <valDistVerLower>45</valDistVerLower>
+          <uomDistVerLower>FL</uomDistVerLower>
+          <codeDistVerMax>ALT</codeDistVerMax>
+          <valDistVerMax>6000</valDistVerMax>
+          <uomDistVerMax>FT</uomDistVerMax>
+          <codeDistVerMnm>HEI</codeDistVerMnm>
+          <valDistVerMnm>3000</valDistVerMnm>
+          <uomDistVerMnm>FT</uomDistVerMnm>
+        END
+      end
+    end
+  end
+
+end

data/spec/lib/aixm/{horizontal → component/geometry}/arc_spec.rb

@@ -1,37 +1,37 @@
-require_relative '../../../spec_helper'
+require_relative '../../../../spec_helper'
 
-describe AIXM::Horizontal::Arc do
+describe AIXM::Component::Geometry::Arc do
   describe :initialize do
     it "won't accept invalid arguments" do
       xy = AIXM::XY.new(lat: 11.1, long: 22.2)
-      -> { AIXM::Horizontal::Arc.new(xy: 0, center_xy: xy, clockwise: true) }.must_raise ArgumentError
-      -> { AIXM::Horizontal::Arc.new(xy: xy, center_xy: 0, clockwise: true) }.must_raise ArgumentError
-      -> { AIXM::Horizontal::Arc.new(xy: xy, center_xy: xy, clockwise: 0) }.must_raise ArgumentError
+      -> { AIXM::Component::Geometry::Arc.new(xy: 0, center_xy: xy, clockwise: true) }.must_raise ArgumentError
+      -> { AIXM::Component::Geometry::Arc.new(xy: xy, center_xy: 0, clockwise: true) }.must_raise ArgumentError
+      -> { AIXM::Component::Geometry::Arc.new(xy: xy, center_xy: xy, clockwise: 0) }.must_raise ArgumentError
     end
   end
 
   describe :clockwise? do
     it "must return true or false" do
       xy = AIXM::XY.new(lat: 11.1, long: 22.2)
-      AIXM::Horizontal::Arc.new(xy: xy, center_xy: xy, clockwise: true).must_be :clockwise?
-      AIXM::Horizontal::Arc.new(xy: xy, center_xy: xy, clockwise: false).wont_be :clockwise?
+      AIXM::Component::Geometry::Arc.new(xy: xy, center_xy: xy, clockwise: true).must_be :clockwise?
+      AIXM::Component::Geometry::Arc.new(xy: xy, center_xy: xy, clockwise: false).wont_be :clockwise?
     end
   end
 
   describe :to_digest do
     it "must return digest of payload" do
-      subject = AIXM::Horizontal::Arc.new(
+      subject = AIXM::Component::Geometry::Arc.new(
         xy: AIXM::XY.new(lat: 11.1, long: 33.3),
         center_xy: AIXM::XY.new(lat: 22.2, long: 33.3),
         clockwise: true
       )
-      subject.to_digest.must_equal '35B2E1AF'
+      subject.to_digest.must_equal 712900173
     end
   end
 
   describe :to_xml do
     it "must build correct XML for clockwise arcs" do
-      subject = AIXM::Horizontal::Arc.new(
+      subject = AIXM::Component::Geometry::Arc.new(
         xy: AIXM::XY.new(lat: 11.1, long: 33.3),
         center_xy: AIXM::XY.new(lat: 22.2, long: 33.3),
         clockwise: true
@@ -49,7 +49,7 @@ describe AIXM::Horizontal::Arc do
     end
 
     it "must build correct XML for counter-clockwise arcs" do
-      subject = AIXM::Horizontal::Arc.new(
+      subject = AIXM::Component::Geometry::Arc.new(
         xy: AIXM::XY.new(lat: 11.1, long: 33.3),
         center_xy: AIXM::XY.new(lat: 22.2, long: 33.3),
         clockwise: false

data/spec/lib/aixm/component/geometry/border_spec.rb

@@ -0,0 +1,30 @@
+require_relative '../../../../spec_helper'
+
+describe AIXM::Component::Geometry::Border do
+  describe :to_digest do
+    it "must return digest of payload" do
+      subject = AIXM::Component::Geometry::Border.new(
+        xy: AIXM::XY.new(lat: 11.1, long: 22.2),
+        name: 'foobar'
+      )
+      subject.to_digest.must_equal 813052011
+    end
+  end
+
+  describe :to_xml do
+    it "must build correct XML" do
+      subject = AIXM::Component::Geometry::Border.new(
+        xy: AIXM::XY.new(lat: 11.1, long: 22.2),
+        name: 'foobar'
+      )
+      subject.to_xml.must_equal <<~END
+      <Avx>
+        <codeType>FNT</codeType>
+        <geoLat>110600.00N</geoLat>
+        <geoLong>0221200.00E</geoLong>
+        <codeDatum>WGE</codeDatum>
+      </Avx>
+      END
+    end
+  end
+end

data/spec/lib/aixm/{horizontal → component/geometry}/circle_spec.rb

@@ -1,15 +1,15 @@
-require_relative '../../../spec_helper'
+require_relative '../../../../spec_helper'
 
-describe AIXM::Horizontal::Circle do
+describe AIXM::Component::Geometry::Circle do
   describe :initialize do
     it "won't accept invalid arguments" do
-      -> { AIXM::Horizontal::Circle.new(center_xy: 0, radius: 0) }.must_raise ArgumentError
+      -> { AIXM::Component::Geometry::Circle.new(center_xy: 0, radius: 0) }.must_raise ArgumentError
     end
   end
 
   describe :north_xy do
     it "must calculate approximation of northmost point on the circumference" do
-      subject = AIXM::Horizontal::Circle.new(
+      subject = AIXM::Component::Geometry::Circle.new(
         center_xy: AIXM::XY.new(lat: 12.12345678, long: -23.12345678),
         radius: 15
       )
@@ -19,17 +19,17 @@ describe AIXM::Horizontal::Circle do
 
   describe :to_digest do
     it "must return digest of payload" do
-      subject = AIXM::Horizontal::Circle.new(
+      subject = AIXM::Component::Geometry::Circle.new(
         center_xy: AIXM::XY.new(lat: 12.12345678, long: -23.12345678),
         radius: 15
       )
-      subject.to_digest.must_equal '914C5F08'
+      subject.to_digest.must_equal 386055945
     end
   end
 
   describe :to_xml do
     it "must build correct XML for circles not near the equator" do
-      subject = AIXM::Horizontal::Circle.new(
+      subject = AIXM::Component::Geometry::Circle.new(
         center_xy: AIXM::XY.new(lat: 11.1, long: 22.2),
         radius: 25
       )
@@ -46,7 +46,7 @@ describe AIXM::Horizontal::Circle do
     end
 
     it "must build correct XML for circles near the equator" do
-      subject = AIXM::Horizontal::Circle.new(
+      subject = AIXM::Component::Geometry::Circle.new(
         center_xy: AIXM::XY.new(lat: -0.0005, long: -22.2),
         radius: 50
       )

data/spec/lib/aixm/{horizontal → component/geometry}/point_spec.rb

@@ -1,22 +1,22 @@
-require_relative '../../../spec_helper'
+require_relative '../../../../spec_helper'
 
-describe AIXM::Horizontal::Point do
+describe AIXM::Component::Geometry::Point do
   describe :initialize do
     it "won't accept invalid arguments" do
-      -> { AIXM::Horizontal::Point.new(xy: 0) }.must_raise ArgumentError
+      -> { AIXM::Component::Geometry::Point.new(xy: 0) }.must_raise ArgumentError
     end
   end
 
   describe :to_digest do
     it "must return digest of payload" do
-      subject = AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 11.1, long: 22.2))
-      subject.to_digest.must_equal '215D7CBA'
+      subject = AIXM::Component::Geometry::Point.new(xy: AIXM::XY.new(lat: 11.1, long: 22.2))
+      subject.to_digest.must_equal 167706171
     end
   end
 
   describe :to_xml do
     it "must build correct XML for N/E points" do
-      subject = AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 11.1, long: 22.2))
+      subject = AIXM::Component::Geometry::Point.new(xy: AIXM::XY.new(lat: 11.1, long: 22.2))
       subject.to_xml.must_equal <<~END
         <Avx>
           <codeType>GRC</codeType>
@@ -28,7 +28,7 @@ describe AIXM::Horizontal::Point do
     end
 
     it "must build correct XML for S/W points" do
-      subject = AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: -11.1, long: -22.2))
+      subject = AIXM::Component::Geometry::Point.new(xy: AIXM::XY.new(lat: -11.1, long: -22.2))
       subject.to_xml.must_equal <<~END
         <Avx>
           <codeType>GRC</codeType>