stdouttoggler 0.5.0.pre → 0.5.1.pre

data/README.txt

@@ -1,129 +1,89 @@
 = Standard Out Toggler
 
-Standard Out Toggler is a simple executable gem that comments and uncomments 
+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, and ruby files. You can configure it to handle 
+handles java, javascript (in .js and .jsp files), and ruby. You can configure it to handle 
 any file type of your choice.
 
 == Use Case
 
-Often when debugging, I find myself adding output statements to code,
-for example alert statements to javascript code and System.out.println
-statements to java code. Then I discover I need to comment out the statements 
-from some files, because they're cluttering up my console, or because I get tired
-of crawling through javascript alerts. Later, I might need to uncomment them again.
+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 
+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.
 
-So I wrote a straightforward ruby program to do what I needed, with support
-for java and javascript.
-
-When I decided to add JSP files to the mix, and had to hard code another set
-of constants and and case statements, I realized that this was a prime opportunity
-for ruby metaprogramming.
-
-As a result, Standard Out Toggler dynamically builds support for default file types
-from a config file in the lib/config directory and offers you the option
-to add additional types via a YAML file in the current directory.
+The Standard Out Toggler gem solves this problem by automatically commenting
+or uncommenting output lines from a command prompt.
 
 == Running the program
 
-Run the executable from a directory of your choice using the stdouttoggler command.
+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), 
 and run the program. For example:
 
->toggle -i comment JavaFile.java C:/programs/JavaScriptFile.js
+toggle -i comment JavaFile.java C:/programs/JavaScriptFile.js
 
 == Command Line Options
 
--h						Help screen.
-
--i <comment|uncomment>	Tells stdouttoggler whether to comment or uncomment output lines.
-
--b						Saves a backup of any changed file.
-
--f						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 can't put any files on the command line.
-						
--c						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>-h</tt>:: Help screen.
+<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.
 
 Here are some sample commands:
 
->stdouttoggler -i comment JavaFile.java C:/programs/JavaScriptFile.js
-
-Comments out 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 JavaFile.java C:/programs/JavaScriptFile.js
 
->toggle -i uncomment JavaFile.java C:/programs/JavaScriptFile.js
+* Comments out all System.out.print and System.out.println statements in the java file, 
+  and all the alert statements in the javascript file.
 
-Uncomments out all System.out.print and System.out.println statements 
-in the java file, and all the alert statements in the javascript file.
+toggle -i uncomment JavaFile.java C:/programs/JavaScriptFile.js
 
->toggle -i comment -b JavaFile.java
+* Uncomments out all System.out.print and System.out.println statements in the java file, 
+  and all the alert statements in the javascript file.
 
-Comments out all System.out.print and System.out.println statements 
-in the java file and saves a backup (JavaFile.java.bak) of the original file.
+toggle -i comment -b JavaFile.java
 
->toggle -i comment -f
+* Comments out all System.out.print and System.out.println statements in the java file 
+  and saves a backup (JavaFile.java.bak) of the original file.
 
-Comments out all output statements in the file_names.yaml file in your
-current directory. See the Using a File section below for an explanation 
-of the structure of that file.
+toggle -i comment -f
 
->toggle -i comment -c AnotherFileType.al
+* Comments out all output statements in the file_names.yaml file in your current directory. 
+  See the Using a File section below for an explanation of the structure of that file.
 
-Comments out all the output statements in AnotherFileType.al
-in your current directory, based on configuration instructions in
-additional_types.yaml in your current directory. See the Configuration
-section below for an explanation of the structure of the YAML configuration file.
+toggle -i comment -c AnotherFileType.al
 
->toggle -i comment -f -c
+* Comments out all the output statements in AnotherFileType.al in your current directory, 
+  based on configuration instructions in additional_types.yaml in your current directory. 
+  See the Configuration section below for an explanation of the structure of the YAML configuration file.
 
-Comments out all output statements in the file_names.yaml file in your
-current directory, based on configuration instructions in
-additional_types.yaml in your current directory.
+toggle -i comment -f -c
 
-== Using a File
+* Comments out all output statements in the file_names.yaml file in your current directory, 
+  based on configuration instructions in additional_types.yaml in your current directory.
 
-In the templates folder you'll find a sample YAML file called file_names.yaml that lists
-files to comment/uncomment:
+== Using a File Instead of Command Line Arguments
 
---- 
-- JavaFile.java
-- ./JavaScriptFile.js
-- C:/programs/ruby/ruby_file.rb
-- AnotherLanguage.al
+In the examples folder you'll find a sample YAML file called file_names.yaml that lists 
+files to comment/uncomment. You can use that file as a template for adding your own files, 
+using relative or absolute paths.
 
-Note that you can use relative or absolute paths.
+Activate this file using the <tt>-f</tt> option. Note that if you use this option, you 
+cannot put any files as arguments on the command line.
 
 == Configuration
 
-In the templates folder you'll find a sample YAML configuration file called additional_types.yaml 
+In the examples folder you'll find a sample YAML configuration file called additional_types.yaml 
 that lists three (imaginary) additional languages for commenting/uncommenting. You can use this file
 as a template for types you wish to add.
 
----
-- :type: anotherlang
-  :extension: .al
-  :keyword: out
-  :comment_string: --
-  :comment_string_escaped: --
-- :type: otherlang
-  :extension: .ol
-  :keyword: print
-  :comment_string: //
-  :comment_string_escaped: \/\/
-- :type: rub
-  :extension: .rub
-  :keyword: putt
-  :comment_string: "#"
-  :comment_string_escaped: "#"
-
 The comment_string_escaped is the tricky one. It will be used in a regular expression,
 so if it contains metacharacters, they need to be escaped. Additionally, if any of the
 values use a character that means something special to the ruby interpreter, such as
 the hash sign, it must be put in quotation marks.
+
+Activate this file using the -c option. 

data/stdouttoggler.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name="stdouttoggler"
-	s.version="0.5.0.pre"
+	s.version="0.5.1.pre"
 	s.platform=Gem::Platform::RUBY
 	s.date="2012-09-14"
 	s.summary="Comments and uncomments output lines in code"
@@ -10,4 +10,7 @@ Gem::Specification.new do |s|
 	s.homepage="http://rubygems.org/stdouttoggler"
 	s.executables=["toggle"]
 	s.require_paths=["lib"]
+	s.has_rdoc=true
+	s.extra_rdoc_files=["README.txt"]
+	s.rdoc_options=["--main", "README.txt"]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stdouttoggler
 version: !ruby/object:Gem::Version
-  version: 0.5.0.pre
+  version: 0.5.1.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -17,7 +17,8 @@ email:
 executables:
 - toggle
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.txt
 files:
 - stdouttoggler.gemspec
 - Rakefile
@@ -37,7 +38,9 @@ files:
 homepage: http://rubygems.org/stdouttoggler
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --main
+- README.txt
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement