bcat 0.4.0 → 0.5.0

data/INSTALLING

@@ -1,4 +1,9 @@
-bcat is usually installed with rubygems:
+bcat is known to work under MacOS X, Linux, and FreeBSD (other UNIX-like
+environments with freedesktop.org integration should work fine too). Progressive
+output has been tested under Safari, Firefox, Chrome, and GNOME Epiphany.
+
+bcat is written in Ruby and requires a basic Ruby installation. Install bcat
+using the gem command:
 
     $ gem install bcat
 

data/README

@@ -3,37 +3,46 @@ bcat
     git clone git://github.com/rtomayko/bcat.git
     gem install bcat
 
-bcat is a pipe to browser utility. It reads from standard input and displays
-what it reads in a web browser:
+bcat is a pipe to browser utility for use at the shell and within editors like
+Vim or Emacs. It reads from standard input, or one or more files, and streams
+output to a browser window:
 
     $ echo "hi mom" |bcat
     $ echo "hi mom" |bcat -t 'Important Message'
+    $ echo "hi mom" |bcat -b chrome
 
-bcat assumes its input is plain text, but you can also pipe in HTML:
+Plain text is converted to simple preformatted HTML with rudimentary support for
+ANSI/VT100 escape sequences (color, background, bold, underline, etc.)
 
-    $ echo "<h1>hi mom</h1>" |bcat -h
-    $ echo "*hi mom*" |markdown |bcat -h
+You can also pipe HTML into bcat, in which case input is written through to the
+browser unmodified:
 
-Browser output is displayed progressively as it's read from standard input,
-making bcat especially useful with build tools and commands like tail(1) that
-generate output over longer periods of time:
+    $ echo "<h1>hi mom</h1>" |bcat
+    $ echo "*hi mom*" |markdown |bcat
+
+Output is displayed progressively as it's being read, making bcat especially
+useful with build tools or even commands like tail(1) that generate output over
+longer periods of time:
 
     $ make all  |bcat
     $ rake test |bcat
     $ tail -f /var/log/syslog |bcat
     $ (while printf .; do sleep 1; done) |bcat
 
-See the bcat(1) manual for detailed command usage.
-
-bcat is known to work under MacOS X, Linux, and FreeBSD (other UNIX-like
-environments with freedesktop.org integration should work fine too). Progressive
-output has been tested under Safari, Firefox, Chrome, and GNOME Epiphany.
-
-See the INSTALLING, COPYING, and CONTRIBUTING files for information on those
-things.
+See the bcat(1) EXAMPLES section for more on using bcat from the shell or within
+editors like Vim:
+  <http://rtomayko.github.com/bcat/bcat.1.html#EXAMPLES>
 
-bcat was inspired by the HTML output capabilities included in TextMate
-and a desire to have those capabilities from the shell and within editors
-like Vim.
+bcat was inspired by TextMate's HTML output capabilities and a desire to have
+them at the shell and also within editors like Vim or Emacs. See:
   <http://manual.macromates.com/en/commands#html_output>
   <http://blog.macromates.com/2005/html-output-for-commands/>
+
+Only a small portion of TextMate's HTML output features are currently supported,
+although more will be added in the future (like hyperlinking file:line
+references and injecting CSS/JavaScript).
+
+See the INSTALLING, COPYING, and CONTRIBUTING files for more information on
+those things.
+
+Copyright (c) 2010 by Ryan Tomayko <http://tomayko.com/about>

data/Rakefile

@@ -34,7 +34,30 @@ desc 'Build the manual'
 task :man do
   ENV['RONN_MANUAL']  = "Bcat #{source_version}"
   ENV['RONN_ORGANIZATION'] = "Ryan Tomayko"
