aixm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 153468c1338fc26792178d856c438511fa10ac58988ef0e938980fd590338164
+  data.tar.gz: b04ae1dcbe0ef0d90beea492c08d08aeab943a156127c70cdc94c5ec69b4995b
+SHA512:
+  metadata.gz: 45a95906e65595273f9e5667a7aee0498f5390a6d9c86500f00dafbc080376316fa4b8d062deefda840ec9a0d403ab941762c59f4b4d413eed17868102e86196
+  data.tar.gz: efe2127226e7a3e3d5b25f69bb29688fa12c59b1af579a272291aa200b5b2447c24b4093e248eb671ca0cb915a0aa31a50f757c8dcb5770f3b7d28139ab78396

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+Gemfile.lock
+pkg/*
+*.gem
+.bundle

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+---
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## 0.1.0
+
+* Initial implementation to import D/R/P zones to OFM
+  * XY Coordinate
+  * Z Altitude
+  * AIXM-Snapshot 4.5 Document
+  * Airspace
+  * Vertical Limits
+  * Geometry
+    * Point
+    * Arc
+    * Border
+    * Circle
+  * Refinements

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+clearing :on
+
+guard :minitest do
+  watch(%r{^spec/(.+)_spec\.rb})
+  watch(%r{^lib/(.+)\.rb}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sven Schwyn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+[![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)
+[![Code Climate](https://img.shields.io/codeclimate/github/svoop/aixm.svg?style=flat)](https://codeclimate.com/github/svoop/aixm)
+[![Gitter](https://img.shields.io/gitter/room/svoop/aixm.svg?style=flat)](https://gitter.im/svoop/aixm)
+[![Donorbox](https://img.shields.io/badge/donate-on_donorbox-yellow.svg)](https://donorbox.org/bitcetera-aixm)
+
+# AIXM
+
+Partial implementation of the [Aeronautical Information Exchange Model (AIXM 4.5)](http://aixm.aero)
+for Ruby.
+
+For now, only the parts needed to automize the AIP import of [Open Flightmaps](https://openflightmaps.org)
+are part of this gem. Most notably, the gem is only a builder of AIXM 4.5
+snapshot files and does not parse them.
+
+* [Homepage](https://github.com/svoop/aixm)
+* Author: [Sven Schwyn - Bitcetera](http://www.bitcetera.com)
+
+## Install
+
+Add this to your <tt>Gemfile</tt>:
+
+```ruby
+gem aixm
+```
+
+## Usage
+
+### Types
+
+#### Coordinate
+
+All of the below are equivalent:
+
+```ruby
+AIXM::XY.new(lat: %q(11°22'33.44"), long: %q(-111°22'33.44"))
+AIXM::XY.new(lat: '112233.44N', long: '1112233.44W')
+AIXM::XY.new(lat: 11.375955555555556, long: -111.37595555555555)
+```
+
+#### Altitude
+
+```ruby
+AIXM::Z.new(alt: 1000, code: :QFE)   # height: 1000ft above ground
+AIXM::Z.new(alt: 2000, code: :QNH)   # altitude: of 2000ft above mean sea level
+AIXM::Z.new(alt: 45, code: :QNE)     # altitude: flight level 45
+```
+
+### Document
+
+See <tt>spec/factory.rb</tt> for examples.
+
+## Rendering
+
+```ruby
+document.to_xml         # render AIXM 4.5 compliant XML
+document.to_xml(:OFM)   # render AIXM 4.5 + OFM extensions XML
+```
+
+## Constants
+
+* <tt>AIXM::GROUND</tt> - height: 0ft above ground
+
+## Refinements
+
+By `using AIXM::Refinements` you get the following general purpose methods:
+
+* <tt>String#indent(number)</tt><br>Indent every line of a string with *number* spaces
+* <tt>String#to_dd</tt><br>Convert DMS angle to DD or <tt>nil</tt> if the format is not recognized
+* <tt>Float#to_dms(padding)</tt><br>Convert DD angle to DMS with the degrees zero padded to *padding* length
+* <tt>Float#trim</tt><br>Convert whole numbers to Integer and leave all other untouched
+
+## References
+
+* [AIXM](http://aixm.aero)
+* [AIXM on Wikipedia](https://en.wikipedia.org/wiki/AIXM)
+* [Open Flightmaps](https://openflightmaps.org)
+
+## Development
+
+To install the development dependencies and then run the test suite:
+
+```
+bundle install
+bundle exec rake    # run tests once
+bundle exec guard   # run tests whenever files are modified
+```
+
+Please submit issues on:
+
+https://github.com/svoop/aixm/issues
+
+To contribute code, fork the project on Github, add your code and submit a
+pull request:
+
+https://help.github.com/articles/fork-a-repo
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['spec/lib/**/*_spec.rb']
+  t.verbose = false
+  t.warning = true
+end
+
+task default: :test

data/aixm.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aixm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aixm'
+  spec.version       = AIXM::VERSION
+  spec.authors       = ['Sven Schwyn']
+  spec.email         = ['ruby@bitcetera.com']
+  spec.description   = %q(Aeronautical Information Exchange Model (AIXM 4.5).)
+  spec.summary       = %q(Aeronautical Information Exchange Model (AIXM 4.5).)
+  spec.homepage      = 'http://www.bitcetera.com/products/aixm'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'minitest-sound'
+  spec.add_development_dependency 'minitest-matchers'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+
+  spec.add_runtime_dependency 'builder', '~> 3'
+  spec.add_runtime_dependency 'nokogiri', '~> 1'
+end

data/lib/aixm.rb

@@ -0,0 +1,25 @@
+require 'builder'
+require 'nokogiri'
+require 'forwardable'
+require 'ostruct'
+require 'digest'
+require 'time'
+
+require_relative 'aixm/version'
+
+require_relative 'aixm/refinements'
+
+require_relative 'aixm/xy'
+require_relative 'aixm/z'
+require_relative 'aixm/geometry'
+
+require_relative 'aixm/horizontal/point'
+require_relative 'aixm/horizontal/arc'
+require_relative 'aixm/horizontal/border'
+require_relative 'aixm/horizontal/circle'
+require_relative 'aixm/vertical/limits'
+
+require_relative 'aixm/constants'
+require_relative 'aixm/document'
+
+require_relative 'aixm/feature/airspace'

data/lib/aixm/constants.rb

@@ -0,0 +1,6 @@
+module AIXM
+
+  SCHEMA = Pathname(__dir__).join('schemas', '4.5', 'AIXM-Snapshot.xsd').freeze
+  GROUND = AIXM::Z.new(alt: 0, code: :QFE).freeze
+
+end

data/lib/aixm/document.rb

@@ -0,0 +1,65 @@
+module AIXM
+  class Document
+
+    include Enumerable
+    extend Forwardable
+    using AIXM::Refinements
+
+    def_delegators :@result_array, :each, :<<
+
+    attr_reader :created_at, :effective_at
+
+    ##
+    # Define a AIXM-Snapshot document
+    #
+    # Options:
+    # * +created_at+ - creation date (default: now)
+    # * +effective_at+ - snapshot effective after date (default: now)
+    def initialize(created_at: nil, effective_at: nil)
+      @created_at, @effective_at = created_at, effective_at
+      @result_array = []
+    end
+
+    ##
+    # Array of features defined by this document
+    def features
+      @result_array
+    end
+
+    ##
+    # Validate against the XSD and return an array of errors
+    def errors
+      xsd = Nokogiri::XML::Schema(File.open(AIXM::SCHEMA))
+      xsd.validate(Nokogiri::XML(to_xml))
+    end
+
+    ##
+    # Check whether the document is valid (extensions excluded)
+    def valid?
+      any? && reduce(true) { |b, f| b && f.valid? } && errors.none?
+    end
+
+    ##
+    # Render AIXM
+    #
+    # Extensions:
+    # * +:OFM+ - Open Flightmaps
+    def to_xml(*extensions)
+      now = Time.now.xmlschema
+      meta = {
+        'xmlns:xsi': 'http://www.aixm.aero/schema/4.5/AIXM-Snapshot.xsd',
+        version: '4.5',
+        origin: "AIXM #{AIXM::VERSION} Ruby gem",
+        created: @created_at&.xmlschema || now,
+        effective: @effective_at&.xmlschema || now
+      }
+      meta[:version] += ' + OFM extensions of version 0.1' if extensions.include?(:OFM)
+      builder = Builder::XmlMarkup.new(indent: 2)
+      builder.instruct!
+      builder.tag!('AIXM-Snapshot', meta) do |aixm_snapshot|
+        aixm_snapshot << @result_array.map { |f| f.to_xml(extensions) }.join.indent(2)
+      end
+    end
+
+  end
+end

data/lib/aixm/feature/airspace.rb

@@ -0,0 +1,74 @@
+module AIXM
+  module Feature
+    class Airspace
+
+      using AIXM::Refinements
+
+      attr_reader :name, :type
+      attr_reader :vertical_limits
+      attr_accessor :geometry, :remarks
+
+      ##
+      # Airspace feature
+      #
+      # Options:
+      # * +name+ - name of the airspace (will be converted to uppercase)
+      # * +type+ - airspace type (e.g. +TMA+ or +P+)
+      def initialize(name:, type:)
+        @geometry = AIXM::Geometry.new
+        @name, @type = name.upcase, type
+      end
+
+      ##
+      # Assign a +Vertical::Limits+ object
+      def vertical_limits=(value)
+        fail(ArgumentError, "invalid vertical limit") unless value.is_a?(AIXM::Vertical::Limits)
+        @vertical_limits = value
+      end
+
+      ##
+      # Check whether the airspace is valid
+      def valid?
+        name && type && vertical_limits && geometry.valid?
+      end
+
+      ##
+      # Digest to identify the payload
+      def to_digest
+        [name, type, vertical_limits.to_digest, geometry.to_digest, remarks].to_digest
+      end
+
+      ##
+      # Render AIXM
+      #
+      # Extensions:
+      # * +:OFM+ - Open Flightmaps
+      def to_xml(*extensions)
+        mid = to_digest
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.Ase(extensions.include?(:OFM) ? { xt_classLayersAvail: false } : {}) do |ase|
+          ase.AseUid(extensions.include?(:OFM) ? { mid: mid, newEntity: true } : { mid: mid }) do |aseuid|
+            aseuid.codeType(type)
+            aseuid.codeId(mid)   # TODO: verify
+          end
+          ase.txtName(name)
+          ase << vertical_limits.to_xml(extensions).indent(2)
+          ase.txtRmk(remarks) if remarks
+          if extensions.include?(:OFM)
+            ase.xt_txtRmk(remarks)
+            ase.xt_selAvail(false)
+          end
+        end
+        builder.Abd do |abd|
+          abd.AbdUid do |abduid|
+            abduid.AseUid(extensions.include?(:OFM) ? { mid: mid, newEntity: true } : { mid: mid }) do |aseuid|
+              aseuid.codeType(type)
+              aseuid.codeId(mid)   # TODO: verify
+            end
+          end
+          abd << geometry.to_xml(extensions).indent(2)
+        end
+      end
+    end
+  end
+end

data/lib/aixm/geometry.rb

@@ -0,0 +1,71 @@
+module AIXM
+  class Geometry
+
+    include Enumerable
+    extend Forwardable
+    using AIXM::Refinements
+
+    def_delegators :@result_array, :each, :<<
+
+    ##
+    # Define a shape (horizontal geometry) which is either exactly one
+    # +AIXM::Horizontals::Circle+ or any number of +AIXM::Horizontals::Point+,
+    # +::Arc+ and +::Border+.
+    #
+    # Example 1:
+    #   geometry = AIXM::Geometry.new(
+    #     AIXM::Horizontals::Point(...),
+    #     AIXM::Horizontals::Point(...)
+    #   )
+    #
+    # Example 2:
+    #   geometry = AIXM::Geometry.new
+    #   geometry << AIXM::Horizontals::Point(...)
+    #   geometry << AIXM::Horizontals::Point(...)
+    def initialize(*horizontals)
+      @result_array = horizontals
+    end
+
+    ##
+    # Array of +AIXM::Horizontal::...+ objects
+    def horizontals
+      @result_array
+    end
+
+    ##
+    # Check whether the geometry is valid
+    def valid?
+      circle? || closed_shape?
+    end
+
+    ##
+    # Digest to identify the payload
+    def to_digest
+      horizontals.map(&:to_digest).to_digest
+    end
+
+    ##
+    # Render AIXM
+    #
+    # Extensions:
+    # * +:OFM+ - Open Flightmaps
+    def to_xml(*extensions)
+      @result_array.map { |h| h.to_xml(extensions) }.join
+    end
+
+    private
+
+    def circle?
+      @result_array.size == 1 &&
+        @result_array.first.is_a?(AIXM::Horizontal::Circle)
+    end
+
+    def closed_shape?
+      @result_array.size >= 3 &&
+        !@result_array.any? { |h| h.is_a?(AIXM::Horizontal::Circle) } &&
+        @result_array.last.is_a?(AIXM::Horizontal::Point) &&
+        @result_array.first.xy == @result_array.last.xy
+    end
+
+  end
+end