Contents

module Shamu
  module JsonApi

    # Presenters are responsible for projecting an {Entities::Entity} or PORO
    # to a well-formatted JSON API {ResourceBuilder builder} response.
    #
    # {Presenter} delegates all of the {ResourceBuilder} methods for convenient
    # syntax.
    #
    # ```
    # class UserPresenter < ApplicationPresenter
    #   def present
    #     identifier :user, resource.id
    #
    #     attributes name: resource.name,
    #                email: resource.email
    #
    #     relationship( :address ) do |rel|
    #       rel.identifier :address, resource.address_id
    #       rel.link :related, user_address_url( resource, resource.address_id )
    #     end
    #   end
    # end
    # ```
    class Presenter

      # @param [Object] resource to presenter.
      # @param [ResourceBuilder] builder used to build the JSON API response.
      def initialize( resource, builder )
        @resource = resource
        @builder  = builder
      end

      # Serialize the `resource` to the `builder`.
      #
      # @return [void]
      def present
        fail NotImplementedError
      end

      private

        delegate :relationship, :attribute, :attributes, :link, :identifier, :meta, to: :builder

        attr_reader :resource
        attr_reader :builder


        # Present all the named attributes of the {#resource}.
        # @param [Array<Symbol>] names of the resource to present.
        def resource_attributes( *names )
          names.map do |name|
            attribute name, attribute_value( resource.send( name ) )
          end
        end

        # Get a JSON API safe version of the value.
        # @param [Object] value the value to be coerced.
        # @return [Object]
        def attribute_value( value )
          case value
          when Date, DateTime then
            value.to_date.to_time.iso8601
          when Time, ActiveSupport::TimeWithZone then
            value.iso8601
          else value
          end
        end

    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
shamu-0.0.11	lib/shamu/json_api/presenter.rb