slim2pdf 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slim2pdf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Piotr Macuk
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'slim2pdf'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slim2pdf
+
+## Usage
+
+    require 'slim2pdf'
+
+### Create writer object
+
+    writer = Slim2pdf::Writer.new
+    writer.template = 'path/to/template.slim'
+    writer.data = {key1: value1, key2: value2}
+
+### Set parameters in initializer
+
+    writer = Slim2pdf::Writer.new('tpl.slim', {key1: 'a', key2: 'b'})
+
+### 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_pdf(pdf_path) # saves rendered html as pdf file
+
+## Examples
+
+### Change slim template to pdf file (doc/examples/simple/).
+
+    require 'slim2pdf'
+
+    writer = Slim2pdf::Writer.new('doc/examples/simple/template.slim')
+    writer.save_to_pdf('doc/examples/simple/output.pdf')
+
+### Generate agreement (doc/examples/agreement/).
+
+    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')
+
+### Generate bulk invoices (doc/examples/invoices/).
+
+    require 'slim2pdf'
+
+    w = 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 = {
+        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")
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test

data/doc/examples/agreement/script.rb

@@ -0,0 +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')

data/doc/examples/agreement/template.slim

@@ -0,0 +1,15 @@
+doctype html
+html
+  head
+    title Example Agreement
+  body
+    p = date
+    h1 Example Agreement
+    #content
+      h2
+        | Agreement between #{part1} and #{part2}
+      h2 Agreement text
+      ol
+        li Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Typi non habent claritatem insitam; est usus legentis in iis qui facit eorum claritatem. Investigationes demonstraverunt lectores legere me lius quod ii legunt saepius. Claritas est etiam processus dynamicus, qui sequitur mutationem consuetudium lectorum. Mirum est notare quam littera gothica, quam nunc putamus parum claram, anteposuerit litterarum formas humanitatis per seacula quarta decima et quinta decima. Eodem modo typi, qui nunc nobis videntur parum clari, fiant sollemnes in futurum.
+        li Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Typi non habent claritatem insitam; est usus legentis in iis qui facit eorum claritatem. Investigationes demonstraverunt lectores legere me lius quod ii legunt saepius. Claritas est etiam processus dynamicus, qui sequitur mutationem consuetudium lectorum. Mirum est notare quam littera gothica, quam nunc putamus parum claram, anteposuerit litterarum formas humanitatis per seacula quarta decima et quinta decima. Eodem modo typi, qui nunc nobis videntur parum clari, fiant sollemnes in futurum.
+        li Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Typi non habent claritatem insitam; est usus legentis in iis qui facit eorum claritatem. Investigationes demonstraverunt lectores legere me lius quod ii legunt saepius. Claritas est etiam processus dynamicus, qui sequitur mutationem consuetudium lectorum. Mirum est notare quam littera gothica, quam nunc putamus parum claram, anteposuerit litterarum formas humanitatis per seacula quarta decima et quinta decima. Eodem modo typi, qui nunc nobis videntur parum clari, fiant sollemnes in futurum.

data/doc/examples/invoices/script.rb

@@ -0,0 +1,12 @@
+require 'slim2pdf'
+
+w = 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 = {
+    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")
+end

data/doc/examples/invoices/template.slim

@@ -0,0 +1,16 @@
+doctype html
+html
+  head
+    title Example Invoice
+  body
+    p
+      | Created at #{date}
+    h1
+      | Invoice nr #{number}
+    #content
+      h2
+        | Seller: #{seller}
+      h2
+        | Buyer: #{buyer}
+      p
+        | Item name: #{item_name}, price: #{price}

data/doc/examples/simple/script.rb

@@ -0,0 +1,4 @@
+require 'slim2pdf'
+
+writer = Slim2pdf::Writer.new('doc/examples/simple/template.slim')
+writer.save_to_pdf('doc/examples/simple/output.pdf')

data/doc/examples/simple/template.slim

@@ -0,0 +1,7 @@
+doctype html
+html
+  head
+    title Example Title
+  body
+    h1 Example Header
+    p Example Body

data/lib/slim2pdf.rb

@@ -0,0 +1,7 @@
+require "slim2pdf/version"
+require "slim"
+require "ostruct"
+require "fileutils"
+require "pathname"
+require "tempfile"
+require "slim2pdf/writer"

data/lib/slim2pdf/version.rb

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

data/lib/slim2pdf/writer.rb

@@ -0,0 +1,58 @@
+module Slim2pdf
+  class Writer
+    attr_accessor :template, :data
+    attr_accessor :footer_text, :footer_font, :footer_font_size
+
+    def initialize(template=nil, data={})
+      @template = template
+      @data = data
+    end
+
+    def render_to_html
+      Slim::Template.new(template).render(scope)
+    end
+
+    def save_to_html(path)
+      create_dir(path)
+      File.write(path, render_to_html)
+    end
+
+    def save_to_pdf(path)
+      create_dir(path)
+      html = create_tmp_html
+      `#{wkhtmltopdf_command(html.path, path)}`
+      html.unlink
+    end
+
+    def wkhtmltopdf_command(html_path, pdf_path)
+      "wkhtmltopdf #{footer_params} -q #{html_path} #{pdf_path}"
+    end
+
+    private
+      # Change hash data to scope object
+      def scope
+        OpenStruct.new(data)
+      end
+
+      # Create dir if not exists
+      def create_dir(path)
+        FileUtils.mkdir_p(Pathname.new(path).dirname)
+      end
+
+      def create_tmp_html
+        tmp = Tempfile.new ['slim2pdf', '.html']
+        begin
+          tmp.write render_to_html
+        ensure
+          tmp.close
+        end
+        tmp
+      end
+
+      def footer_params
+        return unless footer_text
+        "--footer-line --footer-font-name '#{footer_font || 'verdana'}' " +
+        "--footer-font-size '#{footer_font_size || 10}' --footer-left '#{footer_text}'"
+      end
+  end
+end

data/slim2pdf.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slim2pdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slim2pdf"
+  spec.version       = Slim2pdf::VERSION
+  spec.authors       = ["Piotr Macuk"]
+  spec.email         = ["piotr@macuk.pl"]
+  spec.description   = %q{Slim2pdf renders slim template with data hash and save the results as pdf file.}
+  spec.summary       = %q{Slim template to pdf file conversion tool.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_dependency 'slim', '~> 2.0.2'
+  spec.add_dependency "wkhtmltopdf-binary", "~> 0.9.9.1"
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test/'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'slim2pdf'
+require 'minitest/autorun'

data/test/tpl/test.slim

@@ -0,0 +1,8 @@
+doctype html
+html
+  head
+    title = title
+  body
+    h1 = title
+    #content
+      p = content

data/test/writer_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+module Slim2pdf
+  class WriterTest < MiniTest::Unit::TestCase
+    def setup
+      @data = {title: 'Slim2pdf', content: 'Slim to PDF conversion gem'}
+      @template = File.expand_path('../tpl/test.slim', __FILE__)
+      @writer = Writer.new(@template, @data)
+    end
+
+    def test_init
+      Writer.new
+    end
+
+    def test_initialize
+      assert_equal @template, @writer.template
+      assert_equal @data, @writer.data
+    end
+
+    def test_accessors
+      writer = Writer.new
+      writer.template = @template
+      writer.data = @data
+      assert_equal @template, writer.template
+      assert_equal @data, writer.data
+    end
+
+    def test_render_to_html
+      html = @writer.render_to_html
+      assert_match %r(<title>Slim2pdf</title>), html
+      assert_match %r(<p>Slim to PDF conversion gem</p>), html
+    end
+
+    def test_save_to_html
+      path = '/tmp/test.html'
+      @writer.save_to_html(path)
+      assert File.exists?(path)
+      html = File.read(path)
+      assert_match %r(<title>Slim2pdf</title>), html
+      assert_match %r(<p>Slim to PDF conversion gem</p>), html
+      File.unlink(path)
+      assert_equal false, File.exists?(path)
+    end
+
+    def test_save_to_html_with_dir_creation
+      path = '/tmp/a/b/c/test.html'
+      @writer.save_to_html(path)
+      html = File.read(path)
+      assert_match %r(<html>), html
+      FileUtils.rm_rf('/tmp/a')
+      assert_equal false, File.exists?('/tmp/a')
+    end
+
+    def test_save_to_pdf
+      path = '/tmp/test.pdf'
+      @writer.save_to_pdf(path)
+      assert File.exists?(path)
+      File.unlink(path)
+      assert_equal false, File.exists?(path)
+    end
+
+    def test_footer_params
+      @writer.footer_text = 'Footer'
+      command = @writer.wkhtmltopdf_command('tmp.html', 'out.pdf')
+      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')
+      assert_match /14/, command
+      assert_match /arial/, command
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: slim2pdf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Piotr Macuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: wkhtmltopdf-binary
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9.1
+description: Slim2pdf renders slim template with data hash and save the results as
+  pdf file.
+email:
+- piotr@macuk.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/examples/agreement/output.pdf
+- doc/examples/agreement/script.rb
+- doc/examples/agreement/template.slim
+- doc/examples/invoices/output-1.pdf
+- doc/examples/invoices/output-2.pdf
+- doc/examples/invoices/output-3.pdf
+- doc/examples/invoices/output-4.pdf
+- doc/examples/invoices/script.rb
+- doc/examples/invoices/template.slim
+- doc/examples/simple/output.pdf
+- doc/examples/simple/script.rb
+- doc/examples/simple/template.slim
+- lib/slim2pdf.rb
+- lib/slim2pdf/version.rb
+- lib/slim2pdf/writer.rb
+- slim2pdf.gemspec
+- test/test_helper.rb
+- test/tpl/test.slim
+- test/writer_test.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 613998296001512521
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 613998296001512521
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Slim template to pdf file conversion tool.
+test_files:
+- test/test_helper.rb
+- test/tpl/test.slim
+- test/writer_test.rb