aixm 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf1e96e454dba0f43522ac3f8253c34a4f5b209498b410449521b2f9f935f624
-  data.tar.gz: ad46225ec28030c43792f854bf1b1bfe4197217c5d45a5400a1e1f74ffa3c2ca
+  metadata.gz: c0f5f953610761dad1816bb0a390155538205afc41fc53d677f9d433a53de5f6
+  data.tar.gz: ba6b9edea4dc9ffe27239021f28fb3b2cb816bba568286f0108bf070a7108a73
 SHA512:
-  metadata.gz: 672feb31e6a816e8d9c38a2f491833464d669c58f1ccec81ef776f449a3573eea31a263b822e1a88f70f80ea8864865f3c4127df16433f3d5d66430e6b6df93f
-  data.tar.gz: 81b8b9e9dcd1cf088607380915adaa08cac8a43b4837fe124f47ef81dc4a2de428f5babfb6e64efe6c14961652bbf60c0242c3fd56bcc8c1974aa1bc97b9afb1
+  metadata.gz: b0947e0e79962e86e21f96833d47944c012fd1be4fa28a2fbf1aa3d82e2549195bafdcb32d9b3e6fd65f8f63ede53000d7218c6afaa5393549768d1ad0d6b569
+  data.tar.gz: 4358cb754979f06efd3c62d0288a41db984573d6de47f021c585ab056f801c71de480c1258969eeed33db287cc13137355c016f7e911c91e555a499067d9f15c

data/.gitignore

@@ -3,3 +3,4 @@ Gemfile.lock
 pkg/*
 *.gem
 .bundle
+.yardoc

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.0
+ruby-2.5.1

data/.yardopts

@@ -0,0 +1,3 @@
+--no-private
+lib/**/*.rb -
+README.md CHANGELOG.md LICENSE.txt

data/CHANGELOG.md

@@ -1,45 +1,65 @@
+## 0.3.0
+
+* Breaking additions:
+  * Global configuration with `AIXM.config`
+* Breaking changes:
+  * Switch from "AIXM with OFM extensions" to OFMX
+  * `to_aixm` renamed to `to_xml` again
+  * Removed signature `to_xml(extension)` in favor of `AIXM.schema`
+  * Removed `Array#to_digest`
+  * Removed `Document#complete?`
+  * Renamed Schedule to Timetable
+  * Timetable and remarks moved from Airspace to to Layer (formerly known as
+    class layer)
+* Additions
+  * Organization and Unit features
+  * Airport feature
+  * Refinement `Float#to_rad`
+  * Distance calculation with `AIXM::XY#distance`
+  * `Schedule#remarks`
+
 ## 0.2.3
 
-* Breaking minor changes:
+* Breaking changes:
   * VOR types renamed from :vor to :conventional and :doppler_vor to :doppler
   * NBR types added
   * Marker types added
-* Minor changes:
+* Changes:
   * "mid" attributes on all navigational aid features
 
 ## 0.2.2
 
-* Minor changes:
+* Changes:
   * Bad error classes fixed
   * Allow navigational aids without name
 
 ## 0.2.1
 
-* Major changes:
+* Breaking changes:
   * DVOR and VORDME confusion fixed
-  * Schedule added to navigational aids
   * VOR can be associated with DME (-> VOR/DME) or TACAN (-> VORTAC) now
   * `to_xml` renamed to `to_aixm` everywhere
-* Minor changes:
   * Removed :other from all value lists
+* Changes:
+  * Schedule added to navigational aids
 
 ## 0.2.0
 
+* Breaking changes:
+  * Symbols such as :qnh, :ofm or :mhz are downcased now
 * Additions:
   * Frequency
-  * Navigational aids
+  * Navigational aids features
   * `AIXM::Z#qfe?` and friends
-* Breaking major changes:
-  * Symbols such as :qnh, :ofm or :mhz are downcased now
 
 ## 0.1.4
 
-* Breaking minor changes:
+* Breaking changes:
   * `AIXM.z(alt: 123, code: :QNE)` is now `AIXM.z(123, :QNE)`
 
 ## 0.1.3
 
-* Breaking major changes:
+* Breaking changes:
   * Re-organization of classes in features and components
 * Additions:
   * Shortcut initializers e.g. `AIXM.airspace(...)`
@@ -48,7 +68,7 @@
 
 * Breaking additions:
   * Class layers
-* Breaking minor changes:
+* Breaking changes:
   * Use `document.features << (feature)` instead of `document << (feature)`
 
 ## 0.1.1
@@ -58,7 +78,7 @@
   * Refinement `Float#to_km` and `String#uptrans`
   * Shortcut constants `AIXM::UNLIMITED` and `AIXM::H24`
   * `Airspace#short_name`
-* Minor changes:
+* 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
@@ -70,7 +90,7 @@
   * XY Coordinate
   * Z Altitude
   * AIXM-Snapshot 4.5 Document
-  * Airspace
+  * Airspace feature
   * Vertical Limits
   * Geometry
     * Point

data/Guardfile

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

data/README.md

@@ -6,9 +6,9 @@
 
 # AIXM
 
-Partial implementation of the [Aeronautical Information Exchange Model (AIXM 4.5)](http://aixm.aero) for Ruby.
+Partial implementation of the [Aeronautical Information Exchange Model (AIXM 4.5)](http://aixm.aero) and it's dialect [Open FlightMaps eXchange format (OFMX 0)](https://github.com/openflightmaps/ofmx) 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.
+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 for snapshot files and does not parse them.
 
 * [Homepage](https://github.com/svoop/aixm)
 * [API](http://www.rubydoc.info/gems/aixm)
@@ -24,293 +24,100 @@ gem aixm
 
 ## Usage
 
-You can initialize all elements either traditionally or by use of shorter AIXM class methods:
+Here's how to build a document object, populate it with a simple feature and then render it as AIXM:
 
 ```ruby
-AIXM.airspace(...)
-AIXM.airspace(...)
-```
-
-### Fundamentals
-
-All fundamentals are subclasses of `AIXM::Base`.
-
-### 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 you an overview of the AIXM building blocks, the remainder of this guide will use pseudo code to describe the initializer arguments, writer methods etc:
-
-```ruby
-document = AIXM.document(
-  created_at: Time or Date or String
-  effective_at: Time or Date or String
-)
-document.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(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 and Heights
-
-Altitudes and heights exist in three different forms:
-
-```ruby
-AIXM.z(1000, :qfe)   # height: 1000ft above ground
-AIXM.z(2000, :qnh)   # altitude: of 2000ft above mean sea level
-AIXM.z(45, :qne)     # altitude: flight level 45
-```
-
-#### Frequency
-
-```ruby
-AIXM.f(123.35, :mhz)
-```
-
-### Features
-
-All features are subclasses of `AIXM::Feature::Base`.
-
-#### Airspace
-
-```ruby
-airspace = AIXM.airspace(
-  name: String
-  short_name: String or nil
-  type: String or Symbol
-)
-airspace.schedule = AIXM.schedule
-airspace.geometry << AIXM.point or AIXM.arc or AIXM.border or AIXM.circle
-airspace.class_layers << AIXM.class_layer
-airspace.remarks = String
-```
-
-#### Navigational Aids
-
-##### Designated Point
-
-```ruby
-designated_point = AIXM.designated_point(
-  id: String
-  name: String or nil
-  xy: AIXM.xy
-  z: AIXM.z or nil
-  type: :icao or :adhp, or :coordinates
-)
-designated_point.schedule = AIXM.schedule
-designated_point.remarks = String
-```
-
-##### DME
-
-```ruby
-dme = AIXM.dme(
-  id: String
-  name: String
-  xy: AIXM.xy
-  z: AIXM.z or nil
-  channel: String
-)
-dme.schedule = AIXM.schedule
-dme.remarks = String
-```
-
-##### NDB
-
-```ruby
-ndb = AIXM.ndb(
-  id: String
-  name: String
-  xy: AIXM.xy
-  z: AIXM.z or nil
-  type: :en_route, :locator or :marine
-  f: AIXM.f
-)
-ndb.schedule = AIXM.schedule
-ndb.remarks = String
-```
-
-##### Marker
-
-WARNING: Marker are not fully implemented because they usually have to be
-associated with ILS which are not yet implemented.
-
-```ruby
-marker = AIXM.marker(
-  id: String
-  name: String
-  xy: AIXM.xy
-  z: AIXM.z or nil
-  type: :outer, :middle, :inner or :backcourse
-)
-marker.schedule = AIXM.schedule
-marker.remarks = String
-```
-
-##### TACAN
-
-```ruby
-tacan = AIXM.tacan(
-  id: String
-  name: String
-  xy: AIXM.xy
-  z: AIXM.z or nil
-  channel: String
-)
-tacan.schedule = AIXM.schedule
-tacan.remarks = String
-```
-
-##### VOR
-
-```ruby
-vor = AIXM.vor(
-  id: String
-  name: String
-  xy: AIXM.xy
-  z: AIXM.z or nil  
-  type: :conventional or :doppler
-  f: AIXM.f
-  north: :geographic or :grid or :magnetic
-)
-vor.schedule = AIXM.schedule
-vor.remarks = String
-vor.associate_dme(channel: String)     # turns the VOR into a VOR/DME
-vor.associate_tacan(channel: String)   # turns the VOR into a VORTAC
-```
-
-### Components
-
-All components are subclasses of `AIXM::Component::Base`.
-
-#### Schedule
-
-```ruby
-schedule = AIXM.schedule(
-  code: String or Symbol
+document = AIXM.document
+document.features << AIXM.designated_point(
+  id: "ABIXI",
+  xy: AIXM.xy(lat: %q(46°31'54.3"N), long: %q(002°19'55.2"W)),
+  type: :icao
 )
+document.aixm!   # not really necessary since AIXM is the default schema
+document.to_xml
 ```
 
-#### Class Layer
+You can initialize all elements either traditionally or by use of shorter AIXM class methods. The following two statements are identical:
 
 ```ruby
-class_layer = AIXM.class_layer(
-  class: String or nil
-  vertical_limits: AIXM.vertical_limits
-)
+AIXM::Feature::NavigationalAid::DesignatedPoint.new(...)
+AIXM.designated_point(...)
 ```
 
-#### Vertical Limits
+## Configuration
 
-```ruby
-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
+The following configuration options are available for setting and getting:
 
 ```ruby
-point = AIXM.point(
-  xy: AIXM.xy
-)
-arc = AIXM.arc(
-  xy: AIXM.xy
-  center_xy: AIXM.xy
-  cloclwise: true or false
-)
-border = AIXM.border(
-  xy: AIXM.xy
-  name: String
-)
-circle = AIXM.circle(
-  center_xy: AIXM.xy
-  radius: Numeric
-)
+AIXM.config.schema           # either :aixm (default) or :ofmx
+AIXM.config.region           # fallback region
+AIXM.config.ignored_errors   # ignore XML schema errors which match this regex
 ```
 
-#### Geometry
+There are shortcuts to set and get the schema:
 
 ```ruby
-geometry = AIXM.geometry
-geometry << AIXM.point or AIXM.arc or AIXM.border or AIXM.circle
+AIXM.schema             # => :aixm
+AIXM.aixm?              # => true
+AIXM.ofmx!              # => :ofmx
+AIXM.ofmx?              # => true
+AIXM.schema             # => :ofmx
+AIXM.schema(:version)   # => 0
 ```
 
-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`. Since the data model is not fully implemented, some associations cannot be assigned and have to be left empty. The resulting validation errors are silently ignored:
-
-* OrgUid - organizations may be empty tags
+`AIXM::Document#valid?` validates the resulting AIXM or OFMX against its XML schema. If any, you find the errors in `AIXM::Document#errors`.
 
-## Rendering
+## Model
 
-```ruby
-document.to_aixm         # render AIXM 4.5 compliant XML
-document.to_aixm(:ofm)   # render AIXM 4.5 + OFM extensions XML
-```
+### Fundamentals
+* [Document](http://www.rubydoc.info/gems/aixm/AIXM/Document.html)
+* [XY (longitude and latitude)](http://www.rubydoc.info/gems/aixm/AIXM/XY.html)
+* [Z (height, elevation or altitude)](http://www.rubydoc.info/gems/aixm/AIXM/Z.html)
+* [F (frequency)](http://www.rubydoc.info/gems/aixm/AIXM/F.html)
 
-## Constants
+### Features
+* [Organisation](http://www.rubydoc.info/gems/aixm/AIXM/Feature/Organisation.html)
+* [Unit](http://www.rubydoc.info/gems/aixm/AIXM/Feature/Unit.html)
+* [Airport](http://www.rubydoc.info/gems/aixm/AIXM/Feature/Airport.html)
+* [Airspace](http://www.rubydoc.info/gems/aixm/AIXM/Feature/Airspace.html)
+* [Navigational aid](http://www.rubydoc.info/gems/aixm/AIXM/NavigationalAid.html)
+  * [Designated point](http://www.rubydoc.info/gems/aixm/AIXM/Feature/DesignatedPoint.html)
+  * [DME](http://www.rubydoc.info/gems/aixm/AIXM/Feature/DME.html)
+  * [Marker](http://www.rubydoc.info/gems/aixm/AIXM/Feature/Marker.html)
+  * [NDB](http://www.rubydoc.info/gems/aixm/AIXM/Feature/NDB.html)
+  * [TACAN](http://www.rubydoc.info/gems/aixm/AIXM/Feature/TACAN.html)
+  * [VOR](http://www.rubydoc.info/gems/aixm/AIXM/Feature/VOR.html)
 
-* `AIXM::GROUND` - height: 0ft above ground
-* `AIXM::UNLIMITED` - altitude: FL 999
-* `AIXM::H24` - continuous schedule
+### Components
+* [Service](http://www.rubydoc.info/gems/aixm/AIXM/Component/Service.html)
+* [Frequency](http://www.rubydoc.info/gems/aixm/AIXM/Component/Frequency.html)
+* [Geometry](http://www.rubydoc.info/gems/aixm/AIXM/Component/Geometry.html)
+  * [Point](http://www.rubydoc.info/gems/aixm/AIXM/Component/Point.html)
+  * [Arc](http://www.rubydoc.info/gems/aixm/AIXM/Component/Arc.html)
+  * [Border](http://www.rubydoc.info/gems/aixm/AIXM/Component/Border.html)
+  * [Circle](http://www.rubydoc.info/gems/aixm/AIXM/Component/Circle.html)
+* [Runway](http://www.rubydoc.info/gems/aixm/AIXM/Component/Runway.html)
+* [Helipad](http://www.rubydoc.info/gems/aixm/AIXM/Component/Helipad.html)
+* [Layer](http://www.rubydoc.info/gems/aixm/AIXM/Component/Layer.html)
+* [Vertical limits](http://www.rubydoc.info/gems/aixm/AIXM/Component/VerticalLimits.html)
+* [Timetable](http://www.rubydoc.info/gems/aixm/AIXM/Component/Timetable.html)
 
 ## Refinements
 
-By `using AIXM::Refinements` you get the following general purpose methods:
-
-* `Hash#lookup(key, default)`<br>Similar to `fetch` but falls back to values
-* `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
-
-See the [source code](https://github.com/svoop/aixm/blob/master/lib/aixm/refinements.rb) for more explicit descriptions and examples.
-
-## 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
+By `using AIXM::Refinements` you get a few handy [extensions to Ruby core classes](http://www.rubydoc.info/gems/aixm/AIXM/Refinements.html).
 
 ## References
 
+### AIXM
 * [AIXM](http://aixm.aero)
-* [AIXM on Wikipedia](https://en.wikipedia.org/wiki/AIXM)
+* [AICM 4.5 Documentation](https://openflightmaps.github.io/ofmx/aixm/4.5/manual/aicm/)
 * [AIXM 4.5 Specification](http://aixm.aero/document/aixm-45-specification)
-* [AICM 4.5 Entity-Relationship](https://www.ead.eurocontrol.int/SystemHelp/mergedProjects/SDO/aixm/)
+
+### OFMX
+* [OFMX](https://github.com/openflightmaps/ofmx)
+* [OFMX Documentation](https://github.com/openflightmaps/ofmx/wiki)
 * [Open Flightmaps](https://openflightmaps.org)
 
 ## Tests