terminus 0.1.0 → 0.2.0

data/lib/terminus/controller.rb

@@ -0,0 +1,78 @@
+module Terminus
+  class Controller
+    
+    include Timeouts
+    attr_accessor :dock_host
+    
+    def initialize
+      @connected = false
+      @browsers = {}
+      @ping_callbacks = []
+      trap('INT') { exit }
+    end
+    
+    def browser(id = nil)
+      return @browser if id.nil?
+      @browsers[id] ||= Browser.new(self)
+    end
+    
+    def browser=(params)
+      @browser = case params
+        when :docked then @browsers.values.find { |b| b.docked? }
+        when Browser then params
+        when Hash then
+          wait_with_timeout(:named_window) do
+            @browsers.values.find { |b| b.name == params[:name] }
+          end
+      end
+    end
+    
+    def drop_browser(browser)
+      @browsers.delete(browser.id)
+      @browser = nil if @browser == browser
+    end
+    
+    def ensure_browser
+      ensure_connection
+      wait_with_timeout(:browser) { @browser }
+    end
+    
+    def ensure_docked_browser
+      ensure_connection
+      wait_with_timeout(:docked_browser) { @browsers.any? { |id,b| b.docked? } }
+    end
+    
+    def messenger
+      Terminus.ensure_reactor_running
+      return @messenger if defined?(@messenger)
+      
+      @messenger = Faye::Client.new(Terminus.endpoint)
+      
+      @messenger.subscribe('/terminus/ping',    &method(:accept_ping))
+      @messenger.subscribe('/terminus/results', &method(:accept_result))
+      @messenger
+    end
+    
+    def return_to_dock
+      @browsers.each { |id, b| b.return_to_dock }
+    end
+    
+  private
+    
+    def accept_ping(message)
+      browser(message['id']).ping!(message)
+    end
+    
+    def accept_result(message)
+      browser(message['id']).result!(message)
+    end
+    
+    def ensure_connection
+      return if @connected
+      messenger.connect { @connected = true }
+      wait_with_timeout(:connection) { @connected }
+    end
+    
+  end
+end
+

data/lib/terminus/node.rb

@@ -0,0 +1,68 @@
+module Terminus
+  class Node
+    
+    attr_reader :id
+    
+    def initialize(browser, id)
+      @browser, @id = browser, id
+    end
+    
+    def click
+      page    = @browser.page_id
+      command = @browser.tell([:click, @id])
+      
+      @browser.wait_with_timeout(:click_response) do
+        @browser.result(command) || (@browser.page_id != page)
+      end
+    end
+    
+    def drag_to(node)
+      @browser.ask([:drag, {:from => @id, :to => node.id}])
+    end
+    
+    def find(xpath)
+      @browser.ask([:find, xpath, @id]).map { |id| Node.new(@browser, id) }
+    end
+    
+    def select
+      @browser.ask([:select, @id])
+    end
+    
+    def set(value)
+      result = @browser.ask([:set, @id, value])
+      raise Capybara::NotSupportedByDriverError.new if result == 'not_allowed'
+    end
+    
+    def trigger(event_type)
+      @browser.ask([:trigger, @id, event_type])
+    end
+    
+    def unselect
+      allowed = @browser.ask([:unselect, @id])
+      raise Capybara::UnselectNotAllowed.new unless allowed
+    end
+    
+    alias :select_option :select
+    alias :unselect_option :unselect
+    
+    SYNC_DSL_METHODS = [ [:[], :attribute],
+                         :tag_name,
+                         :text,
+                         :value,
+                         [:visible?, :is_visible]
+                       ]
+    
+    SYNC_DSL_METHODS.each do |method|
+      if Array === method
+        name, command = *method
+      else
+        name = command = method
+      end
+      define_method(name) do |*args|
+        @browser.ask([command, @id, *args])
+      end
+    end
+    
+  end
+end
+

data/lib/terminus/server.rb

@@ -16,7 +16,7 @@ module Terminus
     def run!
       return if running?
       handler = Rack::Handler.get('thin')
-      ensure_reactor_running!
+      Terminus.ensure_reactor_running
       handler.run(app, :Port => @options[:port]) { |s| @server = s }
     end
     
@@ -38,11 +38,6 @@ module Terminus
       app.get_client
     end
     
-    def ensure_reactor_running!
-      Thread.new { EM.run unless EM.reactor_running? }
-      while not EM.reactor_running?; end
-    end
-    
   end
 end
 

data/lib/terminus/timeouts.rb

@@ -0,0 +1,27 @@
+module Terminus
+  module Timeouts
+    
+    class TimeoutError < StandardError
+    end
+    
+    include Faye::Timeouts
+    TIMEOUT = 10
+    
+    def wait_with_timeout(name, duration = TIMEOUT, &predicate)
+      result, time_out = nil, false
+      add_timeout(name, duration) { time_out = true }
+      
+      while !result and !time_out
+        result = predicate.call
+        sleep 0.1
+      end
+      
+      raise TimeoutError.new("Waited #{duration}s but could not get a #{name}") if time_out
+      remove_timeout(name)
+      
+      result
+    end
+    
+  end
+end
+

data/lib/views/bookmarklet.erb

@@ -2,6 +2,11 @@
   var faye = '<%= ::Terminus::FAYE_MOUNT %>',
       host = '<%= host %>';
   
