aipp 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49d074cd575fab6f3620f201d538c6a2d8accf1d375438b7cd4fd2e2d77aca56
-  data.tar.gz: 1e1ca6f26498e1033385c7b2dc8aeb558c19b28300df0a5521699956661dd026
+  metadata.gz: 8728d9b2f455af64005813f575779ce93a2bf19167afb0574ce603ef0ed3582f
+  data.tar.gz: 6d901cc39dee66f917e56508520bf78383863375f90a72264909b60996c7d57d
 SHA512:
-  metadata.gz: 1212764315987bacfac6a5429742ef3e9faeff0249cb3bbb4e44554d8a74ef59407e66cf61c3c02475a0a9f316b445449c6adaff3f980a385ab829fbf6472a46
-  data.tar.gz: 503d02d65c4ce0e161e0aebafada72110095104a90910131c87d33e8a91196e9c98289db9b5e0e2b7013a1ed664cd5cb550b01f5ddf4ca074e1cee706c3ba782
+  metadata.gz: 908575b22b787ca1743333146b113b89aea0a1e8919f0ae50abc2bf306bc11fcaec8a12780a56f3591eb96bb7790924a7959d15f0b4d06f68847e527f14782ec
+  data.tar.gz: 12a04dab59f3d229624938c21b64f1c05f15352ed1f5617c5fb05745b0230ef2b80a1fd54024d65375e452fdf8d79d7320ff5fa1d396f03ef1764c4ce4a91b63

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.3
+ruby-2.6.3

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,8 +1,22 @@
+## 0.2.2
+
+#### Changes
+* Helper modules instead of one monolythic `helper.rb`
+
+#### Additions
+* LF/AD-1.3
+* LF/AD-1.6
+* LF/AD-2
+
 ## 0.2.1
 
 #### Changes
+* Require Ruby 2.6
 * Fix broken downloader
 
+#### Additions
+* Support for PDF files
+
 ## 0.2.0
 
 #### Changes
@@ -38,5 +52,6 @@
 ## 0.1.0
 
 #### Initial Implementation
+* Require Ruby 2.5
 * Framework and aip2aixm executable
 * LF/ENR-5.1

data/README.md

@@ -8,9 +8,10 @@
 
 Parser for Aeronautical Information Publication (AIP) available online.
 
