Method: Blueprinter::Base.render_as_hash

Defined in:
lib/blueprinter/base.rb

.render_as_hash(object, options = {}) ⇒ Hash

Generates a hash. Takes a required object and an optional view.

Examples:

Generating a hash with an extended view

post = Post.all
Blueprinter::Base.render_as_hash post, view: :extended
# => [{id:1, title: Hello},{id:2, title: My Day}]

Parameters:

  • object (Object)

    the Object to serialize upon.

  • options (Hash) (defaults to: {})

    the options hash which requires a :view. Any additional key value pairs will be exposed during serialization.

Options Hash (options):

  • :view (Symbol)

    Defaults to :default. The view name that corresponds to the group of fields to be serialized.

  • :root (Symbol|String)

    Defaults to nil. Render the json/hash with a root key if provided.

  • :meta (Any)

    Defaults to nil. Render the json/hash with a meta attribute with provided value if both root and meta keys are provided in the options hash.

Returns:

  • (Hash)


220
221
222
# File 'lib/blueprinter/base.rb', line 220

def self.render_as_hash(object, options = {})
  prepare_for_render(object, options)
end