opal-browser 0.1.0.beta1 → 0.3.1

data/opal/browser/http.rb

@@ -1,20 +1,25 @@
-require 'promise'
-
 require 'browser/http/binary'
 require 'browser/http/headers'
 require 'browser/http/request'
 require 'browser/http/response'
-require 'browser/http/compatibility'
 
 module Browser
 
 module HTTP
+  # Check if HTTP requests are supported.
+  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
+  #
+  # @yieldparam request [Request] the request to configure
+  #
+  # @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 +37,10 @@ module HTTP
   # Send an asynchronous GET request.
   #
   # @param url [String] the URL to request
-  # @return [Response] the response
+  #
+  # @yieldparam request [Request] the request to configure
+  #
+  # @return [Promise] a promise that will be resolved with the response
   def self.get(url, &block)
     send(:get, url, &block)
   end
@@ -40,7 +48,10 @@ module HTTP
   # Send an asynchronous HEAD request.
   #
   # @param url [String] the URL to request
-  # @return [Response] the response
+  #
+  # @yieldparam request [Request] the request to configure
+  #
+  # @return [Promise] a promise that will be resolved with the response
   def self.head(url, &block)
     send(:head, url, &block)
   end
@@ -49,7 +60,10 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
-  # @return [Response] the response
+  #
+  # @yieldparam request [Request] the request to configure
+  #
+  # @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 +72,10 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
-  # @return [Response] the response
+  #
+  # @yieldparam request [Request] the request to configure
+  #
+  # @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 +84,10 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
-  # @return [Response] the response
+  #
+  # @yieldparam request [Request] the request to configure
+  #
+  # @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 +97,9 @@ 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
+  #
+  # @yieldparam request [Request] the request to configure
+  #
   # @return [Response] the response
   def self.send!(method, url, data = nil, &block)
     Request.new(&block).open(method, url, false).send(data)
@@ -85,6 +108,9 @@ module HTTP
   # Send a synchronous GET request.
   #
   # @param url [String] the URL to request
+  #
+  # @yieldparam request [Request] the request to configure
+  #
   # @return [Response] the response
   def self.get!(url, &block)
     send!(:get, url, &block)
@@ -93,6 +119,9 @@ module HTTP
   # Send a synchronous HEAD request.
   #
   # @param url [String] the URL to request
+  #
+  # @yieldparam request [Request] the request to configure
+  #
   # @return [Response] the response
   def self.head!(url, &block)
     send!(:head, url, &block)
@@ -102,6 +131,9 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
+  #
+  # @yieldparam request [Request] the request to configure
+  #
   # @return [Response] the response
   def self.post!(url, data = nil, &block)
     send!(:post, url, data, &block)
@@ -111,6 +143,9 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
+  #
+  # @yieldparam request [Request] the request to configure
+  #
   # @return [Response] the response
   def self.put!(url, data = nil, &block)
     send!(:put, url, data, &block)
@@ -120,6 +155,9 @@ module HTTP
   #
   # @param url [String] the URL to request
   # @param data [String, Hash] the data to send
+  #
+  # @yieldparam request [Request] the request to configure
+  #
   # @return [Response] the response
   def self.delete!(url, data = nil, &block)
     send!(:delete, url, data, &block)

data/opal/browser/immediate.rb

@@ -1,9 +1,28 @@
-require 'browser/compatibility/immediate'
-
 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 +30,88 @@ class Immediate
     @block     = block
   end
 
-  def dispatch
-    raise NotImplementedError
-  end unless method_defined? :dispatch
+  # @!method dispatch
+  #   Dispatch the immediate.
+
+  # @!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 (Asynchronous)'
+    # @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);
+        };
 
-  def prevent
-    raise NotImplementedError
-  end unless method_defined? :prevent
+        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 +121,7 @@ class Immediate
     self
   end
 
+  # Check if the immediate has been aborted.
   def aborted?
     @aborted
   end
@@ -35,9 +129,33 @@ end
 
 end
 
+module Kernel
+  # (see Immediate.new)
+  def defer(*args, &block)
+    Browser::Immediate.new(block, args).tap(&:dispatch)
+  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

data/opal/browser/interval.rb

@@ -1,29 +1,29 @@
 module Browser
 
-# This class wraps `setInterval`.
+# Allows you to create an interval that executes the function every given
+# seconds.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/API/Window.setInterval
 class Interval
   # @!attribute [r] every
-  # @return [Number] the seconds every which the block is called
+  # @return [Float] the seconds every which the block is called
   attr_reader :every
 
   # Create and start an interval.
   #
   # @param window [Window] the window to start the interval on
-  # @param time [Number] seconds every which to call the block
+  # @param time [Float] seconds every which to call the block
   def initialize(window, time, &block)
     @window = Native.convert(window)
     @every  = time
     @block  = block
 
     @aborted = false
-    @stopped = true
-
-    start
   end
 
   # Check if the interval has been stopped.
   def stopped?
-    @stopped
+    @id.nil?
   end
 
   # Check if the interval has been aborted.
@@ -32,21 +32,17 @@ class Interval
   end
 
   # Abort the interval, it won't be possible to start it again.
-  #
-  # @return [self]
   def abort
     `#@window.clearInterval(#@id)`
 
     @aborted = true
     @id      = nil
-
-    self
   end
 
   # Stop the interval, it will be possible to start it again.
-  #
-  # @return [self]
   def stop
+    return if stopped?
+
     `#@window.clearInterval(#@id)`
 
     @stopped = true
@@ -54,16 +50,16 @@ class Interval
   end
 
   # Start the interval if it has been stopped.
-  #
-  # @return [self]
   def start
     raise "the interval has been aborted" if aborted?
-
     return unless stopped?
 
-    @id = `#@window.setInterval(#{@block.to_n}, #@every * 1000)`
+    @id = `#@window.setInterval(#@block, #@every * 1000)`
+  end
 
-    self
+  # Call the [Interval] block.
+  def call
+    @block.call
   end
 end
 
@@ -71,23 +67,45 @@ class Window
   # Execute the block every given seconds.
   #
   # @param time [Float] the seconds between every call
+  #
   # @return [Interval] the object representing the interval
   def every(time, &block)
+    Interval.new(@native, time, &block).tap(&:start)
+  end
+
+  # Execute the block every given seconds, you have to call [#start] on it
+  # yourself.
+  #
+  # @param time [Float] the seconds between every call
+  #
+  # @return [Interval] the object representing the interval
+  def every!(time, &block)
     Interval.new(@native, time, &block)
   end
 end
 
 end
 
+module Kernel
+  # (see Browser::Window#every)
+  def every(time, &block)
+    $window.every(time, &block)
+  end
+
+  # (see Browser::Window#every!)
+  def every!(time, &block)
+    $window.every!(time, &block)
+  end
+end
+
 class Proc
+  # (see Browser::Window#every)
   def every(time)
     $window.every(time, &self)
   end
-end
 
-module Kernel
-  # (see Browser::Window#every)
-  def every(time, &block)
-    $window.every(time, &block)
+  # (see Browser::Window#every!)
+  def every!(time)
+    $window.every!(time, &self)
   end
 end

data/opal/browser/location.rb

@@ -1,7 +1,10 @@
 module Browser
 
+# Allows manipulation of a location, usually from {Window} and {DOM::Document}.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/API/Location
 class Location
-  include Native
+  include Browser::NativeCachedWrapper
 
   # Change the location.
   #
@@ -63,12 +66,25 @@ class Location
   # @return [String] the query part of the location URI
   alias_native :query, :search
   alias_native :query=, :search=
+
+  # Returns the full path of the location URI, including
+  # the query string and fragment, eg. /site?a=b#c
+  def full_path
+    path + query + fragment
+  end
 end
 
 class Window
-  # Get the {Location} object for this window.
-  #
-  # @return [Location]
+  # @!attribute [r] location
+  # @return [Location] the location for the window
+  def location
+    Location.new(`#@native.location`) if `#@native.location`
+  end
+end
+
+class DOM::Document < DOM::Element
+  # @!attribute [r] location
+  # @return [Location] the location for the document
   def location
     Location.new(`#@native.location`) if `#@native.location`
   end

data/opal/browser/navigator.rb

@@ -1,16 +1,18 @@
 module Browser
 
-# Class that represents the browser attributes.
+# Representation of the navigator application.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/API/Navigator
 class Navigator
-  include Native
+  include Browser::NativeCachedWrapper
 
   Version = Struct.new(:major, :minor, :build)
   Product = Struct.new(:name, :version)
   Vendor  = Struct.new(:name, :version)
 
-  # Class that represents a MIME type.
+  # Representation of a MIME type.
   class MimeType
-    include Native
+    include Browser::NativeCachedWrapper
 
     # @!attribute [r] plugin
     # @return [Plugin] the plugin for the MIME type
@@ -33,7 +35,9 @@ class Navigator
     alias_native :type
   end
 
-  # Class to represent a browser plugin.
+  # Representation of a navigator plugin.
+  #
+  # @see https://developer.mozilla.org/en-US/docs/Web/API/Plugin
   class Plugin < Native::Array
     def initialize(plugin)
       super plugin do |m|
@@ -58,6 +62,27 @@ class Navigator
     alias_native :version
   end
 
+  # Representation for the array of plugins.
+  #
+  # @see https://developer.mozilla.org/en-US/docs/Web/API/NavigatorPlugins
+  class Plugins < Native::Array
+    def initialize(plugins)
+      super plugins do |p|
+        Plugin.new(p)
+      end
+    end
+
+    # Reload all browser plugins.
+    def refresh
+      `#@native.refresh(false)`
+    end
+
+    # Reload all browser plugins reloading pages that contain `<embed>`s.
+    def refresh!
+      `#@native.refresh(true)`
+    end
+  end
+
   # @!attribute [r] code
   # @return [String] the browser code name
   alias_native :code, :appCodeName
@@ -108,11 +133,9 @@ class Navigator
   alias_native :platform
 
   # @!attribute [r] plugins
-  # @return [Native::Array<Plugin>] the enabled plugins
+  # @return [Plugins] the enabled plugins
   def plugins
-    Native::Array.new `#@native.plugins` do |p|
-      Plugin.new(p)
-    end
+    Plugins.new(`#@native.plugins`)
   end
 
   # @!attribute [r] product
@@ -137,14 +160,114 @@ class Navigator
   rescue
     false
   end
+
+  # Representation of user location based on Geolocation API
+  #
+  # Example usage:
+  # ```
+  # $window.navigator.geolocate.then do |pos|
+  #   puts "#{pos.coords.latitude}, #{pos.coords.longitude}, #{pos.coords.accuracy}"
+  # end
+  # ```
+  #
+  # @see https://developer.mozilla.org/en-US/docs/Web/API/Position
+  class Position
+    include Browser::NativeCachedWrapper
+
+    class Coords
+      include Native::Wrapper
+
+      # @!attribute [r] latitude
+      alias_native :latitude
+      # @!attribute [r] longitude
+      alias_native :longitude
+      # @!attribute [r] altitude
+      alias_native :altitude
+      # @!attribute [r] accuracy
+      alias_native :accuracy
+      # @!attribute [r] altitude_accuracy
+      alias_native :altitude_accuracy, :altitudeAccuracy
+      # @!attribute [r] heading
+      alias_native :heading
+      # @!attribute [r] speed
+      alias_native :speed
+    end
+
+    # @!attribute [r] timestamp
+    alias_native :timestamp
+
+    def coords
+      @coords ||= Coords.new(`#@native.coords`)
+    end
+  end
+
+  # Geolocates the user once
+  #
+  # @return [Promise] promise that resolves to the {Position} object
+  def geolocate(max_age: 0, timeout: Float::INFINITY, high_accuracy: false)
+    promise = Promise.new
+    succ = proc { |i| promise.resolve(Position.new(i)) }
+    fail = proc { |i| promise.reject(Native(i)) }
+    opts = {maxAge: max_age, timeout: timeout, enableHighAccuracy: high_accuracy}
+    `#@native.geolocation.getCurrentPosition(#{succ.to_n}, #{fail.to_n}, #{opts.to_n})`
+    promise
+  end
+
+  # Geolocates the user multiple times and calls a block with his location
+  # until #stop_tracking is called with a returned id. Calls a proc named error
+  # if error happens.
+  #
+  # @return [Integer] an ID that can be used as an argument to #stop_tracking
+  def track(max_age: 0, timeout: Float::INFINITY, high_accuracy: false, error: proc{|i|}, &block)
+    opts = {maxAge: max_age, timeout: timeout, enableHighAccuracy: high_accuracy}
+    succ = proc { |i| block.call(Position.new(i)) }
+    fail = proc { |i| error.call(Native(i)) }
+    `#@native.geolocation.watchPosition(#{succ.to_n}, #{fail.to_n}, #{opts.to_n})`
+  end
+
+  def stop_tracking(id)
+    `#@native.geolocation.clearWatch(#{id})`
+  end
+
+  # Triggers a vibration on a device. A pattern can be either a number of
+  # miliseconds for a vibration length, or an array of lengths (in
+  # miliseconds) which describes a vibration pattern - first element of said
+  # array describes how long the device should vibrate, second - how long to
+  # stop for and so on.
+  def vibrate(pattern)
+    `#@native.vibrate(#{pattern.to_n})`
+  end
+
+  # Check a battery status of user device. This API is deprecated in the browser
+  # context and usable mainly in privileged contexts.
+  #
+  # @return [Promise] a promise that resolves with a battery status
+  #
+  # @see https://developer.mozilla.org/en-US/docs/Web/API/Navigator/getBattery
+  def get_battery
+    promise = Promise.new
+    yes = proc { |r| promise.resolve(Native(r)) }
+    no = proc { |r| promise.reject(Native(r)) }
+    `#@native.getBattery().then(#{yes.to_n}).catch(#{no.to_n})`
+    promise
+  end
+
+  # Queue to send a small amount of data to a server.
+  #
+  # @param url [String] url to trigger
+  # @param payload [String, Blob, FormData, Hash] data to send
+  #
+  # @see https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon
+  def send_beacon(url, payload=nil)
+    `#@native.sendBeacon(#{url}, #{payload.to_n})`
+  end
 end
 
 class Window
-  # Get the {Navigator} object for this window.
-  #
-  # @return [Navigator]
+  # @!attribute [r] navigator
+  # @return [Navigator] the navigator
   def navigator
-    Navigator.new(`#@native.navigator`) if `#@native.navigator`
+    @navigator ||= Navigator.new(`#@native.navigator`) if `#@native.navigator`
   end
 end