documentalist 0.1.1 → 0.1.2

data/Manifest

@@ -32,6 +32,8 @@ lib/backends/open_office/bridges/jodconverter-2.2.2/src/jodconverter-cli-2.2.2-s
 lib/backends/open_office/bridges/pyodconverter.py
 lib/backends/open_office/server.rb
 lib/backends/pdf_tools.rb
+lib/backends/wkhtmltopdf.rb
+lib/dependencies.rb
 lib/documentalist.rb
 lib/tasks/tasks.rb
 rails/config/documentalist.yml.tpl
@@ -39,10 +41,12 @@ rails/init.rb
 rails/initialize_configuration.rb
 test/documentalist_test.rb
 test/fixtures/fixture_001.odt
+test/fixtures/fixture_002.html
 test/net_pbm_test.rb
 test/odf_merge_test.rb
 test/open_office_test.rb
 test/pdf_tools_test.rb
 test/rails_integration_test.rb
 test/test_helper.rb
+test/wkhtmltopdf_test.rb
 Manifest

data/README.rdoc

@@ -1,3 +1,15 @@
 = Documentalist
+Rails gem for easily managing documents, converting them from a format to another,
+and merging data into ODF templates.
 
-Rails gem for talking to OpenOffice and merging data into OpenDocument templates using an ERB-like syntax.
+= Checking for external dependencies
+Documentalist assembles various moving parts that are necessary to perform the actual
+conversions, you can run run the documentalist:backends:checks task to see if these
+dependencies are met on your system, if it isn't the case it will give you some tips
+on how to fix it.
+
+= Examples
+  Documentalist.convert('/home/somefile.doc', :to => '/home/someotherfile.pdf')
+
+= Installation
+Require the gem in your Rails or Ruby application and you should be good to go !

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake'
 require 'echoe' rescue nil
 
 if Object.const_defined? :Echoe
-  Echoe.new('documentalist', '0.1.1') do |p|
+  Echoe.new('documentalist', '0.1.2') do |p|
     p.description     = "The smooth document management experience, usable as a Rails gem plugin or standalone in any ruby application"
     p.url             = "http://github.com/davout/documentalist"
     p.author          = "David FRANCOIS"
@@ -14,19 +14,15 @@ if Object.const_defined? :Echoe
     p.test_pattern    = "test/**/*.rb"
     p.development_dependencies = ['flexmock >=0.8.6']
     p.runtime_dependencies = ['zip >=2.0.2', 'SystemTimer >=1.2']
+  end
+end
 
-    # TODO : Enforce some dependencies and don't make backend available if
-    # the dependency is not met
-    #
-    # wkhtmltopdf
-    # iconv
-    # pgrep
-    # ps
-    # pkill
-    # grep
-    # file
-    # which
-    # jod converter
-    # open office 3
+namespace :documentalist do
+  namespace :backends do
+    desc "Checks that the required dependencies are met for the different backends"
+    task :checks do
+      require File.join(File.dirname(__FILE__), "init")
+      Documentalist.check_dependencies
+    end
   end
 end

data/config/default.yml

@@ -1,5 +1,5 @@
 # Default configuration in case none is provided
-log_path: ~/documentalist.log
+log_level: debug
 
 python:
   path: /usr/bin/python
@@ -12,6 +12,6 @@ open_office:
   bridge: JOD
   max_cpu: 80
   max_startup_time: 3
-  wakeup_time: 3
+  wakeup_time: 2
   max_conversion_attempts: 3
   max_conversion_time: 5

data/documentalist.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{documentalist}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["David FRANCOIS"]
-  s.date = %q{2010-06-30}
+  s.date = %q{2010-07-04}
   s.description = %q{The smooth document management experience, usable as a Rails gem plugin or standalone in any ruby application}
   s.email = %q{david.francois@webflows.fr}
-  s.extra_rdoc_files = ["README.rdoc", "lib/backends/net_pbm.rb", "lib/backends/odf_merge.rb", "lib/backends/open_office.rb", "lib/backends/open_office/bridges/jodconverter-2.2.2/ChangeLog.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/LICENSE.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/README.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/jodconverter-2.2.2-javadoc.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-commons-io.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-openoffice.org.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-slf4j.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-xstream.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/document-formats.xml", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/DEPENDENCIES.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/commons-cli-1.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/commons-io-1.4.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jodconverter-2.2.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jodconverter-cli-2.2.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/juh-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jurt-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/ridl-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/slf4j-api-1.5.6.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/slf4j-jdk14-1.5.6.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/unoil-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/xstream-1.3.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/src/jodconverter-2.2.2-sources.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/src/jodconverter-cli-2.2.2-sources.jar", "lib/backends/open_office/bridges/pyodconverter.py", "lib/backends/open_office/server.rb", "lib/backends/pdf_tools.rb", "lib/documentalist.rb", "lib/tasks/tasks.rb"]
-  s.files = ["README.rdoc", "Rakefile", "config/default.yml", "documentalist.gemspec", "init.rb", "lib/backends/net_pbm.rb", "lib/backends/odf_merge.rb", "lib/backends/open_office.rb", "lib/backends/open_office/bridges/jodconverter-2.2.2/ChangeLog.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/LICENSE.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/README.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/jodconverter-2.2.2-javadoc.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-commons-io.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-openoffice.org.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-slf4j.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-xstream.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/document-formats.xml", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/DEPENDENCIES.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/commons-cli-1.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/commons-io-1.4.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jodconverter-2.2.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jodconverter-cli-2.2.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/juh-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jurt-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/ridl-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/slf4j-api-1.5.6.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/slf4j-jdk14-1.5.6.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/unoil-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/xstream-1.3.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/src/jodconverter-2.2.2-sources.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/src/jodconverter-cli-2.2.2-sources.jar", "lib/backends/open_office/bridges/pyodconverter.py", "lib/backends/open_office/server.rb", "lib/backends/pdf_tools.rb", "lib/documentalist.rb", "lib/tasks/tasks.rb", "rails/config/documentalist.yml.tpl", "rails/init.rb", "rails/initialize_configuration.rb", "test/documentalist_test.rb", "test/fixtures/fixture_001.odt", "test/net_pbm_test.rb", "test/odf_merge_test.rb", "test/open_office_test.rb", "test/pdf_tools_test.rb", "test/rails_integration_test.rb", "test/test_helper.rb", "Manifest"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/backends/net_pbm.rb", "lib/backends/odf_merge.rb", "lib/backends/open_office.rb", "lib/backends/open_office/bridges/jodconverter-2.2.2/ChangeLog.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/LICENSE.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/README.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/jodconverter-2.2.2-javadoc.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-commons-io.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-openoffice.org.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-slf4j.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-xstream.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/document-formats.xml", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/DEPENDENCIES.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/commons-cli-1.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/commons-io-1.4.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jodconverter-2.2.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jodconverter-cli-2.2.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/juh-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jurt-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/ridl-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/slf4j-api-1.5.6.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/slf4j-jdk14-1.5.6.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/unoil-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/xstream-1.3.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/src/jodconverter-2.2.2-sources.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/src/jodconverter-cli-2.2.2-sources.jar", "lib/backends/open_office/bridges/pyodconverter.py", "lib/backends/open_office/server.rb", "lib/backends/pdf_tools.rb", "lib/backends/wkhtmltopdf.rb", "lib/dependencies.rb", "lib/documentalist.rb", "lib/tasks/tasks.rb"]
+  s.files = ["README.rdoc", "Rakefile", "config/default.yml", "documentalist.gemspec", "init.rb", "lib/backends/net_pbm.rb", "lib/backends/odf_merge.rb", "lib/backends/open_office.rb", "lib/backends/open_office/bridges/jodconverter-2.2.2/ChangeLog.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/LICENSE.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/README.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/jodconverter-2.2.2-javadoc.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-commons-io.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-openoffice.org.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-slf4j.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/docs/third-party-licenses/license-xstream.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/document-formats.xml", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/DEPENDENCIES.txt", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/commons-cli-1.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/commons-io-1.4.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jodconverter-2.2.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jodconverter-cli-2.2.2.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/juh-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/jurt-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/ridl-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/slf4j-api-1.5.6.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/slf4j-jdk14-1.5.6.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/unoil-3.0.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/lib/xstream-1.3.1.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/src/jodconverter-2.2.2-sources.jar", "lib/backends/open_office/bridges/jodconverter-2.2.2/src/jodconverter-cli-2.2.2-sources.jar", "lib/backends/open_office/bridges/pyodconverter.py", "lib/backends/open_office/server.rb", "lib/backends/pdf_tools.rb", "lib/backends/wkhtmltopdf.rb", "lib/dependencies.rb", "lib/documentalist.rb", "lib/tasks/tasks.rb", "rails/config/documentalist.yml.tpl", "rails/init.rb", "rails/initialize_configuration.rb", "test/documentalist_test.rb", "test/fixtures/fixture_001.odt", "test/fixtures/fixture_002.html", "test/net_pbm_test.rb", "test/odf_merge_test.rb", "test/open_office_test.rb", "test/pdf_tools_test.rb", "test/rails_integration_test.rb", "test/test_helper.rb", "test/wkhtmltopdf_test.rb", "Manifest"]
   s.homepage = %q{http://github.com/davout/documentalist}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Documentalist", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{documentalist}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{The smooth document management experience, usable as a Rails gem plugin or standalone in any ruby application}
-  s.test_files = ["test/open_office_test.rb", "test/odf_merge_test.rb", "test/documentalist_test.rb", "test/rails_integration_test.rb", "test/test_helper.rb", "test/pdf_tools_test.rb", "test/net_pbm_test.rb"]
+  s.test_files = ["test/wkhtmltopdf_test.rb", "test/open_office_test.rb", "test/odf_merge_test.rb", "test/documentalist_test.rb", "test/rails_integration_test.rb", "test/test_helper.rb", "test/pdf_tools_test.rb", "test/net_pbm_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), %w{lib documentalist})

data/lib/backends/net_pbm.rb

@@ -1,10 +1,11 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 module Documentalist
   module NetPBM
-    def convert
-      system("cd #{temp_dir} && ppmtojpeg #{ppm_image} > #{ppm_image.gsub(/ppm$/, "jpg")}")
+    include Documentalist::Dependencies
+
+    depends_on_binaries! "ppmtojpeg" => "install netpbm package"
+
+    def self.convert(file, options)
+      system "ppmtojpeg #{file} > #{options[:to]}"
     end
   end
 end

data/lib/backends/odf_merge.rb

@@ -10,6 +10,8 @@ module Documentalist
 
   # This module provides open document merge functionality
   module ODFMerge
+    include Documentalist::Dependencies
+
     def self.merge_string(string, options = {})
       locals = options[:locals]
 

data/lib/backends/open_office.rb

@@ -1,20 +1,40 @@
 module Documentalist
   module OpenOffice
+    include Documentalist::Dependencies
+
+    depends_on_binaries! "ps" => "use Documentalist in a Posix compliant OS",
+      Documentalist.config[:open_office][:path] => "install Open Office and correctly configure the path to its binary",
+      "pkill" => "install pkill binary and make it available through the PATH",
+      "pgrep" => "install pgrep binary and make it available through the PATH",
+      "java" => "install java",
+      "python" => "install python",
+      "file" => "install file binary",
+      "iconv" => "install iconv binary"
+
     # Converts documents
     def self.convert(origin, options)
+      Documentalist.logger.debug("Going to convert #{origin} to #{options[:to]}")
+
       # See how to make OpenOffice startup as smooth as possible and not on first conversion
       # OO auto-start option if in Rails app ?
       Server.ensure_available
 
+      # TODO : manage multi OO instances : http://code.google.com/p/jodconverter/wiki/GettingStarted
+
       Documentalist.timeout(Documentalist.config[:open_office][:max_conversion_time], :attempts => Documentalist.config[:open_office][:max_conversion_attempts]) do
         if Documentalist.config[:open_office][:bridge] == 'JOD'
-          # TODO : manage multi ooo instances : http://code.google.com/p/jodconverter/wiki/GettingStarted
-          
-          system("#{Documentalist.config[:java][:path]} -jar #{File.join(File.dirname(__FILE__), %w{open_office bridges jodconverter-2.2.2 lib jodconverter-cli-2.2.2.jar})} #{origin} #{options[:to]}")
+          command = "#{Documentalist.config[:java][:path]} -jar #{File.join(File.dirname(__FILE__), %w{open_office bridges jodconverter-2.2.2 lib jodconverter-cli-2.2.2.jar})} #{origin} #{options[:to]}"          
         elsif Documentalist.config[:open_office][:bridge] == 'PYOD'
-          system("#{Documentalist.config[:python][:path]} #{File.join(File.dirname(__FILE__), %w{open_office bridges pyodconverter.py})} #{origin} #{options[:to]}")
+          command = "#{Documentalist.config[:python][:path]} #{File.join(File.dirname(__FILE__), %w{open_office bridges pyodconverter.py})} #{origin} #{options[:to]}"
         end
 
+        if Documentalist.config[:log_file] and !Documentalist.config[:log_file].empty?
+          command += " >> #{Documentalist.config[:log_file]} 2>&1"
+        end
+
+        Documentalist.logger.debug("Going to run #{Documentalist.config[:open_office][:bridge]} bridge with command -- #{command}")
+        system(command)
+
         self.convert_txt_to_utf8(options[:to]) if options[:to_format] == :txt
         
         options[:to]
@@ -37,17 +57,18 @@ module Documentalist
 
       # Restart if running or start new instance
       def self.restart!
+        Documentalist.logger.debug("Restarting OpenOffice instance...")
         (kill! if running?) and start!
+        Documentalist.logger.debug("...done !")
       end
 
       # Start new instance
       def self.start!
+        Documentalist.logger.debug("Starting OpenOffice instance...")
         raise "Already running!" if running?
 
-        log_path = Documentalist.config[:log_file] || "/dev/null"
-
         command_line = "#{Documentalist.config[:open_office][:path]} -headless -accept=\"socket,host=127.0.0.1,port=8100\;urp\;\" -nofirststartwizard -nologo -nocrashreport -norestore -nolockcheck -nodefault"
-        command_line << " >> #{log_path} 2>&1"
+        command_line << " >> #{Documentalist.config[:log_file]} 2>&1"
         command_line << " &"
 
         system(command_line)

data/lib/backends/pdf_tools.rb

@@ -1,8 +1,9 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 module Documentalist
   module PdfTools
+    include Documentalist::Dependencies
+
+    depends_on_binaries! "pdftotext" => "install pdftools package"
+
     def self.convert(origin, options)
       if system("pdftotext #{origin} #{options[:destination]} > /dev/null 2>&1")
         options[:destination]

data/lib/backends/wkhtmltopdf.rb

@@ -0,0 +1,11 @@
+module Documentalist
+  module WkHtmlToPdf
+    include Documentalist::Dependencies
+
+    depends_on_binaries! "wkhtmltopdf" => "install wkhtmltopdf package"
+
+    def self.convert(file, options)
+      system "wkhtmltopdf -q #{file} #{options[:to]}"
+    end
+  end
+end

data/lib/dependencies.rb

@@ -0,0 +1,21 @@
+module Documentalist
+  module Dependencies
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def check_binary_dependency(binary, tip)
+        puts "Checking for presence of #{binary}...  #{`which #{binary}`.empty? ? "Failed, you might want to #{tip}" : "OK"}"
+      end
+
+      def check_dependencies
+        @bin_dependencies.each { |k,v| check_binary_dependency(k,v) } if @bin_dependencies
+      end
+
+      def depends_on_binaries!(h)
+        @bin_dependencies = h
+      end
+    end
+  end
+end

data/lib/documentalist.rb

@@ -2,11 +2,8 @@ require 'rubygems'
 require 'yaml'
 require 'system_timer'
 require 'logger'
-
-# Require all backends
-Dir.glob(File.join(File.dirname(__FILE__), 'backends', '*.rb')).each do |backend|
-  require backend
-end
+require 'kconv'
+require File.join(File.dirname(__FILE__),'dependencies')
 
 module Documentalist
   @@config = {}
@@ -36,12 +33,11 @@ module Documentalist
   end
 
   BACKENDS = {
-    OpenOffice => {[:odt, :doc, :rtf, :docx, :txt, :html, :htm, :wps] => [:odt, :doc, :rtf, :pdf, :txt, :html, :htm, :wps]},
-    NetPBM => {:ppm => [:jpg, :jpeg]},
-    PdfTools => {:pdf => :txt},
-    
     # Find a better pattern to pick backend, this one smells pretty bad
-    # WkHTML2PDF => {[:html, :htm] => :pdf}
+    :WkHtmlToPdf => {[:html, :htm] => :pdf},
+    :OpenOffice => {[:odt, :doc, :rtf, :docx, :txt, :wps] => [:odt, :doc, :rtf, :pdf, :txt, :html, :htm, :wps]},
+    :NetPBM => {:ppm => [:jpg, :jpeg]},
+    :PdfTools => {:pdf => :txt},
   }
 
   # Finds the relevant server to perform the conversion
@@ -49,7 +45,7 @@ module Documentalist
     origin = origin.to_s.gsub(/.*\./, "").to_sym
     destination = destination.to_s.gsub(/.*\./, "").to_sym
 
-    BACKENDS.detect do |s, conversions|
+    BACKENDS.map { |b| [send(:const_get, b[0]), b[1]] }.detect do |s, conversions|
       conversions.keys.flatten.include?(origin) and conversions.values.flatten.include?(destination)
     end.to_a.first
   end
@@ -58,57 +54,57 @@ module Documentalist
   def self.convert(file, options={})
     raise "#{file} does not exist !" unless File.exist?(file)
 
-    unless options[:to] or options[:to_format]
-      raise Documentalist::Error.new("No destination or format was given")
-    end
-    
-    # Convert to plain text by default
-    options[:to_format] = options[:to_format] ? options[:to_format].to_sym : :txt
-
-    unless options[:to]
+    if options[:to_format]
       options[:to] = file.gsub(/#{"\\" + File.extname(file)}$/, ".#{options[:to_format].to_s}")
+    elsif options[:to]
+      options[:to_format] = File.extname(options[:to]).gsub(/\./, "").to_sym
+    else
+      raise Documentalist::Error.new("No destination or format was given")
     end
 
     options[:from_format] = File.extname(file).gsub(/\./, "").to_sym
 
     backend = backend_for_conversion(options[:from_format], options[:to_format])
-    converted = backend.convert(file, options)
+    backend.convert(file, options)
 
-    yield(converted) if block_given?
-    converted
+    yield(options[:to]) if block_given?
+    options[:to]
   end
 
   def self.extract_text(file)
-    converted = convert(file, :to => :txt)
+    converted = convert(file, :to_format => :txt)
+    
     if converted and File.exist?(converted)
-      text = File.open(converted).read.toutf8
+      text = Kconv.toutf8(File.open(converted).read)
       FileUtils.rm(converted)
-
-      yield(extracted_text) if block_given?
+      yield(text) if block_given?
       text
     end
   end
 
   def self.extract_images(file)
-    temp_dir = File.join(CONVERSIONS_PATH, (Time.new.to_f*100_000).to_i.to_s)
+    temp_dir = File.join(Dir.tmpdir, rand(10**9).to_s)
     
     if File.extname(file) == '.pdf'
       temp_file = File.join(temp_dir, File.basename(file))
 
-      system "mkdir #{temp_dir} && cp #{file} #{temp_file}"
-      system "cd #{temp_dir} && pdfimages #{temp_file} 'img'"
+      FileUtils.mkdir_p temp_dir
+      FileUtils.cp file, temp_file
+      
+      system "pdfimages #{temp_file} '#{File.join(temp_dir, "img")}'"
 
       Dir.glob(File.join(temp_dir, "*.ppm")).each do |ppm_image|
-        Documentalist.convert(ppm_image, :to => :jpeg)
+        #raise ppm_image
+        Documentalist.convert(ppm_image, :to_format => :jpeg)
       end
     else
-      convert file, :to => :html, :directory => temp_dir
+      Documentalist.convert file, :to_format => :html
     end
 
-    image_file_names = Dir.glob(File.join(temp_dir, "*.{jpg,jpeg,bmp,tif,tiff,gif,png}"))
+    image_files = Dir.glob(File.join(temp_dir, "*.{jpg,jpeg,bmp,tif,tiff,gif,png}"))
 
-    yield(image_file_names) if block_given?
-    image_file_names
+    yield(image_files) if block_given?
+    image_files
   end
 
   # Runs a block with a system-enforced timeout and optionally retry with an
@@ -130,8 +126,10 @@ module Documentalist
     end
   end
 
+  # Returns the logger object used to log documentalist operations
   def self.logger
-    unless @@logger
+    unless @@logger      
+      Documentalist.config[:log_file] ||= File.join(File.dirname(File.expand_path(__FILE__)), %w{.. documentalist.log})
       @@logger = Logger.new(Documentalist.config[:log_file])
       @@logger.level = Logger.const_get(config[:log_level] ? config[:log_level].upcase : "WARN")
     end
@@ -139,6 +137,20 @@ module Documentalist
     @@logger
   end
 
+  # Checks the dependencies for backends
+  def self.check_dependencies
+    puts "Checking backends system dependencies"
+
+    Documentalist.constants.each do |backend|
+      backend = Documentalist.const_get backend.to_sym
+
+      if backend.respond_to? :check_dependencies
+        puts "Checking dependencies for #{backend.to_s}"
+        backend.send :check_dependencies
+      end
+    end
+  end
+
   # Returns a new hash with recursively symbolized keys
   def self.symbolize(hash)
     hash.each_key do |key|
@@ -148,4 +160,9 @@ module Documentalist
   end
 
   class Error < RuntimeError; end
-end  
+end
+
+# Require all backends
+Dir.glob(File.join(File.dirname(__FILE__), 'backends', '*.rb')).each do |backend|
+  require backend
+end

data/rails/init.rb

@@ -1,12 +1,12 @@
 require 'yaml'
 
 require File.join(File.dirname(__FILE__), %w{initialize_configuration})
-require File.join(File.dirname(__FILE__), %w{.. lib documentalist})
+require File.join(File.dirname(__FILE__), %w{.. init})
 
 # Load configuration from Rails.root/config/documentalist.yml
 Documentalist.config_from_yaml! File.join(RAILS_ROOT, %w{config documentalist.yml}), :section => RAILS_ENV
 
 # Set a default for the logfile if it hasn't been provided by the configuration file
-unless Documentalist.config[:logfile]
-  Documentalist.config[:logfile] = File.join(RAILS_ROOT, %w{log documentalist-#{RAILS_ENV}.log})
+unless Documentalist.config[:log_file]
+  Documentalist.config[:log_file] = File.join(RAILS_ROOT, "log", "documentalist-#{RAILS_ENV}.log")
 end

data/test/documentalist_test.rb

@@ -18,8 +18,8 @@ class DocumentalistTest < Test::Unit::TestCase
         :d => "e"
       }
     }
-    
-    assert_equal Documentalist.send(:symbolize, hash), 
+
+    assert_equal Documentalist.send(:symbolize, hash),
       symbolized,
       "Hash wasn't properly symbolized"
   end
@@ -44,6 +44,11 @@ class DocumentalistTest < Test::Unit::TestCase
     log_file = File.join(Dir.tmpdir, "#{rand(10 ** 9).to_s}.log")
 
     Documentalist.config[:log_file] = log_file
+    Documentalist.config[:log_level] = 'warn'
+
+    # Reset logger
+    Documentalist.send :class_variable_set, :@@logger, nil
+
     assert !File.exists?(log_file), "Log file already exists"
 
     Documentalist.logger
@@ -56,8 +61,17 @@ class DocumentalistTest < Test::Unit::TestCase
     assert_difference("File.size(\"#{log_file}\")", nil, "Nothing should have been written") do
       Documentalist.logger.warn("This message should be written !")
     end
-    
+
+    # Reset logger
+    Documentalist.send :class_variable_set, :@@logger, nil
+
     FileUtils.rm(log_file)
     assert !File.exists?(log_file), "Log file hasn't been removed properly"
   end
+
+  def test_extract_text
+    assert_match /thing/,
+      Documentalist.extract_text(fixture_001),
+      "Text was not properly extracted for fixture 001"
+  end
 end

data/test/fixtures/fixture_002.html

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+    <head>
+        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+        <title>Title</title>
+    </head>
+    <body>
+        <p>
+            Test content
+        </p>
+    </body>
+</html>

data/test/rails_integration_test.rb

@@ -28,11 +28,13 @@ class RailsIntegrationTest < Test::Unit::TestCase
     assert File.exists?(File.join(RAILS_ROOT, %w{config documentalist.yml})),
       "Configuration file did not get copied properly"
 
-    assert_equal Documentalist.config[:logfile], File.join(RAILS_ROOT, %w{log documentalist-#{RAILS_ENV}.log})
+    assert_equal Documentalist.config[:log_file], File.join(RAILS_ROOT, "log", "documentalist-#{RAILS_ENV}.log")
 
     # Delete fake RAILS_ROOT
     FileUtils.rm_rf tmp_dir
 
+    # Reset logger
+
     # Check that we cleaned our mess up
     assert !File.exist?(File.join(RAILS_ROOT, %w{config documentalist.yml})), "Temporary file hasn't been removed properly"
   end

data/test/test_helper.rb

@@ -7,6 +7,10 @@ def fixture_001
   File.join(File.dirname(__FILE__), "fixtures/fixture_001.odt")
 end
 
+def fixture_002
+  File.join(File.dirname(__FILE__), "fixtures/fixture_002.html")
+end
+
 class Test::Unit::TestCase
   def assert_difference(code, difference = 0, message = nil)
     message = "Returned values were equal" unless message

data/test/wkhtmltopdf_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class WkHtmlToPdfTest < Test::Unit::TestCase
+  def test_right_backend_is_picked
+    assert_equal Documentalist.backend_for_conversion("test.html", "test.pdf"),
+      Documentalist::WkHtmlToPdf,
+      "Wrong backend picked"
+  end
+
+  def test_conversion
+    temp_file = File.join(Dir.tmpdir, "#{rand(10**9)}.pdf")
+
+    Documentalist.convert(fixture_002, :to => temp_file)
+    assert File.exists?(temp_file), "No converted PDF created"
+
+    assert_match /Test content/, Documentalist.extract_text(temp_file)
+
+    FileUtils.rm temp_file
+    assert !File.exists?(temp_file), "We didn't clean up properly"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: documentalist
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - David FRANCOIS
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-30 00:00:00 +02:00
+date: 2010-07-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,6 +102,8 @@ extra_rdoc_files:
 - lib/backends/open_office/bridges/pyodconverter.py
 - lib/backends/open_office/server.rb
 - lib/backends/pdf_tools.rb
+- lib/backends/wkhtmltopdf.rb
+- lib/dependencies.rb
 - lib/documentalist.rb
 - lib/tasks/tasks.rb
 files: 
@@ -139,6 +141,8 @@ files:
 - lib/backends/open_office/bridges/pyodconverter.py
 - lib/backends/open_office/server.rb
 - lib/backends/pdf_tools.rb
+- lib/backends/wkhtmltopdf.rb
+- lib/dependencies.rb
 - lib/documentalist.rb
 - lib/tasks/tasks.rb
 - rails/config/documentalist.yml.tpl
@@ -146,12 +150,14 @@ files:
 - rails/initialize_configuration.rb
 - test/documentalist_test.rb
 - test/fixtures/fixture_001.odt
+- test/fixtures/fixture_002.html
 - test/net_pbm_test.rb
 - test/odf_merge_test.rb
 - test/open_office_test.rb
 - test/pdf_tools_test.rb
 - test/rails_integration_test.rb
 - test/test_helper.rb
+- test/wkhtmltopdf_test.rb
 - Manifest
 has_rdoc: true
 homepage: http://github.com/davout/documentalist
@@ -194,6 +200,7 @@ signing_key:
 specification_version: 3
 summary: The smooth document management experience, usable as a Rails gem plugin or standalone in any ruby application
 test_files: 
+- test/wkhtmltopdf_test.rb
 - test/open_office_test.rb
 - test/odf_merge_test.rb
 - test/documentalist_test.rb