Class: TemplateBinding
- Inherits:
-
BaseBinding
- Object
- BaseBinding
- TemplateBinding
- Defined in:
- lib/volt/page/bindings/template_binding.rb
Direct Known Subclasses
Instance Attribute Summary
Attributes inherited from BaseBinding
#binding_name, #context, #target
Instance Method Summary collapse
- #call_ready ⇒ Object
-
#check_for_template?(path) ⇒ Boolean
Returns true if there is a template at the path.
-
#initialize(page, target, context, binding_name, binding_in_path, getter) ⇒ TemplateBinding
constructor
A new instance of TemplateBinding.
-
#path_for_template(lookup_path, force_section = nil) ⇒ Object
Takes in a lookup path and returns the full path for the matching template.
- #remove ⇒ Object
-
#render_template(full_path, controller_name) ⇒ Object
The context for templates can be either a controller, or the original context.
- #setup_path(binding_in_path) ⇒ Object
- #update ⇒ Object
Methods inherited from BaseBinding
#queue_update, #remove_anchors, #section, #value_from_getter
Constructor Details
#initialize(page, target, context, binding_name, binding_in_path, getter) ⇒ TemplateBinding
Returns a new instance of TemplateBinding.
5 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 |
# File 'lib/volt/page/bindings/template_binding.rb', line 5 def initialize(page, target, context, binding_name, binding_in_path, getter) # puts "New template binding: #{context.inspect} - #{binding_name.inspect}" 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 # puts "GETTER: #{value_from_getter(getter).inspect}" # Find the source for the getter binding @path, section = 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 model @model = section end # Run the initial render update @path_changed_listener = @path.on('changed') { update } if @path.reactive? @section_changed_listener = @section.on('changed') { update } if @section && @section.reactive? end |
Instance Method Details
#call_ready ⇒ Object
149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/volt/page/bindings/template_binding.rb', line 149 def call_ready if @controller if @controller.respond_to?(:section=) @controller.section = @current_template.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
42 43 44 |
# File 'lib/volt/page/bindings/template_binding.rb', line 42 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 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.
-
component (app/comp)
-
controller
-
view
-
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:
-
component - home
-
controller - index
-
view - index
-
section - body
67 68 69 70 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 |
# File 'lib/volt/page/bindings/template_binding.rb', line 67 def path_for_template(lookup_path, force_section=nil) parts = lookup_path.split('/') parts_size = parts.size default_parts = ['home', 'index', '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] offset = 0 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 if path_position > 1 # Lookup the controller controller = [full_path[0], full_path[1] + '_controller'] end return path, controller end end return nil, nil end |
#remove ⇒ Object
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/volt/page/bindings/template_binding.rb', line 161 def remove 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_name) ⇒ Object
The context for templates can be either a controller, or the original context.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/volt/page/bindings/template_binding.rb', line 127 def render_template(full_path, controller_name) # TODO: at the moment a :body section and a :title will both initialize different # controllers. Maybe we should have a way to tie them together? controller_class = get_controller(controller_name) if controller_class args = [] args << SubContext.new(@model) if @model # Setup the controller current_context = controller_class.new(*args) @controller = current_context else # Pass the context directly current_context = @context @controller = nil end @current_template = TemplateRenderer.new(@page, @target, current_context, @binding_name, full_path) call_ready end |
#setup_path(binding_in_path) ⇒ Object
34 35 36 37 38 39 |
# File 'lib/volt/page/bindings/template_binding.rb', line 34 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
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/volt/page/bindings/template_binding.rb', line 109 def update full_path, controller_name = path_for_template(@path.cur, @section.cur) @current_template.remove if @current_template if @model # Load in any procs @model.each_pair do |key,value| if value.class == Proc @model[key.gsub('-', '_')] = value.call end end end render_template(full_path, controller_name) end |