discoball 0.0.1 → 0.0.2

data/README.md

@@ -5,16 +5,24 @@ discoball
 except that it can highlight multiple patterns (in different colors). Patterns are arbitrary ruby regexes that
 are matched against the entire line.
 
-Usage:
+Usage
+-----
 
     $ discoball [options] <pattern1 pattern2 ...>
 
-Examples:
+Examples
+--------
 
   * Highlight instances of "foo" and "bar" in the text of `myfile.txt`:
 
-      $ cat myfile.txt | discoball foo bar
+        $ cat myfile.txt | discoball foo bar
 
   * Highlight paths of processes running out of `/usr/sbin/`:
 
-      $ ps -ef | discoball '/usr/sbin/.*$'
+        $ ps -ef | discoball '/usr/sbin/.*$'
+
+Installation
+------------
+
+The easiest way to get `discoball` is by using RubyGems: `$ gem install discoball`. You can also clone the git
+repository at `git://github.com/cespare/discoball.git` if you want the latest code.

data/bin/discoball

@@ -1,6 +1,35 @@
 #!/usr/bin/env ruby
 
 require "discoball"
+require "trollop"
 
-highlighter = Discoball::Highlighter.new(ARGV.map { |pattern| Regexp.new(pattern) })
-STDIN.each { |line| puts highlighter.filter(line) }
+options = Trollop::options do
+  banner <<-EOS
+discoball is a tool for highlighting patterns in a text stream.
+
+Usage:
+  $ discoball [options] <pattern1 pattern2 ...>
+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
+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
+
+patterns = ARGV.map { |pattern| Regexp.new(pattern) }
+highlighter = Discoball::Highlighter.new(patterns, color_mode, options[:match])
+STDIN.each do |line|
+  filtered = highlighter.filter(line)
+  puts filtered unless filtered.nil?
+end

data/discoball.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "discoball"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   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=
@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
     bin/discoball
   )
   s.add_dependency("colorize", ">=0.5.8")
+  s.add_dependency("trollop", ">=1.16.2")
 end

data/lib/discoball.rb

@@ -4,29 +4,63 @@ require "colorize"
 
 module Discoball
   UNUSABLE_COLORS = [/black$/, /^default$/, /white$/, /^light/]
+  SINGLE_COLOR = :blue
 
   class Highlighter
-    def initialize(patterns)
+    # 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 = patterns
+      @color_mode = color_mode
+      @match_only = match_only
       @color_stack = String.colors.reject { |color| UNUSABLE_COLORS.any? { |unusable| color =~ unusable } }
       @color_assignments = {}
+      if color_mode == :group_colors
+        @patterns.each { |pattern| @color_assignments[pattern] = pop_rotate }
+      end
     end
 
     def filter(line)
-      matches = @patterns.flat_map { |pattern| line.scan(pattern) }.uniq
-      matches.each { |match| line.gsub!(match, highlight(match)) }
-      line
+      match_found = false
+      case @color_mode
+      when :one_color
+        matches = @patterns.flat_map { |pattern| line.scan(pattern) }.uniq
+        match_found ||= !matches.empty?
+        matches.each { |match| highlight!(line, match, SINGLE_COLOR) }
+      when :group_colors
+        @patterns.each do |pattern|
+          matches = line.scan(pattern).uniq
+          match_found ||= !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.each do |match|
+          unless @color_assignments.include? match
+            @color_assignments[match] = pop_rotate
+          end
+          matches.each { |match| highlight!(line, match, @color_assignments[match]) }
+        end
+      end
+      (@match_only && !match_found) ? nil : line
     end
 
     private
 
-    def highlight(match)
-      unless @color_assignments.include? match
-        color = @color_stack.pop
-        @color_stack.insert(0, color)
-        @color_assignments[match] = color
-      end
-      match.colorize(@color_assignments[match]).underline
+    def highlight!(line, match, color)
+      line.gsub!(match, match.colorize(color).underline)
+    end
+
+    # Get the next color and put it at the back
+    def pop_rotate
+      color = @color_stack.pop
+      @color_stack.insert(0, color)
+      color
     end
   end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: discoball
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors: 
 - Caleb Spare
@@ -25,13 +21,20 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 8
         version: 0.5.8
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id002
 description: A simple stream filter to highlight patterns
 email: cespare@gmail.com
 executables: 
@@ -59,21 +62,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: discoball
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 2
 summary: A simple stream filter to highlight patterns