rubycom 0.1.1

data/test/rubycom/util_test_composite.rb

@@ -0,0 +1,16 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/../../lib/rubycom.rb"
+require "#{File.expand_path(File.dirname(__FILE__))}/util_test_module.rb"
+
+module UtilTestComposite
+  include UtilTestModule
+
+  # 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

data/test/rubycom/util_test_module.rb

@@ -0,0 +1,96 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/../../lib/rubycom.rb"
+
+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
+
+  # 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 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 [String] 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
+
+  include Rubycom
+end

data/test/rubycom/util_test_no_singleton.rb

@@ -0,0 +1,10 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/../../lib/rubycom.rb"
+require "#{File.expand_path(File.dirname(__FILE__))}/util_test_composite.rb"
+
+module UtilTestNoSingleton
+  def test_method
+    "TEST_NON_SINGLETON_METHOD"
+  end
+
+  include Rubycom
+end

data/test/rubycom/utility_tester.rb

@@ -0,0 +1,17 @@
+require 'time'
+
+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_composite.rb"
+require "#{File.expand_path(File.dirname(__FILE__))}/util_test_no_singleton.rb"
+
+require 'test/unit'
+#noinspection RubyInstanceMethodNamingConvention
+class TestCase < Test::Unit::TestCase
+  def test_case
+    base = UtilTestModule
+    args = ["test_command_arg_hash"]
+    result = Rubycom.run(base, args)
+    puts result
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rubycom
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Danny Purcell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows command-line access for all singleton methods in an including
+  class. Reads Yard style documentation for command line help output. Uses Yaml for
+  parsing options. Allows the user to make a command-line tool by simply including
+  Rubycom at the bottom.
+email:
+- dpurcelljr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubycom.rb
+- lib/rubycom/version.rb
+- rubycom.gemspec
+- test/rubycom/test_rubycom.rb
+- test/rubycom/util_test_composite.rb
+- test/rubycom/util_test_module.rb
+- test/rubycom/util_test_no_singleton.rb
+- test/rubycom/utility_tester.rb
+homepage: http://dannypurcell.github.io/Rubycom
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Converts singleton methods to command-line functions upon inclusion.
+test_files:
+- test/rubycom/test_rubycom.rb
+- test/rubycom/util_test_composite.rb
+- test/rubycom/util_test_module.rb
+- test/rubycom/util_test_no_singleton.rb
+- test/rubycom/utility_tester.rb
+has_rdoc: