opal-browser 0.2.0.beta1 → 0.2.0

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

@@ -1,6 +1,6 @@
 require 'buffer'
 
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Message < Event
   def self.supported?
@@ -67,4 +67,4 @@ class Message < Event
   end
 end
 
-end; end; end
+end; end

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Progress < Event
   def self.supported?
@@ -40,4 +40,4 @@ class Progress < Event
   alias_native :total
 end
 
-end; end; end
+end; end

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

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

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

@@ -1,4 +1,4 @@
-module Browser; module DOM; class Event
+module Browser; class Event
 
 class Storage < Event
   def self.supported?
@@ -40,4 +40,4 @@ class Storage < Event
   alias_native :url
 end
 
-end; end; end
+end; end

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

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

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

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

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

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

data/opal/browser/event_source.rb

@@ -10,7 +10,7 @@ class EventSource
   end
 
   include Native
-  include DOM::Event::Target
+  include Event::Target
 
   target {|value|
     EventSource.new(value) if Native.is_a?(value, `window.EventSource`)

data/opal/browser/http.rb

@@ -8,6 +8,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 +19,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 +40,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 +51,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 +63,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 +75,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 +87,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 +100,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 +111,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 +122,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 +134,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 +146,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 +158,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/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

@@ -3,18 +3,8 @@ module Browser; module HTTP
 class Request
   include Native
 
-  # 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, */*'
@@ -45,7 +35,7 @@ class Request
 
     @parameters   = {}
     @query        = {}
-    @headers      = Headers[DEFAULT_HEADERS]
+    @headers      = Headers[HEADERS]
     @method       = :get
     @asynchronous = true
     @binary       = false
@@ -104,21 +94,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 +111,6 @@ class Request
   # Make the request binary.
   def binary!
     @binary = true
-
-    self
   end
 
   # Check if the request is cacheable.
@@ -139,12 +119,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 +189,10 @@ class Request
   # Register an event on the request.
   #
   # @param what [Symbol, String] the event name
-  # @yield [response] yields the {Response}
   #
-  # @return [self]
+  # @yieldparam response [Response] the response for the event
   def on(what, &block)
     @callbacks[what] << block
-
-    self
   end
 
   # Open the request.
@@ -242,12 +215,15 @@ 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 += ??
@@ -258,6 +234,8 @@ class Request
 
     `#@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 +255,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
@@ -327,17 +307,13 @@ class Request
   end
 
   # Abort the request.
-  #
-  # @return [self]
   def abort
     `#@native.abort()`
-
-    self
   end
 
 private
   def callback
-    proc {|event|
+    -> event {
       state = %w[uninitialized loading loaded interactive complete][`#@native.readyState`]
       res   = response
 
@@ -354,7 +330,7 @@ private
           @callbacks[:failure].each { |b| b.(res) }
         end
       end
-    }.to_n
+    }
   end
 end