pandocomatic 0.0.13 → 0.1.0.b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2789cfe2c555b46519a2bdacc5c149072ee968fa
-  data.tar.gz: b6bb2f9fcd18377be26faa63f40cdedd51c6806d
+  metadata.gz: dffe0869e5d1d21dea4701c4a102be0965a5fb38
+  data.tar.gz: f0c876b6f2833288b1c70d02e64c65efee067985
 SHA512:
-  metadata.gz: 734ed488a938cced2e73405b729ce2874a935ee93917fe4a28a2130f66634ae3e26f7804a7d7381e43b318b1dff0d6ca34822ea217279ab1520f1e0906728359
-  data.tar.gz: 833dcc225450ee3c849d2d1d097d71d581d1581665141a576154813b1e1c6b9f19c4b5068803ad0ad0566a2c7341509ff1de844c76ce9df251c1c886dcd2725f
+  metadata.gz: 13a606257cc004eb37f775f24aa561459e0d44adf4657ea0b28dcd7c5e4991a4d7bd5f34f985eca94eef1c972e1800f53be2cf54f8b65247c4edbd5a3e072ca2
+  data.tar.gz: 0c8bb7e39e23858b4a123a5e213005aaed34e63ff42fd213c8c55f54a1cb3583cba51f6eded036012a989dfca15e0b379c524da8dbfb926798aa534b4659ddc5

data/bin/pandocomatic

@@ -1,79 +1,3 @@
 #!/usr/bin/env ruby
