Class: Page

Inherits:
Object show all
Defined in:
lib/volt/page/page.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializePage

Returns a new instance of Page.



36
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 36

def initialize
  @model_classes = {}

  # Run the code to setup the page
  @page = Model.new

  @url = URL.new
  @params = @url.params
  @url_tracker = UrlTracker.new(self)

  @events = DocumentEvents.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?

  if Volt.client?
    channel.on('reconnected') do
      @page._reconnected = true

      `setTimeout(function() {`
        @page._reconnected = false
      `}, 2000);`
    end
  end
end

Instance Attribute Details

#eventsObject (readonly)

Returns the value of attribute events.



34
35
36
# File 'lib/volt/page/page.rb', line 34

def events
  @events
end

#model_classesObject (readonly)

Returns the value of attribute model_classes.



34
35
36
# File 'lib/volt/page/page.rb', line 34

def model_classes
  @model_classes
end

#pageObject (readonly)

Returns the value of attribute page.



34
35
36
# File 'lib/volt/page/page.rb', line 34

def page
  @page
end

#paramsObject (readonly)

Returns the value of attribute params.



34
35
36
# File 'lib/volt/page/page.rb', line 34

def params
  @params
end

#routesObject (readonly)

Returns the value of attribute routes.



34
35
36
# File 'lib/volt/page/page.rb', line 34

def routes
  @routes
end

#templatesObject (readonly)

Returns the value of attribute templates.



34
35
36
# File 'lib/volt/page/page.rb', line 34

def templates
  @templates
end

#urlObject (readonly)

Returns the value of attribute url.



34
35
36
# File 'lib/volt/page/page.rb', line 34

def url
  @url
end

Instance Method Details

#add_model(model_name) ⇒ Object



140
141
142
143
# File 'lib/volt/page/page.rb', line 140

def add_model(model_name)
  model_name = model_name.camelize.to_sym
  @model_classes[model_name] = Object.const_get(model_name)
end

#add_routes(&block) ⇒ Object



151
152
153
154
# File 'lib/volt/page/page.rb', line 151

def add_routes(&block)
  @routes = Routes.new.define(&block)
  @url.router = @routes
end

#add_template(name, template, bindings) ⇒ Object



145
146
147
148
149
# File 'lib/volt/page/page.rb', line 145

def add_template(name, template, bindings)
  @templates ||= {}
  @templates[name] = {'html' => template, 'bindings' => bindings}
  # puts "Add Template: #{name}"
end

#binding_nameObject

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

#channelObject



126
127
128
129
130
131
132
133
134
# File 'lib/volt/page/page.rb', line 126

def channel
  @channel ||= begin
    if Volt.client?
      Channel.new
    else
      ChannelStub.new
    end
  end
end

#flashObject



77
78
79
# File 'lib/volt/page/page.rb', line 77

def flash
  @flash ||= Model.new({}, persistor: Persistors::Flash)
end

#launch_consoleObject



122
123
124
# File 'lib/volt/page/page.rb', line 122

def launch_console
  puts "Launch Console"
end


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_pageObject

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.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/volt/page/page.rb', line 182

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_storeObject



85
86
87
# File 'lib/volt/page/page.rb', line 85

def local_store
  @local_store ||= Model.new({}, persistor: Persistors::LocalStore)
end

#startObject



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/volt/page/page.rb', line 156

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 reactive template
  @title_template = StringTemplateRender.new(self, main_controller, "main/main/main/title")

  # Watch for changes to the title template
  Proc.new do
    title = @title_template.html.gsub(/\n/, ' ')
    `document.title = title;`
  end.watch!
end

#storeObject



81
82
83
# File 'lib/volt/page/page.rb', line 81

def store
  @store ||= Model.new({}, persistor: Persistors::StoreFactory.new(tasks))
end

#tasksObject



89
90
91
# File 'lib/volt/page/page.rb', line 89

def tasks
  @tasks ||= Tasks.new(self)
end