-  sh "ronn -w -r5 man/*.ronn"
+  sh "ronn -stoc -w -r5 man/*.ronn"
+end
+
+desc 'Publish to github pages'
+task :pages => :man do
+  puts '----------------------------------------------'
+  puts 'Rebuilding pages ...'
+  verbose(false) {
+    rm_rf 'pages'
+    push_url = `git remote show origin`.grep(/Push.*URL/).first[/git@.*/]
+    sh "
+      set -e
+      git fetch -q origin
+      rev=$(git rev-parse origin/gh-pages)
+      git clone -q -b gh-pages . pages
+      cd pages
+      git reset --hard $rev
+      rm -f *.html
+      cp -rp ../man/*.html ../man/index.* ./
+      git add -u *.html index.*
+      git commit -m 'rebuild manual'
+      git push #{push_url} gh-pages
+    ", :verbose => false
+  }
 end
 
 file 'bcat.gemspec' => FileList['{lib,test,bin}/**','Rakefile'] do |f|

data/bcat.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name = 'bcat'
-  s.version = '0.4.0'
-  s.date = '2010-06-23'
+  s.version = '0.5.0'
+  s.date = '2010-06-28'
 
-  s.summary     = "browser cat"
-  s.description =
+  s.description = "pipe to browser utility"
+  s.summary =
     "Concatenate input from standard input, or one or more files, " +
     "and write progressive output to a browser."
 
@@ -26,11 +26,15 @@ Gem::Specification.new do |s|
     lib/bcat/ansi.rb
     lib/bcat/browser.rb
     lib/bcat/html.rb
-    lib/bcat/kidgloves.rb
     lib/bcat/reader.rb
+    lib/bcat/server.rb
+    man/a2h.1
     man/a2h.1.ronn
+    man/bcat.1
     man/bcat.1.ronn
+    man/btee.1
     man/btee.1.ronn
+    man/index.html
     test/test_bcat_a2h.rb
     test/test_bcat_ansi.rb
     test/test_bcat_browser.rb
@@ -47,7 +51,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = %w[COPYING]
 
   s.has_rdoc = true
-  s.homepage = "http://github.com/rtomayko/bcat/"
+  s.homepage = "http://rtomayko.github.com/bcat/"
   s.rdoc_options = ["--line-numbers", "--inline-source"]
   s.require_paths = %w[lib]
 end

data/bin/bcat

@@ -20,7 +20,7 @@ require 'optparse'
 
 options = {
   :Host    => '127.0.0.1',
-  :Port    => 8091,
+  :Port    => 0,
   :format  => nil,
   :title   => Dir.pwd,
   :browser => (ENV['BCAT_BROWSER'].to_s.size > 0 ? ENV['BCAT_BROWSER'] : 'default'),
@@ -39,6 +39,8 @@ ARGV.options do |argv|
   argv.on('-T', '--title=v')   { |text| options[:title] = text }
   argv.on('-a', '--ansi')      { options[:ansi] = true }
   argv.on('-d', '--debug')     { options[:debug] = true }
+  argv.on('--host=v')          { |addr| options[:Host] = addr }
+  argv.on('--port=v')          { |port| options[:Port] = port.to_i }
   argv.on_tail('--help')       { exec "grep ^#/ <#{__FILE__} | cut -c4-" }
   argv.parse!
 end
@@ -56,7 +58,8 @@ pid = nil
 begin
   bcat = Bcat.new(ARGV, options)
   bcat.serve! do |sock|
-    url = "http://#{bcat[:Host]}:#{bcat[:Port]}/#{File.basename(Dir.pwd)}"
+    port = sock.addr[1]
+    url = "http://#{bcat[:Host]}:#{port}/#{File.basename(Dir.pwd)}"
     pid = browser.open(url)
   end
 rescue Interrupt

data/lib/bcat.rb

@@ -2,11 +2,11 @@ require 'rack'
 require 'bcat/reader'
 require 'bcat/ansi'
 require 'bcat/html'
-require 'bcat/kidgloves'
+require 'bcat/server'
 require 'bcat/browser'
 
 class Bcat
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
   include Rack::Utils
 
   attr_reader :format
@@ -14,12 +14,7 @@ class Bcat
   def initialize(files=[], config={})
     @config = {:Host => '127.0.0.1', :Port => 8091}.merge(config)
     @reader = Bcat::Reader.new(files)
-    @format = @config[:format] || @reader.sniff
-
-    @filter = @reader
-    @filter = TeeFilter.new(@filter) if @config[:tee]
-    @filter = TextFilter.new(@filter) if @format == 'text'
-    @filter = ANSI.new(@filter) if @format == 'text' || @config[:ansi]
+    @format = @config[:format]
   end
 
   def [](key)
@@ -35,7 +30,7 @@ class Bcat
   end
 
   def serve!(&bk)
-    Rack::Handler::KidGloves.run to_app, @config, &bk
+    Bcat::Server.run to_app, @config, &bk
   end
 
   def call(env)
@@ -43,7 +38,18 @@ class Bcat
     [200, {"Content-Type" => "text/html;charset=utf-8"}, self]
   end
 
+  def assemble
+    @format = @reader.sniff if @format.nil?
+
+    @filter = @reader
+    @filter = TeeFilter.new(@filter) if @config[:tee]
+    @filter = TextFilter.new(@filter) if @format == 'text'
+    @filter = ANSI.new(@filter) if @format == 'text' || @config[:ansi]
+  end
+
   def each
+    assemble
+
     head_parser = Bcat::HeadParser.new
 
     @filter.each do |buf|

data/lib/bcat/ansi.rb

@@ -144,7 +144,8 @@ class Bcat
         [/\A\x08+/, lambda { |m| '' }],
 
         # ansi escape sequences that mess with the display
-        [/\A\x1b\[((?:\d{1,3};?)+)m/, lambda { |m|
+        [/\A\x1b\[((?:\d{1,3};?)+|)m/, lambda { |m|
+          m = '0' if m.strip.empty?
           m.chomp(';').split(';').
           each { |code| yield :display, code.to_i };
           '' }],

data/lib/bcat/server.rb

@@ -0,0 +1,113 @@
+require 'socket'
+require 'stringio'
+require 'rack/utils'
+
+class Bcat
+  # Simple Rack handler based largely on Scott Chacon's kidgloves library:
+  # http://github.com/schacon/kidgloves
+  class Server
+    attr_accessor :app
+
+    def self.run(app, options={}, &block)
+      new(app, options).listen(&block)
+    end
+
+    def initialize(app, options={})
+      @app = app
+      @host = options[:Host] || '0.0.0.0'
+      @port = options[:Port] || 8089
+    end
+
+    def bind(host, port)
+      TCPServer.new(host, port)
+    rescue Errno::EADDRINUSE
+      port += 1
+      retry
+    end
+
+    def listen
+      server = TCPServer.new(@host, @port)
+
+      yield server if block_given?
+
+      loop do
+        socket = server.accept
+        socket.sync = true
+        log "#{socket.peeraddr[2]} (#{socket.peeraddr[3]})"
+        begin
+          req = {}
+
+          # parse the request line
+          request = socket.gets
+          method, path, version = request.split(" ", 3)
+          req["REQUEST_METHOD"] = method
+          info, query = path.split("?")
+          req["PATH_INFO"] = info
+          req["QUERY_STRING"] = query
+
+          # parse the headers
+          while (line = socket.gets)
+            line.strip!
+            break if line.size == 0
+            key, val = line.split(": ")
+            key = key.upcase.gsub('-', '_')
+            key = "HTTP_#{key}" if !%w[CONTENT_TYPE CONTENT_LENGTH].include?(key)
+            req[key] = val
+          end
+
+          # parse the body
+          body =
+            if len = req['CONTENT_LENGTH']
+              socket.read(len.to_i)
+            else
+              ''
+            end
+
+          # process the request
+          process_request(req, body, socket)
+        ensure
+          socket.close if not socket.closed?
+        end
+      end
+    end
+
+    def log(message)
+      # $stderr.puts message
+    end
+
+    def status_message(code)
+      Rack::Utils::HTTP_STATUS_CODES[code]
+    end
+
+    def process_request(request, input_body, socket)
+      env = {}.replace(request)
+      env["HTTP_VERSION"] ||= env["SERVER_PROTOCOL"]
+      env["QUERY_STRING"] ||= ""
+      env["SCRIPT_NAME"] = ""
+
+      rack_input = StringIO.new(input_body)
+      rack_input.set_encoding(Encoding::BINARY) if rack_input.respond_to?(:set_encoding)
+
+      env.update(
+        "rack.version"      => [1,0],
+        "rack.input"        => rack_input,
+        "rack.errors"       => $stderr,
+        "rack.multithread"  => true,
+        "rack.multiprocess" => true,
+        "rack.run_once"     => false,
+        "rack.url_scheme"   => ["yes", "on", "1"].include?(env["HTTPS"]) ? "https" : "http"
+      )
+      status, headers, body = app.call(env)
+      begin
+        socket.write("HTTP/1.1 #{status} #{status_message(status)}\r\n")
+        headers.each do |k, vs|
+          vs.split("\n").each { |v| socket.write("#{k}: #{v}\r\n")}
+        end
+        socket.write("\r\n")
+        body.each { |s| socket.write(s) }
+      ensure
+        body.close if body.respond_to? :close
+      end
+    end
+  end
+end

data/man/a2h.1

@@ -0,0 +1,55 @@
+.\" generated with Ronn/v0.6.42
+.\" http://github.com/rtomayko/ronn/tree/0.6.6-36-gb67d494
+.
+.TH "A2H" "1" "June 2010" "Ryan Tomayko" "Bcat 0.4.0"
+.
+.SH "NAME"
+\fBa2h\fR \- convert ANSI/VT100 escape sequences to HTML
+.
+.SH "SYNOPSIS"
+\fBa2h\fR [\-] [\fIfile\fR\.\.\.]
+.
+.SH "DESCRIPTION"
+The \fBa2h\fR utility reads from standard input, or one or more \fIfile\fRs, and converts ANSI/VT100 escape sequences to inline HTML\.
+.
+.SH "ESCAPE SEQUENCES"
+The following escape sequences are supported:
+.
+.TP
+\fB<ESC>[0m\fR
+Resets all attributes / closes all HTML tags\.
+.
+.TP
+\fB<ESC>[1m\fR=\fB<b>\fR
+Bold\.
+.
+.TP
+\fB<ESC>[4m\fR=\fB<u>\fR
+Underscore\.
+.
+.TP
+\fB<ESC>[5m\fR=\fB<blink>\fR
+Blink\. Really\.
+.
+.TP
+\fB<ESC>[8m\fR=\fB<span style=\'display:none\'>\fR
+Hidden\.
+.
+.TP
+\fB<ESC>[30\-37m\fR=\fB<span style=\'color:\fR\fIcolor\fR\fB>\fR
+Foreground color\.
+.
+.TP
+\fB<ESC>[40\-47m\fR=\fB<span style=\'background\-color:\fR\fIcolor\fR\fB>\fR
+Background color\.
+.
+.TP
+\fB<ESC>[90\-97m\fR=\fB<span style=\'color:\fR\fIcolor\fR\fB>\fR
+Light foreground colors\.
+.
+.TP
+\fB<ESC>[100\-107m\fR=\fB<span style=\'background\-color:\fR\fIcolor\fR\fB>\fR
+Light background color\.
+.
+.SH "SEE ALSO"
+ansi2html\.sh \fIhttp://code\.google\.com/p/wrdese/source/browse/trunk/b/ansi2html\.sh?r=5\fR, HTML::FromANSI \fIhttp://cpansearch\.perl\.org/src/NUFFIN/HTML\-FromANSI\-2\.03/lib/HTML/FromANSI\.pm\fR

data/man/bcat.1

@@ -0,0 +1,225 @@
+.\" generated with Ronn/v0.6.42
+.\" http://github.com/rtomayko/ronn/tree/0.6.6-36-gb67d494
+.
+.TH "BCAT" "1" "June 2010" "Ryan Tomayko" "Bcat 0.4.0"
+.
+.SH "NAME"
+\fBbcat\fR \- browser cat
+.
+.SH "SYNOPSIS"
+\fBbcat\fR [\-htad] [\fIfile\fR\.\.\.]
+.
+.br
+\fBbtee\fR [\-htad] [\fIfile\fR\.\.\.]
+.
+.SH "DESCRIPTION"
+The \fBbcat\fR utility reads from standard input, or one or more \fIfile\fRs, and pipes output into a web browser\. \fIfile\fR may be \'\-\', in which case standard input is concatenated at that position\.
+.
+.P
+When invoked as \fBbtee\fR, all input is written immediately to standard output in addition to being piped into the browser\.
+.
+.SH "OPTIONS"
+\fBbcat\fR opens a simple, undecorated page with the system default web browser and immediately begins streaming input\. The following options control the browser display:
+.
+.TP
+\fB\-b\fR, \fB\-\-browser\fR=default|firefox|safari|chrome|opera|\fIother\fR
+The name of the browser application\. Defaults to the value of the \fBBCAT_BROWSER\fR environment variable, or the system default browser when no \fBBCAT_BROWSER\fR is defined\.
+.
+.TP
+\fB\-T\fR, \fB\-\-title\fR=\fItext\fR
+Use \fItext\fR as the page \fB<title>\fR\. By default, the path to the current working directory is used as the title\.
+.
+.TP
+\fB\-a\fR, \fB\-\-ansi\fR
+Turns on VT100/ANSI escape sequence conversion\. This causes all input to be piped through a2h(1), replacing ANSI escape sequences with HTML for things like bold, underline, and colors\. On by default when the input is text; use the \fB\-a\fR option to turn it on when the input is HTML\.
+.
+.P
+By default, \fBbcat\fR attempts to detect whether input is HTML or plain text using a simple heuristic, but you can force input to be treated as one or the other with these options:
+.
+.TP
+\fB\-t\fR, \fB\-\-text\fR
+The input is non\-HTML encoded text\. All bare \fB<\fR and \fB&\fR characters are entity encoded, end\-of\-line characters are converted to \fB<br>\fR, and the entire output is wrapped in a \fB<pre>\fR\.
+.
+.TP
+\fB\-h\fR, \fB\-\-html\fR
+The input is already HTML encoded\. Under this mode, bcat passes input through to the browser mostly unmodified\. The input may be a full HTML document, or it may be an HTML fragment\. \fBbcat\fR outputs \fB<html>\fR, \fB<head>\fR, and \fB<body>\fR elements even if they are not included in the input\.
+.
+.P
+Miscellaneous options:
+.
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Turn on verbose debug logging to standard error\. Include this output when reporting defects if applicable\.
+.
+.SH "ENVIRONMENT"
+.
+.TP
+\fBBCAT_BROWSER\fR=default|firefox|safari|chrome|opera|\fIother\fR
+The name of the browser to use by default\. \fBbcat\fR maps this to an actual browser command based on the current platform\. The special value \"default\" maps to the system default browser\.
+.
+.TP
+\fBBCAT_COMMAND\fR=\fIcommand\fR
+The entire browser command line (to be executed by \fB/bin/sh\fR)\. This overrides the \fBBCAT_BROWSER\fR environment variable and makes the \fB\-\-browser\fR (\fB\-b\fR) option a no\-op\. This should only be necessary when running a browser unknown to bcat or in order to pass special arguments\.
+.
+.SH "EXAMPLES"
+.
+.SS "Basic Shell Examples"
+With build tools:
+.
+.IP "" 4
+.
+.nf
+
+make test |bcat
+rake test |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+As a clipboard viewer:
+.
+.IP "" 4
+.
+.nf
+
+pbpaste |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+For previewing HTML:
+.
+.IP "" 4
+.
+.nf
+
+markdown README\.md |bcat
+redcloth README\.textile |bcat
+erb \-T \- template\.erb |bcat
+mustache < template\.mustache |bcat
+pygmentize \-Ofull,style=colorful \-f html main\.c |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+As a simple man pager:
+.
+.IP "" 4
+.
+.nf
+
+export MANPAGER=\'col \-b |bcat\'
+man grep
+.
+.fi
+.
+.IP "" 0
+.
+.P
+With git, selectively:
+.
+.IP "" 4
+.
+.nf
+
+git log \-p \-\-color |bcat
+git diff \-\-color HEAD@{5d} HEAD |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+With git, as the default PAGER:
+.
+.IP "" 4
+.
+.nf
+
+export GIT_PAGER=bcat
+
+git log \-p
+git diff HEAD@{5d} HEAD
+.
+.fi
+.
+.IP "" 0
+.
+.P
+As a log viewer:
+.
+.IP "" 4
+.
+.nf
+
+tail \-n 1000 \-f log/development\.log |bcat
+tail \-f $RAILS_ROOT/log/development\.log
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Or, a remote log viewer:
+.
+.IP "" 4
+.
+.nf
+
+ssh example\.org \'tail \-n 1000 \-f /var/log/syslog\' |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Vim and vi Examples"
+Preview current buffer as HTML:
+.
+.IP "" 4
+.
+.nf
+
+:!markdown % |bcat
+:!ronn \-5 \-\-pipe % |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Create keymappings:
+.
+.IP "" 4
+.
+.nf
+
+map ,pm :!markdown % |bcat
+map ,pp :!pygmentize \-Ofull,style=colorful \-f html % |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Use with \fBmakeprg\fR:
+.
+.IP "" 4
+.
+.nf
+
+set makeprg=make\e \e\e\e|bcat
+set makeprg=markdown\e %\e \e\e\e|bcat
+set makeprg=testrb\e %\e \e\e\e|bcat
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+cat(1), tee(1), open(1)