payday 1.0.0beta1

data/.gitignore

@@ -0,0 +1,7 @@
+tmp/
+doc/
+.yardoc/
+*.gem
+Gemfile.lock
+.bundle
+pkg/*

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "rake"
+  gem "yard"
+end
+

data/README.md

@@ -0,0 +1,75 @@
+Payday!
+===
+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.
+
+Using Payday
+===
+It's pretty easy to use Payday with the built in objects. We include the Invoice and LineItem classes, and with them you can get started pretty quickly.
+
+Example:
+
+    invoice = Payday::Invoice.new(:invoice_number => 12)
+    i.line_items << LineItem.new(:price => 20, :quantity => 5, :description => "Pants")
+    i.line_items << LineItem.new(:price => 10, :quantity => 3, :description => "Shirts")
+    i.line_items << LineItem.new(:price => 5, :quantity => 200, :description => "Hats")
+    i.render_pdf_to_file("/path/to_file.pdf")
+
+Customizing Your Logo and Company Name
+===
+Check out Payday::Config to customize your company's name, details, and logo.
+
+Example:
+
+    Payday::Config.default.invoice_log = "/path/to/company/logo.png"
+    Payday::Config.default.company_name = "Awesome Corp"
+    Payday::Config.default.company_details = "10 This Way\nManhattan, NY 10001\n800-111-2222\nawesome@awesomecorp.com"
+
+Using Payday with ActiveRecord Objects (or any other objects, for that matter)
+===
+
+TODO
+
+Rendering Payday PDFs To The Web
+===
+Payday's Invoiceable module includes methods for rendering pdfs to disk and for rendering them to a string. In a Rails controller, you can use the
+render to string method to render a pdf directly to the browser like this:
+
+In config/initializers/mime_types.rb:
+  
+    Mime::Type.register 'application/pdf', :pdf
+    
+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
+      end
+    end
+
+Be sure to restart your server after you edit the mime_types initializer. The updating setting won't take effect until you do.
+
+Contributing
+===
+Payday is pretty young, so there's still a good bit of work to be done. Feel free to fork the project, make some changes, and send a pull request. If you're unsure about what to work on, send me a message on GitHub. I'd love the help!
+
+To Do
+===
+Here's what we're planning on working on with Payday in the near future:
+
+* Package as gem
+* Document how to use with ActiveRecord
+* Release 1.0!
+
+* Add support for currencies other than USD
+* Add support for Money gem or BigDecimal or general numerics (right now we support BigDecimal and general numerics)
+* Add support for blank line items
+* 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
+
+* Add page numbers
+* Ability to render invoice to html for web viewing

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/lib/payday.rb

@@ -0,0 +1,12 @@
+# Not much to see here
+require 'date'
+require 'bigdecimal'
+require 'prawn'
+
+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")

data/lib/payday/config.rb

@@ -0,0 +1,21 @@
+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"+.
+  class Config
+    attr_accessor :invoice_logo, :company_name, :company_details, :date_format, :currency
+    
+    # Returns the default configuration instance
+    def self.default
+      @@default ||= new
+    end
+    
+    private
+      def initialize
+        self.invoice_logo = File.join(File.dirname(__FILE__), "..", "..", "assets", "default_logo.png")
+        self.company_name = "Awesome Corp"
+        self.company_details = "awesomecorp@commondream.net"
+        self.date_format = "%B %e, %Y"
+      end
+  end
+end

data/lib/payday/invoice.rb

@@ -0,0 +1,26 @@
+module Payday
+  
+  # Basically just an invoice. Stick a ton of line items in it, add some details, and then render it out!
+  class Invoice
+    include Payday::Invoiceable
+    
+    attr_accessor :invoice_number, :bill_to, :ship_to, :notes, :line_items, :tax_rate, :tax_description, :due_on, :paid_at
+    
+    def initialize(options =  {})
+      self.invoice_number = options[:invoice_number] || nil
+      self.bill_to = options[:bill_to] || nil
+      self.ship_to = options[:ship_to] || nil
+      self.notes = options[:notes] || nil
+      self.line_items = options[:line_items] || []
+      self.tax_rate = options[:tax_rate] || nil
+      self.tax_description = options[:tax_description] || nil
+      self.due_on = options[:due_on] || nil
+      self.paid_at = options[:paid_at] || nil
+    end
+    
+    # The tax rate that we're applying, as a BigDecimal    
+    def tax_rate=(value)
+      @tax_rate = BigDecimal.new(value.to_s)
+    end
+  end
+end

data/lib/payday/invoiceable.rb

@@ -0,0 +1,60 @@
+# Include {Payday::Invoiceable} in your Invoice class to make it Payday compatible. Payday
+# expects that a +line_items+ method containing an Enumerable of {Payday::LineItem} compatible
+# elements exists. Those LineItem objects primarily need to include quantity, price, and description methods.
+#
+# The +bill_to+ method should always be overwritten by your class. Otherwise, it'll say that your invoice should
+# be billed to Goofy McGoofison. +ship_to+ is also available, but will not be used in rendered invoices if it
+# doesn't exist.
+#
+# Although not required, if a +tax_rate+ method exists, {Payday::Invoiceable} will use it to calculate tax
+# when generating an invoice. We include a simple tax method that calculates tax, but it's probably wiser
+# to override this in your class (our calculated tax won't be stored to a database by default, for example).
+#
+# If the +due_on+ and +paid_at+ methods are available, {Payday::Invoiceable} will use them to show due dates and
+# paid dates, as well as stamps showing if the invoice is paid or due.
+module Payday::Invoiceable
+  
+  # Who the invoice is being sent to.
+  def bill_to
+    "Goofy McGoofison\nYour Invoice Doesn't\nHave It's Own BillTo Method"
+  end
+  
+  # Calculates the subtotal of this invoice by adding up all of the line items
+  def subtotal
+    line_items.inject(BigDecimal.new("0")) { |result, item| result += item.amount }
+  end
+  
+  # The tax for this invoice, as a BigDecimal
+  def tax
+    if defined?(tax_rate)
+      calculated = subtotal * tax_rate
+      return 0 if calculated < 0
+      calculated
+    else
+      0
+    end
+  end
+  
+  # Calculates the total for this invoice.
+  def total
+    subtotal + tax
+  end
+  
+  def overdue?
+    defined?(:due_on) && due_on.is_a?(Date) && due_on < Date.today && !paid_at
+  end
+  
+  def paid?
+    defined?(:paid_at) && !!paid_at
+  end
+  
+  # Renders this invoice to pdf as a string
+  def render_pdf
+    Payday::PdfRenderer.render(self)
+  end
+  
+  # Renders this invoice to pdf
+  def render_pdf_to_file(path)
+    Payday::PdfRenderer.render_to_file(self, path)
+  end
+end

data/lib/payday/line_item.rb

@@ -0,0 +1,29 @@
+module Payday
+  # Represents a line item in an invoice.
+  #
+  # +quantity+ and +price+ are written to be pretty picky, primarily because if we're not picky about what values are set to
+  # them your invoice math could get pretty messed up. It's recommended that both values be set to +BigDecimal+ values.
+  # Otherwise, we'll do our best to convert the set values to a +BigDecimal+.
+  class LineItem
+    include LineItemable
+    
+    attr_accessor :description, :quantity, :price
+    
+    # Initializes a new LineItem
+    def initialize(options = {})
+      self.quantity = options[:quantity] || "1"
+      self.price = options[:price] || "0.00"
+      self.description = options[:description] || ""
+    end
+    
+    # Sets the quantity of this {LineItem}
+    def quantity=(value)
+      @quantity = BigDecimal.new(value.to_s)
+    end
+    
+    # Sets the price for this {LineItem}
+    def price=(value)
+      @price = BigDecimal.new(value.to_s)
+    end
+  end
+end

data/lib/payday/line_itemable.rb

@@ -0,0 +1,8 @@
+# Include this module into your line item implementation to make sure that Payday stays happy
+# with it, or just make sure that your line item implements the amount method.
+module Payday::LineItemable
+  # Returns the total amount for this {LineItemable}, or {#price} * {#quantity}
+  def amount
+    price * quantity
+  end
+end

data/lib/payday/pdf_renderer.rb

@@ -0,0 +1,220 @@
+module Payday
+  
+  # The PDF renderer. We use this internally in Payday to render pdfs, but really you should just need to call
+  # {{Payday::Invoiceable#render_pdf}} to render pdfs yourself.
+  class PdfRenderer
+    
+    # Renders the given invoice as a pdf on disk
+    def self.render_to_file(invoice, path)    
+      pdf(invoice).render_file(path)
+    end
+  
+    # Renders the given invoice as a pdf, returning a string
+    def self.render(invoice)
+      pdf(invoice).render
+    end
+  
+    private
+      def self.pdf(invoice)
+        pdf = Prawn::Document.new
+
+        # set up some default styling
+        pdf.font_size(8)
+
+        stamp(invoice, pdf)
+        company_banner(invoice, pdf)
+        bill_to_ship_to(invoice, pdf)
+        invoice_details(invoice, pdf)
+        line_items_table(invoice, pdf)
+        totals_lines(invoice, pdf)
+        notes(invoice, pdf)
+
+        pdf
+      end
+      
+      def self.stamp(invoice, pdf)
+        stamp = nil
+        if invoice.paid?
+          stamp = "PAID"
+        elsif invoice.overdue?
+          stamp = "OVERDUE"
+        end
+
+        if stamp
+          pdf.bounding_box([200, pdf.cursor - 50], :width => pdf.bounds.width - 400) do
+            pdf.font("Helvetica-Bold") do
+              pdf.fill_color "cc0000"
+              pdf.text stamp, :align=> :center, :size => 25, :rotate => 15
+            end
+          end
+        end
+
+        pdf.fill_color "000000"
+      end
+      
+      def self.company_banner(invoice, pdf)
+        # render the logo
+        logo_info = pdf.image(invoice_or_default(invoice, :invoice_logo), :at => pdf.bounds.top_left, :fit => [200, 100])
+        
+        # render the company details
+        table_data = []
+        table_data << [bold_cell(pdf, invoice_or_default(invoice, :company_name), :size => 12)]
+        table_data << [invoice_or_default(invoice, :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
+          table.draw
+        end
+        
+        pdf.move_cursor_to(pdf.bounds.top - logo_info.scaled_height - 20)
+      end
+      
+      def self.bill_to_ship_to(invoice, pdf)
+        bill_to_cell_style = { :borders => [], :padding => [2, 0]}
+        bill_to_ship_to_bottom = 0
+        
+        # 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)
+          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)
+          
+          pdf.bounding_box([pdf.bounds.width - table.width, pdf.cursor], :width => table.width, :height => table.height + 2) do
+            table.draw
+          end
+        end
+
+        # make sure we start at the lower of the bill_to or ship_to details
+        bill_to_ship_to_bottom = pdf.cursor if pdf.cursor < bill_to_ship_to_bottom
+        pdf.move_cursor_to(bill_to_ship_to_bottom - 20)
+      end
+      
+      def self.invoice_details(invoice, pdf)
+        # invoice details
+        table_data = []
+
+        # 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)]
+        end
+
+        # Due on
+        if defined?(invoice.due_on) && invoice.due_on
+          if invoice.due_on.is_a?(Date)
+            due_date = invoice.due_on.strftime(Payday::Config.default.date_format)
+          else
+            due_date = invoice.due_on.to_s
+          end
+
+          table_data << [bold_cell(pdf, "Due Date:"), bold_cell(pdf, due_date, :align => :right)]
+        end
+
+        # Paid on
+        if defined?(invoice.paid_at) && invoice.paid_at
+          if invoice.paid_at.is_a?(Date)
+            paid_date = invoice.paid_at.strftime(Payday::Config.default.date_format)
+          else
+            paid_date = invoice.paid_at.to_s
+          end
+
+          table_data << [bold_cell(pdf, "Paid Date:"), bold_cell(pdf, paid_date, :align => :right)]
+        end
+
+        if table_data.length > 0
+          pdf.table(table_data, :cell_style => { :borders => [], :padding => 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 => [])]
+        invoice.line_items.each do |line|
+          table_data << [line.description, number_to_currency(line.price), line.quantity.to_s,
+              number_to_currency(line.amount)]
+        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]},
+            :row_colors => ["dfdfdf", "ffffff"]) do
+          # left align the number columns
+          columns(1..3).rows(1..row_length - 1).style(:align => :right)
+
+          # set the column widths correctly
+          natural = natural_column_widths
+          natural[0] = width - natural[1] - natural[2] - natural[3]
+
+          column_widths = natural
+        end
+      end
+      
+      def self.totals_lines(invoice, pdf)
+        table_data = []
+        table_data << [bold_cell(pdf, "Subtotal:"), cell(pdf, number_to_currency(invoice.subtotal), :align => :right)]
+        table_data << [bold_cell(pdf, "Tax:"), cell(pdf, number_to_currency(invoice.tax), :align => :right)]
+        table_data << [bold_cell(pdf, "Total:", :size => 12), 
+            cell(pdf, number_to_currency(invoice.total), :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
+          table.draw
+        end
+      end
+      
+      def self.notes(invoice, pdf)
+        if defined?(invoice.notes) && invoice.notes
+          pdf.move_cursor_to(pdf.cursor - 30)
+          pdf.font("Helvetica-Bold") do
+            pdf.text("Notes")
+          end
+          pdf.line_width = 0.5
+          pdf.stroke_color = "cccccc"
+          pdf.stroke_line([0, pdf.cursor - 3, pdf.bounds.width, pdf.cursor - 3])
+          pdf.move_cursor_to(pdf.cursor - 10)
+          pdf.text(invoice.notes.to_s)
+        end
+      end
+      
+      def self.invoice_or_default(invoice, property)
+        if invoice.respond_to?(property) && invoice.send(property)
+          invoice.send(property)
+        else
+          Payday::Config.default.send(property)
+        end
+      end
+  
+      def self.cell(pdf, text, options = {})
+        Prawn::Table::Cell::Text.make(pdf, text, options)
+      end
+    
+      def self.bold_cell(pdf, text, options = {})
+        options[:font] = "Helvetica-Bold"
+        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
+    
+      def self.number_to_currency(number)
+        number_with_delimiter(sprintf("$%.02f", number))
+      end
+    
+      def self.max_cell_width(cell_proxy)
+        max = 0
+        cell_proxy.each do |cell|
+          if cell.natural_content_width > max
+            max = cell.natural_content_width
+          end
+        end
+      
+        max
+      end
+  end
+end

data/lib/payday/version.rb

@@ -0,0 +1,3 @@
+module Payday
+  VERSION = "1.0.0beta1"
+end

data/payday.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "payday/version"
+
+Gem::Specification.new do |s|
+  s.name        = "payday"
+  s.version     = Payday::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alan Johnson"]
+  s.email       = ["alan@commondream.net"]
+  s.homepage    = ""
+  s.summary     = %q{git remote add origin git@github.com:commondream/payday.git}
+  s.description = %q{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.}
+
+  s.add_dependency("prawn", "~> 0.11.1.pre")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/invoice_test.rb

@@ -0,0 +1,116 @@
+require "test/test_helper"
+
+module Payday
+  class InvoiceTest < Test::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.",
+          :line_items => [LineItem.new(:price => 10, :quantity => 3, :description => "Shirts")],
+          :tax_rate => 12.5, :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 "Local Sales Tax, 12.5%", i.tax_description
+    end
+        
+    test "that subtotal totals up all of the line items in an invoice correctly" do
+      i = Invoice.new
+      
+      # $100 in Pants
+      i.line_items << LineItem.new(:price => 20, :quantity => 5, :description => "Pants")
+      
+      # $30 in Shirts
+      i.line_items << LineItem.new(:price => 10, :quantity => 3, :description => "Shirts")
+      
+      # $1000 in Hats
+      i.line_items << LineItem.new(:price => 5, :quantity => 200, :description => "Hats")
+      
+      assert_equal BigDecimal.new("1130"), i.subtotal
+    end
+    
+    test "that tax returns the correct tax amount, rounded to two decimal places" do
+      i = Invoice.new(:tax_rate => 0.1)
+      i.line_items << LineItem.new(:price => 20, :quantity => 5, :description => "Pants")
+      
+      assert_equal(BigDecimal.new("10"), i.tax)
+    end
+    
+    test "that taxes aren't applied to invoices with a subtotal of 0 or a negative amount" do
+      i = Invoice.new(:tax_rate => 0.1)
+      i.line_items << LineItem.new(:price => -1, :quantity => 100, :description => "Negative Priced Pants")
+      
+      assert_equal(BigDecimal.new("0"), i.tax)
+    end
+    
+    test "that the total for this invoice calculates correctly" do
+      i = Invoice.new(:tax_rate => 0.1)
+      
+      # $100 in Pants
+      i.line_items << LineItem.new(:price => 20, :quantity => 5, :description => "Pants")
+      
+      # $30 in Shirts
+      i.line_items << LineItem.new(:price => 10, :quantity => 3, :description => "Shirts")
+      
+      # $1000 in Hats
+      i.line_items << LineItem.new(:price => 5, :quantity => 200, :description => "Hats")
+      
+      assert_equal BigDecimal.new("1243"), i.total
+    end
+    
+    test "overdue? is false when past date and unpaid" do
+      i = Invoice.new(:due_on => Date.today - 1)
+      assert i.overdue?
+    end
+    
+    test "overdue? is true when past date but paid" do
+      i = Invoice.new(:due_on => Date.today - 1, :paid_at => Date.today)
+      assert !i.overdue?
+    end
+    
+    test "paid is false when not paid" do
+      i = Invoice.new
+      assert !i.paid?
+    end
+    
+    test "paid is true when paid" do
+      i = Invoice.new(:paid_at => Date.today)
+      assert i.paid?
+    end
+    
+    test "rendering to file" do
+      File.unlink("tmp/testing.pdf") if File.exists?("tmp/testing.pdf")
+      assert !File.exists?("tmp/testing.pdf")
+      
+      i = Invoice.new(:tax_rate => 0.1, :notes => "These are some crazy awesome notes!", :invoice_number => 12,
+          :due_on => 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")
+      
+      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")
+        i.line_items << LineItem.new(:price => 5, :quantity => 200, :description => "Hats")
+      end
+
+      i.render_pdf_to_file("tmp/testing.pdf")
+      assert File.exists?("tmp/testing.pdf")
+    end
+    
+    test "rendering to string" do
+      i = Invoice.new(:tax_rate => 0.1, :notes => "These are some crazy awesome notes!", :invoice_number => 12,
+          :due_on => 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")
+
+      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")
+        i.line_items << LineItem.new(:price => 5, :quantity => 200, :description => "Hats")
+      end
+
+      assert_not_nil i.render_pdf
+    end
+  end
+end

data/test/line_item_test.rb

@@ -0,0 +1,25 @@
+require "test/test_helper"
+
+module Payday
+  class LineItemTest < Test::Unit::TestCase
+    test "initializing with a price" do
+      li = LineItem.new(:price => BigDecimal.new("20"))
+      assert_equal BigDecimal.new("20"), li.price
+    end
+  
+    test "initializing with a quantity" do
+      li = LineItem.new(:quantity => 30)
+      assert_equal BigDecimal.new("30"), li.quantity
+    end
+  
+    test "initializing with a description" do
+      li = LineItem.new(:description => "12 Pairs of Pants")
+      assert_equal "12 Pairs of Pants", li.description
+    end
+    
+    test "that amount returns the correct amount" do
+      li = LineItem.new(:price => 10, :quantity => 12)
+      assert_equal BigDecimal.new("120"), li.amount
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "payday")
+
+require 'test/unit'
+
+# Shamelessly ripped from jm's context library: https://github.com/jm/context/blob/master/lib/context/test.rb
+class Test::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+).
+    #
+    #     test "A user should not be able to delete another user" do
+    #       assert_false @user.can?(:delete, @other_user)
+    #     end
+    #
+    def test(name, opts={}, &block)
+      test_name = ["test:", name].reject { |n| n == "" }.join(' ')
+      # puts "running test #{test_name}"
+      defined = instance_method(test_name) rescue false
+      raise "#{test_name} is already defined in #{self}" if defined
+
+      if block_given?
+        define_method(test_name, &block)
+      else
+        define_method(test_name) do
+          flunk "No implementation provided for #{name}"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: payday
+version: !ruby/object:Gem::Version 
+  hash: 62196353
+  prerelease: 5
+  segments: 
+  - 1
+  - 0
+  - 0
+  - beta
+  - 1
+  version: 1.0.0beta1
+platform: ruby
+authors: 
+- Alan Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 961915928
+        segments: 
+        - 0
+        - 11
+        - 1
+        - pre
+        version: 0.11.1.pre
+  type: :runtime
+  version_requirements: *id001
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- assets/default_logo.png
+- lib/payday.rb
+- lib/payday/config.rb
+- lib/payday/invoice.rb
+- lib/payday/invoiceable.rb
+- lib/payday/line_item.rb
+- lib/payday/line_itemable.rb
+- lib/payday/pdf_renderer.rb
+- lib/payday/version.rb
+- payday.gemspec
+- test/invoice_test.rb
+- test/line_item_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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
+signing_key: 
+specification_version: 3
+summary: git remote add origin git@github.com:commondream/payday.git
+test_files: 
+- test/invoice_test.rb
+- test/line_item_test.rb
+- test/test_helper.rb