opal-browser 0.2.0.beta1 → 0.3.2

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/binary.rb

@@ -24,6 +24,7 @@ class Binary
   # Iterate over each byte in the binary.
   #
   # @yield [byte] the byte
+  #
   # @return [self]
   def each(&block)
     return enum_for :each unless block

data/opal/browser/http/headers.rb

@@ -14,6 +14,8 @@ class Headers
   end
 
   # Create {Headers} from a hash.
+  #
+  # @param hash [Hash]
   def self.[](hash)
     result = new
 
@@ -36,9 +38,11 @@ class Headers
     @hash.clear
   end
 
-  # Iterate over the headers.
+  # Enumerate over the headers.
+  #
+  # @yieldparam name [String] the name of the header
+  # @yieldparam value [String] the value of the header
   #
-  # @yield [name, value] the header name and value
   # @return [self]
   def each(&block)
     return enum_for :each unless block
@@ -51,10 +55,18 @@ class Headers
   end
 
   # Get the value of a header.
+  #
+  # @param name [String] the name of the header
+  #
+  # @return [String] the value of the header
   def [](name)
     @hash[name.downcase]
   end
 
+  # Set a value for the header.
+  #
+  # @param name [String] the name of the header
+  # @param value [String] the value of the header
   def []=(name, value)
     header = Header.new(name, value)
 
@@ -64,6 +76,7 @@ class Headers
   # Push a header.
   #
   # @param header [Header] the header to push
+  #
   # @return [self]
   def <<(header)
     @hash[header.name.downcase] = header
@@ -76,6 +89,7 @@ class Headers
   # Merge in place other headers.
   #
   # @param other [Headers, Hash, #each] the headers to merge
