clamsy 0.0.4 → 0.0.5

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+examples/tmp

data/HISTORY.txt

@@ -1,3 +1,13 @@
+=== 0.0.5 (May 19, 2010)
+
+* fixed inconsistent ghostscript failure [#ngty]
+* added examples demostrating clamsy in action [#ngty]
+* fixed subtle bugs in multi-printer support in configuration & major cleaning up of configuration spec [#ngty]
+* enhanced bundled configuration support such that it is platform specific (currently only linux & mac are
+  supported though) [#ngty]
+* added new printer 'jod_converter', which is now the default printer (since it has higher chance of working
+  out of the box, as compared to the more-tedious-to-setup 'cups_pdf' printer) [#ngty]
+
 === 0.0.4 (May 04, 2010)
 
 * fixed bug in multiple pictures replacement [#ngty]

data/README.rdoc

@@ -2,15 +2,6 @@
 
 Ruby wrapper for generating a single pdf for multiple contexts from an odt template.
 
-  clamsy = clumsy + shellish
-            |        |
-            |        |-- under the hood, we are making system calls to ooffice &
-            |            cups server needs to be running
-            |
-            |-- setup isn't straight forward, need to install a couple of packages
-                (how bad it is depends on ur platform) & even manual setting up of
-                cups-pdf printer is needed
-
 == 1. Basics
 
 A template odt is just an ordinary odt (http://en.wikipedia.org/wiki/OpenDocument).
@@ -182,68 +173,21 @@ code does the appropriate replacing of images:
 
 == 3. Configuration
 
-=== 3.1. User-defined ~/.clamsy.yml
-
-  printer: cups_pdf
-  cups_pdf:
-    cups_output_dir: /var/spool/cups-pdf/${USER}
-    cups_output_file:
-    ooffice_cmd: ooffice -norestore -nofirststartwizard -nologo -headless -pt Cups-PDF
-
-NOTES:
-* ${...} gets replaced by the corresponding ENV variable, eg. ${USER} gets replaced
-  by ENV['USER']
-* printer ... describes which printer to use (currently, we ONLY have 'cups_pdf')
-* cups_output_dir ... the directory where cups-pdf places the intermediate working pdf,
-  in linux box, it is specifed by the 'Out' variable in /etc/cups/cups-pdf.conf
-* cups_output_file ... specifies the exact intermediate working pdf, when this is
-  specified, cups_output_dir is ignored
-* ooffice_cmd ... the openoffice command & arguments to use
-
-=== 3.2. Clamsy\.configure {|config| ... }
-
-  Clamsy.configure do |config|
-    config.printer = 'another_printer'
-    config.config_file = '/path/to/alternative/clamsy.yml'
-    config.cups_output_dir = '/another/output/dir'
-    config.cups_output_file = lambda { Dir.glob('/yet/another/output/dir/*.pdf').sort.last }
-  end
-
-NOTES:
-* config_file ... alternative user-defined config file, when specified, ~/.clamsy.yml will
-  be ignored (whatever is supported in this config file is exactly the same as 3.1)
-* cups_output_file ... unlike what we have in the yaml config file, this can be either a
-  proc or a string
-
-=== 3.3. Clamsy\.process(...) {|config| ... }
-
-  Clamsy.process(contexts, template_odt, final_pdf) do |config|
-    # the rest is the same as 3.2
-  end
+(see http://wiki.github.com/ngty/clamsy/configuration)
 
 == 4. Pre-requisites
 
-=== 4.1. Archlinux
-
-  * Installing packages:
-    $ sudo pacman -S ghostscript cups cups-pdf go-openoffice
-
-  * Setting up the cups-pdf virtual printer by following instructions @
-    http://wiki.archlinux.org/index.php/CUPS#Configuring_CUPS-PDF_virtual_printer
-
-  * Making sure cups is running:
-    $ sudo /etc/rc.d/cups start
-
-=== 4.2. Ubuntu (to-be-updated)
-
-=== 4.3. Mac (to-be-updated)
+* Make sure openoffice, java & ghostscript are installed
 
 == TODO
 
+* address security risk of user running destructive commands within embedded ruby in odt
+  template
+* support for other platforms (eg. windows & jruby)
+* turn off non-santized ruby expression by default (since the generated doc easily breaks
+  when underlying xml is invalid)
 * automate cups-pdf printer setup
 
-* more printers support (currently, we ONLY have Clamsy::CupsPdfPrinter)
-
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "clamsy"
-    gem.summary = %Q{A clumsily shellish way to generate a single pdf for multiple contexts from an odt template}
-    gem.description = %Q{}
+    gem.summary = %Q{Clamsy makes PDF generation simple}
+    gem.description = %Q{Ruby wrapper for generating a single pdf for multiple contexts from an odt template.}
     gem.email = "ngty77@gmail.com"
     gem.homepage = "http://github.com/ngty/clamsy"
     gem.authors = ["NgTzeYang"]
@@ -14,7 +14,32 @@ begin
     gem.add_dependency "rghost", "= 0.8.7.2"
     gem.add_dependency "nokogiri", "= 1.4.1"
     gem.add_development_dependency "bacon", ">= 1.1.0"
+    gem.add_development_dependency "eventmachine", ">= 0.12.10"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+
+    gem.post_install_message = <<-POST_INSTALL_MESSAGE
+
+  ///////////////////////////////////////////////////////////////////////////////////////////////////
+
+    :: CLAMSY ::
+
+    Thank you for installing clamsy-0.0.5.
+
+    Starting from this release, the default printer has been changed from 'cups_pdf' to
+    'jod_convertor'. If java is in your PATH, and openoffice is installed the standard way,
+    most probably, no additional action is required after this gem installation.
+
+    We are in the process of constructing the clamsy wiki @ http://wiki.github.com/ngty/clamsy, pls
+    take a look there for solution(s) to your problem(s).
+
+    Alternatively, you may wish to post ur problem @ http://github.com/ngty/clamsy/issues.
+
+    Have a nice day !!
+
+  ///////////////////////////////////////////////////////////////////////////////////////////////////
+
+POST_INSTALL_MESSAGE
+
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/clamsy.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{clamsy}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["NgTzeYang"]
-  s.date = %q{2010-05-04}
-  s.description = %q{}
+  s.date = %q{2010-05-19}
+  s.description = %q{Ruby wrapper for generating a single pdf for multiple contexts from an odt template.}
   s.email = %q{ngty77@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -26,14 +26,37 @@ Gem::Specification.new do |s|
      "VERSION",
      "clamsy.gemspec",
      "clamsy.png",
+     "examples/create_many.rb",
+     "examples/create_one.rb",
+     "examples/data/context.rb",
+     "examples/data/contexts.rb",
+     "examples/data/school_logo.jpg",
+     "examples/data/staff_signature.gif",
+     "examples/data/student_offer_letter.odt",
+     "examples/tmp/dummy",
      "lib/clamsy.rb",
      "lib/clamsy.yml",
      "lib/clamsy/base_printer.rb",
      "lib/clamsy/configuration.rb",
      "lib/clamsy/cups_pdf_printer.rb",
      "lib/clamsy/file_system_support.rb",
+     "lib/clamsy/jod_converter_printer.rb",
      "lib/clamsy/template_open_doc.rb",
      "lib/clamsy/tenjin.rb",
+     "lib/jodconverter/CREDIT",
+     "lib/jodconverter/LICENSE.txt",
+     "lib/jodconverter/README.txt",
+     "lib/jodconverter/commons-cli-1.2.jar",
+     "lib/jodconverter/commons-io-1.4.jar",
+     "lib/jodconverter/jodconverter-2.2.2.jar",
+     "lib/jodconverter/jodconverter-cli-2.2.2.jar",
+     "lib/jodconverter/juh-3.0.1.jar",
+     "lib/jodconverter/jurt-3.0.1.jar",
+     "lib/jodconverter/ridl-3.0.1.jar",
+     "lib/jodconverter/slf4j-api-1.5.6.jar",
+     "lib/jodconverter/slf4j-jdk14-1.5.6.jar",
+     "lib/jodconverter/unoil-3.0.1.jar",
+     "lib/jodconverter/xstream-1.3.1.jar",
      "spec/clamsy/base_printer_spec.rb",
      "spec/clamsy/configuration_spec.rb",
      "spec/clamsy/cups_pdf_printer_spec.rb",
@@ -53,7 +76,9 @@ Gem::Specification.new do |s|
      "spec/clamsy/data/plain_text_before.odt",
      "spec/clamsy/file_system_support_spec.rb",
      "spec/clamsy/invalid_printer_spec.rb",
+     "spec/clamsy/jod_converter_printer_spec.rb",
      "spec/clamsy/template_open_doc_spec.rb",
+     "spec/fake_ooffice_server.rb",
      "spec/integration/cups_pdf_printer_spec.rb",
      "spec/integration/data/embedded_ruby_example.odt",
      "spec/integration/data/embedded_ruby_example.pdf",
@@ -67,24 +92,65 @@ Gem::Specification.new do |s|
      "spec/integration/data/plain_text_example.odt",
      "spec/integration/data/plain_text_example.pdf",
      "spec/integration/data/sunny_clamsy.png",
-     "spec/integration/has_stardand_integration_support_shared_spec.rb",
+     "spec/integration/has_integration_support_shared_spec.rb",
+     "spec/integration/jod_converter_printer_spec.rb",
+     "spec/pdfc/CCLib.jar",
+     "spec/pdfc/CREDIT",
+     "spec/pdfc/PDFC.bat",
+     "spec/pdfc/PDFC.jar",
+     "spec/pdfc/PDFC.sh",
+     "spec/pdfc/PDFParser.jar",
+     "spec/pdfc/config.xml",
+     "spec/pdfc/license/LICENSE.log4j",
+     "spec/pdfc/license/lgpl-3.0.txt",
+     "spec/pdfc/license/overview.txt",
+     "spec/pdfc/log4j-1.2.15.jar",
+     "spec/pdfc/readme.txt",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/ngty/clamsy}
+  s.post_install_message = %q{
+  ///////////////////////////////////////////////////////////////////////////////////////////////////
+
+    :: CLAMSY ::
+
+    Thank you for installing clamsy-0.0.5.
+
+    Starting from this release, the default printer has been changed from 'cups_pdf' to
+    'jod_convertor'. If java is in your PATH, and openoffice is installed the standard way,
+    most probably, no additional action is required after this gem installation.
+
+    We are in the process of constructing the clamsy wiki @ http://wiki.github.com/ngty/clamsy, pls
+    take a look there for solution(s) to your problem(s).
+
+    Alternatively, you may wish to post ur problem @ http://github.com/ngty/clamsy/issues.
+
+    Have a nice day !!
+
+  ///////////////////////////////////////////////////////////////////////////////////////////////////
+
+}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
-  s.summary = %q{A clumsily shellish way to generate a single pdf for multiple contexts from an odt template}
+  s.summary = %q{Clamsy makes PDF generation simple}
   s.test_files = [
-    "spec/integration/cups_pdf_printer_spec.rb",
-     "spec/integration/has_stardand_integration_support_shared_spec.rb",
+    "spec/fake_ooffice_server.rb",
+     "spec/integration/jod_converter_printer_spec.rb",
+     "spec/integration/cups_pdf_printer_spec.rb",
+     "spec/integration/has_integration_support_shared_spec.rb",
      "spec/clamsy/file_system_support_spec.rb",
      "spec/clamsy/base_printer_spec.rb",
+     "spec/clamsy/jod_converter_printer_spec.rb",
      "spec/clamsy/cups_pdf_printer_spec.rb",
      "spec/clamsy/invalid_printer_spec.rb",
      "spec/clamsy/configuration_spec.rb",
      "spec/clamsy/template_open_doc_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "examples/create_many.rb",
+     "examples/data/contexts.rb",
+     "examples/data/context.rb",
+     "examples/create_one.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -96,17 +162,20 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<rghost>, ["= 0.8.7.2"])
       s.add_runtime_dependency(%q<nokogiri>, ["= 1.4.1"])
       s.add_development_dependency(%q<bacon>, [">= 1.1.0"])
+      s.add_development_dependency(%q<eventmachine>, [">= 0.12.10"])
     else
       s.add_dependency(%q<rubyzip>, ["= 0.9.4"])
       s.add_dependency(%q<rghost>, ["= 0.8.7.2"])
       s.add_dependency(%q<nokogiri>, ["= 1.4.1"])
       s.add_dependency(%q<bacon>, [">= 1.1.0"])
+      s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
     end
   else
     s.add_dependency(%q<rubyzip>, ["= 0.9.4"])
     s.add_dependency(%q<rghost>, ["= 0.8.7.2"])
     s.add_dependency(%q<nokogiri>, ["= 1.4.1"])
     s.add_dependency(%q<bacon>, [">= 1.1.0"])
+    s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
   end
 end
 

data/examples/create_many.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$current_dir_file = lambda {|f| File.join(File.expand_path(File.dirname(__FILE__)), f) }
+$data_file = lambda {|f| $current_dir_file["data/#{f}"] }
+$tmp_file = lambda {|f| $current_dir_file["tmp/#{f}"] }
+require $data_file['contexts.rb']
+require 'clamsy'
+
+template_doc_path = $data_file['student_offer_letter.odt']
+final_pdf_path = $tmp_file['student_offer_letters.pdf']
+
+print "Generating #{final_pdf_path} ... "
+Clamsy.process($contexts, template_doc_path, final_pdf_path)
+puts "done"

data/examples/create_one.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$current_dir_file = lambda {|f| File.join(File.expand_path(File.dirname(__FILE__)), f) }
+$data_file = lambda {|f| $current_dir_file["data/#{f}"] }
+$tmp_file = lambda {|f| $current_dir_file["tmp/#{f}"] }
+require $data_file['context.rb']
+require 'clamsy'
+
+template_doc_path = $data_file['student_offer_letter.odt']
+final_pdf_path = $tmp_file['student_offer_letter.pdf']
+
+print "Generating #{final_pdf_path} ... "
+Clamsy.process($context, template_doc_path, final_pdf_path)
+puts "done"

data/examples/data/context.rb

@@ -0,0 +1,41 @@
+subject_klass = Struct.new('Subject', :name, :code, :weekly_hours)
+
+subjects = [
+  subject_klass.new('English', 'S001', 10),
+  subject_klass.new('Maths', 'S002', 10),
+  subject_klass.new('Physics', 'S003', 5),
+  subject_klass.new('Chemistry', 'S004', 5),
+  subject_klass.new('Chinese', 'S005', 10),
+]
+
+$context = {
+  :_pictures => {
+    :staff_signature  =>  $data_file['staff_signature.gif'],
+    :school_logo  =>  $data_file['school_logo.jpg'],
+  },
+  :subjects => subjects,
+  :admin_staff_email => "admin@demo.com",
+  :student_address_line_3 => "Jupiter 04771-0130",
+  :school_website => "www.wizardcollege.edu",
+  :student_nric => "S667755161",
+  :course_start_date => "Jan 1, 2010",
+  :serial_number => "00000026",
+  :student_full_name => "Kok Yeow Loh",
+  :school_name => "Wizard College",
+  :course_name => "2 Yr 'O' Level",
+  :school_address_line_1 => "2985 Jalan Timum",
+  :total_weekly_hours => subjects.inject(0) {|sum, s| sum + s.weekly_hours },
+  :student_first_name => "Kok Yeow",
+  :school_telephone => "+65 6511 6833",
+  :date_of_offer => "May 5, 2010",
+  :course_intake => "Jan Intake",
+  :school_address_line_2 => "XYZ Learning Centre",
+  :examination_authority => "UNDEFINED(examination_authority)",
+  :student_address_line_1 => "Blk 151",
+  :school_fax => "+65 6511 6844",
+  :admin_staff_name => "Tan Tze Wei",
+  :school_address_line_3 => "Jupiter 159457",
+  :course_duration => "24 months",
+  :student_address_line_2 => "5921 Albert Village",
+  :school_email => "info@wizardcollege.edu.sg",
+}

data/examples/data/contexts.rb

@@ -0,0 +1,2 @@
+require $data_file['context.rb']
+$contexts = [$context, $context]

data/lib/clamsy.rb

@@ -6,6 +6,8 @@ require 'clamsy/configuration'
 
 module Clamsy
 
+  ROOT = File.expand_path(File.dirname(__FILE__))
+
   class << self
 
     include FileSystemSupport
@@ -32,8 +34,11 @@ module Clamsy
       end
 
       def config
-        @config ||=
-          Configuration.new(File.join(File.dirname(__FILE__), 'clamsy.yml'), true)
+        @config ||= Configuration.new(bundled_config_file, true)
+      end
+
+      def bundled_config_file
+        File.join(Clamsy::ROOT, 'clamsy.yml')
       end
 
       def printer

data/lib/clamsy.yml

@@ -1,8 +1,34 @@
-printer: cups_pdf
-config_file: ~/.clamsy.yml
+######################################################################################
+ #                                   [   Linux   ]                                  #
+######################################################################################
+linux:
+  printer: jod_converter
+  config_file: ~/.clamsy.yml
+  ooffice_bin: ooffice
+  java_bin: java
 
-cups_pdf:
-  cups_output_dir: /var/spool/cups-pdf/${USER}
-  cups_output_file:
-  ooffice_cmd: ooffice -norestore -nofirststartwizard -nologo -headless -pt Cups-PDF
+  jod_converter:
+    ooffice_server_args: -headless -nofirststartwizard -accept="socket,host=localhost,port=8100;urp;StarOffice.Service"
+
+  cups_pdf:
+    cups_output_dir: /var/spool/cups-pdf/${USER}
+    cups_output_file:
+    ooffice_print_args: -norestore -nofirststartwizard -nologo -headless -pt Cups-PDF
+
+######################################################################################
+ #                                   [    Mac    ]                                  #
+######################################################################################
+darwin:
+  printer: jod_converter
+  config_file: ~/.clamsy.yml
+  ooffice_bin: /Applications/OpenOffice.org.app/Contents/MacOS/soffice.bin
+  java_bin: java
+
+  jod_converter:
+    ooffice_server_args: -headless -nofirststartwizard -accept="socket,host=localhost,port=8100;urp;StarOffice.Service" &
+
+  cups_pdf:
+    cups_output_dir: /opt/local/var/spool/cups-pdf/${USER}
+    cups_output_file:
+    ooffice_print_args: -norestore -nofirststartwizard -nologo -headless -pt Cups-PDF