como 0.0.2 → 0.1.0

data/test/test_como.rb

@@ -4,341 +4,35 @@ include Como
 require 'stringio'
 
 
-class ComoTest < Test::Unit::TestCase
-    
-    def reset_state( args )
-        Spec.setArgv( args )
-        Opt.each do |i|
-            i.given = false
-        end
-        Spec.check
-    end
-
-    def test_sanity
+# Test execution routine.
+def runTest( test )
+    Dir.chdir( 'test' )
+    FileUtils.mkdir_p "result"
+    rf = "result/#{test}.txt"
+    gf = "golden/#{test}.txt"
 
-        Opt.reset
-        Spec.setArgv( %w{ -f file } )
-        
-        Spec.defineCheckHelp( "cmd_opt_test", "Programmer", "2013",
-          [
-            [ :silent, "help", "-h", "Display usage info." ],
-            [ :single, "file", "-f", "File argument." ],
-          ] )
+    system( "export RUBYLIB=../lib; . test_#{test} > #{rf}" )
 
-        assert_equal( 'file', Opt['file'].value )
+    if false
+        # Populate golden files after inspection.
+        system( "cp #{rf} #{gf}" )
     end
-    
-
-    def test_values
-
-        Opt.reset
-        Spec.setArgv( %w{ -f file -d --o1 -o4 1 2 3 -o5 -o2 o2 rest } )
-        
-        Spec.defineCheckHelp( "como_fulltest", "Programmer", "2013",
-          [
-            [ :silent, "help", "-h", "Display usage info." ],
-            [ :single, "file", "-f", "File argument." ],
-            [ :switch, "o1", "-o1", "o1" ],
-            [ :opt_single, "o2", "-o2", "o2" ],
-            [ :opt_single, "o3", "-o3", "o3" ],
-            [ :opt_multi, "o4", "-o4", "o4" ],
-            [ :opt_any, "o5", "-o5", "o5" ],
-            [ :switch, "debug", "-d", "Enable debugging." ],
-            [ :default, "rest", nil, "Default options." ],
-          ] )
-
-        assert_equal( 'file', Opt['file'].value )
-        assert_equal( true, Opt['debug'].given )
-        assert_equal( true, Opt['o1'].given )
-        assert_equal( true, Opt['o2'].given )
-        assert_equal( 'o2', Opt['o2'].value )
-        assert_equal( false, Opt['o3'].given )
-        assert_equal( true, Opt['o4'].given )
-        assert_equal( %w{1 2 3}, Opt['o4'].value )
-        assert_equal( true, Opt['o5'].given )
-        assert_equal( 1, Opt[nil].value.length )
-        assert_equal( 'rest', Opt[nil].value[0] )
-    end
-
-
-    def test_rules
-        Opt.reset
-        Spec.setArgv( %w{ -o1 } )
-        
-        Spec.defineCheckHelp( "como_fulltest", "Programmer", "2013",
-          [
-           [ :silent, "help", "-h", "Display usage info." ],
-           [ :switch, "o1", "-o1", "o1" ],
-           [ :switch, "o2", "-o2", "o2" ],
-           [ :switch, "o3", "-o3", "o3" ],
-           [ :switch, "o4", "-o4", "o4" ],
-          ] )
-
-        # all
-        reset_state( %w{ -o1 -o2 -o3} )
-        ret = Opt.checkRule do
-            all( 'o1', 'o2', 'o3' )
-        end
-        assert_equal( true, ret )
-
-        reset_state( %w{ -o1 -o2 } )
-        ret = Opt.checkRule do
-            all( 'o1', 'o3' )
-        end
-        assert_equal( false, ret )
-
-        # one
-        reset_state( %w{ -o1 } )
-        ret = Opt.checkRule do
-            one( 'o1', 'o2' )
-        end
-        assert_equal( true, ret )
-                         
-        reset_state( %w{ -o1 -o2 } )
-        ret = Opt.checkRule do
-            one( 'o1', 'o2' )
-        end
-        assert_equal( false, ret )
-        
-        # any
-        reset_state( %w{ --o2 } )
-        ret = Opt.checkRule do
-            any( 'o1', 'o2' )
-        end
-        assert_equal( true, ret )
-                         
-        reset_state( %w{ -o3 } )
-        ret = Opt.checkRule do
-            one( 'o1', 'o2' )
-        end
-        assert_equal( false, ret )
-
-        # none
-        reset_state( %w{ } )
-        ret = Opt.checkRule do
-            none
-        end
-        assert_equal( true, ret )
-                         
-        reset_state( %w{ -o3 } )
-        ret = Opt.checkRule do
-            none
-        end
-        assert_equal( false, ret )
-
-        # incr
-        reset_state( %w{ -o1 -o2 -o3} )
-        ret = Opt.checkRule do
-            incr( 'o1', 'o2', 'o3' )
-        end
-        assert_equal( true, ret )
-
-        reset_state( %w{ -o1 -o2} )
-        ret = Opt.checkRule do
-            incr( 'o1', 'o2', 'o3' )
-        end
-        assert_equal( true, ret )
-
-        reset_state( %w{ -o1 -o3} )
-        ret = Opt.checkRule do
-            incr( 'o1', 'o2', 'o3' )
-        end
-        assert_equal( false, ret )
-
-        # follow
-        reset_state( %w{ -o1 -o2 -o3} )
-        ret = Opt.checkRule do
-            follow( 'o1', 'o2', 'o3' )
-        end
-        assert_equal( true, ret )
-
-        reset_state( %w{ -o1 -o3 -o2} )
-        ret = Opt.checkRule do
-            follow( 'o1', 'o2', 'o3' )
-        end
-        assert_equal( true, ret )
-
-        reset_state( %w{ -o2 -o3} )
-        ret = Opt.checkRule do
-            follow( 'o1', 'o2', 'o3' )
-        end
-        assert_equal( false, ret )
-
-        reset_state( %w{-o1 -o3} )
-        ret = Opt.checkRule do
-            follow( 'o1', 'o2', 'o3' )
-        end
-        assert_equal( false, ret )
-
-        # in combination
-        reset_state( %w{-o2} )
-        ret = Opt.checkRule do
-            one(
-                one( 'o1', 'o2' ),
-                none
-                )
-        end
-        assert_equal( true, ret )
-
-        reset_state( %w{-o2 -o3} )
-        ret = Opt.checkRule do
-            all(
-                one( 'o1', 'o2' ),
-                'o3'
-                )
-        end
-        assert_equal( true, ret )
-
-
-        reset_state( %w{-o2 -o3 -o4} )
-        ret = Opt.checkRule do
-            all(
-                one( 'o1', 'o2' ),
-                'o3',
-                incr( 'o3', 'o4' )
-                )
-        end
-        assert_equal( true, ret )
-
-
-        reset_state( %w{-o3 -o4} )
-        ret = Opt.checkRule do
-            all(
-                one( 'o1', 'o2' ),
-                'o3',
-                incr( 'o3', 'o4' )
-                )
-        end
-        assert_equal( false, ret )
-
-
-    end
-
-
-    def test_external
-        Opt.reset
-        Spec.setArgv( %w{ -f file -- other_program -f other_file } )
-        
-        Spec.defineCheckHelp( "cmd_opt_test", "Programmer", "2013",
-          [
-           [ :silent, "help", "-h", "Display usage info." ],
-           [ :single, "file", "-f", "File argument." ],
-          ] )
-        
-        assert_equal( 'file', Opt['file'].value )
-        assert_equal( %w{other_program -f other_file}, Opt.external )
-    end
-
-
-    def test_help
-
-        Opt.reset
-        Spec.setArgv( %w{ -h } )
-        Opt.setIo( StringIO.new )
 
-        Spec.defineCheckHelp( "cmd_opt_test", "Programmer", "2013",
-          [
-            [ :silent, "help", "-h", "Display usage info." ],
-            [ :single, "file", "-f", "File argument." ],
-            [ :opt_any, "list", "-l", "List argument." ],
-          ], { :help_exit => false } )
-
-        help = "
-
-  Usage:
-    cmd_opt_test -f <file> [-l <list>*]
-
-  -f      File argument.
-  -l      List argument.
-
-
-  Copyright (c) 2013 by Programmer
-
-"
-
-        assert_equal( help, Opt.getIo.string )
-    end
-
-
-    def test_missing
-
-        Opt.reset
-        Spec.setArgv( %w{ -l some args } )
-        Opt.setIo( StringIO.new )
-        
-        Spec.defineCheckHelp( "cmd_opt_test", "Programmer", "2013",
-          [
-            [ :silent, "help", "-h", "Display usage info." ],
-            [ :single, "file", "-f", "File argument." ],
-            [ :opt_any, "list", "-l", "List argument." ],
-          ], { :error_exit => false } )
-
-        help = "
-cmd_opt_test error: Option \"-f\" missing...
-
-
-  Usage:
-    cmd_opt_test -f <file> [-l <list>*]
-
-  -f      File argument.
-  -l      List argument.
-
-
-  Copyright (c) 2013 by Programmer
-
-"
-
-        assert_equal( help, Opt.getIo.string )
-
-    end
-
-
-    def test_invalid_rule
-
-        Opt.reset
-        Spec.setArgv( %w{ -o1 } )
-        Opt.setIo( StringIO.new )
-        
-        Spec.defineCheckHelp( "como_fulltest", "Programmer", "2013",
-          [
-           [ :silent, "help", "-h", "Display usage info." ],
-           [ :switch, "o1", "-o1", "o1" ],
-           [ :switch, "o2", "-o2", "o2" ],
-           [ :switch, "o3", "-o3", "o3" ],
-           [ :switch, "o4", "-o4", "o4" ],
-          ], { :error_exit => false } )
-
-        # all
-        reset_state( %w{ -o1 -o2 } )
-        ret = Spec.checkRule do
-            all( 'o1', 'o2', 'o3' )
-        end
-
-        help = "
-como_fulltest error: Option combination mismatch!
-
-  Option combination rules:
-
-    |--# All of:
-    |     |--<o1>
-    |     |--<o2>
-    |     |--<o3>
-
-
-  Usage:
-    como_fulltest [-o1] [-o2] [-o3] [-o4]
-
-  -o1     o1
-  -o2     o2
-  -o3     o3
-  -o4     o4
+    assert( system( "diff #{rf} #{gf}" ), "FAILED: diff #{rf} #{gf}" )
 
