check_writer 0.4.3 → 0.4.4

data/Gemfile

@@ -4,17 +4,15 @@ source "http://rubygems.org"
 #   gem "activesupport", ">= 2.3.5"
 
 gem 'activesupport'
-gem 'prawn'
+gem 'prawn', '>= 0.12.0'
 gem 'linguistics'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem 'appraisal'
   gem 'rake'
   gem "jeweler", "~> 1.8.3"
-  gem 'appraisal'
   gem "rspec", "~> 2.8.0"
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.1.0"
+  gem "bundler", ">= 1.1.0"
 end

data/Gemfile.lock

@@ -1,14 +1,14 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    Ascii85 (1.0.2)
     activesupport (3.2.1)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    appraisal (0.4.1)
-      bundler
-      rake
+    afm (0.2.0)
     diff-lcs (1.1.3)
     git (1.2.5)
+    hashery (2.1.0)
     i18n (0.6.0)
     jeweler (1.8.3)
       bundler (~> 1.0)
@@ -18,17 +18,16 @@ GEM
     json (1.7.1)
     linguistics (1.0.9)
     multi_json (1.1.0)
-    prawn (0.6.1)
-      prawn-core (>= 0.6.1, < 0.7)
-      prawn-format (>= 0.2.2, < 0.3)
-      prawn-layout (>= 0.3.1, < 0.4)
-      prawn-security (>= 0.1.1, < 0.2)
-    prawn-core (0.6.3)
-    prawn-format (0.2.3)
-      prawn-core
-    prawn-layout (0.3.2)
-    prawn-security (0.1.1)
-    rake (0.9.2.2)
+    pdf-reader (1.3.0)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.0)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    prawn (0.12.0)
+      pdf-reader (>= 0.9.0)
+      ttfunk (~> 1.0.2)
+    rake (10.0.3)
     rdoc (3.12)
       json (~> 1.4)
     rspec (2.8.0)
@@ -39,17 +38,18 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    ruby-rc4 (0.1.5)
+    ttfunk (1.0.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activesupport
-  appraisal
-  bundler (~> 1.1.0)
+  bundler (>= 1.1.0)
   jeweler (~> 1.8.3)
   linguistics
-  prawn
+  prawn (>= 0.12.0)
   rake
   rdoc (~> 3.12)
   rspec (~> 2.8.0)

data/README.rdoc

@@ -57,7 +57,7 @@ Here's an example[https://github.com/rylwin/check_writer/raw/master/spec/assets/
 
 It is also possible to include additional data in the stubs in the form of a table. If +with_stubs+ is true,
 then passing a 2D array to +stub_table_data+ will generate a table within each stub. To pass options to Prawn's
-#table method, set +stub_table_options+ with a hash of options.
+#table method, set +stub_table_options+ with a hash of options. You can also use +stub_table_lambda+ to provide a block that is sent to the #table method.
 Example here[https://github.com/rylwin/check_writer/raw/master/spec/assets/with_stub_table_data-0.12.0.pdf].
 
 Instead of just returning a PDF, you can access the Prawn PDF writer object
@@ -76,17 +76,14 @@ reference a JPG or PNG image. The recommended dimensions for a signature image a
 
 If you need a second signature line on the check, +:second_signature_line+ to true.
 
-== Tests
+== Void and Blank Checks
 
-check_writer uses the appraisal gem to facilitate testing of various versions of prawn. To run the tests using appraisal:
+There are times where you may want to print a check that is clearly marked as a
+void check. Setting +void+ to a truish value will place "void" in place of the
+amount, check number, and the signature line.
 
-    $ rake appraisal
-
-Note that if you need modify the Gemfile and need to re-bundle, you will also have to reinstall the appraisal gemfiles as well. To do this, your must first remove the +:development+ group from the Gemfile (i.e., the gems in the development group need to be bundled along with the rest of the gems, so they cannot be isolated in the dev group). Once you have done this, run:
-
-    $ rake appraisal:install
-
-After appraisal installs its gemfiles, you can revert your Gemfile to as it was before.
+If you want the PDF to include everything except the lower one-third of the
+page (the actual check part), set +blank+ to a truish value.
 
 == Contributing to check_writer
 

data/Rakefile

@@ -10,7 +10,6 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-require 'appraisal'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.4.4

data/check_writer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "check_writer"
-  s.version = "0.4.3"
+  s.version = "0.4.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Winograd"]
-  s.date = "2012-12-12"
+  s.date = "2013-03-08"
   s.description = "Ruby library for generating PDF checks that you can take to the bank"
   s.email = "ryan@thewinograds.com"
   s.extra_rdoc_files = [
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
-    "Appraisals",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -27,34 +26,19 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "check_writer.gemspec",
-    "gemfiles/prawn0.12.0.gemfile",
-    "gemfiles/prawn0.12.0.gemfile.lock",
-    "gemfiles/prawn0.6.1.gemfile",
-    "gemfiles/prawn0.6.1.gemfile.lock",
-    "gemfiles/prawn0.6.3.gemfile",
-    "gemfiles/prawn0.6.3.gemfile.lock",
     "lib/check_writer.rb",
     "lib/check_writer/attribute_formatting.rb",
     "lib/check_writer/check.rb",
+    "spec/assets/blank-0.12.0.pdf",
     "spec/assets/sample-signature.png",
     "spec/assets/test-0.12.0.pdf",
-    "spec/assets/test-0.6.1.pdf",
-    "spec/assets/test-0.6.3.pdf",
     "spec/assets/two_in_one-0.12.0.pdf",
-    "spec/assets/two_in_one-0.6.1.pdf",
-    "spec/assets/two_in_one-0.6.3.pdf",
+    "spec/assets/void-0.12.0.pdf",
     "spec/assets/with_second_signature_line-0.12.0.pdf",
-    "spec/assets/with_second_signature_line-0.6.1.pdf",
-    "spec/assets/with_second_signature_line-0.6.3.pdf",
     "spec/assets/with_signature_image-0.12.0.pdf",
-    "spec/assets/with_signature_image-0.6.1.pdf",
-    "spec/assets/with_signature_image-0.6.3.pdf",
     "spec/assets/with_stub_table_data-0.12.0.pdf",
-    "spec/assets/with_stub_table_data-0.6.1.pdf",
-    "spec/assets/with_stub_table_data-0.6.3.pdf",
     "spec/assets/with_stubs-0.12.0.pdf",
-    "spec/assets/with_stubs-0.6.1.pdf",
-    "spec/assets/with_stubs-0.6.3.pdf",
+    "spec/assets/with_two_thirds_stub-0.12.0.pdf",
     "spec/check_spec.rb",
     "spec/spec_helper.rb",
     "vendor/GnuMICR-0.30/AUTHORS",
@@ -86,38 +70,32 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<prawn>, [">= 0"])
+      s.add_runtime_dependency(%q<prawn>, [">= 0.12.0"])
       s.add_runtime_dependency(%q<linguistics>, [">= 0"])
-      s.add_development_dependency(%q<appraisal>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_development_dependency(%q<appraisal>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.1.0"])
     else
       s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<prawn>, [">= 0"])
+      s.add_dependency(%q<prawn>, [">= 0.12.0"])
       s.add_dependency(%q<linguistics>, [">= 0"])
-      s.add_dependency(%q<appraisal>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_dependency(%q<appraisal>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<bundler>, [">= 1.1.0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<prawn>, [">= 0"])
+    s.add_dependency(%q<prawn>, [">= 0.12.0"])
     s.add_dependency(%q<linguistics>, [">= 0"])
-    s.add_dependency(%q<appraisal>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    s.add_dependency(%q<appraisal>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<bundler>, [">= 1.1.0"])
   end
 end
 

data/lib/check_writer/attribute_formatting.rb

@@ -21,6 +21,7 @@ module CheckWriter
     #
     # amount = 1000 => $1,000.00
     def formatted_amount
+      return "VOID" if void
       separated_dollars = dollars.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
       cents_string = (cents < 10) ? "0#{cents}" : cents
       "$#{separated_dollars}.#{cents_string}"
@@ -30,7 +31,8 @@ module CheckWriter
     #
     # amount = 1.12 => One Dollar and Twelve Cents
     def amount_in_words
-      # Wrap cents in string before calling numwords to avoid 
+      return "VOID" if void
+      # Wrap cents in string before calling numwords to avoid
       # SafeBuffer cannot modify string in place error
       cents = "#{self.cents}".en.numwords
 

data/lib/check_writer/check.rb

@@ -5,22 +5,30 @@ module CheckWriter
 
     include CheckWriter::AttributeFormatting
 
+    STUB_FORMATS = [:one_third, :two_thirds]
+
     attr_accessor :number, :date,
       :payee_name, :payor_name,
       :payee_address, :payor_address,
       :bank_name, :bank_address, :bank_fraction,
       :routing_number, :account_number,
-      :amount, :memo,
+      :amount, :memo, :void, :blank,
       :with_stubs, :stub_table_data, :stub_table_options,
+      :stub_table_lambda,
       :second_signature_line,
-      :signature_image_file
+      :signature_image_file,
+      :stub_format
 
     def initialize(attributes={})
       attributes.reverse_merge!(
         :date => Date.today,
+        :void => false,
+        :blank => false,
         :with_stubs => false,
         :stub_table_data => [],
-        :stub_table_options => {}
+        :stub_table_options => {},
+        :stub_table_lambda => nil,
+        :stub_format => :one_third
       )
 
       _assign_attributes(attributes)
@@ -43,6 +51,14 @@ module CheckWriter
       @pdf
     end
 
+    def stub_format=(val)
+      if !STUB_FORMATS.include?(val.to_sym)
+        raise "Invalid stub_format '#{val}'. Must be one of #{STUB_FORMATS}."
+      end
+
+      @stub_format = val
+    end
+
     private
 
     def _assign_attributes(attr)
@@ -56,7 +72,7 @@ module CheckWriter
 
       if with_stubs
         check_stub(true) # top 1/3 stub
-        check_stub(false) # middle 1/3 stub
+        check_stub(false) if stub_format == :one_third # middle 1/3 stub
       end
 
       @pdf.bounding_box [@pdf.bounds.left,@pdf.bounds.top - extra_top_margin_height - box_height*2 - between_box_height*2],
@@ -72,7 +88,20 @@ module CheckWriter
         _payee_address
         signature
         micr
-        end
+
+        if void
+          if Gem::Version.new(Prawn::VERSION) >= Gem::Version.new("0.12.0")
+            @pdf.draw_text "VOID",
+              :at => [@pdf.bounds.left + 400, @pdf.bounds.top - 200],
+              :size => 40
+          else
+            @pdf.text "VOID",
+              :at => [@pdf.bounds.left + 400, @pdf.bounds.top - 200],
+              :size => 40
+          end
+        end # end void
+
+      end unless blank # end check bounding box
 
       # calling stroke here seems to flush the writer. When we don't call stroke, some lines aren't output
       @pdf.stroke
@@ -167,7 +196,7 @@ module CheckWriter
       box_at = [@pdf.bounds.right - inches(2.5), @pdf.bounds.bottom + inches(0.7)]
       sig_at = [@pdf.bounds.right - inches(2.5), @pdf.bounds.bottom + inches(0.7) + 40]
 
-      @pdf.image @signature_image_file, :at => sig_at if @signature_image_file
+      @pdf.image @signature_image_file, :scale => 0.25, :at => sig_at if @signature_image_file
 
       second_sig_box_at = box_at.dup
       second_sig_box_at[1] += inches(0.6)
@@ -194,7 +223,7 @@ module CheckWriter
     def check_stub(top_stub=true)
       check_number(!top_stub)
       top = top_stub ? @pdf.bounds.top - extra_top_margin_height : @pdf.bounds.top - extra_top_margin_height - box_height - between_box_height
-      @pdf.bounding_box [@pdf.bounds.left, top], :width => @pdf.bounds.right - @pdf.bounds.left, :height => box_height do
+      @pdf.bounding_box [@pdf.bounds.left, top], :width => @pdf.bounds.right - @pdf.bounds.left, :height => stub_height do
         @pdf.stroke_bounds
 
         stub_table
@@ -206,26 +235,14 @@ module CheckWriter
       unless stub_table_data.empty?
         width = @pdf.bounds.right - @pdf.bounds.left
 
-        # Pass different default options to #table depending on version of
-        # prawn being used
-        if Gem.loaded_specs["prawn"].version <= Gem::Version.new('0.6.3')
-          headers = stub_table_data.shift
+        opts = stub_table_options.reverse_merge(
+          :header => true,
+          :width => width
+        )
 
-          opts = stub_table_options.reverse_merge(
-            :headers => headers,
-            :border_style => :underline_header,
-            :width => width
-          )
-
-          @pdf.table(stub_table_data, opts)
-
-          stub_table_data.insert(0, headers)
+        if stub_table_lambda
+          @pdf.table(stub_table_data, opts, &stub_table_lambda)
         else
-          opts = stub_table_options.reverse_merge(
-            :header => true,
-            :width => width
-          )
-
           @pdf.table(stub_table_data, opts)
         end
       end
@@ -243,6 +260,15 @@ module CheckWriter
       180 # 2.5in
     end
 
+    def stub_height
+      case stub_format
+      when :one_third
+        box_height
+      when :two_thirds
+        box_height * 2.5
+      end
+    end
+
     def between_box_height
       54 # 3/4in
     end

data/spec/assets/blank-0.12.0.pdf

@@ -0,0 +1,177 @@
+%PDF-1.3
+%����
+1 0 obj
+<< /Creator <feff0050007200610077006e>
+/Producer <feff0050007200610077006e>
+>>
+endobj
+2 0 obj
+<< /Type /Catalog
+/Pages 3 0 R
+>>
+endobj
+3 0 obj
+<< /Type /Pages
+/Count 1
+/Kids [5 0 R]
+>>
+endobj
+4 0 obj
+<< /Length 1432
+>>
+stream
+q
+
+BT
+484.008 733.884 Td
+/F1.0 12 Tf
+[<43686563> 20 <6b204e6f> 40 <2e203132333435>] TJ
+ET
+
+36.000 540.000 540.000 180.000 re
+S
+36.000 576.000 m
+576.000 576.000 l
+
+BT
+44 561.384 Td
+/F1.0 12 Tf
+[<50> 40 <61> 30 <79> 20 <6f72> -30 <3a2050> 40 <61> 30 <79> 20 <6f7220436f6d70616e> 15 <79204e616d65>] TJ
+ET
+
+
+BT
+44 547.512 Td
+/F1.0 12 Tf
+[<50> 40 <61> 30 <79> 20 <65653a204a6f686e20536d697468>] TJ
+ET
+
+432.000 576.000 m
+432.000 540.000 l
+
+BT
+447.324 561.384 Td
+/F1.0 12 Tf
+[<416d6f756e74>] TJ
+ET
+
+
+BT
+441.312 547.512 Td
+/F1.0 12 Tf
+[<24312c3030332e3233>] TJ
+ET
+
+504.000 576.000 m
+504.000 540.000 l
+
+BT
+527.328 561.384 Td
+/F1.0 12 Tf
+[<44617465>] TJ
+ET
+
+
+BT
+509.976 547.512 Td
+/F1.0 12 Tf
+[<30372f30352f32303132>] TJ
+ET
+
+
+BT
+484.008 504.384 Td
+/F1.0 12 Tf
+[<43686563> 20 <6b204e6f> 40 <2e203132333435>] TJ
+ET
+
+36.000 306.000 540.000 180.000 re
+S
+36.000 342.000 m
+576.000 342.000 l
+
+BT
+44 327.384 Td
+/F1.0 12 Tf
+[<50> 40 <61> 30 <79> 20 <6f72> -30 <3a2050> 40 <61> 30 <79> 20 <6f7220436f6d70616e> 15 <79204e616d65>] TJ
+ET
+
+
+BT
+44 313.512 Td
+/F1.0 12 Tf
+[<50> 40 <61> 30 <79> 20 <65653a204a6f686e20536d697468>] TJ
+ET
+
+432.000 342.000 m
+432.000 306.000 l
+
+BT
+447.324 327.384 Td
+/F1.0 12 Tf
+[<416d6f756e74>] TJ
+ET
+
+
+BT
+441.312 313.512 Td
+/F1.0 12 Tf
+[<24312c3030332e3233>] TJ
+ET
+
+504.000 342.000 m
+504.000 306.000 l
+
+BT
+527.328 327.384 Td
+/F1.0 12 Tf
+[<44617465>] TJ
+ET
+
+
+BT
+509.976 313.512 Td
+/F1.0 12 Tf
+[<30372f30352f32303132>] TJ
+ET
+
+S
+Q
+
+endstream
+endobj
+5 0 obj
+<< /Type /Page
+/Parent 3 0 R
+/MediaBox [0 0 612.0 792.0]
+/Contents 4 0 R
+/Resources << /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
+/Font << /F1.0 6 0 R
+>>
+>>
+>>
+endobj
+6 0 obj
+<< /Type /Font
+/Subtype /Type1
+/BaseFont /Helvetica
+/Encoding /WinAnsiEncoding
+>>
+endobj
+xref
+0 7
+0000000000 65535 f 
+0000000015 00000 n 
+0000000109 00000 n 
+0000000158 00000 n 
+0000000215 00000 n 
+0000001699 00000 n 
+0000001877 00000 n 
+trailer
+<< /Size 7
+/Root 2 0 R
+/Info 1 0 R
+>>
+startxref
+1974
+%%EOF