propaganda 0.1.0 → 0.2.0

data/README.rdoc

@@ -3,6 +3,21 @@
 Generate PDFs from HTML. Generate them from Markdown and Textile. Take over
 the world. 
 
+== Note on Ruby Java Bridge and Invoking the Apache library
+
+This gem relies on a java binary and Ruby provides a few ways of getting to
+that. This gem provides support for executing the binary via the Ruby Java 
+Bridge (rjb) which is available on rubygems (http://rubygems.org/gems/rjb). 
+Source is available on Github (http://github.com/arton/rjb). When installing 
+the rjb gem you must have a JAVA_HOME environment variable set. If you install 
+your gems using sudo this can be flummoxing. For OSX:
+
+  sudo env JAVA_HOME=/Library/Java/Home gem install rjb
+
+If you don't want to use rjb, you don't have to. The gem can invoke the java
+library via shell commands if it doesn't detect the rjb gem. In order to
+facilitate this you must have the java application on your path.
+
 == Installation
 
 Propaganda is available on Rubygems.org. 
@@ -53,16 +68,6 @@ keep-together.within-<context>="always" etc. where <context> is line if the
 declaration is found on an inline level element, column if within a table cell 
 otherwise page.
 
-== Note on Ruby Java Bridge
-
-For non-jruby usage this gem relies on the Ruby Java Bridge (rjb) which is
-available on rubygems (http://rubygems.org/gems/rjb). Source is available
-on Github (http://github.com/arton/rjb). When installing the rjb gem you
-must have a JAVA_HOME environment variable set. If you install your gems
-using sudo this can be flummoxing. Just use:
-
-sudo env JAVA_HOME=/Library/Java/Home gem install rjb
-
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -13,7 +13,6 @@ begin
     gem.files = FileList["[A-Z]*", "{bin,java,lib,templates,test}/**/*"] 
     gem.add_dependency "BlueCloth", ">= 1.0.0"
     gem.add_dependency "RedCloth", ">= 4.1.1"
-    gem.add_dependency "rjb", ">= 1.2.0"
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/propaganda/fop/bridge.rb

@@ -0,0 +1,46 @@
+require 'rjb'
+
+module Propaganda    
+  module Fop
+    class Bridge
+      def initialize(verbose=false)
+        @verbose = verbose
+      end
+      
+      def invoke(*args)
+        # When invoking we need to use our own Manager class because the default
+        # cli Main class deletes the file on exit and always calls System.exit 
+        # which closes our application. We avoid that and also setup additional
+        # protection against rogue System.exit calls in the library
+        SystemExitManager.disableSystemExitCall
+        Manager._invoke('main', '[Ljava.lang.String;', args)
+        Output.toString
+      rescue Exception => e
+        raise "Could not render document [#{e}] (" + Errors.toString + ")"
+      ensure  
+        SystemExitManager.enableSystemExitCall
+      end
+          
+      private 
+      
+      def self.classpath
+        path = File.join(File.dirname(__FILE__), '..', '..', '..', 'java')
+        File.expand_path(path)+':'+File.join(path, 'fop.jar')
+      end
+      
+      Rjb::load(Bridge.classpath, ['-Djava.awt.headless=true'])
+      SystemExitManager = Rjb::import 'SystemExitManager'    
+      Manager = Rjb::import 'org.apache.fop.cli.Manager'    
+      ByteArray = Rjb::import 'java.io.ByteArrayOutputStream'
+      PrintStream = Rjb::import 'java.io.PrintStream'
+
+      # Internally fop is very noisy, we have to block all of that if we don't
+      # want to go crazy. To do that we overwrite the default streams, 
+      # unfortunately these are globals, so its one size fits all
+      Errors = ByteArray.new
+      Rjb::import('java.lang.System').err = PrintStream.new(Errors)
+      Output = ByteArray.new
+      Rjb::import('java.lang.System').out = PrintStream.new(Output)
+    end
+  end
+end

data/lib/propaganda/fop/shell.rb

@@ -0,0 +1,32 @@
+require 'open3'
+
+module Propaganda    
+  module Fop
+    class Shell
+      def initialize(verbose=false)
+        @verbose = verbose
+      end
+      
+      def invoke(*args)
+        command = "java -Djava.awt.headless=true -jar #{jarpath} #{args.join(' ')}"
+        if @verbose
+          `#{command}`
+        else
+          stdin, stdout, stderr = Open3.popen3(command)
+          @errors = stderr.read
+          @output = stdout.read
+          raise "Could not invoke: #{@errors}" unless @errors.blank?
+          @output
+        end  
+      end
+
+      private 
+      
+      def self.jarpath
+        path = File.join(File.dirname(__FILE__), '..', '..', '..', 'java')
+        File.expand_path(File.join(path, 'fop.jar'))
+      end
+      
+    end
+  end
+end

data/lib/propaganda/renderer.rb

@@ -0,0 +1,48 @@
+require 'tempfile'
+
+module Propaganda    
+
+  def self.check_dependencies
+    require 'propaganda/fop/shell' 
+    require 'propaganda/fop/bridge'
+  end
+
+  MODE = check_dependencies ? 'rjb' : 'shell'
+
+  class Renderer
+    def initialize(verbose=false)
+      @verbose = verbose
+    end
+
+    def version
+      invoke('-v')
+    end
+
+    def render(html, output, template=nil)
+      template ||= 'default'
+      stylesheet = File.join(File.dirname(__FILE__), '..', '..', 'templates', "#{template}.xsl")
+      stylesheet = File.expand_path(stylesheet)
+      tmp = Tempfile.new('fop')
+      tmp << html
+      tmp.flush
+      tmp.close
+      output = File.expand_path(output)
+      invoke('-xml', tmp.path, '-xsl', stylesheet, '-pdf', output)
+    ensure
+      tmp.close rescue nil
+      tmp = nil  
+    end
+    
+    private 
+    
+    def invoke(*args)
+      if MODE == 'rjb'
+        fop = Propaganda::Fop::Bridge.new(@verbose)
+        fop.invoke(*args)
+      elsif MODE == 'shell'
+        fop = Propaganda::Fop::Shell.new(@verbose)
+        fop.invoke(*args)
+      end
+    end        
+  end
+end

data/lib/propaganda.rb

@@ -1,4 +1,4 @@
-require 'propaganda/fop'
+require 'propaganda/renderer'
 require 'propaganda/formatter'
 
 module Propaganda
@@ -8,7 +8,7 @@ module Propaganda
     text = IO.read(input)
     formatter = Formatter.new
     text = formatter.format(text, title, engine)
-    fop = Fop.new(verbose)
+    fop = Renderer.new(verbose)
     fop.render(text, output, template)
   end
   

data/test/fop_test.rb

@@ -5,13 +5,13 @@ class FopTest < Test::Unit::TestCase
     File.delete('test/samples/sample.pdf') rescue nil
     assert File.exists?('test/samples/sample.html')
     text = IO.read('test/samples/sample.html')
-    fop = Propaganda::Fop.new(true)
+    fop = Propaganda::Renderer.new(true)
     fop.render(text, 'test/samples/sample.pdf')
-    assert File.exists?('test/samples/sample.pdf'),  Propaganda::Fop::Errors.toString 
+    assert File.exists?('test/samples/sample.pdf') 
   end
 
   should "get the version" do
-    fop = Propaganda::Fop.new
+    fop = Propaganda::Renderer.new
     assert fop.version
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: propaganda
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jeff Rafter
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-24 00:00:00 -08:00
+date: 2010-02-25 00:00:00 -08:00
 default_executable: propaganda
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,16 +32,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 4.1.1
     version: 
-- !ruby/object:Gem::Dependency 
-  name: rjb
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.0
-    version: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
   type: :development
@@ -84,8 +74,10 @@ files:
 - java/xml-apis-ext-1.3.04.jar
 - java/xmlgraphics-commons-1.3.1.jar
 - lib/propaganda.rb
-- lib/propaganda/fop.rb
+- lib/propaganda/fop/bridge.rb
+- lib/propaganda/fop/shell.rb
 - lib/propaganda/formatter.rb
+- lib/propaganda/renderer.rb
 - templates/clean.xsl
 - templates/default.xsl
 - test/fop_test.rb

data/lib/propaganda/fop.rb

@@ -1,63 +0,0 @@
-require 'rjb'
-require 'tempfile'
-
-module Propaganda    
-  class Fop
-    def initialize(verbose=false)
-      unless verbose
-      end
-    end
-
-    def version
-      invoke('-v')
-      Output.toString 
-    end
-
-    def render(html, output, template=nil)
-      template ||= 'default'
-      stylesheet = File.join(File.dirname(__FILE__), '..', '..', 'templates', "#{template}.xsl")
-      stylesheet = File.expand_path(stylesheet)
-      tmp = Tempfile.new('fop')
-      tmp << html
-      tmp.flush
-      tmp.close
-      output = File.expand_path(output)
-      invoke('-xml', tmp.path, '-xsl', stylesheet, '-pdf', output)
-    ensure
-      tmp = nil  
-    end
-    
-    private 
-    
-    def invoke(*args)
-      # When invoking we need to use our own Manager class because the default
-      # cli Main class deletes the file on exit and always calls System.exit 
-      # which closes our application. We avoid that and also setup additional
-      # protection against rogue System.exit calls in the library
-      SystemExitManager.disableSystemExitCall
-      Manager._invoke('main', '[Ljava.lang.String;', args)
-    rescue Exception => e
-      raise "Could not render document [#{e}] (" + Errors.toString + ")"
-    ensure  
-      SystemExitManager.enableSystemExitCall
-    end
-        
-    def self.classpath
-      path = File.join(File.dirname(__FILE__), '..', '..', 'java')
-      File.expand_path(path+':'+File.join(path, 'fop.jar'))
-    end
-    
-    Rjb::load(Fop.classpath, ['-Djava.awt.headless=true'])
-    SystemExitManager = Rjb::import 'SystemExitManager'    
-    Manager = Rjb::import 'org.apache.fop.cli.Manager'    
-    ByteArray = Rjb::import 'java.io.ByteArrayOutputStream'
-    PrintStream = Rjb::import 'java.io.PrintStream'
-
-    # Internally fop is very noisy, we have to block all of that if we don't
-    # want to go crazy. To do that we overwrite the default streams
-    Errors = ByteArray.new
-    Rjb::import('java.lang.System').err = PrintStream.new(Errors)
-    Output = ByteArray.new
-    Rjb::import('java.lang.System').out = PrintStream.new(Output)
-  end
-end