clasp-ruby 0.10.2

data/test/unit/tc_arguments_2.rb

@@ -0,0 +1,65 @@
+#! /usr/bin/ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+class Test_Arguments_2 < Test::Unit::TestCase
+
+	def test_combined_flags_0
+
+		aliases	=	[
+		]
+		args	=	CLASP::Arguments.new [ '-abc' ], aliases
+
+		assert_equal 1, args.flags.size
+		assert_equal '-abc', args.flags[0].name
+		assert_equal '-abc', args.flags[0].to_s
+		assert_equal 'abc', args.flags[0].given_label
+		assert_equal 1, args.flags[0].given_hyphens
+		assert_nil args.flags[0].argument_alias
+		assert_equal Hash.new, args.flags[0].extras
+
+		assert_equal 0, args.options.size
+
+		assert_equal 0, args.values.size
+	end
+
+	def test_combined_flags_1
+
+		aliases	=	[
+			CLASP.Flag('--a', alias: '-a'),
+			CLASP.Flag('--b', alias: '-b'),
+			CLASP.Flag('--c', alias: '-c'),
+		]
+		args	=	CLASP::Arguments.new [ '-abc' ], aliases
+
+		assert_equal 3, args.flags.size
+		assert_equal '--a', args.flags[0].name
+		assert_equal '--a', args.flags[0].to_s
+		assert_equal 'abc', args.flags[0].given_label
+		assert_equal 1, args.flags[0].given_hyphens
+		assert_equal aliases[0], args.flags[0].argument_alias
+		assert_equal Hash.new, args.flags[0].extras
+		assert_equal '--b', args.flags[1].name
+		assert_equal '--b', args.flags[1].to_s
+		assert_equal 'abc', args.flags[1].given_label
+		assert_equal 1, args.flags[1].given_hyphens
+		assert_equal aliases[1], args.flags[1].argument_alias
+		assert_equal Hash.new, args.flags[1].extras
+		assert_equal '--c', args.flags[2].name
+		assert_equal '--c', args.flags[2].to_s
+		assert_equal 'abc', args.flags[2].given_label
+		assert_equal 1, args.flags[2].given_hyphens
+		assert_equal aliases[2], args.flags[2].argument_alias
+		assert_equal Hash.new, args.flags[2].extras
+
+		assert_equal 0, args.options.size
+
+		assert_equal 0, args.values.size
+	end
+end
+
+

data/test/unit/tc_arguments_3.rb

@@ -0,0 +1,89 @@
+#! /usr/bin/ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+class Test_Arguments_3 < Test::Unit::TestCase
+
+	def test_include_flag_1
+
+		args	=	CLASP::Arguments.new [ '-f1', 'value1', '--option1=value1', '--flag2' ], nil
+
+		assert args.flags.include? '-f1'
+		assert not(args.flags.include? '-f2')
+		assert args.flags.include? '--flag2'
+		assert not(args.flags.include? '--option1')
+	end
+
+	def test_include_flag_2
+
+		aliases	=	[
+			CLASP.Flag('--flag1', alias: '-f1'),
+		]
+		args	=	CLASP::Arguments.new [ '-f1', 'value1', '--option1=value1', '--flag2' ], aliases
+
+		assert args.flags.include? '-f1'
+		assert args.flags.include? '--flag1'
+		assert not(args.flags.include? '-f2')
+		assert args.flags.include? '--flag2'
+		assert not(args.flags.include? '--option1')
+	end
+
+	def test_combined_flags_1
+
+		aliases	=	[
+			CLASP.Flag('--delete', alias: '-d'),
+			CLASP.Flag('--update', alias: '-u'),
+		]
+		args	=	CLASP::Arguments.new [ '-du' ], aliases
+
+		assert args.flags.include? '--delete'
+		assert args.flags.include? '--update'
+	end
+
+	def test_get_option_1
+
+		args	=	CLASP::Arguments.new [ '-f1', 'value1', '--option1=value1', '--flag2' ], nil
+
+		assert args.options.include? '--option1'
+		assert not(args.options.include? '--option1=value1')
+		assert not(args.options.include? '-f1')
+		assert not(args.options.include? '--flag2')
+	end
+
+	def test_get_option_2
+
+		aliases	=	[
+			CLASP.Flag('--flag1', alias: '-f1'),
+			CLASP.Option('--option1', alias: '-o1'),
+		]
+		args	=	CLASP::Arguments.new [ '-f1', 'value1', '-o1=value1', '--flag2' ], aliases
+
+		assert args.options.include? '-o1'
+		assert args.options.include? '--option1'
+		assert not(args.options.include? '--option1=value1')
+		assert not(args.options.include? '-f1')
+		assert not(args.options.include? '--flag2')
+	end
+
+	def test_combined_flags_and_options_1
+
+		aliases	=	[
+			CLASP.Flag('--delete', alias: '-d'),
+			CLASP.Flag('--update', alias: '-u'),
+			CLASP.Option('--encryption', alias: '-e'),
+			CLASP.Option('--encryption=blowfish', alias: '-b'),
+		]
+		args	=	CLASP::Arguments.new [ '-du', '-e', 'sha' ], aliases
+
+		assert args.flags.include? '--delete'
+		assert args.flags.include? '--update'
+		assert args.options.include? '--encryption'
+		assert_not_nil args.options.detect { |o| o == '--encryption' }
+		assert_nil args.options.detect { |o| o == '--blah' }
+	end
+end
+

