aixm 0.1.0

data/lib/aixm/z.rb

@@ -0,0 +1,39 @@
+module AIXM
+
+  ##
+  # Elevation or altitude
+  #
+  # The following Q codes are recognized:
+  # * QFE - height in feet
+  # * QNH - altitude in feet
+  # * QNE - altitude as flight level
+  class Z
+
+    CODES = %i(QFE QNH QNE).freeze
+
+    attr_reader :alt, :code
+
+    def initialize(alt:, code:)
+      fail(ArgumentError, "unrecognized Q code `#{code}'") unless CODES.include? code
+      @alt, @code = alt, code
+    end
+
+    def ==(other)
+      other.is_a?(Z) && alt == other.alt && code == other.code
+    end
+
+    def ground?
+      @code == :QFE && @alt == 0
+    end
+
+    def base
+      @code == :QFE ? :ASFC : :AMSL
+    end
+
+    def unit
+      @code == :QNE ? :FL : :FT
+    end
+
+  end
+
+end

data/spec/factory.rb

@@ -0,0 +1,66 @@
+module AIXM
+  class Factory
+    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)
+        )
+      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)),
+            clockwise: true
+          )
+          geometry << AIXM::Horizontal::Border.new(
+            xy: AIXM::XY.new(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))
+          )
+        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)), 
+            radius: 10
+          )
+        end
+      end
+
+      def polygon_airspace
+        AIXM::Feature::Airspace.new(name: 'POLYGON AIRSPACE', type: 'D').tap do |airspace|
+          airspace.vertical_limits = vertical_limits
+          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
+          airspace.geometry = circle_geometry
+          airspace.remarks = 'circle airspace'
+        end
+      end
+
+      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
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/aixm/document_spec.rb

