s0nspark-choice 0.1.4

data/test/option_test.rb

@@ -0,0 +1,146 @@
+
+require File.join(File.expand_path(File.dirname(__FILE__)), 'test_helper')
+
+require "choice"
+require 'choice/option'
+
+class TestOption < Test::Unit::TestCase
+  def setup
+    Choice.reset!
+    @option = Choice::Option.new
+  end
+  
+  def test_desc
+    line_one = "This is a description."
+    line_two = "I can add many lines."
+    line_three = "There is no limit."
+    
+    assert_equal false, @option.desc?
+    
+    @option.desc line_one
+    @option.desc line_two
+    
+    assert @option.desc?    
+    assert_equal [line_one, line_two], @option.desc
+    
+    @option.desc line_three
+    assert @option.desc?    
+    assert_equal [line_one, line_two, line_three], @option.desc
+  end
+  
+  def test_choice
+    short = "-p"
+    
+    assert_equal false, @option.short?
+    
+    @option.short short
+    
+    assert @option.short?
+    assert_equal short, @option.short
+  end
+  
+  def test_no_choice
+    default = 42
+    
+    assert_raise(Choice::Option::ParseError) do
+      @option.defaut?
+    end
+    
+    assert_raise(Choice::Option::ParseError) do
+      @option.defaut default
+    end    
+    
+    assert_raise(Choice::Option::ParseError) do
+      @option.defaut
+    end    
+
+  end
+  
+  def test_block_choice
+    assert_equal false, @option.action?
+
+    @option.action do 
+      1 + 1
+    end
+
+    assert @option.action?
+    assert_block(&@option.action)
+  end
+  
+  def test_format
+    @option = Choice::Option.new do
+      validate /^\w+$/
+    end
+    
+    assert_equal /^\w+$/, @option.validate
+
+    block = proc { |f| File.exists? f }
+    @option = Choice::Option.new do
+      validate &block
+    end
+
+    assert_equal block, @option.validate
+  end  
+  
+  def test_dsl
+    @option = Choice::Option.new do
+      short "-s"
+      long "--host=HOST"
+      cast String
+      desc "The hostname."
+      desc "(Alphanumeric only)"
+      filter do
+        5 * 10
+      end
+    end
+
+    assert_equal "-s", @option.short
+    assert_equal "--host=HOST", @option.long
+    assert_equal String, @option.cast
+    assert_equal ["The hostname.", "(Alphanumeric only)"], @option.desc
+    assert_equal proc { 5 * 10 }.call, @option.filter.call
+  end
+  
+  def test_to_a
+    desc = "This is your description."
+    short = "-t"
+    long = "--test=METHOD"
+    default = :to_a
+    
+    @option.desc desc
+    @option.short short
+    @option.long long
+    @option.default default
+    @option.action { 1 + 1 }
+    array = @option.to_a
+        
+    assert_equal Choice::Option, @option.class
+    assert_equal Array, array.class
+    assert array.include? [desc]
+    assert array.include? short
+    assert array.include? long
+    assert array.include? default
+    assert_equal proc { 1 + 1 }.call, array.select { |a| a.is_a? Proc }.first.call
+  end
+  
+  def test_to_h
+    desc = "This is your description."
+    short = "-t"
+    long = "--test=METHOD"
+    cast = Integer
+    
+    @option.desc desc
+    @option.short short
+    @option.long long
+    @option.cast cast
+    @option.filter { 2 + 2 }
+    hash = @option.to_h
+        
+    assert_equal Choice::Option, @option.class
+    assert_equal Hash, hash.class
+    assert_equal [desc], hash['desc']
+    assert_equal short, hash['short']
+    assert_equal cast, hash['cast']    
+    assert_equal proc { 2 + 2 }.call, hash['filter'].call
+  end
+end

data/test/parser_test.rb