data/test/unit/tc_defaults_1.rb

@@ -0,0 +1,73 @@
+#! /usr/bin/ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+class Test_defaults < Test::Unit::TestCase
+
+	def test_responds_to_Help
+
+		assert CLASP::Flag.respond_to? :Help
+	end
+
+	def test_Help_is_idempotent
+
+		help_1	=	CLASP::Flag.Help
+		help_2	=	CLASP::Flag.Help
+
+		assert_same help_1, help_2
+	end
+
+	def test_Help_attributes
+
+		assert_equal '--help', CLASP::Flag.Help.name
+
+		assert_equal [], CLASP::Flag.Help.aliases
+
+		assert_equal 'shows this help and terminates', CLASP::Flag.Help.help
+	end
+
+	def test_Help_extras
+
+		help1	=	CLASP::Flag.Help
+		help2	=	CLASP::Flag.Help(v1: 'v', v2: 2)
+
+		assert_equal Hash.new, help1.extras
+		assert_equal Hash[ [ [ :v1, 'v' ], [ :v2, 2 ] ] ], help2.extras
+	end
+
+	def test_responds_to_Version
+
+		assert CLASP::Flag.respond_to? :Version
+	end
+
+	def test_Version_is_idempotent
+
+		version_1	=	CLASP::Flag.Version
+		version_2	=	CLASP::Flag.Version
+
+		assert_same version_1, version_2
+	end
+
+	def test_Version_attributes
+
+		assert_equal '--version', CLASP::Flag.Version.name
+
+		assert_equal [], CLASP::Flag.Version.aliases
+
+		assert_equal 'shows version and terminates', CLASP::Flag.Version.help
+	end
+
+	def test_Version_extras
+
+		version1	=	CLASP::Flag.Version
+		version2	=	CLASP::Flag.Version(v1: 'v', v2: 2)
+
+		assert_equal Hash.new, version1.extras
+		assert_equal Hash[ [ [ :v1, 'v' ], [ :v2, 2 ] ] ], version2.extras
+	end
+end
+

data/test/unit/tc_examples_Arguments.rb

@@ -0,0 +1,149 @@
+#! /usr/bin/ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+class Test_Examples < Test::Unit::TestCase
+
+	def test_SimpleCommandLineNoAliases
+
+		argv = %w{ --show-all=true infile -c outfile }
+
+		args = CLASP::Arguments.new(argv)
+
+		assert_equal 1, args.flags.size
+		flag = args.flags[0]
+		assert_equal "-c", flag.name
+		assert_equal 1, args.options.size
+		option = args.options[0]
+		assert_equal "--show-all", option.name
+		assert_equal "true", option.value
+		assert_equal 2, args.values.size
+		assert_equal "infile", args.values[0]
+		assert_equal "outfile", args.values[1]
+	end
+
+	def test_UseOfSpecialDoubleSlashFlagToTreatAllSubsequentArgumentsAsValues
+
+		argv = %w{ --show-all=true -- infile outfile -c }
+
+		args = CLASP::Arguments.new(argv)
+
+		assert_equal 0, args.flags.size
+		option = args.options[0]
+		assert_equal "--show-all", option.name
+		assert_equal "true", option.value
+		assert_equal 3, args.values.size
+		assert_equal "infile", args.values[0]
+		assert_equal "outfile", args.values[1]
+		assert_equal "-c", args.values[2]
+	end
+
+	def test_UseOfFlagShortForms
+
+		aliases = [
+
+			CLASP.Flag('--verbose', alias: '-v'),
+			CLASP.Flag('--trace-output', aliases: [ '-t', '--trace' ]),
+		]
+
+		argv = %w{ --trace -v }
+
+		args = CLASP::Arguments.new(argv, aliases)
+
+		assert_equal 2, args.flags.size
+		flag = args.flags[0]
+		assert_equal '--trace-output', flag.name
+		assert_equal '--trace', flag.given_name
+		flag = args.flags[1]
+		assert_equal '--verbose', flag.name
+		assert_equal '-v', flag.given_name
+		assert_equal 0, args.options.size
+		assert_equal 0, args.values.size
+	end
+
+	def test_UseOfFlagSingleShortFormsCombined
+
+		aliases = [
+
+			CLASP.Flag('--expand', alias: '-x'),
+			CLASP.Flag('--verbose', alias: '-v'),
+			CLASP.Flag('--trace-output', aliases: [ '-t', '--trace' ]),
+		]
+
+		argv = %w{ -tvx }
+
+		args = CLASP::Arguments.new(argv, aliases)
+
+		assert_equal 3, args.flags.size
+		flag = args.flags[0]
+		assert_equal '--trace-output', flag.name
+		assert_equal '-tvx', flag.given_name
+		flag = args.flags[1]
+		assert_equal '--verbose', flag.name
+		assert_equal '-tvx', flag.given_name
+		flag = args.flags[2]
+		assert_equal '--expand', flag.name
+		assert_equal '-tvx', flag.given_name
+		assert_equal 0, args.options.size
+		assert_equal 0, args.values.size
+	end
+
+	def test_UseOfOptionShortForm
+
+		aliases = [
+
+			CLASP.Option('--show-all', alias: '-a'),
+		]
+
+		argv = %w{ -c -a true infile outfile }
+
+		args = CLASP::Arguments.new(argv, aliases)
+
+		assert_equal 1, args.flags.size
+		flag = args.flags[0]
+		assert_equal "-c", flag.name
+		assert_equal 1, args.options.size
+		option = args.options[0]
+		assert_equal "--show-all", option.name
+		assert_equal "-a", option.given_name
+		assert_equal "true", option.value
+		assert_equal 2, args.values.size
+		assert_equal "infile", args.values[0]
+		assert_equal "outfile", args.values[1]
+	end
+
+	def test_UseOfFlagsAsAliasesForOption
+
+		aliases = [
+
+			CLASP.Flag('--dump-contents', alias: '-d'),
+			CLASP.Option('--log-level', alias: '-l'),
+			CLASP.Flag('--log-level=warning', alias: '-w'),
+		]
+
+		argv = %w{ myfile -dw }
+
+		args = CLASP::Arguments.new(argv, aliases)
+
+		assert_equal 1, args.flags.size
+		flag = args.flags[0]
+		assert_equal "--dump-contents", flag.name
+		assert_equal "-dw", flag.given_name
+		assert_equal 1, flag.given_index
+		assert_equal 1, args.options.size
+		option = args.options[0]
+		assert_equal "--log-level", option.name
+		assert_equal "-dw", option.given_name
+		assert_equal 1, flag.given_index
+		assert_equal "warning", option.value
+		assert_equal 1, args.values.size
+		assert_equal "myfile", args.values[0]
+	end
+end
+
+# ############################## end of file ############################# #
+

