gimli 0.2.3 → 0.3.0

data/README.textile

@@ -8,11 +8,9 @@ Gimli is a utility for converting markup to pdf files. Useful for reports and su
 It's a developed version of "textile2pdf":https://github.com/walle/textile2pdf to support multiple markup styles and to get syntax highlighting.
 
 It's inspired by the markup convertion in "gollum":https://github.com/github/gollum. The markup code is adapted from gollum.
-It works by converting the markup to pdf using "PDFKit":https://github.com/jdpace/PDFKit
+It works by converting the markup to pdf using "wkhtmltopdf":https://github.com/antialize/wkhtmltopdf
 The markup is converted to html using "github/markup":https://github.com/github/markup
 
-Check out a small presentation here. "http://slides.wallgren.me/gimli":http://slides.wallgren.me/gimli
-
 h3. Markup
 
 Markup files may be written in any format supported by GitHub-Markup (except roff).
@@ -51,6 +49,14 @@ Standard behavior is for gimli to output the files in the current directory. To
 
 Gimli also plays nice with Jekyll style markup files. You can pass gimli the @-y@ flag to have it remove Jekyll's YAML front matter from the top of your markup files. Allowing you to use gimli & Jekyll together on your Blog/Resume/Catalogue to create nicely formatted versions for online and offline viewing.
 
+To pass parameters directly to wkhtmltopdf, use the @-w@ flag. eg.
+
+bc. $ gimli -f test.md -w '--toc --footer-right "[page]/[toPage]"'
+
+This gives a pdf with a table of contents and page numbers in the footer.
+
+See the "man page":https://github.com/antialize/wkhtmltopdf/blob/master/README_WKHTMLTOPDF#L80 for wkhtmltopdf for all possible parameters.
+
 Run @gimli -h@ for a full list of options available
 
 h2. Syntax highlighting

data/bin/gimli

@@ -9,5 +9,16 @@ if ARGV.flags.version?
   exit
 end
 
-Gimli.process! ARGV.flags.file, ARGV.flags.recursive?, ARGV.flags.merge?, ARGV.flags.pagenumbers?, ARGV.flags.tableofcontents?, ARGV.flags.removefrontmatter, ARGV.flags.outputfilename, ARGV.flags.outputdir, ARGV.flags.stylesheet
+config = Gimli.configure do |config|
+  config.file = ARGV.flags.file
+  config.recursive = ARGV.flags.recursive?
+  config.merge = ARGV.flags.merge?
+  config.wkhtmltopdf_parameters = ARGV.flags.wkhtmltopdfparameters
+  config.remove_front_matter = ARGV.flags.removefrontmatter
+  config.output_filename = ARGV.flags.outputfilename
+  config.output_dir = ARGV.flags.outputdir
+  config.stylesheet = ARGV.flags.stylesheet
+end
+
+Gimli.process! config
 

data/lib/gimli.rb

@@ -1,19 +1,32 @@
 # encoding: utf-8
 
 require 'gimli/version'
+require 'gimli/config'
 require 'gimli/setup'
 require 'gimli/markupfile'
 require 'gimli/converter'
 require 'gimli/albino'
 require 'gimli/path'
+require 'gimli/wkhtmltopdf'
 
 module Gimli
 
-  # Starts the processing of selected files
-  def self.process!(file, recursive = false, merge = false, pagenumbers = false, tableofcontents = false, remove_front_matter = false, output_filename = nil, output_dir = nil, stylesheet = nil)
-
+  # Create a config object
+  # @example Example usage
+  #   config = Gimli.configure |config| do
+  #     config.file = './test.md'
+  #     config.output_dir = '/tmp'
+  #     config.table_of_contents = true
+  #   end
+  def self.configure
+    config = Config.new
+    yield config
+    config
+  end
 
-    @files = Path.list_valid(file, recursive).map { |file| MarkupFile.new(file) }
-    Converter.new(@files, merge, pagenumbers, tableofcontents, remove_front_matter, output_filename, output_dir, stylesheet).convert!
+  # Starts the processing of selected files
+  def self.process!(config)
+    @files = Path.list_valid(config.file, config.recursive).map { |file| MarkupFile.new(file) }
+    Converter.new(@files, config).convert!
   end
 end

data/lib/gimli/config.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Gimli
+
+  # Class that keeps the config parameters
+  class Config
+    attr_accessor :file, :recursive, :merge, :wkhtmltopdf_parameters, :remove_front_matter, :output_filename, :output_dir, :stylesheet
+
+    # Sets default values
+    def initialize
+      @recursive = false
+      @merge = false
+      @page_numbers = false
+      @table_of_contents = false
+      @remove_front_matter = false
+    end
+
+  end
+
+end

data/lib/gimli/converter.rb

@@ -2,33 +2,27 @@
 
 require 'fileutils'
 
-require 'pdfkit'
-
 require 'gimli/markup'
 
 module Gimli
 
-  # The class that communicates with PDFKit
+  # The class that converts the files
   class Converter
 
     # Initialize the converter with a File
     # @param [Array] files The list of Gimli::MarkupFile to convert (passing a single file will still work)
-    # @param [Boolean] merge
-    # @param [Boolean] pagenumbers
-    # @param [Boolean] tableofcontents
-    # @param [Boolean] remove_front_matter
-    # @param [String] output_filename
-    # @param [String] output_dir
-    # @param [String] stylesheet
-    def initialize(files, merge = false, pagenumbers = false, tableofcontents = false, remove_front_matter = false, output_filename = nil, output_dir = nil, stylesheet = nil)
+    # @param [Gimli::Config] config
+    def initialize(files, config)
       @files = files
-      @merge = merge
-      @pagenumbers = pagenumbers
-      @tableofcontents = tableofcontents
-      @remove_front_matter = remove_front_matter
-      @output_filename = output_filename
-      @output_dir = output_dir
-      @stylesheet = stylesheet
+      @merge = config.merge
+      @wkhtmltopdf_parameters = config.wkhtmltopdf_parameters
+      @remove_front_matter = config.remove_front_matter
+      @output_filename = config.output_filename
+      @output_dir = config.output_dir
+      @stylesheet = config.stylesheet
+      @stylesheets = []
+
+      @wkhtmltopdf = Wkhtmltopdf.new @wkhtmltopdf_parameters
     end
 
     # Convert the file and save it as a PDF file
@@ -63,35 +57,35 @@ module Gimli
       html
     end
 
-    # Load the pdfkit with html
-    # @param [String] html
-    # @return [PDFKit]
-    def pdf_kit(html)
-      options = {}
-      options.merge!({ :footer_right => '[page]/[toPage]' }) if @pagenumbers
-      options.merge!({ :toc => true }) if @tableofcontents
-      kit = PDFKit.new(html, options)
-
-      load_stylesheets kit
-
-      kit
-    end
-
     # Create the pdf
     # @param [String] html the html input
     # @param [String] filename the name of the output file
     def output_pdf(html, filename)
-      kit = pdf_kit(html)
-      kit.to_file(output_file(filename))
+      load_stylesheets
+      append_stylesheets html
+      @wkhtmltopdf.output_pdf html, output_file(filename)
     end
 
     # Load the stylesheets to pdfkit loads the default and the user selected if any
-    # @param [PDFKit] kit
-    def load_stylesheets(kit)
+    def load_stylesheets
       # Load standard stylesheet
       style = ::File.expand_path("../../../config/style.css", __FILE__)
-      kit.stylesheets << style
-      kit.stylesheets << stylesheet if ::File.exists?(stylesheet)
+      @stylesheets << style
+      @stylesheets << stylesheet if ::File.exists?(stylesheet)
+    end
+
+    def append_stylesheets(html)
+      @stylesheets.each do |stylesheet|
+        if html.match(/<\/head>/)
+          html = html.gsub(/(<\/head>)/, style_tag_for(stylesheet)+'\1')
+        else
+          html.insert(0, style_tag_for(stylesheet))
+        end
+      end
+    end
+
+    def style_tag_for(stylesheet)
+      "<style>#{File.read(stylesheet)}</style>"
     end
 
     # Returns the selected stylesheet. Defaults to ./gimli.css

data/lib/gimli/setup.rb

@@ -20,6 +20,10 @@ module Gimli extend OptiFlagSet
     description 'Sets the name of the output file. Only used with single file and in merge mode'
     alternate_forms 'n'
   end
+  optional_flag 'wkhtmltopdfparameters' do
+    description 'Parameters to be passed on to wkhtmltopdf. Use "" if more than one parameter. See wkhtmltopdf usage for possible parameters.'
+    alternate_forms 'w'
+  end
   optional_switch_flag 'recursive' do
     description 'Recurse current or target directory and convert all valid markup files'
     alternate_forms 'r'
@@ -28,14 +32,6 @@ module Gimli extend OptiFlagSet
     description 'Merge markup files into single pdf file'
     alternate_forms 'm'
   end
-  optional_switch_flag 'pagenumbers' do
-    description 'Print the page numbers in the lower right corner of all pages in pdf'
-    alternate_forms 'p'
-  end
-  optional_switch_flag 'tableofcontents' do
-    description 'Insert a table of contents first in the pdf'
-    alternate_forms 't'
-  end
   optional_switch_flag 'removefrontmatter' do
     description 'Remove yaml frontmatter from your files.'
     alternate_forms 'y'

data/lib/gimli/version.rb

@@ -2,7 +2,7 @@
 
 module Gimli
 
-  Version = "0.2.3"
+  Version = "0.3.0"
 
 end
 

data/lib/gimli/wkhtmltopdf.rb

@@ -0,0 +1,41 @@
+module Gimli
+
+  # The class that communicates with wkhtmltopdf
+  class Wkhtmltopdf
+
+    # Set up options for wkhtmltopdf
+    # @param [String] parameters
+    def initialize(parameters = nil)
+      @parameters = parameters
+    end
+
+    # Convert the html to pdf and write it to file
+    # @param [String] html the html input
+    # @param [String] filename the name of the output file
+    def output_pdf(html, filename)
+      args = command(filename)
+      invoke = args.join(' ')
+
+      result = IO.popen(invoke, "wb+") do |pdf|
+        pdf.puts(html)
+        pdf.close_write
+        pdf.gets(nil)
+      end
+    end
+
+    # Assemble the command to run
+    # @param [String] filename the outputed pdf's filename
+    # @return [Array] a list of strings that make out the call to wkhtmltopdf
+    def command(filename)
+      [bin, @parameters, '--quiet', '-', "\"#{filename}\""].compact
+    end
+
+    # Find the wkhtmltopdf binary
+    # @return [String] the path to the binary
+    def bin
+      @bin ||= "\"#{(`which wkhtmltopdf`).chomp}\""
+    end
+
+  end
+
+end

data/spec/gimli/converter_spec.rb

@@ -10,7 +10,7 @@ describe Gimli::Converter do
     name = 'my_file'
     mock(file).name { name }
 
-    converter = Gimli::Converter.new [file]
+    converter = Gimli::Converter.new [file], Gimli::Config.new
     mock(converter).output_dir { Dir.getwd }
 
     converter.output_file.should == File.join(Dir.getwd, "#{name}.pdf")
@@ -21,7 +21,7 @@ describe Gimli::Converter do
     name = 'my_file'
     mock(file).name { name }
 
-    converter = Gimli::Converter.new [file]
+    converter = Gimli::Converter.new [file], Gimli::Config.new
     mock(converter).output_dir { '/tmp/out' }
 
     converter.output_file(file).should == "/tmp/out/#{name}.pdf"
@@ -31,7 +31,11 @@ describe Gimli::Converter do
     file = Gimli::MarkupFile.new 'fake'
     output_filename = 'my_file'
 
-    converter = Gimli::Converter.new [file], false, false, false, false, output_filename
+    config = Gimli.configure do |c|
+      c.output_filename = output_filename
+    end
+
+    converter = Gimli::Converter.new [file], config
     mock(converter).output_dir { Dir.getwd }
 
     converter.output_file.should == File.join(Dir.getwd, "#{output_filename}.pdf")
@@ -41,7 +45,7 @@ describe Gimli::Converter do
     dir = Dir.getwd
 
     file = Gimli::MarkupFile.new 'fake'
-    converter = Gimli::Converter.new file
+    converter = Gimli::Converter.new file, Gimli::Config.new
 
     converter.output_dir.should == dir
   end
@@ -50,7 +54,12 @@ describe Gimli::Converter do
     dir = '/tmp/out'
 
     file = Gimli::MarkupFile.new 'fake'
-    converter = Gimli::Converter.new file, false, false, false, false, nil, dir
+
+    config = Gimli.configure do |c|
+      c.output_dir = dir
+    end
+
+    converter = Gimli::Converter.new file, config
 
     mock(File).directory?(dir) { true }
 
@@ -59,7 +68,7 @@ describe Gimli::Converter do
 
   it 'should use default stylesheet if none given' do
     file = Gimli::MarkupFile.new 'fake'
-    converter = Gimli::Converter.new file
+    converter = Gimli::Converter.new file, Gimli::Config.new
 
     converter.stylesheet.should == 'gimli.css'
   end
@@ -68,7 +77,11 @@ describe Gimli::Converter do
     file = Gimli::MarkupFile.new 'fake'
     stylesheet = '/home/me/gimli/my-style.css'
 
-    converter = Gimli::Converter.new file, false, false, false, false, nil, nil, stylesheet
+    config = Gimli.configure do |c|
+      c.stylesheet = stylesheet
+    end
+
+    converter = Gimli::Converter.new file, config
 
     converter.stylesheet.should == stylesheet
   end
@@ -77,7 +90,7 @@ describe Gimli::Converter do
     file = Gimli::MarkupFile.new 'fake'
     filename = 'fixtures/fake.textile'
     dir_string = ::File.dirname(::File.expand_path(filename))
-    converter = Gimli::Converter.new file
+    converter = Gimli::Converter.new file, Gimli::Config.new
 
     html = '<p>foo</p><img src="test.jpg" alt="" /><p>bar</p><img src="test2.jpg" alt="" />'
     valid_html = "<p>foo</p><img src=\"#{File.expand_path('test.jpg', dir_string)}\" alt=\"\" /><p>bar</p><img src=\"#{File.expand_path('test2.jpg', dir_string)}\" alt=\"\" />"
@@ -89,7 +102,7 @@ describe Gimli::Converter do
     file = Gimli::MarkupFile.new 'fake'
     filename = '../../fixtures/fake.textile'
     dir_string = ::File.dirname(::File.expand_path(filename))
-    converter = Gimli::Converter.new file
+    converter = Gimli::Converter.new file, Gimli::Config.new
 
     html = '<p>foo</p><img src="https://d3nwyuy0nl342s.cloudfront.net/images/modules/header/logov3-hover.png" alt="" /><p>bar</p>'
 
@@ -100,7 +113,7 @@ describe Gimli::Converter do
     file = Gimli::MarkupFile.new 'fake'
     filename = '../../fixtures/fake.textile'
     dir_string = ::File.dirname(::File.expand_path(filename))
-    converter = Gimli::Converter.new file
+    converter = Gimli::Converter.new file, Gimli::Config.new
 
     html = '<p>foo</p><img src="test.jpg" alt="" /><p>bar</p><img src="/tmp/test2.jpg" alt="" /> <img src="https://d3nwyuy0nl342s.cloudfront.net/images/modules/header/logov3-hover.png" alt="" />'
     valid_html = "<p>foo</p><img src=\"#{File.expand_path('test.jpg', dir_string)}\" alt=\"\" /><p>bar</p><img src=\"/tmp/test2.jpg\" alt=\"\" /> <img src=\"https://d3nwyuy0nl342s.cloudfront.net/images/modules/header/logov3-hover.png\" alt=\"\" />"

data/spec/gimli/wkhtmltopdf_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require './spec/spec_helper'
+
+require './lib/gimli'
+
+describe Gimli::Wkhtmltopdf do
+
+  it 'should assemble correct command' do
+    wkhtmltopdf = Gimli::Wkhtmltopdf.new
+    mock(wkhtmltopdf).bin { '"wkhtmltopdf"' }
+    args = wkhtmltopdf.command('test.pdf')
+    args.size.should == 4
+    args.should include '"wkhtmltopdf"'
+    args.should include '--quiet'
+    args.should include '-'
+    args.should include  '"test.pdf"'
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
 # encoding: utf-8
 
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end
+
 RSpec.configure do |config|
   config.mock_with :rr
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gimli
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-07 00:00:00.000000000 Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markup
@@ -155,22 +155,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.9.1
-- !ruby/object:Gem::Dependency
-  name: pdfkit
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.5.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: optiflag
   requirement: !ruby/object:Gem::Requirement
@@ -265,8 +249,10 @@ files:
 - lib/gimli/path.rb
 - lib/gimli/markupfile.rb
 - lib/gimli/converter.rb
+- lib/gimli/wkhtmltopdf.rb
 - lib/gimli/setup.rb
 - lib/gimli/albino.rb
+- lib/gimli/config.rb
 - lib/gimli/version.rb
 - lib/gimli/markup.rb
 - lib/gimli.rb
@@ -274,6 +260,7 @@ files:
 - spec/gimli/converter_spec.rb
 - spec/gimli/markup_spec.rb
 - spec/gimli/file_spec.rb
+- spec/gimli/wkhtmltopdf_spec.rb
 - spec/fixtures/code_with_utf8.textile
 - spec/fixtures/recursion/level2/level2.markdown
 - spec/fixtures/recursion/level1.textile
@@ -299,7 +286,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3032383899323034374
+      hash: 4505981425751423079
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -308,7 +295,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3032383899323034374
+      hash: 4505981425751423079
 requirements: []
 rubyforge_project: gimli
 rubygems_version: 1.8.24