Cmdline_Parser 0.1.0

data/README.txt

@@ -0,0 +1,13 @@
+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.
+
+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
+

data/cmdlineparser.rb

@@ -0,0 +1,3 @@
+
+#$:.unshift File.dirname(__FILE__)
+require 'lib/cmdline_parser'

data/lib/cmdline_parser.rb

@@ -0,0 +1,190 @@
+
+
+class CmdlineParser
+  attr_accessor :choices, :params
+  
+  VERSION = "0.1.0"
+  
+  def initialize(opt = {})
+    @choices = []
+    @short_map = {}
+    @long_map = {}
+    @params = []
+    @mandatory_choice = {}
+    @search = {}
+    @error_as_message = opt[:error_as_message]
+    @error_as_message ||= false 
+  end
+  
+  def choice(name)
+    opt = Opt.new
+    opt.name = name
+    yield opt
+    @choices << opt
+    @search[opt.name] = opt
+  end
+  
+  def parse_array(argv)
+    prepare_index
+    ignore_value = []
+    0.upto(argv.length-1) do |i|
+      token = argv[i].strip
+      if @short_map.keys.include? token
+        opt = @short_map[token]
+        opt.activated = true
+        if opt.has_value == true
+          tmpVal = argv[i+1]
+          if is_command(tmpVal)
+            if @error_as_message
+              STDERR.puts "Argument needed for flag #{token}"              
+            else
+              raise MissingArgumentException, "Argument needed for flag #{token}"
+            end
+          else
+            if tmpVal != nil
+              opt.value = tmpVal
+              ignore_value << tmpVal
+            else
+              if @error_as_message
+                STDERR.puts "Argument needed for flag #{token}"              
+              else
+                raise MissingArgumentException, "Argument needed for flag #{token}"
+              end
+            end
+          end
+        end
+        
+        if @mandatory_choice.keys.include? opt.name
+          @mandatory_choice.delete(opt.name)
+        end
+        
+      elsif @long_map.keys.include? token
+        opt = @long_map[token]
+        opt.activated = true
+        if opt.has_value == true
+          tmpVal = argv[i+1]
+          if is_command(tmpVal)
+            if @error_as_message
+              STDERR.puts "Argument needed for flag #{token}"              
+            else
+              raise MissingArgumentException, "Argument needed for flag #{token}"
+            end
+          else
+            if tmpVal != nil
+              opt.value = tmpVal
+              ignore_value << tmpVal
+            else
+              if @error_as_message
+                STDERR.puts "Argument needed for flag #{token}"              
+              else
+                raise MissingArgumentException, "Argument needed for flag #{token}"
+              end
+            end
+          end
+        end
+        
+        if @mandatory_choice.keys.include? opt.name
+          @mandatory_choice.delete(opt.name)
+        end
+        
+      else
+        if not ignore_value.include? token
+          @params << token
+        end
+      end
+    end
+    
+    if @mandatory_choice.length > 0
+      msg = []
+      @mandatory_choice.values.each do |ch|
+        msg << "#{ch.short} or #{ch.long}"
+      end
+      
+      if @error_as_message
+        STDERR.puts "Error : Flag #{msg.join(",")} is required for this command"              
+      else
+        raise MissingArgumentException,"Flag #{msg.join(",")} is required for this command"
+      end
+      
+    end
+    
+  end
+  
+  def show_help
+    STDOUT.puts ""
+    STDOUT.puts "Ruby Cmdline Parser version #{CmdlineParser::VERSION}"
+    STDOUT.puts ""
+    STDOUT.puts "   Available commands:"
+#    STDOUT.puts ""
+    @choices.each do |c|
+      STDOUT.print "%5s or %-12s" % [c.short, c.long]
+      if c.has_value
+        STDOUT.print "<param> "
+      else
+        STDOUT.print "        "
+      end
+      
+      if c.mandatory
+        STDOUT.print "[Required] "
+      else
+        STDOUT.print "           "
+      end
+      STDOUT.puts c.desc
+    end
+    STDOUT.puts ""
+    
+  end
+  
+  private
+  def is_command(token)
+    if token != nil
+      token[0].chr == "-" || token[0..1] == "--"
+    else
+      false
+    end
+  end
+  
+  def prepare_index
+    @choices.each do |ch|
+      @short_map[ch.short] = ch
+      @long_map[ch.long] = ch
+      if ch.mandatory == true
+        @mandatory_choice[ch.name] = ch
+      end
+    end
+  end
+  
+  alias :old_method_missing :method_missing
+  def method_missing(arg)
+    if @search[arg] != nil
+      return @search[arg].to_s
+    end
+    
+    if arg.to_s()[arg.to_s.length-4..-1] == "_obj"
+      key = arg.to_s()[0...-4]
+      if @search[key.to_sym] != nil
+        return @search[key.to_sym]
+      end
+    end
+    
+    old_method_missing(arg)
+    #puts "method missing! #{arg}"
+  end
+end
+
+class Opt
+  attr_accessor :name, :short, :long, :desc, :mandatory, :default, :value, :has_value, :activated
+  def initialize
+    @mandatory = false
+    @has_value = false
+    @activated = false
+  end
+
+  def to_s
+    value
+  end
+end
+
+class MissingArgumentException < Exception
+  
+end

data/test/test_cmdline.rb

@@ -0,0 +1,51 @@
+
+if __FILE__ == $0
+  require '../lib/cmdline_parser'
+  
+  parser = CmdlineParser.new
+  parser.choice :first do |opt|
+    opt.short = "-f"
+    opt.long = "--first"
+    opt.has_value = true
+    opt.mandatory = true
+    opt.desc = "First param"
+  end
+  
+  parser.choice :second do |opt|
+    opt.short = "-s"
+    opt.long = "--second"
+    opt.desc = "Second param"
+  end
+
+  parser.choice :third do |opt|
+    opt.short = "-t"
+    opt.long = "--third"
+    opt.desc = "Third param"
+    opt.has_value = true
+  end
+
+  begin
+    parser.parse_array(ARGV)
+  rescue MissingArgumentException => ex
+    STDERR.puts "Error : #{ex.message}"
+    parser.show_help
+    exit(1)
+  end
+  
+  parser.choices.each do |c|
+    if c.activated
+      STDOUT.print "Flag '#{c.name}' activated by user"
+    else
+      STDOUT.print "Flag '#{c.name}' not activated by user"
+    end
+    
+    if c.value
+      STDOUT.puts " with value '#{c.value}'"
+    else
+      STDOUT.puts ""
+    end
+  end
+  
+  STDOUT.puts "Extra parameter for command : #{parser.params.join(" , ")}"
+  
+end

data/test/test_cmdline_parser.rb

@@ -0,0 +1,50 @@
+
+require '../lib/cmdline_parser'
+require 'test/unit'
+
+class TestCmdlineParser < Test::Unit::TestCase
+  def test_output
+    list = ["-f","/media/share/testing.txt","--revision","10", "--mandatory","extra_parameter"]
+    parser = CmdlineParser.new
+    parser.choice :file do |opt|
+      opt.short = "-f"
+      opt.long = "--file"
+      opt.has_value = true
+      opt.desc = "File parameter"
+    end
+    
+    parser.choice :revision do |opt|
+      opt.short = "-r"
+      opt.long = "--revision"
+      opt.desc = "Particular revision"
+      opt.has_value = true
+    end
+    
+    parser.choice :mand do |opt|
+      opt.short = "-m"
+      opt.long = "--mandatory"
+      opt.desc = "Mandatory field!"
+      opt.mandatory = true
+    end
+    
+    parser.choice :ignore do |opt|
+      opt.short = "-i"
+      opt.long = "--ignore"
+      opt.desc = "meant to be ignore!"
+    end
+    
+    parser.parse_array(list)
+    
+    assert_equal(parser.file,list[1])
+    assert_equal(parser.file_obj.activated,true)
+    
+    assert_equal(parser.revision,list[3])
+    assert_equal(parser.revision_obj.activated,true)
+    
+    assert_equal(parser.mand_obj.activated,true)
+    
+    assert_equal(parser.ignore_obj.activated,false)
+    
+    assert_equal(parser.params,[list[5]])
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+email: omikron.tech@gmail.com
+cert_chain: []
+
+summary: Another Ruby command line parser, intended to be embedded into application.
+post_install_message: 
+extra_rdoc_files: 
+- README.txt
+homepage: 
+signing_key: 
+name: Cmdline_Parser
+rdoc_options: []
+
+autorequire: cmdlineparser.rb
+rubyforge_project: 
+executables: []
+
+description: 
+specification_version: 2
+default_executable: 
+files: 
+- README.txt
+- cmdlineparser.rb
+- lib/cmdline_parser.rb
+- test/test_cmdline_parser.rb
+- test/test_cmdline.rb
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+extensions: []
+
+rubygems_version: 1.3.1
+requirements: []
+
+authors: 
+- Chris Liaw Man Cheon
+date: 2009-08-17 16:00:00 +00:00
+platform: ruby
+test_files: []
+
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+require_paths: 
+- .
+dependencies: []
+
+bindir: bin
+has_rdoc: false