payday 1.0.0beta5 → 1.0.0beta6

data/Gemfile

@@ -2,8 +2,3 @@ source "http://rubygems.org"
 
 gemspec
 
-group :development do
-  gem "rake"
-  gem "yard"
-end
-

data/README.md

@@ -29,9 +29,10 @@ Documentation
 ===
 Documentation for the latest version of Payday is available at [rdoc.info](http://rdoc.info/github/commondream/payday/v1.0.0beta5/frames).
 
-Customizing Your Logo and Company Name
+Customizing Your Invoice
 ===
-Check out Payday::Config to customize your company's name, details, and logo.
+Payday::Config includes quite a few options for customizing your invoices, such as options for customizing the logo and
+company details on the invoice.
 
 Example:
 
@@ -98,12 +99,36 @@ In your controller:
     respond_to do |format|
       format.html
       format.pdf do
-        send_data invoice.render_pdf, :filename => "Invoice #12.pdf", :type => "application/pdf", :disposition => :inline
+        send_data invoice.render_pdf, :filename => "Invoice #12.pdf", :type => "application/pdf", :disposition => "inline"
       end
     end
 
 Be sure to restart your server after you edit the mime_types initializer. The updated setting won't take effect until you do.
 
+I18n
+===
+Payday uses the i18n gem to provide support for custom labels and internationalized applications. You can change the default labels by
+adding a YAML file in the `config/locales` directory of your Rails app. Here are the default labels you can customize :
+  
+    payday:
+      status:
+        paid: PAID
+        overdue: OVERDUE
+      invoice:
+        bill_to: Bill To
+        ship_to: Ship To
+        invoice_no: "Invoice #:"
+        due_date: "Due Date:"
+        paid_date: "Paid Date:"
+        subtotal: "Subtotal:"
+        tax: "Tax:"
+        total: "Total:"
+      line_item:
+        description: Description
+        unit_price: Unit Price
+        quantity: Quantity
+        amount: Amount
+
 Examples
 ===
 Here's an [example PDF Invoice](https://github.com/downloads/commondream/payday/example.pdf)
@@ -114,6 +139,12 @@ Contributing
 ===
 Payday is pretty young, so there's still a good bit of work to be done. I highly recommend sending me a message on GitHub before making too many changes, just to make sure that two folks aren't doing the same work, but beyond that feel free to fork the project, make some changes, and send a pull request. If you're unsure about what to work on but would like to help, send me a message on GitHub. I'd love the help!
 
+We've had some awesome contributers:
+
+* Sam Pizzey ([pizzeys](http://github.com/pizzeys))
+* Andrew Nordman ([cadwallion](http://github.com/cadwallion))
+* Pierre Olivier Martel ([pomartel](http://github.com/pomartel))
+
 To Do
 ===
 Here's what we're planning on working on with Payday in the near future:
@@ -127,7 +158,6 @@ Here's what we're planning on working on with Payday in the near future:
 * Add support for indented line items
 * Apply different tax rates to different line items
 * Add support for shipping either pre or post tax
-* Add ability to set pdf document size to something other than 8.5 x 11
 * Add invoice_details has for stuff under the invoice number
 * Add ability to show skus or product ids on each line item
 

data/lib/payday.rb

@@ -1,13 +1,14 @@
 # Not much to see here
 require 'date'
+require 'time'
 require 'bigdecimal'
 require 'prawn'
 require 'money'
 
-require File.join(File.dirname(__FILE__), "payday", "version")
-require File.join(File.dirname(__FILE__), "payday", "config")
-require File.join(File.dirname(__FILE__), "payday", "line_itemable")
-require File.join(File.dirname(__FILE__), "payday", "line_item")
-require File.join(File.dirname(__FILE__), "payday", "pdf_renderer")
-require File.join(File.dirname(__FILE__), "payday", "invoiceable")
-require File.join(File.dirname(__FILE__), "payday", "invoice")
+require 'payday/version'
+require 'payday/config'
+require 'payday/line_itemable'
+require 'payday/line_item'
+require 'payday/pdf_renderer'
+require 'payday/invoiceable'
+require 'payday/invoice'

data/lib/payday/config.rb

@@ -1,10 +1,15 @@
 module Payday
   
   # Configuration for Payday. This is a singleton, so to set the company_name you would call
-  # +Payday::Config.default.company_name = "Awesome Corp"+.
+  # Payday::Config.default.company_name = "Awesome Corp".
   class Config
     attr_accessor :invoice_logo, :company_name, :company_details, :date_format, :currency
     
+    # Sets the page size to use. See the 
+    # {http://prawn.majesticseacreature.com/docs/0.10.2/Prawn/Document/PageGeometry.html Prawn documentation} for valid 
+    # page_size values.
+    attr_accessor :page_size
+    
     # Returns the default configuration instance
     def self.default
       @@default ||= new
@@ -17,6 +22,7 @@ module Payday
         self.company_details = "awesomecorp@commondream.net"
         self.date_format = "%B %e, %Y"
         self.currency = "USD"
+        self.page_size = "LETTER"
       end
   end
-end
+end

data/lib/payday/invoice.rb

@@ -4,7 +4,7 @@ module Payday
   class Invoice
     include Payday::Invoiceable
     
-    attr_accessor :invoice_number, :bill_to, :ship_to, :notes, :line_items, :tax_rate, :tax_description, :due_at, :paid_at
+    attr_accessor :invoice_number, :bill_to, :ship_to, :notes, :line_items, :tax_rate, :tax_description, :due_at, :paid_at, :currency
     
     def initialize(options =  {})
       self.invoice_number = options[:invoice_number] || nil
@@ -16,6 +16,7 @@ module Payday
       self.tax_description = options[:tax_description] || nil
       self.due_at = options[:due_at] || nil
       self.paid_at = options[:paid_at] || nil
+      self.currency = options[:currency] || nil
     end
     
     # The tax rate that we're applying, as a BigDecimal    

data/lib/payday/pdf_renderer.rb

@@ -16,11 +16,11 @@ module Payday
   
     private
       def self.pdf(invoice)
-        pdf = Prawn::Document.new
+        pdf = Prawn::Document.new(:page_size => invoice_or_default(invoice, :page_size))
 
         # set up some default styling
         pdf.font_size(8)
-
+        
         stamp(invoice, pdf)
         company_banner(invoice, pdf)
         bill_to_ship_to(invoice, pdf)
@@ -35,9 +35,9 @@ module Payday
       def self.stamp(invoice, pdf)
         stamp = nil
         if invoice.paid?
-          stamp = "PAID"
+          stamp = I18n.t 'payday.status.paid', :default => "PAID"
         elsif invoice.overdue?
-          stamp = "OVERDUE"
+          stamp = I18n.t 'payday.status.overdue', :default => "OVERDUE"
         end
 
         if stamp
@@ -57,14 +57,14 @@ module Payday
         logo_info = pdf.image(invoice_or_default(invoice, :invoice_logo), :at => pdf.bounds.top_left)
         
         # render the company details
-        company_details = invoice_or_default(invoice, :company_details)
-        company_details = company_details.lines.inject("") { |combined, line| combined << line.strip }
-        
         table_data = []
         table_data << [bold_cell(pdf, invoice_or_default(invoice, :company_name).strip, :size => 12)]
-        table_data << [company_details]
-        table = pdf.make_table(table_data, :cell_style => { :borders => [], :padding => [2, 0] })
-        pdf.bounding_box([pdf.bounds.width - table.width, pdf.bounds.top], :width => table.width, :height => table.height) do
+        
+        company_details = invoice_or_default(invoice, :company_details)
+        company_details = company_details.lines.each { |line| table_data << [line] }
+        
+        table = pdf.make_table(table_data, :cell_style => { :borders => [], :padding => 0 })
+        pdf.bounding_box([pdf.bounds.width - table.width, pdf.bounds.top], :width => table.width, :height => table.height + 5) do
           table.draw
         end
         
@@ -77,14 +77,15 @@ module Payday
         
         # render bill to
         pdf.float do
-          table = pdf.table([[bold_cell(pdf, "Bill To")], [invoice.bill_to]], :column_widths => [200], :cell_style => bill_to_cell_style)
+          table = pdf.table([[bold_cell(pdf, I18n.t('payday.invoice.bill_to', :default => "Bill To"))], 
+              [invoice.bill_to]], :column_widths => [200], :cell_style => bill_to_cell_style)
           bill_to_ship_to_bottom = pdf.cursor
         end
 
         # render ship to
         if defined?(invoice.ship_to)
-          table = pdf.make_table([[bold_cell(pdf, "Ship To")], [invoice.ship_to]], :column_widths => [200],
-              :cell_style => bill_to_cell_style)
+          table = pdf.make_table([[bold_cell(pdf, I18n.t('payday.invoice.ship_to', :default => "Ship To"))], 
+              [invoice.ship_to]], :column_widths => [200], :cell_style => bill_to_cell_style)
           
           pdf.bounding_box([pdf.bounds.width - table.width, pdf.cursor], :width => table.width, :height => table.height + 2) do
             table.draw
@@ -102,7 +103,8 @@ module Payday
 
         # invoice number
         if defined?(invoice.invoice_number) && invoice.invoice_number
-          table_data << [bold_cell(pdf, "Invoice #:"), bold_cell(pdf, invoice.invoice_number.to_s, :align => :right)]
+          table_data << [bold_cell(pdf, I18n.t('payday.invoice.invoice_no', :default => "Invoice #:")), 
+              bold_cell(pdf, invoice.invoice_number.to_s, :align => :right)]
         end
 
         # Due on
@@ -113,7 +115,8 @@ module Payday
             due_date = invoice.due_at.to_s
           end
 
-          table_data << [bold_cell(pdf, "Due Date:"), bold_cell(pdf, due_date, :align => :right)]
+          table_data << [bold_cell(pdf, I18n.t('payday.invoice.due_date', :default => "Due Date:")), 
+              bold_cell(pdf, due_date, :align => :right)]
         end
 
         # Paid on
@@ -124,27 +127,29 @@ module Payday
             paid_date = invoice.paid_at.to_s
           end
 
-          table_data << [bold_cell(pdf, "Paid Date:"), bold_cell(pdf, paid_date, :align => :right)]
+          table_data << [bold_cell(pdf, I18n.t('payday.invoice.paid_date', :default => "Paid Date:")), 
+              bold_cell(pdf, paid_date, :align => :right)]
         end
 
         if table_data.length > 0
-          pdf.table(table_data, :cell_style => { :borders => [], :padding => 1 })
+          pdf.table(table_data, :cell_style => { :borders => [], :padding => [1, 10, 1, 1] })
         end
       end
       
       def self.line_items_table(invoice, pdf)
         table_data = []
-        table_data << [bold_cell(pdf, "Description", :borders => []), 
-            bold_cell(pdf, "Unit Price", :align => :center, :borders => []), 
-            bold_cell(pdf, "Quantity", :align => :center, :borders => []), 
-            bold_cell(pdf, "Amount", :align => :center, :borders => [])]
+        table_data << [bold_cell(pdf, I18n.t('payday.line_item.description', :default => "Description"), :borders => []), 
+            bold_cell(pdf, I18n.t('payday.line_item.unit_price', :default => "Unit Price"), :align => :center, :borders => []), 
+            bold_cell(pdf, I18n.t('payday.line_item.quantity', :default => "Quantity"), :align => :center, :borders => []), 
+            bold_cell(pdf, I18n.t('payday.line_item.amount', :default => "Amount"), :align => :center, :borders => [])]
         invoice.line_items.each do |line|
           table_data << [line.description, number_to_currency(line.price, invoice), BigDecimal.new(line.quantity.to_s).to_s("F"),
               number_to_currency(line.amount, invoice)]
         end
 
         pdf.move_cursor_to(pdf.cursor - 20)
-        pdf.table(table_data, :width => pdf.bounds.width, :header => true, :cell_style => {:border_width => 0.5, :border_color => "cccccc", :padding => [5, 10]},
+        pdf.table(table_data, :width => pdf.bounds.width, :header => true, 
+            :cell_style => {:border_width => 0.5, :border_color => "cccccc", :padding => [5, 10]},
             :row_colors => ["dfdfdf", "ffffff"]) do
           # left align the number columns
           columns(1..3).rows(1..row_length - 1).style(:align => :right)
@@ -159,9 +164,11 @@ module Payday
       
       def self.totals_lines(invoice, pdf)
         table_data = []
-        table_data << [bold_cell(pdf, "Subtotal:"), cell(pdf, number_to_currency(invoice.subtotal, invoice), :align => :right)]
-        table_data << [bold_cell(pdf, "Tax:"), cell(pdf, number_to_currency(invoice.tax, invoice), :align => :right)]
-        table_data << [bold_cell(pdf, "Total:", :size => 12), 
+        table_data << [bold_cell(pdf, I18n.t('payday.invoice.subtotal', :default => "Subtotal:")), 
+            cell(pdf, number_to_currency(invoice.subtotal, invoice), :align => :right)]
+        table_data << [bold_cell(pdf, I18n.t('payday.invoice.tax', :default => "Tax:")), 
+            cell(pdf, number_to_currency(invoice.tax, invoice), :align => :right)]
+        table_data << [bold_cell(pdf, I18n.t('payday.invoice.total', :default => "Total:"), :size => 12), 
             cell(pdf, number_to_currency(invoice.total, invoice), :size => 12, :align => :right)]
         table = pdf.make_table(table_data, :cell_style => { :borders => [] })
         pdf.bounding_box([pdf.bounds.width - table.width, pdf.cursor], :width => table.width, :height => table.height + 2) do
@@ -173,7 +180,7 @@ module Payday
         if defined?(invoice.notes) && invoice.notes
           pdf.move_cursor_to(pdf.cursor - 30)
           pdf.font("Helvetica-Bold") do
-            pdf.text("Notes")
+            pdf.text(I18n.t('payday.invoice.notes', :default => "Notes"))
           end
           pdf.line_width = 0.5
           pdf.stroke_color = "cccccc"
@@ -221,4 +228,4 @@ module Payday
         max
       end
   end
-end
+end

data/lib/payday/version.rb

@@ -2,5 +2,5 @@
 module Payday
   
   # Current Version
-  VERSION = "1.0.0beta5"
+  VERSION = "1.0.0beta6"
 end

data/payday.gemspec

@@ -14,6 +14,9 @@ Gem::Specification.new do |s|
 
   s.add_dependency("prawn", "~> 0.11.1.pre")
   s.add_dependency("money", "~> 3.6.1")
+  s.add_dependency("i18n", "~> 0.5.0")
+
+  s.add_development_dependency("minitest")
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/test/invoice_test.rb

@@ -1,7 +1,8 @@
-require "test/test_helper"
+require File.expand_path("test/test_helper")
 
 module Payday
-  class InvoiceTest < Test::Unit::TestCase
+  class InvoiceTest < MiniTest::Unit::TestCase
+    
     test "that setting values through the options hash on initialization works" do
       i = Invoice.new(:invoice_number => 20, :bill_to => "Here", :ship_to => "There",
           :notes => "These are some notes.",
@@ -94,6 +95,8 @@ module Payday
           :due_at => Date.civil(2011, 1, 22), :paid_at => Date.civil(2012, 2, 22),
           :bill_to => "Alan Johnson\n101 This Way\nSomewhere, SC 22222", :ship_to => "Frank Johnson\n101 That Way\nOther, SC 22229")
       
+      Payday::Config.default.company_details = "10 This Way\nManhattan, NY 10001\n800-111-2222\nawesome@awesomecorp.com"
+      
       3.times do
         i.line_items << LineItem.new(:price => 20, :quantity => 5, :description => "Pants")
         i.line_items << LineItem.new(:price => 10, :quantity => 3, :description => "Shirts")
@@ -115,7 +118,7 @@ module Payday
         i.line_items << LineItem.new(:price => 5, :quantity => 200.0, :description => "Hats")
       end
 
-      assert_not_nil i.render_pdf
+      refute_nil i.render_pdf
     end
   end
 end

data/test/line_item_test.rb

@@ -1,7 +1,7 @@
-require "test/test_helper"
+require File.expand_path("test/test_helper")
 
 module Payday
-  class LineItemTest < Test::Unit::TestCase
+  class LineItemTest < MiniTest::Unit::TestCase
     test "initializing with a price" do
       li = LineItem.new(:price => BigDecimal.new("20"))
       assert_equal BigDecimal.new("20"), li.price

data/test/test_helper.rb

@@ -1,11 +1,11 @@
-require File.join(File.dirname(__FILE__), "..", "lib", "payday")
+require File.expand_path('lib/payday')
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'date'
 require 'time'
 
 # Shamelessly ripped from jm's context library: https://github.com/jm/context/blob/master/lib/context/test.rb
-class Test::Unit::TestCase
+class MiniTest::Unit::TestCase
   class << self
     # Create a test method.  +name+ is a native-language string to describe the test
     # (e.g., no more +test_this_crazy_thing_with_underscores+).

metadata

@@ -1,15 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: payday
 version: !ruby/object:Gem::Version 
-  hash: 62196361
   prerelease: 5
-  segments: 
-  - 1
-  - 0
-  - 0
-  - beta
-  - 5
-  version: 1.0.0beta5
+  version: 1.0.0beta6
 platform: ruby
 authors: 
 - Alan Johnson
@@ -17,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-09 00:00:00 -05:00
+date: 2011-03-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,12 +21,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 961915928
-        segments: 
-        - 0
-        - 11
-        - 1
-        - pre
         version: 0.11.1.pre
   type: :runtime
   version_requirements: *id001
@@ -45,14 +32,31 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 3
-        - 6
-        - 1
         version: 3.6.1
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Payday is a library for rendering invoices. At present it supports rendering invoices to pdfs, but we're planning on adding support for other formats in the near future.
 email: 
 - alan@commondream.net
@@ -94,25 +98,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">"
     - !ruby/object:Gem::Version 
-      hash: 25
-      segments: 
-      - 1
-      - 3
-      - 1
       version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: git remote add origin git@github.com:commondream/payday.git