natour 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c05b80ae3025c95c49b590b0356f88f8217503a33afde1a879c7c2490ffc10c5
-  data.tar.gz: 7ff5fbd624b347de6c605e0eb7d83dc7face9b2d5a6bf8fa293c3ffe6963190d
+  metadata.gz: 1ac583bda8dbd5de8b922cc64bee346916b01c07b4ee986b845ef3c2c87985d0
+  data.tar.gz: 3e89dd11b0dda46ba30fdc62aec372068f5390209f7d119182d9340e4d5fbbfa
 SHA512:
-  metadata.gz: 6dce357c6e74546c484ab06ce83f5aab0cf2782ccdf2711d788e6cd155813c0b19397ceb1c8754b11307fbe15f3ae4dc67fdd1b6f7a313e9038d4ecbe04ab193
-  data.tar.gz: 1cd2542ec0a0761b275b4bc9b27a270354af178beba158bcb7896aa652ebb8c39795abae62afb80827778bbcd22088f4e466f205a51466b77c0fcfe60cbfaf62
+  metadata.gz: 96b0e7a19722f0749d08fe5a51cc9b8491b1e0f04533aed2a07f0fc091ae27eb5df2f1e0c4dc1fd67ef21673840744b9aab27f28bd12376b7dfdd3c126d7b441
+  data.tar.gz: 55f7c5dbfa646ac25e715f3dc7a1b169fc72bc223bf49893f19bbd6d0cc3c5b773ad1bef64f3520ebe4290d1ec2ea7a28b1da745157de877cce9a485bcc55467

data/.natour.yml

@@ -0,0 +1,29 @@
+---
+:report:
+  :create:
+    :out_dir: null
+    :out_file: null
+    :overwrite: false
+    :track_formats:
+      - :gpx
+      - :fit
+    :map: true
+    :map_layers: []
+    :adoc_author: null
+    :short_species_names: false
+  :convert:
+    :out_dir: null
+    :out_file: null
+    :overwrite: false
+    :backend: :pdf
+    :draft: false
+    :draft_backend: null
+    :image_maxdim: 1800
+:map:
+  :create:
+    :out_dir: null
+    :out_file: null
+    :overwrite: false
+    :gps_colors: []
+    :map_layers: []
+    :image_size: [1200, 900]

data/CHANGELOG.adoc

@@ -4,15 +4,41 @@ All notable changes to this project will be documented in this file.
 
 The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog^], and this project adheres to https://semver.org/spec/v2.0.0.html[Semantic Versioning^].
 
+IMPORTANT: As per Semantic Versioning, the major version zero is for initial development and anything may change at any time.
+
 == Unreleased
 
+== 0.12.0 - 2023-11-22
+
+=== Added
+
+- Add command line option to use short species names in the AsciiDoc output. The species names are truncated by removing the authority (botany only).
+
+=== Changed
+
+- Do not use shorthand syntax for the breakable option in the AsciiDoc output.
+
+=== Fixed
+
+- Do not abort report creation if species lists are empty (assume default columns for the AsciiDoc output).
+- Fix search of public transport stations if distance is missing (e.g. if the coordinates are outside of Switzerland).
+
+== 0.11.0 - 2023-04-15
+
+=== Changed
+
+- Specify files to load for a configuration instead of a file and directories.
+- The configuration files must now be named `.natour.yml` (prefixed with a dot).
+
+=== Fixed
+
+- Do not abort creating reports if GPX files do not contain tracks.
+
 == 0.10.0 - 2023-02-18
 
 === Fixed
 
 - Prevent orphaned section titles and table captions in PDF output.
-+
-IMPORTANT: This is a breaking change for existing AsciiDoc files that are converted again. Apply the breakable option to tables containing species lists; otherwise the numbering of the tables will not be consecutive.
 
 == 0.9.0 - 2022-10-08
 
@@ -22,7 +48,7 @@ IMPORTANT: This is a breaking change for existing AsciiDoc files that are conver
 
 === Changed
 
-- Omit empty columns of species lists in AsciiDoc output.
+- Omit empty columns of species lists in the AsciiDoc output.
 
 === Fixed
 
@@ -39,21 +65,11 @@ IMPORTANT: This is a breaking change for existing AsciiDoc files that are conver
 === Changed
 
 - Rename arguments of `Natour::MapGeoAdmin.save_image`, i.e. `tracks` to `gps_files`, `layers` to `map_layers` and `size` to `image_size`.
-+
-IMPORTANT: This is a breaking change.
 - Improve the error reporting on the command line interface in case of file errors.
 - Rework the configuration; the structure and naming follows the command line interface and the keys are of type Ruby Symbol. For details, see the README file.
-+
-IMPORTANT: This is a breaking change. Adapt the configuration file accordingly.
 - Rework the command line interface. Use `natour --help` to get more information.
-+
-IMPORTANT: This is a breaking change. Adapt the commands accordingly.
 - Change `backend` and `draft_backend` arguments of `Natour::convert_report` to symbols.
-+
-IMPORTANT: This is a breaking change. Adapt the configuration file accordingly.
 - Rename `Natour::create` to `Natour::create_reports` and `Natour::convert` to `Natour::convert_report`.
-+
-IMPORTANT: This is a breaking change.
 
 === Fixed
 
@@ -110,8 +126,6 @@ IMPORTANT: This is a breaking change.
 === Removed
 
 - Remove redundant method `Natour::Image.portrait?`.
-+
-IMPORTANT: This is a breaking change. Use `Natour::Image.landscape?` instead.
 
 == 0.3.0 - 2021-03-07
 
@@ -136,8 +150,6 @@ IMPORTANT: This is a breaking change. Use `Natour::Image.landscape?` instead.
 === Changed
 
 - Rename `Natour::SpeciesList.name` to `Natour::SpeciesList.title`.
-+
-IMPORTANT: This is a breaking change.
 - Return an empty array from `Natour::SpeciesList.load_file` if the format is unknown.
 - Change the format of the start time in the AsciiDoc output from _12:30_ to _12:30 Uhr_.
 - Change the format of the duration in the AsciiDoc output from _1h30_ to _1:30 h_.

data/README.adoc

@@ -90,7 +90,7 @@ NOTE: Use `natour --help` to get more information.
 
 === Configuration
 
-The configuration is built by loading https://yaml.org/[YAML^] files in hierarchical order. The files must be named `natour.yml` and are loaded first from the home directory of the current user and then from the current working directory. The values of the previously loaded files are overwritten by the values of the files loaded later. The values are stored internally in nested, dictionary-like collections (Ruby `Hash`), where the structure follows to the command line interface. All keys are of type Ruby `Symbol` and correspond to the commands and options, with middle hyphens replaced by underscores, leading hyphens removed, and without the `no-` prefix for boolean switches. The following configuration file shows all entries and their default values.
+The configuration is built by loading https://yaml.org/[YAML^] files in hierarchical order. The files must be named `.natour.yml` and are loaded first from the home directory of the current user and then from the current working directory. The values of the previously loaded files are overwritten by the values of the files loaded later. The values are stored internally in nested, dictionary-like collections (Ruby `Hash`), where the structure follows to the command line interface. All keys are of type Ruby `Symbol` and correspond to the commands and options, with middle hyphens replaced by underscores, leading hyphens removed, and without the `no-` prefix for boolean switches. The following configuration file shows all entries and their default values.
 
 [source,yml]
 ----
@@ -106,6 +106,7 @@ The configuration is built by loading https://yaml.org/[YAML^] files in hierarch
     :map: true
     :map_layers: []
     :adoc_author: null
+    :short_species_names: false
   :convert:
     :out_dir: null
     :out_file: null

data/bin/natour

