pandocomatic 0.2.6 → 0.2.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75414fdf8e35a31102fd363f188ab12b5d54c525cc8ca1ab5c79a2343041cf82
-  data.tar.gz: 8dc07b1983650c1204d616e2b214dbaa42f0de54ba96466aa3d480489b4b4607
+  metadata.gz: 01d2cd31cfa5c0a4c078b733202f8236c156d89b6f0f3f089ebc214e7c0ecfda
+  data.tar.gz: 91c1f7b718a51e6c92de550eca8aebc8bbf1870399dc15f2ea0fddbc8bfd0f46
 SHA512:
-  metadata.gz: ae8c9b539d5e4fa08f471b5ffa061401fa6f11a3c2896d4da089e6f93742feea788caef087b153938b949c9a8a5f59ad0fd529449778c0fa74e3973f18dffb7a
-  data.tar.gz: ad60c65b3b5a7fae21956a2060326034a3e046a663d1c3c8570b0961f29fe21903f848b16f0ce121e181af39bcbf656d9364cb00f3afe1a13a4f990fac2ae707
+  metadata.gz: 9615e733f2639c45dc5fae67229e99ae39cb0bd869a2690488e115e847d79cd2c97cb2fbf62695155e602decb6c6d9256bfeac2e4b29626127ce92bf02f5fbb4
+  data.tar.gz: e17f09cad20a7f7b78bd35d2ccfec41f6e15bcd58a5998a25d9b121142de1f26d8f991f84bce296dd5ea3dce6f1e6c0850d0b6583a82361aded382568c425268

data/lib/pandocomatic/cli.rb

@@ -66,7 +66,10 @@ module Pandocomatic
         opt :output, 'Output', :short => '-o', :type => String
         opt :input, 'Input', :short => '-i', :type => String, :multi => true
 
-        # Version and help
+        # Experimental
+        opt :root_path, 'Root path', :short => '-r', :type => String
+
+        # Common
         opt :show_version, 'Version', :short => '-v', :long => 'version'
         opt :show_help, 'Help', :short => '-h', :long => 'help'
       end
@@ -122,6 +125,11 @@ module Pandocomatic
           raise CLIError.new(:no_output_given) if not multiple_inputs and File.directory? input.first
         end
 
+        # No check for root_path: a user can supply one that does not exists
+        # at this location and still work on the output location.
+        if options[:root_path_given]
+        end
+
         # Data dir, if specified, should be an existing and readable directory
         if options[:data_dir_given]
           data_dir = File.absolute_path options[:data_dir]

data/lib/pandocomatic/command/convert_file_command.rb

@@ -109,6 +109,11 @@ module Pandocomatic
 
                 pandoc_options = Configuration.extend_value(pandoc_options, template['pandoc'])
             end
+            
+            # Write out the results of the conversion process to file.
+            if @dst.to_s.empty? and @metadata.pandoc_options.has_key? 'output'
+                @dst = @metadata.pandoc_options['output']
+            end
                
             template = Configuration.extend_value(@metadata.pandocomatic, template) if @metadata.has_pandocomatic?            
 
@@ -121,7 +126,7 @@ module Pandocomatic
             # Run the default preprocessors to mix-in information about the file
             # that is being converted and mix-in the template's metadata section as
             # well
-            input = FileInfoPreprocessor.run input, @src, pandoc_options
+            input = FileInfoPreprocessor.run input, @src, src_root, pandoc_options
             input = MetadataPreprocessor.run input, template['metadata'] if template.has_key? 'metadata' and not template['metadata'].empty?
 
             # Convert the file by preprocessing it, run pandoc on it, and
@@ -130,11 +135,6 @@ module Pandocomatic
             input = pandoc input, pandoc_options, File.dirname(@src)
             output = postprocess input, template
 
-            # Write out the results of the conversion process to file.
-            if @dst.to_s.empty? and @metadata.pandoc_options.has_key? 'output'
-                @dst = @metadata.pandoc_options['output']
-            end
-
             begin
                 unless use_output_option @dst then
                     File.open(@dst, 'w') do |file| 
@@ -187,9 +187,9 @@ module Pandocomatic
                     if PANDOC_OPTIONS_WITH_PATH.include? option
                         is_executable = option == "filter"
                         if value.is_a? Array
-                            value = value.map {|v| @config.update_path(v, src_dir, is_executable)}
+                            value = value.map {|v| @config.update_path(v, src_dir, absolute_dst, is_executable)}
                         else
-                            value = @config.update_path(value, src_dir, is_executable)
+                            value = @config.update_path(value, src_dir, @dst, is_executable)
                         end
                     end
 
@@ -264,10 +264,10 @@ module Pandocomatic
                 processors = config[type]
                 output = input
                 processors.each do |processor|
