pandocomatic 0.0.13 → 0.1.0.b

data/lib/pandocomatic/error/io_error.rb

@@ -0,0 +1,50 @@
+#--
+# 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 './pandocomatic_error.rb'
+
+  class IOError < PandocomaticError
+
+    def template()
+      'io_error.txt'
+    end
+    
+    # :file_does_not_exist file
+    # :file_is_not_a_file file
+    # :file_is_not_readable file
+    # :file_is_not_writable file
+    
+    # :error_opening_file file
+    # :error_writing_file file
+    
+    # :directory_does_not_exist dir
+    # :directory_is_not_a_directory dir
+    # :directory_is_not_readable dir
+    # :directory_is_not_writable dir
+
+    # :error_opening_directory dir
+    # :error_creating_directory dir
+   
+    # :file_or_directory_does_not_exist src
+    # :unable_to_copy_file [src, dst]
+    # :unable_to_create_symbolic_link [src, dst]
+    # :unable_to_read_symbolic_link [src]
+  end
+
+end 

data/lib/pandocomatic/error/pandoc_error.rb

@@ -0,0 +1,30 @@
+#--
+# 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 './pandocomatic_error.rb'
+  
+  class PandocError < PandocomaticError
+
+    def template()
+      'pandoc_error.txt'
+    end
+
+    # :error_running_pandoc
+  end
+end 

data/lib/pandocomatic/error/pandocomatic_error.rb

@@ -0,0 +1,48 @@
+#--
+# 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/error_printer.rb'
+
+  class PandocomaticError < StandardError
+    attr_reader :type, :error, :data
+    def initialize(type = :unknown, error = nil, data = nil)
+      super type.to_s.gsub("_", " ").capitalize
+      @type = type
+      @error = error
+      @data = data
+    end
+
+    def has_error?()
+      not @error.nil?
+    end
+
+    def has_data?()
+      not @data.nil?
+    end
+
+    def print()
+      ErrorPrinter.new(self).print
+    end
+
+    def show()
+      ErrorPrinter.new(self).to_s
+    end
+
+  end
+end 

data/lib/pandocomatic/error/processor_error.rb

@@ -0,0 +1,33 @@
+#--
+# 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 './pandocomatic_error.rb'
+
+  class ProcessorError < PandocomaticError
+
+    def template()
+      'processor_error.txt'
+    end
+
+    # :script_does_not_exist script
+    # :script_is_not_executable script
+    # :error_processing_script [script, src]
+  end
+
+end 

data/lib/pandocomatic/fileinfo_preprocessor.rb

@@ -1,16 +1,37 @@
+#--
+# Copyright 2014, 2015, 2016, 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
-    class FileInfoPreprocessor < Processor
-        def self.run input, path
-            created_at = File.stat(path).ctime
-            modified_at = File.stat(path).mtime
-            output = input
-            output << "\n---\n"
-            output << "fileinfo:\n"
-            output << "  path: '#{path}'\n"
-            output << "  created: #{created_at.strftime '%Y-%m-%d'}\n"
-            output << "  modified: #{modified_at.strftime '%Y-%m-%d'}\n"
-            output << "..."
-            output
-        end
+
+  # FileInfoPreprocessor collects information about a file to be converted and
+  # mixes that information into that file's metadata. It is a default
+  # preprocessor.
+  class FileInfoPreprocessor < Processor
+    def self.run input, path
+      created_at = File.stat(path).ctime
+      modified_at = File.stat(path).mtime
+      output = input
+      output << "\n---\n"
+      output << "fileinfo:\n"
+      output << "  path: '#{path}'\n"
+      output << "  created: #{created_at.strftime '%Y-%m-%d'}\n"
+      output << "  modified: #{modified_at.strftime '%Y-%m-%d'}\n"
+      output << "..."
     end
+  end
 end

data/lib/pandocomatic/pandoc_metadata.rb

@@ -1,64 +1,93 @@
+#--
+# Copyright 2014, 2015, 2016, 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 'json'
   require 'yaml'
-  require 'paru/pandoc'
+  require 'paru'
 
-  class PandocMetadata < Hash
+  require_relative './error/pandoc_error.rb'
+  require_relative './error/io_error.rb'
 
+  class PandocMetadata < Hash
+  
     # Paru converters:
     # Note. When converting metadata back to the pandoc markdown format, you have
-    # to use the option "standalone", otherwise the metadata is skipped
-    PANDOC_2_JSON = Paru::Pandoc.new {from "markdown"; to "json"}
-    JSON_2_PANDOC = Paru::Pandoc.new {from "json"; to "markdown"; standalone}
+    # to use the option 'standalone', otherwise the metadata is skipped
+    PANDOC_2_JSON = Paru::Pandoc.new {from 'markdown'; to 'json'}
+    JSON_2_PANDOC = Paru::Pandoc.new {from 'json'; to 'markdown'; standalone}
 
     # When converting a pandoc document to JSON, or vice versa, the JSON object
     # has the following three properties:
-    VERSION = "pandoc-api-version"
-    META = "meta"
-    BLOCKS = "blocks"
-
-    def initialize hash = {}
-      super
-      merge! hash
-    end
+    VERSION = 'pandoc-api-version'
+    META = 'meta'
+    BLOCKS = 'blocks'
 
-    # Collect the metadata embedded in the src file
-    def self.load_file src
+    def self.extract_metadata input_document
       begin
-        yaml_metadata = PandocMetadata.pandoc2yaml File.read(src)
-        if yaml_metadata.empty? then
-          return PandocMetadata.new
-        else
-          return PandocMetadata.new YAML.load(yaml_metadata)
-        end
-      rescue Exception => e
-        raise "Error while reading metadata from #{src}; Are you sure it is a pandoc markdown file?\n#{e.message}"
+        pandoc2yaml File.read(input_document)
+      rescue StandardError => e
+        raise IOError.new(:error_opening_file, e, input_document)
       end
     end
 
-    def self.pandoc2yaml document
-      json = JSON.parse(PANDOC_2_JSON << document)
+    def self.pandoc2yaml(input)
       yaml = ""
+      begin
+        json = JSON.parse(PANDOC_2_JSON << input)
 
-      version, metadata = json.values_at(VERSION, META)
+        version, metadata = json.values_at(VERSION, META)
 
-      if not metadata.empty? then
-        metadata_document = {
-          VERSION => version, 
-          META => metadata, 
-          BLOCKS => []
-        }
+        if not metadata.empty? then
+          metadata_document = {
+            VERSION => version, 
+            META => metadata, 
+            BLOCKS => []
+          }
 
-        yaml = JSON_2_PANDOC << JSON.generate(metadata_document)
+          yaml = JSON_2_PANDOC << JSON.generate(metadata_document)
+        end
+      rescue Paru::Error => e
+        raise PandocError.new(:error_running_pandoc, e, input_document)
       end
 
       yaml
     end
 
+    # Collect the metadata embedded in the src file
+    def self.load_file src
+      yaml_metadata = extract_metadata src
+      if yaml_metadata.empty? then
+        return PandocMetadata.new
+      else
+        return PandocMetadata.new YAML.load(yaml_metadata)
+      end
+    end
+    
+    def initialize hash = {}
+      super
+      merge! hash
+    end
+
     def has_template?
       self['pandocomatic'] and self['pandocomatic']['use-template'] and 
-        not self['pandocomatic']['use-template'].empty?
+          not self['pandocomatic']['use-template'].empty?
     end
 
     def template_name
@@ -69,6 +98,9 @@ module Pandocomatic
       end
     end
 
+    # TODO: allow a pandoc block outside a pandocomatic block to make
+    # pandocomatic work like paru's do-pandoc.rb.
+
     def has_pandoc_options?
       self['pandocomatic'] and self['pandocomatic']['pandoc']
     end

data/lib/pandocomatic/pandocomatic.rb

