opal-browser 0.2.0.beta1 → 0.2.0

data/opal/browser/{dom/event.rb → event.rb}

@@ -1,33 +1,33 @@
-require 'browser/dom/event/base'
-require 'browser/dom/event/ui'
-require 'browser/dom/event/mouse'
-require 'browser/dom/event/keyboard'
-require 'browser/dom/event/focus'
-require 'browser/dom/event/wheel'
-require 'browser/dom/event/composition'
-require 'browser/dom/event/animation'
-require 'browser/dom/event/audio_processing'
-require 'browser/dom/event/before_unload'
-require 'browser/dom/event/composition'
-require 'browser/dom/event/clipboard'
-require 'browser/dom/event/device_light'
-require 'browser/dom/event/device_motion'
-require 'browser/dom/event/device_orientation'
-require 'browser/dom/event/device_proximity'
-require 'browser/dom/event/drag'
-require 'browser/dom/event/gamepad'
-require 'browser/dom/event/hash_change'
-require 'browser/dom/event/progress'
-require 'browser/dom/event/page_transition'
-require 'browser/dom/event/pop_state'
-require 'browser/dom/event/storage'
-require 'browser/dom/event/touch'
-require 'browser/dom/event/sensor'
-require 'browser/dom/event/custom'
-require 'browser/dom/event/message'
-require 'browser/dom/event/close'
-
-module Browser; module DOM
+require 'browser/event/base'
+require 'browser/event/ui'
+require 'browser/event/mouse'
+require 'browser/event/keyboard'
+require 'browser/event/focus'
+require 'browser/event/wheel'
+require 'browser/event/composition'
+require 'browser/event/animation'
+require 'browser/event/audio_processing'
+require 'browser/event/before_unload'
+require 'browser/event/composition'
+require 'browser/event/clipboard'
+require 'browser/event/device_light'
+require 'browser/event/device_motion'
+require 'browser/event/device_orientation'
+require 'browser/event/device_proximity'
+require 'browser/event/drag'
+require 'browser/event/gamepad'
+require 'browser/event/hash_change'
+require 'browser/event/progress'
+require 'browser/event/page_transition'
+require 'browser/event/pop_state'
+require 'browser/event/storage'
+require 'browser/event/touch'
+require 'browser/event/sensor'
+require 'browser/event/custom'
+require 'browser/event/message'
+require 'browser/event/close'
+
+module Browser
 
 class Event
   def self.aliases
@@ -42,7 +42,7 @@ class Event
   end
 
   def self.class_for(name)
-    type = case name_for(name)
+    case name_for(name)
       when 'animationend', 'animationiteration', 'animationstart'
         Animation
 
@@ -250,4 +250,4 @@ class Event
   end
 end
 
-end; end
+end

data/opal/browser/{dom/event → event}/animation.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Animation < Event
   def self.supported?
@@ -35,4 +35,4 @@ class Animation < Event
   alias_native :elapsed, :elapsedTime
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/audio_processing.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class AudioProcessing < Event
   def self.supported?
@@ -30,4 +30,4 @@ class AudioProcessing < Event
   alias_native :output, :outputBuffer
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/base.rb

@@ -1,11 +1,13 @@
-module Browser; module DOM
+module Browser
 
 class Event
   include Native
 
+  # @see https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Creating_and_triggering_events
   class Definition
     include Native
 
+    # @private
     def self.new(&block)
       data = super(`{ bubbles: true, cancelable: true }`)
       block.call(data) if block
@@ -13,10 +15,12 @@ class Event
       data.to_n
     end
 
+    # Set the event as bubbling.
     def bubbles=(value)
       `#@native.bubbles = #{value}`
     end
 
+    # Set the event as cancelable.
     def cancelable=(value)
       `#@native.cancelable = #{value}`
     end
@@ -49,7 +53,7 @@ class Event
     def self.included(klass)
       klass.instance_eval {
         def self.target(&block)
-          DOM::Event::Target.register(&block)
+          Event::Target.register(&block)
         end
       }
     end
@@ -57,6 +61,7 @@ class Event
     class Callback
       attr_reader :target, :name, :selector
 
+      # @private
       def initialize(target, name, selector = nil, &block)
         @target   = target
         @name     = name
@@ -64,10 +69,14 @@ class Event
         @block    = block
       end
 
-      def call(e)
-        to_proc.call(e)
+      # Call the callback with the given event.
+      #
+      # @param event [native] the native event object
+      def call(event)
+        to_proc.call(event)
       end
 
+      # Get the native function linked to the callback.
       def to_proc
         @proc ||= -> event {
           %x{
@@ -86,10 +95,13 @@ class Event
         }
       end
 
+      # @!attribute [r] event
+      # @return [Class] the class for the event
       def event
         Event.class_for(@name)
       end
 
+      # Stop listening for the event linked to the callback.
       def off
         target.off(self)
       end
@@ -102,6 +114,7 @@ class Event
         @pair   = pair
       end
 
+      # Stop listening for the event linked to the delegate.
       def off
         delegate = @target.delegated[@name]
         delegate.last.delete(@pair)
@@ -115,6 +128,26 @@ class Event
 
     Delegates = Struct.new(:callback, :handlers)
 
+    # @overload on(name, &block)
+    #
+    #   Start listening for an event on the target.
+    #
+    #   @param name [String] the event name
+    #
+    #   @yieldparam event [Event] the event
+    #
+    #   @return [Callback]
+    #
+    # @overload on(name, selector, &block)
+    #
+    #   Start listening for an event on the target children.
+    #
+    #   @param name [String] the event name
+    #   @param selector [String] the CSS selector to trigger the event on
+    #
+    #   @yieldparam event [Event] the event
+    #
+    #   @return [Delegate]
     def on(name, selector = nil, &block)
       raise ArgumentError, 'no block has been given' unless block
 
@@ -152,6 +185,13 @@ class Event
       end
     end
 
+    # Start listening for an event in the capturing phase.
+    #
+    # @param name [String] the event name
+    #
+    # @yieldparam event [Event] the event
+    #
+    # @return [Callback]
     def on!(name, &block)
       raise ArgumentError, 'no block has been given' unless block
 
@@ -230,6 +270,13 @@ class Event
       end
     end
 
+    # @overload off()
+    #   Stop listening for any event.
+    #
+    # @overload off(what)
+    #   Stop listening for an event.
+    #
+    #   @param what [Callback, String, Regexp] what to stop listening for
     def off(what = nil)
       case what
       when Callback
@@ -295,6 +342,12 @@ class Event
       end
     end
 
+    # Trigger an event on the target.
+    #
+    # @param name [String] the event name
+    # @param args [Array] optional arguments to the event callback
+    #
+    # @yieldparam definition [Definition] definition to customize the event
     def trigger(event, *args, &block)
       if event.is_a? String
         event = Event.create(event, *args, &block)
@@ -303,7 +356,12 @@ class Event
       dispatch(event)
     end
 
-    # Trigger the event without bubbling.
+    # Trigger an event on the target without bubbling.
+    #
+    # @param name [String] the event name
+    # @param args [Array] optional arguments to the event callback
+    #
+    # @yieldparam definition [Definition] definition to customize the event
     def trigger!(event, *args, &block)
       trigger event, *args do |e|
         block.call(e) if block
@@ -356,7 +414,7 @@ class Event
       return if element.nil? || element == event.on
 
       delegates.handlers.each {|selector, block|
-        if element.matches? selector
+        if element =~ selector
           new    = event.dup
           new.on = element
 
@@ -369,4 +427,4 @@ class Event
   end
 end
 
-end; end
+end

data/opal/browser/{dom/event → event}/before_unload.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class BeforeUnload < Event
   def self.supported?
@@ -12,4 +12,4 @@ class BeforeUnload < Event
   end if supported?
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/clipboard.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Clipboard < Event
   def self.supported?
@@ -25,4 +25,4 @@ class Clipboard < Event
   alias_native :type, :dataType
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/close.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Close < Event
   def self.supported?
@@ -44,4 +44,4 @@ class Close < Event
   alias_native :clean?, :wasClean
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/composition.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Composition < UI
   def self.supported?
@@ -47,4 +47,4 @@ class Composition < UI
   end
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/custom.rb

@@ -1,6 +1,6 @@
 require 'ostruct'
 
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Custom < Event
   def self.supported?
@@ -62,4 +62,4 @@ class Custom < Event
   end
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/device_light.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class DeviceLight < Event
   def self.supported?
@@ -20,4 +20,4 @@ class DeviceLight < Event
   alias_native :value
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/device_motion.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class DeviceMotion < Event
   def self.supported?
@@ -48,4 +48,4 @@ class DeviceMotion < Event
   alias_native :interval
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/device_orientation.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class DeviceOrientation < Event
   def self.supported?
@@ -45,4 +45,4 @@ class DeviceOrientation < Event
   alias_native :gamma
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/device_proximity.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class DeviceProximity < Event
   def self.supported?
@@ -30,4 +30,4 @@ class DeviceProximity < Event
   alias_native :max
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/drag.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 # TODO: handle transfers
 class Drag < Event
@@ -116,4 +116,4 @@ class Drag < Event
   end
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/focus.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Focus < UI
   def self.supported?
@@ -36,4 +36,4 @@ class Focus < UI
   end
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/gamepad.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Gamepad < Event
   def self.supported?
@@ -57,4 +57,4 @@ class Gamepad < Event
   end
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/hash_change.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class HashChange < Event
   def self.supported?
@@ -25,4 +25,4 @@ class HashChange < Event
   alias_native :new, :newURL
 end
 
-end; end; end
+end; end

data/opal/browser/{dom/event → event}/keyboard.rb

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Keyboard < UI
   def self.supported?
@@ -112,4 +112,4 @@ class Keyboard < UI
   end
 end
 
-end; end; end
+end; end