@@ -21,6 +21,7 @@ class NatourCmd < Clamp::Command
       option(%W[--\[no-\]map], :flag, 'Create map images')
       option(%w[--map-layers], 'LAYERS', 'Add additional layers to map images') { |s| s.split(',') }
       option(%w[--adoc-author], 'AUTHOR', 'AsciiDoc author (name <email>[; name2 <email2>...])')
+      option(%W[--\[no-\]short-species-names], :flag, 'Use short species names (botany only)')
       parameter('PATH', 'Path to directory')
 
       def execute
@@ -33,7 +34,9 @@ class NatourCmd < Clamp::Command
           track_formats: track_formats || config[:track_formats],
           create_map: Natour::BooleanUtils.to_boolean(map?, default_value: config[:map]),
           map_layers: map_layers || config[:map_layers],
-          adoc_author: adoc_author || config[:adoc_author]
+          adoc_author: adoc_author || config[:adoc_author],
+          short_species_names: Natour::BooleanUtils.to_boolean(short_species_names?,
+                                                               default_value: config[:short_species_names])
         )
       rescue Errno::EEXIST, Errno::ENOENT, Errno::EACCES, Errno::EISDIR, Errno::EINVAL => e
         message, _, path = Natour::ErrnoUtils.split_message(e)
@@ -125,41 +128,11 @@ class NatourCmd < Clamp::Command
   end
 end
 
-config = Natour::Config.load_file(
-  Pathname($PROGRAM_NAME).basename.sub_ext('.yml'),
-  default: {
-    report: {
-      create: {
-        out_dir: nil,
-        out_file: nil,
-        overwrite: false,
-        track_formats: %i[gpx fit],
-        map: true,
-        map_layers: [],
-        adoc_author: nil
-      },
-      convert: {
-        out_dir: nil,
-        out_file: nil,
-        overwrite: false,
-        backend: :pdf,
-        draft: false,
-        draft_backend: nil,
-        image_maxdim: 1800
-      }
-    },
-    map: {
-      create: {
-        out_dir: nil,
-        out_file: nil,
-        overwrite: false,
-        gps_colors: [],
-        map_layers: [],
-        image_size: [1200, 900]
-      }
-    }
-  }
-)
+config = Natour::Config.load_files([
+  "#{__dir__}/../.natour.yml",
+  Pathname(Dir.home).join('.natour.yml'),
+  Pathname(Dir.pwd).join('.natour.yml')
+])
 
 NatourCmd.run(
   Pathname($PROGRAM_NAME).basename,

data/lib/natour/asciinurse.rb

@@ -4,7 +4,7 @@ require 'pathname'
 
 module Natour
   module Asciinurse
-    def save_adoc(filename, overwrite: false, author: nil)
+    def save_adoc(filename, overwrite: false, author: nil, short_species_names: false)
       dir = Pathname(filename).dirname
       FileUtils.mkdir_p(dir)
       mode = File::WRONLY | File::CREAT | File::TRUNC
@@ -14,12 +14,13 @@ module Natour
           doc_root: Pathname(path).realpath
                                   .relative_path_from(dir.realpath)
                                   .to_s.force_encoding('utf-8'),
-          author: author
+          author: author,
+          short_species_names: short_species_names
         ))
       end
     end
 
-    def to_adoc(doc_root: '.', author: nil)
+    def to_adoc(doc_root: '.', author: nil, short_species_names: false)
       distance = ->(gps_track) { "#{gps_track.distance / 1000} km" if gps_track&.distance }
       ascent = ->(gps_track) { "#{gps_track.ascent} m" if gps_track&.ascent }
       descent = ->(gps_track) { "#{gps_track.descent} m" if gps_track&.descent }
