tagfu 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 by Avinash Padmanabhan
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.

data/README.md

@@ -0,0 +1,60 @@
+Tagfu - Cucumber Tag Manipulation
+=================================
+
+Description
+-----------
+
+Tagfu is a command line utility for manipulating tags in Cucumber feature files
+
+With Tagfu, you can easily add, update, delete specific tags or delete all tags from Cucumber feature files.
+Tagfu can operate on a specific feature file or on all the feature files within a specified folder structure.
+
+Features
+--------
+
+- Manipulate tags for a specific feature file or all the feature files within a specified folder
+- Add one or multiple tags at the feature level
+- Update existing tags
+- Delete specific tags
+- Delete all tags 
+
+Installation
+------------
+
+`gem install tagfu`
+
+Synopsis
+--------
+
+Access the command line help
+
+`tagfu --help`
+
+Add tags to the Cucumber feature file(s) in the current directory
+
+`tagfu -p . -a wip,smoke`  
+`tagfu -p . -a @wip,@smoke`
+
+Update tags in the specified Cucumber feature file
+
+`tagfu -p story.feature -u wip,smoke`  
+`tagfu --path story.feature --update @wip,@smoke`
+
+Delete tags from the Cucumber feature file(s) in the specified folder path
+
+`tagfu --path /usr/home/jdoe/project/features --delete wip,hacky` 
+
+Delete all tags from Cucumber feature file(s) in the current directory
+
+`tagfu --path . --delete-all`
+
+Bugs
+----
+
+Report bugs and requests at [the Github page](https://github.com/eveningsamurai/tagfu).
+
+
+Copyright
+---------
+
+Copyright 2012 by [Avinash Padmanabhan](http://eveningsamurai.wordpress.com) under the MIT license (see the LICENSE file).

data/bin/tagfu

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'tagfu'
+
+Tagfu.run(*ARGV)

data/lib/tagfu/tagger.rb

@@ -0,0 +1,115 @@
+module Tagfu
+
+	class Tagger
+		def initialize(options={})
+			@add_tags    = options[:add_tags]
+			@update_tags = options[:update_tags]
+			@delete_tags = options[:delete_tags]
+			@delete_all  = options[:delete_all]
+			@path        = options[:path]
+		end
+		
+		def sanitize_tags(tags)
+			tags.collect! {|tag| tag.match(/^@/) ? tag : "@#{tag}"}
+		end
+
+		def get_files
+			if File.directory?(@path)
+				current_working_dir = Dir.pwd
+				Dir.chdir(@path)
+				files = Dir.glob("**/*.feature")
+				raise ArgumentError, "No cucumber feature files in specified path" if files.empty?
+				files.each {|file| process_file(file)}
+				Dir.chdir(current_working_dir)
+			elsif File.file?(@path)
+				process_file(@path)
+			else
+				raise ArgumentError, "Path specified is either invalid or not a file/directory"
+			end
+		end
+
+		def process_file(file)
+			lines = File.readlines(file)
+			if @delete_all
+				delete_all(lines)
+			end
+			unless @delete_tags.nil?
+				sanitize_tags(@delete_tags)
+				delete_tags(lines)
+			end
+			unless @add_tags.nil?
+				sanitize_tags(@add_tags)
+				add_tags(lines)
+			end
+			unless @update_tags.nil?
+				sanitize_tags(@update_tags)
+				@update_tags = {:from_tag => @update_tags.first, :to_tag => @update_tags.last}
+				update_tags(lines)
+			end
+			File.open(file, 'w') do |fh|
+				lines.each do |line|
+					fh.write line
+				end			
+			end
+		end
+
+		def delete_all(lines)
+			lines_to_delete = []
+			lines.each_with_index do |line, index|
+				if line.match(/@/)
+					lines_to_delete << index
+				end
+			end
+			running_index = 0
+			lines_to_delete.each do |line_index|
+				lines.delete_at(line_index - running_index)
+				running_index += 1
+			end
+		end
+
+		def delete_tags(lines)
+			@delete_tags.each do |tag|
+				lines.each_with_index do |line, index|
+					if only_tag?(line, tag)
+						lines.delete_at(index)
+					else	
+						indent = lines[index][/^\s+/].to_s
+						line = line.strip
+						next if line.empty?
+						lines[index] = indent + line.chomp.split(' ').delete_if {|word| word.match(/#{tag}/)}.join(' ') + "\n" if line.match(/^@/)
+					end
+				end
+			end
+		end
+
+		def only_tag?(line, tag)
+			return line.strip == tag
+		end
+
+		def add_tags(lines)
+			feature_index = find_index_of_feature(lines)
+			indent = lines[feature_index][/^\s+/].to_s
+			lines.insert(feature_index, indent + @add_tags.join(' ') + "\n")
+		end
+
+		def find_index_of_feature(lines)
+			lines.each_with_index do |line, index|
+				return index if line.strip.match(/^Feature:/)
+			end
+		end
+
+		def update_tags(lines)
+			lines.each_with_index do |line, index|
+				indent = lines[index][/^\s+/].to_s
+				if only_tag?(line, @update_tags[:from_tag])
+					lines.delete_at(index)
+					lines.insert(index, indent + "#{@update_tags[:to_tag]}\n")
+				else
+					line = line.strip
+					next if line.empty?
+					lines[index] = indent + line.chomp.split(' ').map! {|word| word == "#{@update_tags[:from_tag]}" ? "#{@update_tags[:to_tag]}" : word}.join(' ') + "\n" if line.match(/^@/)
+				end
+			end
+		end
+	end
+end

data/lib/tagfu/version.rb

@@ -0,0 +1,3 @@
+module Tagfu
+	VERSION = "1.0.0"
+end

data/lib/tagfu.rb

@@ -0,0 +1,56 @@
+require 'optparse'
+require 'tagfu/tagger'
+
+module Tagfu
+	def self.run(*args)
+		options = {}
+
+		option_parser = OptionParser.new do |opts|
+			opts.banner = 'Usage: tagfu [PATH] [OPTIONS]'
+
+			opts.on('-d', '--delete TAG1,TAG2', Array, 'Delete comma seperated list of tags from scenario(s), e.g. smoke, regression, wip') do |tags|
+				options[:delete_tags] = tags
+			end
+
+			opts.on('--delete-all', 'Delete all tags from specified feature files') do |t|
+				options[:delete_all] = true
+			end
+
+			opts.on('-u', '--update FROM_TAG,TO_TAG', Array, 'Update tag names in scenario(s) e.g. "wip" to "smoke"') do |tags|
+				options[:update_tags] = tags
+			end
+
+			opts.on('-a', '--add TAG1,TAG2', Array, 'Add comma seperated list of tags at the feature level, e.g. smoke, regression, wip') do |tags|
+				options[:add_tags] = tags
+			end
+	
+			opts.on('-p PATH', '--path PATH', 'Path to the cucumber feature file(s)') do |path|
+				options[:path] = path
+			end
+		end
+
+		begin 
+			option_parser.parse!
+			raise OptionParser::MissingArgument, "Atleast one of the options '--update', '--delete', '--add' or '--delete-all' should be specified" if op_tags_absent?(options)
+			raise OptionParser::MissingArgument, "Path '--path' should be specified" if path_absent?(options[:path])
+		rescue OptionParser::ParseError => e
+			puts e.message
+			puts
+			puts option_parser
+			exit -1
+		end
+
+		Tagger.new(options).get_files
+	end
+	
+	def self.op_tags_absent?(options)		
+		tags = [:update_tags, :delete_tags, :add_tags, :delete_all]
+		(tags & options.keys).empty?
+	end
+
+	def self.path_absent?(path)
+		path.nil?
+	end
+	
+end
+

data/spec/tagger_spec.rb

@@ -0,0 +1,164 @@
+require '../lib/tagfu/tagger.rb'
+require 'rspec/expectations'
+require 'tmpdir'
+
+RSpec.configure do |config|
+	@dir = Dir.mktmpdir
+	config.before(:all) do
+		files = {
+			:no_tags => 
+			"""
+				Feature: No Tags in feature file
+				
+				Scenario: sample story
+					Given I have a feature file with no tags
+					When I run it through the tagger
+					Then I see nothing changed
+			""",
+			:add_tags => 
+			"""
+				Feature: No Tags in feature file
+				
+				Scenario: sample story
+					Given I have a feature file with no tags
+					When I run it through the tagger
+					Then I see nothing changed
+			""",
+			:one_tag_to_delete =>
+			"""
+				@wip
+				Feature: One tag to delete in feature file		
+				
+				Scenario: sample story
+					Given I have a feature file with one tag
+					When I run it through the tagger
+					Then I see that the tag has been deleted
+			""", 
+			:one_tag_add_update => 
+			"""
+				Feature: No Tags in feature file
+				
+				@pass
+				Scenario: sample story
+					Given I have a feature file with no tags
+					When I run it through the tagger
+					Then I see nothing changed
+			""",
+			:one_tag_to_update =>
+			"""
+				@wip
+				Feature: One tag to update in feature file		
+				
+				Scenario: sample story
+					Given I have a feature file with one tag
+					When I run it through the tagger
+					Then I see that the tag has been updated
+			""",
+			:three_tags_delete_update =>
+			"""
+				Feature: Three tags to update in feature file		
+				
+				@wip @story1 @story2
+				@story3
+				Scenario: sample story
+					Given I have a feature file with three tags
+					When I run it through the tagger
+					Then I see that the tags has been updated
+			""",
+			:four_tags_add_delete =>
+			"""
+				@wip @story1
+				Feature: One tag to update in feature file		
+				
+				@wip 
+				@story1 
+				@story2
+				Scenario: sample story
+					Given I have a feature file with three tags
+					When I run it through the tagger
+					Then I see that the tags has been updated
+			""",
+			:all_tags_delete =>
+			"""
+				@wip @smoke
+				@story1
+				Feature: One tag to delete in feature file		
+					
+				@story2
+				@story3 @story4
+				Scenario: sample story
+					Given I have a feature file with one tag
+					When I run it through the tagger
+					Then I see that the tag has been deleted
+			""" 
+		}
+		files.each_pair do |feature_name, feature|
+			File.open("#{feature_name.to_s}.feature", 'w') { |f| f.write(feature) }
+		end
+	end
+
+	config.after(:all) do
+		#FileUtils.remove_entry_secure @dir
+		files = Dir.glob("*.feature")
+		files.each {|file| File.unlink(file)}
+	end
+
+	describe Tagfu::Tagger do
+		it "should not change feature file when no tags present" do
+			file = "no_tags.feature"
+			file_before = File.readlines(file)
+			Tagfu::Tagger.new({:path => file, :delete_tags => ["smoke"]}).get_files
+			File.readlines(file).each_with_index do |line, index|
+				line.should == file_before[index]
+			end
+		end
+
+		it "should update tags when present in feature file" do
+			file = "one_tag_to_update.feature"
+			Tagfu::Tagger.new({:path => file, :update_tags => ["wip", "woot"]}).get_files
+			File.readlines(file).any? {|line| line =~ /@wip/}.should be_false
+			File.readlines(file).any? {|line| line =~ /@woot/}.should be_true
+		end
+
+		it "should delete tags when present in feature file" do
+			file = "one_tag_to_delete.feature"
+			Tagfu::Tagger.new({:path => file, :delete_tags => ["wip"]}).get_files
+			File.readlines(file).any? {|line| line =~ /@/}.should be_false
+		end
+
+		it "should add tags to feature file" do
+			file = "add_tags.feature"
+			Tagfu::Tagger.new({:path => file, :add_tags => ["wip"]}).get_files
+			File.readlines(file).any? {|line| line =~ /@wip/}.should be_true
+		end
+
+		it "should add/update tags in feature file" do
+			file = "one_tag_add_update.feature"
+			Tagfu::Tagger.new({:path => file, :add_tags => ["wip", "woot"], :update_tags => ["pass", "smoke"]}).get_files
+			File.readlines(file).any? {|line| line =~ /@smoke/}.should be_true
+		end
+
+		it "should delete/update tags in feature file" do
+			file = "three_tags_delete_update.feature"
+			Tagfu::Tagger.new({:path => file, :delete_tags => ["wip", "story3"], :update_tags => ["story1", "smoke"]}).get_files
+			File.readlines(file).any? {|line| line =~ /@story3/}.should be_false
+			File.readlines(file).any? {|line| line =~ /@wip/}.should be_false
+			File.readlines(file).any? {|line| line =~ /@smoke/}.should be_true
+		end
+
+		it "should add/delete tags in feature file" do
+			file = "four_tags_add_delete.feature"
+			Tagfu::Tagger.new({:path => file, :delete_tags => ["wip", "story1"], :update_tags => ["story2", "story3"]}).get_files
+			File.readlines(file).any? {|line| line =~ /@story1/}.should be_false
+			File.readlines(file).any? {|line| line =~ /@wip/}.should be_false
+			File.readlines(file).any? {|line| line =~ /@story2/}.should be_false
+			File.readlines(file).any? {|line| line =~ /@story3/}.should be_true
+		end
+
+		it "should delete all tags in feature file" do
+			file = "all_tags_delete.feature"
+			Tagfu::Tagger.new({:path => file, :delete_all => true}).get_files
+			File.readlines(file).any? {|line| line =~ /@/}.should be_false
+		end
+	end
+end

data/tagfu.gemspec

@@ -0,0 +1,19 @@
+require './lib/tagfu/version.rb'
+
+Gem::Specification.new do |s|
+  s.name        = 'tagfu'
+  s.version     = Tagfu::VERSION
+  s.date        = '2012-09-22'
+  s.summary     = "tagfu"
+  s.description = "A gem to manipulate tags in cucumber feature files"
+  s.authors     = ["Avinash Padmanabhan"]
+  s.email       = ['avinashpadmanabhan@gmail.com']
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = "https://github.com/eveningsamurai/tagfu"
+
+	s.add_development_dependency "OptionParser"
+	s.add_development_dependency "rspec"
+	s.require_paths = ["lib"]
+
+	s.executables << 'tagfu'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: tagfu
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Avinash Padmanabhan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: OptionParser
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to manipulate tags in cucumber feature files
+email:
+- avinashpadmanabhan@gmail.com
+executables:
+- tagfu
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- bin/tagfu
+- lib/tagfu.rb
+- lib/tagfu/tagger.rb
+- lib/tagfu/version.rb
+- spec/tagger_spec.rb
+- tagfu.gemspec
+homepage: https://github.com/eveningsamurai/tagfu
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: tagfu
+test_files: []