opal-browser 0.2.0 → 0.3.3

data/opal/browser/form_data.rb

@@ -0,0 +1,225 @@
+module Browser
+
+class FormData
+  include NativeCachedWrapper
+
+  module Converter
+    # Encode as URI component.
+    #
+    # @return [String] the string encoded for usage as URI component
+    def encode(string)
+      `encodeURIComponent(#{string})`
+    end
+
+    # Decode as URI component.
+    #
+    # @return [String] the string decoded as URI component
+    def decode(string)
+      `decodeURIComponent(#{string})`
+    end
+
+    # Encode as URI.
+    #
+    # @return [String] the string encoded as URI
+    def encode_uri(string)
+      `encodeURI(#{string})`
+    end
+
+    # Decode as URI.
+    #
+    # @return [String] the string decoded as URI
+    def decode_uri(string)
+      `decodeURI(#{string})`
+    end
+
+    # Flattens a hash to build a flat array, later to be formatted to
+    # produce a nested query.
+    #
+    # This code should be compatible with what Rack::Utils#build_nested_query [1]
+    # does.
+    #
+    # [1] https://github.com/rack/rack/blob/master/lib/rack/utils.rb
+    def flatten(value, key="")
+      case value
+      when Hash
+        out = []
+        value.each do |k,v|
+          k = "#{key}[#{k}]" if key != ''
+          out += flatten(v,k)
+        end
+        out
+      when Array
+        out = []
+        value.each do |v|
+          k = "#{key}[]"
+          out += flatten(v,k)
+        end
+        out
+      else
+        [[key,value]]
+      end
+    end
+
+    # Converts a flat array to a Hash.
+    #
+    # This code should be compatible with what Rack::Utils#parse_nested_query [1]
+    # does.
+    #
+    # [1] https://github.com/rack/rack/blob/master/lib/rack/utils.rb
+    def unflatten(array)
+      out = {}
+      array.each do |k,v|
+        path = [k.split("[").first] + k.scan(/\[(.*?)\]/).flatten
+        c = out
+
+        set = proc { |v,weak| } # Do nothing for the first level
+
+        path.each do |i|
+          case i
+          when "" # Array
+            set.([], true)
+            set = proc do |v,weak|
+              c << v
+              c = c.last
+            end
+          else # Hash
+            set.({}, true)
+            set = proc do |v,weak|
+              c[i] ||= v
+              c[i] = v if !weak
+              c = c[i]
+            end
+          end
+        end
+        set.(v, false)
+
+      end
+      out
+    end
+
+    # Checks if a query Hash contains any files.
+    def contain_files?(hash)
+      flatten(hash).any? { |k,v| [File, Blob].include?(v.class) }
+    end
+
+    # Convert a query Hash to a query string
+    #
+    # @return [String] the string encoded as URI
+    def build_query(hash, sep=?&)
+      flatten(hash).map { |k,v| encode(k) + ?= + encode(v.to_s) }.join(sep)
+    end
+
+    # Convert a query Hash to a FormData instance
+    #
+    # @return [FormData] the instance of FormData
+    def build_form_data(hash)
+      fd = FormData.create
+      flatten(hash).each { |k,v| fd << [k,v] }
+      fd
+    end
+
+    # Convert a query string to a query Hash
+    #
+    # @return [Hash] the query hash
+    def parse_query(string, sep=?&)
+      unflatten(string.split(sep).map { |s| s.split(?=).map(&method(:decode)) })
+    end
+
+    # Converts a JS native value to a wrapped one if possible.
+    #
+    # @return [String, File, Blob]
+    def from_native(n)
+      %x{
+        var c = #{n}.constructor;
+        if (c === File) {
+          #{n = File.new(n)}
+        }
+        else if (c === Blob) {
+          #{n = Blob.new(n)}
+        }
+      }
+      n
+    end
+  end
+
+  extend Converter
+  include Enumerable
+
+  # Create a new FormData instance
+  def self.create(hash=nil)
+    if Hash === hash
+      FormData.build_form_data(hash)
+    elsif DOM::Element::Form === hash
+      new(`new FormData(#{hash.to_n})`)
+    else
+      new(`new FormData()`)
+    end
+  end
+
+  # Append a tuple to this FormData instance
+  #
+  # @param tuple [Array(String, String), Array(String, Blob), Array(String, File),
+  #               Array(String, Blob, String), Array(String, File, String)]
+  #        a tuple of a key, value and possibly a filename
+  def <<(tuple)
+    key, value, filename = tuple
+
+    unless filename
+      `#@native.append(#{key}, #{Native.convert(value)})`
+    else
+      `#@native.append(#{key}, #{Native.convert(value)}, #{filename})`
+    end
+  end
+
+  # Get a field from this FormData instance with a given name
+  def [](key)
+    FormData.from_native(`#@native.get(#{key})`)
+  end
+
+  # Set a field in this FormData instance with a given name
+  def set(key, value, filename = nil)
+    unless filename
+      `#@native.set(#{key}, #{Native.convert(value)})`
+    else
+      `#@native.set(#{key}, #{Native.convert(value)}, #{filename})`
+    end
+  end
+  alias []= set
+
+  # Convert to hash
+  def to_h
+    hash = {}
+    %x{
+      var pair, v, e = #@native.entries();
+      while (true) {
+        v = e.next();
+        if (v.done) break;
+        pair = v.value;
+        #{hash[`pair[0]`] = FormData.from_native(`pair[1]`)}
+      }
+    }
+    hash
+  end
+
+  # Convert to array
+  def to_a
+    to_h.to_a
+  end
+
+  # Iterate over all elements of this FormData
+  def each(&block)
+    to_h.each(&block)
+  end
+
+  # Checks if a field of this name exists in this FormData instance
+  def include?(key)
+    `#@native.has(#{key})`
+  end
+
+  # Delete a field from this FormData instance
+  def delete(key)
+    `#@native.delete(#{key})`
+  end
+end
+
+end

