aipp 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cddca26d9635de7aa2ded8bde0def36adf97d548e9c133358443f7812c778ef6
-  data.tar.gz: cadd71e6709c70f03a6f2ceda4af1ef38b049d70f3aaad2cd45ef3fc792df192
+  metadata.gz: 11e3df230b0b8dcafdef31e97ed97e2bbf7d6c45f75cb86949ee92a3980e07f4
+  data.tar.gz: 9fe425721151ec0c99677813ac283de61f274f97a6d103cbce8d4d178e8f794d
 SHA512:
-  metadata.gz: 5d511918c12c5c877c64cb4d5f28e5d968cdd98e08f9dfc72b8f188579da214aa63e953b36a5f17dbdd8b2d5d0281209f29d2693a458c4b7613d0d012c4111e7
-  data.tar.gz: b3b4a1dc343049c3aec1c58290e52d09fb43adb476a6c085271d31f0d20c016db19cb9ed0f4355e8eb78f199fa3e6b9580a2f2a30d2e6ff8bcc6548f818d8e08
+  metadata.gz: 000f611816b7d7b7112649830b3cd1ae383fd9b2a6defcc554715bfbabb9c3008c1f90f3f8062d3c43630c06f7642cd8e8f3c559a99e6bb7ccc4e045062333b5
+  data.tar.gz: c29e73e68318fe197e06d07a08c79fd5cfcb6be9aff3c5fbb96150f0385682e5a51284caf311026b8623d342a77b73485db1509a844de3217161656b52e8818c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.6
+
+#### Additions
+* Detect duplicate features
+
+#### Changes
+* Require Ruby 2.7
+
 ## 0.2.5
 
 #### Additions

data/README.md

@@ -1,5 +1,5 @@
 [![Version](https://img.shields.io/gem/v/aipp.svg?style=flat)](https://rubygems.org/gems/aipp)
-[![Tests](https://github.com/svoop/aipp/workflows/Test/badge.svg)](https://github.com/svoop/aipp/actions?workflow=Test)
+[![Tests](https://img.shields.io/github/workflow/status/svoop/aipp/Test.svg?style=flat&label=tests)](https://github.com/svoop/aipp/actions?workflow=Test)
 [![Donorbox](https://img.shields.io/badge/donate-on_donorbox-yellow.svg)](https://donorbox.org/bitcetera)
 
 # AIPP
@@ -25,12 +25,36 @@ This gem incluces two executables to download and parse aeronautical data as HTM
 
 ## 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/aipp/master/certs/svoop.pem)
+```
+
+### Standalone
+
+Make sure to have the [latest version of Ruby](https://www.ruby-lang.org/en/documentation/installation/) and then install this gem:
+
+```
+gem install aipp --trust-policy MediumSecurity
+```
+
+### Bundler
+
+If you're familiar with [Bundler](https://bundler.io) powered Ruby projects, you might prefer to add the following to your <tt>Gemfile</tt> or <tt>gems.rb</tt>:
 
 ```ruby
 gem aipp
 ```
 
+And then install the bundle:
+
+```
+bundle install --trust-policy MediumSecurity
+```
+
 ## Usage
 
 See the built-in help for all options:
@@ -61,23 +85,23 @@ You'll find a directory for each region which contains the following items:
   * `manifest.csv` – diffable manifest (see below)
 * `config.yml`<br>This file contains configuration which will be read on subsequent runs, most notably the namespace UUID used to identify the creator of OFMX files.
 
-The manifest is a CSV which lists every feature on a separate line along with its hashes and comment. You can `diff` or `git diff` two manifests:
+The manifest is a CSV which lists every feature on a separate line along with its hashes, AIP and comment. You can `diff` or `git diff` two manifests:
 
 ```diff
 $ git diff -U0 2019-09-12/manifest.csv 2019-10-10/manifest.csv
 
 --- a/2019-09-12/manifest.csv
 +++ b/2019-10-10/manifest.csv
-@@ -89,0 +90 @@ Aha,449f4791,d6d4bff8,Address: PHONE for LFF958FC61
-+Aha,44b9a044,cf55a3cf,Address: PHONE for LF49929DD6
-@@ -134 +135 @@ Aha,6acfbcc5,c4f57e3f,Address: FAX for LF897E1A6F
--Aha,6b381b32,fb947716,Address: RADIO for LFPO
-+Aha,6b381b32,b9723b7e,Address: RADIO for LFPO
-@@ -253,0 +255 @@ Aha,d01c4282,7cc8db7f,Address: PHONE for LF0C413AE2
-+Aha,d05cfbff,74fb76bc,Address: FAX for LF49929DD6
-@@ -327 +329 @@ Ahp,068f4f01,1dc2fb5c,Airport: LFEA BELLE ILE
--Ahp,06d04910,e18af958,Airport: LFFDE9077D TONNERRE CENTRE HOSPITALIER
-+Ahp,06d04910,cc522711,Airport: LFFDE9077D TONNERRE CENTRE HOSPITALIER
+@@ -204 +204 @@ AD-1.3,Ahp,9e9f031e,d6f22057,Airport: LFLJ COURCHEVEL
+-AD-1.3,Ahp,9f1eed18,37ddbbde,Airport: LFQD ARRAS ROCLINCOURT
++AD-1.3,Ahp,9f1eed18,f0e60105,Airport: LFQD ARRAS ROCLINCOURT
+@@ -312 +312 @@ AD-2,Aha,4250c9ee,04d49dc7,Address: RADIO for LFHV
+-AD-2,Aha,6b381b32,fb947716,Address: RADIO for LFPO
++AD-2,Aha,6b381b32,b9723b7e,Address: RADIO for LFPO
+@@ -664 +663,0 @@ AD-2,Ser,3920a7fd,4545c5eb,Service: AFIS by LFGA TWR
+-AD-2,Ser,39215774,1f13f2cf,Service: APP by LFCR APP
+@@ -878 +876,0 @@ AD-2,Ser,bb5228d7,7cfb4572,Service: TWR by LFMH TWR
+-AD-2,Ser,bc72caf2,0a15b39c,Service: FIS by LFCR FIC
 (...)
 ```
 
@@ -135,7 +159,9 @@ 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
 * [`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)
+* [`find`](https://www.rubydoc.info/gems/aipp/AIPP/AIP#find-instance_method) – find previously written [`AIXM::Feature`s](https://www.rubydoc.info/gems/aixm/AIXM/Feature) by object
+* [`find_by`](https://www.rubydoc.info/gems/aipp/AIPP/AIP#find_by-instance_method) – find previously written [`AIXM::Feature`s](https://www.rubydoc.info/gems/aixm/AIXM/Feature) by class and attribute values
+* [`unique`](https://www.rubydoc.info/gems/aipp/AIPP/AIP#unique-instance_method) – prevent duplicate [`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), [`NilClass`](https://www.rubydoc.info/gems/aipp/NilClass), [`Integer`](https://www.rubydoc.info/gems/aipp/Integer), [`String`](https://www.rubydoc.info/gems/aipp/String), [`Hash`](https://www.rubydoc.info/gems/aipp/Hash) and [`Enumerable`](https://www.rubydoc.info/gems/aipp/Enumerable)
 

data/exe/aip2aixm

@@ -4,7 +4,7 @@ require 'bundler/inline'
 
 gemfile do
   source 'https://rubygems.org'
-  ruby '>= 2.5'
+  ruby '>= 2.7'
   gem 'aipp', '~> 0'
 end
 

data/exe/aip2ofmx

@@ -4,7 +4,7 @@ require 'bundler/inline'
 
 gemfile do
   source 'https://rubygems.org'
-  ruby '>= 2.5'
+  ruby '>= 2.7'
   gem 'aipp', '~> 0'
 end
 

data/lib/aipp.rb

@@ -41,6 +41,8 @@ require_relative 'aipp/parser'
 require_relative 'aipp/downloader'
 
 # Disable "did you mean?" suggestions
+#
+# @!visibility private
 module DidYouMean::Correctable
   remove_method :to_s
 end

data/lib/aipp/aip.rb

@@ -52,24 +52,29 @@ module AIPP
     # Add feature to AIXM
     #
     # @param feature [AIXM::Feature] e.g. airport or airspace
+    # @return [AIXM::Feature] added feature
     def add(feature)
       verbose_info "Adding #{feature.inspect}"
-      aixm.features << feature
+      aixm.add_feature feature
+      feature
     end
 
-    # Search features previously written to AIXM and return those matching the
-    # given class and attribute values
+    # @!method find_by(klass, attributes={})
+    #   Find objects of the given class and optionally with the given attribute
+    #   values previously written to AIXM.
     #
-    # @example
-    #   select(:airport, id: "LFNT")
+    #   @note This method is delegated to +AIXM::Association::Array+.
+    #   @see https://www.rubydoc.info/gems/aixm/AIXM/Association/Array#find_by-instance_method
     #
-    # @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(*args)
-      aixm.select_features(*args)
+    # @!method find(object)
+    #   Find equal objects previously written to AIXM.
+    #
+    #   @note This method is delegated to +AIXM::Association::Array+.
+    #   @see https://www.rubydoc.info/gems/aixm/AIXM/Association/Array#find-instance_method
+    %i(find_by find).each do |method|
+      define_method method do |*args|
+        aixm.features.send(method, *args)
+      end
     end
   end
 

data/lib/aipp/downloader.rb

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

data/lib/aipp/executable.rb

@@ -15,15 +15,18 @@ module AIPP
           Download online AIP and convert it to #{options[:schema].upcase}.
           Usage: #{File.basename($0)} [options]
         END
-        o.on('-d', '--airac DATE', String, %Q[AIRAC date (default: "#{@options[:airac].date.xmlschema}")]) { |v| @options[:airac] = AIPP::AIRAC.new(v) }
-        o.on('-r', '--region STRING', String, 'region (e.g. "LF")') { |v| @options[:region] = v.upcase }
-        o.on('-a', '--aip STRING', String, 'process this AIP only (e.g. "ENR-5.1")') { |v| @options[:aip] = v.upcase }
-        o.on('-m', '--[no-]mid', 'insert mid attributes into all Uid elements (default: false)') { |v| @options[:mid] = v } 
-        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 (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('-d', '--airac DATE', String, %Q[AIRAC date (default: "#{@options[:airac].date.xmlschema}")]) { @options[:airac] = AIPP::AIRAC.new(_1) }
+        o.on('-r', '--region STRING', String, 'region (e.g. "LF")') { @options[:region] = _1.upcase }
+        o.on('-a', '--aip STRING', String, 'process this AIP only (e.g. "ENR-5.1")') { @options[:aip] = _1.upcase }
+        if options[:schema] == :ofmx
+          o.on('-g', '--[no-]grouped-obstacles', 'group obstacles (time-consuming!)') { @options[:grouped_obstacles] = _1 }
+          o.on('-m', '--[no-]mid', 'insert mid attributes into all Uid elements (default: false)') { @options[:mid] = _1 }
+        end
+        o.on('-s', '--storage DIR', String, 'storage directory (default: "~/.aipp")') { @options[:storage] = Pathname(_1) }
+        o.on('-f', '--[no-]force', 'ignore XML schema validation (default: false)') { @options[:force] = _1 }
+        o.on('-v', '--[no-]verbose', 'verbose output (default: false)') { $VERBOSE_INFO = _1 }
+        o.on('-w', '--pry-on-warn [ID]', Integer, 'open pry on warn with ID (default: nil)') { $PRY_ON_WARN = _1 || true }
+        o.on('-e', '--[no-]pry-on-error', 'open pry on error (default: false)') { $PRY_ON_ERROR = _1 }
         o.on('-A', '--about', 'show author/license information and exit') { about }
         o.on('-R', '--readme', 'show README and exit') { readme }
         o.on('-L', '--list', 'list implemented regions and AIPs') { list }
@@ -42,12 +45,12 @@ module AIPP
           parser.read_region
           parser.parse_aip
           parser.validate_aixm
-          parser.write_aixm
           parser.write_build
+          parser.write_aixm
           parser.write_config
         end
       rescue => error
-        puts "ERROR: #{error.message}"
+        puts "ERROR: #{error.message}".magenta
         Pry::rescued(error) if $PRY_ON_ERROR
       end
     end
@@ -69,7 +72,7 @@ module AIPP
       regions_path = Pathname($0).dirname.join('..', 'gems', "aipp-#{AIPP::VERSION}", 'lib', 'aipp', 'regions')
       hash = Dir.each_child(regions_path).each.with_object({}) do |region, hash|
         hash[region] = Dir.children(regions_path.join(region)).sort.map do |aip|
-          File.basename(aip, '.rb') unless aip == 'helper.rb'
+          File.basename(aip, '.rb') if File.file?(regions_path.join(region, aip))
         end.compact
       end
       puts hash.to_yaml.sub(/\A\W*/, '')

data/lib/aipp/parser.rb

@@ -28,12 +28,13 @@ module AIPP
       @options[:storage] = options[:storage].join(options[:region])
       @options[:storage].mkpath
       @config = {}
-      @aixm = AIXM.document(region: @options[:region], effective_at: @options[:airac].date)
+      @aixm = AIXM.document(effective_at: @options[:airac].date)
       @dependencies = THash.new
       @fixtures = {}
       @borders = {}
       @cache = OpenStruct.new
       AIXM.send("#{options[:schema]}!")
+      AIXM.config.region = options[:region]
     end
 
     # Read the configuration from config.yml.
@@ -89,12 +90,22 @@ module AIPP
           ).attach_patches.tap(&:parse).detach_patches
         end
       end
+      if options[:grouped_obstacles]
+        info("Grouping obstacles")
+        aixm.group_obstacles!
+      end
+      info("Counting #{aixm.features.count} features")
     end
 
     # Validate the AIXM document.
     #
     # @raise [RuntimeError] if the document is not valid
     def validate_aixm
+      info("Detecting duplicates")
+      if (duplicates = aixm.features.duplicates).any?
+        message = "duplicates found:\n" + duplicates.map { "#{_1.inspect} from #{_1.source}" }.join("\n")
+        @options[:force] ? warn(message, pry: binding) : fail(message)
+      end
       info("Validating #{options[:schema].upcase}")
       unless aixm.valid?
         message = "invalid #{options[:schema].upcase} document:\n" + aixm.errors.map(&:message).join("\n")
@@ -102,56 +113,60 @@ module AIPP
       end
     end
 
-    # Write the AIXM document.
-    def write_aixm
-      info("Writing #{aixm_file}")
-      AIXM.config.mid_region = options[:region] if options[:mid]
-      File.write(aixm_file, aixm.to_xml)
-    end
-
     # Write the AIXM document and context information.
     def write_build
-      info("Writing build")
-      builds_path.mkpath
-      build_file = builds_path.join("#{@options[:airac].date.xmlschema}.zip")
-      build_file.delete if build_file.exist?
-      Dir.mktmpdir do |tmp_dir|
-        tmp_dir = Pathname(tmp_dir)
-        AIXM.config.mid_region = options[:region]
-        # AIXM/OFMX file
-        File.write(tmp_dir.join(aixm_file), aixm.to_xml)
-        # Build details
-        File.write(
-          tmp_dir.join('build.yaml'), {
-            version: AIPP::VERSION,
-            config: @config,
-            options: @options
-          }.to_yaml
-        )
-        # Manifest
-        manifest, buffer, feature, uid, comment = [], '', '', '', ''
-        File.open(tmp_dir.join(aixm_file)).each do |line|
-          buffer << line
-          case line
-          when /^ {2}<(\w{3}) / then buffer, feature = line, $1
-          when /^ {4}<#{feature}Uid mid="(.*?)"/ then uid = $1
-          when /^ {2}<!-- (.*) -->/ then comment = $1
-          when /^ {2}<\/#{feature}>/
-            manifest << [feature, uid[0,8], buffer.payload_hash(region: options[:region])[0,8], comment].to_csv
-            feature, uid = '', ''
+      if @options[:aip]
+        info ("Skipping build")
+      else
+        info("Writing build")
+        builds_path.mkpath
+        build_file = builds_path.join("#{@options[:airac].date.xmlschema}.zip")
+        Dir.mktmpdir do |tmp_dir|
+          tmp_dir = Pathname(tmp_dir)
+          # AIXM/OFMX file
+          AIXM.config.mid = true
+          File.write(tmp_dir.join(aixm_file), aixm.to_xml)
+          # Build details
+          File.write(
+            tmp_dir.join('build.yaml'), {
+              version: AIPP::VERSION,
+              config: @config,
+              options: @options
+            }.to_yaml
+          )
+          # Manifest
+          manifest, buffer, feature, aip, uid, comment = [], '', '', '', '', ''
+          File.open(tmp_dir.join(aixm_file)).each do |line|
+            buffer << line
+            case line
+            when /^ {2}<(\w{3}).*source=".*?\|.*?\|(.*?)\|/ then buffer, feature, aip = line, $1, $2
+            when /^ {4}<#{feature}Uid[^>]+?mid="(.*?)"/ then uid = $1
+            when /^ {2}<!-- (.*) -->/ then comment = $1
+            when /^ {2}<\/#{feature}>/
+              manifest << [aip, feature, uid[0,8], AIXM::PayloadHash.new(buffer).to_uuid[0,8], comment].to_csv
+              feature, aip, uid = '', '', ''
+            end
           end
-        end
-        manifest = manifest.sort.prepend "Feature,Short Uid Hash,Short Feature Hash,Comment\n"
-        File.write(tmp_dir.join('manifest.csv'), manifest.join)
-        # Zip it
-        Zip::File.open(build_file, Zip::File::CREATE) do |zip|
-          tmp_dir.children.each do |entry|
-            zip.add(entry.basename.to_s, entry) unless entry.basename.to_s[0] == '.'
+          manifest = manifest.sort.prepend "AIP,Feature,Short Uid Hash,Short Feature Hash,Comment\n"
+          File.write(tmp_dir.join('manifest.csv'), manifest.join)
+          # Zip it
+          build_file.delete if build_file.exist?
+          Zip::File.open(build_file, Zip::File::CREATE) do |zip|
+            tmp_dir.children.each do |entry|
+              zip.add(entry.basename.to_s, entry) unless entry.basename.to_s[0] == '.'
+            end
           end
         end
       end
     end
 
+    # Write the AIXM document.
+    def write_aixm
+      info("Writing #{aixm_file}")
+      AIXM.config.mid = options[:mid]
+      File.write(aixm_file, aixm.to_xml)
+    end
+
     # Write the configuration to config.yml.
     def write_config
       info("Writing config.yml")

data/lib/aipp/pdf.rb

@@ -117,7 +117,7 @@ module AIPP
     end
 
     def page_for(index:)
-      @page_ranges.index(@page_ranges.bsearch { |i| i >= index }) + 1
+      @page_ranges.index(@page_ranges.bsearch { _1 >= index }) + 1
     end
   end
 end

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

@@ -42,7 +42,7 @@ module AIPP
             @airport = airport_from tr
             verbose_info "Parsing #{@airport.id}"
             ad2_exists = false
-            if airport = select(:airport, id: @airport.id).first
+            if airport = find_by(:airport, id: @airport.id).first
               ad2_exists = true
               @airport = airport
             end
@@ -81,7 +81,7 @@ module AIPP
           when /ouv.+cap|milit/ then :permitted
           when /usa.+restr|priv/ then :reservation_required
         end
-        @airport.add_usage_limitation(limitation) do |l|
+        @airport.add_usage_limitation(type: limitation) do |l|
           (%w(s ns p) & raw_conditions).each do |raw_purpose|
             l.add_condition do |c|
               c.realm = raw_limitation.match?(/milit/) ? :military : :civilian
@@ -111,6 +111,7 @@ module AIPP
           name: tds[0].text.strip.split.join('/')
         ).tap do |runway|
           @runway = runway   # TODO: needed for now for surface composition patches to work
+          bidirectional = runway.name.include? '/'
           runway.length = AIXM.d(tds[1].css('span[id$="VAL_LEN"]').text.to_i, :m)
           runway.width = AIXM.d(tds[1].css('span[id$="VAL_WID"]').text.to_i, :m)
           unless (text = tds[1].css('span[id*="SURFACE"]').text.compact).blank?
@@ -122,16 +123,16 @@ module AIPP
           runway.remarks = tds[7].text.cleanup.blank_to_nil
           values = tds[2].text.remove('°').strip.split
           runway.forth.geographic_orientation = AIXM.a(values.first.to_i)
-          runway.back.geographic_orientation = AIXM.a(values.last.to_i)
+          runway.back.geographic_orientation = AIXM.a(values.last.to_i) if bidirectional
           parts = tds[3].text.strip.split(/\n\s+\n\s+/, 2)
           runway.forth.xy = (xy_from(parts[0]) unless parts[0].blank?)
-          runway.back.xy = (xy_from(parts[1]) unless parts[1].blank?)
+          runway.back.xy = (xy_from(parts[1]) unless parts[1].blank?) if bidirectional
           values = tds[4].text.strip.split
           runway.forth.z = AIXM.z(values.first.to_i, :qnh)
-          runway.back.z = AIXM.z(values.last.to_i, :qnh)
+          runway.back.z = AIXM.z(values.last.to_i, :qnh) if bidirectional
           displaced_thresholds = displaced_thresholds_from(tds[5])
           runway.forth.displaced_threshold = displaced_thresholds.first
-          runway.back.displaced_threshold = displaced_thresholds.last
+          runway.back.displaced_threshold = displaced_thresholds.last if bidirectional
         end
       end