+  var html   = document.getElementsByTagName('html')[0],
+      source = '<html>\n' + html.innerHTML + '\n</html>\n';
+  
+  JSCLASS_PATH = host + '/js.class/';
+  
   var withPackageManager = function(callback) {
     if (window.JS && JS.Packages) return callback();
     
@@ -9,7 +14,7 @@
         head   = document.getElementsByTagName('head')[0];
     
     script.type = 'text/javascript';
-    script.src  = host + '/js.packages.js';
+    script.src  = host + '/loader.js';
     
     script.onload = script.onreadystatechange = function() {
       var state = script.readyState;
@@ -25,14 +30,19 @@
   withPackageManager(function() {
     JS.Packages(function() {
       this.file(host + faye + '/client.js')
-        .provides('Faye', 'Faye.Client');
+        .provides('Faye', 'Faye.Client')
+        .setup(function() { Faye.Client.prototype.MAX_DELAY = 0 });
+      
+      this.file(host + '/syn.js')
+        .provides('Syn');
       
       this.file(host + '/terminus.js')
-        .requires('Faye.Client')
+        .requires('Faye.Client', 'document.evaluate', 'Syn')
         .provides('Terminus');
     });
     
-    require('Terminus', function() {
+    JS.require('Terminus', function() {
+      Terminus.originalSource = source;
       Terminus.connect(host + faye);
     });
   });

data/lib/views/index.erb

@@ -7,21 +7,24 @@
     <title>Terminus</title>
   </head>
   <body>
+    <%= Terminus.driver_script request.host %>
     
     <div class="container">
       <h1><a href="javascript:<%= bookmarklet %>">Terminus</a>.</h1>
       
-      <p>Terminus is a distributed JavaScript console. You can find out
-        more at <a href="http://github.com/jcoglan/terminus">its GitHub page</a>.
-        To connect the console to your browser, you&rsquo;ll need this
-        bookmarklet. Just drag the word &lsquo;Terminus&rsquo; up to your
-        bookmark toolbar and click it to connect any page to your console.</p>
+      <p>This is the holding page. Browsers visiting this page are
+        connected to your Terminus server and can be taken over and
+        controlled by your Ruby programs.</p>
+      
+      <p>That big pink title up there is a bookmarklet. Drag it up
+        to your bookmarks bar and use it to connect any page on the
+        web to your Terminus console.</p>
     </div>
     
     <div class="footer">
-      <p>Copyright &copy; 2010
-      <a href="http://jcoglan.com">James Coglan</a>.
-      Released under the MIT license.</p>
+      <p>Copyright &copy; 2010 <a href="http://jcoglan.com">James Coglan</a>.<br>
+      Released under the MIT license.<br>
+      Source code hosted by <a href="http://github.com/jcoglan/terminus">GitHub</a>.</p>
     </div>
     
   </body>

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+root = File.dirname(__FILE__) + '/../'
+
+require root + 'vendor/capybara/spec/spec_helper'
+require root + 'lib/terminus'
+
+class TestApp
+  template :layout do
+    <<-HTML
+      <html>
+        <head>
+          <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+          <title>Capybara Driver Test</title>
+        </head>
+        <body>
+          <%= yield %>
+          <%= Terminus.driver_script request.host %>
+        </body>
+      </html>
+    HTML
+  end
+end
+

data/spec/terminus_driver_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Capybara::Driver::Terminus do
+  before do
+    @driver = Capybara::Driver::Terminus.new(TestApp)
+    Terminus.ensure_docked_browser
+    Terminus.browser = :docked
+  end
+
+  after do
+    Terminus.return_to_dock
+  end
+
+  it_should_behave_like "driver"
+  it_should_behave_like "driver with javascript support"
+  it_should_behave_like "driver without status code support"
+  it_should_behave_like "driver with support for window switching"
+  it_should_behave_like "driver with cookies support"
+  it_should_behave_like "driver with infinite redirect detection"
+end

data/spec/terminus_session_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Capybara::Session do
+  context 'with terminus driver' do
+    before do
+      @session = Capybara::Session.new(:terminus, TestApp)
+      Terminus.ensure_docked_browser
+      Terminus.browser = :docked
+    end
+
+    after do
+      Terminus.return_to_dock
+    end
+
+    describe '#driver' do
+      it "should be a terminus driver" do
+        @session.driver.should be_an_instance_of(Capybara::Driver::Terminus)
+      end
+    end
+
+    describe '#mode' do
+      it "should remember the mode" do
+        @session.mode.should == :terminus
+      end
+    end
+
+    it_should_behave_like "session"
+    it_should_behave_like "session without headers support"
+    it_should_behave_like "session with javascript support"
+    it_should_behave_like "session without status code support"
+  end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: terminus
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - James Coglan
@@ -9,81 +14,125 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-05 00:00:00 +01:00
+date: 2010-10-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
         version: "1.0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: thin
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
         version: "1.2"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: eventmachine
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
         version: "0.12"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: faye
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.2
-    version: 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: sinatra
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
         version: "1.0"
-    version: 
+  type: :runtime
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: packr
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 1
         version: "3.1"
-    version: 
+  type: :runtime
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: oyster
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
         version: "0.9"
-    version: 
+  type: :runtime
+  version_requirements: *id008
 description: 
-email: jcoglan@googlemail.com
+email: jcoglan@gmail.com
 executables: 
 - terminus
 extensions: []
@@ -92,14 +141,24 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - README.rdoc
-- lib/terminus.rb
-- lib/public/style.css
-- lib/public/terminus.js
-- lib/public/js.packages.js
-- lib/views/bookmarklet.erb
 - lib/views/index.erb
-- lib/terminus/server.rb
+- lib/views/bookmarklet.erb
+- lib/public/loader.js
+- lib/public/syn.js
+- lib/public/terminus.js
+- lib/public/style.css
+- lib/terminus.rb
+- lib/terminus/node.rb
+- lib/terminus/timeouts.rb
+- lib/terminus/browser.rb
 - lib/terminus/application.rb
+- lib/terminus/server.rb
+- lib/terminus/controller.rb
+- lib/capybara/driver/terminus.rb
+- spec/terminus_session_spec.rb
+- spec/terminus_driver_spec.rb
+- spec/spec_helper.rb
+- bin/terminus
 has_rdoc: true
 homepage: http://github.com/jcoglan/terminus
 licenses: []
@@ -111,23 +170,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Control multiple web browsers from the command line
+summary: Capybara driver for cross-browser testing
 test_files: []