opal-browser 0.1.0.beta1 → 0.2.0.beta1

data/opal/browser/dom/node_set.rb

@@ -16,6 +16,10 @@ class NodeSet
     }
   end
 
+  def respond_to_missing?(name)
+    @literal.respond_to?(name)
+  end
+
   def method_missing(name, *args, &block)
     unless @literal.respond_to? name
       each {|el|

data/opal/browser/dom/text.rb

@@ -1,16 +1,31 @@
 module Browser; module DOM
 
+# Encapsulates a text node.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/API/Text
 class Text < CharacterData
+  # (see Document#create_text)
   def self.create(*args)
     $document.create_text(*args)
   end
 
+  # @!attribute [r] whole
+  # @return [String] the whole text
+  #
+  # @see https://developer.mozilla.org/en-US/docs/Web/API/Text.wholeText
   def whole
     `#@native.wholeText`
   end
 
+  # Split the text node at a given offset.
+  #
+  # @param offset [Integer] the offset where to split the text node
+  #
+  # @return [Text] the newly created text node
+  #
+  # @see https://developer.mozilla.org/en-US/docs/Web/API/Text.splitText
   def split(offset)
-    `#@native.splitText(offset)`
+    DOM(`#@native.splitText(offset)`)
   end
 
   def inspect

data/opal/browser/event_source.rb

@@ -1,9 +1,12 @@
 module Browser
 
-# This class wraps `EventSource`.
+# An {EventSource} allows you to receive events from a server in real-time,
+# similar to long-polling but not exactly.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/API/EventSource
 class EventSource
   def self.supported?
-    defined? `window.EventSource`
+    Browser.supports? :EventSource
   end
 
   include Native

data/opal/browser/history.rb

@@ -2,50 +2,86 @@ require 'browser/location'
 
 module Browser
 
+# {History} allows manipulation of the session history.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/API/History
 class History
+  # Check if HTML5 history is supported.
+  def self.supported?
+    Browser.supports? 'History'
+  end
+
   include Native
 
+  # @!attribute [r] length
+  # @return [Integer] how many items are in the history
   alias_native :length
 
+  # Go back in the history.
+  #
+  # @param number [Integer] how many items to go back
   def back(number = 1)
     `#@native.go(-number)`
-
-    self
   end
 
+  # Go forward in the history.
+  #
+  # @param number [Integer] how many items to go forward
   def forward(number = 1)
     `#@native.go(number)`
-
-    self
   end
 
-  def push(url, data = nil)
+  # Push an item in the history.
+  #
+  # @param item [String] the item to push in the history
+  # @param data [Object] additional state to push
+  def push(item, data = nil)
     data = `null` if data.nil?
 
-    `#@native.pushState(data, null, url)`
-
-    self
+    `#@native.pushState(data, null, item)`
   end
 
-  def replace(url, data = nil)
+  # Replace the current history item with another.
+  #
+  # @param item [String] the item to replace with
+  # @param data [Object] additional state to replace
+  def replace(item, data = nil)
     data = `null` if data.nil?
 
-    `#@native.replaceState(data, null, url)`
+    `#@native.replaceState(data, null, item)`
   end
 
+  # @!attribute [r] current
+  # @return [String] the current item
   def current
     $window.location.path
   end
 
-  def state
-    `#@native.state`
+  # @!attribute [r] state
+  # @return [Object] the current state
+  if Browser.supports? 'History.state'
+    def state
+      %x{
+        var state = #@native.state;
+
+        if (state == null) {
+          return nil;
+        }
+        else {
+          return state;
+        }
+      }
+    end
+  else
+    def state
+      raise NotImplementedError, 'history state unsupported'
+    end
   end
 end
 
 class Window
-  # Get the {History} object for this window.
-  #
-  # @return [History]
+  # @!attribute [r] history
+  # @return [History] the history for this window
   def history
     History.new(`#@native.history`) if `#@native.history`
   end

data/opal/browser/http.rb

@@ -4,17 +4,21 @@ require 'browser/http/binary'
 require 'browser/http/headers'
 require 'browser/http/request'
 require 'browser/http/response'
-require 'browser/http/compatibility'
 
 module Browser
 
 module HTTP
+  def self.supported?
+    Browser.supports?('XHR') || Browser.supports?('ActiveXObject')
+  end
+
   # Send an asynchronous request.
   #
   # @param method [Symbol] the HTTP method to use
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
-  # @return [Response] the response
+  #
+  # @return [Promise] a promise that will be resolved with the response
   def self.send(method, url, data = nil, &block)
     Promise.new.tap {|promise|
       Request.new(&block).tap {|req|
@@ -32,7 +36,8 @@ module HTTP
   # Send an asynchronous GET request.
   #
   # @param url [String] the URL to request
-  # @return [Response] the response
+  #
+  # @return [Promise] a promise that will be resolved with the response
   def self.get(url, &block)
     send(:get, url, &block)
   end
@@ -40,7 +45,8 @@ module HTTP
   # Send an asynchronous HEAD request.
   #
   # @param url [String] the URL to request
-  # @return [Response] the response
+  #
+  # @return [Promise] a promise that will be resolved with the response
   def self.head(url, &block)
     send(:head, url, &block)
   end
@@ -49,7 +55,8 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
-  # @return [Response] the response
+  #
+  # @return [Promise] a promise that will be resolved with the response
   def self.post(url, data = nil, &block)
     send(:post, url, data, &block)
   end
@@ -58,7 +65,8 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
-  # @return [Response] the response
+  #
+  # @return [Promise] a promise that will be resolved with the response
   def self.put(url, data = nil, &block)
     send(:put, url, data, &block)
   end
@@ -67,7 +75,8 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
-  # @return [Response] the response
+  #
+  # @return [Promise] a promise that will be resolved with the response
   def self.delete(url, data = nil, &block)
     send(:delete, url, data, &block)
   end
@@ -77,6 +86,7 @@ module HTTP
   # @param method [Symbol] the HTTP method to use
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
+  #
   # @return [Response] the response
   def self.send!(method, url, data = nil, &block)
     Request.new(&block).open(method, url, false).send(data)
@@ -85,6 +95,7 @@ module HTTP
   # Send a synchronous GET request.
   #
   # @param url [String] the URL to request
+  #
   # @return [Response] the response
   def self.get!(url, &block)
     send!(:get, url, &block)
@@ -93,6 +104,7 @@ module HTTP
   # Send a synchronous HEAD request.
   #
   # @param url [String] the URL to request
+  #
   # @return [Response] the response
   def self.head!(url, &block)
     send!(:head, url, &block)
@@ -102,6 +114,7 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
+  #
   # @return [Response] the response
   def self.post!(url, data = nil, &block)
     send!(:post, url, data, &block)
@@ -111,6 +124,7 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
+  #
   # @return [Response] the response
   def self.put!(url, data = nil, &block)
     send!(:put, url, data, &block)
@@ -120,6 +134,7 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
+  #
   # @return [Response] the response
   def self.delete!(url, data = nil, &block)
     send!(:delete, url, data, &block)

data/opal/browser/http/headers.rb

@@ -31,6 +31,11 @@ class Headers
     @hash = Hash.new
   end
 
+  # Clear the {Headers}.
+  def clear
+    @hash.clear
+  end
+
   # Iterate over the headers.
   #
   # @yield [name, value] the header name and value

data/opal/browser/http/request.rb

@@ -8,7 +8,6 @@ class Request
   # @param method [Symbol] the HTTP method to use
   # @param url [String, #to_s] the URL to request
   # @param parameters [String, Hash] the parameters to send
-  #
   def self.open(method, url, parameters = nil, &block)
     request = new(&block)
     request.open(method, url)
@@ -44,11 +43,13 @@ class Request
   def initialize(&block)
     super(transport)
 
+    @parameters   = {}
+    @query        = {}
     @headers      = Headers[DEFAULT_HEADERS]
     @method       = :get
     @asynchronous = true
     @binary       = false
-    @cacheable     = true
+    @cacheable    = true
     @opened       = false
     @sent         = false
     @completed    = false
@@ -61,8 +62,20 @@ class Request
     end if block
   end
 
-  def transport
-    `new XMLHttpRequest()`
+  # @!method transport
+  #   @private
+  if Browser.supports? :XHR
+    def transport
+      `new XMLHttpRequest()`
+    end
+  elsif Browser.supports? :ActiveX
+    def transport
+      `new ActiveXObject("MSXML2.XMLHTTP.3.0")`
+    end
+  else
+    def transport
+      raise NotImplementedError
+    end
   end
 
   # Check if the request has been opened.
@@ -183,11 +196,18 @@ class Request
   #
   # @param hash [Hash] the parameters
   #
-  # @return [self]
-  def parameters(hash)
-    @parameters = hash
+  # @return [Hash]
+  def parameters(hash = nil)
+    hash ? @parameters = hash : @parameters
+  end
 
-    self
+  # Set the URI query.
+  #
+  # @param hash [Hash] the query
+  #
+  # @return [Hash]
+  def query(hash = nil)
+    hash ? @query = hash : @query
   end
 
   # Register an event on the request.
@@ -223,7 +243,17 @@ class Request
     url = @url
 
     unless cacheable?
-      url += (url.include?(??) ? ?& : ??) + "_=#{rand}"
+      @query[:_] = rand
+    end
+
+    unless @query.empty?
+      if url.include???
+        url += ?&
+      else
+        url += ??
+      end
+
+      url += @query.encode_uri
     end
 
     `#@native.open(#{@method.to_s.upcase}, #{url.to_s}, #{@asynchronous}, #{@user.to_n}, #{@password.to_n})`
@@ -279,7 +309,7 @@ class Request
 
     if String === parameters
       data = parameters
-    elsif Hash === parameters
+    elsif Hash === parameters && !parameters.empty?
       data = parameters.map {|vals|
         vals.map(&:encode_uri_component).join(?=)
       }.join(?&)

data/opal/browser/immediate.rb

@@ -1,9 +1,30 @@
-require 'browser/compatibility/immediate'
+require 'promise'
 
 module Browser
 
-# FIXME: drop the method_defined? checks when require order is fixed
+# Class to easily create and dispatch an immediate call.
+#
+# Immediate calls are deferred function calls that happen as soon as they can
+# be scheduled.
+#
+# Compatibility
+# -------------
+# The compatibility layer will try various implementations in the following
+# order.
+#
+# + [setImmediate](https://developer.mozilla.org/en-US/docs/Web/API/Window.setImmediate)
+# + [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window.postMessage)
+# + [readystatechange](https://developer.mozilla.org/en-US/docs/Web/Reference/Events/readystatechange)
+# + [setTimeout](https://developer.mozilla.org/en/docs/Web/API/window.setTimeout)
+#
+# The order has been chosen from best to worst for both performance and
+# preemptiveness.
 class Immediate
+  # Create an immediate for the given function which will be called with the
+  # arguments and block.
+  #
+  # @param func [Proc] the function to call
+  # @param args [Array] the arguments to call it with
   def initialize(func, args, &block)
     @aborted   = false
     @function  = func
@@ -11,14 +32,89 @@ class Immediate
     @block     = block
   end
 
-  def dispatch
-    raise NotImplementedError
-  end unless method_defined? :dispatch
+  # @!method dispatch
+  #   Dispatch the immediate.
 
-  def prevent
-    raise NotImplementedError
-  end unless method_defined? :prevent
+  # @!method prevent
+  #   Prevent the immediate from being called once scheduled.
 
+  if Browser.supports? 'Immediate'
+    def dispatch
+      @id = `window.setImmediate(function() {
+        #{@function.call(*@arguments, &@block)};
+      })`
+    end
+
+    def prevent
+      `window.clearImmediate(#@id)`
+    end
+  elsif Browser.supports? 'Immediate (Internet Explorer)'
+    def dispatch
+      @id = `window.msSetImmediate(function() {
+        #{@function.call(*@arguments, &@block)};
+      })`
+    end
+
+    def prevent
+      `window.msClearImmediate(#@id)`
+    end
+  elsif Browser.supports? 'Window.send'
+    # @private
+    @@tasks  = {}
+
+    # @private
+    @@prefix = "opal.browser.immediate.#{rand(1_000_000)}."
+
+    $window.on :message do |e|
+      if String === e.data && e.data.start_with?(@@prefix)
+        if task = @@tasks.delete(e.data[@@prefix.length .. -1])
+          task[0].call(*task[1], &task[2])
+        end
+      end
+    end
+
+    def dispatch
+      @id          = rand(1_000_000).to_s
+      @@tasks[@id] = [@function, @arguments, @block]
+
+      $window.send! "#{@@prefix}#{@id}"
+    end
+
+    def prevent
+      @@tasks.delete(@id)
+    end
+  elsif Browser.supports? 'Event.readystatechange'
+    def dispatch
+      %x{
+        var script = document.createElement("script");
+
+        script.onreadystatechange = function() {
+          if (!#{aborted?}) {
+            #{@function.call(*@arguments, &@block)};
+          }
+
+          script.onreadystatechange = null;
+          script.parentNode.removeChild(script);
+        };
+
+        document.documentElement.appendChild(script);
+      }
+    end
+
+    def prevent; end
+  else
+    def dispatch
+      @id = `window.setTimeout(function() {
+        #{@function.call(*@arguments, &@block)};
+      }, 0)`
+    end
+
+    def prevent
+      `window.clearTimeout(#@id)`
+    end
+  end
+
+  # Abort the immediate.
   def abort
     return if aborted?
 
@@ -28,6 +124,7 @@ class Immediate
     self
   end
 
+  # Check if the immediate has been aborted.
   def aborted?
     @aborted
   end
@@ -36,8 +133,25 @@ end
 end
 
 class Proc
-  # Defer the function to be called as soon as possible.
+  # (see Immediate.new)
   def defer(*args, &block)
     Browser::Immediate.new(self, args, &block).tap(&:dispatch)
   end
 end
+
+class Promise
+  # Create a promise which will be resolved with the result of the immediate.
+  #
+  # @param args [Array] the arguments the block will be called with
+  def self.defer(*args, &block)
+    new.tap {|promise|
+      proc {
+        begin
+          promise.resolve(block.call(*args))
+        rescue Exception => e
+          promise.reject(e)
+        end
+      }.defer
+    }
+  end
+end