-
-require 'trollop'
-require 'fileutils'
-
-require_relative '../lib/pandocomatic/dir_converter.rb'
-require_relative '../lib/pandocomatic/file_converter.rb'
-require_relative '../lib/pandocomatic/configuration.rb'
-
-opts = Trollop::options do
-  version "pandocomatic 0.0.13"
-  banner <<-EOB
-
-Pandocomatic automates the use of pandoc (<http://www.pandoc.org>). It can be
-used to convert one file or a whole directory (tree).
-
-Usage:
-
-    pandocomatic [--config pandocomatic.yaml] --output output input
-
-Options:
-EOB
-
-  opt :config, "Pandocomatic configuration file, default is ./pandocomatic.yaml",  :type => :string 
-  opt :output, "output file or directory", :type => :string
-
-
-end
-
-# input file/directory
-Trollop::die "Expect exactly one input file or directory" if ARGV.length != 1
-input = ARGV.first
-
-# output file/directory
-Trollop::die "Expect an output file or directory" if opts[:output].nil?
-output = opts[:output]
-
-# Configuration
-if opts[:config].nil? 
-    if Dir.entries(Dir.pwd).include? 'pandocomatic.yaml'
-        settings_file = File.join Dir.pwd, 'pandocomatic.yaml'
-    else
-        default_dir = File.join Dir.home, '.pandocomatic'
-        default_config = File.join default_dir, 'pandocomatic.yaml'
-        begin
-            if not Dir.exist? default_dir 
-                Dir.mkdir default_dir
-            end
-
-            if not File.exist? default_config
-                config_template = File.absolute_path '../lib/pandocomatic/default_configuration.yaml', __dir__
-                FileUtils.cp config_template, default_config
-            end
-        rescue Exception => e
-            raise "Failed creating default pandocomatic file at #{default_config}: #{e.message}"
-        end
-        settings_file = default_config
-    end
-else
-    settings_file = opts[:config]
-end
-
-if not File.exist? settings_file or not File.readable? settings_file then
-    Trollop::die "Cannot read configuration file #{settings_file}" if File
-end
-
-config = Pandocomatic::Configuration.new settings_file
-
-if File.directory? input then
-  if File.exist? output and not File.directory? output then
-    Trollop::die "Expected an output directory, found a file instead"
-  end
-
-  Pandocomatic::DirConverter.new(input, output, config).convert
-
-else 
-  # input is one file
-  Pandocomatic::FileConverter.new.convert input, output, config
-end
+require 'pandocomatic/pandocomatic'
+Pandocomatic::Pandocomatic.run ARGV

data/lib/pandocomatic/cli.rb

@@ -0,0 +1,183 @@
+#--
+# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
+# 
+# This file is part of pandocomatic.
+# 
+# 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
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+# 
+# Pandocomatic is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
+#++
+module Pandocomatic
+  require 'trollop'
+
+  require_relative './error/cli_error.rb'
+
+  ##
+  # Command line options parser for pandocomatic using trollop.
+  #
+  class CLI
+
+    ##
+    # Parse the arguments, returns a triplet with the global options, an
+    # optional subcommand, and the (optional) options for that subcommand.
+    #
+    # @param args [String, Array] A command line invocation string or a list of strings like ARGV
+    #
+    # @return [Hash] The options to pandocomatic
+    # the subcommand's options
+    #
+    def self.parse(args)
+      args = args.split if args.is_a? String
+
+      begin
+        options = parse_options args || {:help => true, :help_given => true}
+        options
+      rescue Trollop::CommandlineError => e
+        raise CLIError.new(:problematic_invocation, e, args)
+      end
+    end
+
+    private 
+
+    # Parse pandocomatic's global options.
+    def self.parse_options(args)
+      parser = Trollop::Parser.new do
+        # General options 
+        opt :dry_run, 'Do a dry run', :short => '-y'
+        opt :quiet, 'Run quietly', :short => '-q'
+        opt :modified_only, 'Modified files only', :short => '-m'
+
+        # Configuration of the converter
+        opt :data_dir, 'Data dir', :short => '-d', :type => String
+        opt :config, 'Configuration file', :short => '-c', :type => String
+
+        # What to convert and where to put it
+        opt :output, 'Output', :short => '-o', :type => String
+        opt :input, 'Input', :short => '-i', :type => String
+
+        # Version and help
+        opt :show_version, 'Version', :short => '-v', :long => 'version'
+        opt :show_help, 'Help', :short => '-h', :long => 'help'
+      end
+
+      # All options should be parsed according to the specification given in the parser
+      begin
+        options = parser.parse args
+      rescue Trollop::CommandlineError => e
+        raise CLIError.new(:problematic_invocation, e, args)
+      end
+      
+      options = use_custom_version options
+      options = use_custom_help options
+     
+      if options_need_to_be_validated? options
+        # if no input option is specified, it should follow as the last item
+        if not options[:input_given]
+          options[:input] = args.shift
+          options[:input_given] = true
+        end
+
+        # There should be no other options left.
+        raise CLIError.new(:too_many_options, nil, args) if not args.empty?
+
+        # There should be an input specified
+        raise CLIError.new(:no_input_given) if options[:input].nil? or options[:input].empty?
+
+        # The input file or directory should exist
+        input = File.absolute_path options[:input]
+        raise CLIError.new(:input_does_not_exist, nil, options[:input]) unless File.exist? input
+        raise CLIError.new(:input_is_not_readable, nil, input) unless File.readable? input
+
+        if options[:output_given]
+          output = File.absolute_path options[:output]
+          # Input and output should be both files or directories
+          match_file_types input, output
+
+          # The output, if it already exist, should be writable
+          raise CLIError.new(:output_is_not_writable, nil, output) unless not File.exist? output or File.writable? output
+        else
+          # If the input is a directory, an output directory should be
+          # specified as well. If the input is a file, the output could be
+          # specified in the input file, or STDOUT could be used.
+          raise CLIError.new(:no_output_given) if File.directory? input
+        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]
+
+          raise CLIError.new(:data_dir_does_not_exist, nil, options[:data_dir]) unless File.exist? data_dir
+          raise CLIError.new(:data_dir_is_not_readable, nil, data_dir) unless File.readable? data_dir
+          raise CLIError.new(:data_dir_is_not_a_directory, nil, data_dir) unless File.directory? data_dir
+        end
+
+        # Config file, if specified, should be an existing and readable file
+        if options[:config_given]
+          config = File.absolute_path options[:config]
+
+          raise CLIError.new(:config_file_does_not_exist, nil, options[:config]) unless File.exist? config
+          raise CLIError.new(:config_file_is_not_readable, nil, config) unless File.readable? config
+          raise CLIError.new(:config_file_is_not_a_file, nil, config) unless File.file? config
+        end
+
+      end
+      
+      options
+    end
+
+    def self.options_need_to_be_validated? options
+      not options[:version_given] and not options[:help_given]
+    end
+
+    #--
+    #Trollop has special behavior for the version and help options. To
+    # overcome, "show_version" and "show_help" options are introduced. When
+    # set, these are put in the options as "version" and "help"
+    # respectively.
+    #++
+    
+    def self.use_custom_version options
+      if options[:show_version]
+        options.delete :show_version
+        options.delete :show_version_given
+        options[:version] = true
+        options[:version_given] = true
+      end
+      options
+    end
+
+    def self.use_custom_help options
+      if options[:show_help]
+        options.delete :show_help
+        options.delete :show_help_given
+        options[:help] = true
+        options[:help_given] = true
+      end
+      options 
+    end
+
+    # If output does not exist, the output can be
+    # created with the same type. If output does exist, however, it should
+    # have the same type as the input.
+    def self.matching_file_types?(input, output)
+      not File.exist?(output) or File.ftype(input) == File.ftype(output)
+    end
+    
+    def self.match_file_types(input, output)
+        if not matching_file_types? input, output 
+          raise CLIError.new(:output_is_not_a_file, nil, input) if File.file? input
+          raise CLIError.new(:output_is_not_a_directory, nil, input) if File.directory? input
+        end
+    end
+
+  end
+end

