pandocomatic 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bb00b9f3b336ff545db723e8148c4328f31523f
-  data.tar.gz: 5efa1bc50a8f98269467ef14b72e41715f4f4706
+  metadata.gz: 270f53bbe40f85d3e270da8512c8c43b24b4f433
+  data.tar.gz: 9d637b18ad586b9513a8eae8d5e6ed9f0d08df0b
 SHA512:
-  metadata.gz: a0c11901a985c60c0103cd53796fb884c180568cabb35ce001b476c661f07553c9c14bd027603a0cc66f21b233294f60fc46cfd8944ec758b7fe0c8e5596ce7d
-  data.tar.gz: a19731270d23f2ca21acf6fdf5fe017fe8a629aff100661669c69f758396ff59ba0fe33dcd25d7f40aafe853645a7f328860aaaf335b6105f605c7c6ce42135d
+  metadata.gz: c6ce8bb13042c452f0087ab30435c1ea72e76f509f31b475fdbd1f50f041829ff49e5b2d68efee5b731e41de397dd5694287fc3216369f9fa5503df877a5e1db
+  data.tar.gz: a1c5c4f72999edf47d31a4afbb02285d8aab3f8b6199f0bb42a46037e81e9c6c5533e30ae671e08b78c3aa7c1abf2fc87215690aab51c1d136e270782792a48f

data/bin/pandocomatic

@@ -1,74 +1,76 @@
 #!/usr/bin/env ruby
 
 require 'trollop'
-require 'yaml'
+require 'fileutils'
 
 require_relative '../lib/pandocomatic/dir_converter.rb'
 require_relative '../lib/pandocomatic/file_converter.rb'
 require_relative '../lib/pandocomatic/configuration.rb'
 
-def convert_file input, opts
-  puts "converting file"
-end
-
-def convert_dir input, opts
-  puts "converting dir"
-end
-
-def convert_tree input, opts
-  puts "Converting tree"
-end
-
 opts = Trollop::options do