-                    script = if @config.is_local_path processor
+                    script = if @config.is_local_path? processor
                                  processor
                              else
-                                 @config.update_path(processor, File.dirname(@src), true)
+                                 @config.update_path(processor, File.dirname(@src), @dst, true)
                              end
 
                     command, *parameters = script.shellsplit # split on spaces unless it is preceded by a backslash

data/lib/pandocomatic/command/convert_file_multiple_command.rb

@@ -64,7 +64,6 @@ module Pandocomatic
             global_templates = @config.determine_templates(@src)
                 
             if global_templates.empty?
-                
                 subcommands.push ConvertFileCommand.new(@config, @src, dst)
             else
                 global_templates.each do |template_name|

data/lib/pandocomatic/configuration.rb

@@ -55,9 +55,15 @@ module Pandocomatic
         'slideous' => 'html',
         'dzslides' => 'html',
         'revealjs' => 'html',
-        's5' => 'html'
+        's5' => 'html',
+        'bibtex' => 'bib',
+        'biblatex' => 'bib'
     }
 
+    # Indicator for paths that should be treated as "relative to the root
+    # path". These paths start with this ROOT_PATH_INDICATOR.
+    ROOT_PATH_INDICATOR = "$ROOT$"
+
     # A Configuration object models a pandocomatic configuration.
     class Configuration
 
@@ -90,6 +96,8 @@ module Pandocomatic
                           nil 
                       end
 
+            @root_path = determine_root_path options
+
             # Extend the command classes by setting the source tree root
             # directory, and the options quiet and dry-run, which are used when
             # executing a command: if dry-run the command is not actually
@@ -231,6 +239,13 @@ module Pandocomatic
             @options[:data_dir_given]
         end
 
+        # Is the root path CLI option given?
+        #
+        # @return [Boolean]
+        def root_path?()
+            @options[:root_path_given]
+        end
+
         # Is the config CLI option given?
         #
         # @return [Boolean]
@@ -288,6 +303,7 @@ module Pandocomatic
             # If a temporary file has been created while concatenating
             # multiple input files, ensure it is removed.
             if @input.is_a? MultipleFilesInput then
+                warn "CLEAN UP"
                 @input.destroy!
             end
         end
@@ -528,29 +544,30 @@ module Pandocomatic
         # @param path [String] path to the executable
         # @param src_dir [String] the source directory from which pandocomatic
         #   conversion process has been started
-        # @param check_executable [Booelan = false] Should the executable be
+        # @param dst [String] the destination path
+        # @param check_executable [Boolean = false] Should the executable be
         #   verified to be executable? Defaults to false.
         #
         # @return [String] the updated path.
-        def update_path(path, src_dir, check_executable = false, output = false)
+        def update_path(path, src_dir, dst = "", check_executable = false, output = false)
             updated_path = path
 
-            if is_local_path path
+            if is_local_path? path
                 # refers to a local dir; strip the './' before appending it to
                 # the source directory as to prevent /some/path/./to/path
                 updated_path = path[2..-1]
-            else
-                if is_absolute_path path
-                    updated_path = path
-                else 
-                    if check_executable
-                        updated_path = Configuration.which path
-                    end
+            elsif is_absolute_path? path
+                updated_path = path
+            elsif is_root_relative_path? path
+                updated_path = make_path_root_relative path, dst, @root_path
+            else 
+                if check_executable
+                    updated_path = Configuration.which path
+                end
 
-                    if updated_path.nil? or not check_executable then
-                        # refers to data-dir
-                        updated_path = File.join @data_dir, path
-                    end
+                if updated_path.nil? or not check_executable then
+                    # refers to data-dir
+                    updated_path = File.join @data_dir, path
                 end
             end
 
@@ -643,7 +660,7 @@ module Pandocomatic
             end
         end
 
-        def is_local_path(path)
+        def is_local_path?(path)
             if Gem.win_platform? then
                 path.match("^\\.\\\\\.*$")
             else
@@ -818,7 +835,7 @@ module Pandocomatic
         end
 
 
-        def is_absolute_path(path)
+        def is_absolute_path?(path)
             if Gem.win_platform? then
                 path.match("^[a-zA-Z]:\\\\\.*$")
             else
@@ -826,6 +843,43 @@ module Pandocomatic
             end
         end
 
