mirror of
https://github.com/opf/openproject.git
synced 2026-06-14 03:30:14 +00:00
Jan Sandbrink
f9d8bc6614
This error is intended for cases when a method is intentionally not implemented, because the module/class defining it expects a subclass (or class including the module) to implement the method. This is intended to distinguish it from other cases, such as: * feature not implemented yet * edge case of a method call not yet supported Notably it avoids the misuse of the Ruby-defined NotImplementedError, which is only intended for much more specific scenarios: > Raised when a feature is not implemented on the current platform. For example, methods depending on the fsync or fork system calls may raise this exception [...] Also see https://docs.ruby-lang.org/en/master/NotImplementedError.html
86 lines
2.3 KiB
Ruby
86 lines
2.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
#-- copyright
|
|
# OpenProject is an open source project management software.
|
|
# Copyright (C) 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 BaseServices
|
|
class BaseCallable
|
|
extend ActiveModel::Callbacks
|
|
define_model_callbacks :call
|
|
|
|
around_call :assign_state
|
|
|
|
def call(*args)
|
|
self.params = extract_options!(args).deep_symbolize_keys
|
|
|
|
run_callbacks(:call) do
|
|
perform(*args)
|
|
end
|
|
end
|
|
|
|
# Reuse or append state to the service
|
|
def with_state(state = {})
|
|
@state = ::Shared::ServiceState.build(state)
|
|
self
|
|
end
|
|
|
|
# Access to the shared service state.
|
|
def state
|
|
@state ||= ::Shared::ServiceState.build
|
|
end
|
|
|
|
protected
|
|
|
|
attr_accessor :params
|
|
|
|
def perform(*)
|
|
raise SubclassResponsibilityError
|
|
end
|
|
|
|
private
|
|
|
|
# Assign state to the service result obtained after the service call.
|
|
# Called by an `around_call` callback.
|
|
def assign_state
|
|
yield.tap do |service_result|
|
|
service_result.state = state
|
|
end
|
|
end
|
|
|
|
def extract_options!(args)
|
|
if args.last.is_a?(Hash)
|
|
args.pop
|
|
elsif args.last.respond_to?(:permitted?) && args.last.respond_to?(:to_h)
|
|
args.pop.to_h
|
|
else
|
|
{}
|
|
end
|
|
end
|
|
end
|
|
end
|