rubycom 0.3.2 → 0.4.0

data/test/rubycom/singleton_commands_test.rb

@@ -0,0 +1,122 @@
+require "#{File.dirname(__FILE__)}/../../lib/rubycom/singleton_commands.rb"
+
+require "#{File.dirname(__FILE__)}/util_test_module.rb"
+require "#{File.dirname(__FILE__)}/util_test_composite.rb"
+require "#{File.dirname(__FILE__)}/util_test_no_singleton.rb"
+
+require 'test/unit'
+
+class SingletonCommandsTest < Test::Unit::TestCase
+
+  def test_discover_command_command_run
+    test_mod = UtilTestComposite
+    test_args = {:args=>["UtilTestModule", "test_command_with_return", "testing_argument"],:opts=>{"test_option_int"=>10}}
+    result = Rubycom::SingletonCommands.discover_command(test_mod, test_args)
+    expected = UtilTestModule.public_method(:test_command_with_return)
+    assert_equal(expected, result)
+  end
+
+  def test_discover_commands_nil
+    test_mod = UtilTestComposite
+    test_args = nil
+    result = nil
+    assert_raise(ArgumentError) { Rubycom::SingletonCommands.discover_commands(test_mod, test_args) }
+    expected = nil
+    assert_equal(expected, result)
+  end
+
+  def test_discover_commands_nil_args
+    test_mod = UtilTestComposite
+    test_args = {}
+    result = Rubycom::SingletonCommands.discover_commands(test_mod, test_args)
+    expected = [
+        UtilTestComposite
+    ]
+    assert_equal(expected, result)
+  end
+
+  def test_discover_commands_empty
+    test_mod = UtilTestComposite
+    test_args = {:args => []}
+    result = Rubycom::SingletonCommands.discover_commands(test_mod, test_args)
+    expected = [
+        UtilTestComposite
+    ]
+    assert_equal(expected, result)
+  end
+
+  def test_discover_commands_command_before_module
+    test_mod = UtilTestComposite
+    test_args = {:args => ['test_command', 'UtilTestModule', 'test_extra_arg']}
+    result = Rubycom::SingletonCommands.discover_commands(test_mod, test_args)
+    expected = [
+        UtilTestComposite,
+        "test_command",
+        "UtilTestModule",
+        "test_extra_arg"
+    ]
+    assert_equal(expected, result)
+  end
+
+  def test_discover_commands_no_module_match
+    test_mod = UtilTestComposite
+    test_args = {:args => ['test_arg', 'test_command', 'test_extra_arg']}
+    result = Rubycom::SingletonCommands.discover_commands(test_mod, test_args)
+    expected = [
+        UtilTestComposite,
+        "test_arg",
+        "test_command",
+        "test_extra_arg"
+    ]
+    assert_equal(expected, result)
+  end
+
+  def test_discover_commands_no_method_match
+    test_mod = UtilTestComposite
+    test_args = {:args => ['UtilTestModule', 'test_arg', 'test_extra_arg']}
+    result = Rubycom::SingletonCommands.discover_commands(test_mod, test_args)
+    expected = [
+        UtilTestComposite,
+        UtilTestModule,
+        "test_arg",
+        "test_extra_arg"
+    ]
+    assert_equal(expected, result)
+  end
+
+  def test_discover_commands_extra_arg
+    test_mod = UtilTestComposite
+    test_args = {:args => ['UtilTestModule', 'test_command', 'test_extra_arg']}
+    result = Rubycom::SingletonCommands.discover_commands(test_mod, test_args)
+    expected = [
+        UtilTestComposite,
+        UtilTestModule,
+        UtilTestModule.public_method(:test_command),
+        "test_extra_arg"
+    ]
+    assert_equal(expected, result)
+  end
+
+  def test_get_commands
+    test_mod = UtilTestComposite
+    result = Rubycom::SingletonCommands.get_commands(test_mod)
+    result.each{|k, v|
+      assert(k.class == Symbol, "each key should be a symbol")
+      UtilTestComposite.included_modules.include?(k)
+      assert([Hash, Symbol].include?(v.class), "each value should be a Hash or a Symbol")
+      assert(v == :method, "if the returned value is not a hash then it should be the symbol :method") if v.class == Symbol
+    }
+  end
+
+  def test_get_commands_all_false
+    test_mod = UtilTestComposite
+    result_keys = Rubycom::SingletonCommands.get_commands(test_mod, false)[:UtilTestComposite].keys.map{|key|key.to_s}
+    test_mod.singleton_methods(false).each{|meth|
+      assert(result_keys.include?(meth.to_s), "get_commands result keys: #{result_keys} should include base module singleton method #{meth.to_s}")
+    }
+    test_mod.included_modules.reject{|mod|mod.to_s == "Rubycom"}.each{|mod|
+      assert(result_keys.include?(mod.to_s), "get_commands result keys: #{result_keys} should include base included module #{mod.to_s}")
+    }
+  end
+
+end

data/test/rubycom/sources_test.rb

@@ -0,0 +1,59 @@
+require "#{File.dirname(__FILE__)}/../../lib/rubycom/sources.rb"
+
+require "#{File.dirname(__FILE__)}/util_test_bin.rb"
+require "#{File.dirname(__FILE__)}/util_test_module.rb"
+require "#{File.dirname(__FILE__)}/util_test_composite.rb"
+require "#{File.dirname(__FILE__)}/util_test_no_singleton.rb"
+
+require 'test/unit'
+
+class SourcesTest < Test::Unit::TestCase
+
+  def test_source_commands
+    test_commands = [
+        UtilTestComposite,
+        UtilTestModule,
+        UtilTestModule.public_method(:test_command),
+        "test_extra_arg"
+    ]
+    result = Rubycom::Sources.source_commands(test_commands)
+    assert(result.size > 0, "should be at least one result")
+    result.each{|res|
+      assert(res.class == Hash, "each result should be a Hash")
+      assert(res.size == 2, "each result should have two keys")
+      assert(res.has_key?(:command), "each result should have a :command key")
+      assert(res.has_key?(:source), "each result should have a :source key")
+    }
+    assert(result.select{|res|res[:command] == UtilTestComposite}.size == 1, "result should have a UtilTestComposite command")
+    assert(result.select{|res|res[:command] == UtilTestModule}.size == 1, "result should have a UtilTestComposite command")
+    assert(result.select{|res|res[:command] == UtilTestModule.public_method(:test_command)}.size == 1, "result should have a test_command method command")
+    assert(result.select{|res|res[:command] == "test_extra_arg"}.size == 1, "result should have a test_extra_arg String command")
+    assert_equal(result.select{|res|res[:command] == UtilTestComposite}.first[:source].gsub("\n",''), (File.read("#{File.dirname(__FILE__)}/util_test_composite.rb")+File.read("#{File.dirname(__FILE__)}/util_test_sub_module.rb")+File.read("#{File.dirname(__FILE__)}/util_test_bin.rb")).gsub("\n",''))
+    assert_equal(result.select{|res|res[:command] == UtilTestModule}.first[:source].gsub("\n",''), (File.read("#{File.dirname(__FILE__)}/util_test_module.rb")).gsub("\n",''))
+    assert_equal(result.select{|res|res[:command] == UtilTestModule.public_method(:test_command)}.first[:source].gsub("\n",''), "# A basic test command\n  def self.test_command\n    puts 'command test'\n  end\n".gsub("\n",''))
+    assert_equal(result.select{|res|res[:command] == "test_extra_arg"}.first[:source].gsub("\n",''), "test_extra_arg")
+  end
+
+  def test_source_command_run
+    test_command = UtilTestModule.public_method(:test_command_with_return)
+    result = Rubycom::Sources.source_command(test_command)
+    expected = "# A test_command with a return argument\n#\n# @param [String] test_arg a test argument\n# @param [Integer] test_option_int an optional test argument which happens to be an Integer\n# @return [Array] an array including both params if test_option_int != 1\n# @return [String] the first param if test_option_int == 1\n  def self.test_command_with_return(test_arg, test_option_int=1)\n    ret = [test_arg, test_option_int]\n    if test_option_int == 1\n      ret = test_arg\n    end\n    ret\n  end\n"
+    assert_equal(expected, result)
+  end
+
+  def test_source_command_run_module
+    test_command = UtilTestModule
+    result = Rubycom::Sources.source_command(test_command)
+    expected = File.read("#{File.dirname(__FILE__)}/util_test_module.rb")
+    assert_equal(expected, result)
+  end
+
+  def test_source_command_run_composite
+    test_command = UtilTestComposite
+    result = Rubycom::Sources.source_command(test_command)
+    bin_file = File.read("#{File.dirname(__FILE__)}/util_test_bin.rb")
+    lib_file = File.read("#{File.dirname(__FILE__)}/util_test_composite.rb")
+    assert(result.include?(bin_file),"source for composite module #{test_command} must include bin_file")
+    assert(result.include?(lib_file),"source for composite module #{test_command} must include lib_file")
+  end
+end

