natour 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c599b25a1b97e3eb894161d80065d2359a7530371e40335702100b79510b013
-  data.tar.gz: '0892297dde6afb7de1a193d0bfe903ce6810d17b5a10c23bd5d0433b4cbde702'
+  metadata.gz: 6c649407352883c9e93ab6d6470413127d54803bb35dc72beb83292c9e521626
+  data.tar.gz: dbeb8f8ae4a412d7832c07ab66d717d40bb5e2ecd096fb076655ef65a6840b53
 SHA512:
-  metadata.gz: ce5fd7ebedd87c7c4dcf529a90878cdeab5dac805362407b9be3becee524aaa3d616d44f62f6bf4d4d8fc694741f607cdff2bb69a134407cbe7d4ac9c70330bf
-  data.tar.gz: 6f92ed19ec2f32eb4933630937ecb2d0fe597e466b6c3057aacfe070f971820d0e03a0dff28eb3d61e1ffea4db6bfd61091da8830c005a7cc8f3a184e450612a
+  metadata.gz: b5a810b2ea0220c9eded025e0f00f8e4f782a42b54128f71a2929a84a535e75f45bb3ddff0cf72f7dad08e047c1aaef3b88800e778901405357efd11336b5db0
+  data.tar.gz: a928d426c1840cb57fb7ab58064850572fc2a7e14aeda6086b2c9560c8b2d7e3e8253c268a9070bef91e4c7fb2c0f26daf2e5664a043f29b595d192a0299137f

data/CHANGELOG.adoc

@@ -6,6 +6,26 @@ The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog^],
 
 == Unreleased
 
+== 0.7.0 - 2022-02-14
+
+=== Added
+
+- Add support for Ruby 3.0 and 3.1
+- Support species lists from Vogelführer Birdlife Schweiz
+
+=== Changed
+
+- Return the filenames from `create` and `convert`
+
+=== Removed
+
+- 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
+
 == 0.6.0 - 2021-11-20
 
 === Fixed

data/README.adoc

@@ -1,6 +1,6 @@
 = natour
 
-This https://rubygems.org/[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 for reports on nature activities.
 
 == Installation
 

data/bin/natour

@@ -28,10 +28,11 @@ option_parser = OptionParser.new do |opts|
   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, 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).'
+    '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:')

data/lib/natour/asciinurse.rb

@@ -28,10 +28,8 @@ module Natour
 
       doc = []
       doc << "= #{title}"
-      if author
-        doc << author
-        doc << ':revdate: {docdate}'
-      end
+      doc << author if author
+      doc << ':revdate: {docdate}'
       doc << ':figure-caption!:'
       doc << ':table-caption!:'
       doc << ':pdf-page-mode: none'
@@ -99,13 +97,13 @@ module Natour
           OpenStruct.new(
             group: :plants,
             title: 'Pflanzenarten',
-            headers: %w[Wissenschaftlicher\ Name Deutscher\ Name],
+            headers: ['Wissenschaftlicher Name', 'Deutscher Name'],
             columns: %i[name name_de]
           ),
           OpenStruct.new(
             group: :birds,
             title: 'Vogelarten',
-            headers: %w[Deutscher\ Name Wissenschaftlicher\ Name],
+            headers: ['Deutscher Name', 'Wissenschaftlicher Name'],
             columns: %i[name_de name]
           )
         ].each do |info|

data/lib/natour/config.rb

@@ -7,7 +7,7 @@ module Natour
       dirs.map do |dir|
         YAML.safe_load(
           File.read(Pathname(dir).join(filename)),
-          [Symbol]
+          permitted_classes: [Symbol]
         )
       rescue Errno::ENOENT
         {}

data/lib/natour/convert.rb

@@ -33,6 +33,7 @@ module Natour
     out_file = Pathname(
       out_file || "#{doc.attr('docname')}#{doc.attr('outfilesuffix')}"
     )
+    filename = out_dir.join(out_file)
 
     if draft
       doc.find_by(context: :image).each do |node|
@@ -51,7 +52,10 @@ module Natour
       localtime
       localdatetime
     ].each do |attr_name|
-      date_time = Time.parse(doc.attr(attr_name))
+      attr_value = doc.attr(attr_name)
+      next unless attr_value
+
+      date_time = Time.parse(attr_value)
       if attr_name.end_with?('datetime')
         doc.set_attr(attr_name, date_time.strftime('%d.%m.%Y %H:%M:%S'))
       elsif attr_name.end_with?('date')
@@ -85,7 +89,7 @@ module Natour
         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|
+        File.open(filename, mode) do |file|
           doc.write(doc.convert, file)
         end
       end