+    Dir.chdir( '..' )
+end
 
-  Copyright (c) 2013 by Programmer
 
-"
+class ComoTest < Test::Unit::TestCase
 
-        assert_equal( help, Opt.getIo.string )
+    def test_options()       runTest( "options"       ); end 
+    def test_queries()       runTest( "queries"       ); end 
+    def test_config()        runTest( "config"        ); end 
+    def test_rule_1()        runTest( "rule_1"        ); end 
+    def test_rule_2()        runTest( "rule_2"        ); end 
+    def test_subcmd()        runTest( "subcmd"        ); end 
+    def test_subcmd_config() runTest( "subcmd_config" ); end 
+    def test_compatible()    runTest( "compatible"    ); end 
 
-    end
 end

data/test/test_compatible

@@ -0,0 +1,28 @@
+como_options
+como_options --doc
+como_options --doc -f
+como_options --doc -f foo
+como_options -f
+como_options -f dii
+como_options -f dii -d
+como_options --file dii -d d1
+como_options --file dii -d d1 d2
+como_options --debug -f dii -d d1
+como_options -f dii -d d1 --debug
+como_options -f dii -d d1 --debug -m foo
+como_options -f dii -d d1 --debug -m foo
+como_options -f dii -d d1 --params foo=bar dii=duu
+como_options -f dii -d d1 --params foo=bar dii=duu -t
+como_options -f dii -d d1 --params foo=bar dii=duu -t duu dii
+como_options -f dii -d d1 --params foo=bar dii=duu -t duu dii left over
+como_options -f dii -d d1 -t --params foo=bar dii=duu left over
+como_options -t duu dii --params foo=bar dii=duu -f dii -d d1 left over
+como_options -f dii -d d1 -t duu dii --params foo=bar dii=duu - left over
+como_options -f dii -d d1 -t duu dii - left over -- external arguments
+como_options -f foo -- external arguments
+como_options -f foo -t
+como_options -q dii -f foo -t
+como_options -d -q dii -f foo -t
+como_options -f foo -d dir
+como_options -f foo -d dir -h
+como_options -h -f foo -d dir

data/test/test_config

@@ -0,0 +1,12 @@
+como_config
+como_config --doc
+como_config --doc -f
+como_config --doc -f foo
+como_config -f
+como_config -f dii
+como_config -f dii -d
+como_config --file dii -d d1
+como_config --file dii -d d1 d2
+como_config --debug -f dii -d d1
+como_config -h
+como_config -h --debug -f dii -d d1

data/test/test_options

