Class: TemplateBinding

Inherits:
BaseBinding show all
Defined in:
lib/volt/page/bindings/template_binding.rb

Direct Known Subclasses

ComponentBinding

Instance Attribute Summary

Attributes inherited from BaseBinding

#binding_name, #context, #target

Instance Method Summary collapse

Methods inherited from BaseBinding

#dom_section, #remove_anchors, #value_from_getter

Constructor Details

#initialize(page, target, context, binding_name, binding_in_path, getter) ⇒ TemplateBinding

Returns a new instance of TemplateBinding.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/volt/page/bindings/template_binding.rb', line 6

def initialize(page, target, context, binding_name, binding_in_path, getter)
  super(page, target, context, binding_name)

  # Binding in path is the path for the template this binding is in
  setup_path(binding_in_path)

  @current_template = nil

  # Find the source for the getter binding
  @path, section, @options = value_from_getter(getter)

  if section.is_a?(String)
    # Render this as a section
    @section = section
  else
    # Use the value passed in as the default arguments
    @arguments = section
  end

  # Sometimes we want multiple template bindings to share the same controller (usually
  # when displaying a :Title and a :Body), this instance tracks those.
  if @options && (controller_group = @options[:controller_group])
    @grouped_controller = GroupedControllers.new(controller_group)
  end

  # Run the initial render
  update

  @path_changed_listener = @path.on('changed') { queue_update } if @path.reactive?
  @section_changed_listener = @section.on('changed') { queue_update } if @section && @section.reactive?
end

Instance Method Details

#call_ready ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/volt/page/bindings/template_binding.rb', line 172

def call_ready
  if @controller
    # Set the current section on the controller if it wants so it can manipulate
    # the dom if needed
    if @controller.respond_to?(:section=)
      @controller.section = @current_template.dom_section
    end

    if @controller.respond_to?(:dom_ready)
      @controller.dom_ready
    end
  end
end

#check_for_template?(path) ⇒ Boolean

Returns true if there is a template at the path

Returns:



46
47
48
 
# File 'lib/volt/page/bindings/template_binding.rb', line 46

def check_for_template?(path)
  @page.templates[path]
end

#path_for_template(lookup_path, force_section = nil) ⇒ Object

Takes in a lookup path and returns the full path for the matching template. Also returns the controller and action name if applicable.

Looking up a path is fairly simple. There are 4 parts needed to find the html to be rendered. File paths look like this: app/component/views/controller_name/view.html Within the html file may be one or more sections.

  1. component (app/comp)

  2. controller

  3. view

  4. sections

When searching for a file, the lookup starts at the section, and moves up. when moving up, default values are provided for the section, then view/section, etc.. until a file is either found or the component level is reached.

The defaults are as follows:

  1. component - main

  2. controller - main

  3. view - main

  4. section - body



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/volt/page/bindings/template_binding.rb', line 71

def path_for_template(lookup_path, force_section=nil)
  parts = lookup_path.split('/')
  parts_size = parts.size

  default_parts = ['main', 'main', 'index', 'body']

  # When forcing a sub template, we can default the sub template section
  default_parts[-1] = force_section if force_section

  (5 - parts_size).times do |path_position|
    # If they passed in a force_section, we can skip the first
    next if force_section && path_position == 0

    full_path = [@collection_name, @controller_name, @page_name, nil]

    start_at = full_path.size - parts_size - path_position

    full_path.size.times do |index|
      if index >= start_at
        if part = parts[index-start_at]
          full_path[index] = part
        else
          full_path[index] = default_parts[index]
        end
      end
    end

    path = full_path.join('/')
    if check_for_template?(path)
      controller = nil

      # Don't return a controller if we are just getting another section
      # from the same controller
      if path_position >= 1
        # Lookup the controller
        controller = [full_path[0], full_path[1] + '_controller', full_path[2]]
      end
      return path, controller
    end
  end

  return nil, nil
end

#queue_update ⇒ Object

Called when the path changes. If we are sharing a controller, clear the cached controller before we queue



117
118
119
120
121
 
# File 'lib/volt/page/bindings/template_binding.rb', line 117

def queue_update
  @grouped_controller.clear if @grouped_controller

  super
end

#remove ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/volt/page/bindings/template_binding.rb', line 186

def remove
  @grouped_controller.clear if @grouped_controller

  if @path_changed_listener
    @path_changed_listener.remove
    @path_changed_listener = nil
  end

  if @section_changed_listener
    @section_changed_listener.remove
    @section_changed_listener = nil
  end

  if @current_template
    # Remove the template if one has been rendered, when the template binding is
    # removed.
    @current_template.remove
  end

  super

  if @controller
    # Let the controller know we removed
    if @controller.respond_to?(:dom_removed)
      @controller.dom_removed
    end

    @controller = nil
  end
end

#render_template(full_path, controller_path) ⇒ Object

The context for templates can be either a controller, or the original context.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/volt/page/bindings/template_binding.rb', line 141

def render_template(full_path, controller_path)
  args = @arguments ? [@arguments] : []

  @controller = nil

  # Fetch grouped controllers if we're grouping
  @controller = @grouped_controller.get if @grouped_controller

  # Otherwise, make a new controller
  unless @controller
    controller_class, action = get_controller(controller_path)

    if controller_class
      # Setup the controller
      @controller = controller_class.new(*args)
    else
      @controller = ModelController.new(*args)
    end

    # Trigger the action
    @controller.send(action) if @controller.respond_to?(action)

    # Track the grouped controller
    @grouped_controller.set(@controller) if @grouped_controller
  end

  @current_template = TemplateRenderer.new(@page, @target, @controller, @binding_name, full_path)

  call_ready
end

#setup_path(binding_in_path) ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/volt/page/bindings/template_binding.rb', line 38

def setup_path(binding_in_path)
  path_parts = binding_in_path.split('/')
  @collection_name = path_parts[0]
  @controller_name = path_parts[1]
  @page_name = path_parts[2]
end

#update ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/volt/page/bindings/template_binding.rb', line 123

def update
  full_path, controller_path = path_for_template(@path.cur, @section.cur)

  @current_template.remove if @current_template

  if @arguments
    # Load in any procs
    @arguments.each_pair do |key,value|
      if value.class == Proc
        @arguments[key.gsub('-', '_')] = value.call
      end
    end
  end

  render_template(full_path, controller_path)
end