terminus 0.4.0 → 0.5.0

data/lib/terminus/client.rb

@@ -1,35 +1,52 @@
 module Terminus
   module Client
-    
+
     autoload :Browser,    ROOT + '/terminus/client/browser'
     autoload :PhantomJS,  ROOT + '/terminus/client/phantomjs'
-    
+
     class Base
+      attr_reader :id
+
       def self.start(options = {})
-        process = new(options)
-        process.start
-        process
+        @process = new(options)
+        @process.start
+        @process
+      end
+
+      def self.debugger
+        @process.debugger
+      end
+
+      def self.save_screenshot(path, options = {})
+        @process.save_screenshot(path, options)
       end
-      
+
       def initialize(options)
-        @address  = TCPServer.new(0).addr
-        @port     = options[:port] || @address[1]
-        @terminus = Terminus.create(:port => @port)
-        @browser  = ChildProcess.build(*browser_args(options[:command]))
+        @id        = Faye.random
+        @options   = options
+        @address   = TCPServer.new(0).addr
+        @connector = Connector::Server.new(self)
+        @port      = options[:port] || @address[1]
+        @terminus  = Terminus.create(:port => @port)
+        @browser   = ChildProcess.build(*browser_args)
       end
-      
+
+      def debug(*args)
+        p args if Terminus.debug
+      end
+
       def start
         Terminus.ensure_reactor_running
         @terminus.run!
-        
+
         @browser.start
-        
+
         Terminus.port = @port
         Terminus.browser = browser_selector
-        
+
         at_exit { stop }
       end
-      
+
       def stop
         @terminus.stop!
         @browser.stop
@@ -37,7 +54,7 @@ module Terminus
       rescue ChildProcess::TimeoutError
       end
     end
-    
+
   end
 end
 

data/lib/terminus/client/browser.rb

@@ -1,30 +1,31 @@
 module Terminus
   module Client
-    
+
     class Browser < Base
       DEFAULT_COMMANDS = {
         /(mingw|mswin|windows|cygwin)/i => ['cmd', '/C', 'start', '/b'],
         /(darwin|mac os)/i              => ['open'],
         /(linux|bsd|aix|solaris)/i      => ['xdg-open']
       }
-      
-      def browser_args(command)
+
+      def browser_args
+        command = @options[:command]
         return command + [dock_url] if command
-          
+
         os  = RbConfig::CONFIG['host_os']
         key = DEFAULT_COMMANDS.keys.find { |key| os =~ key }
         DEFAULT_COMMANDS[key] + [dock_url]
       end
-      
+
       def browser_selector
-        {:current_url => dock_url}
+        {:raw_url => dock_url}
       end
-      
+
       def dock_url
-        "http://#{@address[2]}:#{@port}"
+        "http://#{@address[2]}:#{@port}/"
       end
     end
-    
+
   end
 end
 

data/lib/terminus/client/phantom.js

@@ -1,6 +1,28 @@
-var page = new WebPage(),
-    host = phantom.args[0],
-    port = phantom.args[1];
+var page   = new WebPage(),
+    width  = phantom.args[0],
+    height = phantom.args[1],
+    host   = phantom.args[2],
+    port   = phantom.args[3],
+    socket = phantom.args[4];
 
+var Commands = {
+  save_screenshot: function(path, options, callback) {
+    page.render(path);
+    callback(true);
+  }
+};
+
+var ws = new WebSocket('ws://' + host + ':' + socket + '/');
+ws.onmessage = function(message) {
+  var args   = JSON.parse(message.data),
+      method = args.shift();
+
+  args.push(function(result) {
+    ws.send(JSON.stringify([result]));
+  });
+  Commands[method].apply(Commands, args);
+};
+
+page.viewportSize = {width: parseInt(width, 10), height: parseInt(height, 10)};
 page.open('http://' + host + ':' + port + '/');
 

data/lib/terminus/client/phantomjs.rb

@@ -1,20 +1,57 @@
 module Terminus
   module Client
-    
+
     class PhantomJS < Base
+      BROWSERS        = %w[chromium chromium-browser google-chrome xdg-open open]
+      DEBUG_PATH      = '/webkit/inspector/inspector.html?page=2'
       DEFAULT_COMMAND = ['/usr/bin/env', 'phantomjs']
+      DEFAULT_WIDTH   = 1024
+      DEFAULT_HEIGHT  = 768
       PHANTOM_CLIENT  = File.expand_path('../phantom.js', __FILE__)
