volt 0.8.15 → 0.8.16

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

@@ -7,7 +7,7 @@ module Volt
   # may be allowed in the future (iframes?)
   class DomTarget < BaseSection
     def dom_section(*args)
-      return DomSection.new(*args)
+      DomSection.new(*args)
     end
   end
 end

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

@@ -1,11 +1,11 @@
 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.
+  # 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
 
@@ -31,10 +31,9 @@ module Volt
 
       new_nodes = `self.nodes.cloneNode(true)`
 
-      return [new_nodes, bindings]
+      [new_nodes, bindings]
     end
 
-
     # 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
@@ -45,9 +44,9 @@ module Volt
         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
@@ -86,7 +85,7 @@ module Volt
         else
           start_comment, end_comment = anchors
 
-          %x{
+          `
             if (start_comment.textContent) {
               // direct update
               start_comment.textContent = " $" + new_name + " ";
@@ -100,7 +99,7 @@ module Volt
               start_comment.nodeValue = " $" + new_name + " ";
               end_comment.nodeValue = " $/" + new_name + " ";
             }
-          }
+          `
 
           # %x{
           #   start_comment.innerText = " $" + new_name + " ";
@@ -111,7 +110,7 @@ module Volt
         end
       end
 
-      return new_bindings
+      new_bindings
     end
   end
 end

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

@@ -6,15 +6,15 @@ module Volt
       NO_XPATH = false
     end
 
-    def find_by_comment(text, in_node=`document`)
+    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
@@ -22,7 +22,7 @@ module Volt
     # 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;
@@ -44,15 +44,14 @@ module Volt
 
         return walk(in_node);
 
-      }
+      `
     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);
 
@@ -61,7 +60,7 @@ module Volt
             temp_div.appendChild(doc[i]);
           }
         }
-      }
+      `
       temp_div
     end
   end

data/lib/volt/page/tasks.rb

@@ -27,7 +27,6 @@ module Volt
       promise
     end
 
-
     def received_message(name, promise_id, *args)
       case name
         when 'added', 'removed', 'updated', 'changed'

data/lib/volt/page/template_renderer.rb

@@ -9,7 +9,7 @@ module Volt
 
       @sub_bindings = []
 
-      bindings = self.dom_section.set_content_to_template(page, template_name)
+      bindings = dom_section.set_content_to_template(page, template_name)
 
       bindings.each_pair do |id, bindings_for_id|
         bindings_for_id.each do |binding|

data/lib/volt/page/url_tracker.rb

@@ -11,7 +11,7 @@ module Volt
 
         # Setup popstate on the dom ready event.  Prevents an extra
         # popstate trigger
