pandocomatic 0.0.13 → 0.1.0.b

data/lib/pandocomatic/printer/help_printer.rb

@@ -0,0 +1,27 @@
+#--
+# 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 HelpPrinter < Printer
+    def initialize()
+      super 'help.txt'
+    end
+  end
+end

data/lib/pandocomatic/printer/printer.rb

@@ -0,0 +1,43 @@
+#--
+# 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 'erb'
+
+  class Printer
+
+    def initialize(template_file = 'help.txt')
+      set_template template_file
+    end
+
+    def set_template(template_file)
+      dir = File.dirname(__FILE__)
+      @template = File.absolute_path(File.join(dir, 'views', template_file))
+    end
+
+    def to_s()
+      erb = ERB.new(File.read(@template), 0, '>')
+      erb.result(binding())
+    end
+
+    def print()
+      puts to_s()
+    end
+
+  end
+end

data/lib/pandocomatic/printer/summary_printer.rb

@@ -0,0 +1,35 @@
+#--
+# 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 SummaryPrinter < Printer
+    def initialize(command, input, output)
+      super 'summary.txt'
+      @command = command
+      @input = input
+      @output = output
+    end
+
+    def commands()
+      "#{@command.count} command#{'s' if @command.count != 1}"
+    end
+
+  end
+end

data/lib/pandocomatic/printer/version_printer.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 './printer.rb'
+
+  class VersionPrinter < Printer
+
+    def initialize version
+      super 'version.txt'
+      @version = version
+    end
+
+  end
+end

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

@@ -0,0 +1,12 @@
+<%=@error.message%>: <% case @error.type 
+when :no_input_given%>
+Specify the input file or directory with the option `--input PATH`.
+<% when :unknown_option %>
+See `pandocomatic --help` which options are allowed.
+<% when :too_many_options %>
+<%= @error.data.join(" ") %>.
+<% when :problematic_invocation %>
+<%=@error.error.message%>.
+<% else %>
+'<%= @error.data %>'.
+<% end %>

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

@@ -0,0 +1 @@
+(<%=@command.index_to_s%>) <%=if @command.directory? then "+ " else "  - " end%><%= @command.to_s%>

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

@@ -0,0 +1 @@
+<%=@error.message%>: '<%= @error.data %>'.

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

@@ -0,0 +1,10 @@
+Pandocomatic has encountered the following errors while trying to configure
+the conversion process:
+
+<% @errors.each do |error| %>
+- <%= error.show %>
+<% end %>
+
+Pandocomatic will not start the conversion process before these errors are
+resolved. See `pandocomatic --help` for more information on how to use
+pandocomatic.

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

@@ -0,0 +1,5 @@
+Pandocomatic has encountered an error:
+
+    <%= @error.message %>
+    <%= @error.data %>
+    <%= @error.error %>

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

@@ -0,0 +1 @@
+Pandocomatic needed <%=duration%> to convert '<%= @input %>' to '<%= @output %>'.

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

