From f9767cd97eb9ace6e17d80718f36059edcc0b7c9 Mon Sep 17 00:00:00 2001 From: Adam Anderson Date: Fri, 10 Oct 2008 17:02:12 -0700 Subject: [PATCH] Updating README.txt so people are less likely to O_o --- README.txt | 58 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 39 insertions(+), 19 deletions(-) diff --git a/README.txt b/README.txt index 7bac804..303dca8 100644 --- a/README.txt +++ b/README.txt @@ -9,6 +9,9 @@ http://github.com/scudco/taglob/tree/master == FEATURES/PROBLEMS: * easily select tagged Ruby files +* rake tasks for test::unit and rspec +* rake task for checking against a valid list of tags +* can AND or OR tags == SYNOPSIS: @@ -35,31 +38,48 @@ Totally small, totally useless, totally taglob. Dir.taglob('**/*.rb','foo','bar','buttz').each {|file| puts "#{file} was tagged with foo or bar or buttz!"} +On a more serious note: + * Dir.taglob('**/*.rb','tags,for,the,win') <- Will produce an array of files that contain all these tags(AND) + * Dir.taglob('**/*.rb','tags|or|the|win') <- Will produce an array of files that contain any of these tags(OR) + * rake spec SPEC_OPTS='-f specdoc' <- More infroz(this obviously needs to be run from the gem directory :P) + * taglob binary! + * $ taglob <- produces a list of files in with their respective tags + * $ taglob <- produces a list of tags for that file + * Rake tasks! + * You can now require 'taglob/rake/tasks' in your Rakefile to get test_tag and spec_tag tasks that would be used like this: + * $ rake spec_tag tags="for,the,win" + * $ rake test_tag tags="foo|bar" + * You can also specify your own TestTagTasks in your Rakefile: + require 'taglob/rake' + + Taglob::Rake::SpecTagsTask.new :spec_regression do |t| + t.pattern = 'spec/**/*.rb' + t.tags = "regression|smoke" + end + Taglob::Rake::TestTagsTask.new :test_regression do |t| + t.pattern = 'test/**/*.rb' + t.tags = "regression|smoke" + end + * CheckTagsTask will check all tags in a glob pattern against a valid list of tags + require 'taglob/rake' + task = Taglob::Rake::CheckTagsTask.new do |t| + t.pattern = 'spec/**/*.rb' + t.valid_tag_source = 'config/valid_tags.txt' + end + + == INSTALL: * sudo gem install taglob -== LICENSE: +== UNINSTALL: -(The MIT License) +* sudo gem uninstall taglob -Copyright (c) 2008 Adam Anderson +== REINSTALL -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -'Software'), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: +* sudo gem install taglob -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. +== LICENSE: -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +The copyrights-are-an-imaginary-construct license.