brisk-bills 0.6.0 → 0.7.0

data/CHANGELOG

@@ -1,6 +1,11 @@
 == Change Log
 
-=== Release 1.0.0 (Feb 09, 2010)
+=== Release 0.7.0 (May 03, 2010)
+- Much improved invoice to payment mapping control.
+- Ability to unpublish more than one invoice, and to edit/delete older, already-published invoices
+- Full control of payment to invoice mappings in the invoice/payment models, via InvoicePayment's
+
+=== Release 0.6.0 (May 03, 2010)
 - First release to public
 - gem distributable
 

data/TODO.txt

@@ -1,61 +1,85 @@
-*I want to delete that old ashbritt invoice ... I should be able to !
-	* THen figure out if perhaps we can disable the auto-assign on create  	
-  	* Remove create_invoice_payments from create/destory
+* start using 0.7 pre on mario
+
+* Assign version numbers to the invoice based on the number of times an invoice is published...
+	* I don't know if we should/need-to adjust the invoice pdfs out here just yet ....
+	* Might as well put this in migration 29 while we're publishing anyways
+
+* (Install the rails-debugger on your laptop)
+
+Now for the final Controller Adjustments:
+  	* Invoice_id should be settable on the labor/materials/proposals/etc controllers. (though not the activities controller..not yet at least)
+  	* Invoice create/update Activity assignments will likely need to be adjusted...
+  		* Be sure to adjust any invoice_create tasks as well...
   	
