Merge branch '4477-fixed-expenses'

app/helpers/contracts_helper.rb

@@ -3,6 +3,7 @@ module ContractsHelper
     returning(deliverable) do |d|
       d.labor_budgets.build if d.labor_budgets.empty?
       d.overhead_budgets.build if d.overhead_budgets.empty?
+      d.fixed_budgets.build if d.fixed_budgets.empty?
     end
   end
 

app/models/contract.rb

@@ -36,8 +36,6 @@ class Contract < ActiveRecord::Base
   named_scope :by_name, {:order => "#{Contract.table_name}.name ASC"}
   
   [:status, :contract_type,
-   :fixed_spent, :fixed_budget,
-   :markup_spent, :markup_budget,
    :discount_spent, :discount_budget
   ].each do |mthd|
     define_method(mthd) { "TODO in later release" }
@@ -96,6 +94,26 @@ class Contract < ActiveRecord::Base
   end
   alias_method :profit_spent, :profit_left
 
+  # OPTIMIZE: N+1
+  def fixed_budget
+    deliverables.inject(0) {|total, deliverable| total += deliverable.fixed_budget_total }
+  end
+
+  # OPTIMIZE: N+1
+  def fixed_spent
+    deliverables.inject(0) {|total, deliverable| total += deliverable.fixed_budget_total_spent }
+  end
+
+  # OPTIMIZE: N+1
+  def fixed_markup_budget
+    deliverables.inject(0) {|total, deliverable| total += deliverable.fixed_markup_budget_total }
+  end
+  
+  # OPTIMIZE: N+1
+  def fixed_markup_spent
+    deliverables.inject(0) {|total, deliverable| total += deliverable.fixed_markup_budget_total_spent }
+  end
+  
   def after_initialize
     self.executed = false unless self.executed.present?
   end

app/models/deliverable.rb

@@ -8,10 +8,12 @@ class Deliverable < ActiveRecord::Base
   belongs_to :manager, :class_name => 'User', :foreign_key => 'manager_id'
   has_many :labor_budgets
   has_many :overhead_budgets
+  has_many :fixed_budgets
   has_many :issues
 
   accepts_nested_attributes_for :labor_budgets
   accepts_nested_attributes_for :overhead_budgets
+  accepts_nested_attributes_for :fixed_budgets
   
   # Validations
   validates_presence_of :title
@@ -86,6 +88,24 @@ class Deliverable < ActiveRecord::Base
     issues.inject(0) {|total, issue| total += issue.spent_hours }
   end
 
+  def fixed_budget_total(date=nil)
+    fixed_budgets.sum(:budget)
+  end
+
+  def fixed_budget_total_spent(date=nil)
+    fixed_budgets.paid.sum(:budget)
+  end
+
+  # OPTIMIZE: N+1
+  def fixed_markup_budget_total(date=nil)
+    fixed_budgets.inject(0) {|total, fixed_budget| total += fixed_budget.markup_value }
+  end
+  
+  # OPTIMIZE: N+1
+  def fixed_markup_budget_total_spent(date=nil)
+    fixed_budgets.paid.inject(0) {|total, fixed_budget| total += fixed_budget.markup_value }
+  end
+  
   def filter_by_date(date=nil, &block)
     block.call
   end

app/models/fixed_budget.rb

