propaganda 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Rafter
+
+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.rdoc

@@ -0,0 +1,78 @@
+= propaganda
+
+Generate PDFs from HTML. Generate them from Markdown and Textile. Take over
+the world. 
+
+== Installation
+
+Propaganda is available on Rubygems.org. 
+
+  gem install propaganda
+  
+This will install the library as well as the propoganda binary. 
+
+== Usage
+
+Once installed you can run
+
+  propaganda --help
+  
+Some examples:
+
+  propaganda sample.html sample.pdf
+  
+Will convert sample.html to sample.pdf. You can also submit textile and 
+markdown documents and these will be automagically converted.
+
+  propaganda sample.textile sample.pdf
+  
+The document will be formatted into a basic layout.
+
+== Apache and the Formatting Objects processor
+
+Propaganda uses the Apache FOP library (http://xmlgraphics.apache.org/fop/). I 
+have included those binaries in the gem so that the versions are set. The 
+licenses for items in the jar folder are separate from propaganda.
+
+== Doing it with style
+
+The stylesheets I am using are based entirely on the stylesheets from 
+Antenna House, Inc. (http://www.antennahouse.com) that were made for their 
+formatting engine. It was widely known that these were incompatible with 
+Apache FOP for various reasons. Well, I fixed those, mostly and then tweaked
+things to do what I want a bit more.
+
+I also reworked the way keep-with-next and friends works. Basically there 
+wasn't a good way to implement this directly, so I extended support for blocks
+with css classes. Breaking logic (for table cells and block level objects) 
+'break-before' and 'break-after' converted to break-before="<context>" or 
+break-after="<context>" where <context> is column if it is within a table 
+otherwise page. Keeping logic (for table cells and block level objects) 
+'keep-together' and 'keep-with-next' and 'keep-with-previous' and converted to 
+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.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeff Rafter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "propaganda"
+    gem.summary = %Q{Generate PDFs from HTML. Generate them from Markdown and Textile. Take over the world.}
+    gem.description = %Q{Propaganda uses Apache FOP to convert html to PDF using a series of stylesheets. Propaganda can also format textile and markdown documents. }
+    gem.email = "jeff@socialrange.org"
+    gem.homepage = "http://github.com/jeffrafter/propaganda"
+    gem.authors = ["Jeff Rafter"]
+    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
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "propaganda #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/propaganda

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+def usage
+  puts "Usage: propaganda [options] input output" 
+  puts ""
+  puts "  --title=='A Friendly Title' (will detect from filename if omitted)"
+  puts "  --template=={default|clean} (will use default if omitted)"
+  puts "  --engine=={markdown|textile|none} (will detect from filename if omitted)"
+  puts "  --verbose Show errors and warnings"  
+  puts "  --help"
+  exit
+end
+
+usage if ARGV.size == 0 || ARGV.include?('--help')
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib')) if ENV['PROPAGANDA_ENV'] == 'test'
+
+require 'rubygems'
+require 'propaganda'
+
+def opt(name)
+  p = ARGV.select{|arg| arg =~ /^--#{name}/}.first
+  p.gsub(/^--#{name}=/, '') if p
+end
+
+template = opt "template"
+title = opt "title"
+engine = opt "engine"
+verbose = !opt("verbose").nil?
+
+# Grab the params
+params = ARGV.reject{|arg| arg =~ /^--/}
+input = params[0] rescue nil
+output = params[1] rescue nil
+usage if input.nil? || output.nil?
+
+# Run it
+Propaganda.convert(input, output, title, template, engine, verbose)

data/java/SystemExitManager.java

@@ -0,0 +1,19 @@
+// Hack to disable calls to System.exit in your application. Based on code from
+// http://sprauer.wordpress.com/2009/03/18/disable-java-systemexit/ which is
+// in turn based on http://www.jroller.com/ethdsy/entry/disabling_system_exit
+public class SystemExitManager extends SecurityManager {
+  public void checkPermission(java.security.Permission permission) {
+    if ("exitVM".equals(permission.getName())) {
+      throw new SecurityException("System exit disabled");
+    }
+  }
+  
+  public static void disableSystemExitCall() {    
+    SystemExitManager securityManager = new SystemExitManager();
+    System.setSecurityManager(securityManager);
+  }
+
+  public static void enableSystemExitCall() {
+    System.setSecurityManager(null);
+  }
+}

data/java/org/apache/fop/cli/Manager.java

@@ -0,0 +1,207 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.cli;
+
+import java.io.File;
+import java.io.FileFilter;
+import java.io.OutputStream;
+import java.lang.reflect.Method;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.List;
+
+import org.apache.commons.io.IOUtils;
+
+import org.apache.fop.apps.FOUserAgent;
+import org.apache.fop.apps.MimeConstants;
+
+/**
+ * Main command-line class for Apache FOP.
+ */
+public class Manager {
+
+    /**
+     * @return the list of URLs to all libraries.
+     * @throws MalformedURLException In case there is a problem converting java.io.File
+     * instances to URLs.
+     */
+    public static URL[] getJARList() throws MalformedURLException {
+        String fopHome = System.getProperty("fop.home");
+        File baseDir;
+        if (fopHome != null) {
+            baseDir = new File(fopHome).getAbsoluteFile();
+        } else {
+            baseDir = new File(".").getAbsoluteFile().getParentFile();
+        }
+        File buildDir;
+        if ("build".equals(baseDir.getName())) {
+            buildDir = baseDir;
+            baseDir = baseDir.getParentFile();
+        } else {
+            buildDir = new File(baseDir, "build");
+        }
+        File fopJar = new File(buildDir, "fop.jar");
+        if (!fopJar.exists()) {
+            fopJar = new File(baseDir, "fop.jar");
+        }
+        if (!fopJar.exists()) {
+            throw new RuntimeException("fop.jar not found in directory: "
+                    + baseDir.getAbsolutePath() + " (or below)");
+        }
+        List jars = new java.util.ArrayList();
+        jars.add(fopJar.toURI().toURL());
+        File[] files;
+        FileFilter filter = new FileFilter() {
+            public boolean accept(File pathname) {
+                return pathname.getName().endsWith(".jar");
+            }
+        };
+        File libDir = new File(baseDir, "lib");
+        if (!libDir.exists()) {
+            libDir = baseDir;
+        }
+        files = libDir.listFiles(filter);
+        if (files != null) {
+            for (int i = 0, size = files.length; i < size; i++) {
+                jars.add(files[i].toURI().toURL());
+            }
+        }
+        String optionalLib = System.getProperty("fop.optional.lib");
+        if (optionalLib != null) {
+            files = new File(optionalLib).listFiles(filter);
+            if (files != null) {
+                for (int i = 0, size = files.length; i < size; i++) {
+                    jars.add(files[i].toURI().toURL());
+                }
+            }
+        }
+        URL[] urls = (URL[])jars.toArray(new URL[jars.size()]);
+        /*
+        for (int i = 0, c = urls.length; i < c; i++) {
+            System.out.println(urls[i]);
+        }*/
+        return urls;
+    }
+
+    /**
+     * @return true if FOP's dependecies are available in the current ClassLoader setup.
+     */
+    public static boolean checkDependencies() {
+        try {
+            //System.out.println(Thread.currentThread().getContextClassLoader());
+            Class clazz = Class.forName("org.apache.commons.io.IOUtils");
+            if (clazz != null) {
+                clazz = Class.forName("org.apache.avalon.framework.configuration.Configuration");
+            }
+            return (clazz != null);
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
+    /**
+     * Dynamically builds a ClassLoader and executes FOP.
+     * @param args command-line arguments
+     */
+    public static void startFOPWithDynamicClasspath(String[] args) {
+        try {
+            URL[] urls = getJARList();
+            //System.out.println("CCL: "
+            //    + Thread.currentThread().getContextClassLoader().toString());
+            ClassLoader loader = new java.net.URLClassLoader(urls, null);
+            Thread.currentThread().setContextClassLoader(loader);
+            Class clazz = Class.forName("org.apache.fop.cli.Main", true, loader);
+            //System.out.println("CL: " + clazz.getClassLoader().toString());
+            Method mainMethod = clazz.getMethod("startFOP", new Class[] {String[].class});
+            mainMethod.invoke(null, new Object[] {args});
+        } catch (Exception e) {
+            System.err.println("Unable to start FOP:");
+            e.printStackTrace();
+            System.exit(-1);
+        }
+    }
+
+    /**
+     * Executes FOP with the given arguments. If no argument is provided, returns its
+     * version number as well as a short usage statement; if '-v' is provided, returns its
+     * version number alone; if '-h' is provided, returns its short help message.
+     *
+     * @param args command-line arguments
+     */
+    public static void startFOP(String[] args) {
+        //System.out.println("static CCL: "
+        //    + Thread.currentThread().getContextClassLoader().toString());
+        //System.out.println("static CL: " + Fop.class.getClassLoader().toString());
+        CommandLineOptions options = null;
+        FOUserAgent foUserAgent = null;
+        OutputStream out = null;
+
+        try {
+            options = new CommandLineOptions();
+            options.parse(args);
+
+            foUserAgent = options.getFOUserAgent();
+            String outputFormat = options.getOutputFormat();
+
+            try {
+                if (options.getOutputFile() != null) {
+                    out = new java.io.BufferedOutputStream(
+                          new java.io.FileOutputStream(options.getOutputFile()));
+                    foUserAgent.setOutputFile(options.getOutputFile());
+                }
+                if (!MimeConstants.MIME_XSL_FO.equals(outputFormat)) {
+                    options.getInputHandler().renderTo(foUserAgent, outputFormat, out);
+                } else {
+                    options.getInputHandler().transformTo(out);
+                }
+            } finally {
+                IOUtils.closeQuietly(out);
+            }
+
+            // System.exit(0) called to close AWT/SVG-created threads, if any.
+            // AWTRenderer closes with window shutdown, so exit() should not
+            // be called here
+            if (!MimeConstants.MIME_FOP_AWT_PREVIEW.equals(outputFormat)) {
+              return;
+            }
+        } catch (Exception e) {
+            if (options != null) {
+                options.getLogger().error("Exception", e);
+                if (options.getOutputFile() != null) {
+                    options.getOutputFile().delete();
+                }
+            }
+            return;
+        }
+    }
+
+    /**
+     * The main routine for the command line interface
+     * @param args the command line parameters
+     */
+    public static void main(String[] args) {
+        if (checkDependencies()) {
+            startFOP(args);
+        } else {
+            startFOPWithDynamicClasspath(args);
+        }
+    }
+
+}

data/lib/propaganda/fop.rb

@@ -0,0 +1,63 @@
+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

data/lib/propaganda/formatter.rb

@@ -0,0 +1,35 @@
+require 'redcloth'
+require 'bluecloth'
+
+module Propaganda
+  class Formatter
+    def format(text, title=nil, engine=nil)
+      case engine
+        when 'markdown'
+          text = BlueCloth.new(text).to_html
+          text = layout(text, title)
+        when 'textile'
+          r = RedCloth.new(text)
+          r.hard_breaks = false
+          text = r.to_html
+          text = layout(text, title)
+        else
+          text
+      end        
+    end
+    
+    private
+    
+    def layout(text, title=nil)
+      "<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>
+          #{text}
+        </body>
+      </html>"
+    end
+  end
+end

data/lib/propaganda.rb

@@ -0,0 +1,28 @@
+require 'propaganda/fop'
+require 'propaganda/formatter'
+
+module Propaganda
+  def self.convert(input, output, title=nil, template=nil, engine=nil, verbose=false)
+    title ||= File.basename(input, File.extname(input))
+    engine ||= detect(input)
+    text = IO.read(input)
+    formatter = Formatter.new
+    text = formatter.format(text, title, engine)
+    fop = Fop.new(verbose)
+    fop.render(text, output, template)
+  end
+  
+  def self.detect(input)
+    case File.extname(input)
+      when '.textile'
+        'textile'
+      when '.markdown', '.md'
+        'markdown'
+      when '.html', '.xhtml'
+        'none'
+      else
+        raise "Unknown format for #{input}, use .html, .textile or .markdown extension"
+    end
+  end
+
+end