aixm 0.3.8 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca15626c3948c7f7914face0ccef421502a3b9103bba33bb9f8197696f083a2c
-  data.tar.gz: 8cd271b55758819f0593be1150d4a88484717a0221467c532f852aa011b270a9
+  metadata.gz: e3f6bbccc417b5489c0406281f074c0e2ba763681f2ba93eecce13fc4512a5a3
+  data.tar.gz: 2ee3415fd70d683ed60911ddb78f3cd2fa2277aaeea5546cb3e22ab1c22b2d73
 SHA512:
-  metadata.gz: edee618c607d2e67ac4705a26ff4401f6479958ba84313f9fffc0ca8a3003f3110e8ddfe6a877333c2f29395eaa85cfdf3245c57bd4f3867d8bf48d26f1dc112
-  data.tar.gz: 60fe778dcbf871980ce4b477819be4e1d8a8b4e055365c00837dab226646b714b40f42edd40906acc9726f0f9cd29b4144a1a7506538349ef7e8bb5743146509
+  metadata.gz: c8105e111e3ee60f5ad28b99a2beccd05ce719297c9bb836cca7742dc4b6dec6187fd3cc32b2f09d3924deea35e863329350ca02db869079a2a0f0855a60a6d5
+  data.tar.gz: 5d620f1fb1d47d8a8e6f542029bba5e29d31db796baa6dba3c418d8aef0a6dd75e8996c95d68fa5f45187aae66119bf765af9ebc9d304c8179287c1bb395927c

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+��*;^ь�G�`��ِ.�%o+�����Z�P[~fRs��O7�ߘn(�8�.Yg����9�EV��&Et���ט�97��0�`�ɨ���lxtl����_;���ٮa�EO��@V��g���|H�n�lb7�J���'����Ui4%@J"�(_�ذ���#

data/CHANGELOG.md

@@ -1,7 +1,37 @@
+## 0.3.10
+
+### Additions
+* Proper `has_many` and `has_one` associations
+* `AIXM::Association:Array#find_by|find|duplicate` on `has_many` associations
+* `AIXM.config.mid` now defines whether `mid` attributes are inserted or not
+  provided the selected schema is OFMX
+* `AIXM::Memoize` module
+* `AIXM::PayloadHash` class
+* `mkmid` executable to insert `mid` attributes into valid OFMX file
+* `ckmid` executable to check `mid` attributes in an OFMX file
+* `AIXM::Component::Geometry#point?|circle?|polygon?`
+* `AIXM::Component::Layer#services`
+
+### Breaking Changes
+* Require Ruby 2.7
+* Moved `region` attribute from `Document` back to features again
+* Use `Document#add_feature` instead of `Document@features#<<`
+* Use `Document@features#find` instead of `Document#select_features`
+* Use `Airspace#add_layer` instead of `Airspace@layers#<<`
+* Use `Geometry#add_segment` instead of `Geometry#<<`
+* Renamed `VerticalLimits` to `VerticalLimit`
+* Moved `AIXM::Feature::Service` to `AIXM::Component::Service`
+* Refinements `String#insert_payload_hash` and `Array#to_uuid` removed again
+* Refinement `String#payload_hash` removed in favor of `AIXM::PayloadHash` class
+* Refinements `Array#find|duplicates` removed
+
+### Changes
+* Renamed `AIXM.config.mid_region` to `AIXM.config.region`
+
 ## 0.3.8
 
 #### Additions
-* `AIXM.config.mid_region` to generate `mid` attributes on all features
+* `AIXM.config.mid_region` to insert `mid` attributes
 * Refinement `String#insert_payload_hash`
 
 #### Changes
@@ -48,7 +78,7 @@
 * Surface for `Runway|Helipad#surface`
 * Extracted `AIXM::MIN`, `AIXM::SEC` and `AIXM::DMS_RE` to scan for coordinates
   in texts
-* Refinement `String#payload_hash`
+* Refinements `Array#to_uuid` and `String#payload_hash`
 
 #### Breaking Changes
 * Require Ruby 2.6
