Cmdline_Parser 0.1.0 → 0.1.1

data/README.txt

@@ -1,13 +1,45 @@
 Cmdline Parser
-______________
 
 I intended to design the command line parser to be embedded into my application. 
 However, since more and more project of mine include this as library, i decided to separate it out as gem so that
 i can share it with all my project instead. After all, if i update in one place, all my project received the update.
+Many thanks to Choice developer (http://choice.rubyforge.org/) chris[at]ozmm[dot]org for providing me the inspiration!
+
+The reason i didn't use choice is that I couldn't figure out how to control when i want it to parse. That's the reason
+the method name is parse_list, which trigger the parsing only when i need it with the data i provided, not only from ARGV.
 
 Please sent me comment of your usage of the library! I would love to hear that!
 
 Author : Chris Liaw
 Copyright : Chris Liaw
-License : GNU GPL
+License : GNU LGPL
+
+Usage:
 
+Create option:
+	require 'rubygems'
+	require 'cmdlineparser'
+	
+	parser = CmdlineParser.new
+	parser.choice :name do |option|
+		option.short = "-f"   	# short flag user need to enter
+		option.long = "--file" 	#long flag user need to enter
+		option.desc = "Specified which file to process" #description for this flag. Printed out in help message
+		option.has_value = true # or false as default. Indicate that the parser should store the value followed the flag or else parser ignore it
+		option.mandatory = true # or false as default. Indicate the option is a must and if missing, it will throw MissingArgumentException
+	end
+	
+	begin
+		parser.parse_list(ARGV) # parameter can be any list, ARGV just for sample. See test/test_cmdline_parser.rb for sample.
+	rescue MissingArgumentException => ex  # If any mandatory flag was not given by user, this error will be triggered. 
+		STDERR.puts "ERROR: #{ex.message}" # If a flag requires value but value not given, this error will also be triggered.
+	end
+	
+	if parser.name_obj.activated 	# check if user provide the flag. name => name_obj to differentiate user want the object instead the value
+		parser.name 				# return the value given by user
+	end
+	
+	parser.params 					# return any free parameter which is not tied to any flag. It could be the parameter for the function call.
+	
+	parser.show_help				# print out the help message.
+	

data/changeset.txt

@@ -0,0 +1,12 @@
+
+
+
+
+V0.1.1 (19th August 2009)
+[Added]		Attributes of missing_mandatory to allow client to query for which flag is missing
+[Added]		Sample usage in the README.txt
+[Edited]	Change the license from GPL to LGPL
+
+V0.1.0 (18th August 2009)
+* Initial release
+

data/lib/cmdline_parser.rb

@@ -1,16 +1,16 @@
 
 
 class CmdlineParser
-  attr_accessor :choices, :params
+  attr_accessor :choices, :params, :missing_mandatory
   
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
   
   def initialize(opt = {})
     @choices = []
     @short_map = {}
     @long_map = {}
     @params = []
-    @mandatory_choice = {}
+    @missing_mandatory = {}
     @search = {}
     @error_as_message = opt[:error_as_message]
     @error_as_message ||= false 
@@ -54,8 +54,8 @@ class CmdlineParser
           end
         end
         
-        if @mandatory_choice.keys.include? opt.name
-          @mandatory_choice.delete(opt.name)
+        if @missing_mandatory.keys.include? opt.name
+          @missing_mandatory.delete(opt.name)
         end
         
       elsif @long_map.keys.include? token
@@ -83,8 +83,8 @@ class CmdlineParser
           end
         end
         
-        if @mandatory_choice.keys.include? opt.name
-          @mandatory_choice.delete(opt.name)
+        if @missing_mandatory.keys.include? opt.name
+          @missing_mandatory.delete(opt.name)
         end
         
       else
@@ -94,9 +94,9 @@ class CmdlineParser
       end
     end
     
-    if @mandatory_choice.length > 0
+    if @missing_mandatory.length > 0
       msg = []
-      @mandatory_choice.values.each do |ch|
+      @missing_mandatory.values.each do |ch|
         msg << "#{ch.short} or #{ch.long}"
       end
       
@@ -149,7 +149,7 @@ class CmdlineParser
       @short_map[ch.short] = ch
       @long_map[ch.long] = ch
       if ch.mandatory == true
-        @mandatory_choice[ch.name] = ch
+        @missing_mandatory[ch.name] = ch
       end
     end
   end

metadata

@@ -25,6 +25,7 @@ description:
 specification_version: 2
 default_executable: 
 files: 
+- changeset.txt
 - README.txt
 - cmdlineparser.rb
 - lib/cmdline_parser.rb
@@ -43,12 +44,12 @@ requirements: []
 
 authors: 
 - Chris Liaw Man Cheon
-date: 2009-08-17 16:00:00 +00:00
+date: 2009-08-18 16:00:00 +00:00
 platform: ruby
 test_files: []
 
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 require_paths: 
 - .
 dependencies: []