clamsy 0.0.3 → 0.0.4

data/HISTORY.txt

@@ -1,3 +1,10 @@
+=== 0.0.4 (May 04, 2010)
+
+* fixed bug in multiple pictures replacement [#ngty]
+* support for configuring clamsy (see README section 3) [#jasonong & #ngty]
+* clamsy now has a logo (<PROJECT_ROOT>/clamsy.png) [#zhenyi]
+* well-prepared for alternative printers support [#ngty]
+
 === 0.0.3 (Apr 25, 2010)
 
 * support to replace pictures (useful for inserting digital signatures) [#ngty]

data/README.rdoc

@@ -22,9 +22,9 @@ template engine (http://www.kuwata-lab.com/tenjin) to do the rendering. The foll
 is all u need to know to write odt templates:
 
 * '{? ... ?}' represents embedded Ruby statement (this differs from vanilla tenjin)
-* '#{ ... }' represents embedded Ruby expression
 * '${ ... }' represents embedded Ruby expression which is to be escaped
   (eg. '& < > "' are escaped to '&amp; &lt; &gt; &quot;')
+* '#{ ... }' represents embedded Ruby expression (u should really avoid using this)
 
 == 2. Examples
 
@@ -33,15 +33,15 @@ is all u need to know to write odt templates:
 Template Odt:
 
   --------------------------------------------
-   #{@company_full_name}
-   #{@company_address_line_1}
-   #{@company_address_line_2}
+   ${@company_full_name}
+   ${@company_address_line_1}
+   ${@company_address_line_2}
 
    S/N  Item Description       Amount (SGD)
    {? @items.each_with_index do |item, i| ?}
-   #{i+1} #{item.description}  #{amount}
+   ${i+1} ${item.description}  ${amount}
    {? end ?}
-                        Total  #{total}
+                        Total  ${total}
   ----------------------------------- Page 1 -
 
 Code:
@@ -180,9 +180,50 @@ code does the appropriate replacing of images:
     path_to_final_pdf    # eg. '/tmp/confession.pdf'
   )
 
-== 3. Pre-requisites
+== 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.1. Archlinux
+=== 3.3. Clamsy\.process(...) {|config| ... }
+
+  Clamsy.process(contexts, template_odt, final_pdf) do |config|
+    # the rest is the same as 3.2
+  end
+
+== 4. Pre-requisites
+
+=== 4.1. Archlinux
 
   * Installing packages:
     $ sudo pacman -S ghostscript cups cups-pdf go-openoffice
@@ -193,17 +234,15 @@ code does the appropriate replacing of images:
   * Making sure cups is running:
     $ sudo /etc/rc.d/cups start
 
-=== 3.2. Ubuntu (to-be-updated)
+=== 4.2. Ubuntu (to-be-updated)
 
-=== 3.3. Mac (to-be-updated)
+=== 4.3. Mac (to-be-updated)
 
 == TODO
 
-* add support for configuration, eg. Clamsy.configure {|config| ... }
-
-* automate cups-pdf printer setup or have ooffice directly export odt to pdf
+* automate cups-pdf printer setup
 
-* avoid making system call to 'ooffice'
+* more printers support (currently, we ONLY have Clamsy::CupsPdfPrinter)
 
 == Note on Patches/Pull Requests
 
@@ -219,7 +258,9 @@ code does the appropriate replacing of images:
 
 Written 2010 by:
 
-#1. NgTzeYang, contact ngty77[at]gmail.com or http://github.com/ngty
+1. NgTzeYang, contact http://github.com/ngty
+2. JasonOng, contact http://github.com/jasonong
+3. ZhenyiTan, contact http://github.com/zhenyi
 
 Released under the MIT license
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/clamsy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{clamsy}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["NgTzeYang"]
-  s.date = %q{2010-04-25}
+  s.date = %q{2010-05-04}
   s.description = %q{}
   s.email = %q{ngty77@gmail.com}
   s.extra_rdoc_files = [
@@ -25,21 +25,49 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "clamsy.gemspec",
+     "clamsy.png",
      "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/template_open_doc.rb",
      "lib/clamsy/tenjin.rb",
-     "spec/clamsy_spec.rb",
-     "spec/data/clamsy.png",
-     "spec/data/clamsy2.png",
-     "spec/data/embedded_ruby_example.odt",
-     "spec/data/embedded_ruby_example.pdf",
-     "spec/data/escaped_text_example.odt",
-     "spec/data/escaped_text_example.pdf",
-     "spec/data/multiple_contexts_example.odt",
-     "spec/data/multiple_contexts_example.pdf",
-     "spec/data/picture_example.odt",
-     "spec/data/picture_example.pdf",
-     "spec/data/plain_text_example.odt",
-     "spec/data/plain_text_example.pdf",
+     "spec/clamsy/base_printer_spec.rb",
+     "spec/clamsy/configuration_spec.rb",
+     "spec/clamsy/cups_pdf_printer_spec.rb",
+     "spec/clamsy/data/clamsy.png",
+     "spec/clamsy/data/clamsy2.png",
+     "spec/clamsy/data/embedded_ruby_after.odt",
+     "spec/clamsy/data/embedded_ruby_before.odt",
+     "spec/clamsy/data/escaped_text_after.odt",
+     "spec/clamsy/data/escaped_text_before.odt",
+     "spec/clamsy/data/invalid_content_example.odt",
+     "spec/clamsy/data/invalid_zip_example.odt",
+     "spec/clamsy/data/multiple_contexts_after.odt",
+     "spec/clamsy/data/multiple_contexts_before.odt",
+     "spec/clamsy/data/picture_after.odt",
+     "spec/clamsy/data/picture_before.odt",
+     "spec/clamsy/data/plain_text_after.odt",
+     "spec/clamsy/data/plain_text_before.odt",
+     "spec/clamsy/file_system_support_spec.rb",
+     "spec/clamsy/invalid_printer_spec.rb",
+     "spec/clamsy/template_open_doc_spec.rb",
+     "spec/integration/cups_pdf_printer_spec.rb",
+     "spec/integration/data/embedded_ruby_example.odt",
+     "spec/integration/data/embedded_ruby_example.pdf",
+     "spec/integration/data/escaped_text_example.odt",
+     "spec/integration/data/escaped_text_example.pdf",
+     "spec/integration/data/multiple_contexts_example.odt",
+     "spec/integration/data/multiple_contexts_example.pdf",
+     "spec/integration/data/norm_clamsy.png",
+     "spec/integration/data/picture_example.odt",
+     "spec/integration/data/picture_example.pdf",
+     "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/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/ngty/clamsy}
@@ -48,7 +76,14 @@ Gem::Specification.new do |s|
   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.test_files = [
-    "spec/clamsy_spec.rb",
+    "spec/integration/cups_pdf_printer_spec.rb",
+     "spec/integration/has_stardand_integration_support_shared_spec.rb",
+     "spec/clamsy/file_system_support_spec.rb",
+     "spec/clamsy/base_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"
   ]
 

data/lib/clamsy.rb

@@ -1,142 +1,45 @@
-require 'ftools'
-require 'digest/md5'
-require 'tempfile'
-require 'nokogiri'
-require 'zip/zip'
 require 'clamsy/tenjin'
-require 'rghost'
+require 'clamsy/file_system_support'
+require 'clamsy/base_printer'
+require 'clamsy/template_open_doc'
+require 'clamsy/configuration'
 
 module Clamsy
 
-  class MissingFileError < Exception ; end
-
   class << self
 
-    def process(contexts, template_odt, final_pdf)
-      begin
-        @template_odt = TemplateOdt.new(template_odt)
-        odts = [contexts].flatten.map {|ctx| @template_odt.render(ctx) }
-        Shell.print_odts_to_pdf(odts, final_pdf)
-      ensure
-        @template_odt.trash_tmp_files
-      end
-    end
-
-  end
-
-  private
-
-    module HasTrashableTempFiles
-
-      def trash_tmp_files
-        (@trashable_tmp_files || []).select {|f| f.path }.map(&:unlink)
-      end
-
-      def tmp_file(file_name)
-        ((@trashable_tmp_files ||= []) << Tempfile.new(file_name))[-1]
-      end
+    include FileSystemSupport
 
+    def configure(&blk)
+      yield(config)
     end
 
-    class TemplateOdt
-
-      include HasTrashableTempFiles
-
-      def initialize(template_odt)
-        @template_odt = template_odt
-      end
-
-      def render(context)
-        @context_id = Digest::MD5.hexdigest(context.to_s)
-        Zip::ZipFile.open(working_odt.path) do |@zip|
-          @zip.select {|entry| entry.file? && entry.to_s =~ /\.xml$/ }.each do |entry|
-            @zip.get_output_stream(entry.to_s) {|io| io.write(workers[entry].render(context)) }
-            replace_pictures(entry, context[:_pictures] || {})
-          end
-        end
-        working_odt
-      end
-
-      private
-
-        def replace_pictures(entry, pictures)
-          xpaths = lambda {|name| %\//drawframe[@drawname="#{name}"]/drawimage/@xlinkhref\ }
-          doc = Nokogiri::XML(entry.get_input_stream.read.gsub(':','')) # Hack to avoid namespace error
-          pictures.each do |name, path|
-            (node = doc.xpath(xpaths[name])[0]) && @zip.replace(node.value, path)
-          end
-        end
-
-        def working_odt
-          (@working_odts ||= {})[@context_id] ||=
-            begin
-              dest_odt = tmp_file(@context_id)
-              File.copy(@template_odt, dest_odt.path) ; dest_odt
-            end
-        end
-
-        def workers
-          lambda do |entry|
-            (@workers ||= {})[entry.to_s] ||=
-              begin
-                tmp_file = tmp_file("#{@context_id}.#{File.basename(entry.to_s)}")
-                tmp_file.write(entry.get_input_stream.read)
-                tmp_file.close
-                Tenjin::Template.new(tmp_file.path)
-              end
-          end
-        end
-
+    def process(contexts, template_doc, final_pdf, &blk)
+      block_given? && configure(&blk)
+      generate_pdf(contexts, template_doc, final_pdf)
     end
 
-    class Shell
-
-      # The folder where cups-pdf generated pdfs are stored:
-      # * in archlinux, this is specified in /etc/cups/cups-pdf.conf
-      PDF_OUTPUT_DIR = "/tmp/cups-pdf/#{`whoami`.strip}"
-
-      # The openoffice command to print odt to pdf, requires package cups-pdf & 'Cups-PDF' printer
-      # to be set up in cups.
-      ODT_TO_PDF_CMD = "ooffice -norestore -nofirststartwizard -nologo -headless -pt Cups-PDF"
+    private
 
-      class << self
-
-        include HasTrashableTempFiles
-
-        def print_odts_to_pdf(from_odts, to_pdf)
-          begin
-            tmp_ps = tmp_file(File.basename(to_pdf, '.pdf'))
-            from_odts.map {|odt| tmp_ps << odt_to_ps_stream(odt) }
-            tmp_ps.close
-            gs_convert(:pdf, tmp_ps.path, to_pdf)
-          ensure
-            trash_tmp_files
-          end
+      def generate_pdf(contexts, template_doc, final_pdf)
+        begin
+          @template_doc = TemplateOpenDoc.new(template_doc)
+          docs = [contexts].flatten.map {|ctx| @template_doc.render(ctx) }
+          printer.docs_to_pdf(docs, final_pdf)
+        ensure
+          @template_doc.trash_tmp_files
         end
+      end
 
-        private
-
-          def odt_to_ps_stream(odt)
-            ensure_file_exists!(odt_path = odt.path)
-            pdf_path = File.join(PDF_OUTPUT_DIR, File.basename(odt_path, '.odt')) + '.pdf'
-            system("#{ODT_TO_PDF_CMD} #{odt_path}")
-            gs_convert(:ps, pdf_path)
-          end
-
-          def gs_convert(format, src_path, dest_path=nil)
-            ensure_file_exists!(src_path)
-            method, opts = dest_path ? [:path, {:filename => dest_path}] : [:read, {}]
-            RGhost::Convert.new(src_path).to(format, opts).send(method)
-          end
-
-          def ensure_file_exists!(file_path)
-            exist_flg = false
-            0.upto(10) {|i| File.exists?(file_path) ? (exist_flg = true; break) : sleep(1) }
-            exist_flg or raise MissingFileError.new(file_path)
-          end
+      def config
+        @config ||=
+          Configuration.new(File.join(File.dirname(__FILE__), 'clamsy.yml'), true)
+      end
 
+      def printer
+        Clamsy::BasePrinter.get(config.printer, config)
       end
 
-    end
+  end
 
 end

data/lib/clamsy.yml

@@ -0,0 +1,8 @@
+printer: cups_pdf
+config_file: ~/.clamsy.yml
+
+cups_pdf:
+  cups_output_dir: /var/spool/cups-pdf/${USER}
+  cups_output_file:
+  ooffice_cmd: ooffice -norestore -nofirststartwizard -nologo -headless -pt Cups-PDF
+

data/lib/clamsy/base_printer.rb

@@ -0,0 +1,64 @@
+require 'rghost'
+
+module Clamsy
+
+  class ImplementationNotFoundError < Exception ; end
+  class PrinterNotFoundError < Exception ; end
+
+  class BasePrinter
+    class << self
+
+      include Clamsy::FileSystemSupport
+      attr_reader :subclasses, :config
+
+      def docs_to_pdf(from_docs, to_pdf)
+        begin
+          tmp_ps = tmp_file(File.basename(to_pdf, '.pdf'))
+          from_docs.map {|doc| tmp_ps << doc_to_ps_stream(doc.path) }
+          tmp_ps.close
+          gs_convert(:pdf, tmp_ps.path, to_pdf)
+        ensure
+          trash_tmp_files
+        end
+      end
+
+      def get(name, config)
+        begin
+          require File.join(File.dirname(__FILE__), "#{name}_printer.rb")
+          printer = self.subclasses[name.gsub(/[^a-zA-Z0-9]/,'').downcase]
+          printer.configure(config) ; printer
+        rescue Exception
+          raise PrinterNotFoundError.new("Printer '#{name}' cannot be found.")
+        end
+      end
+
+      protected
+
+        def doc_to_ps_stream(doc_path)
+          file_must_exist!(doc_path)
+          gs_convert(:ps, doc_to_pdf(doc_path))
+        end
+
+        def configure(config)
+          @config = config
+        end
+
+        def doc_to_pdf(doc_path)
+          raise Clamsy::ImplementationNotFoundError.new("#{self.to_s}.doc_to_pdf not implemented.")
+        end
+
+        def gs_convert(format, src_path, dest_path=nil)
+          file_must_exist!(src_path)
+          method, opts = dest_path ? [:path, {:filename => dest_path}] : [:read, {}]
+          RGhost::Convert.new(src_path).to(format, opts).send(method)
+        end
+
+        def inherited(subclass)
+          key = "#{subclass}".sub(/Clamsy::(\w+)Printer/,'\1').downcase
+          (@subclasses ||= {})[key] = subclass
+        end
+
+    end
+
+  end
+end