-        %x{
+        `
           var first = true;
           window.addEventListener("popstate", function(e) {
             if (first === false) {
@@ -22,11 +22,11 @@ module Volt
 
             return true;
           });
-        }
+        `
       end
     end
 
-    def url_updated(first_call=false)
+    def url_updated(first_call = false)
       @page.url.parse(`document.location.href`)
       @page.url.update! unless first_call
     end

data/lib/volt/reactive/computation.rb

@@ -61,9 +61,7 @@ module Volt
         invalidations  = @invalidations
         @invalidations = []
 
-        invalidations.each do |invalidation|
-          invalidation.call
-        end
+        invalidations.each(&:call)
       end
     end
 
@@ -92,9 +90,8 @@ module Volt
       return_value
     end
 
-
     def self.flush!
-      raise "Can't flush while in a flush" if @flushing
+      fail "Can't flush while in a flush" if @flushing
 
       @flushing = true
       # clear any timers
@@ -103,15 +100,13 @@ module Volt
       computations  = @@flush_queue
       @@flush_queue = []
 
-      computations.each do |computation|
-        computation.compute!
-      end
+      computations.each(&:compute!)
 
       @flushing = false
     end
 
     def self.queue_flush!
-      if !@timer
+      unless @timer
         # Flush once everything else has finished running
         @timer = `setImmediate(function() { self['$flush!'](); });`
       end
@@ -119,12 +114,11 @@ module Volt
   end
 end
 
-
 class Proc
   def watch!
     Volt::Computation.new(self).run_in do
       # run self
-      self.call
+      call
     end
   end
 end

data/lib/volt/reactive/dependency.rb

@@ -59,9 +59,7 @@ module Volt
 
       @dependencies = Set.new
 
-      deps.each do |dep|
-        dep.invalidate!
-      end
+      deps.each(&:invalidate!)
     end
 
     # Called when a dependency is no longer needed

data/lib/volt/reactive/eventable.rb

@@ -1,4 +1,6 @@
 module Volt
+  # Listeners are returned from #on on a class with Eventable included.
+  # Listeners can be stopped by calling #remove
   class Listener
     def initialize(klass, event, callback)
       @klass    = klass
@@ -25,7 +27,14 @@ module Volt
     end
   end
 
+  # Include Eventable to add a basic event/trigger system to a class.  Listeners can be
+  # added with #on(event_name) { ... }  Events can be triggered with #trigger!
   module Eventable
+    # Sets up a listener on the class the Eventable module was included in.
+    # event should be a string or symbol.  When something calls #trigger!(event_name) on
+    # the class, it will trigger any listener with the same event name.
+    #
+    # returns: a listener that has a #remove method to stop the listener.
     def on(event, &callback)
       event             = event.to_sym
       listener          = Listener.new(self, event, callback)
@@ -40,12 +49,14 @@ module Volt
       if self.respond_to?(:event_added)
         # call event added passing the event, the scope, and a boolean if it
         # is the first time this event has been added.
-        self.event_added(event, first, first_for_event)
+        event_added(event, first, first_for_event)
       end
 
-      return listener
+      listener
     end
 
+    # Triggers event on the class the module was includeded.  Any .on listeners
+    # will have their block called passing in *args.
     def trigger!(event, *args)
       event = event.to_sym
 
@@ -58,10 +69,12 @@ module Volt
       end
     end
 
+    # Stops the listener returned by calling .on(:event_name)  Triggers #event_removed
+    # if there are no more listeners for that event.
     def remove_listener(event, listener)
       event = event.to_sym
 
-      raise "Unable to delete #{event} from #{self.inspect}" unless @listeners && @listeners[event]
+      fail "Unable to delete #{event} from #{inspect}" unless @listeners && @listeners[event]
 
       @listeners[event].delete(listener)
 
@@ -77,7 +90,7 @@ module Volt
       # Let the class we're included on know that we removed a listener (if it cares)
       if self.respond_to?(:event_removed)
         # Pass in the event and a boolean indicating if it is the last event
-        self.event_removed(event, last, last_for_event)
+        event_removed(event, last, last_for_event)
       end
     end
   end

data/lib/volt/reactive/hash_dependency.rb

@@ -30,6 +30,7 @@ module Volt
     end
 
     private
+
     def ensure_key(key)
       @hash_depedencies[key] ||= Dependency.new
     end

data/lib/volt/reactive/reactive_accessors.rb

@@ -1,6 +1,5 @@
 module Volt
   module ReactiveAccessors
-
     module ClassMethods
       # Create a method to read a reactive value from an instance value.  If it
       # is not setup, create it so it can be updated through the reactive value

data/lib/volt/reactive/reactive_array.rb

@@ -4,7 +4,7 @@ module Volt
   class ReactiveArray
     include Eventable
 
-    def initialize(array=[])
+    def initialize(array = [])
       @array      = array
       @array_deps = []
       @size_dep   = Dependency.new
@@ -49,7 +49,7 @@ module Volt
         end
       end
 
-      return result
+      result
     end
 
     def any?
@@ -73,7 +73,7 @@ module Volt
         size.times do |index|
           val = self[index]
 
-          if !yield(val).true?
+          unless yield(val).true?
             return false
           end
         end
@@ -96,11 +96,10 @@ module Volt
       dep.depend
 
       # Return the index
-      return @array[index]
+      @array[index]
     end
 
     def []=(index, value)
-
       # Assign the new value
       @array[index] = value
 
@@ -112,10 +111,10 @@ module Volt
     def size
       @size_dep.depend
 
-      return @array.size
+      @array.size
     end
 
-    alias :length :size
+    alias_method :length, :size
 
     def delete_at(index)
       # Handle a negative index
@@ -131,7 +130,7 @@ module Volt
 
       # Trigger a changed event for each element in the zone where the
       # delete would change
-      index.upto(self.size+1) do |position|
+      index.upto(size + 1) do |position|
         trigger_for_index!(position)
       end
 
@@ -139,14 +138,13 @@ module Volt
 
       @persistor.removed(model) if @persistor
 
-      return model
+      model
     end
 
-
     def delete(val)
       index = @array.index(val)
       if index
-        self.delete_at(index)
+        delete_at(index)
       else
         # Sometimes the model isn't loaded at the right state yet, so we
         # just remove it from the persistor
@@ -180,29 +178,28 @@ module Volt
     def <<(value)
       result = (@array << value)
 
-      trigger_for_index!(self.size-1)
-      trigger_added!(self.size-1)
+      trigger_for_index!(size - 1)
+      trigger_added!(size - 1)
       trigger_size_change!
 
-      return result
+      result
     end
 
-
     def +(array)
-      raise "not implemented yet"
-      old_size = self.size
+      fail 'not implemented yet'
+      old_size = size
 
       # TODO: += is funky here, might need to make a .plus! method
       result   = ReactiveArray.new(@array.dup + array)
 
-      old_size.upto(result.size-1) do |index|
+      old_size.upto(result.size - 1) do |index|
         trigger_for_index!('changed', index)
         trigger_added!(old_size + index)
       end
 
       trigger_size_change!
 
-      return result
+      result
     end
 
     def insert(index, *objects)
@@ -214,21 +211,20 @@ module Volt
       end
 
       objects.size.times do |count|
-        trigger_added!(index+count)
+        trigger_added!(index + count)
       end
 
       trigger_size_change!
 
-      return result
+      result
     end
 
-
     def inspect
-      "#<#{self.class.to_s}:#{object_id} #{@array.inspect}>"
+      "#<#{self.class}:#{object_id} #{@array.inspect}>"
     end
 
-
     private
+
     # Check to see if the size has changed, trigger a change on size if it has
     def trigger_size_change!
       new_size = @array.size
@@ -245,7 +241,6 @@ module Volt
       dep.changed! if dep
     end
 
-
     def trigger_added!(index)
       trigger!('added', index)
     end