+        def is_root_relative_path?(path)
+            path.start_with? ROOT_PATH_INDICATOR
+        end
+
+        def make_path_root_relative(path, dst, root)
+            # Find how to get to the root directopry from dst directory.
+            # Assumption is that dst is a subdirectory of root.
+            dst_dir = File.dirname(File.absolute_path(dst))
+            
+            path.delete_prefix! ROOT_PATH_INDICATOR if is_root_relative_path? path
+
+            if File.exist? root and File.realpath("#{dst_dir}").start_with?(File.realpath(root)) then
+                rel_start = ""
+
+                until File.identical?(File.realpath("#{dst_dir}/#{rel_start}"), File.realpath(root)) do
+                    # invariant dst_dir/rel_start <= root
+                    rel_start += "../" 
+                end
+
+                if rel_start.end_with? "/" and path.start_with? "/" then
+                    "#{rel_start}#{path.delete_prefix("/")}"
+                else
+                    "#{rel_start}#{path}"
+                end
+            else
+                # Because the destination is not in a subdirectory of root, a
+                # relative path to that root cannot be created. Instead,
+                # the path is assumed to be absolute relative to root
+                root = root.delete_suffix "/" if root.end_with? "/"
+                path = path.delete_prefix "/" if path.start_with? "/"
+
+                "#{root}/#{path}"
+            end
+
+
+        end
+
         def determine_config_file(options, data_dir = Dir.pwd)
             config_file = ''
 
@@ -884,5 +938,15 @@ module Pandocomatic
 
             path
         end
+
+        def determine_root_path(options)
+            if options[:root_path_given] then
+                options[:root_path]
+            elsif options[:output_given] then
+                File.absolute_path(File.dirname options[:output])
+            else
+                File.absolute_path "."
+            end
+        end
     end
 end

data/lib/pandocomatic/pandocomatic.rb

@@ -47,7 +47,7 @@ module Pandocomatic
         ERROR_STATUS = 1266 # This is the sum of the ascii values of the characters in 'pandocomatic'
 
         # Pandocomatic's current version
-        VERSION = [0, 2, 6]
+        VERSION = [0, 2, 7, 4]
 
         # Run pandocomatic given options
         #

data/lib/pandocomatic/printer/views/help.txt

@@ -25,6 +25,9 @@ DESCRIPTION
 
 OPTIONS
 
+
+  Required:
+
   -i PATH, --input PATH
                   Convert PATH. If this option is not given, INPUT is
                   converted. INPUT and --input cannot be used together.
@@ -36,7 +39,8 @@ OPTIONS
   -o PATH, --output PATH
                   Create converted files and directories in PATH.
 
-  optional arguments:
+
+  Optional:
 
   -d PATH, --data-dir PATH
                   Configure pandocomatic to use PATH as its data directory.
@@ -99,6 +103,18 @@ OPTIONS
 
   -y, --dry-run   Configure pandocomatic to run the conversion process, but do
                   not actually run it. Default is FALSE.
+  
+
+  Experimental:
+
+  -r PATH, --root-path PATH  
+                  Set the root path to use with paths that are specified as
+                  relative to that root path. It is used mostly with the 
+                  --css pandoc option. It defaults to the directory of the
+                  specified output.
+
+
+  Common:
 
   -v, --version   Show the version. If this option is used, all other options
                   are ignored.
@@ -134,7 +150,7 @@ AUTHOR
 
 LICENSE
 
-  Copyright 2014—2019 Huub de Beer <Huub@heerdebeer.org>
+  Copyright 2014—2020 Huub de Beer <huub@heerdebeer.org>
 
   Pandocomatic is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by the

data/lib/pandocomatic/printer/views/version.txt

@@ -1,6 +1,6 @@
 Pandocomatic version <%=@version.join('.')%>
 
-© 2014—2019 Huub de Beer <Huub@heerdebeer.org>
+© 2014—2020 Huub de Beer <Huub@heerdebeer.org>
 
 Pandocomatic is free software; pandocomatic is released under the GPLv3.
 

data/lib/pandocomatic/processors/fileinfo_preprocessor.rb

@@ -31,7 +31,7 @@ module Pandocomatic
         # @param path [String] the path to the input document
         # @param options [Hash] pandoc options collected by pandocomatic to run on
         #   this file
-        def self.run input, path, options
+        def self.run input, path, src_path, options
             created_at = File.stat(path).ctime
             modified_at = File.stat(path).mtime
             output = input
@@ -41,6 +41,7 @@ module Pandocomatic
             output << "  to: #{options['to']}\n" if options.has_key? 'to'
             output << "  template: #{options['template']}\n" if options.has_key? 'template'
             output << "  path: '#{path}'\n"
+            output << "  src_path: '#{src_path}'\n"
             output << "  created: #{created_at.strftime '%Y-%m-%d'}\n"
             output << "  modified: #{modified_at.strftime '%Y-%m-%d'}\n"
             output << "...\n\n"

metadata

@@ -1,53 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7.4
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2.1
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
@@ -147,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.4
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -155,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - pandoc, a universal document converter
-rubyforge_project: 
-rubygems_version: 3.0.0.beta1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Automate the use of pandoc