wunderbar 0.13.0 → 0.14.0

data/README.md

@@ -156,6 +156,10 @@ output.  This is accomplished by providing one or more of the following:
       code
     end
  
+    _websocket do
+      code
+    end
+
 Arbitrary Ruby code can be placed in each.  Form parameters are made available
 as instance variables (e.g., `@name`).  Host environment (CGI, Rack, Sinatra)
 values are accessible as methods of the `_` object: for example `_.headers`
@@ -286,6 +290,37 @@ output stream, which provides access to other useful methods, for example:
         _.print 'foo'
         _.printf "Hello %s!\n", 'world'
 
+Methods provided to Wunderbar.websocket
+---
+
+WebSocket support requires `em-websocket` to be installed.
+
+A web socket is a bidrectional channel.  `_.send` or `_.push` can be used to
+send arbitrary strings.  More commonly, the JSON array methods described above
+can be all be used, the important difference is that the individual entries
+are sent individually and as they are produced.
+
+`_.recv` or `_.pop` can be used to receive arbitrary strings.  More commonly,
+`_.subscribe` is used to register a block that is used as a callback.
+
+`_.system` will run an aritrary command.  Lines of output are sent across the
+websocket as they are received as JSON encoded hashes with two values: `type`
+is one of `stdin`, `stdout` or `stderr`; and `line` which contains the line
+itself.
+
+Options to `_websocket` are provided as a hash:  
+
+   * `:port` will chose a port number, with the default being that an
+   available one is picked for you.
+   * `:sync` set to `false` will cause the WebSocket server to be run as a 
+   daemon process.  This defaults to `true` when run from the command line and
+   to `false` when run as CGI.
+   * `buffer_limit` will limit the amount of entries retained and sent to
+   new clients on open requests.  Default is `1`.  A value of zero will disable
+   buffering.  A value of `nil` will result in unlimited buffering.  Note:
+   buffering is effectively unlimited until the first client connects.
+
+
 Secure by default
 ---
 

data/lib/wunderbar/builder.rb

@@ -338,8 +338,10 @@ module Wunderbar
           result = {}
           args.each {|arg| result[arg.to_s] = object.send arg}
         else
-          result = object.map do |item|
-            args.inject({}) {|hash, arg| hash[arg.to_s] = item.send arg; hash}
+          result = []
+          result = @_target if name.empty? and @_target.respond_to? :<<
+          object.each do |item|
+            result << Hash[args.map {|arg| [arg.to_s, item.send(arg)]}]
           end
         end
       end

data/lib/wunderbar/environment.rb

@@ -54,6 +54,11 @@ if self.to_s == 'main'
       Wunderbar.text(*args, &block)
     end
 
+    def _websocket(*args, &block)
+      args.last[:sync]=args.last.fetch(:sync,true) if Hash === args.last
+      Wunderbar.websocket(*args, &block)
+    end
+
     def env
       ENV
     end

data/lib/wunderbar/server.rb

@@ -15,6 +15,7 @@ end
 port = ARGV.find {|arg| arg =~ /--port=(.*)/}
 if port and ARGV.delete(port)
   port = $1.to_i
+  ENV['SERVER_PORT'] = port.to_s
 
   # Evaluate optional data from the script (after __END__)
   eval Wunderbar.data if Object.const_defined? :DATA

data/lib/wunderbar/version.rb

@@ -1,7 +1,7 @@
 module Wunderbar
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 13
+    MINOR = 14
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/wunderbar/websocket.rb

@@ -6,54 +6,104 @@ require 'socket'
 begin
   require 'em-websocket'
 rescue LoadError
-  module EM
-    class Channel
-      def initialize
-        require 'em-websocket'
-      end
-    end
-  end
 end
 
 module Wunderbar
-  class Channel < EM::Channel
-    attr_reader :port
+  class Channel
+    attr_reader :port, :connected, :complete
+
+    def initialize(port, limit)
+      # verify that the port is available
+      TCPServer.new('0.0.0.0', port).close 
 
-    def initialize(port, limit=nil)
-      TCPSocket.new('localhost', port).close
-      raise ArgumentError.new "Socket #{port} is not available"
-    rescue Errno::ECONNREFUSED
       super()
       @port = port
+      @connected = @complete = false
+      @channel1 = EM::Channel.new
+      @channel2 = EM::Channel.new
       @memory = []
-      @memory_channel = subscribe do |msg| 
+      @memory_channel = @channel1.subscribe do |msg| 
         @memory << msg.chomp unless Symbol === msg
-        @memory.shift while limit and @memory.length > limit
+        @memory.shift while @connected and limit and @memory.length > limit
       end
       websocket.run
     end
 
     def websocket
-      @websocket ||= Thread.new do
-        EM::WebSocket.start(:host => '0.0.0.0', :port => @port) do |ws|
-          ws.onopen {@memory.each {|msg| ws.send msg }}
-      
-          sid = subscribe do |msg| 
-            if msg == :shutdown
-              ws.close_websocket
-            else
-              ws.send msg
+      return @websocket if @websocket
+      ready = false
+      @websocket = Thread.new do
+        EM.epoll
+        EM.run do
+          connection = EventMachine::WebSocket::Connection
+          EM.start_server('0.0.0.0', @port, connection, {}) do |ws|
+            ws.onopen do
+              @memory.each {|msg| ws.send msg }
+              @connected = true
+              ws.close_websocket if complete
             end
