bcat 0.0.1 → 0.2.0

data/bcat.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'bcat'
-  s.version = '0.0.1'
-  s.date = '2010-06-19'
+  s.version = '0.2.0'
+  s.date = '2010-06-20'
 
   s.summary     = "browser cat"
   s.description =
@@ -17,9 +17,14 @@ Gem::Specification.new do |s|
     Rakefile
     bcat.gemspec
     bin/bcat
+    bin/bcat-encodehtml
+    bin/btee
     lib/bcat.rb
+    lib/bcat/browser.rb
     lib/bcat/kidgloves.rb
+    lib/bcat/reader.rb
     man/bcat.1.ronn
+    man/btee.1.ronn
   ]
   # = MANIFEST =
 

data/bin/bcat

@@ -1,53 +1,63 @@
 #!/usr/bin/env ruby
-#/ Usage: bcat [-h] [<file>]...
-#/ Read standard input, or one or more <file>s, and write to browser.
+#/ Usage: bcat [-h] [-t <title>] [<file>]...
+#/        btee <options> [<file>]...
+#/ Read standard input, or one or more <file>s, and write to browser. When
+#/ invoked as btee, also write input to standard output.
 #/
 #/ Options
 #/   -h, --html          input is html encoded
 #/   -t, --title=<text>  use <text> as the page title
+#/   -d, --debug         enable verbose debug logging on stderr
 require 'optparse'
-require 'bcat'
 
 options = {
   :html  => false,
   :title => Dir.pwd,
-  :Host  => 'localhost',
-  :Port  => 8091
+  :Host  => '127.0.0.1',
+  :Port  => 8091,
+  :debug => false
 }
 
+(class <<self;self;end).send(:define_method, :notice) { |message|
+  warn "#{File.basename($0)}: #{message}" if options[:debug] }
+
 ARGV.options do |argv|
   argv.on('-h', '--html')    { options[:html] = true }
+  argv.on('-a', '--app=v')   { |app|  ENV['BCAT_APPLICATION'] = app }
   argv.on('-t', '--title=v') { |text| options[:title] = text }
+  argv.on('-d', '--debug')   { options[:debug] = true }
   argv.on_tail('--help') { exec "grep ^#/ <#{__FILE__} | cut -c4-" }
   argv.parse!
 end
+ARGV.push '-' if ARGV.empty?
 
-fds =
-  ARGV.map do |file|
-    if file == '-'
-      $stdin
-    else
-      File.open(file, 'rb')
-    end
-  end
-fds = [$stdin] if fds.empty?
+require 'bcat'
+notice "loaded bcat v#{Bcat::VERSION}"
+
+include Bcat::Browser
+notice "env BCAT_APPLICATION=#{ENV['BCAT_APPLICATION'].inspect}"
+notice "env BCAT_COMMAND=#{browser_command.inspect}"
 
-command = ENV['BCAT_COMMAND'] || 'open $BCAT_ARGS "$BCAT_URL"'
+reader =
+  if File.basename($0) =~ /tee$/
+    Bcat::TeeReader.new(ARGV, $stdout)
+  else
+    Bcat::Reader.new(ARGV)
+  end
 
+notice "starting server"
 pid = nil
 begin
-  bcat = Bcat.new(fds, options)
+  bcat = Bcat.new(reader, options)
   bcat.serve! do |sock|
-    pid =
-      fork do
-        (fds + [sock, $stdin, $stdout]).uniq.each { |fd| fd.close }
-        ENV['BCAT_URL'] = "http://#{bcat[:Host]}:#{bcat[:Port]}/#{File.basename(Dir.pwd)}"
-        ENV['BCAT_ARGS'] = "-a '#{ENV['BCAT_APPLICATION']}'" if !ENV['BCAT_APPLICATION'].to_s.empty?
-        exec "/bin/sh -c \"#{command}\""
-      end
+    url = "http://#{bcat[:Host]}:#{bcat[:Port]}/#{File.basename(Dir.pwd)}"
+    pid = browser(url)
   end
 rescue Interrupt
+  notice "interrupt"
 end
 
 Process.wait(pid) if pid
-exit $?
+status = $?
+notice "open exited with #{status}"
+exit status

data/bin/bcat-encodehtml

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# Usage: bcat-encodehtml
+# Read text from stdin and write HTML encoded result to stdout.
+
+while char = $stdin.getc
+  case char
+  when ?<
+    $stdout.write('&lt;')
+  when ?&
+    $stdout.write('&amp;')
+  else
+    $stdout.putc(char)
+  end
+end

data/bin/btee

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+load File.expand_path('../bcat', __FILE__)

data/lib/bcat.rb

@@ -1,12 +1,14 @@
 require 'rack'
+require 'bcat/reader'
 require 'bcat/kidgloves'
+require 'bcat/browser'
 
 class Bcat
-  VERSION = '0.0.1'
+  VERSION = '0.2.0'
   include Rack::Utils
 
