commandable 0.2.0.beta01

data/spec/source_code_examples/no_description.rb

@@ -0,0 +1,10 @@
+@@command_options
+require "commandable"
+
+class NoDescription
+  extend Commandable
+  command
+  def method_with_no_description
+    "called method_with_no_description"
+  end
+end

data/spec/source_code_examples/parameter_class.rb

@@ -0,0 +1,27 @@
+@@command_options
+require "commandable"
+
+class ParameterClass
+  extend Commandable
+
+  command "hello world"
+  def foo(int_arg1, number_arg2)
+    [int_arg1, number_arg2]
+  end
+
+  command "look a function"
+  def bar(int_arg1, string_arg2="Number 42")
+    [int_arg1, string_arg2]
+  end
+  
+  command "run me for stuff to happen"
+  def qux string_arg1 ="1492", string_arg2 = "I'm a tricky one"
+    [string_arg1, string_arg2]
+  end
+  
+  command "I'm another function!"
+  def baz number_arg1, string_arg2 = "blorp", *array_arg3
+    [number_arg1, string_arg2, array_arg3]
+  end
+
+end

data/spec/source_code_examples/parameter_free.rb

@@ -0,0 +1,22 @@
+@@command_options
+require "commandable"
+
+class ParameterFree
+  extend Commandable
+
+  command 'this method has no params'
+  def no_parms1
+    "no_parms1"
+  end
+
+  command 'none here either'
+  def no_parms2
+    "no_parms2"
+  end
+
+  command 'nope, still none'
+  def no_parms3
+    "no_parms3"
+  end
+
+end

data/spec/source_code_examples/required_methods.rb

@@ -0,0 +1,18 @@
+@@command_options
+require "commandable"
+
+class RequiredMethods
+  
+  extend Commandable
+
+  command :required, 'does some stuff'
+  def required_method(gimmie)
+    gimmie
+  end
+  
+  command "another one"
+  def non_required_method(meh)
+    meh
+  end
+
+end

data/spec/source_code_examples/super_deep_class.rb

@@ -0,0 +1,28 @@
+@@command_options
+require "commandable"
+
+module TopModule
+  class ParentClass
+    module WhatWhat
+      class OhNoYouDian
+        module OhYesIDid
+          module TwoSnapsUpIn
+            class ACircle
+              module Exclamation
+                module OKEvenImBoredNow
+                  class DeepDeepClass
+                    extend Commandable
+                    command 'this is a really deep method call'
+                    def super_deep_method
+                      "you called a deep method"
+                    end 
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/source_code_examples/test_class.rb

@@ -0,0 +1,13 @@
+@@command_options
+require "commandable"
+
+class TestClass
+  extend Commandable
+  command 'does some stuff'
+  def test_method
+    "test_method"
+  end 
+end
+
+
+puts Commandable.execution_queue([])

data/spec/source_code_examples/xor_class.rb

@@ -0,0 +1,37 @@
+@@command_options
+require "commandable"
+
+class XorClass
+  extend Commandable
+
+  command 'a normal method'
+  def normal_method
+    "normal_method"
+  end
+
+  command 'another normal method'
+  def normal_method2
+    "normal_method2"
+  end
+
+  command 'part of the default :xor group', :xor, :default
+  def xor_method1
+    "xor_method1"
+  end
+  
+  command "also in the default :xor group", :xor
+  def xor_method2
+    "xor_method2"
+  end
+
+  command 'you can also make your own groups', :xor => :xor_group
+  def xor_method3
+    "xor_method3"
+  end
+  
+  command "use wantever you want as group names", :xor => :xor_group
+  def xor_method4
+    "xor_method4"
+  end
+
+end

data/spec/source_code_for_errors/class_bad.rb

@@ -0,0 +1,7 @@
+@@command_options
+require "commandable"
+
+class ClassBad
+  extend Commandable
+  command 'this should fail because their is no method'
+end

data/spec/source_code_for_errors/default_method_bad.rb

@@ -0,0 +1,17 @@
+@@command_options
+require "commandable"
+
+class DefaultMethodsBad
+  extend Commandable
+  
+  command 'does some stuff', :default
+  def default_method
+    "default_method"
+  end 
+  
+  command 'does some other stuff', :default
+  def default_method2
+    "default_method2"
+  end 
+
+end

data/spec/source_code_for_errors/private_methods_bad.rb

