Module: AbstractController::Layouts::ClassMethods

Defined in:
actionpack/lib/abstract_controller/layouts.rb

Defined Under Namespace

Modules: LayoutConditions

Instance Method Summary collapse

Instance Method Details

#_implied_layout_name ⇒ Object

If no layout is supplied, look for a template named the return value of this method.

Returns

  • String - A template name



266
267
268
 
# File 'actionpack/lib/abstract_controller/layouts.rb', line 266

def _implied_layout_name
  controller_path
end

#_write_layout_method ⇒ Object

Creates a _layout method to be called by _default_layout .

If a layout is not explicitly mentioned then look for a layout with the controller’s name. if nothing is found then try same procedure to find super class’s layout.



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'actionpack/lib/abstract_controller/layouts.rb', line 274

def _write_layout_method
  remove_possible_method(:_layout)

  prefixes    = _implied_layout_name =~ /\blayouts/ ? [] : ["layouts"]
  name_clause = if name
    <<-RUBY
      lookup_context.find_all("#{_implied_layout_name}", #{prefixes.inspect}).first || super
    RUBY
  end

  if defined?(@_layout)
    layout_definition = case @_layout
      when String
        @_layout.inspect
      when Symbol
        <<-RUBY
          #{@_layout}.tap do |layout|
            unless layout.is_a?(String) || !layout
              raise ArgumentError, "Your layout method :#{@_layout} returned \#{layout}. It " \
                "should have returned a String, false, or nil"
            end
          end
        RUBY
      when Proc
        define_method :_layout_from_proc, &@_layout
        "_layout_from_proc(self)"
      when false
        nil
      when true
        raise ArgumentError, "Layouts must be specified as a String, Symbol, false, or nil"
      when nil
        name_clause
      end
  else
    # Add a deprecation if the parent layout was explicitly set and the child
    # still does a dynamic lookup. In next Rails release, we should @_layout
    # to be inheritable so we can skip the child lookup if the parent explicitly
    # set the layout.
    parent   = self.superclass.instance_variable_get(:@_layout)
    @_layout = nil
    inspect  = parent.is_a?(Proc) ? parent.inspect : parent

    layout_definition = if parent.nil?
        name_clause
      elsif name
        <<-RUBY
          if template = lookup_context.find_all("#{_implied_layout_name}", #{prefixes.inspect}).first
            ActiveSupport::Deprecation.warn 'Layout found at "#{_implied_layout_name}" for #{name} but parent controller ' \
              'set layout to #{inspect.inspect}. Please explicitly set your layout to "#{_implied_layout_name}" ' \
              'or set it to nil to force a dynamic lookup.'
            template
          else
            super
          end
        RUBY
      end
  end

  self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
    def _layout
      if conditional_layout?
        #{layout_definition}
      else
        #{name_clause}
      end
    end
    private :_layout
  RUBY
end

#inherited(klass) ⇒ Object 



207
208
209
210
 
# File 'actionpack/lib/abstract_controller/layouts.rb', line 207

def inherited(klass)
  super
  klass._write_layout_method
end

#layout(layout, conditions = {}) ⇒ Object

Specify the layout to use for this class.

If the specified layout is a:

String

the String is the template name

Symbol

call the method specified by the symbol, which will return the template name

false

There is no layout

true

raise an ArgumentError

nil

Force default layout behavior with inheritance

Parameters

  • layout - The layout to use.

Options (conditions)

  • :only - A list of actions to apply this layout to.

  • :except - Apply this layout to all actions but this one.



251
252
253
254
255
256
257
258
259
 
# File 'actionpack/lib/abstract_controller/layouts.rb', line 251

def layout(layout, conditions = {})
  include LayoutConditions unless conditions.empty?

  conditions.each {|k, v| conditions[k] = Array(v).map {|a| a.to_s} }
  self._layout_conditions = conditions

  @_layout = layout
  _write_layout_method
end