Files
openproject/app/services/api/parse_resource_params_service.rb
Jan Sandbrink f9d8bc6614 Introduce SubclassResponsibility error
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
2026-03-27 08:14:56 +01:00

96 lines
2.7 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 API
class ParseResourceParamsService
attr_accessor :model,
:representer,
:current_user
def initialize(user, model: nil, representer: nil)
self.current_user = user
self.model = model
self.representer = if representer
representer
elsif model
deduce_representer(model)
else
raise "Representer not defined"
end
end
def call(request_body)
parsed = if request_body
parse_attributes(request_body)
else
{}
end
ServiceResult.success(result: parsed)
end
private
def deduce_representer(_model)
raise SubclassResponsibilityError
end
def parsing_representer
representer
.new(struct, current_user:)
end
def parse_attributes(request_body)
struct = parsing_representer
.from_hash(request_body)
deep_to_h(struct)
.deep_symbolize_keys
end
def struct
ParserStruct.new
end
def deep_to_h(value)
# Does not yet factor in Arrays. There hasn't been the need to do that, yet.
case value
when Hash, ParserStruct
value.to_h.transform_values do |sub_value|
deep_to_h(sub_value)
end
else
value
end
end
end
end