openproject/app/models/work_package/spent_time.rb

#-- encoding: UTF-8

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2020 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-2017 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 docs/COPYRIGHT.rdoc for more details.
#++

class WorkPackage::SpentTime
  attr_accessor :user,
                :work_package

  def initialize(user, work_package = nil)
    @user = user
    @work_package = work_package
  end

  def scope
    with_spent_hours_joined
  end

  private

  def with_spent_hours_joined
    query = join_descendants(wp_table)
    query = join_time_entries(query)

    WorkPackage.joins(query.join_sources)
               .group(:id)
  end

  def join_descendants(select)
    select
      .outer_join(relations_table)
      .on(relations_join_descendants_condition)
      .outer_join(wp_descendants)
      .on(hierarchy_and_allowed_condition)
  end

  def join_time_entries(select)
    join_condition = time_entries_table[:work_package_id]
                     .eq(wp_descendants[:id])
                     .and(allowed_to_view_time_entries)

    select
      .outer_join(time_entries_table)
      .on(join_condition)
  end

  def relations_from_and_type_matches_condition
    relations_join_condition = relation_of_wp_and_hierarchy_condition

    non_hierarchy_type_columns.each do |type|
      relations_join_condition = relations_join_condition.and(relations_table[type].eq(0))
    end

    relations_join_condition
  end

  def relation_of_wp_and_hierarchy_condition
    wp_table[:id].eq(relations_table[:from_id]).and(relations_table[:hierarchy].gteq(0))
  end

  def relations_join_descendants_condition
    if work_package
      relations_from_and_type_matches_condition
        .and(wp_table[:id].eq(work_package.id))
    else
      relations_from_and_type_matches_condition
    end
  end

  def allowed_to_view_work_packages
    wp_descendants[:project_id].in(Project.allowed_to(user, :view_work_packages).select(:id).arel)
  end

  def allowed_to_view_time_entries
    time_entries_table[:id].in(TimeEntry.visible(user).select(:id).arel)
  end

  def hierarchy_and_allowed_condition
    self_or_descendant_condition
      .and(allowed_to_view_work_packages)
  end

  def self_or_descendant_condition
    relations_table[:to_id].eq(wp_descendants[:id])
  end

  def non_hierarchy_type_columns
    TypedDag::Configuration[WorkPackage].type_columns - [:hierarchy]
  end

  def wp_table
    @wp_table ||= WorkPackage.arel_table
  end

  def relations_table
    @relations || Relation.arel_table
  end

  def wp_descendants
    @wp_descendants ||= wp_table.alias('descendants')
  end

  def time_entries_table
    @time_entries_table ||= TimeEntry.arel_table
  end
end