data/opal/browser/history.rb

@@ -11,7 +11,7 @@ class History
     Browser.supports? 'History'
   end
 
-  include Native
+  include Browser::NativeCachedWrapper
 
   # @!attribute [r] length
   # @return [Integer] how many items are in the history
@@ -36,9 +36,7 @@ class 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, item)`
+    `#@native.pushState(#{data.to_n}, null, item)`
   end
 
   # Replace the current history item with another.
@@ -46,15 +44,13 @@ class History
   # @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, item)`
+    `#@native.replaceState(#{data.to_n}, null, item)`
   end
 
   # @!attribute [r] current
   # @return [String] the current item
   def current
-    $window.location.path
+    $window.location.full_path
   end
 
   # @!attribute [r] state

data/opal/browser/http/request.rb

@@ -1,7 +1,8 @@
 module Browser; module HTTP
 
 class Request
-  include Native
+  include Native::Wrapper
+  include Event::Target
 
   # Default headers.
   HEADERS = {
@@ -10,6 +11,8 @@ class Request
     'Accept'           => 'text/javascript, text/html, application/xml, text/xml, */*'
   }
 
+  STATES = %w[uninitialized loading loaded interactive complete]
+
   # @!attribute [r] headers
   # @return [Headers] the request headers
   attr_reader :headers
@@ -191,8 +194,12 @@ class Request
   # @param what [Symbol, String] the event name
   #
   # @yieldparam response [Response] the response for the event
-  def on(what, &block)
-    @callbacks[what] << block
+  def on(what, *, &block)
+    if STATES.include?(what) || %w[success failure].include?(what) || Integer === what
+      @callbacks[what] << block
+    else
+      super
+    end
   end
 
   # Open the request.
@@ -229,7 +236,7 @@ class Request
         url += ??
       end
 
-      url += @query.encode_uri
+      url += FormData.build_query(@query)
     end
 
     `#@native.open(#{@method.to_s.upcase}, #{url.to_s}, #{@asynchronous}, #{@user.to_n}, #{@password.to_n})`
@@ -289,14 +296,29 @@ class Request
 
     if String === parameters
       data = parameters
-    elsif Hash === parameters && !parameters.empty?
-      data = parameters.map {|vals|
-        vals.map(&:encode_uri_component).join(?=)
-      }.join(?&)
+    elsif (Hash === parameters && !parameters.empty?) || FormData === parameters
+      data = if Hash === parameters
+        if FormData.contain_files?(parameters)
+          FormData.build_form_data(parameters)
+        else
+          FormData.build_query(parameters)
+        end
+      else #if FormData === parameters
+        parameters
+      end
 
       unless @content_type
-        `#@native.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded')`
+        if FormData === data
+          # I thought it's done this way, but it isn't. It actually is
+          # "multipart/form-data; boundary=-----------.......". Let's miss it
+          # purposefully, because it's filled in automatically in this example.
+          # `#@native.setRequestHeader('Content-Type', 'multipart/form-data')`
+        else
+          `#@native.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded')`
+        end
       end
+
+      data = data.to_n
     else
       data = `null`
     end
@@ -314,7 +336,7 @@ class Request
 private
   def callback
     -> event {
-      state = %w[uninitialized loading loaded interactive complete][`#@native.readyState`]
+      state = STATES[`#@native.readyState`]
       res   = response
 
       @callbacks[state].each { |b| b.(res) }

data/opal/browser/http/response.rb

@@ -4,7 +4,7 @@ module Browser; module HTTP
 
 # Represents an HTTP response.
 class Response
-  include Native
+  include Native::Wrapper
 
   Status = Struct.new(:code, :text)
 
@@ -47,6 +47,10 @@ class Response
     !success?
   end
 
+  # @!attribute [r] url
+  # @return [String] the response URL (after redirects)
+  alias_native :url, :responseURL
+
   # @!attribute [r] text
   # @return [String] the response body as text
   def text

data/opal/browser/http.rb

@@ -1,5 +1,3 @@
-require 'promise'
-
 require 'browser/http/binary'
 require 'browser/http/headers'
 require 'browser/http/request'

data/opal/browser/immediate.rb

@@ -1,5 +1,3 @@
-require 'promise'
-
 module Browser
 
 # Class to easily create and dispatch an immediate call.

data/opal/browser/location.rb

@@ -4,7 +4,7 @@ module Browser
 #
 # @see https://developer.mozilla.org/en-US/docs/Web/API/Location
 class Location
-  include Native
+  include Browser::NativeCachedWrapper
 
   # Change the location.
   #
@@ -66,6 +66,12 @@ 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

data/opal/browser/navigator.rb

@@ -4,7 +4,7 @@ module Browser
 #
 # @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)
@@ -12,7 +12,7 @@ class Navigator
 
   # Representation of a MIME type.
   class MimeType
-    include Native
+    include Browser::NativeCachedWrapper
 
     # @!attribute [r] plugin
     # @return [Plugin] the plugin for the MIME type
@@ -62,7 +62,7 @@ class Navigator
     alias_native :version
   end
 
-  # Representation for the arary of plugins.
+  # Representation for the array of plugins.
   #
   # @see https://developer.mozilla.org/en-US/docs/Web/API/NavigatorPlugins
   class Plugins < Native::Array
@@ -160,13 +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
   # @!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