zena 1.0.0.beta3 → 1.0.0.rc1

data/bricks/pdf/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bricks/pdf/lib/bricks/pdf.rb

@@ -0,0 +1,110 @@
+=begin rdoc
+  PDF is module to render file or IO streams (strings obviously) into pdf.
+
+  Examples:
+
+  Bricks::PDF.engine = 'Xhtml2pdf'
+
+  Bricks::PDF.render_file "myfile.html"                            => STDOUT       (strings)
+  Bricks::PDF.render_file "myfile.html", "out.pdf"                 => out.pdf      (file)
+
+  Bricks::PDF.render_string "This is text to render."              => STDOUT       (strings)
+  Bricks::PDF.render_string "This is text to render.", "out.pdf"   => out.pdf      (file)
+=end
+
+module Bricks
+  module PDF
+    extend self
+    # Wrapper around pdf engines
+    module Engine
+    end # Engine
+
+    class Error < Exception
+    end
+
+    # Raised when an argument is invalid
+    class ArgumentError < Error
+    end
+
+    # Raised when the pdf engine could not be loaded
+    class InvalidEngine < Error
+    end
+
+    def engine=(engine_name)
+      engine_module = Zena.resolve_const("Bricks::PDF::Engine::#{engine_name.to_s.capitalize}")
+      extend engine_module
+    rescue NameError
+      raise PDF::InvalidEngine, "Could not load pdf engine '#{engine_name}'."
+    end
+
+    def render(options)
+      res = nil
+
+      # TODO: redirect error messages...
+      IO.popen(command(options), 'w+') do |io|
+
+        if data = options[:data]
+          io.puts(data)
+        end
+        io.close_write
+
+        unless res = options[:output]
+          res = io.gets
+        end
+      end
+
+      res
+    end
+
+    module ControllerMethods
+      def render_to_pdf(opts)
+        # Get zafu template (compile if needed)
+        template_path = template_url(opts)
+
+        # Produce html
+        data = render_to_string(:file => template_path, :layout=>false)
+
+        target_file = Tempfile.new('trg').path + '.pdf'
+
+        data = Bricks::PDF.render(get_render_auth_params.merge(
+          :data   => data,
+          :output => target_file
+        ))
+
+        if File.exist?(target_file)
+          data = nil
+
+          File.open(target_file, 'rb') do |f|
+            data = f.read
+          end
+
+          FileUtils.rm(target_file)
+          {
+            :type        => 'application/pdf',
+            :disposition => params['disposition'] || 'inline',
+            # Compile html to pdf
+            :data        => data
+          }
+        else
+          # did not work
+          query_string = request.query_string
+          if query_string == ''
+            debug_url = "#{request.path}?debug"
+          else
+            debug_url = "#{request.path}?#{query_string}&debug"
+          end
+
+          {
+            :type        => 'text/html',
+            # Compile html to pdf
+            :disposition => 'inline',
+            :data        => "Could not render pdf file... <a href='#{debug_url}'>debug</a>"
+          }
+        end
+      end
+    end # ControllerMethods
+
+    module ZafuMethods
+    end # ZafuMethods
+  end # PDF
+end # Bricks

data/bricks/pdf/lib/bricks/pdf/engine/prince.rb

@@ -0,0 +1,38 @@
+module Bricks
+  module PDF
+    module Engine
+      module Prince
+        def command(opts)
+          cmd = ['prince']
+          {
+            :http_user     => '--http-user=',
+            :http_password => '--http-password=',
+            :baseurl       => '--baseurl='
+          }.each do |key, cmd_key|
+            cmd << "#{cmd_key}#{opts[key]}"
+          end
+
+          # FIXME: find a way to redirect errors on screen instead of main log.
+          cmd << "--log=#{Zena.log_path}"
+
+          if file = opts[:input]
+            cmd << file
+          else
+            cmd << "-"
+          end
+
+          if file = opts[:output]
+            cmd << "-o #{file}"
+          else
+            cmd << "-o -"
+          end
+
+          cmd.join(' ')
+        end
+      end # Prince
+    end # Engine
+  end # PDF
+end # Bricks
+
+
+

data/bricks/pdf/lib/bricks/pdf/engine/xhtml2pdf.rb

