opal-browser 0.2.0.beta1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b0aa6c5110fd5e167607dbdea62c227163d95be
-  data.tar.gz: 666fc17d0cb5be69e9acf8a2f2d526e4995b7496
+  metadata.gz: 7da4f18bcba46ae940082055c721673e46573149
+  data.tar.gz: f70ab45c0391a6e9924b0b29a3a01923a7f1bcd2
 SHA512:
-  metadata.gz: bdb5103e7c85d23815225544ee28a504a024cc61beb58c5ca77e1af6c0b33853c6bc0b5cc530975039f28151572b423725e6abc7bf5aa22bd4fe82ec4ef68ed8
-  data.tar.gz: 4c08aa42993c6e63623dae9d5b9b09ed722801bf771c1527c56bb0791807958ffbb2d5c80904ae457c0686cf15ea597176de7269f9862a0d014f7171d7597f35
+  metadata.gz: e193b212a1d022644320910c25550cfb9f1db89667f07ea1c594ef5c70aff102a3184b68099f7cd7e9e0d8f6d4904e1dc429c678fbe6fb913d20df64c2c5f610
+  data.tar.gz: 03ed1d8246750cae5bae479b3146de89217ab57af51e5e95d1889247e74a7e6a4fdfad38447f1d0e8290b356924dfa4fd46c899469fa3b95c2bc568ad9c8d644

data/.travis.yml

@@ -16,10 +16,6 @@ env:
     - SELENIUM_BROWSER=firefox SELENIUM_VERSION=25
     - SELENIUM_BROWSER=firefox SELENIUM_VERSION=26
 
-    - SELENIUM_BROWSER=safari SELENIUM_VERSION=5.1
-    - SELENIUM_BROWSER=safari SELENIUM_VERSION=6.1
-    - SELENIUM_BROWSER=safari SELENIUM_VERSION=7.0
-
     - SELENIUM_BROWSER=opera SELENIUM_VERSION=12.15
     - SELENIUM_BROWSER=opera SELENIUM_VERSION=12.16
 
@@ -30,19 +26,37 @@ env:
     - SELENIUM_BROWSER=ie SELENIUM_VERSION=10
     - SELENIUM_BROWSER=ie SELENIUM_VERSION=11
 
+    - SELENIUM_BROWSER=safari SELENIUM_VERSION=5.1
+    - SELENIUM_BROWSER=safari SELENIUM_VERSION=6.1
+    - SELENIUM_BROWSER=safari SELENIUM_VERSION=7.0
+
+    - SELENIUM_BROWSER=ipad   SELENIUM_DEVICE="iPad 2 (5.0)"
+    - SELENIUM_BROWSER=iphone SELENIUM_DEVICE="iPhone 4S"
+    - SELENIUM_BROWSER=iphone SELENIUM_DEVICE="iPhone 5"
+    - SELENIUM_BROWSER=iphone SELENIUM_DEVICE="iPhone 5S"
+
+    - SELENIUM_BROWSER=android SELENIUM_DEVICE="Samsung Galaxy Nexus"
+    - SELENIUM_BROWSER=android SELENIUM_DEVICE="Motorola Razr Maxx HD"
+    - SELENIUM_BROWSER=android SELENIUM_DEVICE="LG Nexus 4"
+
     - SELENIUM_BROWSER=chrome SELENIUM_VERSION=30
     - SELENIUM_BROWSER=chrome SELENIUM_VERSION=31
 
 matrix:
   allow_failures:
-    # I know these fail
-    - env: SELENIUM_BROWSER=ie SELENIUM_VERSION=6
-    - env: SELENIUM_BROWSER=ie SELENIUM_VERSION=7
-
     # ChromeDriver be broken
     - env: SELENIUM_BROWSER=chrome SELENIUM_VERSION=31
     - env: SELENIUM_BROWSER=chrome SELENIUM_VERSION=30
 
+    # Something's fishy
+    - env: SELENIUM_BROWSER=ipad   SELENIUM_DEVICE="iPad 2 (5.0)"
+    - env: SELENIUM_BROWSER=iphone SELENIUM_DEVICE="iPhone 5"
+
+    # Android's driver be broken
+    - env: SELENIUM_BROWSER=android SELENIUM_DEVICE="Samsung Galaxy Nexus"
+    - env: SELENIUM_BROWSER=android SELENIUM_DEVICE="Motorola Razr Maxx HD"
+    - env: SELENIUM_BROWSER=android SELENIUM_DEVICE="LG Nexus 4"
+
 before_install:
   - gem update bundler
   - bundle --version

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 gem 'rack'
 gem 'sinatra'
 gem 'sinatra-websocket'
