opal-browser 0.1.0.beta1 → 0.2.0.beta1

data/opal/browser/canvas/data.rb

@@ -42,7 +42,7 @@ class Data
   end
 
   def length
-    `#@native.length`
+    `#@native.data.length`
   end
 
   def [](index)

data/opal/browser/console.rb

@@ -1,67 +1,43 @@
 module Browser
 
-# This class wraps a `window.console`.
+# Manipulate the browser console.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/API/console
 class Console
   include Native
 
   # Clear the console.
-  #
-  # @return [self]
   def clear
     `#@native.clear()`
-
-    self
   end
 
   # Print a stacktrace from the call site.
-  #
-  # @return [self]
   def trace
     `#@native.trace()`
-
-    self
   end
 
   # Log the passed objects based on an optional initial format.
-  #
-  # @return [self]
   def log(*args)
     `#@native.log.apply(#@native, args)`
-
-    self
   end
 
   # Log the passed objects based on an optional initial format as informational
   # log.
-  #
-  # @return [self]
   def info(*args)
     `#@native.info.apply(#@native, args)`
-
-    self
   end
 
   # Log the passed objects based on an optional initial format as warning.
-  #
-  # @return [self]
   def warn(*args)
     `#@native.warn.apply(#@native, args)`
-
-    self
   end
 
   # Log the passed objects based on an optional initial format as error.
-  #
-  # @return [self]
   def error(*args)
     `#@native.error.apply(#@native, args)`
-
-    self
   end
 
   # Time the given block with the given label.
-  #
-  # @return [self]
   def time(label, &block)
     raise ArgumentError, "no block given" unless block
 
@@ -76,13 +52,9 @@ class Console
     ensure
       `#@native.timeEnd()`
     end
-
-    self
   end
 
   # Group the given block.
-  #
-  # @return [self]
   def group(*args, &block)
     raise ArgumentError, "no block given" unless block
 
@@ -97,13 +69,9 @@ class Console
     ensure
       `#@native.groupEnd()`
     end
-
-    self
   end
 
   # Group the given block but collapse it.
-  #
-  # @return [self]
   def group!(*args, &block)
     return unless block_given?
 
@@ -118,8 +86,6 @@ class Console
     ensure
       `#@native.groupEnd()`
     end
-
-    self
   end
 end
 

data/opal/browser/cookies.rb

@@ -1,25 +1,36 @@
+require 'stringio'
+
 module Browser
 
+# Allows manipulation of browser cookies.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/API/document.cookie
 class Cookies
+  # Default cookie options.
+  DEFAULT = {
+    expires: Time.now + 1.day,
+    secure:  false
+  }
+
   include Enumerable
 
+  attr_reader :options
+
+  # Create a new {Cookies} wrapper.
+  #
+  # @param document [native] the native document object
   def initialize(document)
     @document = document
-
-    @options = {
-      expires: Time.now + 1.day,
-      path:    '',
-      domain:  '',
-      secure:  ''
-    }
-  end
-
-  def options (value = nil)
-    value ? @options.merge!(value) : @options
+    @options  = DEFAULT.dup
   end
 
-  def [] (name)
-    matches = `#@document.cookie`.scan(/#{Regexp.escape(key.encode_uri_component)}=([^;]*)/)
+  # Access the cookie with the given name.
+  #
+  # @param name [String] the name of the cookie
+  #
+  # @return [Object]
+  def [](name)
+    matches = `#@document.cookie`.scan(/#{Regexp.escape(name.encode_uri_component)}=([^;]*)/)
 
     return if matches.empty?
 
@@ -30,49 +41,94 @@ class Cookies
     result.length == 1 ? result.first : result
   end
 
-  def []= (name, value, options = {})
+  # Set a cookie.
+  #
+  # Options
+  # -------
+  # + **max_age** - the max age of the cookie in seconds
+  # + **expires** - the expire date as {Time}
+  # + **path** - the path where the cookie is valid on
+  # + **domain** - the domain where the cookie is valid on
+  # + **secure** - whether the cookie is secure or not
+  #
+  # @param name [String] the name of the cookie
+  # @param value [Object] the data to set
+  # @param options [Hash] the options for the cookie
+  def []=(name, value, options = {})
     `#@document.cookie = #{encode name, value.is_a?(String) ? value : JSON.dump(value), @options.merge(options)}`
   end
 
-  def delete (name)
+  # Delete a cookie.
+  #
+  # @param name [String] the name of the cookie
+  def delete(name)
     `#@document.cookie = #{encode name, '', expires: Time.now}`
   end
 
+  # @!attribute [r] keys
+  # @return [Array<String>] all the cookie names
   def keys
     Array(`#@document.cookie.split(/; /)`).map {|cookie|
       cookie.split(/\s*=\s*/).first
     }
   end
 
+  # @!attribute [r] values
+  # @return [Array] all the cookie values
   def values
     keys.map {|key|
       self[key]
     }
   end
 
-  def each
+  # Enumerate the cookies.
+  #
+  # @yieldparam key [String] the name of the cookie
+  # @yieldparam value [String] the value of the cookie
+  #
+  # @return [self]
+  def each(&block)
+    return enum_for :each unless block
+
     keys.each {|key|
       yield key, self[key]
     }
+
+    self
   end
 
+  # Delete all the cookies
+  #
+  # @return [self]
   def clear
     keys.each {|key|
       delete key
     }
+
+    self
   end
 
 protected
-  def encode (key, value, options = {})
-    result = "#{key.encode_uri_component}=#{value.encode_uri_component}; "
+  def encode(key, value, options = {})
+    io = StringIO.new
+
+    io << key.encode_uri_component << ?= << value.encode_uri_component << '; '
 
-    result += "max-age=#{options[:max_age]}; "        if options[:max_age]
-    result += "expires=#{options[:expires].to_utc}; " if options[:expires]
-    result += "path=#{options[:path]}; "              if options[:path]
-    result += "domain=#{options[:domain]}; "          if options[:domain]
-    result += 'secure'                                if options[:secure]
+    io << 'max-age=' << options[:max_age] << '; '        if options[:max_age]
+    io << 'expires=' << options[:expires].to_utc << '; ' if options[:expires]
+    io << 'path='    << options[:path] << '; '           if options[:path]
+    io << 'domain='  << options[:domain] << '; '         if options[:domain]
+    io << 'secure'                                       if options[:secure]
+
+    io.string
+  end
+end
 
-    result
+class DOM::Document < DOM::Element
+  # @!attribute [r] cookies
+  # @return [Cookies] the cookies for the document
+  def cookies
+    Cookies.new(@native) if defined?(`#@native.cookie`)
   end
 end
 

data/opal/browser/css/declaration.rb

@@ -18,21 +18,16 @@ class Declaration
 
   def replace(string)
     `#@native.cssText = #{string}`
-
-    self
   end
 
   def apply(&block)
     Paggio::CSS::Definition.new(&block).each {|style|
-      # FIXME: use ternary operator when it's fixed
       if style.important
         `#@native.setProperty(#{style.name}, #{style.value}, "important")`
       else
         `#@native.setProperty(#{style.name}, #{style.value}, "")`
       end
     }
-
-    self
   end
 
   def delete(name)

data/opal/browser/{timeout.rb → delay.rb}

@@ -1,15 +1,18 @@
 module Browser
 
-# This class wraps `setTimeout`.
-class Timeout
+# Allows you to delay the call to a function which gets called after the
+# given time.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/API/Window.setTimeout
+class Delay
   # @!attribute [r] after
-  # @return [Number] the seconds after which the block is called
+  # @return [Float] the seconds after which the block is called
   attr_reader :after
 
   # Create and start a timeout.
   #
   # @param window [Window] the window to start the timeout on
-  # @param time [Number] seconds after which the block is called
+  # @param time [Float] seconds after which the block is called
   def initialize(window, time, &block)
     @window = Native.convert(window)
     @after  = time
@@ -19,18 +22,13 @@ class Timeout
   end
 
   # Abort the timeout.
-  #
-  # @return [self]
   def abort
     `#@window.clearTimeout(#@id)`
-
-    self
   end
 
+  # Start the delay.
   def start
     @id = `#@window.setTimeout(#{@block.to_n}, #@after * 1000)`
-
-    self
   end
 end
 
@@ -38,22 +36,24 @@ class Window
   # Execute a block after the given seconds.
   #
   # @param time [Float] the seconds after it gets called
-  # @return [Timeout] the object representing the timeout
+  #
+  # @return [Delay] the object representing the timeout
   def after(time, &block)
-    Timeout.new(@native, time, &block)
+    Delay.new(@native, time, &block)
   end
 end
 
 end
 
 class Proc
+  # (see Browser::Window#after)
   def after(time)
     $window.after(time, &self)
   end
 end
 
 module Kernel
-  # (see Browser::Window#once)
+  # (see Browser::Window#after)
   def after(time, &block)
     $window.after(time, &block)
   end

data/opal/browser/dom.rb

@@ -12,8 +12,6 @@ require 'browser/dom/document_fragment'
 require 'browser/dom/builder'
 require 'browser/dom/mutation_observer'
 
-require 'browser/dom/compatibility'
-
 module Kernel
   # Parse an XML string into a DOM usable {Browser::DOM::Document}
   #

data/opal/browser/dom/attribute.rb

@@ -1,16 +1,22 @@
 module Browser; module DOM
 
+# Encapsulates an {Element} attribute.
 class Attribute
   include Native
 
+  # Returns true if the attribute is an id.
   def id?
     `#@native.isId`
   end
 
+  # @!attribute [r] name
+  # @return [String] the name of the attribute
   def name
     `#@native.name`
   end
 
+  # @!attribute [r] value
+  # @return [String] the value of the attribute
   def value
     `#@native.value`
   end

data/opal/browser/dom/builder.rb

@@ -9,10 +9,6 @@ class Paggio::HTML::Element < BasicObject
   def on(*args, &block)
     (@on ||= []) << [args, block]
   end
-
-  def style(*args, &block)
-    @style = [args, block]
-  end
 end
 
 module Browser; module DOM
@@ -79,10 +75,6 @@ Builder.for Paggio::HTML::Element do |b, item|
     }
   end
 
-  if style = `item.style || nil`
-    dom.style(*style[0], &style[1])
-  end
-
   if inner = `item.inner_html || nil`
     dom.inner_html = inner
   else
@@ -94,4 +86,8 @@ Builder.for Paggio::HTML::Element do |b, item|
   dom
 end
 
+Builder.for DOM::Node do |b, item|
+  item
+end
+
 end; end

data/opal/browser/dom/character_data.rb

@@ -1,34 +1,70 @@
 module Browser; module DOM
 
 class CharacterData < Node
+  # Append data to the node.
+  #
+  # @param string [String] the data to add
+  #
+  # @return [self]
+  def append(string)
+    `#@native.appendData(string)`
+
+    self
+  end
+
+  # @!attribute [r] data
+  # @return [String] the data of the node
   def data
     `#@native.data`
   end
 
-  def append(string)
-    `#@native.appendData(string)`
+  # Delete data from the node.
+  #
+  # @param count [Integer] how much data to delete
+  # @param offset [Integer] the offset to start at
+  #
+  # @return [self]
+  def delete(count, offset = 0)
+    `#@native.deleteData(offset, count)`
 
     self
   end
 
+  # Insert data in the node.
+  #
+  # @param string [String] the data to insert
+  # @param offset [Integer] the offset to start at
+  #
+  # @return [self]
   def insert(string, offset = 0)
     `#@native.insertData(offset, string)`
 
     self
   end
 
-  def delete(count, offset = 0)
-    `#@native.deleteData(offset, count)`
-
-    self
-  end
+  # @!attribute [r] length
+  # @return [Integer] the length of the node
+  alias_native :length
 
+  # Replace data in the node.
+  #
+  # @param string [String] the data to replace with
+  # @param offset [Integer] the offset to start at
+  # @param count [Integer] how much data to replace
+  #
+  # @return [self]
   def replace(string, offset = 0, count = `#@native.length`)
     `#@native.replaceData(offset, count, string)`
 
     self
   end
 
+  # Get a substring of the data.
+  #
+  # @param count [Integer] how much data to lice
+  # @param offset [Integer] the offset to start at
+  #
+  # @return [String] the substring
   def substring(count, offset = 0)
     `#@native.substringData(offset, count)`
   end