hl 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+results.html
+pkg
+html

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@hl --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in hl.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    hl (0.0.1)
+      gem-man
+      methadone (~> 1.0.0.rc5)
+      rainbow
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.4.11)
+      childprocess (>= 0.2.3)
+      cucumber (>= 1.1.1)
+      ffi (>= 1.0.11)
+      rspec (>= 2.7.0)
+    builder (3.0.0)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    cucumber (1.1.9)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.9.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    gem-man (0.3.0)
+    gherkin (2.9.0)
+      json (>= 1.4.6)
+    hpricot (0.8.6)
+    json (1.6.5)
+    methadone (1.0.0.rc5)
+      bundler
+    mustache (0.99.4)
+    rainbow (1.1.3)
+    rake (0.9.2.2)
+    rdiscount (1.6.8)
+    rdoc (3.12)
+      json (~> 1.4)
+    ronn (0.7.3)
+      hpricot (>= 0.8.2)
+      mustache (>= 0.7.0)
+      rdiscount (>= 1.5.8)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    term-ansicolor (1.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  hl!
+  rake (~> 0.9.2)
+  rdoc
+  ronn

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,88 @@
+hl(1) -- Highlight text in an output stream or file
+===================================================
+
+## SYNOPSIS
+
+`hl [options] PATTERN [FILE...]`
+
+`hl [options] -p PATTERN [FILE...]`
+
+## INSTALL
+
+    $ gem install hl
+
+## DESCRIPTION
+
+**hl** higlights (using ANSI escape sequences) instances of _PATTERN_ in the named input _FILEs_ or standard in if none are specified. **hl**'s goal is to assist visually scanning such output, but without trimming that output as `grep(1)` would.  The most common use-case is when trying to scan the output of a `grep` invocation that has complex data or long lines.  In this case, you don't want to further grep the output for the term you're looking for, bit instead simply need a visual cue as to where the secondary search term is in the output.
+
+_PATTERN_ can be a plain string, or a regular expression.
+
+## OPTIONS
+
+  * `-c COLOR`, `--color=COLOR`:
+    Color to use for highlighting.  Available colors are red, green, yellow, blue, magenta, cyan, or white,
+    with yellow being the default.
+
+  * `-n`, `--[no-]inverse`:
+    Inverse highlight.  Shows the highlighting in inverse, with the background of the highlight being the selected color and the foreground being the color of your terminal's background.  This is off by default
+
+  * `-i`, `--[no-]ignore-case`:
+    Ignore case when matching.  This is off by default.
+
+  * `-u`, `--[no-]underline`:
+    Underline highlight.  This is off by default.
+
+  * `-b`, `--[no-]bright`:
+    Use bright colors.  Shows the highlighting using the bright version of the color.  This is off by default.
+
+  * `-p PATTERN`, `--regexp=PATTERN`:
+    Search term as explicit option.  This is useful for searching for patterns that start with a dash.
+
+  * `-h`, `--help`, `--version`:
+    Show the version and help information
+
+## ENVIRONMENT
+
+Default options can be specified in the `HL_OPTS` environment variable, exactly as they would appear on the command line.  You
+can override these switches with the `-no-` form of the options
+
+## EXAMPLES
+
+Highlight the output of grep
+
+    grep '2012-01-02' some_log_file.txt | hl 'user_id'
+
+Highlight the word "user_id" in bright cyan in several files
+
+    hl --color=cyan -b user_id some_file some_other_file yet_a_third_file
+
+## BUGS
+
+  * Does not allow for highlighting multiple terms at once
+
+## AUTHOR
+
+David Copeland, davec (at) naildrivin5.com
+
+## COPYRIGHT
+
+hl is copyright(c) 2012 by David Copeland, released under the Apache license.
+
+## SEE ALSO
+
+  * Source on github: https://github.com/davetron5000/hl
+
+
+[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
+[INSTALL]: #INSTALL "INSTALL"
+[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
+[OPTIONS]: #OPTIONS "OPTIONS"
+[ENVIRONMENT]: #ENVIRONMENT "ENVIRONMENT"
+[EXAMPLES]: #EXAMPLES "EXAMPLES"
+[BUGS]: #BUGS "BUGS"
+[AUTHOR]: #AUTHOR "AUTHOR"
+[COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
+[SEE ALSO]: #SEE-ALSO "SEE ALSO"
+
+
+[hl(1)]: hl.1.html

data/Rakefile

@@ -0,0 +1,42 @@
+require 'bundler'
+require 'rake/clean'
+require 'rake/testtask'
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+require 'methadone'
+require 'fileutils'
+
+include Rake::DSL
+include Methadone::SH
+include FileUtils
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/tc_*.rb'
+end
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :man do 
+  sh 'ronn --markdown --roff man/hl.1.ronn'
+  mv 'man/hl.1.markdown','README.md'
+end
+CLEAN << 'man/hl.1'
+CLEAN << 'man/hl.1.html'
+
+task :default => [:test,:features,:man]

data/bin/hl

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'hl'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do |keyword,*filenames|
+    if options[:regexp]
+      Array(filenames).unshift(keyword)
+      keyword = options[:regexp]
+    end
+
+    exit_now! 'search term or --regexp/-p required' if keyword.nil?
+
+    keyword = keyword.dup
+    highlighter = Hl::Highlighter.new(options)
+
+    puts highlighter.highlight(filenames,keyword)
+  end
+
+  description "Highlight terms in output without grepping out lines"
+
+  options[:color] = 'yellow'
+  colors = ['red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white']
+  on("-c COLOR","--color","Color to use for highlighting",colors,"(#{colors.join('|')})")
+  on("--[no-]bright","-b","Use bright colors")
+  on("--[no-]inverse","-n","Inverse highlight")
+  on("--[no-]underline","-u","Underline highlight")
+  on("--regexp PATTERN","-p","Search term as explicit option")
+  on("--[no-]ignore-case","-i","Ignore case in match")
+
+  arg :search_term, :optional
+  arg :filename, :optional
+
+  version Hl::VERSION
+
+  defaults_from_env_var 'HL_OPTS'
+
+  go!
+end

data/features/hl.feature

@@ -0,0 +1,80 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "hl"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+
+    And the banner should document that this app's arguments are:
+      |search_term|which is optional|
+      |filename   |which is optional|
+
+  Scenario: Highlights stuff in yellow by default
+    Given a file named "test_file" with the word "foo" in it
+    When I successfully run `hl foo ../../test_file`
+    Then the entire contents of "test_file" should be output
+    But the word "foo" should be highlighted in yellow
+
+  Scenario: Highlights the pattern used in the flag
+    Given a file named "test_file" with the word "foo" in it
+    When I successfully run `hl --regexp=foo ../../test_file`
+    Then the entire contents of "test_file" should be output
+    But the word "foo" should be highlighted in yellow
+
+  Scenario: Highlights multiple times per line if needed
+    Given a file named "test_file" with the word "foo bar foo" in it
+    When I successfully run `hl foo ../../test_file`
+    Then the entire contents of "test_file" should be output
+    But the word "foo" should be highlighted both times in yellow
+
+  Scenario: Highlights with case insensitivity
+    Given a file named "test_file" with the word "FOO bar foo" in it
+    When I successfully run `hl -i foo ../../test_file`
+    Then the entire contents of "test_file" should be output
+    But the word "foo" should be highlighted in yellow
+    And the word "FOO" should be highlighted in yellow
+
+  Scenario Outline: Treats search term as a regexp
+    Given a file named "test_file" with the word "867-5309" in it
+    When I successfully run `hl <term> ../../test_file`
+    Then the entire contents of "test_file" should be output
+    But the word "867-5309" should be highlighted in yellow
+
+    Examples:
+      |term|
+      |'867-\d\d\d\d'|
+      |--regexp='867-\d\d\d\d'|
+
+  Scenario: It is an error to omit both the search term and the --regexp flag
+    When I run `hl`
+    Then the stderr should contain "search term or --regexp/-p required"
+
+  Scenario: Highlights stuff in yellow by default using multiple files
+    Given a file named "test_file" with the word "foo" in it
+    And a file named "test_file2" with the word "foobar" in it
+    When I successfully run `hl foo ../../test_file ../../test_file2`
+    Then the entire contents of "test_file" should be output
+    Then the entire contents of "test_file2" should be output
+    But the word "foo" should be highlighted in yellow
+
+  Scenario: Highlights from stdin if no file is given
+    When I run `hl foo` interactively
+    And I type some text containing "foo"
+    Then the contents of what I typed should be output
+    But the word "foo" should be highlighted in yellow
+
+  Scenario: Highlights stuff in blue if requested
+    Given a file named "test_file" with the word "foo" in it
+    When I successfully run `hl --color blue foo ../../test_file`
+    Then the entire contents of "test_file" should be output
+    But the word "foo" should be highlighted in blue
+
+  Scenario: Highlights stuff in bright, inverted, underlined cyan if requested
+    Given a file named "test_file" with the word "foo" in it
+    When I successfully run `hl --color blue -bun foo ../../test_file`
+    Then the entire contents of "test_file" should be output
+    But the word "foo" should be highlighted in bright inverted underlined blue

data/features/step_definitions/hl_steps.rb

@@ -0,0 +1,47 @@
+require 'rainbow'
+Sickill::Rainbow.enabled = true
+CONTENTS = [
+  'This is the first line',
+  'This is the second line and %{keyword} it contains the search term',
+  'This is the last line',
+]
+Given /^a file named "([^"]*)" with the word "([^"]*)" in it$/ do |filename, keyword|
+  @contents_without_ansi = CONTENTS.map { |line| line.gsub('%{keyword}','>>=').split('>>=') }.flatten
+  @contents = CONTENTS.map { |line| line % { :keyword => keyword } }
+  File.open(filename,'w') { |file| @contents.each { |_| file.puts _ } }
+end
+
+Then /^the entire contents of "([^"]*)" should be output$/ do |file|
+  @contents_without_ansi.each { |_| assert_partial_output(_,all_stdout) }
+end
+
+Then /^the word "([^"]*)" should be highlighted in (.*$)$/ do |keyword,color|
+  if color == 'bright inverted underlined blue'
+    expected = keyword.color(:blue).inverse.bright.underline
+  else
+    expected = keyword.color(color.to_sym)
+  end
+  assert_partial_output(expected,all_stdout)
+end
+
+Then /^the word "([^"]*)" should be highlighted both times in (.*$)$/ do |keyword,color|
+  expected = keyword.color(color.to_sym)
+  all_stdout.should match /#{Regexp.escape(expected)}.*#{Regexp.escape(expected)}/
+end
+
+Then /^I type some text containing "([^"]*)"$/ do |keyword|
+  @contents_without_ansi = CONTENTS.map { |line| line.gsub('%{keyword}','>>=').split('>>=') }.flatten
+  contents = CONTENTS.map { |line| line % { :keyword => keyword } }
+  contents.each do |line|
+    step %{I type "#{line}"}
+  end
+  @interactive.stdin.close
+end
+
+Then /^the contents of what I typed should be output$/ do
+  @contents_without_ansi.each { |_| assert_partial_output(_,all_stdout) }
+end
+
+Then /^I should see the help output$/ do
+  step %{the banner should be present}
+end

data/features/support/env.rb

@@ -0,0 +1,20 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+require 'fileutils'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+Before do
+  @aruba_keep_ansi = true
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+  %w(test_file test_file2).each do |filename|
+    FileUtils.rm filename if File.exist? filename
+  end
+end

data/hl.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hl/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hl"
+  s.version     = Hl::VERSION
+  s.authors     = ["Dave Copeland"]
+  s.email       = ["davetron5000@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Highlight words in stdin or files}
+  s.description = %q{To help with reading the results of grep without further reducing the output, hl will highlight terms in the output}
+
+  s.rubyforge_project = "hl"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('ronn')
+  s.add_development_dependency('aruba')
+  s.add_development_dependency('rake','~> 0.9.2')
+  s.add_dependency('methadone', '~>1.0.0.rc5')
+  s.add_dependency('rainbow')
+  s.add_dependency('gem-man')
+end

data/lib/hl.rb

@@ -0,0 +1,2 @@
+require 'hl/highlighter'
+require 'hl/version'

data/lib/hl/highlighter.rb

@@ -0,0 +1,54 @@
+require 'rainbow'
+module Hl
+  class Highlighter
+    # options - a Hash of symbols to values:
+    #           :color - color to highlight
+    #           :bright - highlight in bright
+    #           :underline - underline highlight
+    #           :inverse - invert highlight
+    #           'ignore-case' - ignore case when matching
+    def initialize(options)
+      @options = options
+    end
+
+    # Returns a string containing the highlighted text from the given files or
+    # STDIN if filenames is empty
+    def highlight(filenames,keyword)
+      Sickill::Rainbow.enabled = true
+      files = if filenames.empty?
+                [STDIN]
+              else
+                filenames.map { |_| File.open(_) }
+              end
+      begin
+
+        regexp = Regexp.new(keyword,@options['ignore-case'] ? Regexp::IGNORECASE : nil)
+
+        files.map { |_| _.readlines}.flatten.map { |_| highlight_matches(regexp,_) }.join("\n")
+      ensure
+        files && files.map(&:close)
+      end
+    end
+
+  private
+
+    def highlight_matches(regexp,rest_of_string)
+      match_data = regexp.match(rest_of_string)
+      return rest_of_string if match_data.nil?
+
+      before_match = rest_of_string[0..match_data.begin(0)-1]
+      after_match = rest_of_string[match_data.end(0)..-1]
+
+      return before_match + highlight_string(match_data[0]) + highlight_matches(regexp,after_match)
+    end
+
+    def highlight_string(string)
+      string = string.color(@options['color'].to_sym)
+      string = string.inverse if @options[:inverse]
+      string = string.bright if @options[:bright]
+      string = string.underline if @options[:underline]
+      string
+    end
+
+  end
+end

data/lib/hl/version.rb

@@ -0,0 +1,3 @@
+module Hl
+  VERSION = "0.0.1"
+end

data/man/hl.1

@@ -0,0 +1,107 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "HL" "1" "March 2012" "" ""
+.
+.SH "NAME"
+\fBhl\fR \- Highlight text in an output stream or file
+.
+.SH "SYNOPSIS"
+\fBhl [options] PATTERN [FILE\.\.\.]\fR
+.
+.P
+\fBhl [options] \-p PATTERN [FILE\.\.\.]\fR
+.
+.SH "INSTALL"
+.
+.nf
+
+$ gem install hl
+.
+.fi
+.
+.SH "DESCRIPTION"
+\fBhl\fR higlights (using ANSI escape sequences) instances of \fIPATTERN\fR in the named input \fIFILEs\fR or standard in if none are specified\. \fBhl\fR\'s goal is to assist visually scanning such output, but without trimming that output as \fBgrep(1)\fR would\. The most common use\-case is when trying to scan the output of a \fBgrep\fR invocation that has complex data or long lines\. In this case, you don\'t want to further grep the output for the term you\'re looking for, bit instead simply need a visual cue as to where the secondary search term is in the output\.
+.
+.P
+\fIPATTERN\fR can be a plain string, or a regular expression\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-c COLOR\fR, \fB\-\-color=COLOR\fR
+Color to use for highlighting\. Available colors are red, green, yellow, blue, magenta, cyan, or white, with yellow being the default\.
+.
+.TP
+\fB\-n\fR, \fB\-\-[no\-]inverse\fR
+Inverse highlight\. Shows the highlighting in inverse, with the background of the highlight being the selected color and the foreground being the color of your terminal\'s background\. This is off by default
+.
+.TP
+\fB\-i\fR, \fB\-\-[no\-]ignore\-case\fR
+Ignore case when matching\. This is off by default\.
+.
+.TP
+\fB\-u\fR, \fB\-\-[no\-]underline\fR
+Underline highlight\. This is off by default\.
+.
+.TP
+\fB\-b\fR, \fB\-\-[no\-]bright\fR
+Use bright colors\. Shows the highlighting using the bright version of the color\. This is off by default\.
+.
+.TP
+\fB\-p PATTERN\fR, \fB\-\-regexp=PATTERN\fR
+Search term as explicit option\. This is useful for searching for patterns that start with a dash\.
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR, \fB\-\-version\fR
+Show the version and help information
+.
+.SH "ENVIRONMENT"
+Default options can be specified in the \fBHL_OPTS\fR environment variable, exactly as they would appear on the command line\. You can override these switches with the \fB\-no\-\fR form of the options
+.
+.SH "EXAMPLES"
+Highlight the output of grep
+.
+.IP "" 4
+.
+.nf
+
+grep \'2012\-01\-02\' some_log_file\.txt | hl \'user_id\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Highlight the word "user_id" in bright cyan in several files
+.
+.IP "" 4
+.
+.nf
+
+hl \-\-color=cyan \-b user_id some_file some_other_file yet_a_third_file
+.
+.fi
+.
+.IP "" 0
+.
+.SH "BUGS"
+.
+.IP "\(bu" 4
+Does not allow for highlighting multiple terms at once
+.
+.IP "" 0
+.
+.SH "AUTHOR"
+David Copeland, davec (at) naildrivin5\.com
+.
+.SH "COPYRIGHT"
+hl is copyright(c) 2012 by David Copeland, released under the Apache license\.
+.
+.SH "SEE ALSO"
+.
+.IP "\(bu" 4
+Source on github: https://github\.com/davetron5000/hl
+.
+.IP "" 0
+

data/man/hl.1.ronn

@@ -0,0 +1,73 @@
+hl(1) -- Highlight text in an output stream or file
+===================================================
+
+## SYNOPSIS
+
+`hl [options] PATTERN [FILE...]`
+
+`hl [options] -p PATTERN [FILE...]`
+
+## INSTALL
+
+    $ gem install hl
+
+## DESCRIPTION
+
+**hl** higlights (using ANSI escape sequences) instances of _PATTERN_ in the named input _FILEs_ or standard in if none are specified. **hl**'s goal is to assist visually scanning such output, but without trimming that output as `grep(1)` would.  The most common use-case is when trying to scan the output of a `grep` invocation that has complex data or long lines.  In this case, you don't want to further grep the output for the term you're looking for, bit instead simply need a visual cue as to where the secondary search term is in the output.
+
+_PATTERN_ can be a plain string, or a regular expression.
+
+## OPTIONS
+
+  * `-c COLOR`, `--color=COLOR`:
+    Color to use for highlighting.  Available colors are red, green, yellow, blue, magenta, cyan, or white,
+    with yellow being the default.
+
+  * `-n`, `--[no-]inverse`:
+    Inverse highlight.  Shows the highlighting in inverse, with the background of the highlight being the selected color and the foreground being the color of your terminal's background.  This is off by default
+
+  * `-i`, `--[no-]ignore-case`:
+    Ignore case when matching.  This is off by default.
+
+  * `-u`, `--[no-]underline`:
+    Underline highlight.  This is off by default.
+
+  * `-b`, `--[no-]bright`:
+    Use bright colors.  Shows the highlighting using the bright version of the color.  This is off by default.
+
+  * `-p PATTERN`, `--regexp=PATTERN`:
+    Search term as explicit option.  This is useful for searching for patterns that start with a dash.
+
+  * `-h`, `--help`, `--version`:
+    Show the version and help information
+
+## ENVIRONMENT
+
+Default options can be specified in the `HL_OPTS` environment variable, exactly as they would appear on the command line.  You
+can override these switches with the `-no-` form of the options
+
+## EXAMPLES
+
+Highlight the output of grep
+
+    grep '2012-01-02' some_log_file.txt | hl 'user_id'
+
+Highlight the word "user_id" in bright cyan in several files
+
+    hl --color=cyan -b user_id some_file some_other_file yet_a_third_file
+
+## BUGS
+
+  * Does not allow for highlighting multiple terms at once
+
+## AUTHOR
+
+David Copeland, davec (at) naildrivin5.com
+
+## COPYRIGHT
+
+hl is copyright(c) 2012 by David Copeland, released under the Apache license.
+
+## SEE ALSO
+
+  * Source on github: https://github.com/davetron5000/hl

data/test/tc_something.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class TestSomething < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: hl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dave Copeland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70354328956620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354328956620
+- !ruby/object:Gem::Dependency
+  name: ronn
+  requirement: &70354328956160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354328956160
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70354328955720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354328955720
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70354328955220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70354328955220
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: &70354328954680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70354328954680
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: &70354328954180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70354328954180
+- !ruby/object:Gem::Dependency
+  name: gem-man
+  requirement: &70354328953580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70354328953580
+description: To help with reading the results of grep without further reducing the
+  output, hl will highlight terms in the output
+email:
+- davetron5000@gmail.com
+executables:
+- hl
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hl
+- features/hl.feature
+- features/step_definitions/hl_steps.rb
+- features/support/env.rb
+- hl.gemspec
+- lib/hl.rb
+- lib/hl/highlighter.rb
+- lib/hl/version.rb
+- man/hl.1
+- man/hl.1.ronn
+- test/tc_something.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: hl
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Highlight words in stdin or files
+test_files:
+- features/hl.feature
+- features/step_definitions/hl_steps.rb
+- features/support/env.rb
+- test/tc_something.rb