class JbuilderTemplate

Attributes

template_lookup_options[RW]

Public Class Methods

new(context, *args) click to toggle source
Calls superclass method Jbuilder.new
# File lib/jbuilder/jbuilder_template.rb, line 12
def initialize(context, *args)
  @context = context
  super(*args)
end

Public Instance Methods

array!(collection = [], *attributes) click to toggle source
Calls superclass method Jbuilder#array!
# File lib/jbuilder/jbuilder_template.rb, line 38
def array!(collection = [], *attributes)
  options = attributes.extract_options!

  if options.key?(:partial)
    partial! options[:partial], options.merge(collection: collection)
  else
    super
  end
end
cache!(key=nil, options={}) { |self| ... } click to toggle source

Caches the json constructed within the block passed. Has the same signature as the `cache` helper method in `ActionView::Helpers::CacheHelper` and so can be used in the same way.

Example:

json.cache! ['v1', @person], expires_in: 10.minutes do
  json.extract! @person, :name, :age
end
# File lib/jbuilder/jbuilder_template.rb, line 56
def cache!(key=nil, options={})
  if @context.controller.perform_caching
    value = ::Rails.cache.fetch(_cache_key(key, options), options) do
      _scope { yield self }
    end

    merge! value
  else
    yield
  end
end
cache_if!(condition, *args) { || ... } click to toggle source

Conditionally catches the json depending in the condition given as first parameter. Has the same signature as the `cache` helper method in `ActionView::Helpers::CacheHelper` and so can be used in the same way.

Example:

json.cache_if! !admin?, @person, expires_in: 10.minutes do
  json.extract! @person, :name, :age
end
# File lib/jbuilder/jbuilder_template.rb, line 77
def cache_if!(condition, *args)
  condition ? cache!(*args, &::Proc.new) : yield
end
partial!(name_or_options, locals = {}) click to toggle source
# File lib/jbuilder/jbuilder_template.rb, line 17
def partial!(name_or_options, locals = {})
  case name_or_options
  when ::Hash
    # partial! partial: 'name', foo: 'bar'
    options = name_or_options
  else
    # partial! 'name', locals: {foo: 'bar'}
    if locals.one? && (locals.keys.first == :locals)
      options = locals.merge(partial: name_or_options)
    else
      options = { partial: name_or_options, locals: locals }
    end
    # partial! 'name', foo: 'bar'
    as = locals.delete(:as)
    options[:as] = as if as.present?
    options[:collection] = locals[:collection] if locals.key?(:collection)
  end

  _render_partial_with_options options
end

Protected Instance Methods

_cache_key(key, options) click to toggle source
# File lib/jbuilder/jbuilder_template.rb, line 108
def _cache_key(key, options)
  key = _fragment_name_with_digest(key, options)
  key = url_for(key).split('://', 2).last if ::Hash === key
  ::ActiveSupport::Cache.expand_cache_key(key, :jbuilder)
end
_render_partial(options) click to toggle source
# File lib/jbuilder/jbuilder_template.rb, line 103
def _render_partial(options)
  options[:locals].merge! json: self
  @context.render options
end
_render_partial_with_options(options) click to toggle source
# File lib/jbuilder/jbuilder_template.rb, line 83
def _render_partial_with_options(options)
  options.reverse_merge! locals: {}
  options.reverse_merge! ::JbuilderTemplate.template_lookup_options
  as = options[:as]

  if as && options.key?(:collection)
    as = as.to_sym
    collection = options.delete(:collection)
    locals = options.delete(:locals)
    array! collection do |member|
      member_locals = locals.clone
      member_locals.merge! collection: collection
      member_locals.merge! as => member
      _render_partial options.merge(locals: member_locals)
    end
  else
    _render_partial options
  end
end

Private Instance Methods

_fragment_name_with_digest(key, options) click to toggle source
# File lib/jbuilder/jbuilder_template.rb, line 116
def _fragment_name_with_digest(key, options)
  if @context.respond_to?(:cache_fragment_name)
    # Current compatibility, fragment_name_with_digest is private again and cache_fragment_name
    # should be used instead.
    @context.cache_fragment_name(key, options)
  elsif @context.respond_to?(:fragment_name_with_digest)
    # Backwards compatibility for period of time when fragment_name_with_digest was made public.
    @context.fragment_name_with_digest(key)
  else
    key
  end
end
_mapable_arguments?(value, *args) click to toggle source
Calls superclass method Jbuilder#_mapable_arguments?
# File lib/jbuilder/jbuilder_template.rb, line 129
def _mapable_arguments?(value, *args)
  return true if super
  options = args.last
  ::Hash === options && options.key?(:as)
end