data/test/unit/tc_usage.rb

@@ -0,0 +1,110 @@
+#! /usr/bin/ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_Usage < Test::Unit::TestCase
+
+	def test_empty_default
+
+		aliases	=	[]
+
+		stream	=	StringIO.new
+
+		CLASP.show_usage aliases, stream: stream, program_name: 'myprog'
+
+		assert_equal "USAGE: myprog [ ... flags and options ... ]\n\n", stream.string
+	end
+
+	def test_empty_all
+
+		aliases	=	[]
+
+		stream	=	StringIO.new
+
+		CLASP.show_usage aliases, stream: stream, program_name: 'myprog', flags_and_options: ''
+
+		assert_equal "USAGE: myprog\n\n", stream.string
+	end
+
+	def test_empty_all_with_info_line_of_one_string
+
+		aliases	=	[]
+
+		stream	=	StringIO.new
+
+		info	=	'myprog version'
+
+		CLASP.show_usage aliases, stream: stream, program_name: 'myprog', flags_and_options: '', info_lines: info
+
+		assert_equal "myprog version\nUSAGE: myprog\n\n", stream.string
+	end
+
+	def test_empty_all_with_info_lines
+
+		aliases	=	[]
+
+		stream	=	StringIO.new
+
+		info_lines	=	[
+
+			'Synesis Software My Program',
+			'version 1',
+		]
+
+		CLASP.show_usage aliases, stream: stream, program_name: 'myprog', flags_and_options: '', info_lines: info_lines
+
+		assert_equal "Synesis Software My Program\nversion 1\nUSAGE: myprog\n\n", stream.string
+	end
+
+	def test_empty_all_with_info_lines_including_version
+
+		aliases	=	[]
+
+		stream	=	StringIO.new
+
+		info_lines	=	[
+
+			'Synesis Software My Program',
+			:version
+		]
+
+		CLASP.show_usage aliases, stream: stream, program_name: 'myprog', flags_and_options: '', info_lines: info_lines, version: [ 1, 0, 1], version_prefix: 'v'
+
+		assert_equal "Synesis Software My Program\nmyprog v1.0.1\nUSAGE: myprog\n\n", stream.string
+	end
+
+	def test_one_alias_default
+
+		aliases	=	[
+
+			CLASP::Flag.Version
+		]
+
+		stream	=	StringIO.new
+
+		CLASP.show_usage aliases, stream: stream, program_name: 'myprog'
+
+		assert_equal "USAGE: myprog [ ... flags and options ... ]\n\nflags/options:\n\n\t--version\n\t\t#{CLASP::Flag.Version.help}\n\n", stream.string
+	end
+
+	def test_one_alias_all
+
+		aliases	=	[
+
+			CLASP::Flag.Version
+		]
+
+		stream	=	StringIO.new
+
+		CLASP.show_usage aliases, stream: stream, program_name: 'myprog', flags_and_options: ''
+
+		assert_equal "USAGE: myprog\n\nflags/options:\n\n\t--version\n\t\t#{CLASP::Flag.Version.help}\n\n", stream.string
+	end
+end
+