@@ -0,0 +1,211 @@
+require_relative '../../spec_helper'
+
+describe AIXM::Document do
+  context "incomplete" do
+    subject do
+      AIXM::Document.new
+    end
+
+    it "must fail validation" do
+      subject.wont_be :valid?
+    end
+  end
+
+  context "complete" do
+    subject do
+      AIXM::Factory.document
+    end
+
+    it "won't have errors" do
+      subject.errors.must_equal []
+    end
+
+    it "must pass validation" do
+      subject.must_be :valid?
+    end
+
+    it "must build correct XML without extensions" do
+      subject.to_xml.must_equal <<~END
+        <?xml version="1.0" encoding="UTF-8"?>
+        <AIXM-Snapshot xmlns:xsi="http://www.aixm.aero/schema/4.5/AIXM-Snapshot.xsd" version="4.5" origin="AIXM 0.1.0 Ruby gem" created="2018-01-18T12:00:00+01:00" effective="2018-01-18T12:00:00+01:00">
+          <Ase>
+            <AseUid mid="7F466CA0">
+              <codeType>D</codeType>
+              <codeId>7F466CA0</codeId>
+            </AseUid>
+            <txtName>POLYGON AIRSPACE</txtName>
+            <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>
+            <txtRmk>polygon airspace</txtRmk>
+          </Ase>
+          <Abd>
+            <AbdUid>
+              <AseUid mid="7F466CA0">
+                <codeType>D</codeType>
+                <codeId>7F466CA0</codeId>
+              </AseUid>
+            </AbdUid>
+            <Avx>
+              <codeType>CWA</codeType>
+              <geoLat>475133.00N</geoLat>
+              <geoLong>0073336.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+              <geoLatArc>475415.00N</geoLatArc>
+              <geoLongArc>0073348.00E</geoLongArc>
+            </Avx>
+            <Avx>
+              <codeType>FNT</codeType>
+              <geoLat>475637.00N</geoLat>
+              <geoLong>0073545.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+            </Avx>
+            <Avx>
+              <codeType>GRC</codeType>
+              <geoLat>475133.00N</geoLat>
+              <geoLong>0073336.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+            </Avx>
+          </Abd>
+          <Ase>
+            <AseUid mid="E1115E8A">
+              <codeType>D</codeType>
+              <codeId>E1115E8A</codeId>
+            </AseUid>
+            <txtName>CIRCLE AIRSPACE</txtName>
+            <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>
+            <txtRmk>circle airspace</txtRmk>
+          </Ase>
+          <Abd>
+            <AbdUid>
+              <AseUid mid="E1115E8A">
+                <codeType>D</codeType>
+                <codeId>E1115E8A</codeId>
+              </AseUid>
+            </AbdUid>
+            <Avx>
+              <codeType>CWA</codeType>
+              <geoLat>474023.76N</geoLat>
+              <geoLong>0045300.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+              <geoLatArc>473500.00N</geoLatArc>
+              <geoLongArc>0045300.00E</geoLongArc>
+            </Avx>
+          </Abd>
+        </AIXM-Snapshot>
+      END
+    end
+
+    it "must build correct XML with OFM extensions" do
+      subject.to_xml(:OFM).must_equal <<~END
+        <?xml version="1.0" encoding="UTF-8"?>
+        <AIXM-Snapshot xmlns:xsi="http://www.aixm.aero/schema/4.5/AIXM-Snapshot.xsd" version="4.5 + OFM extensions of version 0.1" origin="AIXM 0.1.0 Ruby gem" created="2018-01-18T12:00:00+01:00" effective="2018-01-18T12:00:00+01:00">
+          <Ase>
+            <AseUid mid="7F466CA0">
+              <codeType>D</codeType>
+              <codeId>7F466CA0</codeId>
+            </AseUid>
+            <txtName>POLYGON AIRSPACE</txtName>
+            <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>
+            <txtRmk>polygon airspace</txtRmk>
+          </Ase>
+          <Abd>
+            <AbdUid>
+              <AseUid mid="7F466CA0">
+                <codeType>D</codeType>
+                <codeId>7F466CA0</codeId>
+              </AseUid>
+            </AbdUid>
+            <Avx>
+              <codeType>CWA</codeType>
+              <geoLat>475133.00N</geoLat>
+              <geoLong>0073336.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+              <geoLatArc>475415.00N</geoLatArc>
+              <geoLongArc>0073348.00E</geoLongArc>
+            </Avx>
+            <Avx>
+              <codeType>FNT</codeType>
+              <geoLat>475637.00N</geoLat>
+              <geoLong>0073545.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+            </Avx>
+            <Avx>
+              <codeType>GRC</codeType>
+              <geoLat>475133.00N</geoLat>
+              <geoLong>0073336.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+            </Avx>
+          </Abd>
+          <Ase>
+            <AseUid mid="E1115E8A">
+              <codeType>D</codeType>
+              <codeId>E1115E8A</codeId>
+            </AseUid>
+            <txtName>CIRCLE AIRSPACE</txtName>
+            <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>
+            <txtRmk>circle airspace</txtRmk>
+          </Ase>
+          <Abd>
+            <AbdUid>
+              <AseUid mid="E1115E8A">
+                <codeType>D</codeType>
+                <codeId>E1115E8A</codeId>
+              </AseUid>
+            </AbdUid>
+            <Avx>
+              <codeType>CWA</codeType>
+              <geoLat>474023.76N</geoLat>
+              <geoLong>0045300.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+              <geoLatArc>473500.00N</geoLatArc>
+              <geoLongArc>0045300.00E</geoLongArc>
+            </Avx>
+          </Abd>
+        </AIXM-Snapshot>
+      END
+    end
+  end
+end

data/spec/lib/aixm/feature/airspace_spec.rb

