ruby_cli 0.0.3 → 0.0.4

data/README.rdoc

@@ -7,7 +7,7 @@ License:: Distributed under the same terms as Ruby
 = Description 
 
 "RubyCLI" is a Ruby library which factors out the code needed to create Ruby 
-programswith a command line interface (CLI) which follows the Unix Philosophy 
+programs with a command line interface (CLI) and that follow the Unix Philosophy 
 design method outlined in http://www.faqs.org/docs/artu/ch01s06.html.
 
 Currently, RubyCLI is short and simple. It uses Ruby's core 
@@ -22,7 +22,20 @@ What does a command line application library need to do?
 2. Pass options and arguments as parameters to other functions defined in libraries or other executables.
 
 What does a command line application library need not do?
-	1. A command line application does not need to validate options or arguments. Libraries or other executables should do this.
+1. A command line application does not need to validate options or arguments. 
+   * Libraries or other executables should do this.
+
+This is the core algorithm of any Ruby CLI application
+ def run
+   if parse_options? && arguments_Valid?
+     process_options
+     process_arguments
+     output_options_and_arguments# def run
+     command
+   else
+     output_help(1)
+   end
+ end
 
 = Installation
 
@@ -33,57 +46,55 @@ gem install ruby_cli
 There are other tools out there which can be used to write command line 
 applications. 
 
-1. clamp[http://github.com/mdub/clamp]
-   * I don't like to learn new DSLs
-2. optparse[http://ruby-doc.org/stdlib/libdoc/optparse/rdoc/index.html]
-   * This library uses this to parse options.
-3. Thor[http://github.com/wycats/thor]
-   * It does not try to follow the Unix Philosophy.
-4. Clip[http://clip.rubyforge.org/]
-   * OptionParser already exists.
+1. clamp[http://github.com/mdub/clamp] - I don't like to learn new DSLs
+2. optparse[http://ruby-doc.org/stdlib/libdoc/optparse/rdoc/index.html] - This library uses this to parse options.
+3. Thor[http://github.com/wycats/thor] - It does not try to follow the Unix Philosophy.
+4. Clip[http://clip.rubyforge.org/] - OptionParser already exists.
 
 = Usage
 
-0. New File
-1. Require the ruby_cli gem.
-2. Create a Ruby class. 
-3. Call it "App", for example.  
-4. Include the RubyCLI module.
-5. Define the command method.
-	* This is where your program does the actual work.  
-	* At this point you have options and arguments available.
-	* Pass them as parameters to library functions or as options/arguments to other executables.
-	* Be smart!  Have libraries and other executables do the heavy work.  
-	* Be smart!  Fewer lines of code (LOC) is good.
-6. Define command options and defaults (optional)
-	* This is where you define a hash for your options and set the default values.
-	* Remember, options by definition are optional.
-7. Define command arguments and defaults (optional)
-
-= Usage Example
+1. New File
+2. Require the ruby_cli gem.
+3. Create a Ruby class. 
+4. Call it "App", for example.  
+5. Include the RubyCLI module.
+6. Define the command method.
+   * This is where your program does the actual work.  
+   * At this point you have options and arguments available.
+   * Pass them as parameters to library functions or as options/arguments to other executables.
+   * Be smart!  Have libraries and other executables do the heavy work.  
+   * Be smart!  Fewer lines of code (LOC) here is an indication that your code will be easy to maintain.
+7. Define command options and defaults (optional)
+   * This is where you define a hash for your options and set the default values.
+   * Remember, options by definition are optional.
+8. Define command arguments and defaults (optional)
+
+= Usage Example 1
 
 This example demonstrates how to use RubyCLI to create a 
-	#!/usr/bin/ruby
 
-	require 'ruby_cli'
+ #!/usr/bin/ruby
 
-	class App
-		include RubyCLI	
+ require 'ruby_cli'
 
-		def command
-			puts "hello world"
-		end
+ class App
+   include RubyCLI	
 
-	end
+ def command
+   puts "hello world"
+ end
 
-	if __FILE__ == $0
-		app = App.new(ARGV)
-		app.run
-	end
+ end
+
+ if __FILE__ == $0
+   app = App.new(ARGV) 
+   app.run
+ end
 
 = Dependencies
 
 * Ruby 1.8.7 or greater
+* None other
 
 = Acknowledgements
 

data/lib/ruby_cli.rb

@@ -4,32 +4,7 @@ require 'optparse'
 # command line applications which follow the Unix Philosophy design method 
 # (http://www.faqs.org/docs/artu/ch01s06.html).
 #
-# What does a command line application library need to do?
-#	1. Provide a UI
-#	a. Process options (use Ruby's Option Parser)
-# b. Process arguments
-# 2. Pass options and arguments as parameters to other functions defined in
-#	libraries or other executables.
-#
-# What does a command line application library need not do?
-# 1. A command line application does not need to validate options or arguments.
-# Libraries or other executables should do this.
-#
-# This module serves as a mixin for Ruby Command Line Applications (CLI).
-# Ruby commands can be written much easier by including this class and following
-# the convention that I have outlined here.
-#
-# This is the core algorithm of any Ruby CLI application.
-# def run
-#   if parse_options? && arguments_valid?
-#		process_options
-#     process_arguments
-#     output_options_and_arguments if @default_options[:verbose]
-#     command
-#   else
-#     output_help(1)
-#   end
-#  end
+# See README.rdoc for more information. 
 module RubyCLI
 
 	# Initialization of this application requires the command line arguments.
@@ -62,7 +37,6 @@ module RubyCLI
     end
   end
 		
-		
 	# Parse the options
 	# Redefine this method if you want to add command specific options
 	def parse_options?
@@ -78,17 +52,17 @@ module RubyCLI
 			opts.on('-V','--verbose','Run verbosely') do 
 				@default_options[:verbose] = true
 			end
-			# TODO: If you redefine, you can add command specific options here!
+			# If you redefine, you can add command specific options here!
 		end
 		@opt_parser.parse!(@default_argv) rescue return false
-		true
+		return true
 	end
 
 	# Check if the required number of arguments remains in the 
 	# argv array after it has been processed by the option parser
 	def arguments_valid?() 
 		return true if @arguments.size == 0
-		@default_argv.size == @arguments.size 
+		return @default_argv.size == @arguments.size 
 	end
 
 	def output_options_and_arguments

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_cli
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Martin Velez
@@ -15,14 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-11 00:00:00 -08:00
+date: 2011-11-27 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
 description: Factors out code needed to create Ruby command line applications
 email: mvelez999@gmail.com
-executables: 
-- hello_world
+executables: []
+
 extensions: []
 
 extra_rdoc_files: []
@@ -30,7 +29,7 @@ extra_rdoc_files: []
 files: 
 - lib/ruby_cli.rb
 - README.rdoc
-- bin/hello_world
+- examples/hello_world
 - test/test_ruby_cli.rb
 - Rakefile
 has_rdoc: true
@@ -47,7 +46,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -56,7 +54,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"