aslakhellesoy-bcat 0.6.0.1

data/CONTRIBUTING

@@ -0,0 +1,13 @@
+Please submit pull requests to:
+
+<https://github.com/rtomayko/bcat/pulls>
+
+For information on forking repositories and sending pull requests:
+
+<http://help.github.com/pull-requests/>
+
+If you prefer sending text patches, please use git-format-patch(1) to generate
+them so I can attribute you properly. Text patches can be submitted to the issue
+tracker:
+
+<https://github.com/rtomayko/bcat/issues>

data/COPYING

@@ -0,0 +1,19 @@
+bcat
+Copyright (c) 2010 Ryan Tomayko <http://tomayko.com/about>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/INSTALLING

@@ -0,0 +1,10 @@
+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
+
+bcat depends on the rack package.

data/README

@@ -0,0 +1,48 @@
+bcat
+    http://github.com/rtomayko/bcat
+    git clone git://github.com/rtomayko/bcat.git
+    gem install bcat
+
+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
+
+Plain text is converted to simple preformatted HTML with rudimentary support for
+ANSI/VT100 escape sequences (color, background, bold, underline, etc.)
+
+You can also pipe HTML into bcat, in which case input is written through to the
+browser unmodified:
+
+    $ 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) 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 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/RELEASING

@@ -0,0 +1,10 @@
+RELEASING
+
+1. Change Bcat::VERSION in lib/bcat.rb
+2. rake bcat.gemspec
+3. rake package
+4. git add lib/bcat.rb bcat.gemspec
+5. git commit -m "0.5.3 release"
+6. git tag v0.5.3
+7. git push origin master v0.5.3
+8. gem push bcat-0.5.3.gem

data/Rakefile

@@ -0,0 +1,83 @@
+require 'date'
+task :default => :test
+
+ROOTDIR = File.expand_path('..', __FILE__).sub(/#{Dir.pwd}(?=\/)/, '.')
+LIBDIR  = "#{ROOTDIR}/lib"
+BINDIR  = "#{ROOTDIR}/bin"
+
+task :environment do
+  $:.unshift ROOTDIR if !$:.include?(ROOTDIR)
+  $:.unshift LIBDIR  if !$:.include?(LIBDIR)
+  ENV['RUBYLIB'] = $LOAD_PATH.join(':')
+  ENV['PATH'] = "#{BINDIR}:#{ENV['PATH']}"
+end
+
+desc 'Run tests'
+task :test => :environment do
+  $LOAD_PATH.unshift "#{ROOTDIR}/test"
+  Dir['test/test_*.rb'].each { |f| require(f) }
+end
+
+def source_version
+  @source_version ||= `ruby -Ilib -rbcat -e 'puts Bcat::VERSION'`.chomp
+end
+
+require 'rubygems'
+$spec = eval(File.read('bcat.gemspec'))
+
+desc "Build gem package"
+task :package => 'bcat.gemspec' do
+  sh "gem build bcat.gemspec"
+end
+
+desc 'Build the manual'
+task :man do
+  ENV['RONN_MANUAL']  = "Bcat #{source_version}"
+  ENV['RONN_ORGANIZATION'] = "Ryan Tomayko"
+  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|
+  # read spec file and split out manifest section
+  spec = File.read(f.name)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+  # replace version and date
+  head.sub!(/\.version = '.*'/, ".version = '#{source_version}'")
+  head.sub!(/\.date = '.*'/, ".date = '#{Date.today.to_s}'")
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject{ |file| file =~ /^\./ }.
+    reject { |file| file =~ /^doc/ }.
+    map{ |file| "    #{file}" }.
+    join("\n")
+  # piece file back together and write...
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head,manifest,tail].join("  # = MANIFEST =\n")
+  File.open(f.name, 'w') { |io| io.write(spec) }
+  puts "updated #{f.name}"
+end

data/bcat.gemspec

@@ -0,0 +1,60 @@
+Gem::Specification.new do |s|
+  s.name = 'aslakhellesoy-bcat'
+  s.version = '0.6.0.1'
+  s.date = '2011-05-22'
+
+  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."
+
+  s.authors     = ["Ryan Tomayko"]
+  s.email       = "rtomayko@gmail.com"
+
+  # = MANIFEST =
+  s.files = %w[
+    CONTRIBUTING
+    COPYING
+    INSTALLING
+    README
+    RELEASING
+    Rakefile
+    bcat.gemspec
+    bin/a2h
+    bin/bcat
+    bin/btee
+    contrib/bman
+    lib/bcat.rb
+    lib/bcat/ansi.rb
+    lib/bcat/browser.rb
+    lib/bcat/html.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/contest.rb
+    test/test_bcat_a2h.rb
+    test/test_bcat_ansi.rb
+    test/test_bcat_browser.rb
+    test/test_bcat_head_parser.rb
+  ]
+  # = MANIFEST =
+
+  s.default_executable = 'bcat'
+  s.executables = ['a2h', 'bcat', 'btee']
+
+  s.test_files = s.files.select {|path| path =~ /^test\/.*_test.rb/}
+  s.add_dependency 'rack', '>= 1.2.2'
+
+  s.extra_rdoc_files = %w[COPYING]
+
+  s.has_rdoc = true
+  s.homepage = "http://rtomayko.github.com/bcat/"
+  s.rdoc_options = ["--line-numbers", "--inline-source"]
+  s.require_paths = %w[lib]
+end

data/bin/a2h

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# Usage: a2h [-] [<file>...]
+# Convert ANSI/VT100 escape sequences to HTML.
+require 'bcat/ansi'
+require 'bcat/reader'
+
+$stdin.sync = true
+$stdout.sync = true
+
+ARGV.push '-' if ARGV.empty?
+
+reader = Bcat::Reader.new(false, ARGV.to_a)
+reader.open
+filter = Bcat::ANSI.new(reader)
+filter.each { |text| $stdout.write(text) }

data/bin/bcat

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+#/ Usage: bcat [-htp] [-a] [-b <browser>] [-T <title>] [<file>]...
+#/        bcat [-htp] [-a] [-b <browser>] [-T <title>] -c command...
+#/        btee <options> [<file>]...
+#/ Pipe to browser utility. Read standard input, possibly one or more <file>s,
+#/ and write concatenated / formatted output to browser. When invoked as btee,
+#/ also write all input back to standard output.
+#/
+#/ Display options:
+#/   -b, --browser=<browser>    open <browser> instead of system default browser
+#/   -T, --title=<text>         use <text> as the browser title
+#/   -a, --ansi                 convert ANSI (color) escape sequences to HTML
+#/
+#/ Input format (auto detected by default):
+#/   -h, --html                 input is already HTML encoded, doc or fragment
+#/   -t, --text                 input is unencoded text
+#/
+#/ Misc options:
+#/   -c, --command              read the standard output of command
+#/   -p, --persist              serve until interrupted, allowing reload
+#/   -d, --debug                enable verbose debug logging on stderr
+require 'optparse'
+
+options = {
+  :Host    => '127.0.0.1',
+  :Port    => 0,
+  :format  => nil,
+  :title   => nil,
+  :browser => (ENV['BCAT_BROWSER'].to_s.size > 0 ? ENV['BCAT_BROWSER'] : 'default'),
+  :ansi    => false,
+  :persist => false,
+  :command => false,
+  :debug   => false,
+  :tee     => !!($0 =~ /tee$/)
+}
+
+(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[:format] = 'html' }
+  argv.on('-t', '--text')      { options[:format] = 'text' }
+  argv.on('-b', '--browser=v') { |app|  options[:browser] = app }
+  argv.on('-T', '--title=v')   { |text| options[:title] = text }
+  argv.on('-a', '--ansi')      { options[:ansi] = true }
+  argv.on('-p', '--persist')   { options[:persist] = true }
+  argv.on('-c', '--command')   { options[:command] = 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
+ARGV.push '-' if ARGV.empty?
+
+require 'bcat'
+notice "loaded bcat v#{Bcat::VERSION}"
+
+browser = Bcat::Browser.new(options[:browser])
+notice "env BCAT_BROWSER=#{options[:browser].inspect}"
+notice "env BCAT_COMMAND='#{browser.command}'"
+
+notice "starting server"
+pid = nil
+begin
+  bcat = Bcat.new(ARGV, options)
+  bcat.serve! do |sock|
+    port = sock.addr[1]
+    url = "http://#{bcat[:Host]}:#{port}/#{File.basename(Dir.pwd)}"
+    pid = browser.open(url)
+  end
+rescue Interrupt
+  notice "interrupt"
+end
+
+Process.wait(pid) if pid
+status = $?.exitstatus
+notice "browser [pid: #{pid}] exited with #{status}"
+exit status

data/bin/btee

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

data/contrib/bman

@@ -0,0 +1,26 @@
+#!/bin/sh
+# Usage: bman <man-args>
+# Open manual page in browser with bcat.
+#
+# Original zsh version by Nick Stenning <http://github.com/nickstenning>
+# http://github.com/rtomayko/bcat/issues#issue/8
+#
+# Ported to POSIX shell by Ryan Tomayko <http://github.com/rtomayko>
+set -e
+
+# we use normal bold and underline
+BOLD="\033[1m"
+EM="\033[3m"
+RESET="\033[0m"
+
+# pass argv directly over to man
+man "$@" |
+
+# replace ^H based bold and underline with ansi equivelants
+sed "
+    s/_\(.\)/"$(echo "$EM")"\1"$(echo "$RESET")"/g
+    s/\(.\)\1/"$(echo "$BOLD")"\1"$(echo "$RESET")"/g
+"        |
+
+# pipe it into bcat
+bcat

data/lib/bcat.rb

@@ -0,0 +1,118 @@
+require 'rack'
+require 'bcat/reader'
+require 'bcat/ansi'
+require 'bcat/html'
+require 'bcat/server'
+require 'bcat/browser'
+
+class Bcat
+  VERSION = '0.6.0.1'
+  include Rack::Utils
+
+  attr_reader :format
+
+  def initialize(args=[], config={})
+    @config = {:Host => '127.0.0.1', :Port => 8091}.merge(config)
+    @reader = Bcat::Reader.new(@config[:command], args)
+    @format = @config[:format]
+  end
+
+  def [](key)
+    @config[key]
+  end
+
+  def to_app
+    app = self
+    Rack::Builder.new do
+      use Rack::Chunked
+      run app
+    end
+  end
+
+  def serve!(&bk)
+    Bcat::Server.run to_app, @config, &bk
+  end
+
+  def call(env)
+    notice "#{env['REQUEST_METHOD']} #{env['PATH_INFO'].inspect}"
+    [200, {"Content-Type" => "text/html;charset=utf-8"}, self]
+  end
+
+  def assemble
+    @reader.open
+
+    @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|
+      if head_parser.nil?
+        yield buf
+      elsif head_parser.feed(buf)
+        yield content_for_head(inject=head_parser.head)
+        yield "\n"
+        yield head_parser.body
+        head_parser = nil
+      end
+    end
+
+    if head_parser
+      yield content_for_head(inject=head_parser.head) +
+            "\n" +
+            head_parser.body
+    end
+
+    yield foot
+  rescue Errno::EINVAL
+    # socket was closed
+    notice "browser client went away"
+  rescue => boom
+    notice "boom: #{boom.class}: #{boom.to_s}"
+    raise
+  end
+
+  def content_for_head(inject='')
+    [
+      "\n" * 1000,
+      "<!DOCTYPE html>",
+      "<html>",
+      "<head>",
+      "<!-- bcat was here -->",
+      inject.to_s,
+      "<link href=\"data:image/x-icon;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQEAYAAABPYyMiAAAABmJLR0T///////8JWPfcAAAACXBIWXMAAABIAAAASABGyWs+AAAAF0lEQVRIx2NgGAWjYBSMglEwCkbBSAcACBAAAeaR9cIAAAAASUVORK5CYII=\" rel=\"icon\" type=\"image/x-icon\" />",
+      "<title>#{self[:title] || 'bcat'}</title>",
+      "</head>"
+    ].join("\n")
+  end
+
+  def foot
+    "</body>\n</html>\n"
+  end
+
+  def escape_js(string)
+    string = string.gsub(/['\\]/) { |char| "\\#{char}" }
+    string.gsub!(/\n/, '\n')
+    string
+  end
+
+  def close
+    unless @config[:persist]
+      notice "closing with interrupt"
+      raise Interrupt, "connection closed"
+    end
+  end
+
+  def notice(message)
+    return if !@config[:debug]
+    warn "#{File.basename($0)}: #{message}"
+  end
+end