bcat 0.5.2 → 0.6.0

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/bcat.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'bcat'
-  s.version = '0.5.2'
-  s.date = '2010-08-23'
+  s.version = '0.6.0'
+  s.date = '2011-02-21'
 
   s.description = "pipe to browser utility"
   s.summary =
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     COPYING
     INSTALLING
     README
+    RELEASING
     Rakefile
     bcat.gemspec
     bin/a2h

data/bin/a2h

@@ -9,6 +9,7 @@ $stdout.sync = true
 
 ARGV.push '-' if ARGV.empty?
 
-reader = Bcat::Reader.new(ARGV.to_a)
+reader = Bcat::Reader.new(false, ARGV.to_a)
+reader.open
 filter = Bcat::ANSI.new(reader)
 filter.each { |text| $stdout.write(text) }

data/bin/bcat

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
-#/ Usage: bcat [-ht] [-a] [-b <browser>] [-T <title>] [<file>]...
+#/ 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,
@@ -15,7 +16,9 @@
 #/   -t, --text                 input is unencoded text
 #/
 #/ Misc options:
-#/   -d, --debug          enable verbose debug logging on stderr
+#/   -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 = {
@@ -25,6 +28,8 @@ options = {
   :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$/)
 }
@@ -38,6 +43,8 @@ ARGV.options do |argv|
   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 }

data/lib/bcat.rb

@@ -6,14 +6,14 @@ require 'bcat/server'
 require 'bcat/browser'
 
 class Bcat
-  VERSION = '0.5.2'
+  VERSION = '0.6.0'
   include Rack::Utils
 
   attr_reader :format
 
-  def initialize(files=[], config={})
+  def initialize(args=[], config={})
     @config = {:Host => '127.0.0.1', :Port => 8091}.merge(config)
-    @reader = Bcat::Reader.new(files)
+    @reader = Bcat::Reader.new(@config[:command], args)
     @format = @config[:format]
   end
 
@@ -39,6 +39,8 @@ class Bcat
   end
 
   def assemble
+    @reader.open
+
     @format = @reader.sniff if @format.nil?
 
     @filter = @reader
@@ -103,8 +105,10 @@ class Bcat
   end
 
   def close
-    notice "closing with interrupt"
-    raise Interrupt, "connection closed"
+    unless @config[:persist]
+      notice "closing with interrupt"
+      raise Interrupt, "connection closed"
+    end
   end
 
   def notice(message)

data/lib/bcat/browser.rb

@@ -43,16 +43,15 @@ class Bcat
     end
 
     def open(url)
-      command = browser_command
       fork do
         $stdin.close
-        exec "#{command} '#{shell_quote(url)}'"
+        exec "#{command} #{shell_quote(url)}"
+        exit! 128
       end
     end
 
     def command
-      return @command if @command
-      browser_command
+      @command || browser_command
     end
 
     def browser_command(browser=@browser)
@@ -63,7 +62,7 @@ class Bcat
     end
 
     def shell_quote(argument)
