openproject/lib/api/v3/string_objects/string_object_representer.rb

#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2017 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 doc/COPYRIGHT.rdoc for more details.
#++

require 'roar/decorator'
require 'roar/json/hal'

module API
  module V3
    module StringObjects
      class StringObjectRepresenter < ::API::Decorators::Single
        # accepting current_user as argument to match common interface, we do not need it though
        def initialize(string, current_user: nil)
          super(string, current_user: nil)
        end

        link :self do
          {
            href: api_v3_paths.string_object(represented)
          }
        end

        property :value,
                 exec_context: :decorator,
                 # empty values sometimes get passed as nil. Thus we make sure that we will always
                 # display an empty string
                 # (nil values are not supported by a string_objects URL anyway)
                 getter: -> (*) { represented || '' }

        private

        def _type
          'StringObject'
        end

        def model_required?
          # the string may also be nil, we are prepared for that
          false
        end
      end
    end
  end
end