discoball 0.0.2 → 0.0.3

data/README.md

@@ -10,8 +10,16 @@ Usage
 
     $ discoball [options] <pattern1 pattern2 ...>
 
+where options are:
+
+  * `--group-colors` or `-g`: Color all matches of the same pattern with the same color
+  * `--one-color` or `-o`: Highlight all matches with a single color
+  * `--match-any` or `-m`: Only print lines matching an input pattern
+  * `--match-all` or `-a`: Only print lines matching all input patterns
+  * `--help` or `-h`: Print the help message
+
 Examples
---------
+------------------
 
   * Highlight instances of "foo" and "bar" in the text of `myfile.txt`:
 
@@ -19,7 +27,34 @@ Examples
 
   * Highlight paths of processes running out of `/usr/sbin/`:
 
-        $ ps -ef | discoball '/usr/sbin/.*$'
+        $ ps -ef | discoball --one_color --match '/usr/sbin/.*$'
+
+  * I wrote discoball for use with [Steve Losh's todo-list tool, t](https://github.com/sjl/t). I put tags on
+    my tasks annotated with `+` (inspired by [Todo.txt](http://todotxt.com/)):
+
+        $ t Make an appointment with the dentist +health
+
+    When I list my tasks (using `t`), I use discoball to highlight the tags with different colors:
+
+        $ t | discoball '\+\S+'
+
+    I can even do some fancier stuff to list particular labels. I have the following function defined in my
+    `.bashrc`:
+
+    ``` bash
+    function tl() {
+      if [ -z  "$1" ]; then
+        t | discoball '\+\S+'
+      else
+        t | discoball -a "${@/#/\+}"
+      fi
+    }
+    ```
+
+    I can use this as follows:
+
+        $ tl               # ~> Show the list of tasks, with tags highlighted
+        $ tl health urgent # ~> Show only tasks tagged with 'health' and 'urgent'
 
 Installation
 ------------

data/bin/discoball

@@ -13,22 +13,32 @@ where options are:
 EOS
   opt :group_colors, "Color all matches of the same pattern with the same color", :default => false
   opt :one_color, "Highlight all matches with a single color", :default => false
-  opt :match, "Only print lines with matches", :default => false
+  opt :match_any, "Only print lines matching an input pattern", :default => false
+  opt :match_all, "Only print lines matching all input patterns", :default => false
 end
 
 color_mode_array = [:group_colors, :one_color].select { |option| options[option] }
 if color_mode_array.size > 1
   Trollop::die "Only one of --group-colors or --one-color may be set"
 end
-
 if color_mode_array.empty?
   color_mode = :individual
 else
   color_mode = color_mode_array[0]
 end
 
+match_mode_array = [:match_any, :match_all].select { |option| options[option] }
+if match_mode_array.size > 1
+  Trollop::die "Only one of --match-any or --match-all may be set"
+end
+if match_mode_array.empty?
+  match_mode = :all
+else
+  match_mode = match_mode_array[0]
+end
+
 patterns = ARGV.map { |pattern| Regexp.new(pattern) }
-highlighter = Discoball::Highlighter.new(patterns, color_mode, options[:match])
+highlighter = Discoball::Highlighter.new(patterns, color_mode, match_mode)
 STDIN.each do |line|
   filtered = highlighter.filter(line)
   puts filtered unless filtered.nil?

data/discoball.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "discoball"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">=0") if s.respond_to? :required_rubygems_version=
   s.specification_version = 2 if s.respond_to? :specification_version=

data/lib/discoball.rb

@@ -7,16 +7,19 @@ module Discoball
   SINGLE_COLOR = :blue
 
   class Highlighter
-    # Patterns is an array of patterns to match. There are three options that can be changed:
-    #   * If color_mode is :individual, then each unique string matching one of the patterns will be a
-    #       different color.
-    #   * If color_mode is :group_colors, then the matches corresponding to each pattern will be the same color.
-    #   * If color_mode is :one_color, then all matches will be a single color.
-    #   * If match_only is set, then only matching lines will be returned.
-    def initialize(patterns, color_mode = :individual, match_only = false)
+    # Patterns is an array of patterns to match. There are two options that can be changed:
+    #   * color_mode
+    #     -:individual - each unique string matching one of the patterns will be a different color.
+    #     -:group_colors - the matches corresponding to each pattern will be the same color.
+    #     -:one_color - all matches will be a single color.
+    #   * match_mode
+    #     -:all - all lines are returned
+    #     -:match_any - lines matching any pattern are returned
+    #     -:match_all - only lines matching every pattern are returned
+    def initialize(patterns, color_mode = :individual, match_mode = :all)
       @patterns = patterns
       @color_mode = color_mode
-      @match_only = match_only
+      @match_mode = match_mode
       @color_stack = String.colors.reject { |color| UNUSABLE_COLORS.any? { |unusable| color =~ unusable } }
       @color_assignments = {}
       if color_mode == :group_colors
@@ -25,21 +28,29 @@ module Discoball
     end
 
     def filter(line)
-      match_found = false
+      match_found = {}
+      @patterns.each { |pattern| match_found[pattern] = false }
+
       case @color_mode
       when :one_color
-        matches = @patterns.flat_map { |pattern| line.scan(pattern) }.uniq
-        match_found ||= !matches.empty?
+        matches = @patterns.flat_map { |pattern|
+          m = line.scan(pattern)
+          match_found[pattern] = true unless m.empty?
+          m
+        }.uniq
         matches.each { |match| highlight!(line, match, SINGLE_COLOR) }
       when :group_colors
         @patterns.each do |pattern|
           matches = line.scan(pattern).uniq
-          match_found ||= !matches.empty?
+          match_found[pattern] = true unless matches.empty?
           matches.each { |match| highlight!(line, match, @color_assignments[pattern]) }
         end
       when :individual
-        matches = @patterns.flat_map { |pattern| line.scan(pattern) }.uniq
-        match_found ||= !matches.empty?
+        matches = @patterns.flat_map { |pattern|
+          m = line.scan(pattern)
+          match_found[pattern] = true unless m.empty?
+          m
+        }.uniq
         matches.each do |match|
           unless @color_assignments.include? match
             @color_assignments[match] = pop_rotate
@@ -47,7 +58,15 @@ module Discoball
           matches.each { |match| highlight!(line, match, @color_assignments[match]) }
         end
       end
-      (@match_only && !match_found) ? nil : line
+
+      case @match_mode
+      when :match_any
+        match_found.any? { |pattern, found| found } ? line : nil
+      when :match_all
+        match_found.all? { |pattern, found| found } ? line : nil
+      else
+        line
+      end
     end
 
     private

metadata

@@ -2,7 +2,7 @@
 name: discoball
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Caleb Spare
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-10 00:00:00 -07:00
+date: 2011-05-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency