commandable 0.2.1 → 0.2.2

data/README.markdown

@@ -36,11 +36,11 @@ And of course upload them when it asks you if it can. You can take a look at the
 Thanks for your help.
 
 
-## Status
+## Latest version
 
-2011-04-04 - Version: 0.2.1 
+2011-08-31 - Version: 0.2.2  
 
-See change history for additions.
+See change history for specific changes.  
 
 ## Principle of Least Surprise
 
@@ -49,7 +49,7 @@ I've tried to follow the principle of least surprise so Commandable should just
 ## Requirements ##
 
 * Ruby 1.9.2
-* Any Posix OS (It works, mostly, on Windows but ironically some of the tests won't run because of some unix commands I use in the tests)
+* OS X or any Posix OS (It works, mostly, on Windows but ironically some of the tests won't run because of some Unix commands I use in the tests)
 
 ## Installation  
 From the command line:  
@@ -198,7 +198,7 @@ Note: Class methods are called directly on the class while instance methods have
 
 ### Automatic usage/help generation ###
 
-One of the great features of **Commandable** is that automatically creates usage instructions based on your methods and the descriptions you provide for them and it adds a `help` command for you.  
+One of the great features of **Commandable** is that it automatically creates usage instructions based on your methods and the descriptions you provide for them. It then adds a `help` command for you that will print out these usage instructions when called.
 
 If your app has no `:default` method or it has a default command that requires parameters the help/usage instructions will be printed if a user just runs your app without any input.  
 
@@ -268,7 +268,7 @@ The help information can be colored using the standard ANSI escape commands foun
 
 Then you can do something like this:
 
-    require 'term/ansicolor'
+    require 'term/ansicolorhi'
     
     c = Term::ANSIColorHI
     
@@ -403,6 +403,11 @@ You just need to configure your bin file with the app settings and then run `Com
     # See the Widget app for an example of this.
     require 'yourappname'
     Commandable.execute(ARGV)
+    
+    # If you don't want the output from your methods to be printed automatically
+    # for instance if your method already outputs some text, you can add :silent
+    # to the execute command like this:
+    # Commandable.execute(ARGV, :silent)
  
 
 I actually prefer to create a separate file for my **Commandable** configuration and load it in my main app  file in the `lib` directory. Again, take a look at `Widget` to see what I mean. 
@@ -422,6 +427,11 @@ Most of all it should be simple to use so if you have any problems please drop m
 
 ## Version History ##
 
+2011-08-31 - Version: 0.2.2
+
+* Added ability to do use Kernel.exit without Commandable trapping the error.
+* Kernel.exit properly forwards exit status if given one.
+
 2011-04-04 - Version: 0.2.1  
 
 * Added ability to use attr\_accessor and att\_writer as commands. You can only write to them of course but it's an easy way to set values.

data/lib/commandable/commandable.rb

@@ -142,8 +142,11 @@ module Commandable
     end
     
     # A wrapper for the execution_queue that runs the queue and traps errors. 
-    # If an error occurs inside this method it will print out a complete.
-    # of availavle methods with usage instructios and exit gracefully.
+    # If an error occurs inside this method it will print out a complete list
+    # of availavle methods with usage instructions and exit gracefully.
+    #
+    # If you do not want the output from your methods to be printed out automatically
+    # run the execute command with silent set to anything other than false or nil.
     def execute(argv, silent=false)
       begin
         command_queue = execution_queue(argv)
@@ -151,6 +154,8 @@ module Commandable
           return_value = com[:proc].call
           puts return_value unless silent
         end
+      rescue SystemExit => kernel_exit
+        Kernel.exit kernel_exit.status
       rescue Exception => exception
         if exception.respond_to?(:friendly_name)
           set_colors

data/lib/commandable/version.rb

@@ -2,7 +2,7 @@ module Commandable
   module VERSION # :nodoc:
     MAJOR  = 0
     MINOR  = 2
-    TINY   = 1
+    TINY   = 2
     PRE    = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/lib/monkey_patch/file_utils.rb

@@ -1,11 +1,11 @@
-require 'fileutils'
+    require 'fileutils'
 
-module FileUtils
-  # Monkeypatch FileUtils really annoying lack of proper directory copying
-  def copy_dir(source, dest)
-    files = Dir.glob("#{source}/**")
-    mkdir_p dest
-    cp_r files, dest
-  end
-  module_function :copy_dir
-end
+    module FileUtils
+      # Monkeypatch FileUtils really annoying lack of proper directory copying
+      def copy_dir(source, dest)
+        files = Dir.glob("#{source}/**")
+        mkdir_p dest
+        cp_r files, dest
+      end
+      module_function :copy_dir
+    end

data/spec/commandable/commandable_spec.rb

@@ -19,7 +19,7 @@ describe Commandable do
 
     context "when checking syntax" do
     
-      it "shouldn't rasie an error if nothing more than 'switch' is used" do
+      it "shouldn't raise an error if nothing more than 'switch' is used" do
         lambda{load 'no_description.rb'}.should_not raise_error(Commandable::SyntaxError)
       end
     

data/spec/commandable/kernel_exit_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Commandable do
+
+  before(:each) {
+    Commandable.reset_all
+    Commandable.app_exe = "mycoolapp"
+    Commandable.app_info = 
+"""
+  My Cool App - It does stuff and things!
+  Copyright (c) 2011 Acme Inc.
+"""
+
+    load 'kernel_exit_class.rb'
+  }
+
+  it "should not trap kernel exits" do
+    lambda{execute_queue(['exit'])}.should raise_error(SystemExit)
+  end
+  
+  it "should forward kernel exit status codes" do
+    lambda{execute_queue(['exit', '40'])}.should raise_error(SystemExit) { |error|
+      error.status.should == 40
+    }
+  end
+
+end

data/spec/source_code_examples/kernel_exit_class.rb

@@ -0,0 +1,10 @@
+require "commandable"
+
+class KernelExitClass
+  
+  extend Commandable
+  command 'does some stuff'
+  def exit(exit_code = 0)
+    Kernel.exit exit_code.to_i
+  end 
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commandable
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-04 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-08-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor-hi
-  requirement: &2153496380 !ruby/object:Gem::Requirement
+  requirement: &70343654860340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +21,10 @@ dependencies:
         version: 1.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2153496380
+  version_requirements: *70343654860340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153495800 !ruby/object:Gem::Requirement
+  requirement: &70343654859880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +32,10 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *2153495800
+  version_requirements: *70343654859880
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2153495200 !ruby/object:Gem::Requirement
+  requirement: &70343654859420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +43,10 @@ dependencies:
         version: '0.10'
   type: :development
   prerelease: false
-  version_requirements: *2153495200
+  version_requirements: *70343654859420
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &2153494600 !ruby/object:Gem::Requirement
+  requirement: &70343654858960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,7 +54,7 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *2153494600
+  version_requirements: *70343654858960
 description: ! 'The easiest way to add command line control to your Ruby app. You
   can add a single line above an existing method and that method will be available
   from the command line.
@@ -93,7 +92,6 @@ files:
 - lib/commandable/exceptions.rb
 - lib/commandable/version.rb
 - lib/monkey_patch/file_utils.rb
-- lib/monkey_patch/os.rb
 - spec/commandable/app_controller_spec.rb
 - spec/commandable/attr_accessor_spec.rb
 - spec/commandable/command_line_execution_spec.rb
@@ -101,6 +99,7 @@ files:
 - spec/commandable/help_generator_spec.rb
 - spec/commandable/helpers_spec.rb
 - spec/commandable/instance_methods_spec.rb
+- spec/commandable/kernel_exit_spec.rb
 - spec/commandable/required_default_spec.rb
 - spec/commandable/reset_spec.rb
 - spec/commandable/xor_groups_spec.rb
@@ -116,6 +115,7 @@ files:
 - spec/source_code_examples/default_method_no_params.rb
 - spec/source_code_examples/instance_methods.rb
 - spec/source_code_examples/instance_methods2.rb
+- spec/source_code_examples/kernel_exit_class.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
@@ -130,7 +130,6 @@ files:
 - 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:
 - MIT
@@ -152,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: The easiest way to add command line control to your Ruby apps.
@@ -165,6 +164,7 @@ test_files:
 - spec/commandable/help_generator_spec.rb
 - spec/commandable/helpers_spec.rb
 - spec/commandable/instance_methods_spec.rb
+- spec/commandable/kernel_exit_spec.rb
 - spec/commandable/required_default_spec.rb
 - spec/commandable/reset_spec.rb
 - spec/commandable/xor_groups_spec.rb
@@ -180,6 +180,7 @@ test_files:
 - spec/source_code_examples/default_method_no_params.rb
 - spec/source_code_examples/instance_methods.rb
 - spec/source_code_examples/instance_methods2.rb
+- spec/source_code_examples/kernel_exit_class.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

data/lib/monkey_patch/os.rb

@@ -1,8 +0,0 @@
-require 'sys/uname'
-include Sys
-
-module Kernel
-  def is_windows?
-    Uname.sysname.downcase.include?('windows')
-  end
-end