-  def initialize(fds=[$stdin], config={})
-    @fds = fds
+  def initialize(reader, config={})
+    @reader = reader
     @config = {:Host => '127.0.0.1', :Port => 8091}.merge(config)
   end
 
@@ -15,9 +17,29 @@ class Bcat
   end
 
   def call(env)
+    notice "#{env['REQUEST_METHOD']} #{env['PATH_INFO'].inspect}"
     [200, {"Content-Type" => "text/html;charset=utf-8"}, self]
   end
 
+  def each
+    yield "\n" * 1000
+    yield "<!DOCTYPE html>\n"
+    yield head
+    yield "<pre>" if !self[:html]
+
+    @reader.each do |buf|
+       if !self[:html]
+         buf = escape_html(buf)
+         buf.gsub!(/\n/, "<br>")
+       end
+       buf = escape_js(buf)
+       yield "<script>document.write('#{buf}');</script>"
+    end
+
+    yield "</pre>" if !self[:html]
+    yield foot
+  end
+
   def head
     ["<html>",
      "<head><title>#{self[:title] || 'bcat'}</title></head>",
@@ -34,35 +56,8 @@ class Bcat
     string
   end
 
-  def each
-    yield "\n" * 1000
-    yield "<!DOCTYPE html>\n"
-    yield head
-    yield "<pre>" if !self[:html]
-
-    begin
-      @fds.each do |fd|
-        begin
-          while buf = fd.readpartial(4096)
-            if !self[:html]
-              buf = escape_html(buf)
-              buf.gsub!(/\n/, "<br>")
-            end
-            buf = escape_js(buf)
-            yield "<script>document.write('#{buf}');</script>"
-          end
-        rescue EOFError
-        ensure
-          fd.close rescue nil
-        end
-      end
-    end
-
-    yield "</pre>" if !self[:html]
-    yield foot
-  end
-
   def close
+    notice "closing with interrupt"
     raise Interrupt
   end
 
@@ -77,4 +72,9 @@ class Bcat
   def serve!(&bk)
     Rack::Handler::KidGloves.run to_app, @config, &bk
   end
+
+  def notice(message)
+    return if !@config[:debug]
+    warn "#{File.basename($0)}: #{message}"
+  end
 end

data/lib/bcat/browser.rb

@@ -0,0 +1,24 @@
+class Bcat
+  module Browser
+    def browser(url, application=ENV['BCAT_APPLICATION'])
+      command = browser_command
+      fork do
+        [$stdin, $stdout].each { |fd| fd.close }
+        ENV['BCAT_ARGS'] = "-a '#{application}'" if !application.to_s.empty?
+        ENV['BCAT_URL'] = url
+        ENV['BCAT_COMMAND'] = command
+        exec "/bin/sh -c \"#{command.gsub(/"/, '\"')}\""
+      end
+    end
+
+    def browser_command
+      return ENV['BCAT_COMMAND'] if !ENV['BCAT_COMMAND'].to_s.empty?
+
+      case `uname`
+      when /Darwin/       ; 'open $BCAT_ARGS "$BCAT_URL"'
+      when /Linux/, /BSD/ ; 'xdg-open $BCAT_ARGS "$BCAT_URL"'
+      else                ; 'xdg-open "$BCAT_URL"'
+      end
+    end
+  end
+end

data/lib/bcat/reader.rb

@@ -0,0 +1,50 @@
+class Bcat
+  # ARGF style multi-file streaming interface. Input is read with IO#readpartial
+  # to avoid buffering.
+  class Reader
+    attr_reader :files
+    attr_reader :fds
+
+    def initialize(files=[])
+      @files = files
+      @fds =
+        files.map do |f|
+          if f == '-'
+            $stdin
+          else
+            File.open(f, 'rb')
+          end
+        end
+    end
+
+    def each
+      fds.each do |fd|
+        fd.sync = true
+        begin
+          while buf = fd.readpartial(4096)
+            yield buf
+          end
+        rescue EOFError
+        ensure
+          fd.close
+        end
+      end
+    end
+  end
+
+  # Like Reader but writes all input to an output IO object in addition to
+  # yielding to the block.
+  class TeeReader < Reader
+    def initialize(files=[], out=$stdout)
+      @out = out
+      super(files)
+    end
+
+    def each
+      super() do |chunk|
+        @out.write chunk
+        yield chunk
+      end
+    end
+  end
+end

data/man/bcat.1.ronn

@@ -3,13 +3,23 @@ bcat(1) -- browser cat
 
 ## SYNOPSIS
 
-`bcat` [-ht] [<file>...]<br>
+`bcat` [-htad] [<file>...]<br>
+`btee` [-htad] [<file>...]
 
 ## DESCRIPTION
 
-The `bcat` utility reads from standard input, or one or more <file>s, and writes
-output to a web browser progressively. A <file> may be '-', in which case
-standard input is concatenated at the position specified.
+The `bcat` utility reads from standard input, or one or more <file>s, and pipes
+output into a web browser. <file> may be '-', in which case standard input is
+concatenated at that position.
+
+When invoked as `btee`, all input is written immediately to standard output in
+addition to being piped into the browser.
+
+## OPTIONS
+
+  * `-t`, `--title`=<text>:
+    Use <text> as the page `<title>`. By default, the path to the current working
+    directory is used as the title.
 
   * `-h`, `--html`:
     Do not HTML encode input. By default, `bcat` assumes input is plain text
@@ -17,9 +27,14 @@ standard input is concatenated at the position specified.
     characters (`\n`) to `<br>` tags, and wraps output in a `<pre>` block. The
     `--html` option disables all of these conversions, causing the input text
     to be written directly as HTML.
-  * `-t`, `--title`=<text>:
-    Use <text> as the page `<title>`. By default, the path to the current working
-    directory is used as the title.
+
+  * `-a`, `--app`=`Safari`|`Google Chrome`|`Firefox`:
+    MacOS only. The name of the browser application. This can also be set using
+    the `BCAT_APPLICATION` environment variable.
+
+  * `-d`, `--debug`:
+    Turn on verbose debug logging to standard error. Include this output when
+    reporting defects if applicable.
 
 ## ENVIRONMENT
 
@@ -27,11 +42,11 @@ standard input is concatenated at the position specified.
   * `BCAT_COMMAND`=`xdg-open "$url"`:
     The command used to launch to the browser application.
 
-  * `BCAT_APPLICATION`=[`Safari | Google Chrome | Firefox`]:
-    MacOS X only. The name of the Application . This is given as the value of
-    the `-a` argument to open(1). When `BCAT_APPLICATION` is undefined, the
-    system default browser is used.
+  * `BCAT_APPLICATION`=[`Safari` | `Google Chrome` | `Firefox`]:
+    MacOS X only. The name of the browser application . This is given as the
+    value of the `-a` argument to open(1). When `BCAT_APPLICATION` is undefined,
+    the system default browser is used.
 
 ## SEE ALSO
 
-cat(1), open(1)
+cat(1), tee(1), open(1)

data/man/btee.1.ronn

@@ -0,0 +1,52 @@
+bcat(1) -- browser cat
+======================
+
+## SYNOPSIS
+
+`bcat` [-htad] [<file>...]<br>
+`btee` [-htad] [<file>...]
+
+## DESCRIPTION
+
+The `bcat` utility reads from standard input, or one or more <file>s, and pipes
+output into a web browser. <file> may be '-', in which case standard input is
+concatenated at that position.
+
+When invoked as `btee`, all input is written immediately to standard output in
+addition to being piped into the browser.
+
+## OPTIONS
+
+  * `-t`, `--title`=<text>:
+    Use <text> as the page `<title>`. By default, the path to the current working
+    directory is used as the title.
+
+  * `-h`, `--html`:
+    Do not HTML encode input. By default, `bcat` assumes input is plain text
+    and entity encodes any `<` or `&` characters, converts raw end-of-line
+    characters (`\n`) to `<br>` tags, and wraps output in a `<pre>` block. The
+    `--html` option disables all of these conversions, causing the input text
+    to be written directly as HTML.
+
+  * `-a`, `--app`=`Safari`|`Google Chrome`|`Firefox`:
+    MacOS only. The name of the browser application. This can also be set using
+    the `BCAT_APPLICATION` environment variable.
+
+  * `-d`, `--debug`:
+    Turn on verbose debug logging to standard error. Include this output when
+    reporting defects if applicable.
+
+## ENVIRONMENT
+
+  * `BCAT_COMMAND`=`open -a $BCAT_APPLICATION $url`:
+  * `BCAT_COMMAND`=`xdg-open "$url"`:
+    The command used to launch to the browser application.
+
+  * `BCAT_APPLICATION`=[`Safari` | `Google Chrome` | `Firefox`]:
+    MacOS X only. The name of the browser application . This is given as the
+    value of the `-a` argument to open(1). When `BCAT_APPLICATION` is undefined,
+    the system default browser is used.
+
+## SEE ALSO
+
+cat(1), tee(1), open(1)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bcat
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: false
   segments: 
   - 0
+  - 2
   - 0
-  - 1
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-19 00:00:00 -07:00
+date: 2010-06-20 00:00:00 -07:00
 default_executable: bcat
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,9 +45,14 @@ files:
 - Rakefile
 - bcat.gemspec
 - bin/bcat
+- bin/bcat-encodehtml
+- bin/btee
 - lib/bcat.rb
+- lib/bcat/browser.rb
 - lib/bcat/kidgloves.rb
+- lib/bcat/reader.rb
 - man/bcat.1.ronn
+- man/btee.1.ronn
 - COPYING
 has_rdoc: true
 homepage: http://github.com/rtomayko/bcat/