@@ -0,0 +1,65 @@
+class FixedBudget < ActiveRecord::Base
+  unloadable
+
+  # Associations
+  belongs_to :deliverable
+
+  # Validations
+
+  # Accessors
+  def budget=(v)
+    if v.is_a? String
+      write_attribute(:budget, v.gsub(/[$ ,]/, ''))
+    else
+      write_attribute(:budget, v)
+    end
+  end
+
+  named_scope :by_period, lambda {|date|
+    if date
+      {
+        :conditions => {:year => date.year, :month => date.month}
+      }
+    end
+  }
+
+  named_scope :paid, {:conditions => {:paid => true}}
+
+  def markup_value
+    return 0 if budget.blank? || markup.blank?
+
+    case
+    when percent_markup?
+      percent = markup.gsub('%','').to_f
+      return budget.to_f * (percent / 100)
+    when straight_markup?
+      markup.gsub('$','').gsub(',','').to_f
+    else
+      0 # Invalid markup
+    end
+    
+  end
+
+  def budget_spent
+    if paid?
+      budget
+    else
+      0
+    end
+  end
+
+  def percent_markup?
+    markup && markup.match(/%/)
+  end
+
+  def straight_markup?
+    markup && markup.match(/\$/)
+  end
+
+  # Is this a blank budget item. Retainers will create blank ones when
+  # they are copied. (RetainerDeliverable#create_budgets_for_periods)
+  def blank_record?
+    return true if new_record?
+    return title.blank? && budget.blank? && markup.blank?
+  end
+end

app/models/fixed_deliverable.rb

@@ -23,14 +23,14 @@ class FixedDeliverable < Deliverable
   # The amount of profit that is budgeted for this deliverable.
   # Profit = Total - ( Labor + Overhead + Fixed + Markup )
   def profit_budget(date=nil)
-    budgets = labor_budget_total(date) + overhead_budget_total(date)
+    budgets = labor_budget_total(date) + overhead_budget_total(date) + fixed_budget_total(date) + fixed_markup_budget_total(date)
     (total(date) || 0.0) - budgets
   end
 
   # The amount of money remaining after expenses have been taken out
-  # Profit left = Total - Labor spent - Overhead spent
+  # Profit left = Total - Labor spent - Overhead spent - Fixed - Markup
   def profit_left(date=nil)
-    total_spent(date) - labor_budget_spent(date) - overhead_spent(date)
+    total_spent(date) - labor_budget_spent(date) - overhead_spent(date) - fixed_budget_total_spent(date) - fixed_markup_budget_total_spent(date)
   end
   
   # Hardcoded value used as a wrapper for the old Budget plugin API.

app/models/hourly_deliverable.rb

@@ -14,12 +14,14 @@ class HourlyDeliverable < Deliverable
     'H'
   end
 
+  # Total = ( Labor Hours * Billing Rate ) + ( Fixed + Markup )
   def total(date=nil)
     return 0 if contract.nil?
     return 0 if contract.billable_rate.blank?
     return 0 if labor_budgets.count == 0 && overhead_budgets.count == 0
 
-    return contract.billable_rate * labor_budget_hours(date)
+    fixed_budget_amount = fixed_budget_total(date) + fixed_markup_budget_total(date)
+    return (contract.billable_rate * labor_budget_hours(date)) + fixed_budget_amount
   end
 
   # Total amount to be billed on the deliverable, using the total time logged
@@ -50,13 +52,13 @@ class HourlyDeliverable < Deliverable
   # The amount of profit that is budgeted for this deliverable
   # Profit = Total - ( Labor + Overhead + Fixed + Markup )
   def profit_budget(date=nil)
-    budgets = labor_budget_total(date) + overhead_budget_total(date)
+    budgets = labor_budget_total(date) + overhead_budget_total(date) + fixed_budget_total(date) + fixed_markup_budget_total(date)
     (total(date) || 0.0) - budgets
   end
 
   # The amount of money remaining after expenses have been taken out
-  # Profit left = Total - Labor spent - Overhead spent
+  # Profit left = Total - Labor spent - Overhead spent - Fixed - Markup
   def profit_left(date=nil)
-    total_spent(date) - labor_budget_spent(date) - overhead_spent(date)
+    total_spent(date) - labor_budget_spent(date) - overhead_spent(date) - fixed_budget_total_spent(date) - fixed_markup_budget_total_spent(date)
   end
 end

app/models/retainer_deliverable.rb

@@ -94,6 +94,12 @@ class RetainerDeliverable < HourlyDeliverable
     budgets
   end
 
+  def fixed_budgets_for_date(date)
+    budgets = fixed_budgets.all(:conditions => {:year => date.year, :month => date.month})
+    budgets = [fixed_budgets.build(:year => date.year, :month => date.month)] if budgets.empty?
+    budgets
+  end
+
   def labor_budget_total(date=nil)
     case scope_date_status(date)
     when :in
@@ -127,6 +133,55 @@ class RetainerDeliverable < HourlyDeliverable
     end
   end
 
+  def fixed_budget_total(date=nil)
+    case scope_date_status(date)
+    when :in
+      fixed_budgets.sum(:budget, :conditions => {:year => date.year, :month => date.month})
+    when :out
+      0
+    else
+      super
+    end
+  end
+
+  def fixed_budget_total_spent(date=nil)
+    case scope_date_status(date)
+    when :in
+      fixed_budgets.paid.sum(:budget, :conditions => {:year => date.year, :month => date.month})
+    when :out
+      0
+    else
+      super
+    end
+  end
+
+  def fixed_markup_budget_total(date=nil)
+    case scope_date_status(date)
+    when :in
+      fixed_budgets.
+        all(:conditions => {:year => date.year, :month => date.month}).
+        inject(0) {|total, fixed_budget| total += fixed_budget.markup_value }
+    when :out
+      0
+    else
+      super
+    end
+  end
+
+  def fixed_markup_budget_total_spent(date=nil)
+    case scope_date_status(date)
+    when :in
+      fixed_budgets.
+        paid.
+        all(:conditions => {:year => date.year, :month => date.month}).
+        inject(0) {|total, fixed_budget| total += fixed_budget.markup_value }
+    when :out
+      0
+    else
+      super
+    end
+  end
+
   def total_spent(date=nil)
     case scope_date_status(date)
     when :in
@@ -231,10 +286,16 @@ class RetainerDeliverable < HourlyDeliverable
       undated_overhead_budgets.each do |template_budget|
         overhead_budgets.create(template_budget.attributes.merge(:year => month.year, :month => month.month))
       end
+
+      undated_fixed_budgets = fixed_budgets.all(:conditions => ["#{FixedBudget.table_name}.year IS NULL AND #{FixedBudget.table_name}.month IS NULL"])
+      undated_fixed_budgets.each do |template_budget|
+        fixed_budgets.create(template_budget.attributes.merge(:year => month.year, :month => month.month))
+      end
     end
     # Destroy origional un-dated budgets
     labor_budgets.all(:conditions => ["#{LaborBudget.table_name}.year IS NULL AND #{LaborBudget.table_name}.month IS NULL"]).collect(&:destroy)
     overhead_budgets.all(:conditions => ["#{OverheadBudget.table_name}.year IS NULL AND #{OverheadBudget.table_name}.month IS NULL"]).collect(&:destroy)
+    fixed_budgets.all(:conditions => ["#{FixedBudget.table_name}.year IS NULL AND #{FixedBudget.table_name}.month IS NULL"]).collect(&:destroy)
   end
 
   def check_for_extended_period
@@ -281,6 +342,17 @@ class RetainerDeliverable < HourlyDeliverable
       end
     end
 
+    fixed_budgets.all.each do |fixed_budget|
+      # Purge un-dated budgets, should not be saved at all
+      fixed_budget.destroy unless fixed_budget.year.present?
+      fixed_budget.destroy unless fixed_budget.month.present?
+
+      # Purge budgets outside the new beginning/ending range
+      unless (beginning_date..ending_date).to_a.include?(Date.new(fixed_budget.year, fixed_budget.month, 1))
+        fixed_budget.destroy
+      end
+    end
+
     true
   end
 
@@ -290,9 +362,10 @@ class RetainerDeliverable < HourlyDeliverable
     old_end_date = end_date_change[0]
     last_labor_budgets = labor_budgets.all(:conditions => {:year => old_end_date.year, :month => old_end_date.month})
     last_overhead_budgets = overhead_budgets.all(:conditions => {:year => old_end_date.year, :month => old_end_date.month})
-
+    last_fixed_budgets = fixed_budgets.all(:conditions => {:year => old_end_date.year, :month => old_end_date.month})
+    
     months_after_date(old_end_date.end_of_month.to_date).each do |new_period|
-      create_budgets_for_new_period(new_period, last_labor_budgets, last_overhead_budgets)
+      create_budgets_for_new_period(new_period, last_labor_budgets, last_overhead_budgets, last_fixed_budgets)
     end
   end
 
@@ -302,14 +375,15 @@ class RetainerDeliverable < HourlyDeliverable
     old_start_date = start_date_change[0]
     first_labor_budgets = labor_budgets.all(:conditions => {:year => old_start_date.year, :month => old_start_date.month})
     first_overhead_budgets = overhead_budgets.all(:conditions => {:year => old_start_date.year, :month => old_start_date.month})
+    first_fixed_budgets = fixed_budgets.all(:conditions => {:year => old_start_date.year, :month => old_start_date.month})
     
     months_before_date(old_start_date.beginning_of_month.to_date).each do |new_period|
-      create_budgets_for_new_period(new_period, first_labor_budgets, first_overhead_budgets)
+      create_budgets_for_new_period(new_period, first_labor_budgets, first_overhead_budgets, first_fixed_budgets)
     end
 
   end
 
-  def create_budgets_for_new_period(new_period, labor_budgets_to_copy, overhead_budgets_to_copy)
+  def create_budgets_for_new_period(new_period, labor_budgets_to_copy, overhead_budgets_to_copy, fixed_budgets_to_copy)
     labor_budgets_to_copy.each do |labor_budget_to_copy|
       create_new_labor_budget_based_on_existing_budget(labor_budget_to_copy, 'year' => new_period.year, 'month' => new_period.month)
     end
@@ -317,6 +391,10 @@ class RetainerDeliverable < HourlyDeliverable
     overhead_budgets_to_copy.each do |overhead_budget_to_copy|
       create_new_overhead_budget_based_on_existing_budget(overhead_budget_to_copy, 'year' => new_period.year, 'month' => new_period.month)
     end
+
+    fixed_budgets_to_copy.each do |fixed_budget_to_copy|
+      create_new_fixed_budget_based_on_existing_budget(fixed_budget_to_copy, 'year' => new_period.year, 'month' => new_period.month)
+    end
   end
   
   def create_new_labor_budget_based_on_existing_budget(existing_labor_budget, attributes={})
@@ -327,6 +405,10 @@ class RetainerDeliverable < HourlyDeliverable
     overhead_budgets.create(existing_overhead_budget.attributes.except('id').merge(attributes))
   end
 
+  def create_new_fixed_budget_based_on_existing_budget(existing_fixed_budget, attributes={})
+    fixed_budgets.create(existing_fixed_budget.attributes.except('id').merge(attributes))
+  end
+
   def scope_date_status(date)
     if date
       if within_date_range?(date)

app/views/contracts/show.html.erb

@@ -44,7 +44,7 @@
         <%= show_budget_field(resource, :labor_spent, :labor_budget, :format => :format_value_field_for_contracts, :html_options => {:class => 'contract-labor'}, :label_html_options => {:width => '46%'}) %>
         <%= show_budget_field(resource, :overhead_spent, :overhead_budget, :format => :format_value_field_for_contracts, :html_options => {:class => 'contract-overhead'}) %>
         <%= show_budget_field(resource, :fixed_spent, :fixed_budget, :format => :format_value_field_for_contracts, :html_options => {:class => 'contract-fixed'}) %>
-        <%= show_budget_field(resource, :markup_spent, :markup_budget, :format => :format_value_field_for_contracts, :html_options => {:class => 'contract-markup'}) %>
+        <%= show_budget_field(resource, :fixed_markup_spent, :fixed_markup_budget, :format => :format_value_field_for_contracts, :html_options => {:class => 'contract-markup'}) %>
         <%= show_budget_field(resource, :profit_spent, :profit_budget, :format => :format_value_field_for_contracts, :html_options => {:class => 'contract-profit'}) %>
         <%= show_budget_field(resource, :discount_spent, :discount_budget, :format => :format_value_field_for_contracts, :html_options => {:class => 'contract-discount'}) %>
 
@@ -104,7 +104,7 @@
               <td width="15%" class="manager"><%= h deliverable.manager.try(:name) %></td>
               <%= format_budget_for_deliverable(deliverable, deliverable.labor_budget_spent, deliverable.labor_budget_total, :class => 'labor') %>
               <%= format_budget_for_deliverable(deliverable, deliverable.overhead_spent, deliverable.overhead_budget_total, :class => 'overhead') %>
-              <%= format_budget_for_deliverable(deliverable, 0, 0) %><%# TODO: Release 2, Fixed Budgets %>
+              <%= format_budget_for_deliverable(deliverable, deliverable.fixed_budget_total_spent, deliverable.fixed_budget_total, :class => 'fixed') %>
             <% end %>
 
             <tr id="deliverable_details_<%= h(deliverable.id) %>" class="ign">

app/views/deliverables/_details_row.html.erb

@@ -62,8 +62,24 @@
                           <td class="overhead_budget_total"><%= h(format_value_field_for_contracts(deliverable.overhead_budget_total(validated_period))) %></td>
                           <td> TODO: Release 2 / TODO hrs </td>
                         </tr>
-                        <%# TODO: Release 2, Fixed %>
-                        <%# TODO: Release 2, Markup %>
+
+                        <% deliverable.fixed_budgets.by_period(period).each do |fixed_budget| %>
+                        <% next if fixed_budget.blank_record? %>
+                        <tr id="fixed_budget_<%= fixed_budget.id %>">
+                          <td class="l fixed_title" title="<%= h(fixed_budget.description) %>"><%= h(fixed_budget.title) %></td>
+                          <td class="fixed_budget_spent"><%= h(format_value_field_for_contracts(fixed_budget.budget_spent)) %></td>
+                          <td class="fixed_budget_total"><%= h(format_value_field_for_contracts(fixed_budget.budget)) %></td>
+                          <td></td>
+                        </tr>
+                        <% end %>
+
+                        <tr>
+                          <td class="l"><%= l(:field_markup) %></td>
+                          <td class="fixed_markup_budget_spent"><%= h(format_value_field_for_contracts(deliverable.fixed_markup_budget_total_spent(period))) %></td>
+                          <td class="fixed_markup_budget_total"><%= h(format_value_field_for_contracts(deliverable.fixed_markup_budget_total(period))) %></td>
+                          <td></td>
+                        </tr>
+
                         <tr>
                           <td class="l">Profit</td>
                           <td><%= h(format_value_field_for_contracts(deliverable.profit_left(validated_period))) %></td>

app/views/deliverables/_finance_form.html.erb

@@ -62,6 +62,46 @@
     </table>
   </li>
 
+  <li class="numeric optional">
+    <div id="deliverable-fixed" class="fixed-item-form">
+		  <label for="contract_discount">Fixed</label>
+
+      <% form.fields_for :fixed_budgets, fixed_budgets do |fixed_budget| %>
+        <%= fixed_budget.hidden_field(:year) %>
+        <%= fixed_budget.hidden_field(:month) %>
+
+        <p class="inline-hints" style="display:none;"><%= fixed_budget.label(:title, l(:field_title))%></p>
+        <%= fixed_budget.text_field(:title) %>
+        
+        <p class="inline-hints">
+          <%= fixed_budget.label(:budget, l(:field_budget), :style => 'display: none;')%> <%# Hidden label :| %>
+          <%= l(:text_dollar_sign) %>
+        </p>
+		    <%= fixed_budget.text_field(:budget) %>
+
+		    <p class="inline-hints">
+          <%= fixed_budget.label(:markup, l(:field_markup), :style => 'display: none;')%> <%# Hidden label :| %>
+          <%= l(:field_discount_hint) %>
+        </p>
+        <%= fixed_budget.text_field(:markup) %>
+
+        <p class="inline-hints">
+          <%= fixed_budget.label(:paid, l(:field_paid), :style => 'display: none;') %><%# Hidden label :| %>
+          <%= l(:field_paid) %>
+        </p>
+        <%= fixed_budget.check_box(:paid) %>
+
+        <p class="inline-hints" style="display:none;"><%= fixed_budget.label(:description, l(:field_description), :for => "fixed-description#{fixed_budget.object.object_id}")%></p>
+        <%= fixed_budget.text_area(:description, :class => 'wiki-edit', :rows => '5', :id => "fixed-description#{fixed_budget.object.object_id}") %>
+        <%= wikitoolbar_for "fixed-description#{fixed_budget.object.object_id}" %>
+
+        <p>Todo: Add button (Release 3)</p>
+      <% end %>
+	  </div>
+	  
+
+  </li>
+
   <%= form.input :total, :input_html => {:size => 10}, :wrapper_html => {:class => 'deliverable_total_input'}, :hint => l(:text_dollar_sign) %>
 
 <% end %>

app/views/deliverables/_form.html.erb

@@ -3,7 +3,7 @@
 <%= javascript_tag("var i18nChangedPeriodMessage = '#{l(:text_changed_period_message)}'") %>
 
 <div class="box tabular">
-<% form.inputs :name => l(:text_deliverable_details_legend) do %>
+<% form.inputs :name => l(:text_deliverable_details_legend), :id => 'deliverable-details' do %>
   <%# Used by jquery to check if this is a new or existing record %>
   <%= hidden_field_tag('deliverable_id', h(resource.id), :id => 'deliverable_stored_id') %>
   <%= form.input :title, :required => true %>
@@ -40,13 +40,13 @@
 <% if resource.retainer? && resource.respond_to?(:months) %>
 <% if resource.months.present? %>
 <% resource.months.each do |month| %>
-<%= render :partial => 'finance_form', :locals => {:form => form, :labor_budgets => resource.labor_budgets_for_date(month), :overhead_budgets => resource.overhead_budgets_for_date(month), :label => l(:text_deliverable_finances_date, :date => month.strftime("%B, %Y")), :fieldset_class => 'date-' + month.strftime('%Y-%m') } %>
+<%= render :partial => 'finance_form', :locals => {:form => form, :labor_budgets => resource.labor_budgets_for_date(month), :overhead_budgets => resource.overhead_budgets_for_date(month), :fixed_budgets => resource.fixed_budgets_for_date(month), :label => l(:text_deliverable_finances_date, :date => month.strftime("%B, %Y")), :fieldset_class => 'date-' + month.strftime('%Y-%m') } %>
 <% end %>
 <% else %>
 <%= content_tag(:p, l(:text_missing_period), :class => 'nodata') %>
 <% end %>
 <% else %>
-<%= render :partial => 'finance_form', :locals => {:form => form, :labor_budgets => resource.labor_budgets, :overhead_budgets => resource.overhead_budgets, :label => l(:text_deliverable_finances), :fieldset_class => '' } %>
+<%= render :partial => 'finance_form', :locals => {:form => form, :labor_budgets => resource.labor_budgets, :overhead_budgets => resource.overhead_budgets, :fixed_budgets => resource.fixed_budgets, :label => l(:text_deliverable_finances), :fieldset_class => '' } %>
 <% end %>
 
 </div>