data/test/rubycom/util_test_bin.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "#{File.expand_path(File.dirname(__FILE__))}/../../lib/rubycom.rb"
+require "#{File.expand_path(File.dirname(__FILE__))}/util_test_composite.rb"
+
+# Test library entry point. Acts as the runnable for UtilTestComposite.rb
+module UtilTestComposite
+  include Rubycom
+end

data/test/rubycom/util_test_composite.rb

@@ -1,20 +1,23 @@
-#!/usr/bin/env ruby
-require "#{File.expand_path(File.dirname(__FILE__))}/../../lib/rubycom.rb"
-require "#{File.expand_path(File.dirname(__FILE__))}/util_test_module.rb"
-require "#{File.expand_path(File.dirname(__FILE__))}/util_test_no_singleton.rb"
-
-module UtilTestComposite
-  include UtilTestModule
-
-  include UtilTestNoSingleton
-
-  # A test_command in a composite console
-  #
-  # @param [String] test_arg a test argument
-  # @return [String] the test arg
-  def self.test_composite_command(test_arg)
-    test_arg
-  end
-
-  include Rubycom
-end
+#!/usr/bin/env ruby
+require "#{File.expand_path(File.dirname(__FILE__))}/../../lib/rubycom.rb"
+require "#{File.expand_path(File.dirname(__FILE__))}/util_test_module.rb"
+require "#{File.expand_path(File.dirname(__FILE__))}/util_test_no_singleton.rb"
+
+# Composite module for testing
+module UtilTestComposite
+  include UtilTestModule
+
+  include UtilTestNoSingleton
+
+  require "#{File.expand_path(File.dirname(__FILE__))}/util_test_sub_module.rb"
+  include UtilTestSubModule
+
+  # A test_command in a composite console
+  #
+  # @param [String] test_arg a test argument
+  # @return [String] the test arg
+  def self.test_composite_command(test_arg)
+    test_arg
+  end
+
+end

data/test/rubycom/util_test_module.rb

