xail 0.0.1 → 0.0.2

data/README.md

@@ -38,10 +38,10 @@ and performs some action, potentially altering the stream, or terminating the fl
 Compound filters take a stream and also a set of subfilters. These generally implement
 flow control.
 
-Stdout is the ultimate consumer of the strings, unless they've been filtered.
+Stdout is the ultimate consumer of the strings, unless they've been redirected using `rest`.
 
 ### Compound Filters
-* `cascade` -- stream the result of first subfilter that streams
+* `cascade` -- stream the result of first subfilter that streams, a cascade filter is the container for your xail script
 * `composition` -- applies each subfilter on the stream of the preceding subfilter, streaming the final result
 
 * `and` -- streams the original if all subfilters stream
@@ -65,7 +65,52 @@ Stdout is the ultimate consumer of the strings, unless they've been filtered.
 * `sample` -- samples the stream, only printing at the rate requested
 * `stop` -- stops processing of this stream and continues with the next
 * `count` -- [todo] computes the rate of the stream for display (need UI aspect)
+* `rest` -- a special compound filter that is applied to any unmatched streams
 
 ### Custom Filters
 
 You can easily develop your own filters. Either as an anonymous block:
+
+    filter do |stream|
+      if stream.includes? 'awesome'
+        nil # stop the stream
+      else
+        stream # keep it going
+      end
+    end
+
+Or, if you need to preserve state, as a filter within the xail file:
+
+    class LineNumbersFilter < AbstractFilter
+        def initialize
+          @lineno = 0
+        end
+
+        def streamLine(line)
+          @lineno += 1
+          return "%5d %s" % [@lineno, line]
+        end
+    end
+
+    linenumbers
+    group('fatal') {
+        contains 'fatal'
+        red
+    }
+
+
+### Hide unfiltered lines
+By default xail will print any unfiltered lines as this is a more typical case.
+You can hide unfiltered lines using a rest block. For example, to only show
+exceptions:
+
+    group('error') {
+      contains 'exception'
+      red
+    }
+
+    stop
+
+### Fine-grained stream control
+You can preform finer grained stream control using the `OR`, `AND`, and `NOT`
+combinators.

data/examples/customfilter.xail.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env xail
+
+class ExecuteFilter < AbstractFilter
+  def initialize(command)
+    @command = command
+  end
+
+  def streamLine(line)
+    puts "WOULD EXECUTE: #{@command} #{line}"
+    return line
+  end
+end
+
+group('exec') {
+  contains 'exec'
+  execute 'echo'
+  stop
+}
+
+rest {
+  stop
+}

data/examples/logview.xail.rb

@@ -3,22 +3,11 @@
 # a simple log error and warning highlighter
 #
 
-class ExecuteFilter < AbstractFilter
-  def initialize(command)
-    @command = command
-  end
-
-  def streamLine(line)
-    puts "EXECUTING #{@command} #{line}"
-    return line
-  end
-end
-
-
+#!/usr/bin/env xail
 group('fatal') {
   contains 'fatal'
   red
-  onblue
+  underscore
   bell
 }
 
@@ -31,4 +20,4 @@ group('error') {
 group('warning') {
   contains 'warn'
   yellow
-}
+}

data/lib/xail.rb

@@ -28,16 +28,22 @@ A Ruby utility for performing basic stream processing, directly focused on incre
       end
     end
 
-
     stream = $stdin
     stream.each() do |line|
-      streamed = filter.streamLine(line)
-      if streamed and streamed.size > 0
-        printf streamed
+      begin
+        streamed = filter.streamLine(line)
+        if streamed and streamed.size > 0
+          print streamed
+        end
+
+      rescue StreamLineStop
       end
     end
   end
 
   config = IO.read(ARGV[0])
   Xail.run(config)
+
+rescue SignalException
+  exit
 end

data/lib/xail/config.rb

@@ -16,10 +16,19 @@ module Xail
       @filter_stack.pop
     end
 
-    def stream(name, source = null)
-      source ||= name
+    def filter(&block)
+      filter_in_scope << Class.new(AbstractFilter) do
+        def streamLine(line)
+          block(line)
+        end
+      end
     end
 
+    # TODO add support for explicitly listing sources
+    #def stream(name, source = null)
+    #  source ||= name
+    #end
+
     def group(name, &filters)
       # TODO intergrate with UX
       filter_scope(FilterComposition.new) {
@@ -27,10 +36,7 @@ module Xail
       }
     end
 
-    def has_final
-      @has_final
-    end
-
+    attr :has_final
     def rest(&filters)
       if @has_final
         raise "rest may only be specified once"
@@ -48,10 +54,18 @@ module Xail
     end
 
     def method_missing(name, *args, &block)
+      abort "internal error #{name} #{args} #{block}" unless name
       filterClass = FilterRegistry::get_filter(name.downcase)
-      filter = filterClass.new(*args)
+      filter_scope(filterClass.new(*args)) do
+        block.yield if block
+      end
       filter_in_scope << filter
 
+    # short circuit the stream line stop exception so we can catch it
+    # in xail main
+    rescue StreamLineStop => stop
+      raise stop
+
     rescue UnknownFilter => error
       abort error.to_s
 

