Class: Page
Instance Attribute Summary collapse
-
#draw_cycle ⇒ Object
readonly
Returns the value of attribute draw_cycle.
-
#events ⇒ Object
readonly
Returns the value of attribute events.
-
#page ⇒ Object
readonly
Returns the value of attribute page.
-
#params ⇒ Object
readonly
Returns the value of attribute params.
-
#routes ⇒ Object
readonly
Returns the value of attribute routes.
-
#templates ⇒ Object
readonly
Returns the value of attribute templates.
-
#url ⇒ Object
readonly
Returns the value of attribute url.
Instance Method Summary collapse
- #add_model(model_name) ⇒ Object
- #add_routes(&block) ⇒ Object
- #add_template(name, template, bindings) ⇒ Object
-
#binding_name ⇒ Object
We provide a binding_name, so we can bind events on the document.
- #channel ⇒ Object
- #flash ⇒ Object
-
#initialize ⇒ Page
constructor
A new instance of Page.
- #launch_console ⇒ Object
- #link_clicked(url = '', event = nil) ⇒ Object
-
#load_stored_page ⇒ Object
When the page is reloaded from the backend, we store the $page.page, so we can reload the page in the exact same state.
- #local_store ⇒ Object
- #start ⇒ Object
- #store ⇒ Object
- #tasks ⇒ Object
Constructor Details
#initialize ⇒ Page
Returns a new instance of Page.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/volt/page/page.rb', line 37 def initialize @model_classes = {} # Run the code to setup the page @page = ReactiveValue.new(Model.new) @url = ReactiveValue.new(URL.new) @params = @url.params @url_tracker = UrlTracker.new(self) @events = DocumentEvents.new @draw_cycle = DrawCycle.new if RUBY_PLATFORM == 'opal' # Setup escape binding for console %x{ $(document).keyup(function(e) { if (e.keyCode == 27) { Opal.gvars.page.$launch_console(); } }); $(document).on('click', 'a', function(event) { return Opal.gvars.page.$link_clicked($(this).attr('href'), event); }); } end # Initialize tasks so we can get the reload message self.tasks if Volt.env.development? channel.on('reconnected') do @page._reconnected.cur = true `setTimeout(function() {` @page._reconnected.cur = false `}, 2000);` end end |
Instance Attribute Details
#draw_cycle ⇒ Object (readonly)
Returns the value of attribute draw_cycle.
35 36 37 |
# File 'lib/volt/page/page.rb', line 35 def draw_cycle @draw_cycle end |
#events ⇒ Object (readonly)
Returns the value of attribute events.
35 36 37 |
# File 'lib/volt/page/page.rb', line 35 def events @events end |
#page ⇒ Object (readonly)
Returns the value of attribute page.
35 36 37 |
# File 'lib/volt/page/page.rb', line 35 def page @page end |
#params ⇒ Object (readonly)
Returns the value of attribute params.
35 36 37 |
# File 'lib/volt/page/page.rb', line 35 def params @params end |
#routes ⇒ Object (readonly)
Returns the value of attribute routes.
35 36 37 |
# File 'lib/volt/page/page.rb', line 35 def routes @routes end |
#templates ⇒ Object (readonly)
Returns the value of attribute templates.
35 36 37 |
# File 'lib/volt/page/page.rb', line 35 def templates @templates end |
#url ⇒ Object (readonly)
Returns the value of attribute url.
35 36 37 |
# File 'lib/volt/page/page.rb', line 35 def url @url end |
Instance Method Details
#add_model(model_name) ⇒ Object
140 141 142 |
# File 'lib/volt/page/page.rb', line 140 def add_model(model_name) @model_classes[["*", "_#{model_name}"]] = Object.const_get(model_name.camelize) end |
#add_routes(&block) ⇒ Object
150 151 152 153 |
# File 'lib/volt/page/page.rb', line 150 def add_routes(&block) @routes = Routes.new.define(&block) @url.cur.router = @routes end |
#add_template(name, template, bindings) ⇒ Object
144 145 146 147 148 |
# File 'lib/volt/page/page.rb', line 144 def add_template(name, template, bindings) @templates ||= {} @templates[name] = {'html' => template, 'bindings' => bindings} # puts "Add Template: #{name}" end |
#binding_name ⇒ Object
We provide a binding_name, so we can bind events on the document
118 119 120 |
# File 'lib/volt/page/page.rb', line 118 def binding_name 'page' end |
#channel ⇒ Object
126 127 128 129 130 131 132 133 134 |
# File 'lib/volt/page/page.rb', line 126 def channel @channel ||= begin if Volt.client? ReactiveValue.new(Channel.new) else ReactiveValue.new(ChannelStub.new) end end end |
#flash ⇒ Object
77 78 79 |
# File 'lib/volt/page/page.rb', line 77 def flash @flash ||= ReactiveValue.new(Model.new({}, persistor: Persistors::Flash)) end |
#launch_console ⇒ Object
122 123 124 |
# File 'lib/volt/page/page.rb', line 122 def launch_console puts "Launch Console" end |
#link_clicked(url = '', event = nil) ⇒ Object
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/volt/page/page.rb', line 93 def link_clicked(url='', event=nil) # Skip when href == '' return false if url.blank? # Normalize url # Benchmark.bm(1) do if @url.parse(url) if event # Handled new url `event.stopPropagation();` end # Clear the flash flash.clear # return false to stop the event propigation return false end # end # Not stopping, process link normally return true end |
#load_stored_page ⇒ Object
When the page is reloaded from the backend, we store the $page.page, so we can reload the page in the exact same state. Speeds up development.
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/volt/page/page.rb', line 183 def load_stored_page if Volt.client? if `sessionStorage` page_obj_str = nil `page_obj_str = sessionStorage.getItem('___page');` `if (page_obj_str) {` `sessionStorage.removeItem('___page');` JSON.parse(page_obj_str).each_pair do |key, value| self.page.send(:"#{key}=", value) end `}` end end rescue => e puts "Unable to restore: #{e.inspect}" end |
#local_store ⇒ Object
85 86 87 |
# File 'lib/volt/page/page.rb', line 85 def local_store @local_store ||= ReactiveValue.new(Model.new({}, persistor: Persistors::LocalStore)) end |
#start ⇒ Object
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/volt/page/page.rb', line 155 def start # Setup to render template Element.find('body').html = "<!-- $CONTENT --><!-- $/CONTENT -->" load_stored_page # Do the initial url params parse @url_tracker.url_updated(true) main_controller = MainController.new # Setup main page template TemplateRenderer.new(self, DomTarget.new, main_controller, 'CONTENT', 'main/main/main/body') # Setup title listener template title_target = AttributeTarget.new title_target.on('changed') do title = title_target.to_html `document.title = title;` end TemplateRenderer.new(self, title_target, main_controller, "main", "main/main/main/title") # TODO: this dom ready should really happen in the template renderer main_controller.dom_ready if main_controller.respond_to?(:dom_ready) end |
#store ⇒ Object
81 82 83 |
# File 'lib/volt/page/page.rb', line 81 def store @store ||= ReactiveValue.new(Model.new({}, persistor: Persistors::StoreFactory.new(tasks))) end |