Class: ViewModels::RenderOptions::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/view_models/render_options.rb

Overview

Base class for Partial and Template.

Direct Known Subclasses

Partial, Template

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(prefix, name, options) ⇒ Base

Initialize Render Options

Parameters:

  • prefix (String) —

    The prefix for rendering

  • name (String) —

    The template name

  • options (Hash) —

    The render options as a hash



20
21
22
23
24
25
 
# File 'lib/view_models/render_options.rb', line 20

def initialize prefix, name, options
  @prefix = prefix
  @options = options
  self.template_name = deoptionize name
  @format = @options.delete :format
end

Instance Attribute Details

#file ⇒ Object

The different attributes used to generate render options



13
14
15
 
# File 'lib/view_models/render_options.rb', line 13

def file
  @file
end

#format ⇒ Object

The different attributes used to generate render options



13
14
15
 
# File 'lib/view_models/render_options.rb', line 13

def format
  @format
end

#name ⇒ Object

The different attributes used to generate render options



13
14
15
 
# File 'lib/view_models/render_options.rb', line 13

def name
  @name
end

#path ⇒ Object

The different attributes used to generate render options



13
14
15
 
# File 'lib/view_models/render_options.rb', line 13

def path
  @path
end

#prefix ⇒ Object

The different attributes used to generate render options



13
14
15
 
# File 'lib/view_models/render_options.rb', line 13

def prefix
  @prefix
end

#view_model ⇒ Object

The different attributes used to generate render options



13
14
15
 
# File 'lib/view_models/render_options.rb', line 13

def view_model
  @view_model
end

Instance Method Details

#error_format ⇒ String

The format when trying to render

Returns:

  • (String) —

    the render format



44
45
46
47
 
# File 'lib/view_models/render_options.rb', line 44

def error_format
  format = self.format
  format ? "format #{format}" : "default format"
end

#error_message ⇒ Object

Generate a suitable error message for the error options.



29
30
31
 
# File 'lib/view_models/render_options.rb', line 29

def error_message
  "'#{error_path}#{name}' with #{error_format}"
end

#error_path ⇒ String

The error path, always returns a string

Returns:

  • (String) —

    The error path



36
37
38
39
 
# File 'lib/view_models/render_options.rb', line 36

def error_path
  path = self.path
  path ? "#{path}/" : ""
end

#format!(view) ⇒ Object

TODO:

Rails specific.

Parameters:

  • view (ActionView) —

    The view to render



61
62
63
 
# File 'lib/view_models/render_options.rb', line 61

def format! view
  view.template_format = @format if @format
end

#path_key ⇒ Object

Used for caching.



67
68
69
 
# File 'lib/view_models/render_options.rb', line 67

def path_key
  [self.path, self.name, self.format]
end

#to_render_options ⇒ Hash

Used when rendering.

Returns:

  • (Hash) —

    The render options



52
53
54
55
56
 
# File 'lib/view_models/render_options.rb', line 52

def to_render_options
  @options[:locals] ||= {}
  @options[:locals].reverse_merge! :view_model => view_model
  @options.reverse_merge :file => file
end