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.



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
# File 'lib/volt/page/page.rb', line 38

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?
end

Instance Attribute Details

#draw_cycleObject (readonly)

Returns the value of attribute draw_cycle.



36
37
38
# File 'lib/volt/page/page.rb', line 36

def draw_cycle
  @draw_cycle
end

#eventsObject (readonly)

Returns the value of attribute events.



36
37
38
# File 'lib/volt/page/page.rb', line 36

def events
  @events
end

#pageObject (readonly)

Returns the value of attribute page.



36
37
38
# File 'lib/volt/page/page.rb', line 36

def page
  @page
end

#paramsObject (readonly)

Returns the value of attribute params.



36
37
38
# File 'lib/volt/page/page.rb', line 36

def params
  @params
end

#routesObject (readonly)

Returns the value of attribute routes.



36
37
38
# File 'lib/volt/page/page.rb', line 36

def routes
  @routes
end

#templatesObject (readonly)

Returns the value of attribute templates.



36
37
38
# File 'lib/volt/page/page.rb', line 36

def templates
  @templates
end

#urlObject (readonly)

Returns the value of attribute url.



36
37
38
# File 'lib/volt/page/page.rb', line 36

def url
  @url
end

Instance Method Details

#add_model(model_name) ⇒ Object



133
134
135
# File 'lib/volt/page/page.rb', line 133

def add_model(model_name)
  @model_classes[["*", "_#{model_name}"]] = Object.const_get(model_name.camelize)
end

#add_routes(&block) ⇒ Object



143
144
145
146
# File 'lib/volt/page/page.rb', line 143

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

#add_template(name, template, bindings) ⇒ Object



137
138
139
140
141
# File 'lib/volt/page/page.rb', line 137

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



111
112
113
# File 'lib/volt/page/page.rb', line 111

def binding_name
  'page'
end

#channelObject



119
120
121
122
123
124
125
126
127
# File 'lib/volt/page/page.rb', line 119

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

#flashObject



70
71
72
# File 'lib/volt/page/page.rb', line 70

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

#launch_consoleObject



115
116
117
# File 'lib/volt/page/page.rb', line 115

def launch_console
  puts "Launch Console"
end


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/volt/page/page.rb', line 86

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.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/volt/page/page.rb', line 176

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



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

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

#startObject



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/volt/page/page.rb', line 148

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

#storeObject



74
75
76
# File 'lib/volt/page/page.rb', line 74

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

#tasksObject



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

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