aipp 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8728d9b2f455af64005813f575779ce93a2bf19167afb0574ce603ef0ed3582f
-  data.tar.gz: 6d901cc39dee66f917e56508520bf78383863375f90a72264909b60996c7d57d
+  metadata.gz: 6d97409845a7b08285c77294aa116873fdcb668bd0f10d13d2ceecd9ef3922a9
+  data.tar.gz: 2594b4ad9bd0b9deba766704778ff1710eaaf71ce675bb4fd378481f4f13dfc6
 SHA512:
-  metadata.gz: 908575b22b787ca1743333146b113b89aea0a1e8919f0ae50abc2bf306bc11fcaec8a12780a56f3591eb96bb7790924a7959d15f0b4d06f68847e527f14782ec
-  data.tar.gz: 12a04dab59f3d229624938c21b64f1c05f15352ed1f5617c5fb05745b0230ef2b80a1fd54024d65375e452fdf8d79d7320ff5fa1d396f03ef1764c4ce4a91b63
+  metadata.gz: aa0ac5dafcc6e36a113e2a97c270f768265379b09c34a833e785adf44f45e5dfcd5bb3951b0d6741ae15bc765386eb55c3118154a48ce568f9fae14f06bf6ae5
+  data.tar.gz: 92dd8d6134a1882b0ceada8e130ed834e3dc866e4b84e2dd513084c5313a42d8fd89b47d3726ff36e1f38bb8837fa190790bcc3f99d752e7504757e1a2b4eb84

data/.travis.yml

@@ -1,4 +1,4 @@
 ---
 language: ruby
 rvm:
-  - 2.6.0
+  - 2.6.3

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.2.3
+
+#### Additons
+* Borders defined as GeoJSON (used by LF/ENR-2.1)
+* LF/AD-5.5
+
+#### Breaking Changes
+* Renamed `AIPP::AIP#write` method to `AIPP::AIP#add`
+
 ## 0.2.2
 
 #### Changes

data/README.md

@@ -51,9 +51,9 @@ module AIPP
       DEPENDS = %w(ENR-2.1 ENR-2.2)   # declare dependencies to other AIPs
 
       def parse
-        html = read               # read the Nokogiri::HTML5 document
-        feature = (...)           # build the feature
-        write(feature: feature)   # write the feature to AIXM::Document
+        html = read             # read the Nokogiri::HTML5 document
+        feature = (...)         # build the feature
+        add(feature: feature)   # add the feature to AIXM::Document
       end
 
     end
@@ -84,16 +84,50 @@ end
 Inside the `parse` method, you have access to the following methods:
 
 * [`read`](https://www.rubydoc.info/gems/aipp/AIPP/AIP#read-instance_method) – download and read an AIP file
-* [`write`](https://www.rubydoc.info/gems/aipp/AIPP/AIP#write-instance_method) – write a [`AIXM::Feature`]([AIXM Rubygem](https://github.com/svoop/aixm)
-* [`select`](https://www.rubydoc.info/gems/aipp/AIPP/AIP#find-instance_method – search previously written [`AIXM::Feature`s]([AIXM Rubygem](https://github.com/svoop/aixm)
+* [`add`](https://www.rubydoc.info/gems/aipp/AIPP/AIP#add-instance_method) – add a [`AIXM::Feature`](https://www.rubydoc.info/gems/aixm/AIXM/Feature)
+* [`select`](https://www.rubydoc.info/gems/aipp/AIPP/AIP#find-instance_method – search previously written [`AIXM::Feature`s](https://www.rubydoc.info/gems/aixm/AIXM/Feature)
 * some core extensions from ActiveSupport – [`Object#blank`](https://www.rubydoc.info/gems/activesupport/Object#blank%3F-instance_method) and [`String`](https://www.rubydoc.info/gems/activesupport/String)
-* core extensions from this gem – [`Object`](https://www.rubydoc.info/gems/aipp/Object), [`String`](https://www.rubydoc.info/gems/aipp/String), [`NilClass`](https://www.rubydoc.info/gems/aipp/NilClass) and [`Enumerable`](https://www.rubydoc.info/gems/aipp/Enumerable)
+* core extensions from this gem – [`Object`](https://www.rubydoc.info/gems/aipp/Object), [`Integer`](https://www.rubydoc.info/gems/aipp/Integer), [`String`](https://www.rubydoc.info/gems/aipp/String), [`NilClass`](https://www.rubydoc.info/gems/aipp/NilClass) and [`Enumerable`](https://www.rubydoc.info/gems/aipp/Enumerable)
+
+As well as the following methods:
+
+* [`options`](https://www.rubydoc.info/gems/aipp/AIPP/Parser#options-instance_method) – arguments read from <tt>aip2aixm</tt> or <tt>aip2ofmx</tt> respectively
+* [`config`](https://www.rubydoc.info/gems/aipp/AIPP/Parser#config-instance_method) – configuration read from <tt>config.yml</tt>
+* [`borders`](https://www.rubydoc.info/gems/aipp/AIPP/Parser#borders-instance_method) – borders defined as GeoJSON read from the region (see below)
+* [`cache`](https://www.rubydoc.info/gems/aipp/AIPP/Parser#cache-instance_method) – virgin `OStruct` instance to make objects available across AIPs
+
+### Borders
+
+AIXM knows named borders for country boundaries. However, you might need additional borders which don't exist as named boarders.
+
+To define additional borders, create simple GeoJSON files in the <tt>lib/aipp/regions/{REGION}/borders/</tt> directory, for example this `custom_border.geojson`:
+
+```json
+{
+  "type": "GeometryCollection",
+  "geometries": [
+    {
+      "type": "LineString",
+      "coordinates": [
+        [6.009531650000042, 45.12013319700009],
+        [6.015747738000073, 45.12006702600007]
+      ]
+    }
+  ]
+}
+```
+
+⚠️ The GeoJSON file must consist of exactly one `GeometryCollection` which may contain any number of `LineString` geometries. Only `LineString` geometries are recognized! To define a closed polygon, the first coordinates of a `LineString` must be identical to the last coordinates.
+
+The [`borders`](https://www.rubydoc.info/gems/aipp/AIPP/Parser#borders-instance_method) method gives you access to a map from the border name (upcased file name) to the corresponding [`AIPP::Border`](https://www.rubydoc.info/gems/aipp/AIPP/Border) object:
+
+```ruby
+borders   # => { "CUSTOM_BORDER" => #<AIPP::Border file=custom_border.geojson> }
+```
 
-As well as the following objects:
+The border object implements simple nearest point and segment calculations to create arrays of [`AIXM::XY`](https://www.rubydoc.info/gems/aixm/AIXM/XY) which can be used with [`AIXM::Component::Geometry`](https://www.rubydoc.info/gems/aixm/AIXM/Component/Geometry). 
 
-* `options` – arguments read from <tt>aip2aixm</tt> or <tt>aip2ofmx</tt> respectively
-* `config` – configuration read from <tt>config.yml</tt>
-* `cache` – virgin `OStruct` instance to make objects available across AIPs
+See [`AIPP::Border`](https://www.rubydoc.info/gems/aipp/AIPP/Border) for more on this.
 
 ### Helpers
 
@@ -213,12 +247,12 @@ info("my message")                  # displays "my message" in black
 info("my message", color: :green)   # displays "my message" in green
 ```
 
-#### debug
+#### verbose info
 
-Use `debug` for in-depth info messages which are only shown if the `--verbose` mode is set:
+Use `verbose_info` for in-depth info messages which are only shown if the `--verbose` mode is set:
 
 ```ruby
-debug("my message")   # displays "my message" in blue
+verbose_info("my message")   # displays "my message" in blue
 ```
 
 ### Pry

data/TODO.md

@@ -1,4 +1,7 @@
 ## LF
 
-### AD-2
-* Landing aids (LOC/GP/DME) as of AD-2 section 2.19
+* AD-3.1: helipads
+* ENR-5.4: obstacles
+* ENR-5.2: military and training areas
+* ENR-2.2: TMZ and RMZ
+* AD-2: landing aids (LOC/GP/DME) as of section 2.19

data/aipp.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
 
-  spec.add_runtime_dependency 'aixm', '>= 0.3.4'
+  spec.add_runtime_dependency 'aixm', '>= 0.3.5'
   spec.add_runtime_dependency 'activesupport', '~> 5'
   spec.add_runtime_dependency 'nokogiri', '~> 1'
   spec.add_runtime_dependency 'nokogumbo', '~> 2'

data/lib/aipp.rb

@@ -21,12 +21,14 @@ require 'active_support'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string'
 require_relative 'core_ext/object'
+require_relative 'core_ext/integer'
 require_relative 'core_ext/string'
 require_relative 'core_ext/nil_class'
 require_relative 'core_ext/enumerable'
 
 require_relative 'aipp/version'
 require_relative 'aipp/pdf'
+require_relative 'aipp/border'
 require_relative 'aipp/t_hash'
 require_relative 'aipp/executable'
 require_relative 'aipp/airac'

data/lib/aipp/aip.rb

@@ -20,7 +20,7 @@ module AIPP
     #   @see AIPP::Parser#options
     # @!method cache
     #   @see AIPP::Parser#cache
-    def_delegators :@parser, :aixm, :config, :options, :cache
+    def_delegators :@parser, :aixm, :config, :options, :borders, :cache
     private :aixm
 
     def initialize(aip:, downloader:, parser:)
@@ -45,10 +45,11 @@ module AIPP
       @downloader.read(document: aip_file, url: url_for(aip_file))
     end
 
-    # Write feature to AIXM
+    # Add feature to AIXM
     #
     # @param feature [AIXM::Feature] e.g. airport or airspace
-    def write(feature)
+    def add(feature)
+      verbose_info "Adding #{feature.class}"
       aixm.features << feature
     end
 

data/lib/aipp/border.rb

@@ -0,0 +1,146 @@
+module AIPP
+
+  # Border GeoJSON file reader
+  #
+  # The border GeoJSON files must be a geometry collection of one or more
+  # line strings:
+  #
+  #   {
+  #     "type": "GeometryCollection",
+  #     "geometries": [
+  #       {
+  #         "type": "LineString",
+  #         "coordinates": [
+  #           [6.009531650000042, 45.12013319700009],
+  #           [6.015747738000073, 45.12006702600007]
+  #         ]
+  #       }
+  #     ]
+  #   }
+  #
+  # @example
+  #   border = AIPP::Border.new("/path/to/file.geojson")
+  #   border.geometries
+  #   # => [[#<AIXM::XY 45.12013320N 006.00953165E>, <AIXM::XY 45.12006703N 006.01574774E>]]
+  class Border
+    attr_reader :file
+    attr_reader :geometries
+
+    def initialize(file)
+      @file = file.is_a?(Pathname) ? file : Pathname(file)
+      fail(ArgumentError, "file must have extension .geojson") unless @file.extname == '.geojson'
+      @geometries = load_geometries
+    end
+
+    # @return [String]
+    def inspect
+      %Q(#<#{self.class} file=#{@file}>)
+    end
+
+    # Name of the border
+    #
+    # By convention, the name of the border is taken from the filename with
+    # both the extension .geojson and all non alphanumeric characters dropped
+    # and the resulting string upcased.
+    #
+    # @return [String]
+    def name
+      @file.basename('.geojson').to_s.gsub(/\W/, '').upcase
+    end
+
+    # Whether the given geometry is closed or not
+    #
+    # A geometry is considered closed when it's first coordinate equals the
+    # last coordinate.
+    #
+    # @param geometry_index [Integer] geometry to check
+    # @return [Boolean] true if the geometry is closed or false otherwise
+    def closed?(geometry_index:)
+      geometry = @geometries[geometry_index]
+      geometry.first == geometry.last
+    end
+
+    # Find a position on a geometry nearest to the given coordinates
+    #
+    # @param geometry_index [Integer] index of the geometry on which to search
+    #   or +nil+ to search on all geometries
+    # @param xy [AIXM::XY] coordinates to approximate
+    # @return [AIPP::Border::Position] position nearest to the given coordinates
+    def nearest(geometry_index: nil, xy:)
+      position = nil
+      min_distance = 21_000_000   # max distance on earth in meters
+      @geometries.each.with_index do |geometry, g_index|
+        next unless geometry_index.nil? || geometry_index == g_index
+        geometry.each.with_index do |coordinates, c_index|
+          distance = xy.distance(coordinates).dist
+          if distance < min_distance
+            position = Position.new(geometries: geometries, geometry_index: g_index, coordinates_index: c_index)
+            min_distance = distance
+          end
+        end
+      end
+      position
+    end
+
+    # Get a segment of a geometry between the given starting and ending
+    # positions
+    #
+    # The segment ends either at the given ending position or at the last
+    # coordinates of the geometry. However, if the geometry is closed, the
+    # segment always continues up to the given ending position.
+    #
+    # @param from_position [AIPP::Border::Position] starting position
+    # @param to_position [AIPP::Border::Position] ending position
+    # @return [Array<AIXM::XY>] array of coordinates describing the segment
+    def segment(from_position:, to_position:)
+      fail(ArgumentError, "both positions must be on the same geometry") unless from_position.geometry_index == to_position.geometry_index
+      geometry_index = from_position.geometry_index
+      geometry = @geometries[geometry_index]
+      if closed?(geometry_index: geometry_index)
+        up = from_position.coordinates_index.upto(to_position.coordinates_index)
+        down = from_position.coordinates_index.downto(0) + (geometry.count - 2).downto(to_position.coordinates_index)
+        geometry.values_at(*(up.count < down.count ? up : down).to_a)
+      else
+        geometry.values_at(*from_position.coordinates_index.up_or_downto(to_position.coordinates_index).to_a)
+      end
+    end
+
+    private
+
+    def load_geometries
+      JSON.load(@file)['geometries'].map do |line_string|
+        line_string['coordinates'].map do |long, lat|
+          AIXM.xy(long: long, lat: lat)
+        end
+      end
+    end
+
+    # Position defines an exact point on a border
+    #
+    # @example
+    #   position = AIPP::Border::Position.new(
+    #     geometries: border.geometries, geometry_index: 0, coordinates_index: 0
+    #   )
+    #   position.xy   # => #<AIXM::XY 45.12013320N 006.00953165E>
+    class Position
+      attr_accessor :geometry_index
+      attr_accessor :coordinates_index
+
+      def initialize(geometries:, geometry_index:, coordinates_index:)
+        @geometries, @geometry_index, @coordinates_index = geometries, geometry_index, coordinates_index
+      end
+
+      # @return [String]
+      def inspect
+        %Q(#<#{self.class} xy=#{xy}>)
+      end
+
+      # Coordinates for this position
+      #
+      # @return [AIXM::XY, nil] coordinates or nil if the indexes don't exist
+      def xy
+        @geometries.dig(@geometry_index, @coordinates_index)
+      end
+    end
+  end
+end

data/lib/aipp/downloader.rb

@@ -57,7 +57,7 @@ module AIPP
       type ||= Pathname(URI(url).path).extname[1..-1].to_sym
       file = work_path.join([document, type].join('.'))
       unless file.exist?
-        debug "Downloading #{document}"
+        verbose_info "Downloading #{document}"
         IO.copy_stream(Kernel.open(url), file)
       end
       convert file

data/lib/aipp/executable.rb

@@ -8,7 +8,7 @@ module AIPP
       @options = options
       @options[:airac] = AIPP::AIRAC.new
       @options[:storage] = Pathname(Dir.home).join('.aipp')
-      @options[:force] = $PRY_ON_WARN = $PRY_ON_ERROR = false
+      @options[:force] = $VERBOSE_INFO = $PRY_ON_WARN = $PRY_ON_ERROR = false
       OptionParser.new do |o|
         o.banner = <<~END
           Download online AIP and convert it to #{options[:schema].upcase}.
@@ -19,7 +19,7 @@ module AIPP
         o.on('-a', '--aip STRING', String, 'process this AIP only (e.g. "ENR-5.1")') { |v| @options[:aip] = v.upcase }
         o.on('-s', '--storage DIR', String, 'storage directory (default: "~/.aipp")') { |v| @options[:storage] = Pathname(v) }
         o.on('-f', '--[no-]force', 'ignore XML schema validation (default: false)') { |v| @options[:force] = v }
-        o.on('-v', '--[no-]verbose', 'verbose output and Ruby debug mode (default: false)') { |v| $DEBUG = v }
+        o.on('-v', '--[no-]verbose', 'verbose output (default: false)') { |v| $VERBOSE_INFO = v }
         o.on('-w', '--pry-on-warn [ID]', Integer, 'open pry on warn with ID (default: nil)') { |v| $PRY_ON_WARN = v || true }
         o.on('-e', '--[no-]pry-on-error', 'open pry on error (default: false)') { |v| $PRY_ON_ERROR = v }
         o.on('-A', '--about', 'show author/license information and exit') { about }

data/lib/aipp/parser.rb

@@ -12,6 +12,9 @@ module AIPP
     # @return [AIXM::Document] target document
     attr_reader :aixm
 
+    # @return [Hash] map from border names to border objects
+    attr_reader :borders
+
     # @return [OpenStruct] object cache
     attr_reader :cache
 
@@ -22,6 +25,7 @@ module AIPP
       @config = {}
       @aixm = AIXM.document(region: @options[:region], effective_at: @options[:airac].date)
       @dependencies = THash.new
+      @borders = {}
       @cache = OpenStruct.new
     end
 
@@ -38,9 +42,16 @@ module AIPP
       info("Reading region #{options[:region]}")
       dir = Pathname(__FILE__).dirname.join('regions', options[:region])
       fail("unknown region `#{options[:region]}'") unless dir.exist?
+      # Borders
+      dir.glob('borders/*.geojson').each do |file|
+        border = AIPP::Border.new(file)
+        @borders[border.name] = border
+      end
+      # Helpers
       dir.glob('helpers/*.rb').each { |f| require f }
+      # Parsers
       dir.glob('*.rb').each do |file|
-        debug("Requiring #{file.basename}")
+        verbose_info "Requiring #{file.basename}"
         require file
         aip = file.basename('.*').to_s
         @dependencies[aip] = ("AIPP::%s::%s::DEPENDS" % [options[:region], aip.remove(/\W/).classify]).constantize

data/lib/aipp/patcher.rb

@@ -24,7 +24,7 @@ module AIPP
           define_method(:"#{attribute}=") do |value|
             catch :abort do
               value = block.call(parser, self, value)
-              debug("PATCH: #{self.inspect}", color: :magenta)
+              verbose_info("PATCH: #{self.inspect}", color: :magenta)
             end
             send(:"original_#{attribute}=", value)
           end

data/lib/aipp/pdf.rb

@@ -97,13 +97,13 @@ module AIPP
     end
 
     def read_cache
-      cache_file = "#{@file}.json"
-      if File.exist?(cache_file) && (File.stat(@file).mtime - File.stat(cache_file).mtime).abs < 1
-        JSON.load File.read(cache_file)
+      cache_file = Pathname.new("#{@file}.json")
+      if cache_file.exist? && (@file.stat.mtime - cache_file.stat.mtime).abs < 1
+        JSON.load cache_file
       else
         read.tap do |data|
-          File.write(cache_file, data.to_json)
-          FileUtils.touch(cache_file, mtime: File.stat(@file).mtime)
+          cache_file.write data.to_json
+          FileUtils.touch(cache_file, mtime: @file.stat.mtime)
         end
       end
     end

data/lib/aipp/regions/LF/AD-1.3.rb

@@ -32,9 +32,9 @@ module AIPP
         tbody = prepare(html: read).css('tbody').first   # skip altiports
         tbody.css('tr').to_enum.with_index(1).each do |tr, index|
           if tr.attr(:id).match?(/-TXT_NAME-/)
-            write @airport if @airport && !ad2_exists
+            add @airport if @airport && !ad2_exists
             @airport = airport_from tr
-            debug "Parsing #{@airport.id}"
+            verbose_info "Parsing #{@airport.id}"
             ad2_exists = false
             if airport = select(:airport, id: @airport.id).first
               ad2_exists = true
@@ -47,7 +47,7 @@ module AIPP
         rescue => error
           warn("error parsing #{@airport.id} at ##{index}: #{error.message}", pry: error)
         end
-        write @airport if @airport && !ad2_exists
+        add @airport if @airport && !ad2_exists
       end
 
       private
@@ -64,7 +64,7 @@ module AIPP
         ).tap do |airport|
           airport.z = AIXM.z(tds[4].text.strip.to_i, :qnh)
           airport.declination = tds[2].text.remove('°').strip.to_f
-          airport.transition_z = AIXM.z(5000, :qnh)   # TODO: default - exceptions may exist
+#         airport.transition_z = AIXM.z(5000, :qnh)   # TODO: default - exceptions exist
         end
       end