@@ -0,0 +1,9 @@
+module Bricks
+  module PDF
+    module Engine
+      module Xhtml2pdf
+        # Not supported until they have http auth and base url settings.
+      end # Xhtml2pdf
+    end # Engine
+  end # PDF
+end # Bricks

data/bricks/pdf/lib/bricks/pdf/install.rb

@@ -0,0 +1,121 @@
+require 'open-uri'
+require 'digest/md5'
+require 'digest/sha1'
+require 'fileutils'
+require 'tempfile'
+
+# begin
+#   cmd = 'which python'
+#   unless system cmd
+#     puts 'FATAL: python 2.6.1+ must be installed'
+#     exit
+#   end
+# end
+
+module Bricks
+  module PDF
+    class Install
+
+      # Utility to install library necessary to PDF on unix like machine.
+      #
+      # To install xhtml2pdf and his dependencies, see PDF::xhtml2pdf in zena/tasks.rb
+
+      include FileUtils::Verbose
+
+      attr_reader :url, :file, :md5, :sha1, :force
+
+      def self.from_url url, opts={}
+        tmpf = Tempfile.new('PDF').path
+        install_dir = "#{tmpf}_d"
+        FileUtils.mkpath(install_dir)
+        in_dir(install_dir) do
+          puts "INFO: start installation of #{url}"
+          self.new url, opts do |install|
+            install.download
+            install.checksum if install.do_checksum?
+            install.deflate
+            install.setup
+          end
+          puts "INFO: end installation of #{url}"
+        end
+      ensure
+        FileUtils.rm(tmpf)
+        FileUtils.rmtree(install_dir)
+      end
+
+      def self.in_dir(path)
+        old_dir = ENV['PWD']
+        Dir.chdir(path)
+        yield
+      ensure
+        Dir.chdir(old_dir)
+      end
+
+
+      def initialize url, opts={}
+        @url    = url
+        @file   = url.split('/').last
+        @md5    = opts.delete :md5
+        @sha1   = opts.delete :sha1
+        @force  = opts.delete :forc
+        yield self if block_given?
+      end
+
+      def download
+        open file, 'w' do |io|
+          io.write open(url).read
+        end
+        puts "INFO: #{file} downloaded" if downloaded?
+      end
+
+      def checksum
+        integrity = if md5
+          @digest = Digest::MD5.hexdigest(File.read file)
+          @digest == md5
+        elsif sha1
+          @digest = Digest::SHA1.hexdigest(File.read file)
+          @digest == sha1
+        end
+
+        unless integrity || force
+          puts "WARN: Invalid checksum #{@digest} for #{file}"
+          exit
+        else
+          true
+        end
+      end
+
+      def deflate
+        cmd = "nice -n 15 tar xvfz #{file}"
+        success = system cmd
+        puts "INFO: #{file} deflated" if success && $?.exited?
+      end
+
+      def setup
+        cd "./#{folder}" do
+          cmd = "sudo nice -n 15 python setup.py install"
+          success = system cmd
+        end
+      end
+
+      def folder
+         @file.gsub('.tar','').gsub('.gz','').gsub('.zip','')
+      end
+
+      def downloaded?
+        true if File.stat(file).size?
+      end
+
+      def do_checksum?
+        md5 || sha1
+      end
+
+    end # Install
+  end # PDF
+end # Bricks
+
+
+
+
+
+

data/bricks/pdf/test/engines/test_prince.rb

@@ -0,0 +1,15 @@
+require 'helper'
+require 'bricks/pdf/engine/prince'
+
+class TestPrince < Test::Unit::TestCase
+  context 'With a Prince based PDF engine' do
+    subject do
+      Module.new do
+        extend Bricks::PDF
+        extend Bricks::PDF::Engine::Prince
+      end
+    end
+
+    should_behave_as_pdf_engine
+  end # With a Prince based PDF engine
+end

data/bricks/pdf/test/engines/test_xhtml2pdf.rb