@@ -0,0 +1,135 @@
+  
+  Pandocomatic. Automate the use of pandoc to convert files or directories.
+
+USAGE
+
+  pandocomatic options [INPUT]
+
+DESCRIPTION
+
+  Automate the use of pandoc. Either converts a single file or a directory
+  tree. Configure the conversion process through configuration files.  Each
+  input file that is converted by pandocomatic is processed as follows:
+
+    input_file -> 
+      preprocessor(0) -> ... -> preprocessor(N) ->
+        pandoc -> 
+          postprocessor(0) -> ... -> postprocessor(M) -> 
+            output_file
+
+  The preprocessors and postprocessors used in the conversion process are
+  configured in pandocomatic templates. Besides processors, you can also
+  specify pandoc options to use to convert the input file. These templates are
+  specified in a configuration file. Templates can be used over and over, thus
+  automating the use of pandoc.
+
+OPTIONS
+
+  -i PATH, --input PATH
+                  Convert PATH. If this option is not given, INPUT is
+                  converted. INPUT and --input cannot be used together.
+
+  -o PATH, --output PATH
+                  Create converted files and directories in PATH.
+
+  optional arguments:
+
+  -d PATH, --data-dir PATH
+                  Configure pandocomatic to use PATH as its data directory.
+                  Default is PANDOC's data dir. (See `pandoc --version` to
+                  find PANDOC's data dir.)
+
+  -c PATH, --config PATH
+                  Configure pandocomatic to use PATH as its configuration file
+                  to use during the conversion process. Default is
+                  DATA_DIR/pandocomatic.yaml.
+                  
+                  Configuration files are YAML files and can contain the
+                  following properties:
+
+                  - data-dir: PATH (see --data-dir option)
+
+                  - settings:
+                    - skip: [GLOB PATTERNS] files to not convert. By default
+                      hidden files (starting with a ".") and
+                      "pandocomatic.yaml" are skipped.
+                    - recursive: BOOLEAN convert this directory recursively.
+                      Default is TRUE
+                    - follow_links: BOOLEAN follow symbolic links. Default is
+                      TRUE
+
+                  - templates:
+                    - glob: [GLOB PATTERNS] files to convert using this
+                      template.
+                    - preprocessors: [SCRIPTS] paths to scripts to run before
+                      converting with pandoc.
+                    - postprocessors: [SCRIPTS] paths to scripts to run after
+                      converting with pandoc.
+                    - pandoc: PANDOC OPTIONS to use when converting with
+                      pandoc.
+
+                  Each file and directory that is converted can contain a
+                  configuration YAML metadata block or YAML configuration file
+                  respectively. In a file, the property 'use-template' tells
+                  pandocomatic which template to use.
+
+  -m, --modified-only
+        
+                  Only convert files that have been modified. Only source files
+                  that have been updated later than the corresponding
+                  destination files will be converted, copied, or linked.
+                  Default is FALSE.
+
+  -q, --quiet     Run pandocomatic quietly. Default is FALSE.
+
+  -y, --dry-run   Configure pandocomatic to run the conversion process, but do
+                  not actually run it. Default is FALSE.
+
+  -v, --version   Show the version. If this option is used, all other options
+                  are ignored.
+
+  -h, --help      Show this help. If this options is used, all other options
+                  but --version are ignored.
+
+EXAMPLE:
+
+  Convert `hello.md` to `hello.html` according to the configuration in
+  `pandocomatic.yaml`:
+
+    pandocomatic --config pandocomatic.yaml -o hello.html -i hello.md
+
+  Generate a static site using data directory `assets`:
+
+    pandocomatic --data-dir assets/ -o website/ -i source/
+
+SEE ALSO
+
+  - Pandocomatic's documentation
+    https://heerdebeer.org/Software/markdown/pandocomatic/
+
+  - Pandoc's manual
+    http://pandoc.org/MANUAL.html
+
+  - YAML website
+    http://yaml.org/
+
+AUTHOR
+
+  Huub de Beer <Huub@heerdebeer.org>
+
+LICENSE
+
+  Copyright 2014, 2015, 2016, 2017, 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
+  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/>.

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

@@ -0,0 +1,12 @@
+<%=@error.message%>: <% case @error.type 
+when :error_opening_file%>
+<%=@error.error.message %>.
+<% when :error_writing_file %>
+<%=@error.error.message%>.
+<% when :error_opening_directory %>
+<%=@error.error.message%>.
+<% when :error_creating_directory %>
+<%=@error.error.message%>.
+<% else %>
+'<%= @error.data %>'.
+<% end %>

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

@@ -0,0 +1 @@
+<%=@error.message%>: '<%= @error.error.message %>'.

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

@@ -0,0 +1,6 @@
+<%=@error.message%>: <% case @error.type
+when :error_processing_script%>
+<%= @error[0] %> (<%= @error[1] %>).
+<% else %>
+'<%= @error.data %>'.
+<% end %>

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

@@ -0,0 +1 @@
+<% if @command.count <= 0 then%>Nothing to do<% else %><%= commands %> to execute to convert '<%= @input %>' to '<%= @output %>'<% end %>.

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

@@ -0,0 +1,7 @@
+Pandocomatic version <%=@version.join('.')%>
+© 2014, 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+
+Pandocomatic is free software; pandocomatic is released under the GPLv3.
+
+For more information about pandocomatic run 'pandocomatic --help' or read its
+documentation at https://heerdebeer.org/Software/markdown/pandocomatic/.

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

@@ -0,0 +1 @@
+Warning. <%=@warning.message.to_s%>: <%=@warning.src%>

data/lib/pandocomatic/printer/warning_printer.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 './printer.rb'
+
+  class WarningPrinter < Printer
+    def initialize(warning)
+      template = 'warning.txt'
+      super template
+      @warning = warning
+    end
+
+    def print
+      warn to_s
+    end
+  end
+end

data/lib/pandocomatic/processor.rb

@@ -1,13 +1,30 @@
+#--
+# 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 'open3'
 
-    require 'open3'
-
-    class Processor
-
-        def self.run script, input
-            output, status = Open3.capture2(script, :stdin_data => input)
-            output
-        end
+  class Processor
 
+    def self.run script, input
+      output, _ = Open3.capture2(script, :stdin_data => input)
+      output
     end
+
+  end
 end

data/lib/pandocomatic/warning.rb

@@ -0,0 +1,36 @@
+#--
+# 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
+  
+  class Warning
+
+    # :skipping_link_because_it_points_outside_the_source_tree
+    
+    def initialize(message = :unknown, data = nil)
+      @message = message
+      @data = data
+    end
+
+    def has_data?
+      not @data.nil?
+    end
+
+  end
+
+end 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.1.0.b
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-30 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru
@@ -19,7 +19,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,30 +29,57 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.2
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.2
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
-description: 'Automate the use of pandoc <http://pandoc.org>: use pandocomatic as
-  a makefile to convert one file, a whole directory of files, or even as a static
-  site generator.'
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+description: 'Automating the use of pandoc <http://pandoc.org>: use pandocomatic to
+  convert one file or a directory tree of files.'
 email: Huub@heerdebeer.org
 executables:
 - pandocomatic
@@ -60,14 +87,49 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/pandocomatic
+- lib/pandocomatic/cli.rb
+- lib/pandocomatic/command/command.rb
+- lib/pandocomatic/command/convert_dir_command.rb
+- lib/pandocomatic/command/convert_file_command.rb
+- lib/pandocomatic/command/copy_file_command.rb
+- lib/pandocomatic/command/create_link_command.rb
+- lib/pandocomatic/command/skip_command.rb
 - lib/pandocomatic/configuration.rb
 - lib/pandocomatic/default_configuration.yaml
-- lib/pandocomatic/dir_converter.rb
-- lib/pandocomatic/file_converter.rb
+- lib/pandocomatic/error/cli_error.rb
+- lib/pandocomatic/error/configuration_error.rb
+- lib/pandocomatic/error/io_error.rb
+- lib/pandocomatic/error/pandoc_error.rb
+- lib/pandocomatic/error/pandocomatic_error.rb
+- lib/pandocomatic/error/processor_error.rb
 - lib/pandocomatic/fileinfo_preprocessor.rb
 - lib/pandocomatic/pandoc_metadata.rb
+- lib/pandocomatic/pandocomatic.rb
+- lib/pandocomatic/printer/command_printer.rb
+- lib/pandocomatic/printer/configuration_errors_printer.rb
+- lib/pandocomatic/printer/error_printer.rb
+- lib/pandocomatic/printer/finish_printer.rb
+- lib/pandocomatic/printer/help_printer.rb
+- lib/pandocomatic/printer/printer.rb
+- lib/pandocomatic/printer/summary_printer.rb
+- lib/pandocomatic/printer/version_printer.rb
+- lib/pandocomatic/printer/views/cli_error.txt
+- lib/pandocomatic/printer/views/command.txt
+- lib/pandocomatic/printer/views/configuration_error.txt
+- lib/pandocomatic/printer/views/configuration_errors.txt
+- lib/pandocomatic/printer/views/error.txt
+- lib/pandocomatic/printer/views/finish.txt
+- lib/pandocomatic/printer/views/help.txt
+- lib/pandocomatic/printer/views/io_error.txt
+- lib/pandocomatic/printer/views/pandoc_error.txt
+- lib/pandocomatic/printer/views/processor_error.txt
+- lib/pandocomatic/printer/views/summary.txt
+- lib/pandocomatic/printer/views/version.txt
+- lib/pandocomatic/printer/views/warning.txt
+- lib/pandocomatic/printer/warning_printer.rb
 - lib/pandocomatic/processor.rb
-homepage: https://github.com/htdebeer/pandocomatic
+- lib/pandocomatic/warning.rb
+homepage: https://heerdebeer.org/Software/markdown/pandocomatic/
 licenses:
 - GPL-3.0
 metadata: {}
@@ -82,14 +144,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - pandoc, a universal document converer <http://pandoc.org>
 rubyforge_project: 
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Automate the use of pandoc
+summary: Automating the use of pandoc
 test_files: []