RubyGems - webkit_remote - Versions diffs - 0.1.0 - Mend

webkit_remote 0.1.0

Files changed (32) hide show

data/.document +5 -0
data/Gemfile +16 -0
data/Gemfile.lock +45 -0
data/LICENSE.txt +20 -0
data/README.rdoc +114 -0
data/Rakefile +38 -0
data/VERSION +1 -0
data/lib/webkit_remote/browser.rb +150 -0
data/lib/webkit_remote/client/page.rb +59 -0
data/lib/webkit_remote/client/page_events.rb +45 -0
data/lib/webkit_remote/client/runtime.rb +406 -0
data/lib/webkit_remote/client.rb +114 -0
data/lib/webkit_remote/event.rb +138 -0
data/lib/webkit_remote/process.rb +160 -0
data/lib/webkit_remote/rpc.rb +205 -0
data/lib/webkit_remote/top_level.rb +31 -0
data/lib/webkit_remote.rb +12 -0
data/test/fixtures/config.ru +12 -0
data/test/fixtures/html/load.html +7 -0
data/test/fixtures/html/runtime.html +31 -0
data/test/helper.rb +44 -0
data/test/webkit_remote/browser_test.rb +80 -0
data/test/webkit_remote/client/page_test.rb +31 -0
data/test/webkit_remote/client/remote_object_group_test.rb +81 -0
data/test/webkit_remote/client/remote_object_test.rb +133 -0
data/test/webkit_remote/client/runtime_test.rb +109 -0
data/test/webkit_remote/client_test.rb +99 -0
data/test/webkit_remote/event_test.rb +83 -0
data/test/webkit_remote/process_test.rb +52 -0
data/test/webkit_remote/rpc_test.rb +55 -0
data/test/webkit_remote_test.rb +63 -0
metadata +274 -0

data/lib/webkit_remote/top_level.rb ADDED Viewed

@@ -0,0 +1,31 @@
+# Top-level namespace.
+module WebkitRemote
+  # Launches a WebKit process locally, and sets up a debugger client for it.
+  #
+  # @param (see WebkitRemote::Process#initialize)
+  # @return [WebkitRemote::Client] a debugging client connected to a local
+  #     WebKit process; the client will automatically stop the process when
+  #     closed
+  def self.local(opts = {})
+    process = WebkitRemote::Process.new opts
+    browser = process.start
+    browser.stop_process = true
+    client = WebkitRemote::Client.new tab: browser.tabs.first,
+                                      close_browser: true
+    client
+  end
+  # Connects to a Webkit process, and sets up a debugger client for it.
+  #
+  # @param (see WebkitRemote::Browser#initialize)
+  # @return [WebkitRemote::Client] a debugging client connected to the remote
+  #     WebKit process; the connection will be automatically terminated when
+  #     the debugging client is closed
+  def self.remote(opts = {})
+    browser = WebkitRemote::Browser.new opts
+    # NOTE: connecting to the last tab to avoid internal tabs and whatnot
+    client = WebkitRemote::Client.new tab: browser.tabs.last,
+                                      close_browser: true
+    client
+  end
+end  # namespace WebkitRemote

data/lib/webkit_remote.rb ADDED Viewed

@@ -0,0 +1,12 @@
+module WebkitRemote; end
+require 'webkit_remote/top_level.rb'
+require 'webkit_remote/browser.rb'
+require 'webkit_remote/process.rb'
+require 'webkit_remote/rpc.rb'
+require 'webkit_remote/client.rb'
+require 'webkit_remote/event.rb'
+require 'webkit_remote/client/page.rb'
+require 'webkit_remote/client/page_events.rb'
+require 'webkit_remote/client/runtime.rb'

data/test/fixtures/config.ru ADDED Viewed

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler.setup :default, :development
+use Rack::Static, urls: ['/html'], root: 'test/fixtures'
+app = lambda do |env|
+  [
+    200,
+    {'Content-Type' => 'text/plain'},
+    ['Fixture app catch-all page. Invalid test URL.']
+  ]
+end
+run app

data/test/fixtures/html/load.html ADDED Viewed