@@ -98,16 +99,19 @@ module Natour
             group: :plants,
             title: 'Pflanzenarten',
             columns: [
-              OpenStruct.new(header: 'Wissenschaftlicher Name', accessor: :name),
-              OpenStruct.new(header: 'Deutscher Name', accessor: :name_de)
+              OpenStruct.new(
+                header: 'Wissenschaftlicher Name',
+                accessor: ->(species) { short_species_names ? BotanicalNameUtils.parse(species.name) : species.name }
+              ),
+              OpenStruct.new(header: 'Deutscher Name', accessor: ->(species) { species.name_de })
             ]
           ),
           OpenStruct.new(
             group: :birds,
             title: 'Vogelarten',
             columns: [
-              OpenStruct.new(header: 'Deutscher Name', accessor: :name_de),
-              OpenStruct.new(header: 'Wissenschaftlicher Name', accessor: :name)
+              OpenStruct.new(header: 'Deutscher Name', accessor: ->(species) { species.name_de }),
+              OpenStruct.new(header: 'Wissenschaftlicher Name', accessor: ->(species) { species.name })
             ]
           )
         ].each do |info|
@@ -120,16 +124,16 @@ module Natour
             caption = '.Tabelle {counter:species_lists}'
             caption << ": #{species_list.description}" if species_list.description
             columns = info.columns.select do |column|
-              species_list.any? { |species| !species.public_send(column.accessor).nil? }
+              species_list.count.zero? || species_list.any? { |species| !column.accessor.call(species).nil? }
             end
             cols = [1] + [5 * info.columns.size / columns.size] * columns.size
             doc << caption
-            doc << "[%breakable,cols=\"#{cols.join(',')}\",options=header]"
+            doc << "[cols=\"#{cols.join(',')}\",options=\"header,breakable\"]"
             doc << '|==='
             doc << "|Nr.|#{columns.map(&:header).join('|')}"
             species_list.each do |species|
               doc <<
-                "|{counter:species_list#{index}}|#{columns.map { |column| species.public_send(column.accessor) }
+                "|{counter:species_list#{index}}|#{columns.map { |column| column.accessor.call(species) }
                                                           .join('|')}"
             end
             doc << '|==='

data/lib/natour/config.rb

@@ -4,12 +4,9 @@ require 'yaml'
 
 module Natour
   class Config
-    def self.load_file(filename, default: {}, dirs: [Dir.home, Dir.pwd])
-      configs = dirs.map do |dir|
-        config = YAML.safe_load(
-          File.read(Pathname(dir).join(filename)),
-          permitted_classes: [Symbol]
-        )
+    def self.load_files(filenames, default: {})
+      configs = filenames.map do |filename|
+        config = YAML.safe_load(File.read(filename), permitted_classes: [Symbol])
         config || {}
       rescue Errno::ENOENT
         {}

data/lib/natour/create_reports.rb

@@ -4,7 +4,8 @@ module Natour
   module_function
 
   def create_reports(dir, out_dir: nil, out_file: nil, overwrite: false,
-                     track_formats: %i[gpx fit], create_map: true, map_layers: [], adoc_author: nil)
+                     track_formats: %i[gpx fit], create_map: true, map_layers: [],
+                     adoc_author: nil, short_species_names: false)
     out_dir = Pathname(out_dir || dir)
     out_file = Pathname(out_file || "#{Pathname(dir).realpath.basename}.adoc")
     reports = Report.load_directory(
@@ -16,7 +17,7 @@ module Natour
                  else
                    out_dir.join("#{out_file.basename('.*')} (#{index})#{out_file.extname}")
                  end
-      report.save_adoc(filename, overwrite: overwrite, author: adoc_author)
+      report.save_adoc(filename, overwrite: overwrite, author: adoc_author, short_species_names: short_species_names)
       filename.to_s
     end
   end

data/lib/natour/gps_track.rb

@@ -29,7 +29,8 @@ module Natour
       format = Pathname(filename).extname.to_s.delete_prefix('.').to_sym if format == :auto
       case format
       when :gpx
-        GPXFile.new(filename)
+        gpx_file = GPXFile.new(filename)
+        gpx_file if gpx_file.types.include?(:track)
       when :fit
         FITFile.new(filename)
       end

data/lib/natour/gpx_file.rb

@@ -9,9 +9,16 @@ module Natour
       'xmlns:gpxtrkx' => 'http://www.garmin.com/xmlschemas/TrackStatsExtension/v1'
     }.freeze
 
