clamsy 0.0.3 → 0.0.4

data/spec/clamsy/cups_pdf_printer_spec.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'clamsy', 'cups_pdf_printer')
+
+class << Clamsy::CupsPdfPrinter
+  public :tmp_pdf_path
+  attr_accessor :config
+end
+
+describe 'Cups pdf printer' do
+
+  before do
+    @printer = Clamsy::CupsPdfPrinter
+    @printer.config = Class.new { attr_accessor :cups_output_dir, :cups_output_file }.new
+  end
+
+  describe '> generating of tmp pdf path (using config.cups_output_file)' do
+
+    should 'return config.cups_output_file if it is not a Proc' do
+      @printer.config.cups_output_file = '/a/b/c'
+      @printer.tmp_pdf_path('dummy').should.equal '/a/b/c'
+    end
+
+    should "return evaluated config.cups_output_file if it is a Proc" do
+      @printer.config.cups_output_file = lambda { "/a/b/#{1+2}" }
+      @printer.tmp_pdf_path('dummy').should.equal '/a/b/3'
+    end
+
+  end
+
+  describe '> generating of tmp pdf path (using config.cups_output_file)' do
+
+    should "use config.cups_output_dir, basename of specified file & pdf file extension" do
+      @printer.config.cups_output_dir = '/a/b/c'
+      @printer.tmp_pdf_path('/e/f/g/document').should.equal '/a/b/c/document.pdf'
+    end
+
+  end
+
+end
+

data/spec/clamsy/file_system_support_spec.rb

@@ -0,0 +1,93 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+class FSSInstance
+  include Clamsy::FileSystemSupport
+  def trashable_tmp_files
+    @trashable_tmp_files || []
+  end
+end
+
+describe 'File system support (ensuring file exists)' do
+
+  before do
+    @instance = FSSInstance.new
+    @missing_file = "#{__FILE__}.x"
+    @check_test_passes_and_completes_in_n_secs = lambda do |seconds_to_wait, test_proc|
+      started_at = Time.now
+      test_proc.call
+      (Time.now - started_at).to_i.should.equal seconds_to_wait
+    end
+  end
+
+  describe '> when given N seconds to wait' do
+
+    it 'should wait & raise Clamsy::FileNotFoundError if file eventually does not exist' do
+      @check_test_passes_and_completes_in_n_secs[
+        seconds_to_wait = 2, lambda do
+          lambda { @instance.file_must_exist!(@missing_file, seconds_to_wait) }.
+            should.raise(Clamsy::FileNotFoundError).
+            message.should.equal("File '#{@missing_file}' not found.")
+        end
+      ]
+    end
+
+    it 'should wait & not raise Clamsy::FileNotFoundError if file eventually exists' do
+      # Hmm ... don't really know how to test this yet.
+      true.should.be.true
+    end
+
+  end
+
+  describe '> when not given any seconds to wait' do
+
+    it 'should immediately raise Clamsy::FileNotFoundError if file does not exist' do
+      @check_test_passes_and_completes_in_n_secs[
+        seconds_to_wait = 0, lambda do
+          lambda { @instance.file_must_exist!(@missing_file) }.
+            should.raise(Clamsy::FileNotFoundError).
+            message.should.equal("File '#{@missing_file}' not found.")
+        end
+      ]
+    end
+
+    it 'should not raise Clamsy::FileNotFoundError if file exists' do
+      @check_test_passes_and_completes_in_n_secs[
+        seconds_to_wait = 0,
+        lambda { @instance.file_must_exist!(__FILE__) }
+      ]
+    end
+
+  end
+
+end
+
+describe 'File system support (trashable temp files)' do
+
+  before do
+    @instance = FSSInstance.new
+  end
+
+  it 'should always return a new temp file upon request' do
+    (file = @instance.tmp_file).class.should.equal Tempfile
+  end
+
+  it 'should support customizing of name of requested temp file' do
+    (file = @instance.tmp_file('zzyyxx')).class.should.equal Tempfile
+    file.path.should.match(/zzyyxx/)
+  end
+
+  it 'should cache newly requested temp file' do
+    orig_count = @instance.trashable_tmp_files.size
+    file = @instance.tmp_file
+    @instance.trashable_tmp_files.size.should.equal orig_count.succ
+    file.path.should.equal @instance.trashable_tmp_files[-1].path
+  end
+
+  it 'should support trashing/deleting all previously requested temp files' do
+    (0..1).each {|_| @instance.tmp_file }
+    orig_count = @instance.trashable_tmp_files.size
+    @instance.trash_tmp_files
+    @instance.trashable_tmp_files.should.be.empty
+  end
+
+end