@@ -0,0 +1,28 @@
+como_options
+como_options --doc
+como_options --doc -f
+como_options --doc -f foo
+como_options -f
+como_options -f dii
+como_options -f dii -d
+como_options --file dii -d d1
+como_options --file dii -d d1 d2
+como_options --debug -f dii -d d1
+como_options -f dii -d d1 --debug
+como_options -f dii -d d1 --debug -m foo
+como_options -f dii -d d1 --debug -m foo
+como_options -f dii -d d1 --params foo=bar dii=duu
+como_options -f dii -d d1 --params foo=bar dii=duu -t
+como_options -f dii -d d1 --params foo=bar dii=duu -t duu dii
+como_options -f dii -d d1 --params foo=bar dii=duu -t duu dii left over
+como_options -f dii -d d1 -t --params foo=bar dii=duu left over
+como_options -t duu dii --params foo=bar dii=duu -f dii -d d1 left over
+como_options -f dii -d d1 -t duu dii --params foo=bar dii=duu - left over
+como_options -f dii -d d1 -t duu dii - left over -- external arguments
+como_options -f foo -- external arguments
+como_options -f foo -t
+como_options -q dii -f foo -t
+como_options -d -q dii -f foo -t
+como_options -f foo -d dir
+como_options -f foo -d dir -h
+como_options -h -f foo -d dir

data/test/test_queries

@@ -0,0 +1,7 @@
+como_queries
+como_queries --doc
+como_queries -m foo
+como_queries --debug -m foo
+como_queries --types t1 t2 t3
+como_queries --types t1 t2 t3
+como_queries --debug -m foo default parameter

data/test/test_rule_1

@@ -0,0 +1,27 @@
+como_rule_1
+como_rule_1 --doc
+como_rule_1 --doc -f
+como_rule_1 --doc -f foo
+como_rule_1 -f
+como_rule_1 -f dii
+como_rule_1 -f dii -m mode
+como_rule_1 -f dii -d dii
+
+como_rule_1 -m mode
+como_rule_1 -m mode --debug
+como_rule_1 -m mode --debug --params fii fuu
+
+como_rule_1 --params fii fuu
+como_rule_1 --params fii fuu --types foo bar
+como_rule_1 --types foo bar --params fii fuu
+como_rule_1 --types foo bar
+
+como_rule_1 -
+como_rule_1 - foo bar
+como_rule_1 foo bar
+como_rule_1 - foo bar -f file
+como_rule_1 - foo bar -f file -d dir
+como_rule_1 - foo bar -d dir
+
+como_rule_1 - -f file -d dir
+como_rule_1 -d dir

data/test/test_rule_2

@@ -0,0 +1,27 @@
+como_rule_2
+como_rule_2 --doc
+como_rule_2 --doc -f
+como_rule_2 --doc -f foo
+como_rule_2 -f
+como_rule_2 -f dii
+como_rule_2 -f dii -m mode
+como_rule_2 -f dii -d dii
+
+como_rule_2 -m mode
+como_rule_2 -m mode --debug
+como_rule_2 -m mode --debug --params fii fuu
+
+como_rule_2 --params fii fuu
+como_rule_2 --params fii fuu --types foo bar
+como_rule_2 --types foo bar --params fii fuu
+como_rule_2 --types foo bar
+
+como_rule_2 -
+como_rule_2 - foo bar
+como_rule_2 foo bar
+como_rule_2 - foo bar -f file
+como_rule_2 - foo bar -f file -d dir
+como_rule_2 - foo bar -d dir
+
+como_rule_2 - -f file -d dir
+como_rule_2 -d dir

data/test/test_subcmd

@@ -0,0 +1,30 @@
+como_subcmd
+como_subcmd -p passwd
+como_subcmd add
+como_subcmd add -f
+como_subcmd add -f file
+como_subcmd -p pass add -f file
+como_subcmd -p pass -u name1 add -f file
+como_subcmd -p pass -u name1 - add -f file
+
+como_subcmd -p pass add -f file -u user
+como_subcmd -p pass add -f file
+como_subcmd -p pass add -f file -fo
+como_subcmd -p pass add -f file -fo -h
+como_subcmd -p pass add -f file -fo rm
+como_subcmd add -f file -fo commit
+como_subcmd -p pass add -f file -fo commit
+
+como_subcmd -p pass rm
+como_subcmd -p pass rm commit
+como_subcmd -p pass rm -f commit
+
+como_subcmd -p pass commit
+como_subcmd -p pass commit dii duu
+como_subcmd -p pass commit -u user1 dii duu
+como_subcmd -p pass commit -u user1 dii duu -h
+como_subcmd -p pass commit -h -u user1 dii duu
+como_subcmd commit -h -u user1 dii duu -h
+como_subcmd commit -u user1 dii duu -h
+
+como_subcmd -p foo commit foo -- external arguments

