volt 0.8.14 → 0.8.15

data/lib/volt/page/targets/dom_template.rb

@@ -1,115 +1,117 @@
 require 'volt/page/targets/helpers/comment_searchers'
 
+module Volt
 # A dom template is used to optimize going from a template name to
 # dom nodes and bindings.  It stores a copy of the template's parsed
 # dom nodes, then when a new instance is requested, it updates the
 # dom markers (comments) for new binding numbers and returns a cloneNode'd
 # version of the dom nodes and the bindings.
-class DomTemplate
-  include CommentSearchers
-
-  def initialize(page, template_name)
-    template = page.templates[template_name]
-
-    if template
-      html = template['html']
-      @bindings = template['bindings']
-    else
-      html = "<div>-- &lt; missing template #{template_name.inspect.gsub('<', '&lt;').gsub('>', '&gt;')} &gt; --</div>"
-      @bindings = {}
-    end
-
-    @nodes = build_from_html(html)
+  class DomTemplate
+    include CommentSearchers
 
-    track_binding_anchors
-  end
+    def initialize(page, template_name)
+      template = page.templates[template_name]
 
-  # Returns the dom nodes and bindings
-  def make_new
-    bindings = update_binding_anchors!(`self.nodes`)
+      if template
+        html      = template['html']
+        @bindings = template['bindings']
+      else
+        html      = "<div>-- &lt; missing template #{template_name.inspect.gsub('<', '&lt;').gsub('>', '&gt;')} &gt; --</div>"
+        @bindings = {}
+      end
 
-    new_nodes = `self.nodes.cloneNode(true)`
+      @nodes = build_from_html(html)
 
-    return [new_nodes, bindings]
-  end
+      track_binding_anchors
+    end
 
+    # Returns the dom nodes and bindings
+    def make_new
+      bindings = update_binding_anchors!(`self.nodes`)
 
-  # Finds each of the binding anchors in the temp dom, then stores a reference
-  # to them so they can be quickly updated without using xpath to find them again.
-  def track_binding_anchors
-    @binding_anchors = {}
-
-    # Loop through the bindings, find in nodes.
-    @bindings.each_pair do |name,binding|
-      if name.is_a?(String)
-        # Find the dom node for an attribute anchor
-        node = nil
-        %x{
-          node = self.nodes.querySelector('#' + name);
-        }
-        @binding_anchors[name] = node
-      else
-        # Find the dom node for a comment anchor
-        start_comment = find_by_comment("$#{name}", @nodes)
-        end_comment = find_by_comment("$/#{name}", @nodes)
+      new_nodes = `self.nodes.cloneNode(true)`
 
-        @binding_anchors[name] = [start_comment, end_comment]
-      end
+      return [new_nodes, bindings]
     end
-  end
 
-  # Takes the binding_anchors and updates them with new numbers (comments and id's)
-  # then returns the bindings updated to the new numbers.
-  def update_binding_anchors!(nodes)
-    new_bindings = {}
 
-    @binding_anchors.each_pair do |name, anchors|
-      new_name = @@binding_number
-      @@binding_number += 1
+    # Finds each of the binding anchors in the temp dom, then stores a reference
+    # to them so they can be quickly updated without using xpath to find them again.
+    def track_binding_anchors
+      @binding_anchors = {}
 
-      if name.is_a?(String)
-        if name[0..1] == 'id'
-          # A generated id
-          # update the id
-          `anchors.setAttribute('id', 'id' + new_name);`
-
-          new_bindings["id#{new_name}"] = @bindings[name]
+      # Loop through the bindings, find in nodes.
+      @bindings.each_pair do |name, binding|
+        if name.is_a?(String)
+          # Find the dom node for an attribute anchor
+          node = nil
+          %x{
+            node = self.nodes.querySelector('#' + name);
+          }
+          @binding_anchors[name] = node
         else
-          # Assume a fixed id, should not be updated
-          # TODO: Might want to check the page to see if a node
-          # with this id already exists and raise if it does.
+          # Find the dom node for a comment anchor
+          start_comment = find_by_comment("$#{name}", @nodes)
+          end_comment   = find_by_comment("$/#{name}", @nodes)
 
