ama-team / ruby-entity-mapper

module AMA

  module Entity

    class Mapper

      module API

        # Class that proxies attribute setting on target entity. That allows

        # tricks like virtual attribute handling or multi-value attribute

        # handling (like in hash or array)

        class Injector < Interface

          # :nocov:

          # Injects passed attribute into entity.

          #

          # @param [Object] entity

          # @param [AMA::Entity::Mapper::Type] type

          # @param [AMA::Entity::Mapper::Type::Attribute] attribute

          # @param [Object] value

          # @param [AMA::Entity::Mapper::Context] context

          def inject(entity, type, attribute, value, context = nil)

            abstract_method

          end

          # :nocov:

        end

      end

    end

  end

end

module AMA

  module Entity

    class Mapper

      module API

        # This interface depicts factory for class instance creation.

        class Factory < Interface

          # :nocov:

          # @param [AMA::Entity::Mapper::Type] type Type that requires creation.

          #   While most probably it wouldn't be necessary, it is unknown until

          #   creation which exact type will be used (altering type parameters

          #   results in new type creation)

          # @param [Object] data Data that will be used for object creation.

          #   May be of any type or even nil.

          # @param [AMA::Entity::Mapper::Context] context

          # @return [Object] Object of passed type.

          def create(type, data = nil, context = nil)

            abstract_method

          end

          # :nocov:

        end

      end

    end

  end

end