@@ -94,7 +124,7 @@
 #### Breaking Changes
 * Renamed `Airport#code` to `Airport#id`
 * Renamed `Airspace#short_name` to `Airspace#local_type`
-* Moved `region` attribute from features to Document
+* Moved `region` attribute from features to `Document`
 
 #### Changes
 * Be more permissive on `Airport#id` in order to accomodate generated codes

data/README.md

@@ -1,38 +1,66 @@
 [![Version](https://img.shields.io/gem/v/aixm.svg?style=flat)](https://rubygems.org/gems/aixm)
-[![Tests](https://github.com/svoop/aixm/workflows/Test/badge.svg)](https://github.com/svoop/aixm/actions?workflow=Test)
+[![Tests](https://img.shields.io/github/workflow/status/svoop/aixm/Test.svg?style=flat&label=tests)](https://github.com/svoop/aixm/actions?workflow=Test)
 [![Code Climate](https://img.shields.io/codeclimate/maintainability/svoop/aixm.svg?style=flat)](https://codeclimate.com/github/svoop/aixm/)
 [![Donorbox](https://img.shields.io/badge/donate-on_donorbox-yellow.svg)](https://donorbox.org/bitcetera)
 
 # AIXM
 
-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.
+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://gitlab.com/openflightmaps/ofmx/wikis) 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 for snapshot files and does not parse them.
 
 * [Homepage](https://github.com/svoop/aixm)
-* [API](http://www.rubydoc.info/gems/aixm)
+* [API](https://www.rubydoc.info/gems/aixm)
 * Author: [Sven Schwyn - Bitcetera](http://www.bitcetera.com)
 
 ## Install
 
-Add this to your <tt>Gemfile</tt> or <tt>gems.rb</tt>:
+### Security
+
+This gem is [cryptographically signed](https://guides.rubygems.org/security/#using-gems) in order to assure it hasn't been tampered with. Unless already done, please add the author's public key as a trusted certificate now:
+
+```
+gem cert --add <(curl -Ls https://raw.github.com/svoop/aixm/master/certs/svoop.pem)
+```
+
+### Bundler
+
+Add the following to the <tt>Gemfile</tt> or <tt>gems.rb</tt> of your [Bundler](https://bundler.io) powered Ruby project:
 
 ```ruby
 gem aixm
 ```
 
+And then install the bundle:
+
+```
+bundle install --trust-policy MediumSecurity
+```
+
+### Standalone
+
+If you're only going to use [the executables](#executables), make sure to have the [latest version of Ruby](https://www.ruby-lang.org/en/documentation/installation/) and then install this gem:
+
+```
+gem install aixm --trust-policy MediumSecurity
+```
+
 ## Usage
 
 Here's how to build a document object, populate it with a simple feature and then render it as AIXM:
 
 ```ruby
-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.document(
+  region: 'LF'
 )
-document.aixm!   # not really necessary since AIXM is the default schema
+document.add_feature(
+  AIXM.designated_point(
+    id: "ABIXI",
+    xy: AIXM.xy(lat: %q(46°31'54.3"N), long: %q(002°19'55.2"W)),
+    type: :icao
+  )
+)
+AIXM.ofmx!
 document.to_xml
 ```
 
@@ -66,15 +94,29 @@ AIXM.schema             # => :ofmx
 AIXM.schema(:version)   # => 0
 ```
 
-### AIXM.config.mid_region
+### AIXM.config.region
 
-In order to insert [OFMX-compliant `mid` attributes]() for all `*Uid` elements, set this configuration option to the OFMX region the element belongs to. By default, no `mid` attributes are inserted.
+The `:ofmx` schema requires the [region to be set on all core features](https://gitlab.com/openflightmaps/ofmx/wikis/Features#core-features). You can do so on individual features, however, you might want to configure a default region to simplify your life:
 
 ```ruby
-AIXM.config.mid_region          # => nil  - don't insert any mid attributes
-AIXM.config.mid_region = 'LF'   # => 'LF' - insert mid attributes for region LF
+AIXM.ofmx!
+AIXM.region = 'LF'
 ```
 
+:warning: This setting has no effect when using the `:aixm` schema.
+
+### AIXM.config.mid
+
+In order to insert [OFMX-compliant `mid` attributes](https://gitlab.com/openflightmaps/ofmx/wikis/Features#mid) into all `*Uid` elements, you have set the mid configuration option to `true`.
+
+```ruby
+AIXM.ofmx!
+AIXM.config.mid          # => false - don't insert mid attributes by default
+AIXM.config.mid = true   # => true  - insert mid attributes
+```
+
+:warning: This setting has no effect when using the `:aixm` schema.
+
 ### AIXM.config.ignored_errors
 
 In case you want to ignore certain XML schema validation errors, set this configuration option to a regular expression which matches the error messages to ignore. By default, no errors are ignored.
@@ -83,65 +125,133 @@ In case you want to ignore certain XML schema validation errors, set this config
 AIXM.config.ignored_errors = /invalid date/i
 ```
 
-## Validation
-
-`AIXM::Document#valid?` validates the resulting AIXM or OFMX against its XML schema. If any, you find the errors in `AIXM::Document#errors`.
-
-## Model
+## Models
 
 ### 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)
-* [D (distance or length)](http://www.rubydoc.info/gems/aixm/AIXM/D.html)
-* [F (frequency)](http://www.rubydoc.info/gems/aixm/AIXM/F.html)
-* [A (angle)](http://www.rubydoc.info/gems/aixm/AIXM/A.html)
+* [Document](https://www.rubydoc.info/gems/aixm/AIXM/Document.html)
+* [XY (longitude and latitude)](https://www.rubydoc.info/gems/aixm/AIXM/XY.html)
+* [Z (height, elevation or altitude)](https://www.rubydoc.info/gems/aixm/AIXM/Z.html)
+* [D (distance or length)](https://www.rubydoc.info/gems/aixm/AIXM/D.html)
+* [F (frequency)](https://www.rubydoc.info/gems/aixm/AIXM/F.html)
+* [A (angle)](https://www.rubydoc.info/gems/aixm/AIXM/A.html)
 
 ### Features
-* [Address](http://www.rubydoc.info/gems/aixm/AIXM/Feature/Address.html)
-* [Organisation](http://www.rubydoc.info/gems/aixm/AIXM/Feature/Organisation.html)
-* [Unit](http://www.rubydoc.info/gems/aixm/AIXM/Feature/Unit.html)
-* [Service](http://www.rubydoc.info/gems/aixm/AIXM/Component/Service.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)
-* [Obstacle and obstacle group](http://www.rubydoc.info/gems/aixm/AIXM/Feature/Obstacle.html)
+* [Address](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Address.html)
+* [Organisation](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Organisation.html)
+* [Unit](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Unit.html)
+* [Service](https://www.rubydoc.info/gems/aixm/AIXM/Component/Service.html)
+* [Airport](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Airport.html)
+* [Airspace](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Airspace.html)
+* [Navigational aid](https://www.rubydoc.info/gems/aixm/AIXM/NavigationalAid.html)
+  * [Designated point](https://www.rubydoc.info/gems/aixm/AIXM/Feature/DesignatedPoint.html)
+  * [DME](https://www.rubydoc.info/gems/aixm/AIXM/Feature/DME.html)
+  * [Marker](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Marker.html)
+  * [NDB](https://www.rubydoc.info/gems/aixm/AIXM/Feature/NDB.html)
+  * [TACAN](https://www.rubydoc.info/gems/aixm/AIXM/Feature/TACAN.html)
+  * [VOR](https://www.rubydoc.info/gems/aixm/AIXM/Feature/VOR.html)
+* [Obstacle and obstacle group](https://www.rubydoc.info/gems/aixm/AIXM/Feature/Obstacle.html)
 
 ### Components
-* [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)
-* [FATO](http://www.rubydoc.info/gems/aixm/AIXM/Component/FATO.html)
-* [Surface](http://www.rubydoc.info/gems/aixm/AIXM/Component/Surface.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)
+* [Frequency](https://www.rubydoc.info/gems/aixm/AIXM/Component/Frequency.html)
+* [Geometry](https://www.rubydoc.info/gems/aixm/AIXM/Component/Geometry.html)
+  * [Point](https://www.rubydoc.info/gems/aixm/AIXM/Component/Point.html)
+  * [Arc](https://www.rubydoc.info/gems/aixm/AIXM/Component/Arc.html)
+  * [Border](https://www.rubydoc.info/gems/aixm/AIXM/Component/Border.html)
+  * [Circle](https://www.rubydoc.info/gems/aixm/AIXM/Component/Circle.html)
+* [Runway](https://www.rubydoc.info/gems/aixm/AIXM/Component/Runway.html)
+* [Helipad](https://www.rubydoc.info/gems/aixm/AIXM/Component/Helipad.html)
+* [FATO](https://www.rubydoc.info/gems/aixm/AIXM/Component/FATO.html)
+* [Surface](https://www.rubydoc.info/gems/aixm/AIXM/Component/Surface.html)
+* [Layer](https://www.rubydoc.info/gems/aixm/AIXM/Component/Layer.html)
+* [Vertical limit](https://www.rubydoc.info/gems/aixm/AIXM/Component/VerticalLimit.html)
+* [Timetable](https://www.rubydoc.info/gems/aixm/AIXM/Component/Timetable.html)
+
+## Associations
+
+The different models are interwoven with [`has_many` and `has_one` associations](https://www.rubydoc.info/gems/aixm/AIXM/Association).
+
+Please note that `has_many` associations are instances `AIXM::Association::Array` which mostly behave like normal arrays. However, you must not add or remove elements on the array directly but use the corresponding method on the associating model instead:
+
+```ruby
+document.features << airport   # => NoMethodError
+document.add_feature airport   # okay
+```
+
+### find_by and find
+
+Use `find_by` on `has_many` to filter associations by class and optional attribute values:
+
+```ruby
+document.features.find_by(:airport)               # => [#<AIXM::Feature::Airport>, #<AIXM::Feature::Airport>]
+document.features.find_by(:airport, id: 'LFNT')   # => [#<AIXM::Feature::Airport>]
+```
+
+To search a `has_many` association for equal objects, use `find`:
+
+```ruby
+document.features.find(airport)   # => [#<AIXM::Feature::Airport>]
+```
+
+This may seem redundant at first, but keep in mind that two instances of +AIXM::CLASSES+ which implement `#to_uid` are considered equal if they are instances of the same class and both their UIDs as calculated by `#to_uid` are equal. Attributes which are not part of the `#to_uid` calculation are irrelevant!
+
+### duplicates
+
+Equally on `has_many` associations, use `duplicates` to find identical or equal associations:
+
+```ruby
+document.features.duplicates   # => [#<AIXM::Feature::Unit>, #<AIXM::Component::Service>, ...]
+```
+
+## Payload Hash
+
+OFMX defines a [payload hash function](https://gitlab.com/openflightmaps/ofmx/wikis/Functions) used to facilitate association and modification tracking. It is used internally, but you can also use it in your own code:
+
+```ruby
+# Payload hash of XML fragment string
+xml = '<xml><a></a></xml>'
+AIXM::PayloadHash.new(xml).to_uuid
+
+# Payload hash of Nokogiri XML fragment
+document = File.open("file.xml") { Nokogiri::XML(_1) }
+AIXM::PayloadHash.new(document).to_uuid
+```
+
+## Validation
+
+`AIXM::Document#valid?` validates the resulting AIXM or OFMX against its XML schema. If any, you find the errors in `AIXM::Document#errors`.
 
 ## Refinements
 
-By `using AIXM::Refinements` you get a few handy [extensions to Ruby core classes](http://www.rubydoc.info/gems/aixm/AIXM/Refinements.html).
+By `using AIXM::Refinements` you get a few handy [extensions to Ruby core classes](https://www.rubydoc.info/gems/aixm/AIXM/Refinements.html).
+
+## Executables
+
+### mkmid
+
+The `mkmid` executable reads an OFMX file, adds [OFMX-compliant `mid` values](https://gitlab.com/openflightmaps/ofmx/wikis/Features#mid) into all `*Uid` elements and validates the result against the schema.
+
+```
+mkmid --help
+```
+
+### ckmid
+
+The `chmid` executable reads an OFMX file, validates it against the schema and checks all `mid` attributes for [OFMX-compliance](https://gitlab.com/openflightmaps/ofmx/wikis/Features#mid).
+
+```
+ckmid --help
+```
 
 ## References
 
 ### AIXM
 * [AIXM](http://aixm.aero)
-* [AICM 4.5 documentation](https://openflightmaps.github.io/ofmx/aixm/4.5/manual/aicm/)
+* [AICM 4.5 documentation](https://openflightmaps.gitlab.io/ofmx/aixm/4.5/manual/aicm/)
 * [AIXM 4.5 specification](http://aixm.aero/document/aixm-45-specification)
 
 ### OFMX
-* [OFMX](https://github.com/openflightmaps/ofmx)
-* [OFMX documentation](https://github.com/openflightmaps/ofmx/wiki)
+* [OFMX](https://gitlab.com/openflightmaps/ofmx)
+* [OFMX documentation](https://gitlab.com/openflightmaps/ofmx/wikis)
 * [open flightmaps](https://openflightmaps.org)
 
 ## Tests

data/exe/ckmid

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# TODO: hide deprecations unless in gem root until fully complying with Ruby 2.7
+Warning[:deprecated] = Dir.pwd.match? /aixm$/
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  ruby '>= 2.7'
+  gem 'aixm', '~> 0'
+end
+
+AIXM::Executables::Ckmid.new.run

data/exe/mkmid

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# TODO: hide deprecations unless in gem root until fully complying with Ruby 2.7
+Warning[:deprecated] = Dir.pwd.match? /aixm$/
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  ruby '>= 2.7'
+  gem 'aixm', '~> 0'
+end
+
+AIXM::Executables::Mkmid.new.run

data/lib/aixm.rb

@@ -1,18 +1,28 @@
-require 'builder'
 require 'ostruct'
 require 'securerandom'
-require 'nokogiri'
 require 'forwardable'
 require 'digest'
 require 'time'
 require 'pathname'
+require 'optparse'
+
+require 'builder'
+require 'nokogiri'
+require 'dry/inflector'
+
+require_relative 'aixm/object'
 
 require_relative 'aixm/version'
-require_relative 'aixm/constants'
 require_relative 'aixm/refinements'
 require_relative 'aixm/config'
 require_relative 'aixm/errors'
 
+require_relative 'aixm/classes'
+require_relative 'aixm/constants'
+require_relative 'aixm/memoize'
+require_relative 'aixm/association'
+require_relative 'aixm/payload_hash'
+
 require_relative 'aixm/document'
 require_relative 'aixm/xy'
 require_relative 'aixm/z'
@@ -22,7 +32,7 @@ require_relative 'aixm/a'
 require_relative 'aixm/w'
 require_relative 'aixm/p'
 
-require_relative 'aixm/component'
+require_relative 'aixm/component/service'
 require_relative 'aixm/component/frequency'
 require_relative 'aixm/component/geometry'
 require_relative 'aixm/component/geometry/point'
@@ -30,7 +40,7 @@ require_relative 'aixm/component/geometry/arc'
 require_relative 'aixm/component/geometry/border'
 require_relative 'aixm/component/geometry/circle'
 require_relative 'aixm/component/layer'
-require_relative 'aixm/component/vertical_limits'
+require_relative 'aixm/component/vertical_limit'
 require_relative 'aixm/component/timetable'
 require_relative 'aixm/component/runway'
 require_relative 'aixm/component/fato'
@@ -42,7 +52,6 @@ require_relative 'aixm/feature'
 require_relative 'aixm/feature/address'
 require_relative 'aixm/feature/organisation'
 require_relative 'aixm/feature/unit'
-require_relative 'aixm/feature/service'
 require_relative 'aixm/feature/airspace'
 require_relative 'aixm/feature/airport'
 require_relative 'aixm/feature/navigational_aid'
@@ -56,3 +65,4 @@ require_relative 'aixm/feature/obstacle'
 require_relative 'aixm/feature/obstacle_group'
 
 require_relative 'aixm/shortcuts'
+require_relative 'aixm/executables'