data/test/test_subcmd_config

@@ -0,0 +1,31 @@
+como_subcmd_config
+como_subcmd_config -p passwd
+como_subcmd_config add
+como_subcmd_config add -f
+como_subcmd_config add -f file
+como_subcmd_config -p pass add -f file
+como_subcmd_config -p pass -u name1 add -f file
+como_subcmd_config -p pass -u name1 - add -f file
+
+como_subcmd_config -p pass add -f file -u user
+como_subcmd_config -p pass add -f file
+como_subcmd_config -p pass add -f file -fo
+como_subcmd_config -p pass add -f file -fo -h
+como_subcmd_config -p pass add -f file -fo rm
+como_subcmd_config add -f file -fo commit
+como_subcmd_config -p pass add -f file -fo commit
+
+como_subcmd_config -p pass rm
+como_subcmd_config -p pass rm -h
+como_subcmd_config -p pass rm commit
+como_subcmd_config -p pass rm -f commit
+
+como_subcmd_config -p pass commit
+como_subcmd_config -p pass commit dii duu
+como_subcmd_config -p pass commit -u user1 dii duu
+como_subcmd_config -p pass commit -u user1 dii duu -h
+como_subcmd_config -p pass commit -h -u user1 dii duu
+como_subcmd_config commit -h -u user1 dii duu
+como_subcmd_config commit -u user1 dii duu -h
+
+como_subcmd_config -p foo commit foo -- external arguments

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: como
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,80 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-12-30 00:00:00.000000000 Z
 dependencies: []
-description: Como provides low manifest command line option parsing and deployment.
+description: ! 'Como provides low manifest command line option parsing and deployment.
   The command line options are described in compact table format and option values
-  are stored to conveniently named properties. Como provides the command usage information
-  based on the option table (plus program info) automatically. Como supports also
-  checking for option combinations using a simple DSL.
+  are stored to conveniently named properties. Como builds command usage information
+  based on the option
+
+  table (+ generic program info) and displays it automatically if necessary. Como
+  supports also subcommands and checking for option combinations using a simple DSL.'
 email: tero.isannainen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.rdoc
+- CHANGELOG.rdoc
 files:
 - README.rdoc
+- CHANGELOG.rdoc
 - LICENSE
 - Rakefile
 - lib/como.rb
+- test/test_subcmd
 - test/test_como.rb
+- test/como_rule_2
+- test/test_config
+- test/test_rule_1
+- test/como_config
+- test/test_subcmd_config
+- test/test_compatible
+- test/test_rule_2
+- test/como_queries
+- test/como_subcmd
+- test/test_options
+- test/como_subcmd_config
+- test/como_rule_1
+- test/test_queries
+- test/como_options
+- test/como_compatible
+- test/golden/rule_1.txt
+- test/golden/queries.txt
+- test/golden/subcmd_config.txt
+- test/golden/subcmd.txt
+- test/golden/rule_2.txt
+- test/golden/compatible.txt
+- test/golden/config.txt
+- test/golden/options.txt
+- doc/top-level-namespace.html
+- doc/js/full_list.js
+- doc/js/app.js
+- doc/js/jquery.js
+- doc/index.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/Como.html
+- doc/file.README.html
+- doc/method_list.html
+- doc/file_list.html
+- doc/class_list.html
+- doc/file.como.html
+- doc/_index.html
+- doc/Como/RuleCheck.html
+- doc/Como/MainOpt.html
+- doc/Como/MasterOpt.html
+- doc/Como/RuleDisplay.html
+- doc/Como/Opt.html
+- doc/Como/ComoCommon.html
+- doc/Como/Opt/MissingArgument.html
+- doc/Como/Opt/ErrorWithData.html
+- doc/Como/Opt/InvalidOption.html
+- doc/Como/ArgsParseState.html
+- doc/Como/Spec.html
+- doc/file.CHANGELOG.html
+- doc/frames.html
 homepage: 
 licenses:
 - Ruby