+        
+            sid = @channel1.subscribe do |msg| 
+              if msg == :shutdown
+                ws.close_websocket
+              else
+                ws.send msg
+              end
+            end
+        
+            ws.onmessage {|msg| @channel2.push msg}
+
+            ws.onclose {@channel1.unsubscribe sid}
           end
-      
-          ws.onclose {unsubscribe sid}
+          EM.add_timer(0.1) {ready = true}
+        end
+      end
+      sleep 0.2 until ready
+      @websocket
+    end
+
+    def subscribe(*args, &block)
+      @channel2.subscribe(*args, &block)
+    end
+
+    def unsubscribe(*args, &block)
+      @channel2.unsubscribe(*args, &block)
+    end
+
+    def push(*args)
+      @channel1.push(*args)
+    end
+
+    def send(*args)
+      @channel1.push(*args)
+    end
+
+    def pop(*args)
+      @channel2.pop(*args)
+    end
+
+    def recv(*args)
+      @channel2.pop(*args)
+    end
+
+    def _(*args, &block)
+      if block or args.length > 1 
+        begin
+          builder = Wunderbar::JsonBuilder.new(Struct.new(:params).new({}))
+          builder._! self
+          builder._(*args, &block)
+        rescue Exception => e
+          self << {:type=>'stderr', :line=>e.inspect}
         end
+      elsif args.length == 1
+        @channel1.push(args.first.to_json)
+      else
+        self
       end
     end
 
-    def _(msg=nil, &block)
-      return self if msg==nil 
-      push(msg.to_json)
+    def <<(value)
+      @channel1.push(value.to_json)
     end
 
     def system(command)
@@ -73,26 +123,39 @@ module Wunderbar
       end
     end
 
+    def complete=(value)
+      @channel1.push :shutdown if value
+      @complete = value
+    end
+
     def close
-      unsubscribe @memory_channel if @memory_channel
-      push :shutdown
-      sleep 1
+      @channel1.unsubscribe @memory_channel if @memory_channel
       EM::WebSocket.stop
       websocket.join    
     end
   end
 
   if defined? EventMachine::WebSocket
-    def self.websocket(port=nil, &block)
+    def self.websocket(opts={}, &block)
+      opts = {:port => opts} if Fixnum === opts
+      port = opts[:port]
+      buffer = opts.fetch(:buffer,1)
+
       if not port
         socket = TCPServer.new(0)
         port = Socket.unpack_sockaddr_in(socket.getsockname).first
         socket.close
       end
 
-      submit do
+      sock1 = nil
+
+      proc = Proc.new do
         begin
-          channel = Wunderbar::Channel.new(port)
+          channel = Wunderbar::Channel.new(port, buffer)
+          if sock1
+            sock1.send('x',0)
+            sock1.close
+          end
           channel.instance_eval &block
         rescue Exception => exception
           channel._ :type=>:stderr, :line=>exception.inspect
@@ -101,13 +164,23 @@ module Wunderbar
             channel._ :type=>:stderr, :line=>"  #{frame}"
           end
         ensure
-          channel.push :shutdown
-          sleep 5
-          channel.close if channel
+          if channel
+            channel.complete = true
+            sleep 5
+            sleep 60 unless channel.connected
+            channel.close
+          end
         end
       end
 
-      sleep 1
+      if opts[:sync]
+        instance_eval &proc
+      else
+        sock1, sock2 = UNIXSocket.pair
+        submit &proc
+        sleep 0.3 while sock2.recv(1) != 'x'
+        sock2.close
+      end
 
       port
     end

data/wunderbar.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wunderbar"
-  s.version = "0.13.0"
+  s.version = "0.14.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sam Ruby"]
-  s.date = "2012-04-28"
+  s.date = "2012-04-30"
   s.description = "    Wunderbar makes it easy to produce valid HTML5, wellformed XHTML, Unicode\n    (utf-8), consistently indented, readable applications.  This includes\n    output that conforms to the Polyglot specification and the emerging\n    results from the XML Error Recovery Community Group.\n"
   s.email = "rubys@intertwingly.net"
   s.files = ["wunderbar.gemspec", "README.md", "COPYING", "lib/wunderbar.rb", "lib/wunderbar", "lib/wunderbar/installation.rb", "lib/wunderbar/html-methods.rb", "lib/wunderbar/job-control.rb", "lib/wunderbar/server.rb", "lib/wunderbar/logger.rb", "lib/wunderbar/rack.rb", "lib/wunderbar/builder.rb", "lib/wunderbar/websocket.rb", "lib/wunderbar/sinatra.rb", "lib/wunderbar/environment.rb", "lib/wunderbar/rails.rb", "lib/wunderbar/cgi-methods.rb", "lib/wunderbar/cssproxy.rb", "lib/wunderbar/version.rb"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wunderbar
 version: !ruby/object:Gem::Version 
-  hash: 43
+  hash: 39
   prerelease: 
   segments: 
   - 0
-  - 13
+  - 14
   - 0
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors: 
 - Sam Ruby
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-28 00:00:00 Z
+date: 2012-04-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder