payday 1.0.0beta7 → 1.0.0beta8

data/README.md

@@ -45,43 +45,7 @@ Using Payday with ActiveRecord Objects (or any other objects, for that matter)
 
 Payday focuses on two main objects, an invoice and a line item, so to use Payday with ActiveRecord you'll want to create your own classes for those objects. We include the Payday::Invoiceable and Payday::LineItemable modules to help out with that.
 
-Here's the simplest possible implementation of a custom invoice and line item with Payday:
-
-In a new migration:
-
-    create_table :invoices do |t|
-      # invoices will work without anything but bill_to, but there are quite a few options for the fields you can save, like ship_to
-      # due_at, and paid_at
-      t.string :bill_to
-      
-      t.timestamps
-    end
-    
-    create_table :line_items do |t|
-      t.decimal :price
-      t.string :description
-      t.integer :quantity     # can also be :decimal or :float - just needs to be numeric
-      
-      t.integer :invoice_id
-      
-      t.timestamps
-    end
-    
-In app/models/invoice.rb:
-
-    class Invoice < ActiveRecord::Base
-      include Payday::Invoiceable
-
-      has_many :line_items
-    end
-    
-In app/models/line_item.rb:
-
-    class LineItem < ActiveRecord::Base
-      include Payday::LineItemable
-
-      belongs_to :invoice
-    end
+Thanks to the work of Andrew Nordman, Payday includes a Rails generator that makes it super simple to generate the necessary models and migration for wiring Payday up to your app. Run `rails generate payday:setup --help` for more information about using the generator.
 
 For a bit more fleshed out example, be sure to check out [http://github.com/commondream/payday-example](http://github.com/commondream/payday-example).
 

data/lib/payday/i18n.rb

@@ -1,2 +1,2 @@
 # Load everything in the local folder
-I18n.load_path.concat(Dir[File.join(File.dirname(__FILE__), "payday", "locale", "*.yml")])
+I18n.load_path.concat(Dir[File.join(File.dirname(__FILE__), "locale", "*.yml")])

data/lib/payday/invoice.rb

@@ -4,8 +4,8 @@ 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,
-        :currency, :invoice_details
+    attr_accessor :invoice_number, :bill_to, :ship_to, :notes, :line_items, :shipping_rate, :shipping_description,
+                  :tax_rate, :tax_description, :due_at, :paid_at, :currency, :invoice_details
     
     def initialize(options =  {})
       self.invoice_number = options[:invoice_number] || nil
@@ -13,6 +13,8 @@ module Payday
       self.ship_to = options[:ship_to] || nil
       self.notes = options[:notes] || nil
       self.line_items = options[:line_items] || []
+      self.shipping_rate = options[:shipping_rate] || nil
+      self.shipping_description = options[:shipping_description] || nil
       self.tax_rate = options[:tax_rate] || nil
       self.tax_description = options[:tax_description] || nil
       self.due_at = options[:due_at] || nil
@@ -25,5 +27,10 @@ module Payday
     def tax_rate=(value)
       @tax_rate = BigDecimal.new(value.to_s)
     end
+    
+    # Shipping rate
+    def shipping_rate=(value)
+      @shipping_rate = BigDecimal.new(value.to_s)
+    end
   end
 end

data/lib/payday/invoiceable.rb

@@ -35,9 +35,19 @@ module Payday::Invoiceable
     end
   end
   
+  # TODO Add a per weight unit shipping cost
+  # Calculates the shipping
+  def shipping
+    if defined?(shipping_rate)
+      shipping_rate
+    else
+      0
+    end
+  end
+  
   # Calculates the total for this invoice.
   def total
-    subtotal + tax
+    subtotal + tax + shipping
   end
   
   def overdue?
@@ -61,7 +71,7 @@ module Payday::Invoiceable
   # Iterates through the details on this invoiceable. The block given should accept
   # two parameters, the detail name and the actual detail value.
   def each_detail(&block)
-    return if !defined?(:invoice_details)
+    return if defined?(invoice_details).nil?
     
     invoice_details.each do |detail|
       block.call(detail[0], detail[1])

data/lib/payday/locale/de.yml

@@ -0,0 +1,19 @@
+de:
+  payday:
+    status: 
+      overdue: ÜBERFÄLLIG
+      paid: BEZAHLT
+    invoice: 
+      bill_to: Rechnung an
+      due_date: "Fälligkeit:"
+      invoice_no: "Rechnungsnr.:"
+      paid_date: "Zahlungsdatum:"
+      ship_to: Versenden an
+      subtotal: "Zwischensumme:"
+      tax: "Steuern:"
+      total: "Gesamt:"
+    line_item: 
+      amount: Betrag
+      description: Beschreibung
+      quantity: Menge
+      unit_price: Stückpreis

data/lib/payday/locale/en.yml

@@ -10,6 +10,7 @@ en:
       due_date: "Due Date:"
       paid_date: "Paid Date:"
       subtotal: "Subtotal:"
+      shipping: "Shipping:"
       tax: "Tax:"
       total: "Total:"
     line_item:

data/lib/payday/locale/es.yml

@@ -0,0 +1,19 @@
+es:
+  payday: 
+    status: 
+      overdue: RETRASADO
+      paid: PAGADO
+    invoice: 
+      bill_to: Facturar a
+      due_date: "Vencimiento:"
+      invoice_no: "Recibo #:"
+      paid_date: "Pagado en:"
+      ship_to: Enviar a
+      subtotal: "Subtotal:"
+      tax: "Impuesto:"
+      total: "Total:"
+    line_item: 
+      amount: Cantidad
+      description: Descripción
+      quantity: Cantidad
+      unit_price: Precio por Unidad

data/lib/payday/locale/fr.yml

@@ -0,0 +1,19 @@
+fr:
+  payday:
+    status:
+      paid: PAYÉ
+      overdue: EN RETARD
+    invoice:
+      bill_to: Facturé à
+      ship_to: Livré à
+      invoice_no: "Facture #:"
+      due_date: "Paiment dû le:"
+      paid_date: "Payé le:"
+      subtotal: "Sous-total:"
+      tax: "Taxe:"
+      total: "Total:"
+    line_item:
+      description: Description
+      unit_price: Prix unitaire
+      quantity: Quantité
+      amount: Montant

data/lib/payday/pdf_renderer.rb

@@ -28,6 +28,8 @@ module Payday
         line_items_table(invoice, pdf)
         totals_lines(invoice, pdf)
         notes(invoice, pdf)
+        
+        page_numbers(pdf)
 
         pdf
       end
@@ -41,7 +43,7 @@ module Payday
         end
 
         if stamp
-          pdf.bounding_box([200, pdf.cursor - 50], :width => pdf.bounds.width - 400) do
+          pdf.bounding_box([150, pdf.cursor - 50], :width => pdf.bounds.width - 300) do
             pdf.font("Helvetica-Bold") do
               pdf.fill_color "cc0000"
               pdf.text stamp, :align=> :center, :size => 25, :rotate => 15
@@ -171,8 +173,16 @@ module Payday
         table_data = []
         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)]
+        if invoice.tax_rate > 0
+          table_data << [bold_cell(pdf,
+              invoice.tax_description.nil? ? I18n.t('payday.invoice.tax', :default => "Tax:") : invoice.tax_description), 
+              cell(pdf, number_to_currency(invoice.tax, invoice), :align => :right)]
+        end
+        if invoice.shipping_rate > 0
+          table_data << [bold_cell(pdf,
+              invoice.shipping_description.nil? ? I18n.t('payday.invoice.shipping', :default => "Shipping:") : invoice.shipping_description), 
+              cell(pdf, number_to_currency(invoice.shipping, invoice), :align => :right)]
+        end
         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 => [] })
@@ -195,6 +205,12 @@ module Payday
         end
       end
       
+      def self.page_numbers(pdf)
+        if pdf.page_count > 1
+          pdf.number_pages("<page> / <total>", [pdf.bounds.right - 18, -15])
+        end
+      end
+      
       def self.invoice_or_default(invoice, property)
         if invoice.respond_to?(property) && invoice.send(property)
           invoice.send(property)
@@ -212,11 +228,6 @@ module Payday
         cell(pdf, text, options)
       end
     
-      # from Rails, I think
-      def self.number_with_delimiter(number, delimiter=",")
-        number.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
-      end
-    
       # Converts this number to a formatted currency string
       def self.number_to_currency(number, invoice)
         number.to_money(invoice_or_default(invoice, :currency)).format

data/lib/payday/version.rb

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

data/test/invoice_test.rb

@@ -7,14 +7,17 @@ module Payday
       i = Invoice.new(:invoice_number => 20, :bill_to => "Here", :ship_to => "There",
           :notes => "These are some notes.",
           :line_items => [LineItem.new(:price => 10, :quantity => 3, :description => "Shirts")],
-          :tax_rate => 12.5, :tax_description => "Local Sales Tax, 12.5%")
+          :shipping_rate => 15.00, :shipping_description => "USPS Priority Mail:",
+          :tax_rate => 0.125, :tax_description => "Local Sales Tax, 12.5%")
           
       assert_equal 20, i.invoice_number
       assert_equal "Here", i.bill_to
       assert_equal "There", i.ship_to
       assert_equal "These are some notes.", i.notes
       assert_equal "Shirts", i.line_items[0].description
-      assert_equal BigDecimal.new("12.5"), i.tax_rate
+      assert_equal BigDecimal.new("15.00"), i.shipping_rate
+      assert_equal "USPS Priority Mail:", i.shipping_description
+      assert_equal BigDecimal.new("0.125"), i.tax_rate
       assert_equal "Local Sales Tax, 12.5%", i.tax_description
     end
         
@@ -116,7 +119,7 @@ module Payday
       assert !File.exists?("tmp/testing.pdf")
       
       i = Invoice.new(:tax_rate => 0.1, :notes => "These are some crazy awesome notes!", :invoice_number => 12,
-          :due_at => Date.civil(2011, 1, 22), :paid_at => Date.civil(2012, 2, 22),
+          :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",
           :invoice_details => {"Ordered By:" => "Alan Johnson", "Paid By:" => "Dude McDude"})
@@ -130,6 +133,7 @@ module Payday
       end
 
       i.render_pdf_to_file("tmp/testing.pdf")
+      
       assert File.exists?("tmp/testing.pdf")
     end
     

metadata

@@ -2,7 +2,7 @@
 name: payday
 version: !ruby/object:Gem::Version 
   prerelease: 5
-  version: 1.0.0beta7
+  version: 1.0.0beta8
 platform: ruby
 authors: 
 - Alan Johnson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-12 23:00:00 -05:00
+date: 2011-03-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,7 +84,10 @@ files:
 - lib/payday/invoiceable.rb
 - lib/payday/line_item.rb
 - lib/payday/line_itemable.rb
+- lib/payday/locale/de.yml
 - lib/payday/locale/en.yml
+- lib/payday/locale/es.yml
+- lib/payday/locale/fr.yml
 - lib/payday/pdf_renderer.rb
 - lib/payday/version.rb
 - payday.gemspec