natour 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 653a7f10629f9d5cb63e991eba1e4693e88dcf3b26d0a92978f98601d8223507
-  data.tar.gz: 8e8671274bab8ac94bec16bcd5d967cdd337ccfb81e63b406d3d066d0689951d
+  metadata.gz: 731b0453c6a936a6207ce9802c212ed6747631eaedac2c88becc01420774f066
+  data.tar.gz: b8558c8228ddc650b44c92632f55d44737cdb9f5ac2114e1b472b8cb860d12d2
 SHA512:
-  metadata.gz: f8a3ec14f64440b08bc1e291ac20bd7cff86cef27509010c253779eab32ca26098667b8d5b13b216f8f486174b326f201941201da98a4b4ed8e22d3a43d2407f
-  data.tar.gz: 3554afc251f92900f32fe59e925c690cc9f1de77f7e3b84c0a94c5885a2706543ddca2b0a6cd50c11a0ea13918923c3e1766ef7059d938ed89fae49d49135a8c
+  metadata.gz: a866a26f237240eeb30e6b4ca8aa5e82c1bfb7db472d18951a5fccb6e3c873f6b0683b9c04bfe60202d81442edb3205e7b8a7d44dd4eddad09329c1a4d181d9e
+  data.tar.gz: f181d95ffb4df6445c649a51b6d762bd8d801ccfcdc57c616e8dad7cb30f5b52afe5daf294c1ae76c4ecec9efa719f03dbceae84dd9db7a2fdbfbed870d97f09

data/CHANGELOG.adoc

@@ -6,6 +6,17 @@ The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog^],
 
 == Unreleased
 
+== 0.4.0 - 2021-05-02
+
+=== Added
+
+- Show date/time of images in draft output
+- Support preferred conversion backend for draft output
+
+=== Changed
+
+- Remove redundant method `Image.portrait?`
+
 == 0.3.0 - 2021-03-07
 
 === Changed

data/bin/natour

@@ -17,6 +17,7 @@ config = Natour::Config.load_file(
     'adoc-author' => nil,
     'backend' => 'pdf',
     'draft' => false,
+    'draft-backend' => nil,
     'image-maxdim' => 1800
   }
 )
@@ -69,6 +70,9 @@ option_parser = OptionParser.new do |opts|
   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
   end
@@ -106,6 +110,7 @@ else
     overwrite: config['overwrite'],
     backend: config['backend'],
     draft: config['draft'],
+    draft_backend: config['draft-backend'],
     image_maxdim: config['image-maxdim']
   )
 end

data/lib/natour.rb

@@ -1,5 +1,5 @@
-require 'natour/helpers/date_parser'
-require 'natour/helpers/suppress_output'
+require 'natour/utils/date_utils'
+require 'natour/utils/stdout_utils'
 require 'natour/convert'
 require 'natour/create'
 require 'natour/asciinurse'

data/lib/natour/asciinurse.rb

@@ -77,10 +77,10 @@ module Natour
         doc << '== Bilder'
         doc << ''
         images.each do |image|
-          width = if image.portrait?
-                    '40%'
-                  else
+          width = if image.landscape?
                     '80%'
+                  else
+                    '40%'
                   end
           doc << '.Abbildung {counter:image}'
           doc << "image::#{Pathname(doc_root).join(image.path)}[width=#{width}]"

data/lib/natour/convert.rb

@@ -8,7 +8,13 @@ module Natour
   module_function
 
   def convert(filename, out_dir: nil, out_file: nil, overwrite: false,
-              backend: 'pdf', draft: false, image_maxdim: 16000)
+              backend: 'pdf', draft: false, draft_backend: nil, image_maxdim: 16000)
+    backend = if draft
+                draft_backend || backend
+              else
+                backend
+              end
+
     doc = Asciidoctor.load_file(
       filename,
       backend: backend,
@@ -29,7 +35,9 @@ module Natour
 
     if draft
       doc.find_by(context: :image).each do |node|
-        node.title = "#{node.title} [#{node.attr('target')}]"
+        target = node.attr('target')
+        image = Image.load_file(dir.join(target).to_s)
+        node.title = "#{node.title} [#{[target, image.date_time].compact.join('|')}]"
       end
     end
 
@@ -40,25 +48,17 @@ module Natour
         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
+          image = Image.load_file(dir.join(target).to_s).autorotate.shrink_to(image_maxdim)
           new_target = tmp_dir.join("title_logo_image_#{Pathname(target).basename}").to_s
-          suppress_output { image.write_to_file(new_target) }
+          image.save_as(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
+          image = Image.load_file(dir.join(target).to_s).autorotate.shrink_to(image_maxdim)
           new_target = tmp_dir.join("image#{index}_#{Pathname(target).basename}").to_s
-          suppress_output { image.write_to_file(new_target) }
+          image.save_as(new_target)
           node.set_attr('target', new_target)
         end
 

data/lib/natour/image.rb

@@ -1,29 +1,57 @@
 require 'vips'
 require 'timeliness'
+require 'fileutils'
+require 'pathname'
 
 module Natour
   class Image
     attr_reader :path
     attr_reader :date_time
 
-    def initialize(path)
+    def initialize(path, image)
       @path = path
-      image = Vips::Image.new_from_file(path)
-      width, height = image.size
-      @portrait = width < height
-      get_field = ->(name) { image.get(name) if image.get_fields.include?(name) }
-      orientation = get_field.call('exif-ifd0-Orientation')
-      @portrait = orientation[/^(\d) \(/, 1].to_i.between?(5, 8) if orientation
-      date_time = get_field.call('exif-ifd0-DateTime')
+      @image = image
+      orientation = get_field('exif-ifd0-Orientation')
+      @landscape = if orientation
+                     orientation[/^(\d) \(/, 1].to_i.between?(1, 4)
+                   else
+                     image.width >= image.height
+                   end
+      date_time = get_field('exif-ifd0-DateTime')
       @date_time = Timeliness.parse(date_time[/^(.*?) \(/, 1], format: 'yyyy:mm:dd hh:nn:ss') if date_time
     end
 
-    def portrait?
-      @portrait
+    def self.load_file(filename)
+      Image.new(filename, Vips::Image.new_from_file(filename))
     end
 
     def landscape?
-      !portrait?
+      @landscape
+    end
+
+    def autorotate
+      Image.new(@path, @image.autorot)
+    end
+
+    def shrink_to(maxdim)
+      scale = maxdim / @image.size.max.to_f
+      image = if scale < 1.0
+                @image.resize(scale)
+              else
+                @image.copy
+              end
+      Image.new(@path, image)
+    end
+
+    def save_as(filename)
+      FileUtils.mkdir_p(Pathname(filename).dirname)
+      StdoutUtils.suppress_output { @image.write_to_file(filename) }
+    end
+
+    private
+
+    def get_field(name)
+      @image.get(name) if @image.get_fields.include?(name)
     end
   end
 end

data/lib/natour/report.rb

@@ -35,7 +35,7 @@ module Natour
         title = Pathname.pwd.basename.to_s.encode('utf-8')
                         .gsub(/^\d{4}-\d{2}-\d{2}( |_|-)?/, '')
         images = Pathname.glob('**/*.{jpg,jpeg}', File::FNM_CASEFOLD)
-                         .map { |filename| Image.new(filename.to_s) }
+                         .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)
@@ -58,7 +58,7 @@ module Natour
                 gps_track.save_gpx(track, overwrite: true)
                 filename = Pathname(gps_track.path).sub_ext('.jpg')
                 map.save_image(filename, tracks: [track], layers: map_layers)
-                Image.new(filename.to_s)
+                Image.load_file(filename.to_s)
               end
             end
           end

data/lib/natour/species_list.rb

@@ -34,13 +34,13 @@ module Natour
       case header
       when /^Primary/
         CSV.open(filename, 'r:windows-1252:utf-8', headers: true, liberal_parsing: true) do |csv|
-          date = DateParser.parse(Pathname(filename).basename).compact.first
+          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, :kosmos_vogelfuehrer, :birds, nil, nil, items)]
         end
       when /^<\?xml.*?www\.ornitho\.ch/m
-        date = DateParser.parse(Pathname(filename).basename).compact.first
+        date = DateUtils.parse(Pathname(filename).basename).compact.first
         doc = Nokogiri.XML(File.read(filename, mode: 'r:utf-8'))
         folder = doc.at('/xmlns:kml/xmlns:Document/xmlns:Folder/xmlns:Folder/xmlns:Folder')
         name = folder.at('./xmlns:name').text
@@ -57,7 +57,7 @@ module Natour
                       .reject { |rows| rows.count == 1 }
           chunks.map do |rows|
             name, description = rows.shift
-            date = DateParser.parse(name, Pathname(filename).basename).compact.first
+            date = DateUtils.parse(name, Pathname(filename).basename).compact.first
             items = rows.map { |row| Species.new(row[1][/^(([^ ]+ [^ ]+)(( aggr\.)|( subsp\. [^ ]+))?)/, 1], row[2]) }
                         .sort_by(&:name).uniq
             SpeciesList.new(
@@ -73,7 +73,7 @@ module Natour
         end
       when /^obs_id/
         CSV.open(filename, 'r:bom|utf-16le:utf-8', col_sep: "\t", headers: true) do |csv|
-          date = DateParser.parse(Pathname(filename).basename).compact.first
+          date = DateUtils.parse(Pathname(filename).basename).compact.first
           items = csv.select { |row| row[0] }
                      .map { |row| Species.new(row[11][/^(([^ ]+ [^ ]+)(( aggr\.)|( subsp\. [^ ]+))?)/, 1], nil) }
                      .sort_by(&:name).uniq

data/lib/natour/{helpers/date_parser.rb → utils/date_utils.rb}

@@ -1,7 +1,7 @@
 require 'timeliness'
 
 module Natour
-  module DateParser
+  module DateUtils
     module_function
 
     def parse(*args)

data/lib/natour/utils/stdout_utils.rb

@@ -0,0 +1,16 @@
+module Natour
+  module StdoutUtils
+    module_function
+
+    def suppress_output
+      orig_stdout = $stdout.clone
+      orig_stderr = $stderr.clone
+      $stdout.reopen(File.new(File::NULL, 'w'))
+      $stderr.reopen(File.new(File::NULL, 'w'))
+      yield
+    ensure
+      $stdout.reopen(orig_stdout)
+      $stderr.reopen(orig_stderr)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natour
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Simon Gysi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -192,8 +192,6 @@ files:
 - lib/natour/gps_track.rb
 - lib/natour/gps_track_point.rb
 - lib/natour/gpx_file.rb
-- lib/natour/helpers/date_parser.rb
-- lib/natour/helpers/suppress_output.rb
 - lib/natour/image.rb
 - lib/natour/map_geo_admin.rb
 - lib/natour/public_transport.rb
@@ -201,6 +199,8 @@ files:
 - lib/natour/species.rb
 - lib/natour/species_list.rb
 - lib/natour/station.rb
+- lib/natour/utils/date_utils.rb
+- lib/natour/utils/stdout_utils.rb
 homepage: https://rubygems.org/gems/natour
 licenses:
 - MIT

data/lib/natour/helpers/suppress_output.rb

@@ -1,14 +0,0 @@
-module Natour
-  module_function
-
-  def suppress_output
-    orig_stdout = $stdout.clone
-    orig_stderr = $stderr.clone
-    $stdout.reopen(File.new(File::NULL, 'w'))
-    $stderr.reopen(File.new(File::NULL, 'w'))
-    yield
-  ensure
-    $stdout.reopen(orig_stdout)
-    $stderr.reopen(orig_stderr)
-  end
-end