-  	* We need to go through and see where client balances are being handled, and make sure its using invoiced_amount - payment_amount
+  	* Keep in mind - we may need/want to update InvoicePayments and not just delete/create them (say an allocaed amount changes from $4.00 -> $3.00 on the same invoice/payment
   	* let's start by adding a detail that shows what payments are currently allocated..
-  	* Don't forget to Add the right show fields too (in the payments controller)
+  	* We don't need to get sart about allocating, unless there's 0 allocated payments whcih are currently assigned...
+  	* Show a warning if someone tries to commit a payment w/o allocating the full amount...
+  	* Don't forget to Add the right show-action fields too (in the payments controller)
+  	* There's should be a way in the invoices to show which payments were applied to the invoice... (perhaps on the edit detail - just a listing?)
+  		* Maybe this should be editable.... perhaps only if is_published?
   	* THen we can add an edit...
+  	* Remove that restriction on unpublishing old invoices...
   	* And then we need to add a complemntary field in the invoices view? Nah - but show which payments are currently assigned as a read-only...
-  	* Then we can allow multiple invoices to be unpublished...
 
-	* I guess I unpublish and delete it?
-	* We should put proper transactions in place here too while we're in here...
-	* No - let's get the damn payments applying with the interface quickbooks uses
-	* We should probably allow payment updates, just do a destroy_invoice_payments and create_invoice_payments when that happens. if its the newest payment for a client.
-		* Make sure the payments_test adds a test for this...
-
-* Add Existing Client Representatives should show them in alaphabetical order
+* Things might be a little awkward with out activity assignment if people are going back and editing old stuff... we should really have an activity selector...
 
 * We should add an unpublished Open Invoices controller ...
 
+* I'd like to see a payment identifier listed in the payments list ... (check no/cc#)
+
+* Payment:::is_allocated should probably be added to a view and then list controller...
+	* Code is there - but no view supports it...
+
 * We should put tax before cost in the activities with prices controller...
 
-* I want to delete that old ashbritt invoice ... I should be able to !
-  * Here's what I'm thinking:
-  	* We remove create_invoice_payments from create/destory
-  	* We add an unallocated_amount to the payments controller / view
-  	* We need to go through and see where client balances are being handled, and make sure its using invoiced_amount - payment_amount
-  	* let's start by adding a detail that shows what payments are currently allocated..
-  	* THen we can add an edit...
-  	* And then we need to add a complemntary field in the invoices view? Nah - but show which payments are currently assigned as a read-only...
-  	* Then we can allow multiple invoices to be unpublished...
+* WHen Assigning employees to labr_rates - the form stays open between updates and shouldnt...
+
+* Move_to_invoice function should allow us to Move_to '(Unassigned)', and ideally that would be a radio group
 
-	* I guess I unpublish and delete it?
-	* We should put proper transactions in place here too while we're in here...
-	* No - let's get the damn payments applying with the interface quickbooks uses
-	* We should probably allow payment updates, just do a destroy_invoice_payments and create_invoice_payments when that happens. if its the newest payment for a client.
-		* Make sure the payments_test adds a test for this...
+* Start using 0.8-pre on mario...
 
-* Add better transactions throughout!
+* Publish !!!!!
+---------------
+* all delete confirms should go through the modal box
+
+* Probably - we should prompt on invoice update, when appropriate, whether to email the client. 
+	* Probably too, publish should be a row-action and not a form control
+* Probably - when prompted to delete an invoice, we should give the option to also remove the activities (or preserve them and leave them unsassigned)
 
 * Translate the time into the local zone for the user, probably each user/client should have a zone associtation in their account.
 	*  Its already stored in UTC everywhere...
 	* We need to factor this into invoices too, I think
 
 * Public interface
-	* Showing the Client eventlogs as an unedutable nested list  might be nice... Hell, employee eventlogs too....
-   * CC payments handling - not a plugin
 
+* Showing the Client eventlogs as an unedutable nested list  might be nice... Hell, employee eventlogs too....
+
+* Publish !!!!!
+---------------
+* CC payments handling built-in- not a plugin
+
+* Slimtimer-less time entry
+
+* Revise the site-settings interfaces...
+
+* Plugin interface...
+
+* Publish 0.9 !!!!!
 ---------------
-Plugin interface using engines?
 ---------------
-LONGER-TERM: (Needs re-prioritization...)
+LONGER-TERM Features: (Needs re-prioritization...)
 
-Feature:
+* We should audit for proper transaction support, and test!
 
-* I'd like some tests cases written for the view objects, make sure they work just like the non-views... ...
-	* Boy this is getting hard, I think it has something to do wioth the transactions... Oddly, the tests work on their own, outside of the rake test	
+* All of our read_attribute stuff, isn't "Caching"the newest values. (I think - write a test for this ...)
+	* Use a find_invoice_with_totals
+		* then update an invoice
+		* then run an invoice.amunt(true)
+		* tune run an invice.amount .... This this treturn the prior amount value?
+	* THis has to be fixed/ested for all read attributes...
+
+* Drop the VIEW hacks and de-normalize the payments/invoices tables. Just 'cache' the irksome values in here
 
 * Better searches by using the search sql fields...
 
@@ -69,9 +93,7 @@ BUG: We should probably write a plugin that better displays delete errors in the
 	* Create two invoices - both unpublished, try to delete the oldest one
 
 * Use polymorphic relationship for sub activities
-	* Maybe ..
-
-* all delete confirms should go through the modal box - make this a plugin
+	* I really don't like the way we're uing dont_validate_type_associations. ..
 
 * The ability to create an activity from the activities & invoices/activities list would be sweet
 	* With a little pop-up that asks for the activity type?

data/app/controllers/admin/employees_controller.rb

@@ -27,6 +27,6 @@ class Admin::EmployeesController < ApplicationController
   def conditions_for_collection
     ['is_active = ?', true]
   end
-  
+ 
   handle_extensions
 end

data/app/controllers/admin/invoices_controller.rb

@@ -65,10 +65,46 @@ class Admin::InvoicesController < ApplicationController
     (klass == Activity) ? Admin::ActivitiesWithPricesController : super
   end
 
+  # We ovverride the defaut behavior here only so that we can use this method as a hook to detyermine the invoice.activity_type_ids
+  # Before they've been updated by the form. We reference @activity_type_ids_before in before_update_save to determine whether we
+  # need to update the activity associations for this invoice.
+  def update_record_from_params(*args)
+    @activity_type_ids_before = @record.activity_type_ids.dup if @record
+    super
+  end
+
+  def before_update_save(invoice)
+    super
+       
+    invoice.activities = invoice.recommended_activities if (
+      invoice.new_record? or (
+        !invoice.is_published and
+        # Unfortunately, there's no easy way to accomplish a invoice.activity_types.changed?, so - this will 
+        # effectively ascertain that answer by comparing the params against the activity_type_ids 
+        (invoice.issued_on_changed? || (@activity_type_ids_before != invoice.activity_type_ids))
+      )
+    )
+
+    invoice.payment_assignments.clear if !invoice.is_published and invoice.is_published_changed?
+
+    # We're going to need this in the after_update_save... Note it now.
+    @invoice_changes = invoice.changes.keys.collect(&:to_sym)
+    @invoice_new_record = invoice.new_record?
+  end
+
+  alias before_create_save before_update_save
+
   def after_update_save(invoice)
     super
-    
-    if successful? and invoice.is_published # TODO: And only if is_published has changed?...
+
+    if successful? and invoice.is_published and (@invoice_new_record || @invoice_changes.include?(:is_published))
+      # Unfortunately we have to assign payments using the quick_create and not by concat'ing on the
+      # invoice AssociationProxy. THis is due to a bug in my InvoicesWithTotal wrapper that I think is related
+      # to the association proxy not resettting its owenr id on an id change (as is the case of a create)
+      invoice.client.recommend_payment_assignments_for(invoice.amount).each do |ip|
+         InvoicePayment.quick_create! invoice.id, ip.payment_id, ip.amount
+      end
+
       define_invoice invoice
       
       attachments = [

data/app/controllers/admin/payments_controller.rb

@@ -6,7 +6,7 @@ class Admin::PaymentsController < ApplicationController
   active_scaffold :payment do |config|
     config.label = "Payments"
 
-    config.columns = [:paid_on, :client, :payment_method, :payment_method_identifier, :amount, :invoice_assignment, :unallocated_amount, :created_at, :updated_at]
+    config.columns = [:paid_on, :client, :payment_method, :payment_method_identifier, :amount, :invoice_assignments, :amount_unallocated, :created_at, :updated_at]
 
     config.columns[:client].form_ui = :select
     config.columns[:client].sort_by :sql => 'clients.company_name'
@@ -17,8 +17,8 @@ class Admin::PaymentsController < ApplicationController
     config.columns[:payment_method_identifier].description = 'Last four card digits, check number...'
     config.columns[:payment_method_identifier].label = 'Method Identifier'
 
-    config.columns[:unallocated_amount].label = 'Unallocated'
-    config.columns[:invoice_assignment].label = 'Posted To'
+    config.columns[:amount_unallocated].label = 'Unallocated'
+    config.columns[:invoice_assignments].label = 'Posted To'
     
     config.columns[:amount].sort_by :sql => 'amount_in_cents'
     
@@ -30,9 +30,9 @@ class Admin::PaymentsController < ApplicationController
       :client, 
       :payment_method, 
       :payment_method_identifier, 
-      :amount, 
-#      :unallocated_amount, 
-#      :invoice_assignment
+      :amount
+#      :amount_unallocated, 
+#      :invoice_assignments
     ]
     
     config.update.link = nil
@@ -40,6 +40,13 @@ class Admin::PaymentsController < ApplicationController
 #    observe_active_scaffold_form_fields :fields => %w(client amount), :action => :on_invoice_assignment_observation
   end
 
+  def before_update_save(payment)      
+    payment.invoice_assignments = payment.client.recommend_invoice_assignments_for payment.amount
+  end
+
+  alias before_create_save before_update_save
+
+
   def on_invoice_assignment_observation
     record_id = (/^[\d]+$/.match(params[:record_id])) ? params[:record_id].to_i : nil
     

data/app/helpers/admin/activity_tax_field_helper.rb

@@ -1,7 +1,7 @@
 module Admin::ActivityTaxFieldHelper
   
   def tax_column(record)
-    h_money (record.tax) ? record.tax : 0.0
+    h_money (record.tax) ? record.tax : Money.new(0)
   end  
   
   def apply_tax_form_column(record, input_name)

data/app/helpers/admin/activity_type_field_helper.rb

@@ -22,11 +22,11 @@ module Admin::ActivityTypeFieldHelper
   end
   
   def cost_column(record)
-    h_money (record.cost) ? record.cost : 0.0
+    h_money (record.cost) ? record.cost : Money.new(0)
   end
   
   def tax_column(record)
-    h_money (record.tax) ? record.tax : 0.0
+    h_money (record.tax) ? record.tax : Money.new(0)
   end
 
   def cost_form_column(record,input_name)

data/app/helpers/admin/payments_helper.rb

@@ -13,8 +13,14 @@ module Admin::PaymentsHelper
     )
   end
 