data/spec/clamsy/invalid_printer_spec.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+class InvalidPrinter < Clamsy::BasePrinter ; end
+
+describe 'Invalid printer' do
+
+  describe '> converting docs to pdf' do
+
+    behaves_like 'has standard files support'
+
+    it 'should raise Clamsy::ImplementationNotFoundError' do
+      tmp_doc = tmp_file('doc')
+      lambda { InvalidPrinter.docs_to_pdf([tmp_doc], "#{__FILE__}.pdf") }.
+        should.raise(Clamsy::ImplementationNotFoundError).
+        message.should.equal("InvalidPrinter.doc_to_pdf not implemented.")
+    end
+
+  end
+
+end
+

data/spec/clamsy/template_open_doc_spec.rb

@@ -0,0 +1,95 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe 'Template open doc' do
+
+  before do
+    @data_file = lambda {|file| File.join(File.dirname(__FILE__), 'data', file) }
+  end
+
+  describe '> initializing' do
+
+    it 'should raise Clamsy::FileNotFoundError template doc cannot be found' do
+      missing_template = @data_file['missing.odt']
+      lambda { Clamsy::TemplateOpenDoc.new(missing_template) }.
+        should.raise(Clamsy::FileNotFoundError).
+        message.should.equal("File '#{missing_template}' not found.")
+    end
+
+    it 'should raise Clamsy::TemplateDocIsCorruptedError if template doc is not a valid document' do
+      invalid_template = @data_file['invalid_zip_example.odt']
+      lambda { Clamsy::TemplateOpenDoc.new(invalid_template) }.
+        should.raise(Clamsy::TemplateDocIsCorruptedError).
+        message.should.equal("Template doc '#{invalid_template}' is corrupted.")
+    end
+
+    it 'should raise Clamsy::TemplateDocContentIsCorruptedError if template doc has invalid content' do
+      invalid_template = @data_file['invalid_content_example.odt']
+      lambda { Clamsy::TemplateOpenDoc.new(invalid_template) }.
+        should.raise(Clamsy::TemplateDocContentIsCorruptedError).
+        message.should.equal("Template doc content '#{invalid_template}'/'content.xml' is corrupted.")
+    end
+
+  end
+
+  describe '> rendering' do
+
+    before do
+      @zip_content = lambda {|file| Zip::ZipFile.open(file).map {|e| e.get_input_stream.read } }
+      @template = lambda {|name| Clamsy::TemplateOpenDoc.new(@data_file["#{name}_before.odt"]) }
+      @check_rendering_yields_expected_doc = lambda do |context, example|
+        generated_content = @zip_content[@template[example].render(context).path]
+        expected_content = @zip_content[@data_file["#{example}_after.odt"]]
+        (generated_content - expected_content).should.be.empty
+        (expected_content - generated_content).should.be.empty
+      end
+    end
+
+    it 'should return instance of Tempfile for generated doc' do
+      file = @template[:plain_text].render({})
+      file.class.should.equal Tempfile
+    end
+
+    it 'should do #{...} plain text replacement' do
+      @check_rendering_yields_expected_doc[
+        context = {:someone => 'Peter', :mood => 'Happy'},
+        example = :plain_text
+      ]
+    end
+
+    it 'should do ${...} escaped (santized) replacement' do
+      @check_rendering_yields_expected_doc[
+        context = {:someone => '<Peter>', :mood => '<Happy>'},
+        example = :escaped_text
+      ]
+    end
+
+    it 'should do {? ... ?} embedded ruby statements processing' do
+      @check_rendering_yields_expected_doc[
+        context = {
+          :everyone => [
+            {:name => 'Peter', :mood => 'Happy'},
+            {:name => 'Jane', :mood => 'Sad'}
+          ]
+        },
+        example = :embedded_ruby
+      ]
+    end
+
+    it 'should do picture replacement for pictures with matching names' do
+      @check_rendering_yields_expected_doc[
+        context = {:_pictures => {:to_be_replaced_pic => @data_file['clamsy.png']}},
+        example = :picture
+      ]
+    end
+
+    it 'should raise Clamsy::RenderedDocContentIsCorruptedError if rendering yields invalid content' do
+      lambda {
+        @template[:plain_text].render(:someone => '<Peter>', :mood => '<Happy>')
+      }.should.raise(Clamsy::RenderedDocContentIsCorruptedError).message.should.equal(
+        'Rendered doc content is corrupted, use ${ ... } where text escaping is needed.'
+      )
+    end
+
+  end
+
+end

