Files
ubicloud/serializers/base.rb
Burak Yucesoy 3020f79d9d Allow serializers to be configured with options
We currently use structures for serializing same objects in different formats,
such as :default and :detailed. However, this approach is not flexible, because
to add an option which modifies both :default and :detailed formats, you need
to create 2 new structures.

For example, if you want to output slightly different information for :api and
:web options, you need to define :default_api, :detailed_api, :default_web and
:detailed_web structures.

With this change, you can pass options to the serializer, which then can be
used to alter the output. We also started to use options to distinguish between
default and detailed formats.

Apart from being more flexible, this approach allows using serializers without
creating serializer instances as all the methods become class methods. We also
cut the line count by 123.
2024-05-28 21:38:09 +03:00

41 lines
1.6 KiB
Ruby

# frozen_string_literal: true
# Based on Pliny: https://github.com/interagent/pliny/blob/master/lib/template/lib/serializers/base.rb
#
# Copyright (c) 2014 Brandur Leach and Pedro Belo
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
module Serializers
class Base
def self.serialize(object, options = {})
return if object.nil?
if object.respond_to?(:map) && !object.is_a?(Hash)
object.map { |item| serialize_internal(item, options) }
else
serialize_internal(object, options)
end
end
def self.serialize_internal(object, options = {})
raise NoMethodError
end
end
end