payday 1.0.0beta6 → 1.0.0beta7

data/README.md

@@ -107,27 +107,30 @@ Be sure to restart your server after you edit the mime_types initializer. The up
 
 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 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
+    en:
+      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
+          
+If you translate the invoice to your own language, please send me a copy of your locale.yml file so that we can include it with
+the main Payday distribution and other Payday users can enjoy the fruits of your labor.
 
 Examples
 ===
@@ -158,8 +161,8 @@ 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 invoice_details has for stuff under the invoice number
 * Add ability to show skus or product ids on each line item
+* Add ability to add fine print to invoices.
 
 * Add page numbers
 * Ability to render invoice to html for web viewing

data/lib/generators/payday/setup/USAGE

@@ -0,0 +1,30 @@
+Description:
+	Creates the Invoice and LineItem models for Payday to use to 
+	render invoicing, and optionally a migration.
+		
+Usage:
+	Pass the name of the Invoice and LineItems to the generator to
+	establish the models and database migrations for you.  These 
+	parameters can be in camel-case or in under_scored format.
+	
+	If no invoice_name or line_item_name is passed, it will default
+	to Invoice and LineItem.
+	
+	If you wish to not create the migration and only have the
+	models generated for you, pass the --skip-migration flag to
+	the generator.
+	
+Examples:
+	`rails generate payday:setup`
+	
+	Will create Invoice and LineItem models with Payday
+	configured, and a database migration file to create
+	the tables and the minimum Payday needs to operate.
+		
+	`rails generate payday:setup --invoice-name=Bill --line_item-name=Actions`
+	
+	Will create Bill and Actions models with Payday's 
+	associations and configurations established, as well
+	as a database migration for the bills and actions
+	tables.
+

data/lib/generators/payday/setup/setup_generator.rb

@@ -0,0 +1,44 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+# rails g payday:setup <invoice_name> <line_item_name>
+# Generates models for invoicing with Payday includes prepped
+# Params:
+
+# OPTIONS:
+# --skip-migration - Does not create the migration file for invoicing
+module Payday
+  class SetupGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    
+    source_root File.expand_path('../templates', __FILE__)
+    
+    class_option :invoice_name, :type => :string, :default => "Invoice"
+    class_option :line_item_name, :type => :string, :default => "LineItem"
+    class_option :skip_migration, :desc => "Does not create the migration file for tables", :type => :boolean
+    
+    def generate_invoice_model
+      template "invoice.rb", "app/models/#{options.invoice_name.underscore}.rb"
+    end
+    
+    def generate_line_item_model
+      template "line_item.rb", "app/models/#{options.line_item_name.underscore}.rb"
+    end
+    
+    def generate_migration
+      unless options.skip_migration?
+        migration_template 'migration.rb', "db/migrate/create_payday_tables.rb"
+      end
+    end
+    
+    private
+    
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+  end
+end

data/lib/generators/payday/setup/templates/invoice.rb

@@ -0,0 +1,5 @@
+class <%= options.invoice_name.singularize %> < ActiveRecord::Base
+  include Payday::Invoiceable
+  
+  has_many :<%= options.line_item_name.pluralize.underscore %>
+end

data/lib/generators/payday/setup/templates/line_item.rb

@@ -0,0 +1,5 @@
+class <%= options.line_item_name.singularize %> < ActiveRecord::Base
+  include Payday::LineItemable
+  
+  belongs_to :<%= options.invoice_name.underscore %>
+end

data/lib/generators/payday/setup/templates/migration.rb

@@ -0,0 +1,26 @@
+class CreatePaydayTables < ActiveRecord::Migration
+  def self.up
+    create_table :<%= options.invoice_name.pluralize.underscore.split("/").last %> 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 :<%= options.line_item_name.pluralize.underscore.split("/").last %> do |t|
+      t.decimal :price
+      t.string :description
+      t.integer :quantity     # can also be :decimal or :float - just needs to be numeric
+
+      t.references :<%= options.invoice_name.underscore %>
+
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :<%= options.invoice_name.pluralize.underscore.split("/").last %>
+    drop_table :<%= options.line_item_name.pluralize.underscore.split("/").last %>
+  end
+end

data/lib/payday.rb

@@ -7,6 +7,7 @@ require 'money'
 
 require 'payday/version'
 require 'payday/config'
+require 'payday/i18n'
 require 'payday/line_itemable'
 require 'payday/line_item'
 require 'payday/pdf_renderer'