@@ -0,0 +1,10 @@
+@@command_options
+require "commandable"
+
+# This is just a not so clever way of getting at the instance methods of Commandable
+# Accessing the private methods of a class/module is a bad idea but I really need to
+# test them. Plus making a helper module just to test them is also against best practices
+# so...
+class PrivateMethods
+  extend Commandable
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+$:.unshift File.expand_path((File.dirname(__FILE__) + '/../lib'))
+$:.unshift File.expand_path((File.dirname(__FILE__) + '/source_code_examples'))
+$:.unshift File.expand_path((File.dirname(__FILE__) + '/source_code_for_errors'))
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'term/ansicolor'
+require 'rspec'
+require 'commandable'
+
+# A note on the specs:
+# Since Commandable uses singletons the tests sometimes get confused about their state.
+# I'm working on a way to properly clear every thing out of memory before each test but tests
+# doesn't pass in autotest try running the test again or run rspec yourself and they'll pass.
+
+# Debug print
+module Kernel
+  def dp(value)
+    puts ""
+    puts "*" * 40
+    puts "value: #{value}"
+    puts "&" * 40
+    puts ""
+  end
+  def dpi(value)
+    puts ""
+    puts "*" * 40
+    pp value
+    puts "&" * 40
+    puts ""
+  end
+end
+
+# Trap STDOUT and STDERR for testing what a method prints to the terminal
+def capture_output
+  begin
+    require 'stringio'
+    $o_stdout, $o_stderr = $stdout, $stderr
+    $stdout, $stderr = StringIO.new, StringIO.new
+    yield
+    {:stdout => $stdout.string, :stderr => $stderr.string}
+  ensure
+    $stdout, $stderr = $o_stdout, $o_stderr
+  end
+end
+
+# Executes a command capturing STDOUT and STDERR as an array representing each line
+def execute_output_ary(argv)
+  execute_output_s(argv).split(%r{\n})
+end
+
+# Executes a command capturing STDOUT and STDERR as one string
+def execute_output_s(argv)
+  output = capture_output{Commandable.execute(argv)}
+  output[:stdout] + output[:stderr]
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: commandable
+version: !ruby/object:Gem::Version
+  version: 0.2.0.beta01
+  prerelease: 6
+platform: ruby
+authors:
+- Mike Bethany
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-03-17 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor-hi
+  requirement: &2154595880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154595880
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154595380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *2154595380
+description: Adding command line control to your app is as easy as putting 'command
+  "this command does xyz"' above a method. Parameter lists and a help command are
+  automatically built for you.
+email:
+- mikbe.tk@gmail.com
+executables:
+- commandable
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENCE
+- README.markdown
+- Rakefile
+- _testing/alias_trap.rb
+- autotest/discover.rb
+- bin/commandable
+- commandable.gemspec
+- lib/commandable.rb
+- lib/commandable/app_controller.rb
+- lib/commandable/commandable.rb
+- lib/commandable/exceptions.rb
+- lib/commandable/version.rb
+- lib/monkey_patch/file_utils.rb
+- spec/commandable/command_line_execution_spec.rb
+- spec/commandable/commandable_spec.rb
+- spec/commandable/help_generator_spec.rb
+- spec/commandable/helpers_spec.rb
+- spec/commandable/reset_spec.rb
+- spec/commandable/xor_groups_spec.rb
+- spec/source_code_examples/class_command_no_command.rb
+- spec/source_code_examples/class_methods.rb
+- spec/source_code_examples/class_methods_nested.rb
+- spec/source_code_examples/command_no_command.rb
+- spec/source_code_examples/deep_class.rb
+- spec/source_code_examples/default_method.rb
+- spec/source_code_examples/default_method_no_params.rb
+- spec/source_code_examples/multi_line_description.rb
+- spec/source_code_examples/multi_line_description_no_params.rb
+- spec/source_code_examples/no_description.rb
+- spec/source_code_examples/parameter_class.rb
+- spec/source_code_examples/parameter_free.rb
+- spec/source_code_examples/required_methods.rb
+- spec/source_code_examples/super_deep_class.rb
+- spec/source_code_examples/test_class.rb
+- spec/source_code_examples/xor_class.rb
+- spec/source_code_for_errors/class_bad.rb
+- spec/source_code_for_errors/default_method_bad.rb
+- spec/source_code_for_errors/private_methods_bad.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://mikbe.tk
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: The easiest way to add command line control to your app.
+test_files:
+- autotest/discover.rb
+- spec/commandable/command_line_execution_spec.rb
+- spec/commandable/commandable_spec.rb
+- spec/commandable/help_generator_spec.rb
+- spec/commandable/helpers_spec.rb
+- spec/commandable/reset_spec.rb
+- spec/commandable/xor_groups_spec.rb
+- spec/source_code_examples/class_command_no_command.rb
+- spec/source_code_examples/class_methods.rb
+- spec/source_code_examples/class_methods_nested.rb
+- spec/source_code_examples/command_no_command.rb
+- spec/source_code_examples/deep_class.rb
+- spec/source_code_examples/default_method.rb
+- spec/source_code_examples/default_method_no_params.rb
+- spec/source_code_examples/multi_line_description.rb
+- spec/source_code_examples/multi_line_description_no_params.rb
+- spec/source_code_examples/no_description.rb
+- spec/source_code_examples/parameter_class.rb
+- spec/source_code_examples/parameter_free.rb
+- spec/source_code_examples/required_methods.rb
+- spec/source_code_examples/super_deep_class.rb
+- spec/source_code_examples/test_class.rb
+- spec/source_code_examples/xor_class.rb
+- spec/source_code_for_errors/class_bad.rb
+- spec/source_code_for_errors/default_method_bad.rb
+- spec/source_code_for_errors/private_methods_bad.rb
+- spec/spec_helper.rb