-      
-      def browser_args(command)
-        args = (command || DEFAULT_COMMAND).dup
-        args + [PHANTOM_CLIENT, @address[2], @port.to_s]
+
+      def initialize(*args)
+        @debug_port = TCPServer.new(0).addr[1]
+        @debugger   = BROWSERS.map(&method(:detect_browser)).compact.first
+        super
       end
-      
+
+      def browser_args
+        command = @options[:command] || DEFAULT_COMMAND
+        width   = @options[:width]   || DEFAULT_WIDTH
+        height  = @options[:height]  || DEFAULT_HEIGHT
+
+        args = command.dup
+        args + ["--remote-debugger-port=#{@debug_port}", "--remote-debugger-autorun=yes",
+                PHANTOM_CLIENT, width.to_s, height.to_s,
+                @address[2], @port.to_s, @connector.port.to_s]
+      end
+
       def browser_selector
         {:name => 'PhantomJS'}
       end
+
+      def debugger
+        raise ArgumentError, 'Could not find launchable browser' unless @debugger
+        url = "http://#{@address[2]}:#{@debug_port}#{DEBUG_PATH}"
+        process = ChildProcess.build(@debugger, url)
+        process.start
+        puts "Launched WebKit remote debugger at #{url}"
+      end
+
+      def detect_browser(browser)
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          exe = File.join(path, browser)
+          return exe if File.executable?(exe)
+        end
+        nil
+      end
+
+      def save_screenshot(path, options = {})
+        message = Yajl::Encoder.encode(['save_screenshot', path, options])
+        @connector.request(message)
+      end
     end
-    
+
   end
 end
 

data/lib/terminus/connector.rb

@@ -1,9 +1,9 @@
 module Terminus
   module Connector
-    
+
     autoload :Server,        ROOT + '/terminus/connector/server'
     autoload :SocketHandler, ROOT + '/terminus/connector/socket_handler'
-    
+
   end
 end
 

data/lib/terminus/connector/server.rb

@@ -23,11 +23,11 @@
 
 module Terminus
   module Connector
-    
+
     class Server
       RECV_SIZE    = 1024
       BIND_TIMEOUT = 5
-      
+
       def initialize(browser, timeout = BIND_TIMEOUT)
         @browser = browser
         @skips   = 0
@@ -35,7 +35,7 @@ module Terminus
         @timeout = timeout
         reset
       end
-      
+
       def reset
         @closing = false
         @env     = nil
@@ -43,15 +43,15 @@ module Terminus
         @parser  = Http::Parser.new
         @socket  = nil
       end
-      
+
       def connected?
         not @socket.nil?
       end
-      
+
       def port
         @server.addr[1]
       end
-      
+
       def request(message)
         @browser.debug(:send, @browser.id, message)
         accept unless connected?
@@ -65,13 +65,13 @@ module Terminus
         reset
         nil
       end
-      
+
       def drain_socket
         @closing = true if @socket
       end
-      
+
     private
-      
+
       def start_server
         time = Time.now
         TCPServer.open(0)
@@ -83,7 +83,7 @@ module Terminus
           raise
         end
       end
-      
+
       def accept
         @skips.times { @server.accept.close }
         @socket = @server.accept
@@ -100,7 +100,7 @@ module Terminus
           @browser.debug(:accept, @browser.id, @handler.url)
         end
       end
-      
+
       def env
         @env ||= begin
           env = {'REQUEST_METHOD' => @parser.http_method}
@@ -113,11 +113,11 @@ module Terminus
           env
         end
       end
-      
+
       def receive
         @browser.debug(:receive, @browser.id)
         start = Time.now
-        
+
         until @handler.message?
           raise Errno::EWOULDBLOCK if (Time.now - start) >= @timeout
           IO.select([@socket], [], [], @timeout) or raise Errno::EWOULDBLOCK
@@ -128,7 +128,7 @@ module Terminus
         end
         @handler && @handler.next_message
       end
-      
+
       def close
         [server, socket].compact.each do |s|
           s.close_read
@@ -136,7 +136,7 @@ module Terminus
         end
       end
     end
-    
+
   end
 end
 

data/lib/terminus/connector/socket_handler.rb

@@ -23,50 +23,50 @@
 
 module Terminus
   module Connector
-    
+
     class SocketHandler
       attr_reader :env
-      
+
       def initialize(server, env)
         @server   = server
         @env      = env
         @parser   = Faye::WebSocket.parser(env).new(self)
         @messages = []
       end
-      
+
       def url
         "ws://#{env['HTTP_HOST']}/"
       end
-      
+
       def handshake_response
         @parser.handshake_response
       end
-      
+
       def <<(data)
         @parser.parse(data)
       end
-      
+
       def encode(message)
         @parser.frame(Faye::WebSocket.encode(message))
       end
-      
+
       def receive(message)
         @messages << message
       end
-      
+
       def message?
         @messages.any?
       end
-      
+
       def next_message
         @messages.shift
       end
-      
+
       def close(*args)
         @server.reset
       end
     end
-    
+
   end
 end
 

data/lib/terminus/controller.rb

@@ -1,23 +1,25 @@
 module Terminus
   class Controller
-    
+
     include Timeouts
-    
+
     def initialize
       @connected    = false
       @browsers     = {}
       @host_aliases = {}
+      @local_ports  = []
+      @visited      = Set.new
     end
-    
+
     def browser(id = nil)
       return @browser if id.nil?
       @browsers[id] ||= Browser.new(self, id)
     end
-    
+
     def browsers
       @browsers.values
     end
-    
+
     def browser=(params)
       ensure_connection
       return @browser = params if Browser === params
@@ -25,41 +27,46 @@ module Terminus
         @browsers.values.find { |b| b === params }
       end
     end
-    
+
     def cookies
       @cookies ||= CookieJar::Jar.new
     end
-    
+
     def drop_browser(browser)
       @browsers.delete(browser.id)
       @browser = nil if @browser == browser
     end
-    
+
     def ensure_browsers(n = 1)
       ensure_connection
       wait_with_timeout(:browsers) { @browsers.size >= n }
     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 register_local_port(port)
+      @local_ports << port
+      @host_aliases[Host.new(URI.parse("http://localhost:#{port}/"))] = Host.new(URI.parse("http://localhost:80/"))
+    end
+
     def return_to_dock
       @browsers.each { |id, b| b.return_to_dock }
     end
-    
+
     def rewrite_local(url, dock_host)
       uri = URI.parse(url)
       uri.host = '127.0.0.1' if uri.host == dock_host
       uri.path = '' if uri.path == '/'
-      
+
       # 1.8.7 does not have Hash#key, and 1.9.2 gives warnings for #index
       remote_host = @host_aliases.respond_to?(:key) ?
                     @host_aliases.key(Host.new(uri)) :
@@ -70,41 +77,66 @@ module Terminus
         uri.host   = remote_host.host
         uri.port   = remote_host.port
       end
-      uri.host = dock_host if dock_host and uri.host =~ LOCALHOST
+      uri.path = '/' if uri.path == ''
       uri
     end
-    
+
     def rewrite_remote(url, dock_host = nil)
+      protocol_relative = (url =~ /^\/\//)
+      url = "http:#{url}" if protocol_relative
+
       uri = URI.parse(url)
-      return uri unless URI::HTTP === uri and uri.host !~ LOCALHOST and uri.host != dock_host
+      return uri unless URI::HTTP === uri
+
+      if (uri.host =~ LOCALHOST or uri.host == dock_host)
+        if uri.port == 80
+          uri.port = @host_aliases.keys.find { |h| h.host =~ LOCALHOST }.port
+        end
+
+        if local_ports.include?(uri.port)
+          uri.host = dock_host
+          return uri
+        end
+      end
+
       server = boot(uri)
-      uri.scheme = 'http'
+      uri.scheme = protocol_relative ? nil : 'http'
       uri.host, uri.port = (dock_host || server.host), server.port
       uri
     rescue URI::InvalidURIError
       url
     end
-    
+
     def server_running?(server)
       return false unless server.port
-      uri = URI.parse("http://#{server.host}:#{server.port}/")
+      uri = URI.parse("http://#{server.host}:#{server.port}#{PING_PATH}")
       Net::HTTP.start(uri.host, uri.port) { |h| h.head(uri.path) }
       true
     rescue
       false
     end
-    
+
+    def visit_url(url)
+      @visited.add(url)
+    end
+
+    def visited?(url)
+      visited = @visited.member?(url)
+      @visited.delete(url)
+      visited
+    end
+
   private
-    
+
     def accept_ping(message)
       browser(message['id']).ping!(message)
     end
-    
+
     def accept_result(message)
       browser = @browsers[message['id']]
       browser.result!(message) if browser
     end
-    
+
     def boot(remote_uri)
       host = Host.new(remote_uri)
       @host_aliases[host] ||= begin
@@ -114,13 +146,17 @@ module Terminus
         Host.new(server)
       end
     end
-    
+
     def ensure_connection
       return if @connected
       messenger.connect { @connected = true }
       wait_with_timeout(:connection) { @connected }
     end
-    
+
+    def local_ports
+      [Terminus.port] + @local_ports + @host_aliases.values.map { |h| h.port }
+    end
+
   end
 end