openproject/modules/reporting/app/models/entry.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# 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.
#
# See COPYRIGHT and LICENSE files for more details.
#++

module Entry
  [TimeEntry, CostEntry].each { |e| e.send :include, self }

  class Delegator < ApplicationRecord
    # Rails 3.2.13 delegates most of the methods defined here to an
    # ActiveRecord::Relation (see active_record/querying.rb).
    # Thus only implementing the four find_x methods isn't enough
    # Rails 2.3 internally called these e.g. for all().
    # A quick fix is implementing all(), but we might need to reconsider how we
    # do the delegation here if more methods were based on the four find_xs.
    self.abstract_class = true
    class << self
      def ===(obj)
        TimeEntry === obj or CostEntry === obj
      end

      def calculate(type, *args)
        a = TimeEntry.calculate(type, *args)
        b = CostEntry.calculate(type, *args)
        case type
        when :sum, :count then a + b
        when :avg then (a + b) / 2
        when :min then [a, b].min
        when :max then [a, b].max
        else raise NotImplementedError
        end
      end

      undef_method :create, :update, :delete, :destroy, :new, :update_counters,
                   :increment_counter, :decrement_counter

      %w[update_all destroy_all delete_all].each do |meth|
        define_method(meth) { |*args| send_all(meth, *args) }
      end

      private

      def all(*args)
        ActiveSupport::Deprecation.warn('Passing arguments is deprecated') if args.any?
        find_many :all # *args
      end

      def count(*args)
        ActiveSupport::Deprecation.warn('Passing arguments is deprecated') if args.any?
        find_many :count # *args
      end

      def find_initial(options)         find_one  :find_initial,  options end

      def find_last(options)            find_one  :find_last,     options end

      def find_every(options)           find_many :find_every,    options end

      def find_from_ids(_args, options) find_many :find_from_ids, options end

      def find_one(*args)
        TimeEntry.send(*args) || CostEntry.send(*args)
      end

      def find_many(*args)
        TimeEntry.send(*args) + CostEntry.send(*args)
      end

      def send_all(*args)
        [TimeEntry.send(*args), CostEntry.send(*args)]
      end
    end
  end

  def units
    super
  rescue NoMethodError
    hours
  end

  def cost_type
    super
  rescue NoMethodError
  end

  def activity
    super
  rescue NoMethodError
  end

  def activity_id
    super
  rescue NoMethodError
  end

  def self.method_missing(*a, &b)
    Delegator.send(*a, &b)
  end
end