rubycom 0.2.0 → 0.2.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzIyZGNiNTNlZGYwNTllMDcwOTFhNzE5YjMyMTE2M2YxZWFiNzM5MA==
+  data.tar.gz: !binary |-
+    YmI0MWUwNWVkMzExYjUyNjVjOGMwNWVjYzE5ZTNhZDFhMTg4Yjk4OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Njc2YzE2YTBkNDNkN2FkZGI4MTZhNWIyNzVkNzdjYjE2YTg5ZDcyYmE1MTg0
+    Y2RkMTg1YzY2Yzg2N2M4NTMzY2QzN2Y1MDQ1N2JkZGU2NzhjYWQ0ZWYwMmRk
+    YjkyYTg2MTVlNzA3ZmRkZGZjMmExZDIwMmVmNTliMmMxM2JlMzA=
+  data.tar.gz: !binary |-
+    M2EzNTAwODE5OTdjYzNmNjYxYzc0YjRmZjRlMjU4NGVhNTE3YjI4MzZiNGFh
+    ZWVkNDBlY2YxYmRjYzMxNGRiZWYwNzhlMzE2NzE0MmQwMjlkNDhmZjU2ZGQw
+    Y2M5Mjg2MjM1OWIwYjE0OWI3OTVmMjBiYmU4OGE3MWU2M2JmNjI=

data/Rakefile

@@ -29,9 +29,9 @@ task :package => [:clean, :test, :yard] do
 end
 
 task :install => :package do
-  system("gem install rubycom-#{Rubycom::VERSION}")
+  system("gem install #{File.expand_path(File.dirname(__FILE__))}/rubycom-#{Rubycom::VERSION}.gem")
 end
 
 task :release => :package do
-  system("gem push ./rubycom-#{Rubycom::VERSION}.gem")
+  system("gem push #{File.expand_path(File.dirname(__FILE__))}/rubycom-#{Rubycom::VERSION}.gem")
 end

data/lib/rubycom.rb

@@ -50,6 +50,7 @@ module Rubycom
         begin
           raise CLIError, 'No job specified' if arguments[0].nil? || arguments[0].empty?
           job_hash = YAML.load_file(arguments[0])
+          job_hash = {} if job_hash.nil?
           STDOUT.sync = true
           if arguments.delete('-test') || arguments.delete('--test')
             puts "[Test Job #{arguments[0]}]"
@@ -96,6 +97,7 @@ module Rubycom
   # @param [String] command the name of the Method to call
   # @param [Array] arguments a String Array representing the arguments for the given command
   def self.run_command(base, command, arguments=[])
+    arguments = [] if arguments.nil?
     raise CLIError, 'No command specified.' if command.nil? || command.length == 0
     begin
       raise CLIError, "Invalid Command: #{command}" unless self.get_top_level_commands(base).include? command.to_sym
@@ -182,6 +184,11 @@ module Rubycom
     }.reduce(:+) or "No Commands found for #{base}."
   end
 
+  # Creates a separator with the appropriate spacing to line up a command/description pair in a command list
+  #
+  # @param [Symbol] sym
+  # @param [Integer] spacer_length
+  # @return [String] a spaced separator String for use in a command/description list
   def self.get_separator(sym, spacer_length=0)
     [].unshift(" " * (spacer_length - sym.to_s.length)).join << "  -  "
   end
@@ -195,6 +202,7 @@ module Rubycom
     raise CLIError, "Can not get usage for #{command_name} with base: #{base||"nil"}" if base.nil? || !base.respond_to?(:included_modules)
     return 'No command specified.' if command_name.nil? || command_name.length == 0
     if base.included_modules.map { |mod| mod.name.to_sym }.include?(command_name.to_sym)
+      begin
       mod_const = Kernel.const_get(command_name.to_sym)
       desc = File.read(mod_const.public_method(mod_const.singleton_methods().first).source_location.first).split(//).reduce(""){|str,c|
         unless str.gsub("\n",'').gsub(/\s+/,'').include?("module#{mod_const}")
@@ -202,13 +210,21 @@ module Rubycom
           end
           str
       }.split("\n").select{|line| line.strip.match(/^#/)}.map{|line| line.strip.gsub(/^#+/,'')}.join("\n")
+      rescue
+        desc = ""
+      end
     else
       raise CLIError, "Invalid command for #{base}, #{command_name}" unless base.public_methods.include?(command_name.to_sym)
-      desc = self.get_doc(base.public_method(command_name.to_sym))[:desc].join("\n") rescue nil
+      desc = self.get_doc(base.public_method(command_name.to_sym))[:desc].join("\n") rescue ""
     end
     (desc.nil?||desc=='nil'||desc.length==0) ? "#{command_name}\n" : self.get_formatted_summary(command_name, desc, separator)
   end
 
+  # Arranges the given command_name and command_description with the separator in a standard format
+  #
+  # @param [String] command_name the command format
+  # @param [String] command_description the description for the given command
+  # @param [String] separator optional separator to use
   def self.get_formatted_summary(command_name, command_description, separator = '  -  ')
     width = 95
     prefix = command_name.to_s.split(//).map { " " }.join + separator.split(//).map { " " }.join
@@ -245,7 +261,7 @@ module Rubycom
     else
       raise CLIError, "Invalid command for #{base}, #{command_name}" unless base.public_methods.include?(command_name.to_sym)
       m = base.public_method(command_name.to_sym)
-      method_doc = self.get_doc(m)
+      method_doc = self.get_doc(m) || {}
 
       msg = "Usage: #{m.name} #{self.get_param_usage(m)}\n"
       msg << "#{"Parameters:"}\n" unless m.parameters.empty?
@@ -256,6 +272,9 @@ module Rubycom
     end
   end
 
+  # Discovers the given Method's parameters and uses them to build a formatted usage string
+  #
+  # @param [Method] method the Method object to generate usage for
   def self.get_param_usage(method)
     return "" if method.parameters.nil? || method.parameters.empty?
     method.parameters.map { |type, param| {type => param}
@@ -297,7 +316,7 @@ module Rubycom
     }.reduce(&:merge) || {}
   end
 
-  # Retrieves the given method's documentation from it's source code.
+  # Retrieves the given method's documentation from it's source code
   #
   # @param [Method] method the Method who's documentation should be retrieved
   # @return [Hash] a Hash representing the given Method's documentation, documentation parsed as follows:
@@ -316,16 +335,21 @@ module Rubycom
     }.reduce(&:merge)
   end
 
+  # Looks up the commands which will be available on the given base Module and returns the longest command name
+  # Used in arranging the command list format
+  #
+  # @param [Module] base the base Module to look up
+  # @return [String] the longest command name which will show in a list of commands for the given base Module
   def self.get_longest_command_name(base)
     return '' if base.nil?
     self.get_commands(base, false).map { |_, mod_hash|
       mod_hash[:commands] + mod_hash[:inclusions].flatten }.flatten.max_by(&:size) or ''
   end
 
-  # Retrieves the singleton methods in the given base
+  # Retrieves the singleton methods in the given base and included Modules
   #
   # @param [Module] base the module which invoked 'include Rubycom'
-  # @param [Boolean] all if true recursively search for included modules' commands, if false return only top level commands.
+  # @param [Boolean] all if true recursively search for included modules' commands, if false return only top level commands
   # @return [Hash] a Hash of Symbols representing the command methods in the given base and it's included modules (if all=true)
   def self.get_commands(base, all=true)
     return {} if base.nil? || !base.respond_to?(:singleton_methods) || !base.respond_to?(:included_modules)
@@ -341,6 +365,10 @@ module Rubycom
     }
   end
 
+  # Discovers the commands specified in the given base without considering the commands contained in sub-modules
+  #
+  # @param [Module] base the base Module to search
+  # @return [Array] a list of command name symbols which are defined in the given Module
   def self.get_top_level_commands(base)
     return {} if base.nil? || !base.respond_to?(:singleton_methods) || !base.respond_to?(:included_modules)
     excluded_commands = [:included, :extended]
@@ -349,6 +377,10 @@ module Rubycom
         base.included_modules.select { |mod| !excluded_modules.include?(mod.name.to_sym) }.map { |mod| mod.name.to_sym }.flatten
   end
 
+  # Discovers the commands specified in the given base and included Modules
+  #
+  # @param [Module] base the base Module to search
+  # @return [Hash] a set of command name symbols mapped to containing Modules
   def self.index_commands(base)
     excluded_commands = [:included, :extended]
     excluded_modules = [:Rubycom]

data/lib/rubycom/version.rb

@@ -1,3 +1,3 @@
 module Rubycom
-  VERSION = "0.2.0"
+  VERSION = "0.2.3"
 end

data/rubycom.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["d.purcell.jr+rubycom@gmail.com"]
   spec.description   = %q{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.}
   spec.summary       = %q{Converts singleton methods to command-line functions upon inclusion.}
-  spec.homepage      = "http://dannypurcell.github.io/Rubycom"
+  spec.homepage      = "http://dannypurcell.github.io/rubycom"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/test/rubycom/test_rubycom.rb

@@ -114,6 +114,7 @@ class TestRubycom < Test::Unit::TestCase
 
     Commands:
     test_command                -  A basic test command
+    test_command_no_docs
     test_command_with_arg       -  A test_command with one arg
     test_command_arg_named_arg  -  A test_command with an arg named arg
     test_command_with_args      -  A test_command with two args
@@ -150,6 +151,7 @@ class TestRubycom < Test::Unit::TestCase
     expected = <<-END.gsub(/^ {4}/, '')
     Commands:
     test_command                -  A basic test command
+    test_command_no_docs
     test_command_with_arg       -  A test_command with one arg
     test_command_arg_named_arg  -  A test_command with an arg named arg
     test_command_with_args      -  A test_command with two args
@@ -180,7 +182,7 @@ class TestRubycom < Test::Unit::TestCase
   end
 
   def test_get_top_level_commands
-    test_command_list = [:test_command, :test_command_with_arg, :test_command_arg_named_arg, :test_command_with_args, :test_command_with_options,
+    test_command_list = [:test_command, :test_command_no_docs, :test_command_with_arg, :test_command_arg_named_arg, :test_command_with_args, :test_command_with_options,
                          :test_command_all_options, :test_command_options_arr, :test_command_with_return,
                          :test_command_arg_timestamp, :test_command_arg_false, :test_command_arg_arr,
                          :test_command_arg_hash]
@@ -398,6 +400,7 @@ class TestRubycom < Test::Unit::TestCase
 
     Commands:
     test_command                -  A basic test command
+    test_command_no_docs
     test_command_with_arg       -  A test_command with one arg
     test_command_arg_named_arg  -  A test_command with an arg named arg
     test_command_with_args      -  A test_command with two args

data/test/rubycom/util_test_composite.rb

@@ -1,9 +1,12 @@
 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

data/test/rubycom/util_test_module.rb

@@ -12,6 +12,10 @@ module UtilTestModule
     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

data/test/rubycom/util_test_no_singleton.rb

@@ -1,5 +1,4 @@
 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

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: rubycom
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.3
 platform: ruby
 authors:
 - Danny Purcell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -115,30 +104,29 @@ files:
 - test/rubycom/util_test_module.rb
 - test/rubycom/util_test_no_singleton.rb
 - test/rubycom/utility_tester.rb
-homepage: http://dannypurcell.github.io/Rubycom
+homepage: http://dannypurcell.github.io/rubycom
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Converts singleton methods to command-line functions upon inclusion.
 test_files:
 - test/rubycom/test_rubycom.rb