slim2pdf 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Slim2pdf [![Code Climate](https://codeclimate.com/github/macuk/slim2pdf.png)](https://codeclimate.com/github/macuk/slim2pdf)
 
-Slim2pdf renders slim template with data hash and save the results as pdf file.
+Slim2pdf renders [slim template](http://slim-lang.com/) with data hash and saves the results as pdf file.
 
 ## Installation
 
@@ -23,55 +23,78 @@ Or install it yourself as:
 ### Create writer object
 
     writer = Slim2pdf::Writer.new
-    writer.template = 'path/to/template.slim'
-    writer.data = {key1: value1, key2: value2}
+    writer.template = 'template.slim'
+    writer.data = {name: 'John', surname: 'Doe'}
 
 ### Set parameters in initializer
 
-    writer = Slim2pdf::Writer.new('tpl.slim', {key1: 'a', key2: 'b'})
+    writer = Slim2pdf::Writer.new('template.slim', {name: 'John', surname: 'Doe'})
 
 ### Possible actions
 
     writer.render_to_html # return rendered html as string
 
-    writer.save_to_html(html_path) # saves rendered html to file
+    writer.save_to_html('output.html') # saves rendered html to file
 
-    writer.save_to_pdf(pdf_path) # saves rendered html as pdf file
+    writer.save_to_pdf('output.pdf') # saves rendered html as pdf file
+
+### Changing default wkhtmltopdf command
+
+    writer = Slim2pdf::Writer.new
+    writer.wkhtmltopdf_command = '/your/path/to/wkhtmltopdf --your --params'
+
+Input (html) and output (pdf) files will be added automatically.
 
 ## Examples
 
-### Change slim template to pdf file (doc/examples/simple/).
+### Save simple slim template without data to pdf file
 
     require 'slim2pdf'
 
-    writer = Slim2pdf::Writer.new('doc/examples/simple/template.slim')
-    writer.save_to_pdf('doc/examples/simple/output.pdf')
+    writer = Slim2pdf::Writer.new('simple.slim')
+    writer.save_to_pdf('simple.pdf')
 
-### Generate agreement (doc/examples/agreement/).
+See: [doc/examples/simple](https://github.com/macuk/slim2pdf/tree/master/doc/examples/simple)
+
+### Generate agreement with footer
 
     require 'slim2pdf'
 
-    w = Slim2pdf::Writer.new
-    w.template = 'doc/examples/agreement/template.slim'
-    w.data = {date: '2014-01-14', part1: 'Google', part2: 'Microsoft'}
-    w.footer_text = 'Agreement footer'
-    w.save_to_pdf('doc/examples/agreement/output.pdf')
+    writer = Slim2pdf::Writer.new('agreement.slim')
+    writer.data = {date: '2014-01-14', part1: 'Google', part2: 'Microsoft'}
+    writer.footer_text = 'Agreement footer'
+    writer.save_to_pdf('agreement.pdf')
+
+See: [doc/examples/agreement](https://github.com/macuk/slim2pdf/tree/master/doc/examples/agreement)
 
-### Generate bulk invoices (doc/examples/invoices/).
+### Generate bulk invoices
 
     require 'slim2pdf'
 
-    w = Slim2pdf::Writer.new('doc/examples/invoices/template.slim')
+    writer = Slim2pdf::Writer.new('invoice.slim')
     buyers = ['Buyer A', 'Buyer B', 'Buyer C', 'Buyer D']
     buyers.each_with_index do |buyer, index|
       number = index + 1
-      w.data = {
+      writer.data = {
         seller: 'Seller', buyer: buyer, number: "#{number}/2014",
         item_name: 'Service', price: '$100', date: '2014-01-14'
       }
-      w.save_to_pdf("doc/examples/invoices/output-#{number}.pdf")
+      writer.save_to_pdf("invoice-#{number}.pdf")
     end
 
+See: [doc/examples/invoices](https://github.com/macuk/slim2pdf/tree/master/doc/examples/invoices)
+
+## Debuging
+
+### Setting logger
+
+    require 'logger'
+
+    writer = Slim2pdf::Writer.new
+    writer.logger = Logger.new(STDERR)
+
+If you use Slim2pdf with Rails, the Rails.logger will be set automatically.
+
 ## Contributing
 
 1. Fork it

data/doc/examples/agreement/script.rb

@@ -1,7 +1,7 @@
 require 'slim2pdf'
 
-w = Slim2pdf::Writer.new
-w.template = 'doc/examples/agreement/template.slim'
-w.data = {date: '2014-01-14', part1: 'Google', part2: 'Microsoft'}
-w.footer_text = 'Agreement footer'
-w.save_to_pdf('doc/examples/agreement/output.pdf')
+writer = Slim2pdf::Writer.new
+writer.template = 'doc/examples/agreement/template.slim'
+writer.data = {date: '2014-01-14', part1: 'Google', part2: 'Microsoft'}
+writer.footer_text = 'Agreement footer'
+writer.save_to_pdf('doc/examples/agreement/output.pdf')

data/doc/examples/invoices/script.rb

@@ -1,12 +1,12 @@
 require 'slim2pdf'
 
-w = Slim2pdf::Writer.new('doc/examples/invoices/template.slim')
+writer = Slim2pdf::Writer.new('doc/examples/invoices/template.slim')
 buyers = ['Buyer A', 'Buyer B', 'Buyer C', 'Buyer D']
 buyers.each_with_index do |buyer, index|
   number = index + 1
-  w.data = {
+  writer.data = {
     seller: 'Seller', buyer: buyer, number: "#{number}/2014",
     item_name: 'Service', price: '$100', date: '2014-01-14'
   }
-  w.save_to_pdf("doc/examples/invoices/output-#{number}.pdf")
+  writer.save_to_pdf("doc/examples/invoices/output-#{number}.pdf")
 end

data/lib/slim2pdf/version.rb

@@ -1,3 +1,3 @@
 module Slim2pdf
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/slim2pdf/writer.rb

@@ -1,7 +1,9 @@
 module Slim2pdf
   class Writer
     attr_accessor :template, :data
+    attr_accessor :wkhtmltopdf_command
     attr_accessor :footer_text, :footer_font, :footer_font_size
+    attr_accessor :logger
 
     def initialize(template=nil, data={})
       @template = template
@@ -15,17 +17,26 @@ module Slim2pdf
     def save_to_html(path)
       create_dir(path)
       File.write(path, render_to_html)
+      logger.info "[Slim2pdf] HTML file saved: #{path}" if logger
     end
 
     def save_to_pdf(path)
       create_dir(path)
       html = create_tmp_html
-      `#{wkhtmltopdf_command(html.path, path)}`
+      full_command = "#{wkhtmltopdf_command} #{html.path} #{path}"
+      logger.debug "[Slim2pdf] Run command: #{full_command}" if logger
+      `#{full_command}`
       html.unlink
+      logger.info "[Slim2pdf] PDF file saved: #{path}" if logger
     end
 
-    def wkhtmltopdf_command(html_path, pdf_path)
-      "wkhtmltopdf #{footer_params} -q #{html_path} #{pdf_path}"
+    # wkhtmltopdf command without html and pdf file params
+    def wkhtmltopdf_command
+      @wkhtmltopdf_command || "wkhtmltopdf #{footer_params} -q"
+    end
+
+    def logger
+      @logger ||= defined?(Rails) ? Rails.logger : nil
     end
 
     private

data/test/writer_test.rb

@@ -1,4 +1,6 @@
 require 'test_helper'
+require 'logger'
+require 'stringio'
 
 module Slim2pdf
   class WriterTest < MiniTest::Unit::TestCase
@@ -59,17 +61,45 @@ module Slim2pdf
       assert_equal false, File.exists?(path)
     end
 
+    def test_wkhtmltopdf_command
+      assert_match /wkhtmltopdf/, @writer.wkhtmltopdf_command
+      assert_match /-q/, @writer.wkhtmltopdf_command
+      @writer.wkhtmltopdf_command = 'test -a -b -c'
+      assert_equal 'test -a -b -c', @writer.wkhtmltopdf_command
+    end
+
     def test_footer_params
       @writer.footer_text = 'Footer'
-      command = @writer.wkhtmltopdf_command('tmp.html', 'out.pdf')
+      command = @writer.wkhtmltopdf_command
       assert_match /Footer/, command
       assert_match /10/, command
       assert_match /verdana/, command
       @writer.footer_font = 'arial'
       @writer.footer_font_size = 14
-      command = @writer.wkhtmltopdf_command('tmp.html', 'out.pdf')
+      command = @writer.wkhtmltopdf_command
       assert_match /14/, command
       assert_match /arial/, command
     end
+
+    def test_logger_accessor
+      assert_nil @writer.logger
+      stderr = Logger.new(STDERR)
+      @writer.logger = stderr
+      assert_equal stderr, @writer.logger
+    end
+
+    def test_logging
+      sio = StringIO.new
+      @writer.logger = Logger.new(sio)
+      @writer.logger.level = Logger::DEBUG
+      @writer.save_to_html('/tmp/out.html')
+      File.unlink('/tmp/out.html')
+      @writer.save_to_pdf('/tmp/out.pdf')
+      File.unlink('/tmp/out.pdf')
+      log = sio.string
+      assert_match %r(/tmp/out.html), log
+      assert_match %r(/tmp/out.pdf), log
+      assert_match /Run command: wkhtmltopdf/, log
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slim2pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 613998296001512521
+      hash: -782601368619973164
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 613998296001512521
+      hash: -782601368619973164
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25