-  def unallocated_amount_form_column(record, input_name)
-    '<span class="active-scaffold_detail_value" id="record_unallocated_amount_%s">%s</span>' % [record.id, '(Enter a Payment Amount)']
+  def amount_unallocated_form_column(record, input_name)
+    '<span class="active-scaffold_detail_value" id="record_amount_unallocated_%s">%s</span>' % [record.id, '(Enter a Payment Amount)']
+  end
+  
+  def invoice_assignments_column(record)
+    record.invoice_assignments.collect{|ia| 
+      '%s to Invoice %d' % [ia.amount.format, ia.invoice.id   ]
+    }.join ', '
   end
   
   def invoice_assignment_form_column(record, input_name)

data/app/helpers/application_helper.rb

@@ -2,9 +2,9 @@
 module ApplicationHelper
   
   def h_money(amount, inverse_polarity = false)    
-    '<span class="%s">$%s</span>' % [ 
+    '<span class="%s">%s</span>' % [ 
       ( (inverse_polarity ? (amount > 0 ) : (amount < 0 )) ? 'money_negative':'money_positive' ), 
-      amount.to_s.gsub(/(\d)(?=\d{3}+(\.\d*)?$)/, '\1,')
+      amount.format
     ] unless amount.nil?
   end
   
@@ -24,4 +24,11 @@ module ApplicationHelper
     @javascripts = ['scriptaculous.js?load=effects', 'modalbox.js','briskbills-quick-helpers.js']
     @stylesheets = ['modalbox.css']
   end
+  
+  # This fixes a javascript bug in active_scaffold 1.2RC1. If the controller id starts with a number, prototype 
+  # pukes during delete and create when called in a sublist on recent firefox/safari's
+  def controller_id
+    @controller_id ||= 'as_' + super
+  end
+
 end

data/app/model_views/invoices_with_total.rb

@@ -22,12 +22,17 @@ class InvoicesWithTotal < Invoice
   def invoice_assign_and_save!(inv)
     invoice_columns = Invoice.columns.collect{|c| c.name}-['id']
 
+    inv.activity_ids = activity_ids
+    inv.payment_assignments = payment_assignments
     inv.activity_type_ids = activity_type_ids
     
     attributes.reject{|k,v| true unless invoice_columns.include? k }.each{ |k,v| inv.send "#{k}=", v }
 
     inv.save!
 
+    # For the case of a create! this assign the id to the current view
+    self.id ||= inv.id
+
     inv.errors.each { |attr,msg| errors.add attr, msg }
     
     inv

data/app/models/activity.rb

@@ -30,7 +30,7 @@ class Activity < ActiveRecord::Base
     activity_type_sym = (activity_type.nil? or activity_type.empty?) ? nil : activity_type.to_sym
     
     unless dont_validate_type_associations or !self.class.reflections.has_key?(activity_type_sym)
-      type_association = instance_variable_get("@#{activity_type}")
+      type_association = self.send activity_type_sym
 
       if type_association.nil?
         errors.add activity_type_sym, 'missing'
@@ -68,9 +68,13 @@ class Activity < ActiveRecord::Base
   end
   
   def validate_on_update
-    errors.add_to_base "Activity can't be adjusted once its invoice is published" if is_published? and changed_attributes.length > 0 
+    errors.add_to_base "Activity can't be adjusted once its invoice is published" if ( 
+      # If we're published, and someone's trying to change us ....
+      is_published? and changed_attributes.length > 0 and 
+      # *But* this change isn't the case of an invoice association from nil to (not nil) [this case is cool]:
+      !(changed_attributes.length == 1 and changed_attributes.keys.include? "invoice_id" and invoice_id_change[0].nil?)
+    )
   end
-  # /No updates/destroys
   
   def sub_activity
     send activity_type unless activity_type.nil?

data/app/models/activity/labor.rb

@@ -79,7 +79,7 @@ class Activity::Labor < ActiveRecord::Base
     '%.2f' % activity.cost.to_f,
     item_name,
     occurred_on.strftime('%m/%d/%y'),
-    comments.tr("\r\n", '')
+    comments.try(:tr, "\r\n", '')
     ]
   end
 

data/app/models/activity/labor/slimtimer.rb

@@ -1,3 +1,5 @@
+require "#{BRISKBILLS_ROOT}/lib/utilities.rb"
+
 class Activity::Labor < ActiveRecord::Base
   has_one :slimtimer_time_entry, :foreign_key => :activity_labor_id, :class_name => "::SlimtimerTimeEntry"
 end

data/app/models/client.rb

@@ -23,9 +23,11 @@ class Client < ActiveRecord::Base
   def uninvoiced_activities_balance( force_reload = false )
     (attribute_present? :uninvoiced_activities_balance_in_cents and !force_reload) ?
       Money.new(read_attribute(:uninvoiced_activities_balance_in_cents).to_i) :
-      (Activity.sum( Invoice::ACTIVITY_TOTAL_SQL, :conditions => ['client_id = ? AND is_published = ? AND invoice_id IS NULL',id, true] ) or 0.0)
+      (Activity.sum( Invoice::ACTIVITY_TOTAL_SQL, :conditions => ['client_id = ? AND is_published = ? AND invoice_id IS NULL',id, true] ) or 0)
   end
   
+  # THis is the client's outstanding balance. This value is calculated based off the total invoices amount - total payments amount. And is 
+  # Not determined based on invoice/payment assignments 
   def balance( force_reload = false )
     Money.new(
       (attribute_present? :balance_in_cents and !force_reload) ?
@@ -77,8 +79,8 @@ class Client < ActiveRecord::Base
   def mailing_address
     ret = []
     
-    %w(name address1 address2).each do |f|
-      val = send(f.to_sym) and ( ret <<val if val.length )
+    %w( name address1 address2 ).each do |f|
+      val = send(f.to_sym) and ( ret << val if val.length )
     end
 
     ret << '%s%s %s' % [
@@ -89,5 +91,93 @@ class Client < ActiveRecord::Base
 
     ret
   end
+    
+  # Returns an array of unsaved InvoicePayment objects, with unset payment_ids, and 'recommended' amounts.
+  # If the provided amount exactly equals an outstanding invoice's amount, we return a InvoicePayment for the oldest such matching invoice. 
+  # Otherwise, we start applying the amount to invoices in ascending order by issued_date.
+  def recommend_invoice_assignments_for(amount)
+    amount = amount.to_money
+
+    invs = unpaid_invoices(
+      :all,
+      # Using this order forces the closest-amount match to be above anything else, followed by date sorting
+      :order => '(amount_outstanding_in_cents = %d) DESC, issued_on ASC, created_at ASC' % amount.cents
+    )
+
+    unassigned_outstanding = invs.inject(Money.new(0)){|total, inv| total + inv.amount_outstanding}
+    
+    invs.collect{ |inv|
+      if amount > 0 and unassigned_outstanding > 0
+        assignment = (amount >= inv.amount_outstanding) ? 
+            inv.amount_outstanding : 
+            amount
+        
+        unassigned_outstanding -= assignment
+        amount  -= assignment
+        
+        InvoicePayment.new :invoice => inv, :amount => assignment if assignment > 0
+      end
+    }.compact
+  end
+  
+  # Returns an array of unsaved InvoicePayment objects, with unset invoice_ids, and 'recommended' amounts.
+  # If the provided amount exactly equals an payment's unalloated amount, we return a InvoicePayment for the oldest such matching payment. 
+  # Otherwise, we start applying the amount to payments in ascending order by issued_date.
+  def recommend_payment_assignments_for(amount, verbose_inclusion = false)
+    amount = amount.to_money
+    
+    pymnts = unassigned_payments(
+      :all,
+      # Using this order forces the closest-amount match to be above anything else, followed by date sorting
+      :order => '(amount_unallocated_in_cents = %d) DESC, paid_on ASC, created_at ASC' % amount.cents
+    )
+
+    current_client_balance = pymnts.inject(Money.new(0)){|total, pmnt| total - pmnt.amount_unallocated}
+  
+    pymnts.collect{ |unallocated_pmnt|
+      if amount > 0 or current_client_balance < 0
+        assignment = (unallocated_pmnt.amount_unallocated > amount) ?
+          amount :
+          unallocated_pmnt.amount_unallocated
+        
+        current_client_balance += assignment
+        amount -= assignment
+        
+        InvoicePayment.new :payment => unallocated_pmnt, :amount => assignment if assignment > 0
+      end
+    }.compact
+  end
+
+  # Returns all the client's invoices for which the allocated payments is less than the invoice amount. Perhaps this should be a has_many,
+  # But since we're using the find_with_totals that would get complicated... 
+  def unpaid_invoices( how_many = :all, options = {} )
+    Invoice.find_with_totals(
+      how_many, 
+      {:conditions => [
+        [
+        'client_id = ?',
+        'is_published = ?',
+        'IF(activities_total.total_in_cents IS NULL, 0,activities_total.total_in_cents) - '+
+        'IF(invoices_total.total_in_cents IS NULL, 0,invoices_total.total_in_cents) > ?'
+        ].join(' AND '),
+        id, true, 0
+      ]}.merge(options.reject{|k,v| k == :conditions})
+    )
+  end
+
+  # Returns all the client's payments for which the invoice allocation is less than the payment amount. Perhaps this should be a has_many,
+  # But since we're using the find_with_totals that would get complicated... 
+  def unassigned_payments( how_many = :all, options = {} )
+    Payment.find_with_totals( 
+      how_many, 
+      {:conditions => [
+        [
+        'client_id = ?',
+        '(payments.amount_in_cents - IF(payments_total.amount_allocated_in_cents IS NULL, 0, payments_total.amount_allocated_in_cents) ) > ?'
+        ].join(' AND '),
+        id, 0
+      ]}.merge(options.reject{|k,v| k == :conditions}) 
+    )
+  end
 
 end