openproject/lib/open_project/costs/patches/query_patch.rb

#-- copyright
# OpenProject Costs Plugin
#
# Copyright (C) 2009 - 2014 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# version 3.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#++

module OpenProject::Costs::Patches::QueryPatch
  class CurrencyQueryColumn < QueryColumn
    unloadable
    include ActionView::Helpers::NumberHelper
    alias :super_value :value

    def value(work_package)
      number_to_currency(work_package.send(name))
    end

    def real_value(work_package)
      super_value work_package
    end

    def xls_formatter
      :cost
    end

    def xls_value(work_package)
      super_value work_package
    end
  end

  def self.included(base) # :nodoc:
    base.extend(ClassMethods)

    base.send(:include, InstanceMethods)

    # Same as typing in the class
    base.class_eval do
      unloadable # Send unloadable so it will not be unloaded in development

      add_available_column(QueryColumn.new(:cost_object_subject))
      add_available_column(CurrencyQueryColumn.new(:material_costs))
      add_available_column(CurrencyQueryColumn.new(:labor_costs))
      add_available_column(CurrencyQueryColumn.new(:overall_costs))

      Queries::WorkPackages::Filter.add_filter_type_by_field('cost_object_id', 'list_optional')

      alias_method_chain :available_work_package_filters, :costs
    end
  end

  module ClassMethods

    # Setter for +available_columns+ that isn't provided by the core.
    def available_columns=(v)
      self.available_columns = (v)
    end

    # Method to add a column to the +available_columns+ that isn't provided by the core.
    def add_available_column(column)
      self.available_columns << (column)
    end
  end

  module InstanceMethods

    # Wrapper around the +available_filters+ to add a new Cost Object filter
    def available_work_package_filters_with_costs
      @available_filters = available_work_package_filters_without_costs

      if project && project.module_enabled?(:costs_module)
        openproject_costs_filters = {
          "cost_object_id" => {
            :type => :list_optional,
            :order => 14,
            :values => CostObject.all(:conditions => ["project_id IN (?)", project], :order => 'subject ASC').collect { |d| [d.subject, d.id.to_s]}
          },
        }
      else
        openproject_costs_filters = { }
      end
      return @available_filters.merge(openproject_costs_filters)
    end
  end
end