@@ -1,112 +1,142 @@
-require "#{File.expand_path(File.dirname(__FILE__))}/../../lib/rubycom.rb"
-# A command module used for testing
-module UtilTestModule
-
-  # A test non-command method
-  def non_command
-    puts 'fail'
-  end
-
-  # A basic test command
-  def self.test_command
-    puts 'command test'
-  end
-
-  def self.test_command_no_docs
-    puts 'command test'
-  end
-
-  # A test_command with one arg
-  #
-  # @param [String] test_arg a test argument
-  def self.test_command_with_arg(test_arg)
-    "test_arg=#{test_arg}"
-  end
-
-  # A test_command with an arg named arg
-  #
-  # @param [String] arg a test argument whose parameter name is arg
-  def self.test_command_arg_named_arg(arg)
-    "arg=#{arg}"
-  end
-
-  # A test_command with two args
-  # @param [String] test_arg a test argument
-  # @param [String] another_test_arg another test argument
-  def self.test_command_with_args(test_arg, another_test_arg)
-    puts "test_arg=#{test_arg},another_test_arg=#{another_test_arg}"
-  end
-
-  # A test_command with an optional argument
-  # @param [String] test_arg a test argument
-  # @param [String] test_option an optional test argument
-  def self.test_command_with_options(test_arg, test_option='option_default')
-    puts "test_arg=#{test_arg},test_option=#{test_option}"
-  end
-
-  # A test_command with all optional arguments
-  # @param [String] test_arg an optional test argument
-  # @param [String] test_option another optional test argument
-  def self.test_command_all_options(test_arg='test_arg_default', test_option='test_option_default')
-    puts "Output is test_arg=#{test_arg},test_option=#{test_option}"
-  end
-
-  # A test_command with an options array
-  # @param [String] test_option an optional test argument
-  # @param [Array] test_options an optional array of arguments
-  def self.test_command_options_arr (
-      test_option="test_option_default",
-          *test_options
-  )
-    puts "Output is test_option=#{test_option},test_option_arr=#{test_options}"
-  end
-
-  # A test_command with a return argument
-  #
-  # @param [String] test_arg a test argument
-  # @param [Integer] test_option_int an optional test argument which happens to be an Integer
-  # @return [Array] an array including both params if test_option_int != 1
-  # @return [String] a the first param if test_option_int == 1
-  def self.test_command_with_return(test_arg, test_option_int=1)
-    ret = [test_arg, test_option_int]
-    if test_option_int == 1
-      ret = test_arg
-    end
-    ret
-  end
-
-  # A test_command with a Timestamp argument and an unnecessarily long description which should overflow when
-  # it tries to line up with other descriptions.
-  # @param [Timestamp] test_time a test Timestamp argument
-  # @return [Hash] a hash including the given argument
-  def self.test_command_arg_timestamp(test_time)
-    {test_time: test_time}
-  end
-
-  # A test_command with a Boolean argument
-  # @param [Boolean] test_flag a test Boolean argument
-  # @return [Boolean] the flag passed in
-  def self.test_command_arg_false(test_flag=false)
-    test_flag
-  end
-
-  # A test_command with an array argument
-  #
-  # @param [Array] test_arr an Array test argument
-  def self.test_command_arg_arr(test_arr=[])
-    test_arr
-  end
-
-  # A test_command with an Hash argument
-  # @param [Hash] test_hash a Hash test argument
-  def self.test_command_arg_hash(test_hash={})
-    test_hash
-  end
-
-  # A test_command with several mixed options
-  def self.test_command_mixed_options(test_arg, test_arr=[], test_opt='test_opt_arg', test_hsh={}, test_bool=true, *test_rest)
-    "test_arg=#{test_arg} test_arr=#{test_arr} test_opt=#{test_opt} test_hsh=#{test_hsh} test_bool=#{test_bool} test_rest=#{test_rest}"
-  end
-
-  include Rubycom
-end
+require "#{File.expand_path(File.dirname(__FILE__))}/../../lib/rubycom.rb"
+# A command module used for testing
+#
+#This module contains most of the test case input methods.
+module UtilTestModule
+
+  # A test non-command method
+  def non_command
+    puts 'fail'
+  end
+
+  # A basic test command
+  def self.test_command
+    puts 'command test'
+  end
+
+  def self.test_command_no_docs
+    puts 'command test'
+  end
+
+  # A test_command with one arg
+  #
+  # @param [String] test_arg a test argument
+  def self.test_command_with_arg(test_arg)
+    "test_arg=#{test_arg}"
+  end
+
+  # A test_command with an arg named arg
+  #
+  # @param [String] arg a test argument whose parameter name is arg
+  def self.test_command_arg_named_arg(arg)
+    "arg=#{arg}"
+  end
+
+  # A test_command with two args
+  # @param [String] test_arg a test argument
+  # @param [String] another_test_arg another test argument
+  def self.test_command_with_args(test_arg, another_test_arg)
+    puts "test_arg=#{test_arg},another_test_arg=#{another_test_arg}"
+  end
+
+  # A test_command with an optional argument
+  # @param [String] test_arg a test argument
+  # @param [String] test_option an optional test argument
+  def self.test_command_with_options(test_arg, test_option='option_default')
+    puts "test_arg=#{test_arg},test_option=#{test_option}"
+  end
+
+  # A test_command with all optional arguments
+  # @param [String] test_arg an optional test argument
+  # @param [String] test_option another optional test argument
+  def self.test_command_all_options(test_arg='test_arg_default', test_option='test_option_default')
+    puts "Output is test_arg=#{test_arg},test_option=#{test_option}"
+  end
+
+  # A test_command with a nil optional argument
+  # @param [String] test_arg a test argument
+  # @param [String] test_option an optional test argument with a nil default value
+  # @return [String] a message including the value and class of each parameter
+  def self.test_command_nil_option(test_arg, test_option=nil)
+    "test_arg=#{test_arg}, test_arg.class=#{test_arg.class}, test_option=#{test_option}, test_option.class=#{test_option.class}"
+  end
+
+  # A test_command with an options array
+  # @param [String] test_option an optional test argument
+  # @param [Array] test_options an optional array of arguments
+  def self.test_command_options_arr (
+      test_option='test_option_default',
+          *test_options
+  )
+    puts "Output is test_option=#{test_option},test_option_arr=#{test_options}"
+  end
+
+  # A test_command with a return argument
+  #
+  # @param [String] test_arg a test argument
+  # @param [Integer] test_option_int an optional test argument which happens to be an Integer
+  # @return [Array] an array including both params if test_option_int != 1
+  # @return [String] the first param if test_option_int == 1
+  def self.test_command_with_return(test_arg, test_option_int=1)
+    ret = [test_arg, test_option_int]
+    if test_option_int == 1
+      ret = test_arg
+    end
+    ret
+  end
+
+  # A test_command with a Timestamp argument and an unnecessarily long description which should overflow when
+  # it tries to line up with other descriptions.
+  #
+  # some more stuff
+  #
+  # @param [Timestamp] test_time a test Timestamp argument
+  # @return [Hash] a hash including the given argument
+  def self.test_command_arg_timestamp(test_time)
+    {:test_time => test_time}
+  end
+
+  # A test_command with a Boolean argument
+  # @param [Boolean] test_flag a test Boolean argument
+  # @return [Boolean] the flag passed in
+  def self.test_command_arg_false(test_flag=false)
+    test_flag
+  end
+
+  # A test_command with an array argument
+  #
+  # @param [Array] test_arr an Array test argument
+  def self.test_command_arg_arr(test_arr=[])
+    test_arr
+  end
+
+  # A test_command with an Hash argument
+  # @param [Hash] test_hash a Hash test argument
+  def self.test_command_arg_hash(test_hash={})
+    test_hash
+  end
+
+  # A test_command with several mixed options
+  #
+  # @param [String] test_arg
+  # @param [Array] test_arr
+  # @param [String] test_opt
+  # @param [Fixnum] test_opt
+  def self.test_command_mixed_options(test_arg, test_arr=[], test_opt='test_opt_arg', test_hsh={}, test_bool=true, *test_rest)
+    "test_arg=#{test_arg} test_arr=#{test_arr} test_opt=#{test_opt} test_hsh=#{test_hsh} test_bool=#{test_bool} test_rest=#{test_rest}"
+  end
+
+  # A test_command with several mixed options with varying names
+  #
+  # @param [Object] arg_test anything
+  # @param [Array] arr an array of things
+  # @param [String] opt an optional string
+  # @param [Hash] hsh a hash representing some test keys and values
+  # @param [TrueClass|FalseClass] bool a true or false
+  # @param [Array] rest_test everything else
+  def self.test_command_mixed_names(arg_test, arr=[], opt='test_opt_arg', hsh={}, bool=true, *rest_test)
+    "arg_test=#{arg_test} arr=#{arr} opt=#{opt} hsh=#{hsh} bool=#{bool} rest_test=#{rest_test}"
+  end
+
+  include Rubycom
+end