@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+  <head><title>WebkitRemote load test</title></head>
+  <body>
+    <p>tbd</p>
+  </body>
+</html>

data/test/fixtures/html/runtime.html ADDED Viewed

@@ -0,0 +1,31 @@
+<!doctype html>
+<html>
+  <head>
+    <title>WebkitRemote Runtime test</title>
+    <script type="text/javascript">
+      (function() {
+        window.test_fn = function(hello, ruby) {
+          return hello + ruby;
+        };
+        var TestClass = function (hello) {
+          this.hello = hello;
+        };
+        TestClass.prototype.number = 42;
+        TestClass.prototype.add3 = function(hello, again, ruby) {
+          return this.hello + hello + again + ruby;
+        };
+        TestClass.prototype.greetings = function(arg1, arg2) {
+        return new TestClass(this.hello + ', ' + arg1.hello + ' and ' +
+                             arg2.hello);
+        };
+        TestClass.prototype.toString = function() {
+          return this.hello;
+        };
+        window.TestClass = TestClass;
+      })();
+    </script>
+  </head>
+  <body>
+    <p>tbd</p>
+  </body>
+</html>

data/test/helper.rb ADDED Viewed

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/unit'
+require 'minitest/spec'
+require 'simplecov'
+SimpleCov.start
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'webkit_remote'
+require 'thread'
+Thread.abort_on_exception = true
+# Launch a dev server and wait until it starts.
+pid = Process.spawn 'bundle exec puma --port 9969 --quiet test/fixtures/config.ru',
+                    :in => '/dev/null', :out => '/dev/null'
+Process.detach pid
+at_exit { Process.kill 'TERM', pid }
+loop do
+  begin
+    response = Net::HTTP.get_response URI.parse('http://localhost:9969')
+    break if response.kind_of?(Net::HTTPSuccess)
+  rescue SystemCallError
+    sleep 0.1
+  end
+end
+class MiniTest::Unit::TestCase
+  # URL for a file in the test/fixtures directory.
+  def fixture_url(name)
+    "http://localhost:9969/html/#{name}.html"
+  end
+end
+MiniTest::Unit.autorun

data/test/webkit_remote/browser_test.rb ADDED Viewed

