stdouttoggler 0.5.1.pre → 1.0.0

data/README.txt

@@ -2,14 +2,14 @@
 
 Standard Out Toggler is an executable gem that comments and uncomments 
 output lines from a variety of different file types. Out of the box, this gem 
-handles java, javascript (in .js and .jsp files), and ruby. You can configure it to handle 
-any file type of your choice.
+handles java, javascript (in .js and .jsp files), ruby, and perl files. 
+You can configure it to handle any file type of your choice.
 
 == Use Case
 
 Sometimes when debugging, developers add output statements to code,
-for example alert statements to javascript code or System.out.println
-statements to java code. Then they discover need temporarily to comment out the statements 
+for example alert statements to javascript or System.out.println
+statements to java. Then they discover need temporarily to comment out the statements 
 from some files, because they're cluttering up the console or because they get tired
 of crawling through javascript alerts. Later, they may need to uncomment them again.
 
@@ -20,7 +20,7 @@ or uncommenting output lines from a command prompt.
 
 Run the executable from a directory of your choice using the toggle command.
 The only required option is the instruction option (-i), which tells stdouttoggler
-whether to comment or uncomment. Add one or more files as args (relative or absolute paths), 
+whether to comment or uncomment output lines. Add one or more files as args (relative or absolute paths), 
 and run the program. For example:
 
 toggle -i comment JavaFile.java C:/programs/JavaScriptFile.js
@@ -31,7 +31,7 @@ toggle -i comment JavaFile.java C:/programs/JavaScriptFile.js
 <tt>-i <comment|uncomment></tt>:: Tells stdouttoggler whether to comment or uncomment output lines.
 <tt>-b</tt>:: Saves a backup of any changed file.
 <tt>-f</tt>:: Tells stdouttoggler to find files for commenting or uncommenting in a file called file_names.yaml, which you put in the current directory. This can come in handy if you're changing a lot of files or using files with long paths. Note that if you use this option, you cannot put any files on the command line.
-<tt>-c</tt>:: Tells stdouttoggler that you're adding additional file types to the default java, javascript, JSP, and ruby types, using a file called  additional_types.yaml in the current directory.
+<tt>-c</tt>:: Tells stdouttoggler that you're adding additional file types, using a file called  additional_types.yaml in the current directory.
 
 Here are some sample commands:
 
@@ -42,7 +42,7 @@ toggle -i comment JavaFile.java C:/programs/JavaScriptFile.js
 
 toggle -i uncomment JavaFile.java C:/programs/JavaScriptFile.js
 
-* Uncomments out all System.out.print and System.out.println statements in the java file, 
+* Uncomments all System.out.print and System.out.println statements in the java file, 
   and all the alert statements in the javascript file.
 
 toggle -i comment -b JavaFile.java
@@ -72,7 +72,7 @@ In the examples folder you'll find a sample YAML file called file_names.yaml tha
 files to comment/uncomment. You can use that file as a template for adding your own files, 
 using relative or absolute paths.
 
-Activate this file using the <tt>-f</tt> option. Note that if you use this option, you 
+Activate this file using the -f option. Note that if you use this option, you 
 cannot put any files as arguments on the command line.
 
 == Configuration

data/lib/stdouttoggler/application.rb

@@ -7,9 +7,9 @@ require 'yaml'
 
 module StdOutToggler
 
-	#parses and validates command line options and configuration;
-	#runs the application;
-	#key instance variables:
+	#Parses and validates command line options and configuration;
+	#runs the application.
+	#Key instance variables:
 	#@options: command line options
 	#@stdout_type_maps: used to generate the regex class methods
 	#@files: list of files to comment/uncomment
@@ -23,7 +23,7 @@ module StdOutToggler
 			validate_stdout_type_maps
 		end
 	
-		#parses command line options
+		#Parses command line options
 		def prepare_options
 			@options = {}
 			begin
@@ -53,7 +53,7 @@ module StdOutToggler
 			end
 		end
 		
-		#ensures that we have the required instruction command
+		#Ensures that we have the required instruction command
 		def validate_instruction
 			unless @options[:instruction]
 				puts "You need to have an -i (or --instruction) flag with an argument indicating comment or uncomment"
@@ -61,7 +61,7 @@ module StdOutToggler
 			end	
 		end
 		
-		#builds the list of files designated for commenting/uncommenting
+		#Builds the list of files designated for commenting/uncommenting
 		def prepare_files
 			if @options[:file]
 				unless ARGV.length == 0