@@ -0,0 +1,96 @@
+require_relative '../../../spec_helper'
+
+describe AIXM::Feature::Airspace do
+  context "incomplete" do
+    subject do
+      AIXM::Feature::Airspace.new(name: 'foobar', type: 'D')
+    end
+
+    describe :valid? do
+      it "must fail validation" do
+        subject.wont_be :valid?
+      end
+    end
+
+    describe :vertical_limits= do
+      it "won't accept invalid vertical limits" do
+        -> { subject.vertical_limits=0 }.must_raise ArgumentError
+      end
+    end
+  end
+
+  context "complete" do
+    subject do
+      AIXM::Factory.polygon_airspace
+    end
+
+    describe :valid? do
+      it "must pass validation" do
+        subject.must_be :valid?
+      end
+    end
+
+    describe :to_digest do
+      it "must return digest of payload" do
+        subject.to_digest.must_equal '7F466CA0'
+      end
+    end
+
+    describe :to_xml do
+      it "must build correct XML with OFM extensions" do
+        subject.to_xml(:OFM).must_equal <<~END
+          <Ase xt_classLayersAvail="false">
+            <AseUid mid="7F466CA0" newEntity="true">
+              <codeType>D</codeType>
+              <codeId>7F466CA0</codeId>
+            </AseUid>
+            <txtName>POLYGON AIRSPACE</txtName>
+            <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>
+            <txtRmk>polygon airspace</txtRmk>
+            <xt_txtRmk>polygon airspace</xt_txtRmk>
+            <xt_selAvail>false</xt_selAvail>
+          </Ase>
+          <Abd>
+            <AbdUid>
+              <AseUid mid="7F466CA0" newEntity="true">
+                <codeType>D</codeType>
+                <codeId>7F466CA0</codeId>
+              </AseUid>
+            </AbdUid>
+            <Avx>
+              <codeType>CWA</codeType>
+              <geoLat>475133.00N</geoLat>
+              <geoLong>0073336.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+              <geoLatArc>475415.00N</geoLatArc>
+              <geoLongArc>0073348.00E</geoLongArc>
+            </Avx>
+            <Avx>
+              <codeType>FNT</codeType>
+              <geoLat>475637.00N</geoLat>
+              <geoLong>0073545.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+            </Avx>
+            <Avx>
+              <codeType>GRC</codeType>
+              <geoLat>475133.00N</geoLat>
+              <geoLong>0073336.00E</geoLong>
+              <codeDatum>WGE</codeDatum>
+            </Avx>
+          </Abd>
+        END
+      end
+    end
+  end
+end

data/spec/lib/aixm/geometry_spec.rb

