pandocomatic 0.0.13 → 0.1.0.b

data/lib/pandocomatic/command/copy_file_command.rb

@@ -0,0 +1,49 @@
+#--
+# 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 'fileutils'
+
+  require_relative '../error/io_error.rb'
+  require_relative 'command.rb'
+
+  class CopyFileCommand < Command
+    attr_reader :src
+
+    def initialize(src, dst)
+      super()
+      @src = src
+      @dst = dst
+      @errors.push IOError.new(:file_is_not_readable, nil, @src) unless File.readable? @src
+      @errors.push IOError.new(:file_is_not_writable, nil, @dst) unless not File.exist?(@dst) or File.writable?(@dst)
+    end
+
+    def run()
+      begin
+        FileUtils.cp(@src, @dst) if file_modified?(@src, @dst)
+      rescue StandardError => e
+        raise IOError.new(:unable_to_copy_file, e, [@src, @dst])
+      end
+    end
+
+    def to_s()
+      "copy #{File.basename @src}"
+    end
+    
+  end
+end

data/lib/pandocomatic/command/create_link_command.rb

@@ -0,0 +1,85 @@
+#--
+# 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 'command.rb'
+
+  require_relative '../warning.rb'
+  require_relative '../error/io_error.rb'
+  require_relative '../printer/warning_printer.rb'
+
+  class CreateLinkCommand < Command
+
+    attr_reader :src, :dst, :dst_target
+
+    def initialize(src, dst)
+      super()
+      @src = src
+      begin
+        src_target = File.readlink @src
+
+        if src_target.start_with? '.' then
+          full_src_target = File.expand_path src_target, File.dirname(src)
+
+          if full_src_target.start_with? src_root()
+            @dst = dst
+            @dst_target = src_target
+          else
+            WarningPrinter.new(Warning.new(:skipping_link_because_it_points_outside_the_source_tree, @src)).print
+          end
+
+          uncount if skip?
+        end
+      rescue StandardError => e
+        @errors.push IOError.new(:unable_to_read_symbolic_link, e, @src)
+      end
+    end
+
+    def run()
+      begin
+        File.symlink @dst_target, @dst unless File.exist? @dst
+      rescue StandardError => e
+        raise IOError.new(:unable_to_create_symbolic_link, e, [@src, @dst])
+      end
+    end
+
+    def runnable?()
+      not (has_errors? or @dst.nil? or @dst_target.nil? or @src.nil?)
+    end
+
+    def to_s()
+      "link #{File.basename @dst} -> #{@dst_target}"
+    end
+
+    def skip?()
+      not modified_only? or not modified?
+    end
+    
+    def modified?()
+      if File.exist? @dst then
+        absolute_dst = File.realpath @dst
+        target = File.expand_path(@dst_target, absolute_dst)
+        absolute_dst != target
+      else
+        true
+      end
+    end
+
+  end
+end

data/lib/pandocomatic/command/skip_command.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 'command.rb'
+
+  class SkipCommand < Command
+    attr_reader :src, :message
+
+    def initialize(src, message)
+      super()
+      @src = src
+      @message = message
+    end
+
+    def has_message?()
+      not(@message.nil? or @message.empty?)
+    end
+
+    def run()
+    end
+
+    def skip?()
+      true
+    end
+
+    def to_s
+      "skipping #{File.basename @src}" + if has_message?
+        ": #{@message.to_s}"
+      end
+    end
+
+  end
+end

data/lib/pandocomatic/configuration.rb

@@ -1,191 +1,239 @@
+#--
+# 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 'yaml'
-    require 'paru/pandoc'
-
-    DEFAULT_CONFIG = YAML.load_file File.join(__dir__, 'default_configuration.yaml')
-
-    FORMAT_TO_EXT = {
-        'native' => 'hs',
-        'markdown_strict' => 'markdown',
-        'markdown_phpextra' => 'markdown',
-        'markdown_github' => 'markdown',
-        'html5' => 'html',
-        'docx' => 'docx',
-        'latex' => 'tex'
-    }
-
-    class Configuration
-
-        def initialize filename
-            begin
-                path = File.absolute_path filename
-                settings = YAML.load_file path
-                if settings['settings'] and settings['settings']['data-dir'] then
-                    data_dir = settings['settings']['data-dir']
-                    src_dir = File.dirname filename
-                    if data_dir.start_with? '.' then
-                        @data_dir = File.absolute_path data_dir, src_dir
-                    else
-                        @data_dir = data_dir
-                    end
-                else
-                    @data_dir = File.join Dir.home, '.pandocomatic'
-                end
-            rescue Exception => e
-                raise "Unable to load configuration file #{settings}: #{e.message}"
-            end
+  require 'yaml'
+  require 'paru/pandoc'
 
-            @settings = {'skip' => ['.*', 'pandocomatic.yaml']} # hidden files will always be skipped, as will pandocomatic configuration files
-            @templates = {}
-            @convert_patterns = {}
-            configure settings
-        end
+  DEFAULT_CONFIG = YAML.load_file File.join(__dir__, 'default_configuration.yaml')
 
-        def reconfigure filename
-            begin
-                settings = YAML.load_file filename
-                new_config = Marshal.load(Marshal.dump(self))
-                new_config.configure settings
-                new_config
-            rescue Exception => e
-                raise "Unable to load configuration file #{filename}: #{e.message}"
-            end
-        end
+  FORMAT_TO_EXT = {
+    'native' => 'hs',
+    'markdown_strict' => 'markdown',
+    'markdown_phpextra' => 'markdown',
+    'markdown_github' => 'markdown',
+    'html5' => 'html',
+    'docx' => 'docx',
+    'latex' => 'tex'
+  }
 
-        def configure settings
-            reset_settings settings['settings'] if settings.has_key? 'settings'
-            if settings.has_key? 'templates' then
-                settings['templates'].each do |name, template|
-                    full_template = {
-                        'glob' => [],
-                        'preprocessors' => [],
-                        'pandoc' => {},
-                        'postprocessors' => []
-                    }
-
-                    reset_template name, full_template.merge(template)
-                end
-            end
-        end
+  # Configuration describes a pandocomatic configuration.
+  class Configuration
 
-        def marshal_dump
-            [@data_dir, @settings, @templates, @convert_patterns]
-        end
+    def initialize options, data_dir, configuration_file
+      @data_dir = data_dir
 
-        def marshal_load array
-            @data_dir, @settings, @templates, @convert_patterns = array
-        end
-    
-        def skip? src
-            if @settings.has_key? 'skip' then
-                @settings['skip'].any? {|glob| File.fnmatch glob, File.basename(src)}
-            else
-                false
-            end
-        end
+      load configuration_file
+    end
 
-        def convert? src
-            @convert_patterns.values.flatten.any? {|glob| File.fnmatch glob, File.basename(src)}
-        end
+    # Read a configuration file and create a pandocomatic configuration object
+    #
+    # @param [String] filename Path to the configuration yaml file
+    # @returns [Configuration] a pandocomatic configuration object
+    def load(filename)
+      begin
+        path = File.absolute_path filename
+        settings = YAML.load_file path
+        if settings['settings'] and settings['settings']['data-dir'] then
+          data_dir = settings['settings']['data-dir']
+          src_dir = File.dirname filename
+          if data_dir.start_with? '.' then
+            @data_dir = File.absolute_path data_dir, src_dir
+          else
+            @data_dir = data_dir
+          end
+        end
+      rescue StandardError => e
+        raise ConfigurationError.new(:unable_to_load_config_file, e, filename)
+      end
+
+      # hidden files will always be skipped, as will pandocomatic
+      # configuration files, unless explicitly set to not skip via the
+      # "unskip" option
+
+      @settings = {'skip' => ['.*', 'pandocomatic.yaml']} 
+
+      @templates = {}
+      @convert_patterns = {}
+
+      configure settings
+    end
 
-        def recursive?
-            @settings['recursive']
-        end
+    # Update this configuration with a configuration file
+    #
+    # @param [String] filename path to the configuration file
+    #
+    # @returns [Configuration] a new configuration
+    def reconfigure(filename)
+      begin
+        settings = YAML.load_file filename
+        new_config = Marshal.load(Marshal.dump(self))
+        new_config.configure settings
+        new_config
+      rescue StandardError => e
+        raise ConfigurationError.new(:unable_to_load_config_file, e, filename)
+      end
+    end
 
-        def follow_links?
-            @settings['follow_links']
-        end
+    def configure(settings)
+      reset_settings settings['settings'] if settings.has_key? 'settings'
+      if settings.has_key? 'templates' then
+        settings['templates'].each do |name, template|
+          full_template = {
+            'glob' => [],
+            'preprocessors' => [],
+            'pandoc' => {},
+            'postprocessors' => []
+          }
 
-        def set_extension dst
-            dir = File.dirname dst
-            ext = File.extname dst
-            basename = File.basename dst, ext
-            File.join dir, "#{basename}.#{find_extension dst}"
+          reset_template name, full_template.merge(template)
         end
+      end
+    end
 
-        def find_extension dst
-            template = determine_template dst
-            if template.nil? then
-                extension = 'html'
-            else
-                to = @templates[template]['pandoc']['to']
-                extension = FORMAT_TO_EXT[to] || to
-            end
-        end
+    def marshal_dump()
+      [@data_dir, @settings, @templates, @convert_patterns]
+    end
 
-        def get_template template_name
-            @templates[template_name]
-        end
+    def marshal_load(array)
+      @data_dir, @settings, @templates, @convert_patterns  = array
+    end
 
-        def determine_template src
-            @convert_patterns.select do |template_name, globs|
-                globs.any? {|glob| File.fnmatch glob, File.basename(src)}
-            end.keys.first
-        end
+    def to_s()
+      marshal_dump
+    end
 
-        def update_path path, src_dir
-            if path.start_with? './' 
-                # refers to a local (to file) dir
-                File.join src_dir, path
-            elsif path.start_with? '/' then
-                path
-            else
-                # refers to data-dir
-                File.join @data_dir, path
-            end
-        end
+    def skip?(src)
+      if @settings.has_key? 'skip' then
+        @settings['skip'].any? {|glob| File.fnmatch glob, File.basename(src)}
+      else
+        false
+      end
+    end
 
-        private 
-        
-        def reset_settings settings
-            settings.each do |setting, value|
-                case setting
-                when 'skip'
-                    @settings['skip'] = @settings['skip'].concat(value).uniq
-                when 'data-dir'
-                    next # skip data-dir setting; is set once in initialization
-                else
-                    @settings[setting] = value
-                end
-            end
+    def convert?(src)
+      @convert_patterns.values.flatten.any? {|glob| File.fnmatch glob, File.basename(src)}
+    end
+
+    def recursive?()
+      @settings['recursive']
+    end
+
+    def follow_links?()
+      @settings['follow_links']
+    end
+
+    def set_extension(dst)
+      dir = File.dirname dst
+      ext = File.extname dst
+      basename = File.basename dst, ext
+      File.join dir, "#{basename}.#{find_extension dst}"
+    end
+
+    def find_extension(dst)
+      template = determine_template dst
+      if template.nil? then
+        extension = 'html'
+      else
+        # TODO: what if there is no pandoc.to?
+        to = @templates[template]['pandoc']['to']
+        extension = FORMAT_TO_EXT[to] || to
+      end
+    end
+
+    def has_template?(template_name)
+      @templates.has_key? template_name
+    end
+
+    def get_template(template_name)
+      @templates[template_name]
+    end
+
+    def determine_template(src)
+      @convert_patterns.select do |template_name, globs|
+        globs.any? {|glob| File.fnmatch glob, File.basename(src)}
+      end.keys.first
+    end
+
+    def update_path(path, src_dir)
+      if path.start_with? './' 
+        # refers to a local (to file) dir
+        File.join src_dir, path
+      elsif path.start_with? '/' then
+        path
+      else
+        # refers to data-dir
+        File.join @data_dir, path
+      end
+    end
+
+    private 
+
+    def reset_settings(settings)
+      settings.each do |setting, value|
+        case setting
+        when 'skip'
+          @settings['skip'] = @settings['skip'].concat(value).uniq
+        when 'data-dir'
+          next # skip data-dir setting; is set once in initialization
+        else
+          @settings[setting] = value
         end
+      end
+    end
 
-        def reset_template name, template
-            if @templates.has_key? name then
-                fields = ['glob', 'preprocessors', 'pandoc', 'postprocessors']
-                fields.each do |field|
-                    case field
-                    when 'preprocessors', 'postprocessors', 'glob'
-                        if @templates[name][field] then
-                            if template[field] then
-                                @templates[name][field].concat(template[field]).uniq!
-                            end
-                        else
-                            if template[field] then
-                                @templates[name][field] = template[field]
-                            end
-                        end
-                    when 'pandoc'
-                        if @templates[name][field] then
-                            if template[field] then
-                                @templates[name][field].merge! template[field]
-                            end
-                        else
-                            if template[field] then
-                                @templates[name][field] = template[field]
-                            end
-                        end
-                    end
-                end
+    def reset_template(name, template)
+      if @templates.has_key? name then
+        fields = ['glob', 'preprocessors', 'pandoc', 'postprocessors']
+        fields.each do |field|
+          case field
+          when 'preprocessors', 'postprocessors', 'glob'
+            if @templates[name][field] then
+              if template[field] then
+                @templates[name][field].concat(template[field]).uniq!
+              end
             else
-                @templates[name] = template
+              if template[field] then
+                @templates[name][field] = template[field]
+              end
             end
-            if template.has_key? 'glob' then
-                @convert_patterns[name] = template['glob']
+          when 'pandoc'
+            if @templates[name][field] then
+              if template[field] then
+                @templates[name][field].merge! template[field]
+              end
+            else
+              if template[field] then
+                @templates[name][field] = template[field]
+              end
             end
+          end
         end
+      else
+        @templates[name] = template
+      end
 
+      if template.has_key? 'glob' then
+        @convert_patterns[name] = template['glob']
+      end
     end
 
+  end
+
 end

data/lib/pandocomatic/error/cli_error.rb

@@ -0,0 +1,49 @@
+#--
+# 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 CLIError < PandocomaticError
+
+    def template()
+      'cli_error.txt'
+    end
+
+      # :no_input_given,
+      # :input_does_not_exist,
+      # :input_is_not_readable,
+
+      # :no_output_given,
+      # :output_is_not_a_directory,
+      # :output_is_not_a_file,
+      # :output_it_not_writable,
+
+      # :unknown_option,
+      # :too_many_options,
+      # :problematic_invocation,
+
+      # :data_dir_does_not_exist,
+      # :data_dir_is_not_a_directory,
+      # :data_dir_is_not_readable,
+
+      # :config_file_does_not_exist,
+      # :config_file_is_not_a_file,
+      # :config_file_is_not_readable
+  end
+end 

data/lib/pandocomatic/error/configuration_error.rb

@@ -0,0 +1,39 @@
+#--
+# 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 ConfigurationError < PandocomaticError
+    
+    def template()
+      'configuration_error.txt'
+    end
+
+    # :data_dir_does_not_exist,
+    # :data_dir_is_not_a_directory,
+    # :data_dir_is_not_readable,
+
+    # :config_file_does_not_exist,
+    # :config_file_is_not_a_file,
+    # :config_file_is_not_readable,
+    # :unable_to_load_config_file
+    
+    # :no_such_template
+  end
+end