Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Basic implementation

  • Loading branch information...
commit 5eaf46df636bf5af96e6449d422e578783fad84d 0 parents
@davetron5000 authored
4 .gitignore
@@ -0,0 +1,4 @@
+.DS_Store
+results.html
+pkg
+html
1  .rvmrc
@@ -0,0 +1 @@
+rvm use 1.9.3@hl --create
4 Gemfile
@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in hl.gemspec
+gemspec
53 Gemfile.lock
@@ -0,0 +1,53 @@
+PATH
+ remote: .
+ specs:
+ hl (0.0.1)
+ 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)
+ gherkin (2.9.0)
+ json (>= 1.4.6)
+ json (1.6.5)
+ methadone (1.0.0.rc5)
+ bundler
+ rainbow (1.1.3)
+ rake (0.9.2.2)
+ rdoc (3.12)
+ json (~> 1.4)
+ 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
202 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.
23 README.rdoc
@@ -0,0 +1,23 @@
+= hl - DESCRIBE YOUR GEM
+
+Author:: YOUR NAME (YOUR EMAIL)
+Copyright:: Copyright (c) 2012 YOUR NAME
+
+
+License:: apache, see LICENSE.txt
+
+
+
+DESCRIBE YOUR GEM HERE
+
+== Links
+
+* {Source on Github}[LINK TO GITHUB]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+
+== Examples
+
+== Contributing
+
31 Rakefile
@@ -0,0 +1,31 @@
+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'
+
+include Rake::DSL
+
+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 :default => [:test,:features]
52 bin/hl
@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'rainbow'
+require 'hl'
+
+class App
+ include Methadone::Main
+ include Methadone::CLILogging
+
+ main do |keyword,filename|
+ begin
+ Sickill::Rainbow.enabled = true
+ keyword = keyword.dup
+ color = options['color'].to_sym
+ file = if filename.nil?
+ STDIN
+ else
+ File.open(filename)
+ end
+
+ expected_highlight = keyword.color(color)
+ expected_highlight = expected_highlight.inverse if options[:inverse]
+ expected_highlight = expected_highlight.bright if options[:bright]
+
+ file.readlines.map { |_| _.clone.gsub(keyword,expected_highlight) }.each do |line|
+ puts line
+ end
+ ensure
+ file.close
+ end
+ 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("--bright","-b","Use bright colors")
+ on("--inverse","-i","Inverse highlight")
+
+ arg :search_term, :required
+ arg :filename, :optional
+
+
+ version Hl::VERSION
+
+ use_log_level_option
+
+ go!
+end
46 features/hl.feature
@@ -0,0 +1,46 @@
+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 following options should be documented:
+ |--version |
+ |--color |
+ |-c |
+ |--bright |
+ |-b |
+ |--inverse |
+ |-i |
+
+ And the banner should document that this app's arguments are:
+ |search_term|which is required|
+ |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 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 cyan if requested
+ Given a file named "test_file" with the word "foo" in it
+ When I successfully run `hl --color blue -bi foo ../../test_file`
+ Then the entire contents of "test_file" should be output
+ But the word "foo" should be highlighted in bright inverted blue
38 features/step_definitions/hl_steps.rb
@@ -0,0 +1,38 @@
+require 'rainbow'
+Sickill::Rainbow.enabled = true
+CONTENTS = [
+ 'This is the first line',
+ 'This is the second line and %{keyword} it contarins 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 blue'
+ expected = keyword.color(:blue).inverse.bright
+ else
+ expected = keyword.color(color.to_sym)
+ end
+ assert_partial_output(expected,all_stdout)
+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
16 features/support/env.rb
@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+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
+end
29 hl.gemspec
@@ -0,0 +1,29 @@
+# -*- 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{TODO: Write a gem summary}
+ s.description = %q{TODO: Write a gem description}
+
+ 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"]
+
+ # specify any dependencies here; for example:
+ # s.add_development_dependency "rspec"
+ # s.add_runtime_dependency "rest-client"
+ s.add_development_dependency('rdoc')
+ 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')
+end
5 lib/hl.rb
@@ -0,0 +1,5 @@
+require "hl/version"
+
+module Hl
+ # Your code goes here...
+end
3  lib/hl/version.rb
@@ -0,0 +1,3 @@
+module Hl
+ VERSION = "0.0.1"
+end
7 test/tc_something.rb
@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class TestSomething < Test::Unit::TestCase
+ def test_truth
+ assert true
+ end
+end
Please sign in to comment.
Something went wrong with that request. Please try again.