ruby_cli 0.1.2 → 0.2.0

data/README.rdoc

@@ -1,10 +1,10 @@
-= Ruby CLI
+= RubyCLI
 
-Author:: Martin Velez
+Author:: {Martin Velez}[http://www.martinvelez.com]
 Copyright:: Copyright (c) 2011 Martin Velez
 License:: Distributed under the same terms as Ruby
 
-= Description 
+== Description 
 
 "RubyCLI" is a Ruby library which factors out the code needed to create Ruby 
 programs with a command line interface (CLI) and that follow the Unix Philosophy 
@@ -13,7 +13,7 @@ design method outlined in http://www.faqs.org/docs/artu/ch01s06.html.
 Currently, RubyCLI is short and simple. It uses Ruby's core 
 optparse[http://ruby-doc.org/stdlib/libdoc/optparse/rdoc/index.html] library.
 
-= Design
+== Design
 
 What does a command line application library need to do?
 1. Provide a user interface (UI)
@@ -22,7 +22,7 @@ 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. 
+1. Validate options or arguments. 
    * Libraries or other executables should do this.
 
 This is the core algorithm of any Ruby CLI application
@@ -37,7 +37,7 @@ This is the core algorithm of any Ruby CLI application
    end
  end
 
-= Installation
+== Installation
 
 Rubygems:
  gem install ruby_cli
@@ -46,7 +46,7 @@ Not Rubygems:
 1. use only files in lib folder
 2. Use the RubyCLI module as a mixin for your CLI application
 
-= Alternative Tools
+== Alternative Tools
 
 There are other tools out there which can be used to write command line 
 applications. 
@@ -56,7 +56,7 @@ applications.
 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
+== Usage
 
 1. New File
 2. Require the ruby_cli gem.
@@ -74,7 +74,7 @@ applications.
    * Remember, options by definition are optional.
 8. Define command arguments and defaults (optional)
 
-= Usage Example 1
+== Usage Example 1
 
 This example demonstrates how to use RubyCLI to create a command line application. 
 
@@ -101,16 +101,21 @@ This example demonstrates how to use RubyCLI to create a command line applicatio
 * Ruby 1.8.7 or greater
 * None other
 
-= Acknowledgements
+== Acknowledgements
 
-Todd Werth[http://blog.toddwerth.com/entries/5]
-* I used his Ruby command line application skeleton code.  I borrowed 
-some ideas from there.
+{Todd Werth}[http://blog.toddwerth.com/entries/5]
+* I used his Ruby command line application skeleton code.  I borrowed some ideas from there.
 
-= TODO
+== TODO
 
 * ?
 
-= Source Code
+== Development
 
-https://github.com/martinvelez/ruby_cli
+=== Source Repository
+ruby_cli is hosted on Github at: 
+ https://github.com/martinvelez/ruby_cli
+ 
+=== Issues and Bug Reports
+Get help, request features, and reports bugs here:
+ https://github.com/martinvelez/ruby_cli/issues

data/examples/hello_world

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 require 'ruby_cli'
 

data/lib/ruby_cli.rb

@@ -7,12 +7,13 @@ require 'optparse'
 # See README.rdoc for more information. 
 module RubyCLI
 
+	
 	# Initialization of this application requires the command line arguments.
 	def initialize(default_argv, command_name, usage = "[OPTIONS]... [ARGUMENTS]...")
 		@default_argv = default_argv
 		@default_options = {:help => false, :verbose => false}
-		define_command_options
-		define_command_arguments
+		initialize_command_options
+		initialize_command_arguments
 		@opt_parser = nil
 		@command_name = command_name
 		@usage = usage
@@ -20,11 +21,11 @@ module RubyCLI
 
 	# This method can be overwritten if you want to set defaults for your command
 	# specific options.
-	def define_command_options() @options = {} end
+	def initialize_command_options() @options = {} end
 	
 	# This method can be overwritten if you want to set defaults for your command
 	# specific arguments.
-	def define_command_arguments() @arguments = {} end
+	def initialize_command_arguments() @arguments = {} end
 	
 	# Run the application
   def run
@@ -38,10 +39,9 @@ module RubyCLI
     end
   end
 
-	# Redefine this method if you want to add command specific options	
-	def define_option_parser
-		#configure an OptionParser
-		OptionParser.new do |opts|		
+	# Parse the options
+	def parse_options?
+		@opt_parser = OptionParser.new do |opts|		
 			opts.banner = "Usage: #{@command_name} #{@usage}"
 			opts.separator ""
 			opts.separator "Specific options:"
@@ -53,16 +53,19 @@ module RubyCLI
 				@default_options[:verbose] = true
 			end
 			# If you redefine, you can copy this method and add command specific options here!
-		end
-	end
-
-	# Parse the options
-	def parse_options?
-		@opt_parser = define_option_parser	
+		end	
+		define_command_option_parsing
 		@opt_parser.parse!(@default_argv) rescue return false
 		return true
 	end
 
+	# Redefine this method if you have command specific options to tell
+	# the OptionParser object how to parse and handle your options
+	# Introduced in versio 0.2.0 to reduce LOC in CLI application
+	# @opt_parser is available at this point
+	def define_command_option_parsing() 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?() 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_cli
 version: !ruby/object:Gem::Version 
-  hash: 31
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Martin Velez
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-09 00:00:00 -08:00
+date: 2011-12-13 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -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"