-  version "pandocomatic 0.0.1"
+  version "pandocomatic 0.0.3"
   banner <<-EOB
 
 Pandocomatic automates the use of pandoc (<http://www.pandoc.org>). It can be
-used to convert a file, a directory, or a directory tree.
+used to convert one file or a whole directory (tree).
 
 Usage:
 
-  Convert a file
-
-      pandocomatic [--config file.yaml] --output output.file input.file
-
-  Convert a directory or directory tree
-
-      pandocomatic [--config file.yaml] [--recursive] --output output.dir input.dir
+    pandocomatic [--config pandocomatic.yaml] --output output input
 
 Options:
 EOB
-  opt :config, "pandocomatic configuration file", :type => :string
-  opt :recursive, "apply pandocomatic recursively"
-  opt :target, "named conversion target", :type => :string
+
+  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? then
-  config = Pandocomatic::Configuration.new
+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
-  if not File.exist? opts[:config] or not File.readable? opts[:config] then
-    Trollop::die "Cannot read configuration file #{opts[:config]}" if File
-  end
+    settings_file = opts[:config]
+end
 
-  config = Pandocomatic::Configuration.new YAML.load_file opts[:config]
+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
 
-  config.configure({'recursive' => true}) if opts[:recursive] 
   Pandocomatic::DirConverter.new(input, output, config).convert
 
 else 

data/lib/pandocomatic/configuration.rb

@@ -1,124 +1,160 @@
 module Pandocomatic
 
-  require 'paru/pandoc'
-
-  DEFAULT_CONFIG = {
-        'recursive' => true,
-        'follow_links' => false,
-        'skip' => ['.*', 'pandocomatic.yaml'],
-        'targets' => {
-          'markdown' => {
-            'pattern' => ['*.markdown', '*.md'],
-            'pandoc' => {
-              'from' => 'markdown',
-              'to' => 'html5'
-            }
-          }
-        }
-      }
-
-  FORMAT_TO_EXT = {
-    'native' => 'hs',
-    'markdown_strict' => 'markdown',
-    'markdown_phpextra' => 'markdown',
-    'markdown_github' => 'markdown',
-    'html5' => 'html',
-    'docx' => 'docx',
-    'latex' => 'tex'
-  }
-
-  class Configuration
-
-    def initialize hash = DEFAULT_CONFIG
-      @config = {
-        'recursive' => true,
-        'follow_links' => false,
-        'skip' => ['.*'],
-        'targets' => {}
-      }
-      @convert_patterns = {}
-      configure hash
-    end
+    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
+
+            @settings = {'skip' => ['.*', 'pandocomatic.yaml']} # hidden files will always be skipped, as will pandocomatic configuration files
+            @templates = {}
+            @convert_patterns = {}
+            configure settings
+        end
 
-    def configure options
-      options.each do |key, value|
-        if key == 'targets' then
-          update_targets value
-        else
-          @config[key] = value
+        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
-      end
-    end
 
-    def reconfigure options
-      new_config = Marshal.load(Marshal.dump(self))
-      new_config.configure options
-      new_config
-    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|
+                    reset_template name, template
+                end
+            end
+        end
 
-    def marshal_dump
-      [@config, @convert_patterns]
-    end
+        def marshal_dump
+            [@data_dir, @settings, @templates, @convert_patterns]
+        end
 
-    def marshal_load array
-      @config, @convert_patterns = array
-    end
+        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
 
-    def update_targets targets
-      targets.each do |name, options|
-        @config['targets'][name] = options
-        @convert_patterns[name] = options['pattern']
-      end
-    end
+        def convert? src
+            @convert_patterns.values.flatten.any? {|glob| File.fnmatch glob, File.basename(src)}
+        end
 
-    def skip? src
-      @config['skip'].any? {|pattern| File.fnmatch pattern, File.basename(src)}
-    end
+        def recursive?
+            @settings['recursive']
+        end
 
-    def convert? src
-      @convert_patterns.values.flatten.any? {|pattern| File.fnmatch pattern, File.basename(src)}
-    end
+        def follow_links?
+            @settings['follow_links']
+        end
 
-    def recursive?
-      @config['recursive']
-    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 follow_links?
-      @config['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
+                to = @templates[template]['pandoc']['to']
+                extension = FORMAT_TO_EXT[to] || to
+            end
+        end
 
-    def find_extension dst
-      target = determine_target dst
-      if target.nil? then
-        extension = 'html'
-      else
-        to = @config['targets'][target]['pandoc']['to']
-        extension = FORMAT_TO_EXT[to] || to
-      end
-    end
+        def get_template template_name
+            @templates[template_name]
+        end
 
-    
-    def get_target_config target
-      @config['targets'][target]
-    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 determine_target src
-      @convert_patterns.select do |target, patterns|
-        patterns.any? {|pattern| File.fnmatch pattern, 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
 
-    def to_s 
-      @config
-    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
+                @templates[name].merge! template
+            else
+                @templates[name] = template
+            end
+            if template.has_key? 'glob' then
+                @convert_patterns[name] = template['glob']
+            end
+        end
 
-  end
+    end
 
 end

data/lib/pandocomatic/default_configuration.yaml

@@ -0,0 +1,13 @@
+settings:
+    recursive: true
+    follow-symlinks: true
+    skip: ['.*', 'pandocomatic.yaml']
+templates:
+    markdown-to-html:
+        glob: ['*.markdown', '*.md']
+        preprocessors: []
+        pandoc:
+            from: markdown
+            to: html5
+            standalone: true
+        postprocessors: []

data/lib/pandocomatic/dir_converter.rb

@@ -1,7 +1,6 @@
 module Pandocomatic
 
   require 'fileutils'
-
   require_relative 'file_converter.rb'
 
   CONFIG_FILE = 'pandocomatic.yaml'
@@ -27,12 +26,15 @@ module Pandocomatic
 
         dst = File.join dst_dir, filename
 
-        if File.directory? src and config.recursive?
+        if File.directory? src then
+            if config.recursive? then
           
-          # Convert subdirectories only when the recursivity is set in the
-          # configuration.
-          convert src, dst, config
-
+              # Convert subdirectories only when the recursivity is set in the
+              # configuration.
+              convert src, dst, config
+            else
+              next # skip directories when not recursive
+            end
         elsif File.symlink? src and not config.follow_links
 
           recreate_link src, dst
@@ -68,8 +70,7 @@ module Pandocomatic
     def reconfigure current_config, src_dir
       config_file = File.join src_dir, CONFIG_FILE
       if File.exist? config_file then
-        require 'yaml'
-        current_config.reconfigure YAML.load_file config_file
+        current_config.reconfigure config_file
       else
         current_config
       end
@@ -101,7 +102,6 @@ module Pandocomatic
       end
     end
 
-
   end
     
 end

data/lib/pandocomatic/file_converter.rb

@@ -1,30 +1,31 @@
 module Pandocomatic
 
-
   require 'paru/pandoc'
   require_relative 'pandoc_metadata.rb'
+  require_relative 'processor.rb'
+  require_relative 'fileinfo_preprocessor'
 
   class FileConverter
 
-    def initialize
-    end
-
     def convert src, dst, current_config
+      @config = current_config
       metadata = PandocMetadata.load_file src
 
-      if metadata.has_target? then
-        target = metadata.target
+      if metadata.has_template? then
+        template_name = metadata.template_name
       else
-        target = current_config.determine_target src
+        template_name = @config.determine_template src
       end
 
-      config = current_config.get_target_config target
-      pandoc_options = (config['pandoc'] || {}).merge(metadata.pandoc_options || {})
+      template = @config.get_template template_name
+
+      pandoc_options = (template['pandoc'] || {}).merge(metadata.pandoc_options || {})
 
       input = File.read src
-      input = preprocess input, config
-      input = pandoc input, pandoc_options
-      output = postprocess input, config
+      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']
@@ -37,9 +38,30 @@ module Pandocomatic
 
     private
 
-    def pandoc input, options
+    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
@@ -61,14 +83,14 @@ module Pandocomatic
         processors = config[type]
         output = input
         processors.each do |processor|
-          output = processor << output
+          output = Processor.run(@config.update_path(type, processor), output)
         end
+        output
       else
         input
       end
     end
 
-
   end
 
 end

data/lib/pandocomatic/fileinfo_preprocessor.rb

@@ -0,0 +1,15 @@
+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 << "..."
+        end
+    end
+end

data/lib/pandocomatic/pandoc_metadata.rb

@@ -31,13 +31,15 @@ module Pandocomatic
       end
     end
 
-    def has_target?
-      has_key? 'pandocomatic' and self['pandocomatic'].has_key? 'target'
+    def has_template?
+      has_key? 'pandocomatic' and 
+          self['pandocomatic'].has_key? 'use-template' and 
+          not self['pandocomatic']['use-template'].empty?
     end
 
-    def target
-      if has_target? then
-        self['pandocomatic']['target']
+    def template_name
+      if has_template? then
+        self['pandocomatic']['use-template']
       else
         ''
       end

data/lib/pandocomatic/processor.rb

@@ -0,0 +1,13 @@
+module Pandocomatic
+
+    require 'open3'
+
+    class Processor
+
+        def self.run script, input
+            output, status = Open3.capture2(script, :stdin_data => input)
+            output
+        end
+
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-14 00:00:00.000000000 Z
+date: 2015-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru
@@ -56,16 +56,17 @@ description: 'Automate the use of pandoc <http://pandoc.org>: use pandocomatic a
 email: Huub@heerdebeer.org
 executables:
 - pandocomatic
-- pandoc2yaml
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/pandoc2yaml
 - bin/pandocomatic
 - lib/pandocomatic/configuration.rb
+- lib/pandocomatic/default_configuration.yaml
 - lib/pandocomatic/dir_converter.rb
 - lib/pandocomatic/file_converter.rb
+- lib/pandocomatic/fileinfo_preprocessor.rb
 - lib/pandocomatic/pandoc_metadata.rb
+- lib/pandocomatic/processor.rb
 homepage: https://github.com/htdebeer/pandocomatic
 licenses:
 - GPL3

data/bin/pandoc2yaml

@@ -1,48 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'trollop'
-require 'yaml'
-
-require_relative '../lib/pandocomatic/pandoc_metadata.rb'
-
-opts = Trollop::options do
-  version "pandoc2yaml 1"
-  banner <<-EOB
-
-pandoc2yaml collects the metadata in a pandoc markdown file and exports it to
-yaml.
-
-Usage:
-
-    pandoc2yaml [-o output.yaml] input.markdown
-
-Options:
-EOB
-
-  opt :output, "optional output file, use STDOUT as default", :type => :string
-end
-
-begin
-  if ARGV.length != 1 then
-    Trollop::die "pandoc2yaml expects one input file as argument"
-  end
-
-  input = ARGV.first
-
-  Trollop::die "#{input} does not exist" if not File.exist? input
-  Trollop::die "#{input} is not a file" if not File.file? input
-  Trollop::die "#{input} is not readable" if not File.readable? input
-  
-  metadata = YAML.dump Pandocomatic::PandocMetadata.load_file input
-
-  if opts[:output].nil? then
-    $stdout << metadata 
-  else
-    File.open(opts[:output], "w") do |file|
-      file << metadata
-    end
-  end
-
-rescue Exception => e
-  warn "Error while collecting metadata: #{e.message}"
-end