@@ -91,7 +91,7 @@ module StdOutToggler
 			end		
 		end
 		
-		#builds the list of type maps used to dynamically generate methods
+		#Builds the list of type maps used to dynamically generate methods
 		#in the stdout_regex class
 		def build_stdout_type_maps
 			default_stdout_type_maps = [] 		#part of gem configuration
@@ -121,7 +121,7 @@ module StdOutToggler
 			@stdout_type_maps = (default_stdout_type_maps + configured_stdout_type_maps).uniq
 		end
 		
-		#ensures that all type maps are valid
+		#Ensures that all type maps are valid
 		def validate_stdout_type_maps
 			type_maps_validator = TypesValidator.new(@stdout_type_maps)
 
@@ -149,7 +149,7 @@ module StdOutToggler
 			end		
 		end
 		
-		#comment/uncomment designated files, per command line instruction
+		#Comment/uncomment designated files, per command line instruction
 		def run
 			@stdout_type_maps.each do |type_map|
 				StdOutRegex::Producer.create_methods_for_producing_stdout_regex_strings(type_map)
@@ -202,7 +202,7 @@ module StdOutToggler
 				
 		end
 		
-		#displays results
+		#Displays results
 		def notify
 			file_string = @files.reduce(""){|a,file| a << (file + ", ")}.chop.chop
 			puts "All standard output lines in #{file_string} have been #{@options[:instruction]}ed#{@options[:instruction] == "comment" ? " out" : ""}."		

data/lib/stdouttoggler/file_writer.rb

@@ -1,6 +1,6 @@
 module StdOutToggler
 
-	#provides a clean, testable interface that
+	#Provides a clean, testable interface that
 	#handles the process of commenting out a file
 	class FileWriter
 		def self.modify_file(input_file_handle, output_file_handle, stdout_regex)

data/lib/stdouttoggler/regex/stdout_regex.rb

@@ -9,7 +9,7 @@ module StdOutToggler
 	#See lib/stdouttoggler/types.rb for the default list of maps used by stdouttoggler.
 	module StdOutRegex
 
-		#data type for regex and substitution strings
+		#Data type for regex and substitution strings
 		class Holder
 			attr_accessor :regex_interpolation, :substitution_string_interpolation
 			def initialize(regex_interpolation, substitution_string_interpolation)
@@ -17,7 +17,7 @@ module StdOutToggler
 			end
 		end
 
-		#uses dynamically generated methods to produce necessary regexes and string substitutions for files
+		#Uses dynamically generated methods to produce necessary regexes and string substitutions for files
 		class Producer
 			#From the options map argument, this macro creates methods of the form <type>_comment_regex and <type>_uncomment_regex,
 			#for example: java_comment_regex and java_uncomment_regex

data/lib/stdouttoggler/types.rb

@@ -1,6 +1,6 @@
 module StdOutToggler
 
-	#class to hold our default file types
+	#Class to hold our default file types
 	class Types
 		attr_accessor :type_maps
 		def initialize
@@ -9,6 +9,7 @@ module StdOutToggler
 			type_maps[1] = {:type => "javascript", :extension => ".js", :keyword => "alert", :comment_string => "//", :comment_string_escaped => "\\/\\/"}
 			type_maps[2] = {:type => "jsp", :extension => ".jsp", :keyword => "alert", :comment_string => "//", :comment_string_escaped => "\\/\\/"}
 			type_maps[3] = {:type => "ruby", :extension => ".rb", :keyword => "puts", :comment_string => "#", :comment_string_escaped => "#"}
+			type_maps[4] = {:type => "perl", :extension => ".pl", :keyword => "print", :comment_string => "#", :comment_string_escaped => "#"}
 		end
 	end
 	

data/lib/stdouttoggler.rb

@@ -10,7 +10,7 @@
 require 'stdouttoggler/application.rb'
 require 'pathname'
 
-#application namespace
+#Application namespace
 module StdOutToggler
 	#returns the name of the executable file
 	def self.executable

data/stdouttoggler.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name="stdouttoggler"
-	s.version="0.5.1.pre"
+	s.version="1.0.0"
 	s.platform=Gem::Platform::RUBY
 	s.date="2012-09-14"
 	s.summary="Comments and uncomments output lines in code"

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: stdouttoggler
 version: !ruby/object:Gem::Version
-  version: 0.5.1.pre
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Mark Buechler
@@ -52,9 +52,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24