optiflag 0.6

data/optiflag.gemspec

@@ -0,0 +1,13 @@
+require 'rake'
+Gem::Specification.new do |spec|
+	spec.name = "optiflag"
+	spec.version = "0.6"
+	spec.summary = "Optiflag is yet-another library for handling command-line options in an arbitrary Ruby program."
+	spec.author = "Daniel Eklund"
+	spec.email = "doeklund@gmail.com"
+	spec.homepage = "http://rubyforge.org/projects/optiflag/"
+	spec.files = FileList['**/*'].to_a
+	spec.test_files = FileList['test/tc*'].to_a - ["test/tc_flagall.rb"]
+	spec.has_rdoc = true
+	spec.rubyforge_project = 'optiflag'
+end  

data/test/tc_advanced_usage_helping.rb

@@ -0,0 +1,42 @@
+require 'optiflag.rb'
+require 'test/unit'
+
+module HelpArgs extend OptiFlag::Flagset
+  usage_flag "h","?","help"
+  flag "dir"
+end
+
+class TC_AdvancedHelpArgs < Test::Unit::TestCase
+
+  def test_help_requested
+    command_lines = 
+           ["-dir thedire -? dir",
+            "-dir thedire -h dir",
+            "-dir thedire -help dir"]
+    command_lines.each do |cl|
+      argv = cl.split
+      args = HelpArgs::parse(argv)
+      assert(args.help_requested?,
+             "A help flag was added to the command-line. Please register its existence.")
+      assert_equal("dir",args.help_requested_on, 
+                   "Advanced help is supposed to be requested on 'dir'")
+      assert_equal("thedire",args.flag_value.dir,
+                   "thedire is the proper value of the dir flag")
+    end
+  end
+  def test_no_help_requested
+     command_lines = 
+            ["-dir thedire",
+             "-dir thedire -he",
+             "-dir thedire -hElp"]
+     command_lines.each do |cl|
+      argv = cl.split
+      args = HelpArgs::parse(argv)
+      assert_equal("thedire",args.flag_value.dir,
+                   "thedire is the proper value of the dir flag")
+
+       assert(! args.help_requested?,
+              "There are no help flags on the command line")
+     end
+ end
+end

data/test/tc_basic_alternate_forms.rb

@@ -0,0 +1,30 @@
+require 'optiflag.rb'
+require 'test/unit'
+
+module AlternateArgs extend OptiFlag::Flagset
+  flag "directory" do 
+    alternate_forms %w{d dir D DIR DIRECTORY}
+  end
+end
+
+
+
+class TC_AlternateArgs < Test::Unit::TestCase
+
+ 
+  def test_alternate_forms
+    command_lines = 
+           ["-d FLOTSAM","-dir FLOTSAM",
+            "--directory FLOTSAM",
+            "-DIR FLOTSAM","-DIRECTORY FLOTSAM",
+            "-directory FLOTSAM","-D FLOTSAM"]
+    command_lines.each do |command_line|
+      args = AlternateArgs::parse(command_line.split)
+      assert_equal("FLOTSAM",args.flag_value.directory,
+                   "Directory not properly set")
+      assert(! args.errors?, 
+             "No errors should have occurred")       
+    end
+  end
+
+end

data/test/tc_basic_char_flags.rb

@@ -0,0 +1,103 @@
+require 'optiflag.rb'
+require 'test/unit'
+
+
+module CharArgs extend OptiFlag::Flagset
+  character_flag :l, :p_group
+  character_flag :s, :p_group
+  character_flag :a, :p_group
+  optional_switch_flag "clear"
+  character_flag :x do
+    description "Extract"
+  end
+  character_flag :v
+  character_flag :f
+  flag "dir"
+  keyword "bobby"
+end
+
+class TC_CharArgs < Test::Unit::TestCase
+
+  def test_xvf
+    command_lines = ["-x bobby -v -f -dir sdsdsd",
+                     "-xvf", 
+                     "-vxf",
+                     "-fvx bobby",
+                     "-f -dir kosd -xv",
+                     "-dir sdsd -x -fv",
+                     "-x -vf",
+                     "-f -vx",
+                     "-v -f -x -vo sd"]
+    command_lines.each do |x|
+      argv = x.split
+      args = CharArgs::parse(argv)
+      assert_equal(true,args.flag_value.f?,
+                   "The 'f' flag should be set")
+      assert_equal(true,args.flag_value.v?,
+                   "The 'v' flag should be set")
+      assert_equal(true,args.flag_value.x?,
+                   "The 'x' flag should be set")
+
+    end
+  end
+
+  def test_lsa
+    command_lines = ["-x bobby -v -f -dir sdsdsd",
+                     "-xvf", 
+                     "-vxf",
+                     "-fvx bobby",
+                     "-f -dir kosd -xv",
+                     "-dir sdsd -x -fv",
+                     "-x -vf",
+                     "-f -vx",
+                     "-v -f -x -vo sd"]
+    command_lines.each do |x|
+      argv = x.split
+      args = CharArgs::parse(argv)
+      assert_equal(false,args.flag_value.l?)
+      assert_equal(false,args.flag_value.s?)
+      assert_equal(false,args.flag_value.a?)
+      end
+  end
+  def test_lsa_not_there
+    command_lines = ["-lsa",
+                     "-las",
+                     "-als",
+                     "-asl",
+                     "-sal",
+                     "-sla",
+                     "-s -la",
+                     "-s -al",
+                     "-a -sl",
+                     "-a -ls ",
+                     "-l -s -a",
+                     "--l --s --a",
+                     "-lsa bobby -dir sdsd",
+                     "bobby -dir sdsd -las",
+                     "-als bobby -dir sdsd",
+                     "bobby -asl",
+                     "-sal -dir sdsd",
+                     "-sla",
+                     "-s bobby -la",
+                     "-s -al",
+                     "-a bobby -sl",
+                     "-a -ls",
+                     "-l bobby -dir sdsd -s -a"]
+
+    command_lines.each do |x|
+      argv = x.split
+      args = CharArgs::parse(argv)
+      assert_equal(true,args.flag_value.l?)
+      assert_equal(true,args.flag_value.s?)
+      assert_equal(true,args.flag_value.a?)
+      assert_equal(false,args.flag_value.x?)
+      assert_equal(false,args.flag_value.v?)
+      assert_equal(false,args.flag_value.f?)
+      end
+  end
+
+
+
+  
+end
+

data/test/tc_basic_optional_flag.rb