+    attr_reader :types
+
     def initialize(filename)
       @doc = Nokogiri.XML(File.read(filename, mode: 'r:utf-8'))
 
+      @types = []
+      @types << :waypoint if @doc.at('/xmlns:gpx/xmlns:wpt', GPX_XMLNS)
+      @types << :route if @doc.at('/xmlns:gpx/xmlns:rte', GPX_XMLNS)
+      @types << :track if @doc.at('/xmlns:gpx/xmlns:trk', GPX_XMLNS)
+
       stats = @doc.at('/xmlns:gpx/xmlns:trk/xmlns:extensions/gpxtrkx:TrackStatsExtension', GPX_XMLNS)
       if stats
         ascent = stats.at('./gpxtrkx:Ascent', GPX_XMLNS).text.to_i
@@ -23,7 +30,7 @@ module Natour
       start_point = to_track_point(@doc.at('/xmlns:gpx/xmlns:trk/xmlns:trkseg[1]/xmlns:trkpt[1]', GPX_XMLNS))
       end_point = to_track_point(@doc.at('/xmlns:gpx/xmlns:trk/xmlns:trkseg[last()]/xmlns:trkpt[last()]', GPX_XMLNS))
 
-      super(filename, start_point.time&.to_date, ascent, descent, distance, duration, start_point, end_point)
+      super(filename, start_point&.time&.to_date, ascent, descent, distance, duration, start_point, end_point)
     end
 
     def to_gpx
@@ -33,6 +40,8 @@ module Natour
     private
 
     def to_track_point(trkpt)
+      return nil unless trkpt
+
       GPSTrackPoint.new(
         trkpt['lat'].to_f,
         trkpt['lon'].to_f,

data/lib/natour/public_transport.rb

@@ -16,7 +16,7 @@ module Natour
       return unless response.is_a?(Net::HTTPSuccess)
 
       stations = JSON.parse(response.body, symbolize_names: true)
-      stations.reject! { |station| station[:dist] > radius }
+      stations.reject! { |station| !station.key?(:dist) || station[:dist] > radius }
       station_types = %w[
         sl-icon-type-train
         sl-icon-type-strain

data/lib/natour/report.rb

@@ -51,6 +51,7 @@ module Natour
                                                     .join(',')
                        Pathname.glob("**/*.{#{track_pattern}}")
                                .map { |filename| GPSTrack.load_file(filename.to_s) }
+                               .compact
                                .sort_by { |gps_track| [gps_track.date, gps_track.path] }
                      end
 

data/lib/natour/species_list.rb

@@ -65,7 +65,7 @@ module Natour
           chunks.map do |rows|
             name, description = rows.shift
             date = DateUtils.parse(name, Pathname(filename).basename).compact.first
-            items = rows.map { |row| Species.new(BotanicalNameUtils.parse(row[1]), row[2]) }
+            items = rows.map { |row| Species.new(row[1], row[2]) }
                         .sort_by(&:name).uniq
             SpeciesList.new(
               filename,
@@ -82,7 +82,7 @@ module Natour
         CSV.open(filename, 'r:bom|utf-16le:utf-8', col_sep: "\t", headers: true) do |csv|
           date = DateUtils.parse(Pathname(filename).basename).compact.first
           items = csv.select { |row| row[0] }
-                     .map { |row| Species.new(BotanicalNameUtils.parse(row[11]), nil) }
+                     .map { |row| Species.new(row[11], nil) }
                      .sort_by(&:name).uniq
           [SpeciesList.new(filename, date, :info_flora, :plants, nil, nil, items)]
         end

data/lib/natour/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Natour
-  VERSION = '0.10.0'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natour
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Simon Gysi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-18 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -213,6 +213,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".natour.yml"
 - CHANGELOG.adoc
 - LICENSE
 - README.adoc