natour 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a465921bd4e696f168be735851b576e1ec95eca0396eb52581801a16d9c75e1
+  data.tar.gz: 5c0fd93836e21d57752a185842c17787894b8c56d1850564240a6f88b514dcb5
+SHA512:
+  metadata.gz: d39f3f80ab7bc2ee632d3458d623e8f7bb517c19b2f8c3d3fcc110c15ff8c09c646e52fb59623ca3be7c7f08877e527991c5f2774c41f1f17f4752d8b7a636ff
+  data.tar.gz: d20556324500e26c3d428c6925f0e5ceefad9dfd790f78083e25d38fe28e27756653f5eecb5f9545b978a36a28a761dd9d257fafa8ca1ff0c75b62d9d0670308

data/CHANGELOG.adoc

@@ -0,0 +1,12 @@
+= natour Changelog
+
+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^].
+
+== Unreleased
+
+== 0.1.0 - 2020-12-04
+
+=== Added
+- First release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Simon Gysi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.adoc

@@ -0,0 +1,122 @@
+= natour
+
+This https://rubygems.org/[RubyGem^] provides an application and a library for reports on nature activities.
+
+== Installation
+
+. Install the <<Prerequisites>>
+. Install the gem
++
+NOTE: Use `sudo` on Ubuntu
++
+[source,shell]
+----
+gem install natour
+----
+
+=== Prerequisites
+
+Install the required components by following the instructions below. Please read the installation guide of the components if you encounter any problems or if your OS is not listed below (e.{nbsp}g. macOS).
+
+==== Windows
+
+. Download and install the latest version from https://rubyinstaller.org/[RubyInstaller for Windows^]
+. Download and install the latest version from https://www.google.com/chrome/[Google Chrome-Webbroser^]
+. Add `BROWSER_PATH=path\to\chrome.exe` to the environment variables
+. Log off Windows and back on again to ensure the environment variable takes effect
+
+==== Ubuntu
+
+. Install https://www.ruby-lang.org/[Ruby^]
++
+[source,shell]
+----
+sudo apt install ruby
+----
+
+. Install https://nokogiri.org/[Nokogiri^] dependencies
++
+[source,shell]
+----
+sudo apt install build-essential patch ruby-dev zlib1g-dev liblzma-dev
+----
+
+. Install https://libvips.github.io/libvips/[libvips^]
++
+[source,shell]
+----
+sudo apt install libvips42
+----
+
+. Install https://www.google.com/chrome/[Google Chrome-Webbroser^]
++
+[source,shell]
+----
+wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+sudo apt install ./google-chrome-stable_current_amd64.deb
+----
+
+== Application
+
+[cols="1,4",options=header]
+|===
+|Command
+|Description
+
+|`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.
+|===
+
+=== 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.
+
+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
+----
+
+== 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')
+----
+
+[source,ruby]
+----
+require 'natour'
+
+Natour::convert('path/to/dir/report.adoc')
+----
+
+=== Testing
+
+Execute the following command to run the tests. Add `-Ilib` to the command to run the tests against the library sources instead of the installed gem.
+
+NOTE: Some tests require an Internet connection.
+
+[source,shell]
+----
+ruby ./test/test.rb
+----
+
+Run the following command to check the style and formatting by https://rubocop.org/[RuboCop^].
+
+[source,shell]
+----
+rubocop
+----

data/bin/natour

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+
+require 'word_wrap'
+require 'pathname'
+require 'optparse'
+require 'natour'
+
+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,
+    'image-maxdim' => 1800
+  }
+)
+
+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, 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('--image-maxdim DIM', 'Shrink oversized images (PDF only)') do |value|
+    config['image-maxdim'] = value.to_i
+  end
+end
+
+begin
+  option_parser.parse!
+rescue OptionParser::InvalidArgument,
+       OptionParser::InvalidOption => e
+  abort("Error: #{e}")
+end
+
+abort('Error: wrong number of arguments') if ARGV.length != 1
+
+path = Pathname(ARGV[0].encode('utf-8')
+                       .delete_suffix('"')
+                       .gsub('\\', '/'))
+
+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'],
+    image_maxdim: config['image-maxdim']
+  )
+end

data/lib/natour.rb

@@ -0,0 +1,17 @@
+require 'natour/cli/convert'
+require 'natour/cli/create'
+require 'natour/helpers/date_parser'
+require 'natour/helpers/suppress_output'
+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'

data/lib/natour/asciinurse.rb

@@ -0,0 +1,126 @@
+require 'fileutils'
+require 'pathname'
+require 'ostruct'
+
+module Natour
+  module Asciinurse
+    def save_adoc(filename, overwrite: false, author: nil)
+      dir = Pathname(filename).dirname
+      FileUtils.mkdir_p(dir)
+      mode = File::WRONLY | File::CREAT | File::TRUNC
+      mode |= File::EXCL unless overwrite
+      File.open(filename, mode) do |file|
+        file.write(to_adoc(
+          doc_root: Pathname(path).realpath
+                                  .relative_path_from(dir.realpath)
+                                  .to_s.force_encoding('utf-8'),
+          author: author
+        ))
+      end
+    end
+
+    def to_adoc(doc_root: '.', author: nil)
+      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 }
+
+      title_image = images.find(&:landscape?)
+
+      doc = []
+      doc << "= #{title}"
+      if author
+        doc << author
+        doc << Date.today.strftime('%d.%m.%Y')
+      end
+      doc << ':figure-caption!:'
+      doc << ':pdf-page-mode: none'
+      doc << ':title-page:'
+      if title_image
+        doc << ":title-image: #{Pathname(doc_root).join(title_image.path)}"
+        doc << ':title-logo-image: image::{title-image}[top=0%]'
+        doc << ''
+        doc << 'ifndef::backend-pdf[]'
+        doc << 'image::{title-image}[]'
+        doc << 'endif::[]'
+      end
+      doc << ''
+      doc << '<<<'
+      doc << ''
+      doc << '== Allgemein'
+      doc << ''
+      doc << '[cols="h,3"]'
+      doc << '|==='
+      doc << "|Datum      |#{gps_track&.date&.strftime('%d.%m.%Y')}"
+      doc << "|Startzeit  |#{gps_track&.start_point&.time&.strftime('%H:%M')}"
+      doc << "|Dauer      |#{gps_track&.duration&.strftime('%thh%M')}"
+      doc << "|Strecke    |#{distance.call(gps_track)}"
+      doc << "|Aufstieg   |#{ascent.call(gps_track)}"
+      doc << "|Abstieg    |#{descent.call(gps_track)}"
+      doc << "|Ausgangsort|#{starting_point}"
+      doc << "|Ankunftsort|#{arrival_point}"
+      doc << '|Teilnehmer |'
+      doc << '|==='
+      doc << ''
+      if map_image
+        doc << "image::#{Pathname(doc_root).join(map_image.path)}[]"
+        doc << ''
+      end
+      doc << '<<<'
+      doc << ''
+      doc << '== Beschreibung'
+      doc << ''
+      doc << ''
+      doc << ''
+      unless images.empty?
+        doc << '<<<'
+        doc << ''
+        doc << '== Bilder'
+        doc << ''
+        images.each do |image|
+          width = if image.portrait?
+                    '40%'
+                  else
+                    '80%'
+                  end
+          doc << '.Abbildung {counter:image}'
+          doc << "image::#{Pathname(doc_root).join(image.path)}[width=#{width}]"
+          doc << ''
+        end
+      end
+      unless species_lists.empty?
+        birds_info = OpenStruct.new(
+          title: 'Vogelarten',
+          headers: %w[Deutscher\ Name Wissenschaftlicher\ Name],
+          columns: %i[name_de name]
+        )
+        plants_info = OpenStruct.new(
+          title: 'Pflanzenarten',
+          headers: %w[Wissenschaftlicher\ Name Deutscher\ Name],
+          columns: %i[name name_de]
+        )
+        doc << '<<<'
+        doc << ''
+        doc << '== Artenlisten'
+        doc << ''
+        species_lists.each.with_index(1) do |species_list, index|
+          info = {
+            kosmos_vogelfuehrer: birds_info,
+            flora_helvetica: plants_info,
+            info_flora: plants_info
+          }[species_list.type]
+          doc << "=== #{info.title}"
+          doc << ''
+          doc << '[cols="1,5,5",options=header]'
+          doc << '|==='
+          doc << "|Nr.|#{info.headers.join('|')}"
+          species_list.each do |species|
+            doc << "|{counter:species_list#{index}}|#{info.columns.map { |method| species.send(method) }.join('|')}"
+          end
+          doc << '|==='
+          doc << ''
+        end
+      end
+      doc.join("\n")
+    end
+  end
+end

data/lib/natour/cli/convert.rb

@@ -0,0 +1,76 @@
+require 'fileutils'
+require 'pathname'
+require 'asciidoctor'
+require 'asciidoctor-pdf'
+require 'vips'
+
+module Natour
+  module_function
+
+  def convert(filename, out_dir: nil, out_file: nil, overwrite: false,
+              backend: 'pdf', draft: false, image_maxdim: 16000)
+    doc = Asciidoctor.load_file(
+      filename,
+      backend: backend,
+      safe: :unsafe,
+      standalone: true
+    )
+
+    dir = Pathname(filename).dirname
+    out_dir = Pathname(out_dir || dir)
+    out_file = Pathname(
+      out_file || "#{doc.attr('docname')}#{doc.attr('outfilesuffix')}"
+    )
+
+    if draft
+      doc.find_by(context: :image).each do |node|
+        node.title = "#{node.title} [#{node.attr('target')}]"
+      end
+    end
+
+    if backend == 'pdf'
+      Dir.mktmpdir do |tmp_dir|
+        tmp_dir = Pathname(tmp_dir)
+
+        title_logo_image = doc.attr('title-logo-image')
+        if title_logo_image
+          target = title_logo_image[/^image:{1,2}(.*?)\[(.*?)\]$/, 1]
+          options = {}
+          options[:autorotate] = true if target =~ /\.jpe?g$/i
+          image = Vips::Image.new_from_file(dir.join(target).to_s, options)
+          scale = image_maxdim / image.size.max.to_f
+          image = image.resize(scale) if scale < 1.0
+          new_target = tmp_dir.join("title_logo_image_#{Pathname(target).basename}").to_s
+          suppress_output { image.write_to_file(new_target) }
+          doc.set_attr('title-logo-image', title_logo_image.gsub(target, new_target))
+        end
+
+        doc.find_by(context: :image).each.with_index do |node, index|
+          target = node.attr('target')
+          options = {}
+          options[:autorotate] = true if target =~ /\.jpe?g$/i
+          image = Vips::Image.new_from_file(dir.join(target).to_s, options)
+          scale = image_maxdim / image.size.max.to_f
+          image = image.resize(scale) if scale < 1.0
+          new_target = tmp_dir.join("image#{index}_#{Pathname(target).basename}").to_s
+          suppress_output { image.write_to_file(new_target) }
+          node.set_attr('target', new_target)
+        end
+
+        FileUtils.mkdir_p(out_dir)
+        mode = File::WRONLY | File::CREAT | File::TRUNC | File::BINARY
+        mode |= File::EXCL unless overwrite
+        File.open(out_dir.join(out_file), mode) do |file|
+          doc.write(doc.convert, file)
+        end
+      end
+    else
+      FileUtils.mkdir_p(out_dir)
+      mode = File::WRONLY | File::CREAT | File::TRUNC
+      mode |= File::EXCL unless overwrite
+      File.open(out_dir.join(out_file), mode) do |file|
+        doc.write(doc.convert, file)
+      end
+    end
+  end
+end