@@ -93,9 +97,11 @@ module Natour
       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|
+      File.open(filename, mode) do |file|
         doc.write(doc.convert, file)
       end
     end
+
+    filename.to_s
   end
 end

data/lib/natour/create.rb

@@ -8,13 +8,14 @@ module Natour
     reports = Report.load_directory(
       dir, track_formats: track_formats, create_map: create_map, map_layers: map_layers
     )
-    reports.each.with_index(1) do |report, index|
+    reports.map.with_index(1) do |report, index|
       filename = if index < 2
                    out_dir.join(out_file)
                  else
                    out_dir.join("#{out_file.basename('.*')} (#{index})#{out_file.extname}")
                  end
       report.save_adoc(filename, overwrite: overwrite, author: adoc_author)
+      filename.to_s
     end
   end
 end

data/lib/natour/report.rb

@@ -34,18 +34,22 @@ module Natour
         path = Pathname(dir)
         title = Pathname.pwd.basename.to_s.encode('utf-8')
                         .gsub(/^\d{4}-\d{2}-\d{2}( |_|-)?/, '')
-        images = Pathname.glob('**/*.{jpg,jpeg}', File::FNM_CASEFOLD)
+        images = Pathname.glob('**/*.{[j|J][p|P][g|G],[j|J][p|P][e|E][g|G]}')
                          .map { |filename| Image.load_file(filename.to_s) }
                          .sort_by { |image| [image.date_time ? 0 : 1, image.date_time, image.path] }
         species_lists =
-          Pathname.glob('**/*.{csv,kml}', File::FNM_CASEFOLD)
+          Pathname.glob('**/*.{[c|C][s|S][v|V],[k|K][m|M][l|L]}')
                   .map { |filename| SpeciesList.load_file(filename.to_s) }
                   .flatten
                   .sort_by { |species_list| [species_list.type, species_list.date ? 0 : 1, species_list.date] }
         gps_tracks = if track_formats.empty?
                        []
                      else
-                       Pathname.glob("**/*.{#{track_formats.join(',')}}", File::FNM_CASEFOLD)
+                       track_patterns = { gpx: '[g|G][p|P][x|X]', fit: '[f|F][i|I][t|T]' }
+                       track_pattern = track_formats.map { |track_format| track_patterns[track_format] }
+                                                    .compact
+                                                    .join(',')
+                       Pathname.glob("**/*.{#{track_pattern}}")
                                .map { |filename| GPSTrack.load_file(filename.to_s) }
                                .sort_by { |gps_track| [gps_track.date, gps_track.path] }
                      end

data/lib/natour/species_list.rb

@@ -24,9 +24,9 @@ module Natour
     def self.load_file(filename)
       block = IO.binread(filename, 128)
       header = if block.unpack('CC') == [0xff, 0xfe]
-                 block[2..-1].force_encoding('utf-16le').encode('utf-8')
+                 block[2..].force_encoding('utf-16le').encode('utf-8')
                elsif block.unpack('CCC') == [0xef, 0xbb, 0xbf]
-                 block[3..-1].force_encoding('utf-8')
+                 block[3..].force_encoding('utf-8')
                else
                  block
                end
@@ -39,6 +39,13 @@ module Natour
                      .sort_by(&:name_de).uniq
           [SpeciesList.new(filename, date, :kosmos_vogelfuehrer, :birds, nil, nil, items)]
         end
+      when /^Name/
+        CSV.open(filename, 'r:bom|utf-8', headers: true) do |csv|
+          date = DateUtils.parse(Pathname(filename).basename).compact.first
+          items = csv.map { |row| Species.new(row[1], row[0]) }
+                     .sort_by(&:name_de).uniq
+          [SpeciesList.new(filename, date, :birdlife_vogelfuehrer, :birds, nil, nil, items)]
+        end
       when /^<\?xml.*?www\.ornitho\.ch/m
         date = DateUtils.parse(Pathname(filename).basename).compact.first
         doc = Nokogiri.XML(File.read(filename, mode: 'r:utf-8'))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natour
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Simon Gysi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -70,16 +70,16 @@ dependencies:
   name: fit4ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: word_wrap
   requirement: !ruby/object:Gem::Requirement
@@ -154,16 +168,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.25'
 description:
 email: simon.gysi@gmail.com
 executables:
@@ -202,7 +216,7 @@ files:
 - lib/natour/utils/botanical_name_utils.rb
 - lib/natour/utils/date_utils.rb
 - lib/natour/utils/stdout_utils.rb
-homepage: https://rubygems.org/gems/natour
+homepage: https://github.com/simongysi/natour
 licenses:
 - MIT
 metadata:
@@ -217,7 +231,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="