documentalist 0.1.0 → 0.1.1

data/test/net_pbm_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class NetPBMTest < Test::Unit::TestCase
+  def test_net_pbm_binary_is_present
+    assert !`which ppmtojpeg`.empty?, "Can't seem to find ppmtojpeg binary"
+  end
+end

data/test/odf_merge_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+class ODFMergeTest < Test::Unit::TestCase
+  # Tests that an arbitrary hash of data gets correctly merged into a string template
+  def test_merge
+    template = "<%= @var1 %><%= 1.upto(3).map{ |n| n.to_s }.join %><%= @var2 %>"
+
+    merged = Documentalist::ODFMerge.merge_string(template, :locals => {
+        :var1 => "test",
+        :var2 => "working?"
+      }
+    )
+
+    assert_equal "test123working?", merged, "Merge wasn't performed correctly"
+  end
+
+  # Tests that the ODFMerge backend correctly extracts the contents.xml contents
+  # of an ODF document
+  def test_extracts_contents_from_odf_file
+    contents = Documentalist::ODFMerge.get_contents fixture_001
+
+    assert_match /Hello/, contents
+    assert_match /thing/, contents
+    assert !(contents =~ /%&gt;/)
+    assert !(contents =~ /&lt;%=/)
+  end
+
+  # Tests that a merge is correctly performed with an ODF template
+  def test_odf_merge
+    result = File.join(Dir.tmpdir, "#{(rand * 10 ** 9).to_i}.odt")
+
+    Documentalist.odf_merge fixture_001,
+      :locals => {:thing => "world"},
+      :to => result
+
+    assert /world/, Documentalist::ODFMerge.get_contents(result)
+
+    FileUtils.rm result
+    assert !File.exists?(result), "Oops, we haven't cleaned up our mess..."
+  end
+
+  # Tests that an ODF template can be merged and then converted to another format
+  # using the OpenOffice backend
+  def test_odf_merge_and_convert
+    result = File.join(Dir.tmpdir, "#{(rand * 10 ** 9).to_i}.pdf")
+
+    Documentalist.odf_merge fixture_001,
+      :locals => {:thing => "world"},
+      :to => result
+
+    assert File.exists?(result), "Seems like there is no merged result"
+
+    FileUtils.rm result
+    assert !File.exists?(result), "Oops, we haven't cleaned up our mess..."
+  end
+end

data/test/open_office_test.rb

@@ -1,21 +1,78 @@
-require 'test/unit'
-require 'documentalist'
-require 'fileutils'
-require 'tmpdir'
+require 'test_helper'
 
 class OpenOfficeTest < Test::Unit::TestCase
-  def test_open_office
-    destination = File.join(Dir.tmpdir, "fixture#{rand(10**9)}.pdf")
+  @@oo_server = Documentalist::OpenOffice::Server
 
-    Documentalist.convert(
-      File.join(File.dirname(__FILE__), "fixtures", "fixture.odt"),
-      destination
-    )
+  def setup
+    # Make our test reproductible
+    @@oo_server.kill! if @@oo_server.running?
+  end
+
+  def test_open_office_converts_from_odf_to_pdf_with_jod
+    destination = File.join(Dir.tmpdir, "#{rand(10**9)}.doc")
+
+    Documentalist.convert fixture_001, :to => destination
+
+    assert File.exist?(destination), "Nothing seems to have been converted..."
+
+    FileUtils.rm destination
+    assert !File.exist?(destination), "We didn't clean up our mess!"
+  end
+
+  def test_open_office_converts_from_odf_to_pdf_with_pyod
+    Documentalist.config[:open_office][:bridge] = "PYOD"
+
+    destination = File.join(Dir.tmpdir, "#{rand(10**9)}.doc")
+
+    Documentalist.convert fixture_001, :to => destination
+
+    assert File.exist?(destination), "Nothing seems to have been converted..."
+
+    FileUtils.rm destination
+    assert !File.exist?(destination), "We didn't clean up our mess!"
+  end
+
+  def test_open_office_converts_with_just_a_format
+    Documentalist.config[:open_office][:bridge] = "PYOD"
 
-    assert File.exist?(destination)
+    destination = File.join(Dir.tmpdir, "#{rand(10**9)}.doc")
 
-    FileUtils.rm(destination)
+    temp_origin = File.join(Dir.tmpdir, "#{rand(10 ** 9).to_s}_fixture_001.odt")
+    temp_destination = temp_origin.gsub(/\.odt/, ".txt")
+
+    FileUtils.cp fixture_001, temp_origin
+
+    Documentalist.convert temp_origin, :to_format => :txt
+
+    assert File.exist?(temp_origin), "Nothing seems to have been copied..."
+    assert File.exist?(temp_destination), "Nothing seems to have been converted..."
+
+    assert !File.size(temp_destination).zero?
+
+    FileUtils.rm temp_origin
+    FileUtils.rm temp_destination
+
+    assert !File.exist?(temp_origin), "We didn't clean up our mess!"
+    assert !File.exist?(temp_destination), "We didn't clean up our mess!"
+  end
+
+  def test_open_office_should_obey
+    assert !@@oo_server.running?, "OpenOffice service is running, it shouldn't be"
+
+    @@oo_server.start!
+    assert @@oo_server.running?, "OpenOffice didn't start"
+
+    pids = @@oo_server.pids
+    assert !(pids.nil? or pids.empty?),  "Oops, pid was blank!"
+
+    @@oo_server.restart!
+    assert_not_equal pids, @@oo_server.pids, "Seems like OpenOffice didn't actually get restarted"
+  end
 
-    assert !File.exist?(destination)
+  def test_open_office_should_explode_if_no_destination_given
+    assert_raise Documentalist::Error do
+      # We want to make sure an exception is raised if no destination is passed
+      Documentalist.convert(__FILE__)
+    end
   end
 end

data/test/pdf_tools_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class PdfToolsTest < Test::Unit::TestCase
+  def test_pdf_tools_binaries_are_present
+    assert !`which pdfimages`.empty?, "Can't seem to find pdfimages binary"
+    assert !`which pdftotext`.empty?, "Can't seem to find pdftotext binary"
+  end
+end

data/test/rails_integration_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'tmpdir'
+
+class RailsIntegrationTest < Test::Unit::TestCase
+  def test_config_file_gets_copied_and_loaded
+    # Undefine Documentalist so we don't get annoying warnings about constant redefinition
+    # when redefining Documentalist::BACKENDS when requiring it a second time after it
+    # being required a first time through the 'test_helper' require
+    Object.send(:remove_const, :Documentalist)
+
+    # Ensure that RAILS_ROOT is undefined
+    assert !Object.const_defined?(:RAILS_ROOT), "RAILS_ROOT constant is defined, I won't go further"
+
+    # Set up a fake RAILS_ROOT
+    tmp_dir = Object.const_set :RAILS_ROOT, File.join(Dir.tmpdir, (rand(10**9)).to_s)
+    FileUtils.mkdir_p File.join(tmp_dir, "config")
+
+    # Set up a fake RAILS_ENV
+    Object.const_set :RAILS_ENV, "development"
+
+    # Initialize in fake Rails context
+    require File.join(File.dirname(__FILE__), %w{.. rails init})
+
+    # Check that the configuration got loaded up properly
+    assert_equal Documentalist.config[:python][:path], '/usr/bin/python'
+
+    # Check that our configuration template got copied
+    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})
+
+    # Delete fake RAILS_ROOT
+    FileUtils.rm_rf tmp_dir
+
+    # 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
+end

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'test/unit'
+require 'flexmock/test_unit'
+require 'documentalist'
+
+def fixture_001
+  File.join(File.dirname(__FILE__), "fixtures/fixture_001.odt")
+end
+
+class Test::Unit::TestCase
+  def assert_difference(code, difference = 0, message = nil)
+    message = "Returned values were equal" unless message
+    start_value = eval(code).to_i
+    yield
+    end_value = eval(code).to_i
+
+    if difference
+      assert_equal difference, end_value - start_value, message
+    else
+      assert((end_value - start_value) != 0, message)
+    end
+  end
+
+  def assert_no_difference(code, message = "Returned values were different")
+    assert_difference(code, 0, message) do
+      yield
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: documentalist
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - David FRANCOIS
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-08 00:00:00 +02:00
+date: 2010-06-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,38 @@ dependencies:
         version: 2.0.2
   type: :runtime
   version_requirements: *id001
-description: Ruby interface that talks to OpenOffice
+- !ruby/object:Gem::Dependency 
+  name: SystemTimer
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 8
+        - 6
+        version: 0.8.6
+  type: :development
+  version_requirements: *id003
+description: The smooth document management experience, usable as a Rails gem plugin or standalone in any ruby application
 email: david.francois@webflows.fr
 executables: []
 
@@ -42,21 +73,85 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
-- lib/DocumentConverter.py
+- 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/open_office/server.rb
+- lib/tasks/tasks.rb
 files: 
 - README.rdoc
 - Rakefile
+- config/default.yml
 - documentalist.gemspec
 - init.rb
-- lib/DocumentConverter.py
+- 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/open_office/server.rb
+- lib/tasks/tasks.rb
+- rails/config/documentalist.yml.tpl
 - rails/init.rb
+- rails/initialize_configuration.rb
 - test/documentalist_test.rb
-- test/fixtures/fixture.odt
+- 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
 has_rdoc: true
 homepage: http://github.com/davout/documentalist
@@ -97,7 +192,12 @@ rubyforge_project: documentalist
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby interface that talks to OpenOffice
+summary: The smooth document management experience, usable as a Rails gem plugin or standalone in any ruby application
 test_files: 
-- test/documentalist_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