@@ -0,0 +1,374 @@
+
+require File.join(File.expand_path(File.dirname(__FILE__)), 'test_helper')
+
+require 'choice/option'
+require 'choice/parser'
+
+class TestParser < Test::Unit::TestCase
+  def setup
+    @options = {}
+  end
+  
+  def test_parse_options
+    @options['band'] = Choice::Option.new do
+      short '-b'
+      long '--band=BAND'
+      cast String
+      desc 'Your favorite band.'
+    end
+    @options['animal'] = Choice::Option.new do
+      short '-a'
+      long '--animal=ANIMAL'
+      cast String
+      desc 'Your favorite animal.'
+    end      
+    band = 'Led Zeppelin'
+    animal = 'Reindeer'
+    
+    args = ['-b', band, "--animal=#{animal}"]
+          
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal band, choices['band']
+    assert_equal animal, choices['animal']
+  end
+  
+  def test_parse_no_options
+    assert_equal Hash.new, Choice::Parser.parse(nil, nil)
+  end
+  
+  def test_parse_default
+    @options['soda'] = Choice::Option.new do
+      short '-s'
+      long '--soda=SODA'
+      default 'PibbJr'
+    end
+    
+    args = []
+    
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal 'PibbJr', choices['soda']
+  end
+  
+  def test_parse_options_with_filters
+    @options['host'] = Choice::Option.new do
+      short '-h'
+      filter do |opt|
+        opt.gsub!(/[^\w]/, '')
+        opt = opt.sub(/k/, 'c')
+      end
+    end     
+    host = 'de.fun.kt'
+    args = ['-h', host]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal 'defunct', choices['host']
+  end 
+  
+  def test_casting
+    @options['port'] = Choice::Option.new do
+      short '-p'
+      cast Integer
+    end
+    
+    port = '3000'
+    args = ['-p', port]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal port.to_i, choices['port']
+  end
+  
+  def test_text_required
+    @options['name'] = Choice::Option.new do
+      short '-n'
+      long '--name=NAME'
+    end
+    @options['age'] = Choice::Option.new do
+      short '-a'
+      long 'age[=AGE]'
+      cast Integer
+    end
+    
+    args = ['-n', '-a', '21']
+    
+    assert_raise(Choice::Parser::ArgumentRequired) do
+      choices = Choice::Parser.parse(@options, args)
+    end
+  end
+  
+  def test_text_optional
+    @options['color'] = Choice::Option.new do
+      short '-c'
+      long '--color[=COLOR]'
+    end
+    
+    args = ['-c']
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert choices['color']
+    
+    color = 'ladyblue'
+    args = ['-c', color]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal color, choices['color']
+  end
+
+  def test_text_optional_deprecated
+    @options['color'] = Choice::Option.new do
+      short '-c'
+      long '--color=[COLOR]'
+    end
+    
+    args = ['-c']
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert choices['color']
+    
+    color = 'ladyblue'
+    args = ['-c', color]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal color, choices['color']
+  end
+  
+  def test_ignore_separator
+    options = []
+    options << ['keyboard', Choice::Option.new do
+      short '-k'
+      long '--keyboard=BOARD'
+    end]
+    
+    options << ['mouse', Choice::Option.new do
+      short '-m'
+      long '--mouse=MOUSE'
+    end]
+    
+    args = ['-m', 'onebutton']
+    choices = Choice::Parser.parse([options.first, '----', options.last], args)
+    
+    assert choices['mouse']
+    assert_equal 1, choices.size
+  end
+  
+  def test_long_as_switch
+    @options['chunky'] = Choice::Option.new do
+      short '-b'
+      long '--bacon'
+    end
+
+    args = ['--bacon']
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert choices['chunky']
+  end
+  
+  def test_validate_regexp
+    @options['email'] = Choice::Option.new do
+      short '-e'
+      long '--email=EMAIL'
+      desc 'Your valid email addy.'
+      validate /^[a-z0-9_.-]+@[a-z0-9_.-]+\.[a-z]{2,4}$/i
+    end
+
+    email_bad = 'this will@neverwork'    
+    email_good = 'chris@ozmm.org'
+    
+    args = ['-e', email_bad]
+    assert_raise(Choice::Parser::ArgumentValidationFails) do
+      choices = Choice::Parser.parse(@options, args)
+    end
+
+    args = ['-e', email_good]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal email_good, choices['email']
+  end
+  
+  def test_validate_block
+    @options['file'] = Choice::Option.new do
+      short '-f'
+      long '--file=FILE'
+      desc 'Your valid email addy.'
+      validate do |arg|
+        File.exists? arg
+      end
+    end
+
+    file_bad = 'not_a_file.rb'
+    file_good = __FILE__
+    
+    args = ['-f', file_bad]
+    assert_raise(Choice::Parser::ArgumentValidationFails) do
+      choices = Choice::Parser.parse(@options, args)
+    end
+
+    args = ['-f', file_good]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal file_good, choices['file']
+  end
+
+  def test_unknown_argument
+    @options['cd'] = Choice::Option.new do
+      short '-c'
+      long '--cd=CD'
+      desc 'A CD you like.'
+    end
+  
+    args = ['-c', 'BestOfYanni', '--grace']
+    assert_raise(Choice::Parser::UnknownOption) do
+      choices = Choice::Parser.parse(@options, args)
+    end
+  end
+
+  def test_valid
+    @options['suit'] = Choice::Option.new do
+      short '-s'
+      long '--suit=SUIT'
+      valid %w[club diamond spade heart]
+      desc "The suit of your card, sir."
+    end
+
+    suit_good = 'club'
+    suit_bad = 'joker'
+    
+    args = ['-s', suit_bad]
+    assert_raise(Choice::Parser::InvalidArgument) do
+      choices = Choice::Parser.parse(@options, args)
+    end
+
+    args = ['-s', suit_good]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal suit_good, choices['suit']
+  end
+
+  def test_valid_needs_argument
+    @options['pants'] = Choice::Option.new do
+      short '-p'
+      long '--pants'
+      valid %w[jeans slacks trunks boxers]
+      desc "Your preferred type of pants."
+    end
+    
+    args = ['-p']
+    assert_raise(Choice::Parser::ArgumentRequiredWithValid) do
+      choices = Choice::Parser.parse(@options, args)
+    end
+  end
+
+  def test_long_as_array
+    @options['medium'] = Choice::Option.new do
+      short '-m'
+      long '--medium=*MEDIUM'
+      desc "The medium(s) you like best."
+    end
+
+    mediums = %w[canvas stone steel]
+
+    args = ['-m', mediums.first, '-m',  mediums[1], '-m', mediums.last]
+    choices = Choice::Parser.parse(@options, args)
+    assert_equal mediums, choices['medium']
+
+    args = ['-m', mediums.first, mediums[1], mediums.last]
+    choices = Choice::Parser.parse(@options, args)
+    assert_equal mediums, choices['medium']
+
+    args = ["--medium=#{mediums.first}", "--medium=#{mediums[1]}", "--medium=#{mediums.last}"]
+    choices = Choice::Parser.parse(@options, args)
+    assert_equal mediums, choices['medium']
+
+    args = ["--medium=#{mediums.first}", mediums[1], mediums.last]
+    choices = Choice::Parser.parse(@options, args)
+    assert_equal mediums, choices['medium']
+  end
+
+  def test_long_as_array_optional
+    @options['instruments'] = Choice::Option.new do
+      short '-i'
+      long '--instruments[=*INSTRUMENTS]'
+      desc "Do you like instruments?  Which ones do you like best?"
+    end
+
+    instruments = %w[xylophone guitar piano]
+
+    args = ["--instruments=#{instruments.first}", "--instruments=#{instruments[1]}", 
+            "--instruments=#{instruments.last}"]
+    choices = Choice::Parser.parse(@options, args)
+    assert_equal instruments, choices['instruments']
+
+    args = %w[--instruments]
+    choices = Choice::Parser.parse(@options, args)
+    assert_equal true, choices['instruments']
+  end
+
+  def test_long_as_array_with_valid
+    @options['suits'] = Choice::Option.new do
+      short '-s'
+      long '--suits=*SUITS'
+      valid %w[club diamond spade heart]
+      desc "The suits of your deck, sir."
+    end
+
+    suits = %w[spade heart]
+
+    args = ['-s', suits.first, suits.last]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal suits, choices['suits']
+    
+    args = ['-s', suits.first, 'notasuit']
+    assert_raise(Choice::Parser::InvalidArgument) do
+      choices = Choice::Parser.parse(@options, args)
+    end
+  end
+
+  def test_long_with_spaces
+    @options['donut'] = Choice::Option.new do
+      short '-d'
+      long '--donut DONUT'
+      desc "Your favorite donut style."
+    end
+
+    donut = 'long-john'
+
+    args = ['--donut', donut]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal donut, choices['donut']
+  end
+
+  def test_optional_long_with_spaces
+    @options['donut'] = Choice::Option.new do
+      short '-d'
+      long '--donut [DONUT]'
+      desc "Your favorite donut style."
+    end
+
+    donut = 'chocolate'
+
+    args = ['--donut', donut]
+    choices = Choice::Parser.parse(@options, args)
+    assert_equal donut, choices['donut']
+
+    args = ['--donut']
+    choices = Choice::Parser.parse(@options, args)
+    assert_equal true, choices['donut']
+  end
+
+  def test_long_with_spaces_arrayed
+    @options['donuts'] = Choice::Option.new do
+      short '-d'
+      long '--donuts *DONUTS'
+      desc "Your favorite donut styles."
+    end
+
+    donuts = %w[glazed cream-filled]
+
+    args = ['--donuts', donuts.first, donuts.last]
+    choices = Choice::Parser.parse(@options, args)
+    assert_equal donuts, choices['donuts']
+  end
+end