check_writer 0.0.0 → 0.1.0

data/README.rdoc

@@ -2,16 +2,26 @@
 
 A ruby gem to help generate checks in PDF format.
 
+It generates PDF checks that look something 
+like this[https://github.com/rylwin/check_writer/raw/master/spec/assets/test-0.12.0.pdf].
+Print that PDF on check stock and you've got yourself a real check.
+
 == Project Status
 
-A version of this code has been used in a production application for a couple of years and we are finally getting around to extracting the check writing code. As we go through this process, there may be significant changes to the API. You've been warned.
+A version of this code has been used in a production application for a couple of years 
+and we are finally getting around to extracting the check writing code. As we go through this 
+process, there may be significant changes to the API. You've been warned.
 
 Currently the only check stock format that is supported is the 1/3 bottom check. 
-You can get some check stock at Amazon[http://www.amazon.com/gp/product/B002HIV1KQ/ref=as_li_qf_sp_asn_il_tl?ie=UTF8&tag=checkwriter-20&linkCode=as2&camp=1789&creative=9325&creativeASIN=B002HIV1KQ], amongst other places.
+You can get some check stock at 
+Amazon[http://www.amazon.com/gp/product/B002HIV1KQ/ref=as_li_qf_sp_asn_il_tl?ie=UTF8&tag=checkwriter-20&linkCode=as2&camp=1789&creative=9325&creativeASIN=B002HIV1KQ],
+amongst other places.
 
 == GnuMICR
 
-check_writer uses GnuMICR (http://www.sandeen.net/GnuMICR) to print the MICR numbers at the bottom of the check. Please read the notes on the GnuMICR site. We have not had any issues using this font (2+ years now), but that is no guarantee.
+check_writer uses GnuMICR (http://www.sandeen.net/GnuMICR) to print the MICR numbers at the 
+bottom of the check. Please read the notes on the GnuMICR site. We have not 
+had any issues using this font (2+ years now), but that is no guarantee.
 
 == Example
 
@@ -38,7 +48,18 @@ check_writer uses GnuMICR (http://www.sandeen.net/GnuMICR) to print the MICR num
 
   check.to_pdf # returns PDF file data
 
-Check out spec/assets to see what the output looks like.
+If you set the +with_stubs+ option to +true+ you'll get a bit of formatting
+and information displayed in the top and middle check stub. 
+Here's an example[https://github.com/rylwin/check_writer/raw/master/spec/assets/test-0.12.0.pdf].
+
+Instead of just returning a PDF, you can access the Prawn PDF writer object 
+(Prawn::Document), which you can use to further customize the check or even 
+include multiple checks on the same PDF:
+
+  pdf = check1.to_prawn
+  pdf.start_new_page # this is a prawn method
+  pdf = check2.to_prawn(pdf)
+  pdf.render # returns the PDF data for a PDF w/ two checks on two pages
 
 == Tests
 

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/check_writer.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "check_writer"
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Winograd"]
@@ -34,10 +34,17 @@ Gem::Specification.new do |s|
     "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/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/with_stubs-0.12.0.pdf",
+    "spec/assets/with_stubs-0.6.1.pdf",
+    "spec/assets/with_stubs-0.6.3.pdf",
     "spec/check_spec.rb",
     "spec/spec_helper.rb",
     "vendor/GnuMICR-0.30/AUTHORS",

data/lib/check_writer.rb

@@ -6,4 +6,5 @@ Linguistics::use( :en )
 
 dir = File.dirname(__FILE__) + '/check_writer'
 MICR_FONT = "#{dir}/../../vendor/GnuMICR-0.30/GnuMICR.ttf"
+require "#{dir}/attribute_formatting"
 require "#{dir}/check"

data/lib/check_writer/attribute_formatting.rb

@@ -0,0 +1,46 @@
+module CheckWriter
+
+  # Provides formatting methods for Check attributes
+  module AttributeFormatting
+
+    # Returns an integer representing the number of cents of the amount
+    #
+    # amount = 3.23 => 23
+    def cents
+      ((amount.to_f - dollars) * 100).to_i
+    end
+
+    # Returns an integer representing the number of dollars of the amount
+    #
+    # amount = 3.23 => 3
+    def dollars
+      amount.to_i
+    end
+
+    # Formats the amount as currency
+    #
+    # amount = 1000 => $1,000.00
+    def formatted_amount
+      separated_dollars = dollars.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+      "$#{separated_dollars}.#{cents}"
+    end
+
+    # Converts numeric amount of the check into words.
+    #
+    # amount = 1.12 => One Dollar and Twelve Cents
+    def amount_in_words
+      # Wrap cents in string before calling numwords to avoid 
+      # SafeBuffer cannot modify string in place error
+      cents = "#{self.cents}".en.numwords
+
+      "#{dollars.en.numwords} Dollars and #{cents} Cents".titleize
+    end
+
+    # Formats date
+    def formatted_date
+      date.strftime('%B %e, %Y')
+    end
+
+  end
+
+end

data/lib/check_writer/check.rb

@@ -1,53 +1,42 @@
 module CheckWriter
 
+  # Check generates checks as a PDF
   class Check
 
+    include CheckWriter::AttributeFormatting
+
     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,
+      :with_stubs
 
     def initialize(attributes={})
-      _assign_attributes(attributes)
-    end
+      attributes.reverse_merge!(
+        :date => Date.today,
+        :with_stubs => false
+      )
 
-    def date
-      @date||Date.today
+      _assign_attributes(attributes)
     end
 
-    # Returns an integer representing the number of cents of the amount
-    #
-    # amount = 3.23 => 23
-    def cents
-      ((amount.to_f - dollars) * 100).to_i
+    # Renders the check as a pdf and returns the pdf data
+    def to_pdf
+      to_prawn.render
     end
 
-    # Returns an integer representing the number of dollars of the amount
+    # Renders the check and returns the Prawn::Document for 
+    # further manipulation.
     #
-    # amount = 3.23 => 3
-    def dollars
-      amount.to_i
-    end
-
-    def formatted_amount
-      separated_dollars = dollars.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
-      "$#{separated_dollars}.#{cents}"
-    end
-
-    def amount_in_words
-      # Wrap cents in string before calling numwords to avoid 
-      # SafeBuffer cannot modify string in place error
-      cents = "#{self.cents}".en.numwords
-
-      "#{dollars.en.numwords} Dollars and #{cents} Cents".titleize
-    end
-
-    def to_pdf
-      @pdf = Prawn::Document.new(:bottom_margin => 0.0)
+    # To use an existing Prawn::Document, pass this in as the
+    # +pdf+ argument. If +pdf+ is nil, a new Prawn::Document
+    # will be created.
+    def to_prawn(pdf=nil)
+      @pdf = pdf||Prawn::Document.new(:bottom_margin => 0.0)
       _generate_check_pdf
-      @pdf.render
+      @pdf
     end
 
     private
@@ -60,8 +49,11 @@ module CheckWriter
 
     def _generate_check_pdf
       @pdf.move_down(between_box_height/4.0)
-      #check_stub(true)
-      #check_stub(false)
+
+      if with_stubs
+        check_stub(true) # top 1/3 stub
+        check_stub(false) # 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], 
         :width => @pdf.bounds.right - @pdf.bounds.left, :height => check_box_height do
@@ -72,7 +64,6 @@ module CheckWriter
 
         bank
         payor
-        #property_name
         date_and_amount_and_memo
         _payee_address
         signature
@@ -92,48 +83,29 @@ module CheckWriter
       return [@pdf.bounds.left, center_y + 2], [@pdf.bounds.right, center_y + 2]
     end
 
-    def info_box(title, value, width, offset = 0)
-      @pdf.bounding_box [@pdf.bounds.left + 8 + offset, @pdf.bounds.top - 2], :width => width - 8 do
-        @pdf.text title, :align => :center 
-        @pdf.move_down 4
-        @pdf.text "#{value}"  
-        @pdf.line center_of_box
-      end  
-    end
-
-    def box_info_row
-      info_box("Property Name", @check.property.name, inches(3.25))
-      info_box("Apt #", @check.unit.unit_number, inches(0.75), inches(3.25))
-      info_box("Description", "Deposit Refund", inches(1.5), inches(4.0))
-      info_box("Move-Out", @check.lease.move_out_date.to_s(:mdy), inches(1), inches(5.5)) if @check.lease.move_out_date
-      info_box("Amount", c(@check.amount), inches(1), inches(6.5))
-    end
-
-    def box_info_block
-      @pdf.bounding_box [@pdf.bounds.left + 8, @pdf.bounds.top - inches(0.55)], :width => inches(7) do
-        @pdf.text "Movein Date: #{@check.lease.move_in_date.to_time.to_s(:mdy)}" if @check.lease.move_in_date
-        @pdf.text "Moveout Notice: #{@check.lease.move_out_notice_date.to_time.to_s(:mdy)}" if @check.lease.move_out_notice_date
-        @pdf.text "Lease Exp. Date: #{@check.lease.expiration_date.to_time.to_s(:mdy)}" if @check.lease.expiration_date
-        @pdf.text "Term: #{@check.lease.term}" 
-        @pdf.text "Moveout Date: #{@check.lease.move_out_date.to_time.to_s(:mdy)}" if @check.lease.move_out_date
-        @pdf.text "Moveout Reason: #{@check.lease.move_out_reason}" if @check.lease.move_out_reason
-        @pdf.text "Processed By: #{@check.refund.employee}" if @check.refund.employee
-        @pdf.text("STOP PAYMENT ON CHECK NO. #{@check.original_check.check_number}", :align => :center) if @check.original_check.present?
-      end
-    end
-
     def box_bottom_row
+      # Payor and payee names
       @pdf.move_to [@pdf.bounds.left, inches(0.5)]
       @pdf.line_to [@pdf.bounds.right, inches(0.5)]
       @pdf.bounding_box [@pdf.bounds.left + 8, inches(0.5) - 6], :width => inches(6.75) do
-        @pdf.text "Payor: #{@check.property}"
-        @pdf.text "Payee: #{@check.lease.signers.join(", ")}"
+        @pdf.text "Payor: #{payor_name}"
+        @pdf.text "Payee: #{payee_name}"
       end
+
+      # Amount
+      @pdf.move_to [@pdf.bounds.right - inches(2), inches(0.5)]
+      @pdf.line_to [@pdf.bounds.right - inches(2), 0]
+      @pdf.bounding_box [@pdf.bounds.left + inches(5.5), inches(0.5) - 6], :width => inches(1), :height => inches(0.5) do
+        @pdf.text "Amount", :align => :center
+        @pdf.text formatted_amount, :align => :center
+      end
+
+      # Check date
       @pdf.move_to [@pdf.bounds.right - inches(1), inches(0.5)]
       @pdf.line_to [@pdf.bounds.right - inches(1), 0]
       @pdf.bounding_box [@pdf.bounds.left + inches(6.5), inches(0.5) - 6], :width => inches(1), :height => inches(0.5) do
         @pdf.text "Date", :align => :center
-        @pdf.text "#{@check.date.to_time.to_s(:mdy) if @check.date}", :align => :center
+        @pdf.text formatted_date, :align => :center
       end
     end
 
@@ -162,15 +134,9 @@ module CheckWriter
       end
     end
 
-    def property_name
-      @pdf.bounding_box [@pdf.bounds.left + inches(0.5), @pdf.bounds.top - inches(0.85)], :width => inches(3.5) do
-        @pdf.text @check.property.name, :font_size => 14
-      end
-    end
-
     def date_and_amount_and_memo
       @pdf.bounding_box [@pdf.bounds.left + inches(4.5), @pdf.bounds.top - inches(1.25)], :width => inches(1) do
-        @pdf.text date.strftime('%B %e, %Y')
+        @pdf.text formatted_date
       end
       @pdf.bounding_box [@pdf.bounds.right - inches(1) - 4, @pdf.bounds.top - inches(1.25)], :width => inches(1) do
         @pdf.text formatted_amount, :align => :right    
@@ -212,8 +178,6 @@ module CheckWriter
       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.stroke_bounds
-        box_info_row
-        box_info_block if top_stub
         box_bottom_row
       end
     end

data/spec/check_spec.rb

@@ -17,6 +17,7 @@ describe "CheckWriter::Check" do
     ]
 
     @check = CheckWriter::Check.new(
+      :date => Date.parse('5/7/2012'),
       :number => '12345',
       :payee_name => 'John Smith',
       :payee_address => payee_address,
@@ -54,4 +55,36 @@ describe "CheckWriter::Check" do
     assert_data_matches_file_content('test', data)
   end
 
+  context "with stubs" do
+    before(:each) do
+      @check.with_stubs = true
+      @data = @check.to_pdf
+    end
+
+    it "generates a pdf with check stubs stroked and some basic info" do
+      # Use this line to re-write the PDF we test against
+      # write_content_to_file('with_stubs', @data)
+
+      assert_data_matches_file_content('with_stubs', @data)
+    end
+  end
+
+  context "#to_prawn" do
+    it "returns a prawn object" do
+      @check.to_prawn.should be_a_kind_of(Prawn::Document)
+    end
+
+    it "can be used to print multiple checks" do
+      pdf = @check.to_prawn
+      pdf.start_new_page
+      pdf = @check.to_prawn(pdf)
+      @data = pdf.render
+
+      # Use this line to re-write the PDF we test against
+      # write_content_to_file('two_in_one', @data)
+
+      assert_data_matches_file_content('two_in_one', @data)
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: check_writer
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ryan Winograd
@@ -205,10 +205,17 @@ files:
 - 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/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/with_stubs-0.12.0.pdf
+- spec/assets/with_stubs-0.6.1.pdf
+- spec/assets/with_stubs-0.6.3.pdf
 - spec/check_spec.rb
 - spec/spec_helper.rb
 - vendor/GnuMICR-0.30/AUTHORS