data/spec/{clamsy_spec.rb → integration/cups_pdf_printer_spec.rb}

@@ -1,13 +1,16 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require File.join(File.dirname(__FILE__), 'has_stardand_integration_support_shared_spec')
 
-describe "Clamsy" do
+describe "Clamsy (using Cups-PDF printer)" do
 
   behaves_like 'has standard files support'
+  behaves_like 'has standard integration support'
 
   before do
     @check_processing_yields_content = lambda do |contexts, example|
       generated_pdf = tmp_file('clamsy_pdf').path
-      Clamsy.process(contexts, template_odt(example), generated_pdf)
+      Clamsy.process(contexts, template_doc(example), generated_pdf)
+      `cp #{generated_pdf} /tmp/abc.pdf`
       expected_content = comparable_content(expected_pdf(example))
       generated_content = comparable_content(generated_pdf)
       generated_content.size.should.equal expected_content.size
@@ -19,9 +22,12 @@ describe "Clamsy" do
     trash_tmp_files
   end
 
-  it 'should do picture replacement for matching <draw:frame draw:name="..." />' do
+  it 'should do picture replacement for pictures with matching names' do
     @check_processing_yields_content[
-      context = {:_pictures => {:to_be_replaced_pic => data_file('clamsy.png')}},
+      context = {:_pictures => {
+        :sunny_clamsy => data_file('norm_clamsy.png'),
+        :norm_clamsy => data_file('sunny_clamsy.png'),
+      }},
       example = :picture
     ]
   end
@@ -40,7 +46,7 @@ describe "Clamsy" do
     ]
   end
 
-  it 'should do {? ... ?} embedded ruby statements' do
+  it 'should do {? ... ?} embedded ruby statements processing' do
     @someone = Class.new do
       attr_reader :name, :mood
       def initialize(name, mood)

data/spec/integration/has_stardand_integration_support_shared_spec.rb

@@ -0,0 +1,27 @@
+shared 'has standard integration support' do
+  class << self
+
+    INSIGNIFICANT_AND_UNMATCHABLE_PATTERNS = [
+      /^q\[\-?\d+\.?\d*( \-?\d+\.?\d*){5}\]concat\n$/,
+      /^\d+\.?\d*( \d+\.?\d*){3} re\n$/
+    ]
+
+    def data_file(file)
+      File.join(File.dirname(__FILE__), 'data', file)
+    end
+
+    def template_doc(name)
+      data_file("#{name}_example.odt")
+    end
+
+    def expected_pdf(name)
+      data_file("#{name}_example.pdf")
+    end
+
+    def comparable_content(file)
+      RGhost::Convert.new(file).to(:ps).read.grep(/^[^%][^%]?/).
+        reject {|line| INSIGNIFICANT_AND_UNMATCHABLE_PATTERNS.any? {|regexp| regexp =~ line } }
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'bacon'
 require 'differ'
 require 'tempfile'
 require 'digest/md5'
+require 'yaml'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -10,37 +11,12 @@ require 'clamsy'
 
 shared 'has standard files support' do
   class << self
-
-    INSIGNIFICANT_AND_UNMATCHABLE_PATTERNS = [
-      /^q\[\-?\d+\.?\d*( \-?\d+\.?\d*){5}\]concat\n$/,
-      /^\d+\.?\d*( \d+\.?\d*){3} re\n$/
-    ]
-
-    def data_file(file)
-      File.join(File.dirname(__FILE__), 'data', file)
-    end
-
-    def template_odt(name)
-      data_file("#{name}_example.odt")
-    end
-
-    def expected_pdf(name)
-      data_file("#{name}_example.pdf")
-    end
-
-    def comparable_content(file)
-      RGhost::Convert.new(file).to(:ps).read.grep(/^[^%][^%]?/).
-        reject {|line| INSIGNIFICANT_AND_UNMATCHABLE_PATTERNS.any? {|regexp| regexp =~ line } }
-    end
-
     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
-
   end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - NgTzeYang
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-25 00:00:00 +08:00
+date: 2010-05-04 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -92,21 +92,49 @@ files:
 - 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
 has_rdoc: true
 homepage: http://github.com/ngty/clamsy
@@ -139,5 +167,12 @@ signing_key:
 specification_version: 3
 summary: A clumsily shellish way to generate a single pdf for multiple contexts from an odt template
 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