@@ -0,0 +1,15 @@
+require 'helper'
+require 'bricks/pdf/engine/xhtml2pdf'
+
+class TestXhtml2pdf < Test::Unit::TestCase
+  context 'With a Prince based PDF engine' do
+    subject do
+      Module.new do
+        extend Bricks::PDF
+        extend Bricks::PDF::Engine::Xhtml2pdf
+      end
+    end
+
+    should_behave_as_pdf_engine
+  end # With a Xhtml2pdf based PDF engine
+end

data/bricks/{data2pdf → pdf}/test/helper.rb

@@ -4,11 +4,10 @@ require 'shoulda'
 require 'mocha'
 require 'active_support'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'shoulda_macros'))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'data2pdf'
-require 'shoulda_data2pdf'
+#$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+#$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bricks/pdf'
+require 'shoulda_macros/shoulda_pdf'
 
 class Test::Unit::TestCase
 

data/bricks/pdf/test/shoulda_macros/shoulda_pdf.rb

@@ -0,0 +1,72 @@
+class Test::Unit::TestCase
+
+  def setup
+   @dir = File.dirname(__FILE__)
+  end
+
+  def contact_html
+   File.join(@dir, '..', 'fixtures', 'contact.html')
+  end
+
+  def contact_pdf
+    File.join(@dir, '..', 'fixtures', 'contact.pdf')
+  end
+
+
+  def self.should_behave_as_pdf_engine
+
+    context 'Rendering from file' do
+      setup do
+        @dir = File.dirname(__FILE__)
+      end
+
+      should 'create a pdf file if the destination is a file' do
+        assert_exist contact_pdf do
+          subject.render(:input => contact_html, :output => contact_pdf)
+        end
+      end
+
+      should 'fill STDOUT if no destination is specified' do
+        assert_match %r{^%PDF}, subject.render(:input => contact_html)
+      end
+    end
+
+
+    context 'Rendering from STDIN' do
+      should 'create pdf file if destination is a file' do
+        assert_exist contact_pdf do
+          subject.render(:data => '<html>Hello World</html>', :output => contact_pdf)
+        end
+      end
+
+      should 'fill STDOUT if no destination is specified' do
+        assert_match %r{^%PDF}, subject.render(:data => '<html>Hello World</html>')
+      end
+    end
+
+    context 'Rendering with http auth' do
+      setup do
+        @login    = 'ABCDLOGINABCD'
+        @password = '7787PASSWORD8'
+      end
+
+      should 'include http user in command' do
+        assert_match %r{#{@login}}, subject.command(:http_user => @login, :http_password => @password)
+      end
+
+      should 'include http password in command' do
+        assert_match %r{#{@password}}, subject.command(:http_user => @login, :http_password => @password)
+      end
+    end
+
+    context 'Rendering with baseurl' do
+      setup do
+        @baseurl  = 'http://localhost:7999'
+      end
+
+      should 'include baseurl in command' do
+        assert_match %r{#{@baseurl}}, subject.command(:baseurl => @baseurl)
+      end
+    end
+  end # should_behave_as_pdf_engine
+end # Test::Unit::TestCase

data/bricks/pdf/zena/init.rb

@@ -0,0 +1,5 @@
+require 'bricks/pdf'
+
+Bricks::PDF.engine = Bricks::CONFIG['pdf']['engine']
+
+Zena::Use.module Bricks::PDF

data/bricks/pdf/zena/tasks.rb

@@ -0,0 +1,17 @@
+namespace :pdf do
+  desc "Install binary for xhtml2pdf library"
+  task :xhtml2pdf => :environment do
+    install = Bricks::PDF::Install
+    install.from_url "http://pypi.python.org/packages/source/p/pisa/pisa-3.0.33.tar.gz", :md5 => 'e2040b12211303d065bc4ae2470d2700'
+
+    install.from_url "http://www.reportlab.com/ftp/reportlab-2.5.tar.gz"
+
+    install.from_url 'http://html5lib.googlecode.com/files/html5lib-0.11.1.zip', :sha1=>'157506319e40f5d973c128e5e2b826cd1bee471e'
+
+    install.from_url 'http://effbot.org/downloads/Imaging-1.1.7.tar.gz'
+
+    install.from_url 'http://pybrary.net/pyPdf/pyPdf-1.12.tar.gz'
+
+    puts "\n==========================================\nBricks::PDF dependencies installation done"
+  end
+end