-      arg = argument.to_s.gsub(/([\\'])/) { "\\" + $1 }
+      '"' + argument.to_s.gsub(/([\\"`$])/) { "\\" + $1 } + '"'
     end
   end
 end

data/lib/bcat/reader.rb

@@ -4,25 +4,38 @@ class Bcat
   # ARGF style multi-file streaming interface. Input is read with IO#readpartial
   # to avoid buffering.
   class Reader
-    attr_reader :files
+    attr_reader :is_command
+    attr_reader :args
     attr_reader :fds
 
-    def initialize(files=[])
-      @files = files
-      @fds =
-        files.map do |f|
-          if f == '-'
-            $stdin
-          else
-            File.open(f, 'rb')
-          end
-        end
+    def initialize(is_command, args=[])
+      @is_command = is_command
+      @args = args
+    end
+
+    def open
+      @fds = is_command ? open_command : open_files
       @buf = []
     end
 
+    def open_command
+      [IO.popen(args.join(' '), 'rb')]
+    end
+
+    def open_files
+      args.map do |f|
+        if f == '-'
+          $stdin
+        else
+          File.open(f, 'rb')
+        end
+      end
+    end
+
     def each
       yield @buf.shift while @buf.any?
       while fd = fds.first
+        fds.shift and next if fd.closed?
         fd.sync = true
         begin
           while buf = fd.readpartial(4096)

data/man/bcat.1.ronn

@@ -3,7 +3,8 @@ bcat(1) -- browser cat
 
 ## SYNOPSIS
 
-`bcat` [-htad] [<file>...]<br>
+`bcat` [-htapd] [<file>...]<br>
+`bcat` [-htapd] -c <command>...<br>
 `btee` [-htad] [<file>...]
 
 ## DESCRIPTION
@@ -46,13 +47,23 @@ with these options:
     entire output is wrapped in a `<pre>`.
 
   * `-h`, `--html`:
-    The input is already HTML encoded. Under this mode, bcat passes input
+    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. `bcat` outputs `<html>`, `<head>`,
     and `<body>` elements even if they are not included in the input.
 
 Miscellaneous options:
 
+  * `-c`, `--command`:
+    Interpret the remaining options as a command to be run whose output should
+    be piped into the web browser.
+
+  * `-p`, `--persist`:
+    Have `bcat` serve requests until it is interrupted. Reloading the page
+    in the browser will cause `bcat` to re-read the files (or re-run the command
+    if used with the `--command` option). Standard input can only be read once
+    and will produce no content on subsequent requests.
+
   * `-d`, `--debug`:
     Turn on verbose debug logging to standard error. Include this output when
     reporting defects if applicable.
@@ -92,6 +103,10 @@ For previewing HTML:
     mustache < template.mustache |bcat
     pygmentize -Ofull,style=colorful -f html main.c |bcat
 
+Regenerate the content each time the page is reloaded:
+
+    bcat -pc markdown README.md
+
 As a simple man pager:
 
     export MANPAGER='col -b |bcat'

data/man/btee.1.ronn

@@ -3,7 +3,8 @@ bcat(1) -- browser cat
 
 ## SYNOPSIS
 
-`bcat` [-htad] [<file>...]<br>
+`bcat` [-htapd] [<file>...]<br>
+`bcat` [-htapd] -c <command>...<br>
 `btee` [-htad] [<file>...]
 
 ## DESCRIPTION
@@ -46,13 +47,23 @@ with these options:
     entire output is wrapped in a `<pre>`.
 
   * `-h`, `--html`:
-    The input is already HTML encoded. Under this mode, bcat passes input
+    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. `bcat` outputs `<html>`, `<head>`,
     and `<body>` elements even if they are not included in the input.
 
 Miscellaneous options:
 
+  * `-c`, `--command`:
+    Interpret the remaining options as a command to be run whose output should
+    be piped into the web browser.
+
+  * `-p`, `--persist`:
+    Have `bcat` serve requests until it is interrupted. Reloading the page
+    in the browser will cause `bcat` to re-read the files (or re-run the command
+    if used with the `--command` option). Standard input can only be read once
+    and will produce no content on subsequent requests.
+
   * `-d`, `--debug`:
     Turn on verbose debug logging to standard error. Include this output when
     reporting defects if applicable.
@@ -92,6 +103,10 @@ For previewing HTML:
     mustache < template.mustache |bcat
     pygmentize -Ofull,style=colorful -f html main.c |bcat
 
+Regenerate the content each time the page is reloaded:
+
+    bcat -pc markdown README.md
+
 As a simple man pager:
 
     export MANPAGER='col -b |bcat'

data/test/test_bcat_browser.rb

@@ -2,4 +2,11 @@ require 'contest'
 require 'bcat/browser'
 
 class BrowserTest < Test::Unit::TestCase
+
+  setup { @browser = Bcat::Browser.new('default', nil) }
+
+  test 'shell quotes double-quotes, backticks, and parameter expansion' do
+    assert_equal "\"http://example.com/\\\"/\\$(echo oops)/\\`echo howdy\\`\"",
+      @browser.shell_quote("http://example.com/\"/$(echo oops)/`echo howdy`")
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bcat
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 2
-  version: 0.5.2
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-23 00:00:00 -07:00
+date: 2011-02-21 00:00:00 -08:00
 default_executable: bcat
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,6 +48,7 @@ files:
 - COPYING
 - INSTALLING
 - README
+- RELEASING
 - Rakefile
 - bcat.gemspec
 - bin/a2h