openproject/app/services/time_entries/delete_service.rb

#-- encoding: UTF-8

#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2018 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.
#
# 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.
#++

##
# Implements the deletion of a time entry.
class TimeEntries::DeleteService
  include Concerns::Contracted
  attr_accessor :user, :time_entry

  def initialize(user:, time_entry:)
    self.user = user
    self.time_entry = time_entry
    self.contract_class = TimeEntries::DeleteContract
  end

  ##
  # Deletes the given time entry if allowed.
  #
  # @return True if the deletion has been initiated, false otherwise.
  def call
    result, errors = validate_and_yield(time_entry, user) do
      time_entry.destroy
    end

    ServiceResult.new(success: result, errors: errors, result: time_entry)
  end
end