+  #
   # @return [self]
   def merge!(other)
     other.each {|name, value|

data/opal/browser/http/request.rb

@@ -1,25 +1,18 @@
 module Browser; module HTTP
 
 class Request
-  include Native
+  include Native::Wrapper
+  include Event::Target
 
-  # Open and send a 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)
-    request.send(*parameters)
-  end
-
-  DEFAULT_HEADERS = {
+  # Default headers.
+  HEADERS = {
     'X-Requested-With' => 'XMLHttpRequest',
     'X-Opal-Version'   => RUBY_ENGINE_VERSION,
     '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
@@ -45,7 +38,7 @@ class Request
 
     @parameters   = {}
     @query        = {}
-    @headers      = Headers[DEFAULT_HEADERS]
+    @headers      = Headers[HEADERS]
     @method       = :get
     @asynchronous = true
     @binary       = false
@@ -104,21 +97,13 @@ class Request
   end
 
   # Make the request asynchronous.
-  #
-  # @return [self]
   def asynchronous!
     @asynchronous = true
-
-    self
   end
 
   # Make the request synchronous.
-  #
-  # @return [self]
   def synchronous!
     @asynchronous = false
-
-    self
   end
 
   # Check the request is binary.
@@ -129,8 +114,6 @@ class Request
   # Make the request binary.
   def binary!
     @binary = true
-
-    self
   end
 
   # Check if the request is cacheable.
@@ -139,12 +122,8 @@ class Request
   end
 
   # Disable caching for this request.
-  #
-  # @return [self]
   def no_cache!
     @cacheable = false
-
-    self
   end
 
   # Get or set the user used for authentication.
@@ -213,13 +192,14 @@ class Request
   # Register an event on the request.
   #
   # @param what [Symbol, String] the event name
-  # @yield [response] yields the {Response}
   #
-  # @return [self]
-  def on(what, &block)
-    @callbacks[what] << block
-
-    self
+  # @yieldparam response [Response] the response for the event
+  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.
@@ -242,22 +222,27 @@ class Request
 
     url = @url
 
+    # add a dummy random parameter to the query to try circumvent caching
     unless cacheable?
       @query[:_] = rand
     end
 
+    # add the encoded query to the @url, prepending the right character if
+    # there was already a query in the defined @url or not
     unless @query.empty?
-      if url.include???
+      if url.include? ??
         url += ?&
       else
         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})`
 
+    # if there are no registered callbacks no point in setting the event
+    # handler
     unless @callbacks.empty?
       `#@native.onreadystatechange = #{callback}`
     end
@@ -277,6 +262,8 @@ class Request
 
     raise 'the request has already been sent' if sent?
 
+    # try to circumvent caching setting an If-Modified-Since header with a very
+    # old date
     unless cacheable?
       `#@native.setRequestHeader("If-Modified-Since", "Tue, 11 Sep 2001 12:46:00 GMT")`
     end
@@ -309,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
@@ -327,18 +329,14 @@ class Request
   end
 
   # Abort the request.
-  #
-  # @return [self]
   def abort
     `#@native.abort()`
-
-    self
   end
 
 private
   def callback
-    proc {|event|
-      state = %w[uninitialized loading loaded interactive complete][`#@native.readyState`]
+    -> event {
+      state = STATES[`#@native.readyState`]
       res   = response
 
       @callbacks[state].each { |b| b.(res) }
@@ -354,7 +352,7 @@ private
           @callbacks[:failure].each { |b| b.(res) }
         end
       end
-    }.to_n
+    }
   end
 end
 

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'
@@ -8,6 +6,7 @@ require 'browser/http/response'
 module Browser
 
 module HTTP
+  # Check if HTTP requests are supported.
   def self.supported?
     Browser.supports?('XHR') || Browser.supports?('ActiveXObject')
   end
@@ -18,6 +17,8 @@ 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 [Promise] a promise that will be resolved with the response
   def self.send(method, url, data = nil, &block)
     Promise.new.tap {|promise|
@@ -37,6 +38,8 @@ module HTTP
   #
   # @param url [String] the URL to request
   #
+  # @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)
@@ -46,6 +49,8 @@ module HTTP
   #
   # @param url [String] the URL to request
   #
+  # @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)
@@ -56,6 +61,8 @@ 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 [Promise] a promise that will be resolved with the response
   def self.post(url, data = nil, &block)
     send(:post, url, data, &block)
@@ -66,6 +73,8 @@ 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 [Promise] a promise that will be resolved with the response
   def self.put(url, data = nil, &block)
     send(:put, url, data, &block)
@@ -76,6 +85,8 @@ 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 [Promise] a promise that will be resolved with the response
   def self.delete(url, data = nil, &block)
     send(:delete, url, data, &block)
@@ -87,6 +98,8 @@ 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.send!(method, url, data = nil, &block)
     Request.new(&block).open(method, url, false).send(data)
@@ -96,6 +109,8 @@ module HTTP
   #
   # @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)
@@ -105,6 +120,8 @@ module HTTP
   #
   # @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)
@@ -115,6 +132,8 @@ 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)
@@ -125,6 +144,8 @@ 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)
@@ -135,6 +156,8 @@ 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,5 +1,3 @@
-require 'promise'
-
 module Browser
 
 # Class to easily create and dispatch an immediate call.
@@ -37,7 +35,6 @@ class Immediate
 
   # @!method prevent
   #   Prevent the immediate from being called once scheduled.
-
   if Browser.supports? 'Immediate'
     def dispatch
       @id = `window.setImmediate(function() {
@@ -58,7 +55,7 @@ class Immediate
     def prevent
       `window.msClearImmediate(#@id)`
     end
-  elsif Browser.supports? 'Window.send'
+  elsif Browser.supports? 'Window.send (Asynchronous)'
     # @private
     @@tasks  = {}
 
@@ -77,7 +74,7 @@ class Immediate
       @id          = rand(1_000_000).to_s
       @@tasks[@id] = [@function, @arguments, @block]
 
-      $window.send! "#{@@prefix}#{@id}"
+      $window.send "#{@@prefix}#{@id}"
     end
 
     def prevent
@@ -132,6 +129,13 @@ end
 
 end
 
+module Kernel
+  # (see Immediate.new)
+  def defer(*args, &block)
+    Browser::Immediate.new(block, args).tap(&:dispatch)
+  end
+end
+
 class Proc
   # (see Immediate.new)
   def defer(*args, &block)