natour 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a5853cf54dee642dc7cf5e2fef40e7a3379266ead197977c4804146b8334ef0
-  data.tar.gz: 13b08bc14434447bb5e6b18605f1c8a1fdadef8bba17e47154eec829095b3e13
+  metadata.gz: 1ac583bda8dbd5de8b922cc64bee346916b01c07b4ee986b845ef3c2c87985d0
+  data.tar.gz: 3e89dd11b0dda46ba30fdc62aec372068f5390209f7d119182d9340e4d5fbbfa
 SHA512:
-  metadata.gz: f829da1ae7ae12e9f753274e8200c8d3de4e0d7e6c8cf13d5cdcb6c2c1abb4bf0ce5d8837e22ff32ed4589d2f30c7a4d5175831c24dfe8e642a8cf279be96fa6
-  data.tar.gz: d144ee6947ada5321c828772db6364770dc8bea4616a3022e4c1f99bdc9a3df23e9f8bcd9c0e0dcf29fd74c945513539d19050d8780f0805e32e3ecd981ef69b
+  metadata.gz: 96b0e7a19722f0749d08fe5a51cc9b8491b1e0f04533aed2a07f0fc091ae27eb5df2f1e0c4dc1fd67ef21673840744b9aab27f28bd12376b7dfdd3c126d7b441
+  data.tar.gz: 55f7c5dbfa646ac25e715f3dc7a1b169fc72bc223bf49893f19bbd6d0cc3c5b773ad1bef64f3520ebe4290d1ec2ea7a28b1da745157de877cce9a485bcc55467

data/.natour.yml

@@ -10,6 +10,7 @@
     :map: true
     :map_layers: []
     :adoc_author: null
+    :short_species_names: false
   :convert:
     :out_dir: null
     :out_file: null

data/CHANGELOG.adoc

@@ -8,6 +8,21 @@ IMPORTANT: As per Semantic Versioning, the major version zero is for initial dev
 
 == 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
@@ -33,7 +48,7 @@ IMPORTANT: As per Semantic Versioning, the major version zero is for initial dev
 
 === Changed
 
-- Omit empty columns of species lists in AsciiDoc output.
+- Omit empty columns of species lists in the AsciiDoc output.
 
 === Fixed
 

data/README.adoc

@@ -94,7 +94,35 @@ The configuration is built by loading https://yaml.org/[YAML^] files in hierarch
 
 [source,yml]
 ----
-include::.natour.yml[]
+---
+: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]
 ----
 
 How to restrict GPS tracks to the FIT format (see https://developer.garmin.com/fit/[FIT SDK^]) and add additional map layers (see https://api3.geo.admin.ch/api/faq/index.html#which-layers-are-available[API FAQ - GeoAdmin API 3.0 documentation^]) is shown in the example below.

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)

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/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/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/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.11.0'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natour
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Simon Gysi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-15 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor