natour 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c649407352883c9e93ab6d6470413127d54803bb35dc72beb83292c9e521626
-  data.tar.gz: dbeb8f8ae4a412d7832c07ab66d717d40bb5e2ecd096fb076655ef65a6840b53
+  metadata.gz: 96d45e360af42e65ff67db55ff6e9814013e0a884ceb5b601ceec10731312181
+  data.tar.gz: f495db38dbdef792422945c891ddf830850a812513663e6cffd72fd4757f1b97
 SHA512:
-  metadata.gz: b5a810b2ea0220c9eded025e0f00f8e4f782a42b54128f71a2929a84a535e75f45bb3ddff0cf72f7dad08e047c1aaef3b88800e778901405357efd11336b5db0
-  data.tar.gz: a928d426c1840cb57fb7ab58064850572fc2a7e14aeda6086b2c9560c8b2d7e3e8253c268a9070bef91e4c7fb2c0f26daf2e5664a043f29b595d192a0299137f
+  metadata.gz: 2a520888a91305d5cd924d133d1356bc1021b0cf75c2ad7753e577e1a7455afbb610991c080a88ca5dc3e4c0bdc9895e36d518694a9e0b8faa6d27bfe0552ba8
+  data.tar.gz: eb6ca2cbc565dfd79e2ea06413a00a9362996cd45aca70b601e06fca58e6acae5d1bd47f2bbf0d8962f6b1a03922f3477446eca019d5648a1b4ad0334a509938

data/CHANGELOG.adoc

@@ -6,90 +6,125 @@ The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog^],
 
 == Unreleased
 
+== 0.8.0 - 2022-04-22
+
+=== Added
+
+- Add command to create map images from GPS tracks, waypoints and routes.
+- Add command line option to display the version of this gem.
+
+=== 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
+
+- Do not overwrite map images unless otherwise specified.
+- Do not abort if the configuration file is empty.
+
 == 0.7.0 - 2022-02-14
 
 === Added
 
-- Add support for Ruby 3.0 and 3.1
-- Support species lists from Vogelführer Birdlife Schweiz
+- Add support for Ruby 3.0 and 3.1.
+- Support species lists from https://www.birdlife.ch/de/content/eine-neue-moderne-vogel-app-fuer-die-schweiz[Vogelführer Birdlife Schweiz^].
 
 === Changed
 
-- Return the filenames from `create` and `convert`
+- Return the filenames from `Natour::create` and `Natour::convert`.
 
 === Removed
 
-- Drop support for Ruby 2.5
+- Drop support for Ruby 2.5.
 
 === Fixed
 
-- Add revision date to the AsciiDoc output regardless of the author
-- Prevent conversion from being aborted if a built-in date/time attribute is missing
+- Add revision date to the AsciiDoc output regardless of the author.
+- Prevent conversion from being aborted if a built-in date/time attribute is missing.
 
 == 0.6.0 - 2021-11-20
 
 === Fixed
 
-- Support GPX files containing only mandatory elements (i.e. no extensions)
-- Consider also the image dimensions to determine the orientation, even if the tag is present
+- Support GPX files containing only mandatory elements (i.e. no extensions).
+- Consider also the image dimensions to determine the orientation, even if the tag is present.
 
 == 0.5.0 - 2021-08-16
 
 === Added
 
-- Reflect the date of the last update in the revision date
-- Add captions to species lists in the AsciiDoc output
-- Group species lists by taxonomic groups in the AsciiDoc output
+- Reflect the date of the last update in the revision date.
+- Add captions to species lists in the AsciiDoc output.
+- Group species lists by taxonomic groups in the AsciiDoc output.
 
 === Fixed
 
-- Support species lists of Flora Helvetica exported from Favoriten
-- Consider botanical names with the authority name preceding the subspecies
+- Support species lists of https://www.flora-helvetica.ch/[Flora Helvetica^] exported from _Favoriten_.
+- Consider botanical names with the authority name preceding the subspecies.
 
 == 0.4.0 - 2021-05-02
 
 === Added
 
-- Show date/time of images in draft output
-- Support preferred conversion backend for draft output
+- Show date/time of images in draft output.
+- Support preferred conversion backend for draft output.
 
-=== Changed
+=== Removed
 
-- Remove redundant method `Image.portrait?`
+- Remove redundant method `Natour::Image.portrait?`.
++
+IMPORTANT: This is a breaking change. Use `Natour::Image.landscape?` instead.
 
 == 0.3.0 - 2021-03-07
 
 === Changed
 
-- Sort the reports according to their GPS track
-- Bump minimum required Ruby version to 2.5
-- Change font in PDF output to support ♀ and ♂ symbols
+- Sort the reports according to their GPS track.
+- Bump minimum required Ruby version to 2.5.
+- Change font in PDF output to support ♀ and ♂ symbols.
 
 === Fixed
 
-- Make source code compatible with Ruby version 2.5
+- Make source code compatible with Ruby 2.5.
 
 == 0.2.0 - 2021-01-24
 
 === Added
 
-- Add this gem's name to the footer of the PDF output
-- Support species lists from https://www.ornitho.ch/[ornitho.ch^] (KML format only)
-- Classify species lists by taxonomic groups (i.e. `SpeciesList.group`)
+- Add this gem's name to the footer of the PDF output.
+- Support species lists from https://www.ornitho.ch/[ornitho.ch^] (KML format only).
+- Classify species lists by taxonomic groups (i.e. `Natour::SpeciesList.group`).
 
 === Changed
 
-- Change `SpeciesList.name` to `SpeciesList.title`
-- Return an empty array from `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_
+- 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_.
 
 === Fixed
 
-- Get the date from images even if the orientation tag is missing
-- Fix typo in help message
+- Get the date from images even if the orientation tag is missing.
+- Fix typo in help message.
 
 == 0.1.0 - 2020-12-04
 
 === Added
-- First release
+- First release.

data/README.adoc

@@ -1,6 +1,6 @@
 = natour
 
-This https://rubygems.org/gems/natour[RubyGem^] provides an application and a library for reports on nature activities.
+This https://rubygems.org/gems/natour[RubyGem^] provides an application and a library to document nature activities.
 
 == Installation
 
@@ -58,49 +58,101 @@ sudo apt install ./google-chrome-stable_current_amd64.deb
 
 == Application
 
-[cols="1,4",options=header]
-|===
-|Command
-|Description
+Create reports in https://asciidoc.org/[AsciiDoc^] format from a directory with GPS tracks, images and species lists. After editing the AsciiDoc files (e.g. selecting the images and describing the adventure), they can be converted to various formats, including PDF and HTML. A typical directory structure and the necessary commands are shown in the following example.
+
+....
+└─ 2022-02-26 Monte Caslano             < Root directory
+   ├─ Bilder                            < Directory containing images
+   │  ├─ IMG_7687.JPG
+   │  ├─ IMG_7688.JPG
+   │  ├─ ...
+   │  └─ IMG_7870.JPG
+   ├─ 2022-02-26 14.45.27.fit           < GPS track exported by GPS device
+   ├─ 2022-02-26 14.45.27.gpx           < GPS track exported by GPS device
+   ├─ 2022-02-26 14.45.27.jpg           < Image of the map section created
+   ├─ 2022-02-26 Monte Caslano.adoc     < Report in AsciiDoc format created
+   ├─ 2022-02-26 Monte Caslano.pdf      < Report converted from AsciiDoc to PDF
+   ├─ 2022-02-26MonteCaslano.csv        < Species list exported from Kosmos Vogelführer
+   └─ flora_helvetica_sammlungen.csv    < Species list exported from Flora Helvetica
+....
 
-|`natour`
-|Create reports in https://asciidoc.org/[AsciiDoc^] format from a directory with GPS tracks, images and species lists. After editing the AsciiDoc files, they can be converted to various formats, including PDF and HTML. Use `natour --help` to get more information.
-|===
+[source,shell]
+----
+natour report create "2022-02-26 Monte Caslano"
+----
+
+[source,shell]
+----
+natour report convert "2022-02-26 Monte Caslano/2022-02-26 Monte Caslano.adoc"
+----
+
+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 key-value pairs are stored internally in a Ruby Hash, where the keys correspond to the command line arguments without leading dashes and without `no-` prefix for boolean switches.
+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]
+----
+---
+:report:
+  :create:
+    :out_dir: null
+    :out_file: null
+    :overwrite: false
+    :track_formats:
+      - :gpx
+      - :fit
+    :map: true
+    :map_layers: []
+    :adoc_author: null
+  :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
+    :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.
 
 [source,yml]
 ----
 ---
-track-formats:
-  - !ruby/sym fit
-map-layers:
-  - ch.swisstopo.swisstlm3d-wanderwege
-  - ch.bav.haltestellen-oev
+:report:
+  :create:
+    :track_formats:
+      - :fit
+    :map_layers:
+      - ch.swisstopo.swisstlm3d-wanderwege
+      - ch.bav.haltestellen-oev
 ----
 
 == Library
 
-=== Basic Use
-
 The basic use is shown in the following example. For details, see the source code and the unit tests.
 
 [source,ruby]
 ----
 require 'natour'
 
-Natour::create('path/to/dir')
+Natour::create_reports('path/to/dir')
 ----
 
 [source,ruby]
 ----
 require 'natour'
 
-Natour::convert('path/to/dir/report.adoc')
+Natour::convert_report('path/to/dir/report.adoc')
 ----
 
 === Testing

data/bin/natour

@@ -1,117 +1,165 @@
 #!/usr/bin/env ruby
 
-require 'word_wrap'
-require 'pathname'
-require 'optparse'
+require 'clamp'
 require 'natour'
+require 'pathname'
+require 'word_wrap'
 
-config = Natour::Config.load_file(
-  Pathname($PROGRAM_NAME).basename.sub_ext('.yml'),
-  default: {
-    'out-dir' => nil,
-    'out-file' => nil,
-    'overwrite' => false,
-    'track-formats' => %i[gpx fit],
-    'map' => true,
-    'map-layers' => [],
-    'adoc-author' => nil,
-    'backend' => 'pdf',
-    'draft' => false,
-    'draft-backend' => nil,
-    'image-maxdim' => 1800
-  }
-)
+class NatourCmd < Clamp::Command
+  class ReportCmd < Clamp::Command
+    class CreateCmd < Clamp::Command
+      banner(WordWrap.ww(
+        'Create reports in AsciiDoc format from a directory. GPS tracks, images and species ' \
+        'lists (Kosmos Vogelführer, Vogelführer Birdlife Schweiz, ornitho.ch, Flora Helvetica, ' \
+        'Info Flora Online-Feldbuch) are included. Images of the map section covered by the GPS ' \
+        'tracks are also created and included.'
+      ))
+      option(%w[-d --out-dir], 'DIR', 'Output directory')
+      option(%w[-f --out-file], 'FILE', 'Output filename')
+      option(%W[--\[no-\]overwrite], :flag, 'Overwrite existing files')
+      option(%w[--track-formats], 'FORMATS', 'GPS track formats (gpx, fit)') { |s| s.split(',').map(&:to_sym) }
+      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>...])')
+      parameter('PATH', 'Path to directory')
 
-option_parser = OptionParser.new do |opts|
-  opts.banner = "Usage: #{Pathname($PROGRAM_NAME).basename('.*')} [OPTIONS]... PATH"
-  opts.separator('')
-  opts.separator(WordWrap.ww(
-    'If PATH refers to a directory, one or more reports are created in ' \
-    'AsciiDoc format. GPS tracks, images and species lists (Kosmos ' \
-    'Vogelführer, Vogelführer Birdlife Schweiz, ornitho.ch, Flora Helvetica,' \
-    ' Info Flora Online-Feldbuch) are included. Images of the map section ' \
-    'covered by the GPS tracks are also created and included. If PATH refers' \
-    ' to an AsciiDoc file, it is converted to PDF (or any other supported ' \
-    'format).'
-  ))
-  opts.separator('')
-  opts.separator('General:')
-  opts.on('-h', '--help', 'Display this help screen') do
-    $stdout.puts(opts)
-    exit
-  end
-  opts.on('-d', '--out-dir DIR', 'Output directory') do |value|
-    config['out-dir'] = value
-  end
-  opts.on('-f', '--out-file FILE', 'Output filename') do |value|
-    config['out-file'] = value
-  end
-  opts.on('--[no-]overwrite', 'Overwrite existing files') do |value|
-    config['overwrite'] = value
-  end
-  opts.separator('')
-  opts.separator('Creation:')
-  opts.on('--track-formats FORMATS', Array, 'GPS track formats (gpx, fit)') do |value|
-    config['track-formats'] = value.map(&:to_sym)
-  end
-  opts.on('--[no-]map', 'Create map images') do |value|
-    config['map'] = value
-  end
-  opts.on('--map-layers LAYERS', Array, 'Add additional layers to map images') do |value|
-    config['map-layers'] = value
-  end
-  opts.on('--adoc-author AUTHOR', 'AsciiDoc author (name <email>[; name2 <email2>...])') do |value|
-    config['adoc-author'] = value
-  end
-  opts.separator('')
-  opts.separator('Conversion:')
-  opts.on('-b', '--backend BACKEND', 'Conversion backend (pdf, html5 ...)') do |value|
-    config['backend'] = value
-  end
-  opts.on('--[no-]draft', 'Show additional information (e.g. image paths)') do |value|
-    config['draft'] = value
-  end
-  opts.on('--draft-backend BACKEND', 'Preferred conversion backend for draft (pdf, html5 ...)') do |value|
-    config['draft-backend'] = value
-  end
-  opts.on('--image-maxdim DIM', 'Shrink oversized images (PDF only)') do |value|
-    config['image-maxdim'] = value.to_i
+      def execute
+        config = context[:config][:report][:create]
+        Natour.create_reports(
+          path.encode('utf-8').delete_suffix('"').gsub('\\', '/'),
+          out_dir: out_dir || config[:out_dir],
+          out_file: out_file || config[:out_file],
+          overwrite: Natour::BooleanUtils.to_boolean(overwrite?, default_value: config[:overwrite]),
+          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]
+        )
+      rescue Errno::EEXIST, Errno::ENOENT, Errno::EACCES, Errno::EINVAL => e
+        message, _, path = Natour::ErrnoUtils.split_message(e)
+        abort("ERROR: #{message} '#{path}'")
+      end
+    end
+
+    class ConvertCmd < Clamp::Command
+      banner(WordWrap.ww(
+        'Convert a report from AsciiDoc to PDF or HTML (or any other supported format).'
+      ))
+      option(%w[-d --out-dir], 'DIR', 'Output directory')
+      option(%w[-f --out-file], 'FILE', 'Output filename')
+      option(%W[--\[no-\]overwrite], :flag, 'Overwrite existing files')
+      option(%w[-b --backend], 'BACKEND', 'Conversion backend (pdf, html5 ...)', &:to_sym)
+      option(%W[--\[no-\]draft], :flag, 'Show additional information (e.g. image paths)')
+      option(%w[--draft-backend], 'BACKEND', 'Preferred conversion backend for draft (pdf, html5 ...)', &:to_sym)
+      option(%w[--image-maxdim], 'DIM', 'Shrink oversized images (PDF only)') { |s| Integer(s) }
+      parameter('PATH', 'Path to AsciiDoc file')
+
+      def execute
+        config = context[:config][:report][:convert]
+        Natour.convert_report(
+          path.encode('utf-8').delete_suffix('"').gsub('\\', '/'),
+          out_dir: out_dir || config[:out_dir],
+          out_file: out_file || config[:out_file],
+          overwrite: Natour::BooleanUtils.to_boolean(overwrite?, default_value: config[:overwrite]),
+          backend: backend || config[:backend],
+          draft: Natour::BooleanUtils.to_boolean(draft?, default_value: config[:draft]),
+          draft_backend: draft_backend || config[:draft_backend],
+          image_maxdim: image_maxdim || config[:image_maxdim]
+        )
+      rescue Errno::EEXIST, Errno::ENOENT, Errno::EACCES, Errno::EISDIR => e
+        message, _, path = Natour::ErrnoUtils.split_message(e)
+        abort("ERROR: #{message} '#{path}'")
+      end
+    end
+
+    subcommand('create', 'Create AsciiDoc reports from directory', CreateCmd)
+    subcommand('convert', 'Convert AsciiDoc report to PDF or HTML', ConvertCmd)
   end
-end
 
-begin
-  option_parser.parse!
-rescue OptionParser::InvalidArgument,
-       OptionParser::InvalidOption => e
-  abort("Error: #{e}")
-end
+  class MapCmd < Clamp::Command
+    class CreateCmd < Clamp::Command
+      banner(WordWrap.ww(
+        'Create images of the map section covered by the GPS files. The GPS files must be in GPX' \
+        ' or KML format and contain tracks, waypoints or routes. The images are saved in JPG or ' \
+        'PNG format.'
+      ))
+      option(%w[-d --out-dir], 'DIR', 'Output directory')
+      option(%w[-f --out-file], 'FILE', 'Output filename')
+      option(%W[--\[no-\]overwrite], :flag, 'Overwrite existing files')
+      option(%w[--map-layers], 'LAYERS', 'Add additional layers to map images') { |s| s.split(',') }
+      option(%w[--image-size], 'WIDTH,HEIGHT', 'Image size') do |s|
+        s.split(',', 2).map { |v| Integer(v) }
+      end
+      parameter('PATH ...', 'Paths to GPS files', attribute_name: :paths)
 
-abort('Error: wrong number of arguments') if ARGV.length != 1
+      def execute
+        config = context[:config][:map][:create]
+        Natour::MapGeoAdmin.open do |map|
+          filename = Pathname(out_dir || config[:out_dir] || Pathname(paths.first).dirname)
+                     .join(out_file || config[:out_file] || Pathname(paths.first).basename.sub_ext('.jpg'))
+          map.save_image(
+            filename,
+            overwrite: Natour::BooleanUtils.to_boolean(overwrite?, default_value: config[:overwrite]),
+            gps_files: paths,
+            map_layers: map_layers || config[:map_layers],
+            image_size: image_size || config[:image_size]
+          )
+        end
+      rescue Errno::EEXIST, Errno::ENOENT, Errno::EACCES => e
+        message, _, path = Natour::ErrnoUtils.split_message(e)
+        abort("ERROR: #{message} '#{path}'")
+      end
+    end
 
-path = Pathname(ARGV[0].encode('utf-8')
-                       .delete_suffix('"')
-                       .gsub('\\', '/'))
+    subcommand('create', 'Create map images from GPS files', CreateCmd)
+  end
 
-if path.directory?
-  Natour.create(
-    path,
-    out_dir: config['out-dir'],
-    out_file: config['out-file'],
-    overwrite: config['overwrite'],
-    track_formats: config['track-formats'],
-    create_map: config['map'],
-    map_layers: config['map-layers'],
-    adoc_author: config['adoc-author']
-  )
-else
-  Natour.convert(
-    path,
-    out_dir: config['out-dir'],
-    out_file: config['out-file'],
-    overwrite: config['overwrite'],
-    backend: config['backend'],
-    draft: config['draft'],
-    draft_backend: config['draft-backend'],
-    image_maxdim: config['image-maxdim']
-  )
+  subcommand('report', 'Create or convert reports', ReportCmd)
+  subcommand('map', 'Create map images', MapCmd)
+
+  option(%w[-v --version], :flag, 'Display the version') do
+    $stdout.puts("#{invocation_path} #{Natour::VERSION}")
+    exit
+  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,
+        map_layers: [],
+        image_size: [1200, 900]
+      }
+    }
+  }
+)
+
+NatourCmd.run(
+  Pathname($PROGRAM_NAME).basename,
+  ARGV,
+  { config: config }
+)

data/lib/natour/asciinurse.rb

@@ -1,6 +1,6 @@
 require 'fileutils'
-require 'pathname'
 require 'ostruct'
+require 'pathname'
 
 module Natour
   module Asciinurse
@@ -120,7 +120,8 @@ module Natour
             doc << '|==='
             doc << "|Nr.|#{info.headers.join('|')}"
             species_list.each do |species|
-              doc << "|{counter:species_list#{index}}|#{info.columns.map { |method| species.send(method) }.join('|')}"
+              doc <<
+                "|{counter:species_list#{index}}|#{info.columns.map { |method| species.public_send(method) }.join('|')}"
             end
             doc << '|==='
             doc << ''

data/lib/natour/config.rb

@@ -1,17 +1,20 @@
+require 'deep_merge/rails_compat'
 require 'pathname'
 require 'yaml'
 
 module Natour
   class Config
     def self.load_file(filename, default: {}, dirs: [Dir.home, Dir.pwd])
-      dirs.map do |dir|
-        YAML.safe_load(
+      configs = dirs.map do |dir|
+        config = YAML.safe_load(
           File.read(Pathname(dir).join(filename)),
           permitted_classes: [Symbol]
         )
+        config || {}
       rescue Errno::ENOENT
         {}
-      end.reduce(default, &:merge)
+      end
+      configs.reduce(default) { |dst, src| dst.deeper_merge!(src, overwrite_arrays: true) }
     end
   end
 end

data/lib/natour/{convert.rb → convert_report.rb}

@@ -1,15 +1,15 @@
-require 'fileutils'
-require 'pathname'
 require 'asciidoctor'
 require 'asciidoctor-pdf'
-require 'vips'
+require 'fileutils'
+require 'pathname'
 require 'time'
+require 'vips'
 
 module Natour
   module_function
 
-  def convert(filename, out_dir: nil, out_file: nil, overwrite: false,
-              backend: 'pdf', draft: false, draft_backend: nil, image_maxdim: 16000)
+  def convert_report(filename, out_dir: nil, out_file: nil, overwrite: false,
+                     backend: :pdf, draft: false, draft_backend: nil, image_maxdim: 16000)
     backend = if draft
                 draft_backend || backend
               else
@@ -65,7 +65,7 @@ module Natour
       end
     end
 
-    if backend == 'pdf'
+    if backend == :pdf
       Dir.mktmpdir do |tmp_dir|
         tmp_dir = Pathname(tmp_dir)
 

data/lib/natour/{create.rb → create_reports.rb}

@@ -1,12 +1,14 @@
+require 'pathname'
+
 module Natour
   module_function
 
-  def create(dir, out_dir: nil, out_file: nil, overwrite: false,
-             track_formats: %i[gpx fit], create_map: true, map_layers: [], adoc_author: nil)
+  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)
     out_dir = Pathname(out_dir || dir)
     out_file = Pathname(out_file || "#{Pathname(dir).realpath.basename}.adoc")
     reports = Report.load_directory(
-      dir, track_formats: track_formats, create_map: create_map, map_layers: map_layers
+      dir, track_formats: track_formats, create_map: create_map, overwrite_map: overwrite, map_layers: map_layers
     )
     reports.map.with_index(1) do |report, index|
       filename = if index < 2

data/lib/natour/fit_file.rb

@@ -1,7 +1,7 @@
+require 'date'
+require 'duration'
 require 'fit4ruby'
 require 'nokogiri'
-require 'duration'
-require 'date'
 require 'time'
 
 module Natour

data/lib/natour/gps_track.rb

@@ -1,6 +1,6 @@
+require 'duration'
 require 'fileutils'
 require 'pathname'
-require 'duration'
 require 'time'
 
 module Natour

data/lib/natour/gpx_file.rb

@@ -1,5 +1,5 @@
-require 'nokogiri'
 require 'duration'
+require 'nokogiri'
 require 'timeliness'
 
 module Natour

data/lib/natour/image.rb

@@ -1,7 +1,7 @@
-require 'vips'
-require 'timeliness'
 require 'fileutils'
 require 'pathname'
+require 'timeliness'
+require 'vips'
 
 module Natour
   class Image

data/lib/natour/map_geo_admin.rb

@@ -1,14 +1,14 @@
-require 'fileutils'
-require 'pathname'
-require 'webrick'
 require 'concurrent'
 require 'ferrum'
+require 'fileutils'
+require 'pathname'
 require 'uri'
+require 'webrick'
 
 module Natour
   class MapGeoAdmin
     def initialize(port: 0)
-      @doc_root = Dir.mktmpdir
+      @doc_root = Pathname(Dir.mktmpdir)
       FileUtils.cp_r("#{__dir__}/data/js", @doc_root)
       event = Concurrent::Event.new
       @server = WEBrick::HTTPServer.new(
@@ -36,21 +36,27 @@ module Natour
       FileUtils.remove_entry(@doc_root)
     end
 
-    def save_image(filename, tracks: [], layers: [], size: [1200, 900])
-      FileUtils.cp(tracks, @doc_root)
-      FileUtils.mkdir_p(Pathname(filename).dirname)
+    def save_image(filename, overwrite: false, gps_files: [], map_layers: [], image_size: [1200, 900])
+      FileUtils.cp(gps_files, @doc_root)
       uri = URI("http://#{@server[:BindAddress]}:#{@server[:Port]}/map")
       uri.query = URI.encode_www_form(
-        tracks: tracks.map { |track| Pathname(track).basename }.join(','),
-        layers: layers.join(','),
-        size: size.map { |dim| dim.is_a?(String) ? dim : "#{dim}px" }.join(',')
+        'gps-files': gps_files.map { |gps_file| Pathname(gps_file).basename }.join(','),
+        'map-layers': map_layers.join(','),
+        'map-size': image_size.map { |dim| dim.is_a?(String) ? dim : "#{dim}px" }.join(',')
       )
       @browser.goto(uri)
+      tmp_filename = @doc_root.join(Pathname(filename).basename)
       @browser.screenshot(
-        path: filename,
+        path: tmp_filename,
         quality: 100,
         selector: '.map'
       )
+      FileUtils.mkdir_p(Pathname(filename).dirname)
+      mode = File::WRONLY | File::CREAT | File::TRUNC | File::BINARY
+      mode |= File::EXCL unless overwrite
+      File.open(filename, mode) do |file|
+        file.write(File.read(tmp_filename, mode: 'rb'))
+      end
     end
 
     def self.open(*args)
@@ -66,11 +72,11 @@ module Natour
       def do_GET(request, response) # rubocop:disable Naming/MethodName
         raise WEBrick::HTTPStatus::NotFound unless request.path == '/map'
 
-        tracks = request.query.fetch('tracks', '').split(',')
-        layers = request.query.fetch('layers', '').split(',')
+        files = request.query.fetch('gps-files', '').split(',')
+        layers = request.query.fetch('map-layers', '').split(',')
         layers.unshift('ch.swisstopo.pixelkarte-farbe')
 
-        width, height = request.query.fetch('size', '').split(',')
+        width, height = request.query.fetch('map-size', '').split(',')
         raise WEBrick::HTTPStatus::BadRequest unless width && height
 
         doc = []
@@ -90,27 +96,65 @@ module Natour
         doc << '    layers.forEach(function(layer) {'
         doc << '      map.addLayer(ga.layer.create(layer))'
         doc << '    })'
-        doc << "    var tracks = [#{tracks.map { |track| "\"#{track}\"" }.join(', ')}]"
-        doc << '    tracks = tracks.map(function(track) {'
-        doc << '      return new ol.layer.Vector({'
-        doc << '        source: new ol.source.Vector({'
-        doc << '          format: new ol.format.GPX(),'
-        doc << '          url: track'
-        doc << '        }),'
-        doc << '        style: new ol.style.Style({'
+        doc << '    var styles = {'
+        doc << '      "Point": new ol.style.Style({'
+        doc << '        image: new ol.style.Circle({'
+        doc << '          fill: new ol.style.Fill({'
+        doc << '            color: function() {'
+        doc << '              var color = "blueviolet"'
+        doc << '              var alpha = 0.3'
+        doc << '              var [r, g, b] = ol.color.asArray(color)'
+        doc << '              return ol.color.asString([r, g, b, alpha])'
+        doc << '            }()'
+        doc << '          }),'
+        doc << '          radius: 6,'
         doc << '          stroke: new ol.style.Stroke({'
         doc << '            color: "blueviolet",'
-        doc << '            width: 3'
+        doc << '            width: 1.5'
         doc << '          })'
         doc << '        })'
+        doc << '      }),'
+        doc << '      "LineString": new ol.style.Style({'
+        doc << '        stroke: new ol.style.Stroke({'
+        doc << '          color: "blueviolet",'
+        doc << '          width: 3'
+        doc << '        })'
+        doc << '      }),'
+        doc << '      "MultiLineString": new ol.style.Style({'
+        doc << '        stroke: new ol.style.Stroke({'
+        doc << '          color: "blueviolet",'
+        doc << '          width: 3'
+        doc << '        })'
+        doc << '      })'
+        doc << '    }'
+        doc << "    var files = [#{files.map { |file| "\"#{file}\"" }.join(', ')}]"
+        doc << '    var vectors = files.map(function(file) {'
+        doc << '      return new ol.layer.Vector({'
+        doc << '        source: new ol.source.Vector({'
+        doc << '          format: function() {'
+        doc << '            if (file.endsWith(".gpx")) {'
+        doc << '              return new ol.format.GPX()'
+        doc << '            } else if (file.endsWith(".kml")) {'
+        doc << '              return new ol.format.KML({'
+        doc << '                extractStyles: false'
+        doc << '              })'
+        doc << '            } else {'
+        doc << '              return null'
+        doc << '            }'
+        doc << '          }(),'
+        doc << '          url: file'
+        doc << '        }),'
+        doc << '        style: function(feature) {'
+        doc << '          return styles[feature.getGeometry().getType()]'
+        doc << '        }'
         doc << '      })'
         doc << '    })'
-        doc << '    tracks.forEach(function(track) {'
-        doc << '      map.addLayer(track)'
-        doc << '      track.getSource().on("change", function(evt) {'
+        doc << '    vectors.forEach(function(vector) {'
+        doc << '      map.addLayer(vector)'
+        doc << '      vector.getSource().on("change", function(evt) {'
         doc << '        var extent = ol.extent.createEmpty()'
-        doc << '        tracks.forEach(function(track) {'
-        doc << '          ol.extent.extend(extent, track.getSource().getExtent())'
+        doc << '        vectors.forEach(function(vector) {'
+        doc << '          ol.extent.extend(extent, vector.getSource().getExtent())'
         doc << '        })'
         doc << '        map.getView().fit(extent, map.getSize())'
         doc << '      })'

data/lib/natour/public_transport.rb

@@ -1,7 +1,7 @@
-require 'uri'
+require 'json'
 require 'net/http'
 require 'openssl'
-require 'json'
+require 'uri'
 
 module Natour
   class PublicTransport

data/lib/natour/report.rb

@@ -29,7 +29,7 @@ module Natour
       @arrival_point = arrival_point
     end
 
-    def self.load_directory(dir, track_formats: %i[gpx fit], create_map: true, map_layers: [])
+    def self.load_directory(dir, track_formats: %i[gpx fit], create_map: true, overwrite_map: false, map_layers: [])
       Dir.chdir(dir) do
         path = Pathname(dir)
         title = Pathname.pwd.basename.to_s.encode('utf-8')
@@ -61,7 +61,7 @@ module Natour
                 track = Pathname(tmp_dir).join(gps_track.path).sub_ext('.gpx')
                 gps_track.save_gpx(track, overwrite: true)
                 filename = Pathname(gps_track.path).sub_ext('.jpg')
-                map.save_image(filename, tracks: [track], layers: map_layers)
+                map.save_image(filename, overwrite: overwrite_map, gps_files: [track], map_layers: map_layers)
                 Image.load_file(filename.to_s)
               end
             end

data/lib/natour/utils/boolean_utils.rb

@@ -0,0 +1,11 @@
+module Natour
+  module BooleanUtils
+    module_function
+
+    def to_boolean(value, default_value: false)
+      return !!value unless value.nil?
+
+      !!default_value
+    end
+  end
+end

data/lib/natour/utils/errno_utils.rb

@@ -0,0 +1,9 @@
+module Natour
+  module ErrnoUtils
+    module_function
+
+    def split_message(error)
+      error.message.split(/ @ | - /, 3)
+    end
+  end
+end

data/lib/natour/version.rb

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

data/lib/natour.rb

@@ -1,18 +1,21 @@
-require 'natour/utils/botanical_name_utils'
-require 'natour/utils/date_utils'
-require 'natour/utils/stdout_utils'
-require 'natour/convert'
-require 'natour/create'
-require 'natour/asciinurse'
-require 'natour/config'
-require 'natour/gps_track'
-require 'natour/gps_track_point'
-require 'natour/gpx_file'
-require 'natour/fit_file'
-require 'natour/image'
-require 'natour/map_geo_admin'
-require 'natour/public_transport'
-require 'natour/report'
-require 'natour/species'
-require 'natour/species_list'
-require 'natour/station'
+require_relative 'natour/utils/boolean_utils'
+require_relative 'natour/utils/botanical_name_utils'
+require_relative 'natour/utils/date_utils'
+require_relative 'natour/utils/errno_utils'
+require_relative 'natour/utils/stdout_utils'
+require_relative 'natour/asciinurse'
+require_relative 'natour/config'
+require_relative 'natour/convert_report'
+require_relative 'natour/create_reports'
+require_relative 'natour/gps_track'
+require_relative 'natour/gps_track_point'
+require_relative 'natour/gpx_file'
+require_relative 'natour/fit_file'
+require_relative 'natour/image'
+require_relative 'natour/map_geo_admin'
+require_relative 'natour/public_transport'
+require_relative 'natour/report'
+require_relative 'natour/species'
+require_relative 'natour/species_list'
+require_relative 'natour/station'
+require_relative 'natour/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natour
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Simon Gysi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: ferrum
   requirement: !ruby/object:Gem::Requirement
@@ -192,8 +220,8 @@ files:
 - lib/natour.rb
 - lib/natour/asciinurse.rb
 - lib/natour/config.rb
-- lib/natour/convert.rb
-- lib/natour/create.rb
+- lib/natour/convert_report.rb
+- lib/natour/create_reports.rb
 - lib/natour/data/fonts/dejavuserifcondensed-bold.ttf
 - lib/natour/data/fonts/dejavuserifcondensed-bold_italic.ttf
 - lib/natour/data/fonts/dejavuserifcondensed-italic.ttf
@@ -213,9 +241,12 @@ files:
 - lib/natour/species.rb
 - lib/natour/species_list.rb
 - lib/natour/station.rb
+- lib/natour/utils/boolean_utils.rb
 - lib/natour/utils/botanical_name_utils.rb
 - lib/natour/utils/date_utils.rb
+- lib/natour/utils/errno_utils.rb
 - lib/natour/utils/stdout_utils.rb
+- lib/natour/version.rb
 homepage: https://github.com/simongysi/natour
 licenses:
 - MIT
@@ -238,8 +269,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: natour provides an application and a library for reports on nature activities
+summary: natour provides an application and a library to document nature activities.
 test_files: []