aixm 0.1.0 → 0.1.3

checksums.yaml

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

data/CHANGELOG.md

@@ -1,6 +1,33 @@
+## 0.1.3
+
+* Breaking major changes:
+  * Re-organization of classes in features and components
+* Additions:
+  * Shortcut initializers e.g. `AIXM.airspace(...)`
+
+## 0.1.2
+
+* Breaking additions:
+  * Class layers
+* Breaking minor changes:
+  * Use `document.features << (feature)` instead of `document << (feature)`
+
+## 0.1.1
+
+* Additions:
+  * Schedule (all but `TIMSH`)
+  * Refinement `Float#to_km` and `String#uptrans`
+  * Shortcut constants `AIXM::UNLIMITED` and `AIXM::H24`
+  * `Airspace#short_name`
+* Minor changes:
+  * `Document#created_at` and `#effective_at` accept Time, Date, String or *nil*
+  * Separate `AIXM::Document#valid?` from `#complete?`
+  * Write coordinates in DD if extension `:OFM` is set
+  * `Array#to_digest` returns Integer which fits in signed 32bit
+
 ## 0.1.0
 
-* Initial implementation to import D/R/P zones to OFM
+* Initial implementation to import D/R/P zones to OFM:
   * XY Coordinate
   * Z Altitude
   * AIXM-Snapshot 4.5 Document
@@ -11,4 +38,5 @@
     * Arc
     * Border
     * Circle
+  * Shortcut constant `AIXM::GROUND`
   * Refinements

data/Guardfile

@@ -3,5 +3,5 @@ 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' }
+  watch(%r{^spec/(spec_helper|factory)\.rb}) { 'spec' }
 end

data/README.md