data/lib/xail/filter.rb

@@ -102,7 +102,7 @@ module Xail
         if line != nil
           filter.streamLine(line)
         else
-          nil
+          return nil
         end
       end
     end
@@ -127,26 +127,26 @@ module Xail
   class OrFilter < AbstractCompoundFilter
     def streamLine(line)
       @filters.each do |filter|
-        if filter.streamLine line
+        if filter and filter.streamLine(line)
           return line
         end
       end
 
-      nil
+      return nil
     end
   end
 
 
   # the not filter streams the original if none of the component filters stream
-  class NotFilter < AndFilter
+  class NotFilter < AbstractCompoundFilter
     def streamLine(line)
-      result = super.streamLine(line)
-
-      if result != nil
-        nil
-      else
-        line
+      @filters.each do |filter|
+        if filter.streamLine(line)
+          return
+        end
       end
+
+      return line
     end
   end
 
@@ -157,7 +157,9 @@ module Xail
 
     def streamLine(line)
       @keys.each do |key|
-        if line.include?(key)
+        if key.instance_of? Regexp and line[key]
+          return line
+        elsif key.instance_of? String and line.downcase.include? key.downcase
           return line
         end
       end
@@ -182,13 +184,21 @@ module Xail
   end
 
 
-  # the stop filter never streams
-  class StopFilter < AbstractFilter
+  # the sink filter never streams
+  class SinkFilter < AbstractFilter
     def streamLine(line)
       nil
     end
   end
 
+  # the stop filter stops all processing of this stream-line
+  class StreamLineStop < Exception; end
+  class StopFilter < AbstractFilter
+    def streamLine(line)
+      raise StreamLineStop
+    end
+  end
+
   # the pass through filter always streams
   class PassThroughFilter < AbstractFilter
     def streamLine(line)

data/lib/xail/version.rb

@@ -1,3 +1,3 @@
 module Xail
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/filter_spec.rb

@@ -24,10 +24,17 @@ describe PassThroughFilter do
   end
 end
 
+describe SinkFilter do
+  it "should sink all streams" do
+    f = SinkFilter.new
+    f.streamLine("hi").should eq(nil)
+  end
+end
+
 describe StopFilter do
-  it "should stop all streams" do
+  it "should stop all processing of this stream-line" do
     f = StopFilter.new
-    f.streamLine("hi").should eq(nil)
+    lambda { f.streamLine("hi") }.should raise_error(StreamLineStop)
   end
 end
 
@@ -61,10 +68,10 @@ end
 describe FilterCascade do
   it "should cascade through" do
     f = FilterCascade.new
-    f << StopFilter.new
-    f << StopFilter.new
+    f << SinkFilter.new
+    f << SinkFilter.new
     f << ContainsFilter.new("hi")
-    f << StopFilter.new
+    f << SinkFilter.new
 
     f.streamLine("bye").should eq(nil)
     f.streamLine("hi").should eq("hi")
@@ -80,4 +87,48 @@ describe FilterComposition do
     f.streamLine('bye').should eq(nil)
     f.streamLine('hi there alice').should eq('hi there blice')
   end
+end
+
+describe OrFilter do
+  it "should act like logical or" do
+    f = OrFilter.new
+    f << ContainsFilter.new('a')
+    f << ContainsFilter.new('b')
+
+    f.streamLine('a').should eq('a')
+    f.streamLine('b').should eq('b')
+    f.streamLine('c').should eq(nil)
+  end
+end
+
+describe AndFilter do
+  it "should act like logical and" do
+    f = AndFilter.new
+    f << ContainsFilter.new('a')
+    f << ContainsFilter.new('b')
+
+    f.streamLine('a').should eq(nil)
+    f.streamLine('b').should eq(nil)
+    f.streamLine('ab').should eq('ab')
+  end
+end
+
+describe NotFilter do
+  it "should act like logical not" do
+    f = NotFilter.new
+    f << ContainsFilter.new('a')
+
+    f.streamLine('a').should eq(nil)
+    f.streamLine('b').should eq('b')
+  end
+
+  it "should take multiple subfilters" do
+    f = NotFilter.new
+    f << ContainsFilter.new('a')
+    f << ContainsFilter.new('b')
+
+    f.streamLine('a').should eq(nil)
+    f.streamLine('b').should eq(nil)
+    f.streamLine('c').should eq('c')
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xail
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70198967869060 !ruby/object:Gem::Requirement
+  requirement: &70300575161740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70198967869060
+  version_requirements: *70300575161740
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70198967868420 !ruby/object:Gem::Requirement
+  requirement: &70300575161280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70198967868420
+  version_requirements: *70300575161280
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &70198967867800 !ruby/object:Gem::Requirement
+  requirement: &70300575160760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70198967867800
+  version_requirements: *70300575160760
 description: A lightweight Ruby DSL for building text-stream filters
 email:
 - wiktor@tumblr.com
@@ -57,6 +57,7 @@ files:
 - README.md
 - Rakefile
 - bin/xail
+- examples/customfilter.xail.rb
 - examples/logview.xail.rb
 - examples/logviewtest.txt
 - lib/xail.rb