data/lib/payday/i18n.rb

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

data/lib/payday/invoice.rb

@@ -4,7 +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
+    attr_accessor :invoice_number, :bill_to, :ship_to, :notes, :line_items, :tax_rate, :tax_description, :due_at, :paid_at,
+        :currency, :invoice_details
     
     def initialize(options =  {})
       self.invoice_number = options[:invoice_number] || nil
@@ -17,6 +18,7 @@ module Payday
       self.due_at = options[:due_at] || nil
       self.paid_at = options[:paid_at] || nil
       self.currency = options[:currency] || nil
+      self.invoice_details = options[:invoice_details] || []
     end
     
     # The tax rate that we're applying, as a BigDecimal    

data/lib/payday/invoiceable.rb

@@ -57,4 +57,14 @@ module Payday::Invoiceable
   def render_pdf_to_file(path)
     Payday::PdfRenderer.render_to_file(self, path)
   end
+  
+  # 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)
+    
+    invoice_details.each do |detail|
+      block.call(detail[0], detail[1])
+    end
+  end
 end

data/lib/payday/locale/en.yml

@@ -0,0 +1,19 @@
+en:
+  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

data/lib/payday/pdf_renderer.rb

@@ -60,8 +60,7 @@ module Payday
         table_data = []
         table_data << [bold_cell(pdf, invoice_or_default(invoice, :company_name).strip, :size => 12)]
         
-        company_details = invoice_or_default(invoice, :company_details)
-        company_details = company_details.lines.each { |line| table_data << [line] }
+        invoice_or_default(invoice, :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
@@ -131,6 +130,12 @@ module Payday
               bold_cell(pdf, paid_date, :align => :right)]
         end
 
+        # loop through invoice_details and include them
+        invoice.each_detail do |key, value|
+          table_data << [bold_cell(pdf, key), 
+              bold_cell(pdf, value, :align => :right)]
+        end
+
         if table_data.length > 0
           pdf.table(table_data, :cell_style => { :borders => [], :padding => [1, 10, 1, 1] })
         end

data/lib/payday/version.rb

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

data/test/invoice_test.rb

@@ -87,13 +87,39 @@ module Payday
       assert i.paid?
     end
     
+    test "iterating through invoice_details as two element arrays" do
+      i = Invoice.new(:invoice_details => [["Test", "Yes"], ["Awesome", "Absolutely"]])
+      details = []
+      i.each_detail do |key, value|
+        details << [key, value]
+      end
+      
+      assert_equal 2, details.length
+      assert details.include?(["Test", "Yes"])
+      assert details.include?(["Awesome", "Absolutely"])
+    end
+    
+    test "iterating through invoice_details as a hash" do
+      i = Invoice.new(:invoice_details => {"Test" => "Yes", "Awesome" => "Absolutely"})
+      details = []
+      i.each_detail do |key, value|
+        details << [key, value]
+      end
+      
+      assert_equal 2, details.length
+      assert details.include?(["Test", "Yes"])
+      assert details.include?(["Awesome", "Absolutely"])
+    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_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")
+          :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"})
       
       Payday::Config.default.company_details = "10 This Way\nManhattan, NY 10001\n800-111-2222\nawesome@awesomecorp.com"
       

metadata

@@ -2,7 +2,7 @@
 name: payday
 version: !ruby/object:Gem::Version 
   prerelease: 5
-  version: 1.0.0beta6
+  version: 1.0.0beta7
 platform: ruby
 authors: 
 - Alan Johnson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-10 00:00:00 -05:00
+date: 2011-03-12 23:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,12 +72,19 @@ files:
 - README.md
 - Rakefile
 - assets/default_logo.png
+- lib/generators/payday/setup/USAGE
+- lib/generators/payday/setup/setup_generator.rb
+- lib/generators/payday/setup/templates/invoice.rb
+- lib/generators/payday/setup/templates/line_item.rb
+- lib/generators/payday/setup/templates/migration.rb
 - lib/payday.rb
 - lib/payday/config.rb
+- lib/payday/i18n.rb
 - lib/payday/invoice.rb
 - lib/payday/invoiceable.rb
 - lib/payday/line_item.rb
 - lib/payday/line_itemable.rb
+- lib/payday/locale/en.yml
 - lib/payday/pdf_renderer.rb
 - lib/payday/version.rb
 - payday.gemspec