@@ -0,0 +1,218 @@
+require_relative '../../spec_helper'
+
+describe AIXM::Geometry do
+
+  context "singularity" do
+    subject do
+      AIXM::Geometry.new
+    end
+
+    it "must fail validation" do
+      subject.wont_be :circle?
+      subject.wont_be :closed_shape?
+      subject.wont_be :valid?
+    end
+  end
+
+  context "point" do
+    subject do
+      AIXM::Geometry.new.tap do |geometry|
+        geometry << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 11, long: 22))
+      end
+    end
+
+    it "must fail validation" do
+      subject.wont_be :circle?
+      subject.wont_be :closed_shape?
+      subject.wont_be :valid?
+    end
+  end
+
+  context "line" do
+    subject do
+      AIXM::Geometry.new.tap do |geometry|
+        geometry << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 11, long: 22))
+        geometry << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 22, long: 33))
+      end
+    end
+
+    it "must fail validation" do
+      subject.wont_be :circle?
+      subject.wont_be :closed_shape?
+      subject.wont_be :valid?
+    end
+  end
+
+  context "polygon" do
+    subject do
+      AIXM::Geometry.new.tap do |geometry|
+        geometry << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 11, long: 22))
+        geometry << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 22, long: 33))
+      end
+    end
+
+    it "must recognize unclosed" do
+      subject.wont_be :circle?
+      subject.wont_be :closed_shape?
+      subject.wont_be :valid?
+    end
+
+    it "must recognize closed" do
+      subject << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 11, long: 22))
+      subject.wont_be :circle?
+      subject.must_be :closed_shape?
+      subject.must_be :valid?
+    end
+
+    it "must return elements" do
+      subject.horizontals.count.must_equal 2
+    end
+
+    it "must return digest of payload" do
+      subject.to_digest.must_equal '281EE1FA'
+    end
+
+    it "must build valid XML" do
+      subject.to_xml.must_equal <<~END
+        <Avx>
+          <codeType>GRC</codeType>
+          <geoLat>110000.00N</geoLat>
+          <geoLong>0220000.00E</geoLong>
+          <codeDatum>WGE</codeDatum>
+        </Avx>
+        <Avx>
+          <codeType>GRC</codeType>
+          <geoLat>220000.00N</geoLat>
+          <geoLong>0330000.00E</geoLong>
+          <codeDatum>WGE</codeDatum>
+        </Avx>
+      END
+    end
+  end
+
+  context "arc" do
+    subject do
+      AIXM::Geometry.new.tap do |geometry|
+        geometry << AIXM::Horizontal::Arc.new(xy: AIXM::XY.new(lat: 11, long: 22), center_xy: AIXM::XY.new(lat: 10, long: 20), clockwise: true)
+        geometry << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 22, long: 33))
+      end
+    end
+
+    it "must recognize unclosed" do
+      subject.wont_be :circle?
+      subject.wont_be :closed_shape?
+      subject.wont_be :valid?
+    end
+
+    it "must recognize closed" do
+      subject << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 11, long: 22))
+      subject.wont_be :circle?
+      subject.must_be :closed_shape?
+      subject.must_be :valid?
+    end
+
+    it "must build valid XML" do
+      subject.to_xml.must_equal <<~END
+        <Avx>
+          <codeType>CWA</codeType>
+          <geoLat>110000.00N</geoLat>
+          <geoLong>0220000.00E</geoLong>
+          <codeDatum>WGE</codeDatum>
+          <geoLatArc>100000.00N</geoLatArc>
+          <geoLongArc>0200000.00E</geoLongArc>
+        </Avx>
+        <Avx>
+          <codeType>GRC</codeType>
+          <geoLat>220000.00N</geoLat>
+          <geoLong>0330000.00E</geoLong>
+          <codeDatum>WGE</codeDatum>
+        </Avx>
+      END
+    end
+
+    it "must return digest of payload" do
+      subject.to_digest.must_equal '8DC81708'
+    end
+  end
+
+  context "border" do
+    subject do
+      AIXM::Geometry.new.tap do |geometry|
+        geometry << AIXM::Horizontal::Border.new(xy: AIXM::XY.new(lat: 11, long: 22), name: 'foobar')
+        geometry << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 22, long: 33))
+      end
+    end
+
+    it "must recognize unclosed" do
+      subject.wont_be :circle?
+      subject.wont_be :closed_shape?
+      subject.wont_be :valid?
+    end
+
+    it "must recognize closed" do
+      subject << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 11, long: 22))
+      subject.wont_be :circle?
+      subject.must_be :closed_shape?
+      subject.must_be :valid?
+    end
+
+    it "must build valid XML" do
+      subject.to_xml.must_equal <<~END
+        <Avx>
+          <codeType>FNT</codeType>
+          <geoLat>110000.00N</geoLat>
+          <geoLong>0220000.00E</geoLong>
+          <codeDatum>WGE</codeDatum>
+        </Avx>
+        <Avx>
+          <codeType>GRC</codeType>
+          <geoLat>220000.00N</geoLat>
+          <geoLong>0330000.00E</geoLong>
+          <codeDatum>WGE</codeDatum>
+        </Avx>
+      END
+    end
+
+    it "must return digest of payload" do
+      subject.to_digest.must_equal 'F208007C'
+    end
+  end
+
+  context "circle" do
+    subject do
+      AIXM::Geometry.new.tap do |geometry|
+        geometry << AIXM::Horizontal::Circle.new(center_xy: AIXM::XY.new(lat: 11, long: 22), radius: 10)
+      end
+    end
+
+    it "must pass validation" do
+      subject.must_be :circle?
+      subject.wont_be :closed_shape?
+      subject.must_be :valid?
+    end
+
+    it "must fail validation when additional elements are present" do
+      subject << AIXM::Horizontal::Point.new(xy: AIXM::XY.new(lat: 11, long: 22))
+      subject.wont_be :circle?
+      subject.wont_be :closed_shape?
+      subject.wont_be :valid?
+    end
+
+    it "must build valid XML" do
+      subject.to_xml.must_equal <<~END
+        <Avx>
+          <codeType>CWA</codeType>
+          <geoLat>110523.76N</geoLat>
+          <geoLong>0220000.00E</geoLong>
+          <codeDatum>WGE</codeDatum>
+          <geoLatArc>110000.00N</geoLatArc>
+          <geoLongArc>0220000.00E</geoLongArc>
+        </Avx>
+      END
+    end
+
+    it "must return digest of payload" do
+      subject.to_digest.must_equal 'CCBB63FD'
+    end
+  end
+end