@@ -0,0 +1,176 @@
+#--
+# Copyright 2014, 2015, 2016, 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 './error/pandocomatic_error.rb'
+  require_relative './error/pandoc_error.rb'
+  require_relative './error/configuration_error.rb'
+
+  require_relative './cli.rb'
+
+  require_relative './configuration.rb'
+
+  require_relative './printer/help_printer.rb'
+  require_relative './printer/version_printer.rb'
+  require_relative './printer/error_printer.rb'
+  require_relative './printer/configuration_errors_printer.rb'
+  require_relative './printer/finish_printer.rb'
+  require_relative './printer/summary_printer.rb'
+
+  require_relative './command/command.rb'
+  require_relative './command/convert_dir_command.rb'
+  require_relative './command/convert_file_command.rb'
+
+  class Pandocomatic
+    VERSION = [0, 1, 0]
+    CONFIG_FILE = 'pandocomatic.yaml'
+
+    def self.run(args)
+      begin
+        start_time = Time.now
+        options = CLI.parse args
+
+        if options[:version_given]
+          # The version option has precedence over all other options; if
+          # given, the version is printed
+          VersionPrinter.new(VERSION).print
+        elsif options[:help_given]
+          # The help option has precedence over all other options except the
+          # version option. If given, the help is printed.
+          HelpPrinter.new().print
+        else
+          # Run the pandocomatic converter configured according to the options
+          # given.
+          input = options[:input]
+          output = options[:output]
+          configuration = configure 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
+          # executed and if quiet the command is not printed to STDOUT
+          src_root = File.absolute_path input
+          dry_run = if options[:dry_run_given] then options[:dry_run] else false end
+          quiet = if options[:quiet_given] then options[:quiet] else false end
+          modified_only = if options[:modified_only_given] then options[:modified_only_given] else false end
+
+          Command.reset(src_root, dry_run, quiet, modified_only)
+
+          # Pandocomatic has two modes: converting a directory tree or
+          # converting a single file. The mode is selected by the input.
+          if File.directory? input
+            command = ConvertDirCommand.new(configuration, input, output)
+          else
+            command = ConvertFileCommand.new(configuration, input, output)
+          end
+
+          # Notify the user about all configuration errors collected when
+          # determining the commands to run to perform this pandocomatic
+          # conversion.
+          if command.all_errors.size > 0
+            ConfigurationErrorsPrinter.new(command.all_errors).print
+            exit
+          end
+
+          # Pandocomatic is successfully configured: running the
+          # actual conversion now.
+          SummaryPrinter.new(command, input, output).print unless quiet
+
+          # Depending on the options dry-run and quiet, the command.execute
+          # method will actually performing the commands (dry-run = false) and
+          # print the command to STDOUT (quiet = false)
+          command.execute()
+
+          FinishPrinter.new(command, input, output, start_time).print unless quiet
+        end
+      rescue PandocomaticError => e
+        # Report the error and break off the conversion process.
+        ErrorPrinter.new(e).print
+      rescue StandardError => e
+        # An unexpected error has occurred; break off the program drastically
+        # for now
+        raise e
+      end
+    end
+
+    private
+
+    def self.determine_config_file(options, data_dir = Dir.pwd)
+      config_file = ''
+
+      if options[:config_given]
+        config_file = options[:config]
+      elsif Dir.entries(data_dir).include? CONFIG_FILE
+        config_file = File.join(data_dir, CONFIG_FILE)
+      elsif Dir.entries(Dir.pwd()).include? CONFIG_FILE
+        config_file = File.join(Dir.pwd(), CONFIG_FILE)
+      else
+        # Fall back to default configuration file distributed with
+        # pandocomatic
+        config_file = File.join(__dir__, 'default_configuration.yaml')
+      end
+
+      path = File.absolute_path config_file
+
+      raise ConfigurationError.new(:config_file_does_not_exist, nil, path) unless File.exist? path
+      raise ConfigurationError.new(:config_file_is_not_a_file, nil, path) unless File.file? path
+      raise ConfigurationError.new(:config_file_is_not_readable, nil, path) unless File.readable? path
+
+      path
+    end
+
+    def self.determine_data_dir(options)
+      data_dir = ''
+
+      if options[:data_dir_given]
+        data_dir = options[:data_dir]
+      else
+        # No data-dir option given: try to find the default one from pandoc
+        begin
+          data_dir = Paru::Pandoc.info()[:data_dir]
+        rescue Paru::Error => e
+          # If pandoc cannot be run, continuing probably does not work out
+          # anyway, so raise pandoc error
+          raise PandocError.new(:error_running_pandoc, e, data_dir)
+        rescue StandardError => e
+          # Ignore error and use the current working directory as default working directory
+          data_dir = Dir.pwd
+        end
+      end
+
+      # check if data directory does exist and is readable
+      path = File.absolute_path data_dir
+
+      raise ConfigurationError.new(:data_dir_does_not_exist, nil, path) unless File.exist? path
+      raise ConfigurationError.new(:data_dir_is_not_a_directory, nil, path) unless File.directory? path
+      raise ConfigurationError.new(:data_dir_is_not_readable, nil, path) unless File.readable? path
+
+      path
+    end
+
+    def self.configure(options)
+      data_dir = determine_data_dir options
+      config_file = determine_config_file options, data_dir
+      Configuration.new options, data_dir, config_file
+    end
+
+  end
+end

data/lib/pandocomatic/printer/command_printer.rb

@@ -0,0 +1,28 @@
+#--
+# 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.rb'
+
+  class CommandPrinter < Printer
+    def initialize(command)
+      super 'command.txt'
+      @command = command
+    end
+  end
+end

data/lib/pandocomatic/printer/configuration_errors_printer.rb

@@ -0,0 +1,29 @@
+#--
+# 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.rb'
+
+  class ConfigurationErrorsPrinter < Printer
+    def initialize(errors)
+      super 'configuration_errors.txt'
+      @errors = errors
+    end
+
+  end
+end

data/lib/pandocomatic/printer/error_printer.rb

@@ -0,0 +1,34 @@
+#--
+# 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.rb'
+
+  class ErrorPrinter < Printer
+    def initialize(error)
+      template = if error.respond_to? :template then error.template else 'error.txt' end
+      super template
+      @error = error
+    end
+
+    def print
+      warn to_s
+    end
+
+  end
+end

data/lib/pandocomatic/printer/finish_printer.rb

@@ -0,0 +1,44 @@
+#--
+# 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 './summary_printer.rb'
+
+  class FinishPrinter < SummaryPrinter
+    MINUTE = 60 # seconds
+    def initialize(command, input, output, start_time)
+      super command, input, output
+      set_template 'finish.txt'
+
+      @start_time = start_time
+      @end_time = Time.now
+    end
+
+    def duration()
+      seconds = @end_time - @start_time
+      if seconds > MINUTE
+        minutes = (seconds / MINUTE).floor
+        seconds = seconds - (minutes * MINUTE)
+        "#{minutes} minute#{'s' if minutes != 1} and #{seconds.round(1)} second#{'s' if seconds != 1}"
+      else
+        "#{seconds.round(1)} second#{'s' if seconds != 1}"
+      end
+    end
+
+  end
+end