@@ -0,0 +1,80 @@
+require File.expand_path('../helper.rb', File.dirname(__FILE__))
+describe WebkitRemote::Browser do
+  before :each do
+    @process = WebkitRemote::Process.new port: 9669
+    @process.start
+  end
+  after :each do
+    @process.stop if @process
+  end
+  describe 'with process' do
+    before :each do
+      @browser = WebkitRemote::Browser.new process: @process
+    end
+    after :each do
+      @browser.close if @browser
+    end
+    it 'sets the host and port correctly' do
+      @browser.host.must_equal 'localhost'
+      @browser.port.must_equal 9669
+    end
+    it 'enumerates the browser tabs correctly' do
+      tabs = @browser.tabs
+      tabs.length.must_equal 1
+      tabs.first.must_be_kind_of WebkitRemote::Browser::Tab
+      tabs.first.browser.must_equal @browser
+      tabs.first.debug_url.must_match(/^ws:\/\/localhost:9669\//)
+      tabs.first.url.must_equal 'about:blank'
+    end
+    it 'does not auto-stop the process by default' do
+      @browser.stop_process?.must_equal false
+      @browser.close
+      @browser.closed?.must_equal true
+      @process.running?.must_equal true
+    end
+    describe 'with process auto-stopping' do
+      before do
+        @browser.stop_process = true
+      end
+      it 'stops the process when closed' do
+        @browser.stop_process?.must_equal true
+        @browser.close
+        @browser.closed?.must_equal true
+        @process.running?.must_equal false
+      end
+    end
+  end
+  describe 'with host/port' do
+    before :each do
+      @browser = WebkitRemote::Browser.new host: 'localhost', port: 9669
+    end
+    after :each do
+      @browser.close if @browser
+    end
+    it "does not support process auto-stopping" do
+      @browser.stop_process.must_equal false
+      lambda {
+        @browser.stop_process = true
+      }.must_raise ArgumentError
+      @browser.stop_process.must_equal false
+    end
+    it 'enumerates the browser tabs correctly' do
+      tabs = @browser.tabs
+      tabs.length.must_equal 1
+      tabs.first.must_be_kind_of WebkitRemote::Browser::Tab
+      tabs.first.browser.must_equal @browser
+      tabs.first.debug_url.must_match(/^ws:\/\/localhost:9669\//)
+      tabs.first.url.must_equal 'about:blank'
+    end
+  end
+end

data/test/webkit_remote/client/page_test.rb ADDED Viewed

@@ -0,0 +1,31 @@
+require File.expand_path('../../helper.rb', File.dirname(__FILE__))
+describe WebkitRemote::Client::Page do
+  before do
+    @client = WebkitRemote.local port: 9669
+  end
+  after do
+    @client.close
+  end
+  describe 'navigate' do
+    before do
+      @url = fixture_url(:load)
+      @client.page_events = true
+      @client.navigate_to @url
+      @events = []
+      @client.each_event do |event|
+        @events << event
+        break if event.kind_of?(WebkitRemote::Event::PageLoaded)
+      end
+    end
+    it 'changes the tab URL' do
+      @client.browser.tabs.map(&:url).must_include @url
+    end
+    it 'fires a PageLoaded event' do
+      @events.map(&:class).must_include WebkitRemote::Event::PageLoaded
+    end
+  end
+end

data/test/webkit_remote/client/remote_object_group_test.rb ADDED Viewed

@@ -0,0 +1,81 @@
+require File.expand_path('../../helper.rb', File.dirname(__FILE__))
+describe WebkitRemote::Client::RemoteObjectGroup do
+  before :each do
+    @client = WebkitRemote.local port: 9669
+    @client.page_events = true
+    @client.navigate_to fixture_url(:runtime)
+    @client.wait_for type: WebkitRemote::Event::PageLoaded
+    @object1 = @client.remote_eval '({})', group: 'g1'
+    @object2 = @client.remote_eval '({})', group: 'g1'
+    @object3 = @client.remote_eval '({})', group: 'g2'
+    @group1 = @client.object_group 'g1'
+    @group2 = @client.object_group 'g2'
+  end
+  after :each do
+    @group1.release_all if @group1
+    @group2.release_all if @group2
+    @client.close
+  end
+  describe 'include?' do
+    it 'is true for objects in the group' do
+      @group1.include?(@object1).must_equal true
+      @group1.include?(@object2).must_equal true
+      @group2.include?(@object3).must_equal true
+    end
+    it 'is false for objects in different groups' do
+      @group2.include?(@object2).must_equal false
+      @group1.include?(@object3).must_equal false
+      @group2.include?(@object1).must_equal false
+    end
+  end
+  describe 'after an object release' do
+    before :each do
+      @object1.release
+    end
+    it 'does not include the released object' do
+      @group1.include?(@object1).must_equal false
+    end
+    it 'includes unreleased objects' do
+      @group1.include?(@object2).must_equal true
+    end
+    it 'does not release the whole group' do
+      @group1.released?.must_equal false
+    end
+    describe 'after releasing the only other object in the group' do
+      before :each do
+        @object2.release
+      end
+      it 'released the whole group' do
+        @group1.released?.must_equal true
+      end
+      it 'removes the group from the client' do
+        @client.object_group('g1').must_equal nil
+      end
+    end
+  end
+  describe '#release_all' do
+    before :each do
+      @group1.release_all
+    end
+    it 'releases all the objects in the group' do
+      @object1.released?.must_equal true
+      @object2.released?.must_equal true
+    end
+    it 'does not release objects in other groups' do
+      @object3.released?.must_equal false
+    end
+    it 'releases the group and removes the group from the client' do
+      @group1.released?.must_equal true
+      @client.object_group('g1').must_equal nil
+    end
+  end
+end

data/test/webkit_remote/client/remote_object_test.rb ADDED Viewed

@@ -0,0 +1,133 @@
+require File.expand_path('../../helper.rb', File.dirname(__FILE__))
+describe WebkitRemote::Client::RemoteObject do
+  before :each do
+    @client = WebkitRemote.local port: 9669
+    @client.page_events = true
+    @client.navigate_to fixture_url(:runtime)
+    @client.wait_for type: WebkitRemote::Event::PageLoaded
+  end
+  after :each do
+    @client.close
+  end
+  describe 'properties' do
+    describe 'with simple JSON' do
+      before :each do
+        @object = @client.remote_eval 'window.t = ({answer: 42, test: true})'
+      end
+      it 'enumerates the properties correctly' do
+        @object.properties[:answer].name.must_equal :answer
+        @object.properties[:test].name.must_equal :test
+        @object.properties[:other].must_equal nil
+      end
+      it 'gets the correct values' do
+        @object.properties[:answer].value.must_equal 42
+        @object.properties[:test].value.must_equal true
+      end
+      it 'sets owner correctly' do
+        @object.properties[:answer].owner.must_equal @object
+      end
+      it 'does not have extra properties' do
+        @object.properties.select { |name, property| property.enumerable? }.
+                keys.sort.must_equal [:answer, :test]
+      end
+      it 'recognizes writable properties' do
+        @object.properties[:answer].writable?.must_equal true
+        @object.properties[:constructor].writable?.must_equal false
+      end
+      it 'recognizes configurable properties' do
+        @object.properties[:answer].configurable?.must_equal true
+        @object.properties[:constructor].configurable?.must_equal false
+      end
+      it 'recognizes enumerable properties' do
+        @object.properties[:answer].enumerable?.must_equal true
+        @object.properties[:constructor].enumerable?.must_equal false
+      end
+      describe 'after property update' do
+        before do
+          @object.properties[:DONE]
+          @client.remote_eval 'window.t.test = "updated"'
+        end
+        it 'does not automatically refresh' do
+          @object.properties[:test].value.must_equal true
+        end
+        it 'refreshes when properties! is called' do
+          @object.properties![:test].value.must_equal 'updated'
+        end
+      end
+    end
+    describe 'with the XMHttpRequest built-in' do
+      before :each do
+        @object = @client.remote_eval 'XMLHttpRequest'
+      end
+      it 'recognizes configurable, non-writable, enumerable properties' do
+        @object.properties[:DONE].configurable?.must_equal true
+        @object.properties[:DONE].writable?.must_equal false
+        @object.properties[:DONE].enumerable?.must_equal true
+      end
+    end
+  end
+  describe 'bound_call' do
+    before :each do
+      @object = @client.remote_eval 'new TestClass("hello ruby")', group: 'g1'
+    end
+    after :each do
+      group = @client.object_group 'g1'
+      group.release_all if group
+    end
+    describe 'with a function that operates on primitives' do
+      before :each do
+        @result = @object.bound_call 'TestClass.prototype.add3',
+                                     ' answer:', 4, 2
+      end
+      it 'returns a native primitive type' do
+        @result.must_equal 'hello ruby answer:42'
+      end
+    end
+    describe 'with a function that returns a primitive' do
+      before :each do
+        @arg1 = @client.remote_eval 'new TestClass(" again")', group: 'g1'
+        @arg2 = @client.remote_eval 'new TestClass(" ruby")', group: 'g2'
+        @result = @object.bound_call 'TestClass.prototype.add3', ' hello',
+                                     @arg1, @arg2
+      end
+      it 'returns a native primitive type' do
+        @result.must_equal 'hello ruby hello again ruby'
+      end
+    end
+    describe 'with objects' do
+      before :each do
+        @arg1 = @client.remote_eval '({hello: "rbx", goodbye: "java"})',
+                                    group: 'g1'
+        @arg2 = @client.remote_eval '({hello: "jruby", goodbye: "java2"})',
+                                    group: 'g2'
+        @result = @object.bound_call 'TestClass.prototype.greetings',
+                                     @arg1, @arg2
+      end
+      it 'passes the objects and returns an object correctly' do
+        @result.must_be_kind_of WebkitRemote::Client::RemoteObject
+        @result.js_class_name.must_equal 'TestClass'
+        @result.bound_call('TestClass.prototype.toString').
+                must_equal 'hello ruby, rbx and jruby'
+      end
+      it 'adds the result to the target group' do
+        @result.group.must_equal @object.group
+      end
+    end
+  end
+end