data/lib/pandocomatic/command/command.rb

@@ -0,0 +1,113 @@
+#--
+# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
+# 
+# This file is part of pandocomatic.
+# 
+# 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
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+# 
+# Pandocomatic is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
+#++
+module Pandocomatic
+
+  require_relative '../printer/command_printer.rb'
+
+  class Command
+
+    attr_reader :errors, :index
+
+    @@total = 0
+    @@dry_run = false
+    @@quiet = false
+    @@src_root = "."
+    @@modified_only = false
+
+    def initialize()
+      @errors = []
+      @@total += 1
+      @index = @@total
+    end
+
+    def self.reset(src_root = ".", dry_run = false, quiet = false, modified_only)
+      @@src_root = src_root
+      @@dry_run = dry_run
+      @@quiet = quiet
+      @@modified_only = modified_only
+      @@total = 0
+    end
+
+    def src_root()
+      @@src_root
+    end
+
+    def dry_run?()
+      @@dry_run
+    end
+
+    def quiet?()
+      @@quiet
+    end
+
+    def modified_only?()
+      @@modified_only
+    end
+
+    def count()
+      1
+    end
+
+    def all_errors()
+      @errors
+    end
+
+    def index_to_s()
+      "#{@@total - @index + 1}".rjust(@@total.to_s.size)
+    end
+
+    def execute()
+      CommandPrinter.new(self).print unless quiet?
+      run if not dry_run? and runnable?
+    end
+
+    def run()
+    end
+
+    def runnable?()
+      not has_errors?
+    end
+
+    def to_s()
+      'command'
+    end
+    
+    def directory?()
+      false
+    end
+
+    def skip?()
+      false
+    end
+
+    def uncount()
+      @@total -= 1
+    end
+
+    def has_errors?()
+      not @errors.empty?
+    end
+
+    # src file is newer than the dstination file?
+    def file_modified?(src, dst)
+      not File.exist? dst or File.mtime(src) > File.mtime(dst)
+    end
+
+  end
+end

data/lib/pandocomatic/command/convert_dir_command.rb

@@ -0,0 +1,155 @@
+#--
+# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
+# 
+# This file is part of pandocomatic.
+# 
+# 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
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+# 
+# Pandocomatic is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
+#++
+module Pandocomatic
+
+  require_relative '../error/io_error.rb'
+
+  require_relative 'command.rb'
+  require_relative 'create_link_command.rb'
+  require_relative 'convert_file_command.rb'
+  require_relative 'copy_file_command.rb'
+  require_relative 'skip_command.rb'
+
+  class ConvertDirCommand < Command
+
+    attr_reader :config, :src_dir, :dst_dir, :subcommands
+
+    def initialize(current_config, src_dir, dst_dir)
+      super()
+      @src_dir = src_dir
+      @config = current_config
+
+      begin
+        @config = reconfigure current_config, @src_dir
+      rescue ConfigurationError => e
+        @errors.push e
+      end
+
+      @dst_dir = dst_dir
+
+      if Dir.exist? @dst_dir
+        @errors.push IOError.new(:directory_is_not_readable, nil, @dst_dir) unless File.readable? @dst_dir
+        @errors.push IOError.new(:directory_is_not_writable, nil, @dst_dir) unless File.writable? @dst_dir
+        @errors.push IOError.new(:directory_is_not_a_directory, nil, @dst_dir) unless File.directory? @dst_dir
+      end
+
+      @subcommands = []
+
+      Dir.foreach @src_dir do |filename|
+        src = File.join @src_dir, filename
+
+        next if config.skip? src
+
+        @errors.push IOError.new(:file_or_directory_does_not_exist, nil, src) unless File.exist? src
+
+        dst = File.join @dst_dir, filename
+
+        if File.symlink? src and not config.follow_links?
+          subcommand = CreateLinkCommand.new(src, dst)
+        elsif File.directory? src then
+          if config.recursive? then
+            subcommand = ConvertDirCommand.new(config, src, dst)
+          else
+            subcommand = SkipCommand.new(src, :skipping_directory)
+          end
+        elsif File.file? src 
+          if config.convert? src then
+            dst = config.set_extension dst
+            if not modified_only? or file_modified? src, dst then
+              subcommand = ConvertFileCommand.new(config, src, dst)
+            end
+          else
+            if not modified_only? or file_modified? src, dst then
+              subcommand = CopyFileCommand.new(src, dst)
+            end
+          end
+        else
+          subcommand = SkipCommand.new(src, :unclear_what_to_do)
+        end
+
+        @subcommands.push subcommand unless subcommand.nil? or subcommand.skip?
+      end
+
+      # Empty commands do not count to the total amount of commands to execute
+      uncount if skip?
+    end
+
+    def skip?()
+      @subcommands.empty?
+    end
+
+    def count()
+      @subcommands.reduce(if skip? then 0 else 1 end) do |total, subcommand|
+        total += subcommand.count
+      end
+    end
+
+    def all_errors()
+      @subcommands.reduce(@errors) do |total, subcommand|
+        total += subcommand.all_errors
+      end
+    end
+
+    def directory?()
+      true
+    end
+
+    def to_s()
+      "convert #{@src_dir}" + '; ' + if create_directory? then 'create and ' else '' end + "enter #{@dst_dir}"
+    end
+
+    def run()
+      begin
+        Dir.mkdir @dst_dir if create_directory?
+      rescue SystemError => e
+        raise IOError.new(:error_creating_directory, e, @dst_dir)
+      end
+    end
+
+    def execute()
+      if not @subcommands.empty?
+        CommandPrinter.new(self).print unless quiet?
+        run if not dry_run? and runnable?
+
+        @subcommands.each do |subcommand|
+          subcommand.execute
+        end
+      end
+    end
+
+    private
+
+    def create_directory?()
+      not File.exist? @dst_dir or not File.directory? @dst_dir
+    end
+
+    # If the source directory contains a configuration file, use it to
+    # reconfigure the converter. Otherwise, use the current configuration
+    def reconfigure(current_config, src_dir)
+      config_file = File.join src_dir, Pandocomatic::CONFIG_FILE
+      if File.exist? config_file then
+        config = current_config.reconfigure config_file
+      else
+        config = current_config
+      end
+      config
+    end
+
+  end
+end

data/lib/pandocomatic/command/convert_file_command.rb

@@ -0,0 +1,163 @@
+#--
+# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
+# 
+# This file is part of pandocomatic.
+# 
+# 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
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+# 
+# Pandocomatic is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
+#++
+module Pandocomatic
+
+  require 'paru'
+
+  require_relative '../pandoc_metadata.rb'
+  require_relative '../processor.rb'
+  require_relative '../fileinfo_preprocessor'
+
+  require_relative '../error/io_error.rb'
+  require_relative '../error/configuration_error.rb'
+  require_relative '../error/processor_error.rb'
+
+  require_relative 'command.rb'
+
+  class ConvertFileCommand < Command
+
+    attr_reader :config, :src, :dst
+
+    def initialize(config, src, dst)
+      super()
+      @config = config
+      @src = src
+      @dst = dst
+
+      @errors.push IOError.new(:file_does_not_exist, nil, @src) unless File.exist? @src
+      @errors.push IOError.new(:file_is_not_a_file, nil, @src) unless File.file? @src
+      @errors.push IOError.new(:file_is_not_readable, nil, @src) unless File.readable? @src
+    end
+
+    def run
+      convert_file
+    end
+
+    def to_s
+      "convert #{File.basename @src} -> #{File.basename @dst}"
+    end
+
+    private
+
+    def convert_file
+      metadata = PandocMetadata.load_file @src
+
+      if metadata.has_template? then
+        template_name = metadata.template_name
+      else
+        template_name = @config.determine_template @src
+      end
+
+      raise ConfigurationError.new(:no_such_template, nil, template_name) unless @config.has_template? template_name
+
+      template = @config.get_template template_name
+
+      pandoc_options = (template['pandoc'] || {}).merge(metadata.pandoc_options || {})
+
+      input = File.read @src
+      input = FileInfoPreprocessor.run input, @src
+      input = preprocess input, template
+      input = pandoc input, pandoc_options, File.dirname(@src)
+      output = postprocess input, template
+
+      if @dst.to_s.empty? and metadata.pandoc_options.has_key? 'output'
+        @dst = metadata.pandoc_options['output']
+      end
+
+      begin
+        File.open(@dst, 'w') do |file| 
+          raise IOError.new(:file_is_not_a_file, nil, @dst) unless File.file? @dst
+          raise IOError.new(:file_is_not_writable, nil, @dst) unless File.writable? @dst
+          file << output
+        end
+      rescue StandardError => e
+        raise IOError.new(:error_writing_file, e, @dst)
+      end
+    end
+    
+    # TODO: update this list
+    PANDOC_OPTIONS_WITH_PATH = [
+      'filter', 
+      'template', 
+      'css', 
+      'include-in-header', 
+      'include-before-body',
+      'include-after-body',
+      'reference-odt',
+      'reference-docx',
+      'epub-stylesheet',
+      'epub-cover-image',
+      'epub-metadata',
+      'epub-embed-font',
+      'bibliography',
+      'csl'
+    ]
+
+    def pandoc(input, options, src_dir)
+      converter = Paru::Pandoc.new
+      options.each do |option, value|
+
+        value = @config.update_path value, src_dir if 
+        PANDOC_OPTIONS_WITH_PATH.include? option
+
+        converter.send option, value unless option == 'output'
+        # don't let pandoc write the output to enable postprocessing
+      end
+
+      begin
+        converter << input
+      rescue Paru::Error => e
+        raise PandocError.new(:error_running_pandoc, e, input_document)
+      end
+    end
+
+    def preprocess(input, config = {})
+      process input, 'preprocessors', config
+    end
+
+    def postprocess(input, config = {})
+      process input, 'postprocessors', config
+    end
+
+    # Run the input string through a list of filters called processors. There
+    # are to types: preprocessors and postprocessors
+    def process(input, type, config = {})
+      if config.has_key? type then
+        processors = config[type]
+        output = input
+        processors.each do |processor|
+          script = @config.update_path(processor, File.dirname(@src))
+          
+          raise ProcessorError.new(:script_does_not_exist, nil, script) unless File.exist? script
+          raise ProcessorError.new(:script_is_not_executable, nil, script) unless File.executable? script
+
+          begin
+            output = Processor.run(script, output)
+          rescue StandardError => e
+            ProcessorError.new(:error_processing_script, e, [script, @src])
+          end
+        end
+        output
+      else
+        input
+      end
+    end
+
+  end
+end