-gem 'opal-rspec', '0.3.0.beta3'
+gem 'opal-rspec', '0.4.0.beta1'
 
 # runner
 gem 'selenium-webdriver', require: false

data/README.md

@@ -1,13 +1,34 @@
 Browser support for Opal
 ========================
 
-[![Build Status](https://secure.travis-ci.org/opal/opal-browser.png?branch=master)](http://travis-ci.org/opal/opal-browser)
-[![Gem Version](https://badge.fury.io/rb/opal-browser.png)](http://badge.fury.io/rb/opal-browser)
-[![Code Climate](https://codeclimate.com/github/opal/opal-browser.png)](https://codeclimate.com/github/opal/opal-browser)
+[![Build Status](https://secure.travis-ci.org/opal/opal-browser.svg?branch=master)](http://travis-ci.org/opal/opal-browser)
+[![Gem Version](https://badge.fury.io/rb/opal-browser.svg)](http://badge.fury.io/rb/opal-browser)
+[![Code Climate](http://img.shields.io/codeclimate/github/opal/opal-browser.svg)](https://codeclimate.com/github/opal/opal-browser)
+
 
 This library aims to be a full-blown wrapper for all the browser API including
 HTML5.
 
+Usage
+=====
+
+_Server side (config.ru, Rakefile, Rails, Sinatra, etc.)_
+
+```ruby
+require 'opal-browser'
+# Your server code here
+```
+
+_Browser side_
+
+```ruby
+require 'opal'
+require 'browser'
+# Your Opal code here
+```
+
+
+
 Features
 ========
 This is a list of the currently wrapped features and some details on them.
@@ -18,7 +39,7 @@ DOM support is complete as far as I know, it has a very Nokogiri feel to it
 with obvious differences where relevant (for instance, event handling).
 
 ```ruby
-$document.on 'dom:load' do
+$document.ready do
   alert "yo dawg, I'm all loaded up in here"
 end
 ```
@@ -27,7 +48,7 @@ It also supports a markaby inspired builder DSL which generates DOM nodes
 directly instead of creating a string.
 
 ```ruby
-$document.on 'dom:load' do
+$document.ready do
   DOM {
     div.info {
       span.red "I'm all cooked up."
@@ -89,6 +110,18 @@ EventSource
 -----------
 Event sources have been implemented and are easily configurable with blocks.
 
+```ruby
+Browser::EventSource.new '/events' do |es|
+  es.on :message do |e|
+    alert e.data
+  end
+
+  es.on :custom do |e|
+    alert "custom #{e.data}"
+  end
+end
+```
+
 History
 -------
 The HTML5 History API has been fully wrapped.
@@ -98,6 +131,27 @@ Storage
 The HTML5 Storage API has been wrapped and it exports a single Storage class
 that uses the most appropriate and available API to store data locally.
 
+Database SQL
+------------
+WebSQL has been fully wrapped.
+
+```ruby
+db = Browser::Database::SQL.new 'test'
+db.transaction {|t|
+  t.query('CREATE TABLE test(ID INTEGER PRIMARY KEY ASC, text TEXT)').then {
+    t.query('INSERT INTO test (id, text) VALUES(?, ?)', 1, 'huehue')
+  }.then {
+    t.query('INSERT INTO test (id, text) VALUES(?, ?)', 2, 'jajaja')
+  }.then {
+    t.query('SELECT * FROM test')
+  }.then {|r|
+    r.each {|row|
+      alert row.inspect
+    }
+  }
+}
+```
+
 Browser support
 ===============
 

data/index.html.erb

@@ -7,16 +7,19 @@
     window.onerror = function(msg, url, line) {
       var error = document.createElement("div");
           error.setAttribute("id", "rspec-error");
-          error.innerHTML  = "Error: " + msg + "<br/>";
-          error.innerHTML += "Line: " + line + "<br/>";
-          error.innerHTML += "URL: " + url + "<br/>";
+          error.appendChild(document.createTextNode(msg));
 
       document.body.appendChild(error);
     }
   </script>
+
+  <script src="spec/json2.js"></script>
+  <script src="spec/sizzle.js"></script>
+  <script src="spec/wgxpath.install.js"></script>
+
+  <%= javascript_include_tag @server.main %>
 </head>
 <body>
-  <%= javascript_include_tag @server.main %>
 </body>
 </html>
 

data/lib/opal-browser.rb

@@ -0,0 +1 @@
+require 'opal/browser'

data/opal-browser.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new {|s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ['lib']
 
-  s.add_dependency 'opal', '~> 0.6.0'
+  s.add_dependency 'opal'
   s.add_dependency 'paggio'
 }

data/opal/browser.rb

@@ -5,6 +5,7 @@ require 'browser/version'
 require 'browser/utils'
 require 'browser/support'
 
+require 'browser/event'
 require 'browser/window'
 require 'browser/dom'
 require 'browser/css'

data/opal/browser/animation_frame.rb

@@ -1,6 +1,22 @@
 module Browser
 
+# Allows you to wrap a block to use in an animation rendering cycle.
+#
+# @see https://developer.mozilla.org/en/docs/Web/API/window.requestAnimationFrame
 class AnimationFrame
+  def self.supported?
+    ['Animation.request',
+     'Animation.request (Chrome)',
+     'Animation.request (Firefox)',
+     'Animation.request (Opera)',
+     'Animation.request (Internet Explorer)'].any? {|feature|
+       Browser.supports? feature
+     }
+  end
+
+  # Execute the block to update an animation before the next repaint.
+  #
+  # @param window [Window] the window to request the frame on
   def initialize(window, &block)
     @window = window
     @native = window.to_n
@@ -28,6 +44,7 @@ class AnimationFrame
       `#@native.msRequestAnimationFrame(#{block.to_n})`
     end
   else
+    # Request the animation frame.
     def request
       raise NotImplementedError, 'window requestAnimationFrame unsupported'
     end
@@ -70,6 +87,7 @@ class AnimationFrame
       `#@native.msCancelRequestAnimationFrame(#@id)`
     end
   else
+    # Cancel the animation frame request.
     def cancel
       raise NotImplementedError, 'window cancelAnimationFrame unsupported'
     end
@@ -78,8 +96,15 @@ end
 
 end
 
+module Kernel
+  # (see Browser::AnimationFrame.new)
+  def animation_frame(&block)
+    Browser::AnimationFrame.new($window, &block)
+  end
+end
+
 class Proc
-  # Execute a block to update an animation before the next repaint.
+  # (see Browser::AnimationFrame.new)
   def animation_frame
     Browser::AnimationFrame.new($window, &self)
   end

data/opal/browser/canvas.rb

@@ -1,13 +1,3 @@
-#--
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#                    Version 2, December 2004
-#
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-#
-#  0. You just DO WHAT THE FUCK YOU WANT TO.
-#++
-
 require 'promise'
 
 require 'browser/canvas/style'

data/opal/browser/canvas/data.rb

@@ -1,13 +1,3 @@
-#--
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#                    Version 2, December 2004
-#
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-#
-#  0. You just DO WHAT THE FUCK YOU WANT TO.
-#++
-
 module Browser; class Canvas
 
 class Data

data/opal/browser/canvas/gradient.rb

@@ -1,13 +1,3 @@
-#--
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#                    Version 2, December 2004
-#
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-#
-#  0. You just DO WHAT THE FUCK YOU WANT TO.
-#++
-
 module Browser; class Canvas
 
 class Gradient

data/opal/browser/canvas/style.rb

@@ -1,13 +1,3 @@
-#--
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#                    Version 2, December 2004
-#
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-#
-#  0. You just DO WHAT THE FUCK YOU WANT TO.
-#++
-
 module Browser; class Canvas
 
 class StyleObject

data/opal/browser/canvas/text.rb

@@ -1,13 +1,3 @@
-#--
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#                    Version 2, December 2004
-#
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-#
-#  0. You just DO WHAT THE FUCK YOU WANT TO.
-#++
-
 module Browser; class Canvas
 
 class Text

data/opal/browser/cookies.rb

@@ -43,17 +43,15 @@ class Cookies
 
   # 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
+  #
+  # @option options [Integer] :max_age the max age of the cookie in seconds
+  # @option options [Time]    :expires the expire date
+  # @option options [String]  :path    the path the cookie is valid on
+  # @option options [String]  :domain  the domain the cookie is valid on
+  # @option options [Boolean] :secure  whether the cookie is secure or not
   def []=(name, value, options = {})
     `#@document.cookie = #{encode name, value.is_a?(String) ? value : JSON.dump(value), @options.merge(options)}`
   end

data/opal/browser/database/sql.rb

@@ -0,0 +1,194 @@
+require 'promise'
+require 'ostruct'
+
+module Browser; module Database
+
+class SQL
+  # Check if the browser supports WebSQL.
+  def self.supported?
+    Browser.supports? 'WebSQL'
+  end
+
+  class Error < StandardError
+    def self.new(error)
+      return super if self != Error
+
+      [Unknown, Database, Version, TooLarge, Quota, Syntax, Constraint, Timeout] \
+        [`error.code`].new(`error.message`)
+    end
+
+    Unknown    = Class.new(self)
+    Database   = Class.new(self)
+    Version    = Class.new(self)
+    TooLarge   = Class.new(self)
+    Quota      = Class.new(self)
+    Syntax     = Class.new(self)
+    Constraint = Class.new(self)
+    Timeout    = Class.new(self)
+  end
+
+  include Native
+
+  # @return [String] the name of the database
+  attr_reader :name
+
+  # @return [String] the description for the database
+  attr_reader :description
+
+  # @return [Integer] the size constraint in bytes
+  attr_reader :size
+
+  # Open a database with the given name and options.
+  #
+  # @param name [String] the name for the database
+  # @param options [Hash] options to open the database
+  #
+  # @option options [String] :description the description for the database
+  # @option options [String] :version ('') the expected version of the database
+  # @option options [Integer] :size (5 * 1024 * 1024) the size constraint in bytes
+  def initialize(name, options = {})
+    @name        = name
+    @description = options[:description] || name
+    @version     = options[:version]     || ''
+    @size        = options[:size]        || 2 * 1024 * 1024
+
+    super(`window.openDatabase(#{name}, #{@version}, #{@description}, #{@size})`)
+  end
+
+  # @overload version()
+  #
+  #   Get the version of the database.
+  #
+  #   @return [String]
+  #
+  # @overload version(from, to, &block)
+  #
+  #   Migrate the database to a new version.
+  #
+  #   @param from [String] the version you're migrating from
+  #   @param to [String] the version you're migrating to
+  #
+  #   @yieldparam transaction [Transaction] the transaction to work with
+  def version(from = nil, to = nil, &block)
+    return `#@native.version` unless block
+
+    `#@native.changeVersion(#{from}, #{to},
+      #{-> t { block.call(Transaction.new(self, t)) }})`
+  end
+
+  # Start a transaction on the database.
+  #
+  # @yieldparam transaction [Transaction] the transaction to work on
+  def transaction(&block)
+    raise ArgumentError, 'no block given' unless block
+
+    `#@native.transaction(#{-> t { block.call(Transaction.new(self, t)) }})`
+  end
+
+  # Allows you to make changes to the database or read data from it.
+  class Transaction
+    include Native
+
+    # @return [Database] the database the transaction has been created from
+    attr_reader :database
+
+    # @private
+    def initialize(database, transaction)
+      @database = database
+
+      super(transaction)
+    end
+
+    # Query the database.
+    #
+    # @param query [String] the SQL query to send
+    # @param parameters [Array] optional bind parameters for the query
+    #
+    # @return [Promise]
+    def query(query, *parameters)
+      promise = Promise.new
+
+      `#@native.executeSql(#{query}, #{parameters},
+        #{-> _, r { promise.resolve(Result.new(self, r)) }},
+        #{-> _, e { promise.reject(Error.new(e)) }})`
+
+      promise
+    end
+  end
+
+  # Represents a row.
+  class Row < OpenStruct
+    # @private
+    def initialize(row)
+      super(Hash.new(row))
+    end
+
+    def inspect
+      "#<SQL::Row: #{Hash.new(@native).inspect}>"
+    end
+  end
+
+  class Result
+    include Native
+
+    # @return [Transaction] the transaction the result came from
+    attr_reader :transaction
+
+    # @return [SQL] the database the result came from
+    attr_reader :database
+
+    # @private
+    def initialize(transaction, result)
+      @transaction = transaction
+      @database    = transaction.database
+
+      super(result)
+    end
+
+    include Enumerable
+
+    # Get a row from the result.
+    #
+    # @param index [Integer] the index for the row
+    #
+    # @return [Row]
+    def [](index)
+      if index < 0
+        index += length
+      end
+
+      unless index < 0 || index >= length
+        Row.new(`#@native.rows.item(index)`)
+      end
+    end
+
+    # Enumerate over the rows.
+    #
+    # @yieldparam row [Row]
+    #
+    # @return [self]
+    def each(&block)
+      return enum_for :each unless block
+
+      %x{
+        for (var i = 0, length = #@native.rows.length; i < length; i++) {
+          #{block.call(self[`i`])};
+        }
+      }
+
+      self
+    end
+
+    # @!attribute [r] length
+    # @return [Integer] number of rows in the result
+    def length
+      `#@native.rows.length`
+    end
+
+    # @!attribute [r] affected
+    # @return [Integer] number of affected rows
+    alias_native :affected, :rowsAffected
+  end
+end
+
+end; end