-This gem incluces two executables to download and parse aeronautical data, then export is as [AIXM](https://github.com/svoop/aixm) or [OFMX](https://github.com/openflightmaps/ofmx/wiki).
+This gem incluces two executables to download and parse aeronautical data as HTML or PDF, then export is as [AIXM](https://github.com/svoop/aixm) or [OFMX](https://github.com/openflightmaps/ofmx/wiki).
 
 * [Homepage](https://github.com/svoop/aipp)
+* [Rubydoc](https://www.rubydoc.info/gems/aipp/AIPP)
 * Author: [Sven Schwyn - Bitcetera](http://www.bitcetera.com)
 
 ## Install
@@ -36,25 +37,7 @@ AIPP uses a storage directory for configuration, caching and in order to keep th
 
 The reference implementation is region "LF" (France).
 
-To implement a region, you have to create a new directory <tt>lib/aipp/regions/{REGION}</tt> and place the following files there:
-
-### helper.rb
-
-Create the file <tt>helper.rb</tt> which defines the module `AIPP::LF::Helper` and usually contains the URL builder method `url_for` used by all AIP parsers:
-
-```ruby
-module AIPP
-  module LF
-    module Helper
-
-      def url_for(aip_file)
-        # build and return the download URL for the aip file
-      end
-
-    end
-  end
-end
-```
+To implement a region, you have to create a new directory <tt>lib/aipp/regions/{REGION}/</tt> and place the following files there:
 
 ### AIP Parsers
 
@@ -68,8 +51,9 @@ module AIPP
       DEPENDS = %w(ENR-2.1 ENR-2.2)   # declare dependencies to other AIPs
 
       def parse
-        html = load_html
-        # read from "html" (Nokogiri::HTML::Document) and write to "aixm"
+        html = read               # read the Nokogiri::HTML5 document
+        feature = (...)           # build the feature
+        write(feature: feature)   # write the feature to AIXM::Document
       end
 
     end
@@ -86,8 +70,9 @@ module AIPP
 
       def parse
         %i(one two three).each do |part|
-          html = load_html(aip_file: "#{aip}.#{part}")
-          # read from "html" (Nokogiri::HTML::Document) and write to "aixm"
+          html = read(aip_file: "#{aip}.#{part}")   # read with a non-standard name
+          support_html = read(aip_file: 'AD-0.6')        # maybe read necessary support documents
+          (...)
         end
       end
 
@@ -96,14 +81,99 @@ module AIPP
 end
 ```
 
-Inside the `parse` method, you have access to the following objects:
+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)
+* 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)
+
+As well as the following objects:
 
-* `aixm` – target: instance of `AIXM::Document` (see [AIXM Rubygem](https://github.com/svoop/aixm))
 * `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
 
-Furthermore, you have access to any method defined in <tt>helper.rb</tt> and you can overwrite any of them if need be (most notably `url_for`).
+### Helpers
+
+Helpers are modules defined in the <tt>lib/aipp/regions/{REGION}/helpers/</tt> directory. All helper modules are required automatically.
+
+There is one mandatory helper called `URL.rb` which must define the following method to build URLs from which to download AIPs:
+
+```ruby
+module AIPP
+  module LF
+    module Helpers
+      module URL
+
+        def url_for(aip_file)
+          # build and return the download URL for the aip file
+        end
+
+      end
+    end
+  end
+end
+```
+
+Feel free to add more helpers to DRY code which is shared by multiple AIP parsers. Say you want to extract methods which are used by all AIP parsers:
+
+```ruby
+module AIPP
+  module LF
+    module Helpers
+      module Common
+
+        def source(position:, aip_file: nil)
+          (...)
+        end
+
+      end
+    end
+  end
+end
+```
+
+To use this `source` method, simply include the helper module in the AIP parser:
+
+```ruby
+module AIPP
+  module LF
+    class AD2 < AIP
+
+      include AIPP::LF::Helpers::Common
+
+    end
+  end
+end
+```
+
+### Patches
+
+When parsed data is faulty or missing, you might have to use a different data source instead such as static data from a fixture file. This is where patches come in. You can patch any AIXM attribute setter by defining a patch block inside the AIP parser:
+
+```ruby
+module AIPP
+  module LF
+    class AD2 < AIP
+
+      patch AIXM::Component::Runway::Direction, :xy do |parser, object, value|
+        throw :abort unless value.nil?
+        @fixtures ||= YAML.load_file(Pathname(__FILE__).dirname.join('AD-1.3.yml'))
+        airport_id = parser.instance_variable_get(:@airport).id
+        direction_name = object.name.to_s
+        throw :abort if (xy = @fixtures.dig('runways', airport_id, direction_name, 'xy')).nil?
+        lat, long = xy.split(/\s+/)
+        AIXM.xy(lat: lat, long: long)
+      end
+
+    end
+  end
+end
+```
+
+The patch block receives the object and the current value. If this value is okay, `throw :abort` to leave the patch block without touching anything. Otherwise, have the patch block return a new value which will be used instead.
 
 ### Source File Line Numbers
 
@@ -113,11 +183,11 @@ In order to reference the source of an AIXM/OFMX feature, it's necessary to know
 tr.line
 ```
 
-:warning: Make sure you have build Nokogumbo `--with-libxml2`. Otherwise, all elements will report line number `0` and therefore render OFMX documents invalid. See the [Nokogumbo README](https://github.com/rubys/nokogumbo/blob/master/README.md#flavors-of-nokogumbo) for more on this.
+⚠️ Make sure you have build Nokogumbo `--with-libxml2`. Otherwise, all elements will report line number `0` and therefore render OFMX documents invalid. See the [Nokogumbo README](https://github.com/rubys/nokogumbo/blob/master/README.md#flavors-of-nokogumbo) for more on this.
 
 ### Errors
 
-You should `fail` on fatal problems. The `-E` command line argument will open a Pry session when such an error occurs. Issue errors as usual:
+You should `fail` on fatal problems. The `-e` command line argument will open a Pry session when such an error occurs. Issue errors as usual:
 
 ```ruby
 fail "my message"
@@ -125,23 +195,38 @@ fail "my message"
 
 ### Warnings
 
-You should `warn` on non-fatal problems. The `-W ID` command line argument will open a Pry session when then warning with the given ID occurs. To issue a warning:
+You should `warn` on non-fatal problems. The `-w ID` command line argument will open a Pry session when then warning with the given ID occurs. To issue a warning:
 
 ```ruby
-warn("my message", context: binding)   # open Pry with binding context
-warn("my message", context: error)     # open Pry with error context
+warn("my message", pry: binding)   # open Pry attached to the binding
+warn("my message", pry: error)     # open Pry attached to the error
 ```
 
-### Informational Messages
+### Messages
 
-You may `info` any other useful information:
+#### info
+
+Use `info` for essential info messages:
 
 ```ruby
-info("my message")                  # show info only in verbose mode (-V)
-info("my message", force: true)     # always show info
-info("my message", color: :green)   # show info with this color
+info("my message")                  # displays "my message" in black
+info("my message", color: :green)   # displays "my message" in green
 ```
 
+#### debug
+
+Use `debug` for in-depth info messages which are only shown if the `--verbose` mode is set:
+
+```ruby
+debug("my message")   # displays "my message" in blue
+```
+
+### Pry
+
+Pry is loaded with stack explorer support. Type `help` in the Pry console to see all available commands. The most useful command in the context of this gem is `up` which beams you one frame up in the caller stack.
+
+Note: It's not currently possible to use pry-byebug at this time since it [interferes with pry-rescue](https://github.com/ConradIrwin/pry-rescue/issues/71).
+
 ## AIRAC Date Calculations
 
 The `AIPP::AIRAC` class is used to calculate AIRAC cycles:

data/TODO.md

@@ -0,0 +1,4 @@
+## LF
+
+### AD-2
+* Landing aids (LOC/GP/DME) as of AD-2 section 2.19

data/aipp.gemspec

@@ -19,21 +19,26 @@ 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.required_ruby_version = '>= 2.6'
 
-  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 'spy'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
 
-  spec.add_runtime_dependency 'aixm', '~> 0', '>= 0.3.2'
+  spec.add_runtime_dependency 'aixm', '>= 0.3.4'
+  spec.add_runtime_dependency 'activesupport', '~> 5'
   spec.add_runtime_dependency 'nokogiri', '~> 1'
   spec.add_runtime_dependency 'nokogumbo', '~> 2'
+  spec.add_runtime_dependency 'pdf-reader', '~> 2'
+  spec.add_runtime_dependency 'json', '~> 2'
+  spec.add_runtime_dependency 'rubyzip', '~> 1'
   spec.add_runtime_dependency 'colorize', '~> 0'
   spec.add_runtime_dependency 'pry', '~> 0'
   spec.add_runtime_dependency 'pry-rescue', '~> 1'
+  spec.add_runtime_dependency 'pry-stack_explorer', '~> 0'
 end

data/lib/aipp.rb

@@ -12,16 +12,28 @@ require 'ostruct'
 require 'date'
 require 'nokogiri'
 require 'nokogumbo'
+require 'pdf-reader'
+require 'json'
+require 'zip'
 require 'aixm'
 
+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/string'
+require_relative 'core_ext/nil_class'
+require_relative 'core_ext/enumerable'
+
 require_relative 'aipp/version'
-require_relative 'aipp/refinements'
+require_relative 'aipp/pdf'
 require_relative 'aipp/t_hash'
 require_relative 'aipp/executable'
-require_relative 'aipp/progress'
 require_relative 'aipp/airac'
+require_relative 'aipp/patcher'
 require_relative 'aipp/aip'
 require_relative 'aipp/parser'
+require_relative 'aipp/downloader'
 
 # Disable "did you mean?" suggestions
 module DidYouMean::Correctable

data/lib/aipp/aip.rb

@@ -2,62 +2,77 @@ module AIPP
 
   # @abstract
   class AIP
-    using AIPP::Refinements
-    include AIPP::Progress
     extend Forwardable
+    include AIPP::Patcher
 
     DEPENDS = []
 
     # @return [String] AIP name (e.g. "ENR-2.1")
     attr_reader :aip
 
-    # @return [AIXM::Document] target document
-    attr_reader :aixm
+    # @!method close
+    #   @see AIPP::Downloader#close
+    def_delegator :@downloader, :close
 
-    # @!method aixm
-    #   @return (see AIPP::Parser#aixm)
     # @!method config
-    #   @return (see AIPP::Parser#config)
+    #   @see AIPP::Parser#config
     # @!method options
-    #   @return (see AIPP::Parser#options)
+    #   @see AIPP::Parser#options
     # @!method cache
-    #   @return (see AIPP::Parser#cache)
+    #   @see AIPP::Parser#cache
     def_delegators :@parser, :aixm, :config, :options, :cache
+    private :aixm
 
-    def initialize(aip:, parser:)
-      @aip, @parser = aip, parser
-      self.class.include [:AIPP, options[:region], :Helper].constantize
+    def initialize(aip:, downloader:, parser:)
+      @aip, @downloader, @parser = aip, downloader, parser
+      self.class.include ("AIPP::%s::Helpers::URL" % options[:region]).constantize
     end
 
-    # Load an AIP source file
+    # Read an AIP source file
     #
     # Depending on whether a local copy of the file exists, either:
-    # * download from URL to local storage and read from local storage
-    # * read from local storage
+    # * download from URL to local storage and read from local archive
+    # * read from local archive
     #
     # An URL builder method +url_for(aip_file)+ must be defined either in
     # +helper.rb+ or in the AIP parser definition (e.g. +ENR-2.1.rb+).
     #
     # @param aip_file [String] e.g. "ENR-2.1" or "AD-2.LFMV" (default: +aip+)
-    # @return [Nokogiri::HTML5] HTML document
-    def load_html(aip_file: nil)
+    # @return [Nokogiri::HTML5::Document, String] HTML as Nokogiri document,
+    #   PDF or TXT as String
+    def read(aip_file=nil)
       aip_file ||= aip
-      unless (aip_path = storage_path(aip_file)).exist?
-        info("Downloading #{aip_file}", force: true)
-        storage_path.mkpath
-        IO.copy_stream(open(url_for(aip_file)), aip_path)
-      end
-      Nokogiri::HTML5(aip_path)
+      @downloader.read(document: aip_file, url: url_for(aip_file))
     end
 
-    private
-
-    def storage_path(aip_file=nil)
-      options[:storage].
-        join(options[:airac].date.xmlschema).
-        join(("#{aip_file}.html" if aip_file).to_s)
+    # Write feature to AIXM
+    #
+    # @param feature [AIXM::Feature] e.g. airport or airspace
+    def write(feature)
+      aixm.features << feature
     end
 
+    # Search features previously written to AIXM and return those matching the
+    # given class and attribute values
+    #
+    # @example
+    #   select(:airport, id: "LFNT")
+    #
+    # @param klass [Class, Symbol] feature class like AIXM::Feature::Airport or
+    #   AIXM::Feature::NavigationalAid::VOR, shorthand notations as symbols
+    #   e.g. :airport or :vor as listed in AIXM::CLASSES are recognized as well
+    # @param attributes [Hash] filter by these attributes and their values
+    # @return [Array<AIXM::Feature>]
+    def select(klass, attributes={})
+      klass = AIXM::CLASSES.fetch(klass) if klass.is_a? Symbol
+      aixm.features.select do |feature|
+        if feature.is_a? klass
+          attributes.reduce(true) do |memo, (attribute, value)|
+            memo && feature.send(attribute) == value
+          end
+        end
+      end
+    end
   end
 
 end