@@ -0,0 +1,74 @@
+require 'optiflag.rb'
+require 'test/unit'
+
+module OptionalArgs extend OptiFlag::Flagset
+  flag "dir"
+  optional_flag "log"
+  optional_flag "verbose_level" do
+    value_in_set [1,2,3,4,0]
+  end
+  optional_switch_flag "force"
+end
+
+class TC_OptionalArgs < Test::Unit::TestCase
+
+  def test_none_there
+    cl = %w{ -dir c:/my_stuff   }
+    result = OptionalArgs::parse(cl)
+    assert( ! result.errors?)
+    assert_equal("c:/my_stuff",result.flag_value.dir)
+    assert(!result.flag_value.log?)
+    assert(!result.flag_value.verbose_level?)
+    assert(!result.flag_value.force?)
+  end
+  
+  def test_all_there_and_no_errors
+    cl = %w{ -dir c:/my_stuff -log c:/log -force -verbose_level 3  }
+    result = OptionalArgs::parse(cl)
+    assert( ! result.errors?)
+    assert_equal("c:/log",result.flag_value.log)
+    assert_equal("3",result.flag_value.verbose_level)
+    assert(result.flag_value.force?)
+  end
+  def test_some_there_and_no_errors
+    cl = %w{ -dir c:/my_stuff  -force -verbose_level 3  }
+    result = OptionalArgs::parse(cl)
+    assert( ! result.errors?)
+    assert(!result.flag_value.log?)
+    assert_equal(nil,result.flag_value.log)
+    assert_equal("3",result.flag_value.verbose_level)
+    assert(result.flag_value.force?)
+  end
+  def test_some_there_and_no_errors_rearranged_1
+    cl = %w{ -dir c:/my_stuff  -verbose_level 3    -force}
+    result = OptionalArgs::parse(cl)
+    assert( ! result.errors?)
+    assert(!result.flag_value.log?)
+    assert_equal(nil,result.flag_value.log)
+    assert_equal("3",result.flag_value.verbose_level)
+    assert(result.flag_value.force?)
+  end
+  def test_some_there_and_no_errors_rearranged_2
+    cl = %w{  -force -dir c:/my_stuff  -verbose_level 3   }
+    result = OptionalArgs::parse(cl)
+    assert( ! result.errors?)
+    assert(!result.flag_value.log?)
+    assert_equal(nil,result.flag_value.log)
+    assert_equal("3",result.flag_value.verbose_level)
+    assert(result.flag_value.force?)
+  end
+  def test_some_there_but_has_validation_error
+    cl = %w{  -dir c:/my_stuff  -verbose_level three   }
+    result = OptionalArgs::parse(cl)
+    assert( result.errors?)
+    assert(!result.flag_value.log?)
+    assert_equal(nil,result.flag_value.log)
+    assert(!result.flag_value.force?)
+    assert_equal(0,result.errors.missing_flags.length)
+    assert_equal(1,result.errors.validation_errors.length)
+  end
+
+  
+
+end
+

data/test/tc_basic_parsing.rb

@@ -0,0 +1,51 @@
+require 'optiflag.rb'
+require 'test/unit'
+
+module DansArgs extend OptiFlag::Flagset
+  flag ["directory"]
+  flag "script"
+  flag ["control_db"] do
+    description "The control database credentials"
+  end
+  flag ["target_db"]
+end
+
+class TC_FlagAll < Test::Unit::TestCase
+
+  def setup
+    @regular_dans_args = %w{-directory my_directory -script my_script 
+              -control_db control -target_db target}
+    @missing_dans_args = %w{-directory my_directory -script my_script}
+  end
+
+  def test_regular_dans_arg_parses
+    result = DansArgs::parse(@regular_dans_args)
+    assert_equal("my_directory",result.flag_value.directory,
+           "Flag should be equal to my_directory")
+    assert(result.flag_value.directory?,
+           "Directory Flag should have been passed")
+    assert_equal("my_script",result.flag_value.script,
+           "Flag should be equal to my_script")
+    assert_equal("control",result.flag_value.control_db,
+           "Flag should be equal to control")
+    assert(result.errors? == false,"There should be no errors")
+  end
+
+  def test_missing_dans_arg_parses
+    result = DansArgs::parse(@missing_dans_args)
+    assert( result.errors?,  
+            "There should be errors, with two missing required options")
+    assert_equal("-control_db",result.errors.missing_flags[0], 
+           "First Missing flag should be -control_db")
+    assert_equal("-target_db",result.errors.missing_flags[1],
+           "Second Missing flag should be -target_db")
+    assert_equal(2,result.errors.missing_flags.length,
+           "There should be two missing flags")
+  end
+
+  def teardown
+
+  end
+
+end
+

data/test/tc_basic_usage_helping.rb

@@ -0,0 +1,40 @@
+require 'optiflag.rb'
+require 'test/unit'
+
+module HelpArgs extend OptiFlag::Flagset
+  usage_flag "h","?","help"
+  flag "dir"
+end
+
+class TC_HelpArgs < Test::Unit::TestCase
+
+  def test_help_requested
+    command_lines = 
+           ["-dir thedire -?",
+            "-dir thedire -h",
+            "-dir thedire -help"]
+    command_lines.each do |cl|
+      argv = cl.split
+      args = HelpArgs::parse(argv)
+      assert(args.help_requested?,
+             "A help flag was added to the command-line. Please register its existence.")
+      assert_equal("thedire",args.flag_value.dir,
+                   "thedire is the proper value of the dir flag")
+    end
+  end
+  def test_no_help_requested
+     command_lines = 
+            ["-dir thedire",
+             "-dir thedire -he",
+             "-dir thedire -hElp"]
+     command_lines.each do |cl|
+      argv = cl.split
+      args = HelpArgs::parse(argv)
+      assert_equal("thedire",args.flag_value.dir,
+                   "thedire is the proper value of the dir flag")
+
+       assert(! args.help_requested?,
+              "There are no help flags on the command line")
+     end
+ end
+end

data/test/tc_basic_value_validation.rb

@@ -0,0 +1,40 @@
+require 'optiflag.rb'
+require 'test/unit'
+
+module ValidArgs extend OptiFlag::Flagset
+  flag "directory"
+  flag "script", :description => "The Script directory"
+  flag "mode" do 
+    value_matches /[0-9]/
+  end
+  flag ["date"] do
+    value_matches ["Must be of form mm\/dd\/yy",  
+                   /^[0-9]{2}\/[0-9]{2}\/[0-9]{2,4}$/]
+  end
+
+  
+end
+
+class TC_ValidArgs < Test::Unit::TestCase
+
+ 
+  def test_validation
+    command_line = %w{-directory c:/eu -script RunMe -mode 3 -date 12/23/2006}
+    args = ValidArgs::parse(command_line)
+    assert_equal("c:/eu",args.flag_value.directory,
+                 "Directory not properly set")
+    assert(! args.errors?, 
+           "No errors should have occurred") 
+  end
+
+  def test_validation_with_errors
+    command_line = %w{-directory c:/eu -script RunMe -mode wrx -date monday}
+    args = ValidArgs::parse(command_line)
+    assert(args.errors?, 
+           "An error should have occurred") 
+    assert_equal(2,args.errors.validation_errors.length,
+                 "There should be 2 problems")
+  end
+  
+end
+

data/test/tc_bug_one.rb

@@ -0,0 +1,25 @@
+require 'optiflag.rb'
+require 'test/unit'
+
+module BUG_ONE extend OptiFlag::Flagset
+  flag "dir" do
+    alternate_forms "D","d"
+  end
+  flag "log"
+  flag "db", :description => "The database"
+  optional_flag "verbose"
+end
+
+
+
+class TC_BUG_ONE < Test::Unit::TestCase
+ 
+  def test_bug
+    command_line = "-log LOG -dir LOG  -db DB"
+    args = BUG_ONE::parse(command_line.split)
+    assert(! args.errors?, 
+           "No errors should have occurred")       
+
+  end
+
+end

data/test/tc_bug_two.rb

@@ -0,0 +1,33 @@
+require 'optiflag.rb'
+require 'test/unit'
+
+module BugTwoArgs extend OptiFlag::Flagset
+  flag "dir"
+  optional_flag "log"
+  optional_flag "verbose_level" do
+    value_in_set [1,2,3,4,0]
+  end
+  optional_switch_flag "force"
+  usage_flag "h"
+end
+
+class TC_BugTwo < Test::Unit::TestCase
+
+
+  def setup
+    # this thing is changing global state
+    cl = %w{ -dir c:/my_stuff -log c:/log -force -verbose_level 3 -h }
+    result = BugTwoArgs::parse(cl)
+  end
+
+  def test_a
+    cl = %w{ -dir c:/my_stuff   }
+    result = BugTwoArgs::parse(cl)
+    assert(!result.help_requested?,"Help was not requested")
+    assert(!result.flag_value.log?)
+
+    assert(!result.flag_value.verbose_level?)
+    assert(!result.flag_value.force?)
+  end
+end
+