payday 1.0.0beta1 → 1.0.0beta2

data/README.md

@@ -2,6 +2,17 @@ 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.
 
+Installing
+===
+Payday is available as a Rubygem, so installing it is as easy as running:
+
+    gem install payday --pre
+
+Or, using bundler:
+
+    gem "payday"
+
+
 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.
@@ -14,6 +25,10 @@ Example:
     i.line_items << LineItem.new(:price => 5, :quantity => 200, :description => "Hats")
     i.render_pdf_to_file("/path/to_file.pdf")
 
+Documentation
+===
+Documentation for the latest version of Payday is available at [rdoc.info](http://rdoc.info/github/commondream/payday/v1.0.0beta1/frames).
+
 Customizing Your Logo and Company Name
 ===
 Check out Payday::Config to customize your company's name, details, and logo.
@@ -27,7 +42,47 @@ Example:
 Using Payday with ActiveRecord Objects (or any other objects, for that matter)
 ===
 
-TODO
+Payday focuses on two main objects, an invoice and a line item, so to 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
+
+For a bit more fleshed out example, be sure to check out [http://github.com/commondream/payday-example](http://github.com/commondream/payday-example).
 
 Rendering Payday PDFs To The Web
 ===
@@ -49,6 +104,12 @@ In your controller:
 
 Be sure to restart your server after you edit the mime_types initializer. The updating setting won't take effect until you do.
 
+Examples
+===
+Here's an [example PDF Invoice](https://github.com/downloads/commondream/payday/testing.pdf)
+
+There's also an example Rails application running on Heroku at [http://payday-example.heroku.com](http://payday-example.heroku.com). You can check out the source at [http://github.com/commondream/payday-example](http://github.com/commondream/payday-example).
+
 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!
@@ -57,10 +118,10 @@ 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
+* Let some folks use it for a bit.
 * Release 1.0!
 
+* Actually get a designer to style the invoices.
 * 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

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_on, :paid_at
+    attr_accessor :invoice_number, :bill_to, :ship_to, :notes, :line_items, :tax_rate, :tax_description, :due_at, :paid_at
     
     def initialize(options =  {})
       self.invoice_number = options[:invoice_number] || nil
@@ -14,7 +14,7 @@ module Payday
       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.due_at = options[:due_at] || nil
       self.paid_at = options[:paid_at] || nil
     end
     

data/lib/payday/invoiceable.rb

@@ -10,7 +10,7 @@
 # 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
+# If the +due_at+ 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
   
@@ -41,7 +41,7 @@ module Payday::Invoiceable
   end
   
   def overdue?
-    defined?(:due_on) && due_on.is_a?(Date) && due_on < Date.today && !paid_at
+    defined?(:due_at) && ((due_at.is_a?(Date) && due_at < Date.today) || (due_at.is_a?(Time) < Time.now))  && !paid_at
   end
   
   def paid?

data/lib/payday/line_itemable.rb

@@ -1,7 +1,7 @@
 # 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}
+  # Returns the total amount for this {LineItemable}, or +price * quantity+
   def amount
     price * quantity
   end

data/lib/payday/pdf_renderer.rb

@@ -103,11 +103,11 @@ module Payday
         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)
+        if defined?(invoice.due_at) && invoice.due_at
+          if invoice.due_at.is_a?(Date) || invoice.due_at.is_a?(Time)
+            due_date = invoice.due_at.strftime(Payday::Config.default.date_format)
           else
-            due_date = invoice.due_on.to_s
+            due_date = invoice.due_at.to_s
           end
 
           table_data << [bold_cell(pdf, "Due Date:"), bold_cell(pdf, due_date, :align => :right)]

data/lib/payday/version.rb

@@ -1,3 +1,6 @@
+# This is Payday!
 module Payday
-  VERSION = "1.0.0beta1"
+  
+  # Current Version
+  VERSION = "1.0.0beta2"
 end

data/test/invoice_test.rb

@@ -62,12 +62,12 @@ module Payday
     end
     
     test "overdue? is false when past date and unpaid" do
-      i = Invoice.new(:due_on => Date.today - 1)
+      i = Invoice.new(:due_at => 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)
+      i = Invoice.new(:due_at => Date.today - 1, :paid_at => Date.today)
       assert !i.overdue?
     end
     
@@ -86,7 +86,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_on => 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")
       
       3.times do
@@ -101,7 +101,7 @@ module Payday
     
     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),
+          :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")
 
       3.times do

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: payday
 version: !ruby/object:Gem::Version 
-  hash: 62196353
+  hash: 62196359
   prerelease: 5
   segments: 
   - 1
   - 0
   - 0
   - beta
-  - 1
-  version: 1.0.0beta1
+  - 2
+  version: 1.0.0beta2
 platform: ruby
 authors: 
 - Alan Johnson