@@ -2,7 +2,7 @@
 [![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)
+[![Donorbox](https://img.shields.io/badge/donate-on_donorbox-yellow.svg)](https://donorbox.org/bitcetera)
 
 # AIXM
 
@@ -14,11 +14,12 @@ 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)
+* [API](http://www.rubydoc.info/gems/aixm)
 * Author: [Sven Schwyn - Bitcetera](http://www.bitcetera.com)
 
 ## Install
 
-Add this to your <tt>Gemfile</tt>:
+Add this to your `Gemfile`:
 
 ```ruby
 gem aixm
@@ -26,29 +27,131 @@ gem aixm
 
 ## Usage
 
-### Types
+You can initialize all elements either traditionally or by use of shorter
+AIXM class methods:
+
+```ruby
+AIXM::Feature::Airspace.new(...)
+AIXM.airspace(...)
+```
+
+### Fundamentals
+
+All fundamentals are bundled at the root of the module `AIXM`.
+
+### Document
+
+The document is the root container of the AIXM snapshot file to be generated.
+It's essentially a collection of features:
+
+```ruby
+document = AIXM.document(created_at: Time.now, effective_at: Time.now)
+document.features << AIXM.airspace(...)
+```
+
+To give an overview of the AIXM building blocks, the remainder of this guide
+will list initializer arguments with colons (`name: class`) and attribute
+writers with equal or push signs (`name = class` or `name << class`):
+
+* AIXM.document
+  * created_at: Time, Date or String
+  * effective_at: Time, Date or String
+  * features << AIXM::Feature
+
+See [the API documentation](http://www.rubydoc.info/gems/aixm) for details and
+[spec/factory.rb](https://github.com/svoop/aixm/blob/master/spec/factory.rb) for
+examples.
 
 #### 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)
+AIXM.xy(lat: %q(11°22'33.44"), long: %q(-111°22'33.44"))
+AIXM.xy(lat: '112233.44N', long: '1112233.44W')
+AIXM.xy(lat: 11.375955555555556, long: -111.37595555555555)
 ```
 
-#### Altitude
+#### Altitude and Heights
+
+Altitudes and heights exist in three different forms:
 
 ```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
+AIXM.z(alt: 1000, code: :QFE)   # height: 1000ft above ground
+AIXM.z(alt: 2000, code: :QNH)   # altitude: of 2000ft above mean sea level
+AIXM.z(alt: 45, code: :QNE)     # altitude: flight level 45
 ```
 
-### Document
+### Features
+
+All features are subclasses of `AIXM::Feature`.
+
+#### Airspace
+
+* AIXM.airspace
+  * name: String
+  * short_name: String or *nil*
+  * type: String or Symbol
+  * schedule = AIXM.schedule
+  * geometry << AIXM.point, AIXM.arc, AIXM.border or AIXM.circle
+  * class_layers << AIXM.class_layer
+  * remarks = String
+
+### Components
+
+All components are subclasses of `AIXM::Component`.
+
+#### Schedule
 
-See <tt>spec/factory.rb</tt> for examples.
+* AIXM.schedule
+  * code: String or Symbol
+
+#### Class Layer
+
+* AIXM.class_layer
+  * class: String or *nil*
+  * vertical_limits: AIXM.vertical_limits
+
+#### Vertical Limits
+
+* AIXM.vertical_limits
+  * max_z: AIXM.z or *nil*
+  * upper_z: AIXM.z
+  * lower_z: AIXM.z
+  * min_z: AIXM.z or *nil*
+
+#### Point, Arc, Border and Circle
+
+* AIXM.point
+  * xy: AIXM.xy
+* AIXM.arc
+  * xy: AIXM.xy
+  * center_xy: AIXM.xy
+  * cloclwise: *true* or *false*
+* AIXM.border
+  * xy: AIXM.xy
+  * name: String
+* AIXM.circle
+  * center_xy: AIXM.xy
+  * radius: Numeric
+
+#### Geometry
+
+* AIXM.geometry
+  * << AIXM.point, AIXM.arc, AIXM.border or AIXM.circle
+
+For a geometry to be complete, it must be comprised of either:
+
+* exactly one circle
+* at least three points, arcs or borders (the last of which a point with
+  identical coordinates as the first)
+
+## Validation
+
+* Use `AIXM::Document#complete?` to check whether all mandatory information is
+present. Airspaces, geometries etc have `complete?` methods as well.
+* Use `AIXM::Document#valid?` to validate the resulting AIXM against the XSD
+schema. If any, you find the errors in `AIXM::Document#errors`.
 
 ## Rendering
 
@@ -59,16 +162,33 @@ document.to_xml(:OFM)   # render AIXM 4.5 + OFM extensions XML
 
 ## Constants
 
-* <tt>AIXM::GROUND</tt> - height: 0ft above ground
+* `AIXM::GROUND` - height: 0ft above ground
+* `AIXM::UNLIMITED` - altitude: FL 999
+* `AIXM::H24` - continuous schedule
 
 ## 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
+* `String#indent(number)`<br>Indent every line of a string with *number* spaces
+* `String#uptrans`<br>upcase and transliterate to match the reduced character set for names
+* `String#to_dd`<br>Convert DMS angle to DD or `nil` if the format is not recognized
+* `Float#to_dms(padding)`<br>Convert DD angle to DMS with the degrees zero padded to *padding* length
+* `Float#trim`<br>Convert whole numbers to Integer and leave all other untouched
+* `Float#to_km(from: unit)`<br>Convert a distance from *unit* (:km, :m, :nm or :ft) to km
+
+## Extensions
+
+### OFM
+
+This extension adds proprietary tags and attributes (most of which are prefixed
+with `xt_`) aiming to improve importing the resulting AIXM into the OFM
+originative suite:
+
+* `<AIXM-Snapshot version="4.5 + OFM extensions of version 0.1" (...) />`<br>root node with extended version string
+* `<Ase xt_classLayersAvail="(true|false)">`<br>true when multiple class layers and therefore an Adg-node is present
+* `<xt_selAvail>(true|false)</xt_selAvail>`<br>enables conditional airspaces feature
+* `<AseUid newEntity="(true|false)">`<br>tell the importer whether adding a new or updating an existing entity
 
 ## References
 
@@ -76,6 +196,15 @@ By `using AIXM::Refinements` you get the following general purpose methods:
 * [AIXM on Wikipedia](https://en.wikipedia.org/wiki/AIXM)
 * [Open Flightmaps](https://openflightmaps.org)
 
+## Tests
+
+Some tests are very time consuming and therefore skipped by default. To run the
+full test suite, set the environment variable:
+
+```
+export SPEC_SCOPE=all
+```
+
 ## Development
 
 To install the development dependencies and then run the test suite:

data/aixm.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.homepage      = 'https://github.com/svoop/aixm'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.5'
+  
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'

data/lib/aixm.rb

@@ -6,20 +6,22 @@ require 'digest'
 require 'time'
 
 require_relative 'aixm/version'
-
 require_relative 'aixm/refinements'
 
+require_relative 'aixm/document'
 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/component/base'
+require_relative 'aixm/component/geometry'
+require_relative 'aixm/component/geometry/point'
+require_relative 'aixm/component/geometry/arc'
+require_relative 'aixm/component/geometry/border'
+require_relative 'aixm/component/geometry/circle'
+require_relative 'aixm/component/class_layer'
+require_relative 'aixm/component/vertical_limits'
+require_relative 'aixm/component/schedule'
 
 require_relative 'aixm/feature/airspace'
+
+require_relative 'aixm/shortcuts'

data/lib/aixm/component/base.rb

@@ -0,0 +1,6 @@
+module AIXM
+  module Component
+    class Base
+    end
+  end
+end

data/lib/aixm/component/class_layer.rb

@@ -0,0 +1,49 @@
+module AIXM
+  module Component
+
+    ##
+    # Class layers consists of an optional airspace class and mandatory
+    # vertical limits.
+    class ClassLayer < Base
+      using AIXM::Refinements
+
+      CLASSES = %i(A B C D E F G)
+
+      attr_reader :vertical_limits
+
+      def initialize(class: nil, vertical_limits:)
+        @klass, @vertical_limits = binding.local_variable_get(:class)&.to_sym, vertical_limits
+        fail(ArgumentError, "invalid class `#{@klass}'") unless @klass.nil? || CLASSES.include?(@klass)
+        fail(ArgumentError, "invalid vertical limits") unless @vertical_limits.is_a? AIXM::Component::VerticalLimits
+      end
+
+      ##
+      # Read the airspace class
+      #
+      # This and other workarounds in the initializer are necessary due to "class"
+      # being a reserved keyword in Ruby.
+      def class
+        @klass
+      end
+
+      ##
+      # Digest to identify the payload
+      def to_digest
+        [self.class, vertical_limits.to_digest].to_digest
+      end
+
+      ##
+      # Render AIXM
+      #
+      # Extensions:
+      # * +:OFM+ - Open Flightmaps
+      def to_xml(*extensions)
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.codeClass(self.class.to_s) if self.class
+        builder << vertical_limits.to_xml(*extensions)
+        builder.target!   # see https://github.com/jimweirich/builder/issues/42
+      end
+    end
+
+  end
+end

data/lib/aixm/component/geometry.rb

@@ -0,0 +1,73 @@
+module AIXM
+  module Component
+
+    ##
+    # Geometries define a 3D airspace horizontally. It's either exactly one
+    # circle or at least three points, arcs and borders (the last of which
+    # has to be a point with the same coordinates as the first).
+    #
+    # Example 1:
+    #   geometry = AIXM.geometry(
+    #     AIXM.point(...),
+    #     AIXM.point(...)
+    #   )
+    #
+    # Example 2:
+    #   geometry = AIXM.geometry
+    #   geometry << AIXM.point(...)
+    #   geometry << AIXM.point(...)
+    class Geometry < Base
+      include Enumerable
+      extend Forwardable
+      using AIXM::Refinements
+
+      def_delegators :@result_array, :each, :<<
+
+      def initialize(*segments)
+        @result_array = segments
+      end
+
+      ##
+      # Array of +AIXM::Component::Geometry::...+ objects
+      def segments
+        @result_array
+      end
+
+      ##
+      # Check whether the geometry is complete
+      def complete?
+        circle? || closed_shape?
+      end
+
+      ##
+      # Digest to identify the payload
+      def to_digest
+        segments.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::Component::Geometry::Circle)
+      end
+
+      def closed_shape?
+        @result_array.size >= 3 &&
+          !@result_array.any? { |h| h.is_a?(AIXM::Component::Geometry::Circle) } &&
+          @result_array.last.is_a?(AIXM::Component::Geometry::Point) &&
+          @result_array.first.xy == @result_array.last.xy
+      end
+    end
+
+  end
+end