-          # Copy from existing binding
-          new_bindings[name] = @bindings[name]
+          @binding_anchors[name] = [start_comment, end_comment]
         end
-      else
-        start_comment, end_comment = anchors
-
-        %x{
-          if (start_comment.textContent) {
-            // direct update
-            start_comment.textContent = " $" + new_name + " ";
-            end_comment.textContent = " $/" + new_name + " ";
-          } else if (start_comment.innerText) {
-            start_comment.innerText = " $" + new_name + " ";
-            end_comment.innerText = " $/" + new_name + " ";
-          } else {
-            // phantomjs doesn't work with textContent, so we replace the nodes
-            // and update the references
-            start_comment.nodeValue = " $" + new_name + " ";
-            end_comment.nodeValue = " $/" + new_name + " ";
+      end
+    end
+
+    # Takes the binding_anchors and updates them with new numbers (comments and id's)
+    # then returns the bindings updated to the new numbers.
+    def update_binding_anchors!(nodes)
+      new_bindings = {}
+
+      @binding_anchors.each_pair do |name, anchors|
+        new_name         = @@binding_number
+        @@binding_number += 1
+
+        if name.is_a?(String)
+          if name[0..1] == 'id'
+            # A generated id
+            # update the id
+            `anchors.setAttribute('id', 'id' + new_name);`
+
+            new_bindings["id#{new_name}"] = @bindings[name]
+          else
+            # Assume a fixed id, should not be updated
+            # TODO: Might want to check the page to see if a node
+            # with this id already exists and raise if it does.
+
+            # Copy from existing binding
+            new_bindings[name] = @bindings[name]
+          end
+        else
+          start_comment, end_comment = anchors
+
+          %x{
+            if (start_comment.textContent) {
+              // direct update
+              start_comment.textContent = " $" + new_name + " ";
+              end_comment.textContent = " $/" + new_name + " ";
+            } else if (start_comment.innerText) {
+              start_comment.innerText = " $" + new_name + " ";
+              end_comment.innerText = " $/" + new_name + " ";
+            } else {
+              // phantomjs doesn't work with textContent, so we replace the nodes
+              // and update the references
+              start_comment.nodeValue = " $" + new_name + " ";
+              end_comment.nodeValue = " $/" + new_name + " ";
+            }
           }
-        }
 
-        # %x{
-        #   start_comment.innerText = " $" + new_name + " ";
-        #   end_comment.innerText = " $/" + new_name + " ";
-        # }
+          # %x{
+          #   start_comment.innerText = " $" + new_name + " ";
+          #   end_comment.innerText = " $/" + new_name + " ";
+          # }
 
-        new_bindings[new_name] = @bindings[name]
+          new_bindings[new_name] = @bindings[name]
+        end
       end
-    end
 
-    return new_bindings
+      return new_bindings
+    end
   end
-end
+end

data/lib/volt/page/targets/helpers/comment_searchers.rb

@@ -1,66 +1,68 @@
-module CommentSearchers
-  if RUBY_PLATFORM == 'opal'
-    NO_XPATH = `!!window._phantom || !document.evaluate`
-  else
-    NO_XPATH = false
-  end
-
-  def find_by_comment(text, in_node=`document`)
-    if NO_XPATH
-      return find_by_comment_without_xml(text, in_node)
+module Volt
+  module CommentSearchers
+    if RUBY_PLATFORM == 'opal'
+      NO_XPATH = `!!window._phantom || !document.evaluate`
     else
-      node = nil
-
-      %x{
-        node = document.evaluate("//comment()[. = ' " + text + " ']", in_node, null, XPathResult.UNORDERED_NODE_ITERATOR_TYPE, null).iterateNext();
-      }
-      return node
+      NO_XPATH = false
     end
-  end
 
-  # PhantomJS does not support xpath in document.evaluate
-  def find_by_comment_without_xml(text, in_node)
-    match_text = " #{text} "
-    %x{
-      function walk(node) {
-        if (node.nodeType === 8 && node.nodeValue === match_text) {
-          return node;
+    def find_by_comment(text, in_node=`document`)
+      if NO_XPATH
+        return find_by_comment_without_xml(text, in_node)
+      else
+        node = nil
+
+        %x{
+          node = document.evaluate("//comment()[. = ' " + text + " ']", in_node, null, XPathResult.UNORDERED_NODE_ITERATOR_TYPE, null).iterateNext();
         }
+        return node
+      end
+    end
+
+    # PhantomJS does not support xpath in document.evaluate
+    def find_by_comment_without_xml(text, in_node)
+      match_text = " #{text} "
+      %x{
+        function walk(node) {
+          if (node.nodeType === 8 && node.nodeValue === match_text) {
+            return node;
+          }
 
-        var children = node.childNodes;
-        if (children) {
-          for (var i=0;i < children.length;i++) {
-            var matched = walk(children[i]);
-            if (matched) {
-              return matched;
+          var children = node.childNodes;
+          if (children) {
+            for (var i=0;i < children.length;i++) {
+              var matched = walk(children[i]);
+              if (matched) {
+                return matched;
+              }
             }
           }
-        }
 
-        return null;
-      }
+          return null;
+        }
 
 
-      return walk(in_node);
+        return walk(in_node);
 
-    }
-  end
+      }
+    end
 
 
-  # Returns an unattached div with the nodes from the passed
-  # in html.
-  def build_from_html(html)
-    temp_div = nil
-    %x{
-      temp_div = document.createElement('div');
-      var doc = jQuery.parseHTML(html);
+    # Returns an unattached div with the nodes from the passed
+    # in html.
+    def build_from_html(html)
+      temp_div = nil
+      %x{
+        temp_div = document.createElement('div');
+        var doc = jQuery.parseHTML(html);
 
-      if (doc) {
-        for (var i=0;i < doc.length;i++) {
-          temp_div.appendChild(doc[i]);
+        if (doc) {
+          for (var i=0;i < doc.length;i++) {
+            temp_div.appendChild(doc[i]);
+          }
         }
       }
-    }
-    return temp_div
+      temp_div
+    end
   end
-end
+end

data/lib/volt/page/tasks.rb

@@ -1,77 +1,79 @@
-# The tasks class provides an interface to call tasks on
-# the backend server.
-class Tasks
-  def initialize(page)
-    @page = page
-    @promise_id = 0
-    @promises = {}
+module Volt
+  # The tasks class provides an interface to call tasks on
+  # the backend server.
+  class Tasks
+    def initialize(page)
+      @page       = page
+      @promise_id = 0
+      @promises   = {}
 
-    page.channel.on('message') do |*args|
-      received_message(*args)
+      page.channel.on('message') do |*args|
+        received_message(*args)
+      end
     end
-  end
 
-  def call(class_name, method_name, *args)
-    promise_id = @promise_id
-    @promise_id += 1
+    def call(class_name, method_name, *args)
+      promise_id            = @promise_id
+      @promise_id           += 1
 
-    # Track the callback
-    promise = Promise.new
-    @promises[promise_id] = promise
+      # Track the callback
+      promise               = Promise.new
+      @promises[promise_id] = promise
 
-    # TODO: Timeout on these callbacks
+      # TODO: Timeout on these callbacks
 
-    @page.channel.send_message([promise_id, class_name, method_name, *args])
+      @page.channel.send_message([promise_id, class_name, method_name, *args])
 
-    promise
-  end
+      promise
+    end
 
 
-  def received_message(name, promise_id, *args)
-    case name
-    when 'added', 'removed', 'updated', 'changed'
-      notify_query(name, *args)
-    when 'response'
-      response(promise_id, *args)
-    when 'reload'
-      reload
+    def received_message(name, promise_id, *args)
+      case name
+        when 'added', 'removed', 'updated', 'changed'
+          notify_query(name, *args)
+        when 'response'
+          response(promise_id, *args)
+        when 'reload'
+          reload
+      end
     end
-  end
 
-  # When a request is sent to the backend, it can attach a callback,
-  # this is called from the backend to pass to the callback.
-  def response(promise_id, result, error)
-    promise = @promises.delete(promise_id)
+    # When a request is sent to the backend, it can attach a callback,
+    # this is called from the backend to pass to the callback.
+    def response(promise_id, result, error)
+      promise = @promises.delete(promise_id)
 
-    if promise
-      if error
-        # TODO: full error handling
-        puts "Task Response: #{error.inspect}"
-        promise.reject(error)
-      else
-        promise.resolve(result)
+      if promise
+        if error
+          # TODO: full error handling
+          puts "Task Response: #{error.inspect}"
+          promise.reject(error)
+        else
+          promise.resolve(result)
+        end
       end
     end
-  end
 
-  # Called when the backend sends a notification to change the results of
-  # a query.
-  def notify_query(method_name, collection, query, *args)
-    query_obj = Persistors::ArrayStore.query_pool.lookup(collection, query)
-    query_obj.send(method_name, *args)
-  end
+    # Called when the backend sends a notification to change the results of
+    # a query.
+    def notify_query(method_name, collection, query, *args)
+      query_obj = Persistors::ArrayStore.query_pool.lookup(collection, query)
+      query_obj.send(method_name, *args)
+    end
 
-  def reload
-    # Stash the current page value
-    value = JSON.dump($page.page.to_h)
+    def reload
+      # Stash the current page value
+      value = JSON.dump($page.page.to_h)
 
-    # If this browser supports session storage, store the page, so it will
-    # be in the same state when we reload.
-    if `sessionStorage`
-      `sessionStorage.setItem('___page', value);`
-    end
+      # If this browser supports session storage, store the page, so it will
+      # be in the same state when we reload.
+      if `sessionStorage`
+        `sessionStorage.setItem('___page', value);`
+      end
 
-    $page.page._reloading = true
-    `window.location.reload(false);`
+      $page.page._reloading = true
+      `window.location.reload(false);`
+    end
   end
 end

data/lib/volt/page/template_renderer.rb

@@ -1,25 +1,28 @@
 require 'volt/page/bindings/base_binding'
 
-class TemplateRenderer < BaseBinding
-  attr_reader :context
-  def initialize(page, target, context, binding_name, template_name)
-    super(page, target, context, binding_name)
+module Volt
+  class TemplateRenderer < BaseBinding
+    attr_reader :context
 
-    @sub_bindings = []
+    def initialize(page, target, context, binding_name, template_name)
+      super(page, target, context, binding_name)
 
-    bindings = self.dom_section.set_content_to_template(page, template_name)
+      @sub_bindings = []
 
-    bindings.each_pair do |id,bindings_for_id|
-      bindings_for_id.each do |binding|
-        @sub_bindings << binding.call(page, target, context, id)
+      bindings = self.dom_section.set_content_to_template(page, template_name)
+
+      bindings.each_pair do |id, bindings_for_id|
+        bindings_for_id.each do |binding|
+          @sub_bindings << binding.call(page, target, context, id)
+        end
       end
     end
-  end
 
-  def remove
-    @sub_bindings.each(&:remove)
-    @sub_bindings = []
+    def remove
+      @sub_bindings.each(&:remove)
+      @sub_bindings = []
 
-    super
+      super
+    end
   end
 end

data/lib/volt/page/url_tracker.rb

@@ -1,32 +1,34 @@
-# The URLTracker is responsible for updating the url when
-# a param changes, or updating the url model/params when
-# the browser url changes.
-class UrlTracker
-  def initialize(page)
-    @page = page
+module Volt
+  # The URLTracker is responsible for updating the url when
+  # a param changes, or updating the url model/params when
+  # the browser url changes.
+  class UrlTracker
+    def initialize(page)
+      @page = page
 
-    if Volt.client?
-      that = self
+      if Volt.client?
+        that = self
 
-      # Setup popstate on the dom ready event.  Prevents an extra
-      # popstate trigger
-      %x{
-        var first = true;
-        window.addEventListener("popstate", function(e) {
-          if (first === false) {
-            that.$url_updated();
-          }
+        # Setup popstate on the dom ready event.  Prevents an extra
+        # popstate trigger
+        %x{
+          var first = true;
+          window.addEventListener("popstate", function(e) {
+            if (first === false) {
+              that.$url_updated();
+            }
 
-          first = false;
+            first = false;
 
-          return true;
-        });
-      }
+            return true;
+          });
+        }
+      end
     end
-  end
 
-  def url_updated(first_call=false)
-    @page.url.parse(`document.location.href`)
-    @page.url.update! unless first_call
+    def url_updated(first_call=false)
+      @page.url.parse(`document.location.href`)
+      @page.url.update! unless first_call
+    end
   end
 end