commandable 0.2.0.beta01 → 0.2.0.beta2

data/BUGS.txt

@@ -0,0 +1,2 @@
+term-ansicolor-hi conflicts with term-ansicolor.
+

data/README.markdown

@@ -16,7 +16,16 @@ You can now "use your words" to let people interact with your apps in a natural
 
 ## Status
 
-2011-03-17 - Final testing and building the example app. You could use it now, it's in feature freeze except for adding the example app (Widget).
+2011-03-18 - Final testing and building the example app. I'd wait to use it till I finish the example app. I'm finding new use cases as I do this and correcting some omissions of logic.
+
+## Principle of Least Surprise
+
+I've tried to honestly follow the theory of the principle of least surprise so it should just work like you would expect it to.
+
+## Requirements ##
+
+* Ruby 1.9.2
+* *Nix OS (Probably works on Windows but not tested yet)
 
 ## Installation  
 From the command line:  
@@ -226,7 +235,7 @@ Then you can do something like this:
 
     require 'term/ansicolor'
     
-    c = Term::ANSIColor
+    c = Term::ANSIColorHI
     
     Commandable.color_app_info           = c.intense_white  + c.bold
     Commandable.color_app_name           = c.intense_green  + c.bold

data/bin/commandable

@@ -4,7 +4,7 @@ require 'commandable'
 Commandable.color_output = true
 Commandable.verbose_parameters = false
 Commandable.app_name = "commandable"
-Commandable.app_info =
+Commandable.app_info =  
 """
   \e[92mCommandable\e[0m - The easiest way to add command line control to your app.
   Copyrighted free software - Copyright (c) 2011 Mike Bethany.

data/commandable.gemspec

@@ -11,11 +11,12 @@ Gem::Specification.new do |s|
   s.email                   = ["mikbe.tk@gmail.com"]
   s.homepage                = "http://mikbe.tk"
   s.summary                 = %q{The easiest way to add command line control to your app.}
-  s.description             = %q{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.}
+  s.description             = %q{The easiest way to add command line control to your app.\nAdding command line control to your app is as easy as putting 'command "this command does xyz"' above a method.\nParameter lists and a help command are automatically built for you.}
 
-  s.add_dependency("term-ansicolor-hi", "~>1.0.6")
+  s.add_dependency("term-ansicolor-hi", "~>1.0.7")
   
   s.add_development_dependency("rspec", "~>2.5")
+  s.add_development_dependency("cucumber")
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec,autotest}/*`.split("\n")

data/features/ansicolor.feature

@@ -0,0 +1,11 @@
+Feature: Ansicolor
+  In order to not have horrible looking colors
+  As a programmer
+  I want to make sure I'm using ANSIColorHI
+  And it doesn't conflict with the original ANSIColor
+  
+  
+  Scenario: Run a feature
+  When I run cucumber
+  Then it doesn't give an error
+  

data/features/setup/env.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'rspec/expectations'
+require 'commandable'

data/features/step-definitions/step-definitions.rb

@@ -0,0 +1,7 @@
+When /^I run cucumber$/ do
+  true.should be_true
+end
+
+Then /^it doesn't give an error$/ do
+  true.should be_true
+end

data/lib/commandable/app_controller.rb

@@ -12,13 +12,13 @@ module Commandable
         `open #{File.expand_path((File.dirname(__FILE__) + '/../../readme.markdown'))}`
       end
       
-      command "Copies a fully working app demonstrating how\n to use Commandable with RSpec and Cucumber"
+      command "Copies a fully working app demonstrating how\nto use Commandable with RSpec and Cucumber"
       # Creates a simple example app demonstrating a fully working app
       def widget(path="./widget")
         puts "This feature hasn't been added yet. I'm working on it now and it will be in the release version."
       end
       
-      command "Copies the test classes to a folder so\n you can see a bunch of small examples"
+      command "Copies the test classes to a folder so\nyou can see a bunch of small examples"
       # Copies the test classes to a folder so you can see a bunch of small examples
       def examples(path="./example_classes")
         FileUtils.copy_dir(File.expand_path(File.dirname(__FILE__) + '/../../spec/source_code_examples'),path)

data/lib/commandable/commandable.rb

@@ -1,4 +1,4 @@
-require 'term/ansicolor'
+require 'term/ansicolorhi'
 require 'set'
 
 # This library allows you to incredibly easily make 
@@ -19,13 +19,13 @@ module Commandable
     
     # Describes your application, printed at the top of help/usage messages
     attr_accessor :app_info
-    
+  
     # Used when building the usage line, e.g. Usage: app_name [command] [parameters]
     attr_accessor :app_name
-    
+  
     # If optional parameters show default values, true by default
     attr_accessor :verbose_parameters
-    
+  
     # Boolean: If help/usage messages will print in color
     attr_accessor :color_output
     # What color the app_info text will be in the help message
@@ -40,7 +40,7 @@ module Commandable
     attr_accessor :color_parameter
     # What color the word "Usage:" will be in the help message
     attr_accessor :color_usage
-    
+  
     # What color the word "Error:" text will be in error messages
     attr_accessor :color_error_word
     # What color the friendly name of the error will be in error messages
@@ -145,18 +145,16 @@ module Commandable
           puts com[:proc].call
         end
       rescue Exception => exception
-      if exception.respond_to?(:friendly_name)
-        set_colors
-        puts help("  #{@c_error_word}Error:#{@c_reset} #{@c_error_name}#{exception.friendly_name}#{@c_reset}\n  #{@c_error_description}#{exception.message}#{@c_reset}\n\n")
-      else
-      #rescue Exception => exception
-      
-        puts "\n Bleep, bloop, bleep! Danger Will Robinson! Danger!"
-        puts "\n Error: #{exception.inspect}"
-        puts "\n Backtrace:"
-        puts exception.backtrace.collect{|line| " #{line}"}
-        puts
-      end
+        if exception.respond_to?(:friendly_name)
+          set_colors
+          puts help("\n  #{@c_error_word}Error:#{@c_reset} #{@c_error_name}#{exception.friendly_name}#{@c_reset}\n  #{@c_error_description}#{exception.message}#{@c_reset}\n\n")
+        else
+          puts "\n Bleep, bloop, bleep! Danger Will Robinson! Danger!"
+          puts "\n Error: #{exception.inspect}"
+          puts "\n Backtrace:"
+          puts exception.backtrace.collect{|line| " #{line}"}
+          puts
+        end
       end
     end
     
@@ -202,6 +200,13 @@ module Commandable
       method_hash.each do |meth, params|
         command = @@commands[meth]
         
+        # Test for missing parameters
+        required = command[:parameters].select{|param| param[0]==:req} if command[:parameters]
+        if required
+          required.shift(params.count)
+          raise MissingRequiredParameterError, {:method=>meth, :parameters=>required.collect!{|meth| meth[1]}.to_s[1...-1].gsub(":","")} unless required.empty?
+        end
+
         # Test for duplicate XORs
         proc_array.select{|x| x[:xor] and x[:xor]==command[:xor] }.each {|bad| raise ExclusiveMethodClashError, "#{meth}, #{bad[:method]}"}
 
@@ -211,6 +216,7 @@ module Commandable
         proc_array << {:method=>meth, :xor=>command[:xor], :parameters=>params, :priority=>command[:priority], :proc=>lambda{klass.send(meth, *params)}}
       end
       proc_array.sort{|a,b| a[:priority] <=> b[:priority]}.reverse
+    
     end
    
     # Set colors to their default values
@@ -218,8 +224,8 @@ module Commandable
       # Colors - off by default
       @color_output      ||= false
       # Build the default colors
-      Term::ANSIColor.coloring = true
-      c = Term::ANSIColor
+      Term::ANSIColorHI.coloring = true
+      c = Term::ANSIColorHI
       @color_app_info           = c.intense_white  + c.bold
       @color_app_name           = c.intense_green  + c.bold
       @color_command            = c.intense_yellow

data/lib/commandable/exceptions.rb

@@ -34,6 +34,20 @@ module Commandable
     end
   end
 
+
+  # An error raised if a user does not provide a required command
+  class MissingRequiredParameterError < ScriptError
+    # Returns a more print friendly error name
+    def friendly_name
+      "Missing Required Parmeter"
+    end
+    # Create a new instance of the MissingRequiredParameterError class
+    def initialize(msg)
+      super("The command \"#{msg[:method]}\" is missing the required parameter \"#{msg[:parameters]}\".")
+    end
+  end
+
+
   # This error is raised if a user gives two or more commands from the same exclusive group
   class ExclusiveMethodClashError < ScriptError
     # Returns a more print friendly error name

data/lib/commandable/version.rb

@@ -1,4 +1,4 @@
 module Commandable
   # The application's version number
-  VERSION = "0.2.0.beta01"
+  VERSION = "0.2.0.beta2"
 end

data/lib/monkey_patch/file_utils.rb

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

data/spec/commandable/command_line_execution_spec.rb

@@ -6,10 +6,10 @@ describe Commandable do
     Commandable.reset_all
     Commandable.app_name = "mycoolapp"
     Commandable.app_info = 
-"""
-  My Cool App - It does stuff and things!
-  Copyright (c) 2011 Acme Inc.
-"""
+    """
+      My Cool App - It does stuff and things!
+      Copyright (c) 2011 Acme Inc.
+    """
 
     load 'parameter_class.rb'
   }
@@ -17,13 +17,29 @@ describe Commandable do
   context "when parsing arguments" do
   
     context "and there is an error in the command line" do
-    
+ 
+      context "because a required parameter is not given" do
+        
+        context "with a class that doesn't have a default method" do
+          specify{lambda{execute_queue(["zaz"]).should raise_error(MissingRequiredParameterError)}}
+          specify{lambda{execute_output_s(["zaz"]).should include(/Missing Required/)}}
+          specify{lambda{execute_queue(["zaz", "potato"]).should raise_error(MissingRequiredParameterError)}}
+          specify{lambda{execute_output_s(["zaz", "potato"]).should include(/Missing Required/)}}
+          specify{lambda{execute_queue(["zaz", "potato", "gump"]).should_not raise_error}}
+          specify{lambda{execute_output_s(["zaz", "potato", "gump"]).should_not include(/Missing Required/)}}
+        end
+      
+        # When a default method has a required parameter and nothing is given on the command
+        # line Commandable will run help so you won't get a MissingRequiredParameterError
+        
+      end
+
       context "and the default method does not accept parameters" do
         
         before(:each) {load 'default_method_no_params.rb'}
         
         context "but something that isn't a method is the first thing on the command line" do
-          specify {lambda{Commandable.execution_queue(["potato"])}.should raise_error(Commandable::UnknownCommandError)}
+          specify {lambda{execute_queue(["potato"])}.should raise_error(Commandable::UnknownCommandError)}
           specify { execute_output_s(["potato"]).should match(/Unknown Command/)} 
         end
         
@@ -31,7 +47,7 @@ describe Commandable do
     
       context "and running procs from the execution queue" do
         it "raises an error if there is an invalid command given" do
-          lambda{Commandable.execution_queue(["fly", "navy"])}.should raise_error(Commandable::UnknownCommandError)
+          lambda{execute_queue(["fly", "navy"])}.should raise_error(Commandable::UnknownCommandError)
         end
       end
     
@@ -146,9 +162,16 @@ describe Commandable do
         
       end
       
+      context "when a default method name isn't specified but the required switch is properly given" do
+        before(:each){load "default_method.rb"}
+        specify{lambda{execute_queue(["phish"])}.should_not raise_error}
+        specify{lambda{execute_output_s(["phish"]).should include(/default method called with: phish/)}}
+        specify{execute_queue(["not_a_default_method", "potato"]).should include("not a default method, called with: Cleveland, potato") }
+        specify{execute_output_s(["not_a_default_method", "phish"]).should include("not a default method, called with: Cleveland, phish")}
+      end
+      
     end
 
-
   end
 
 end

data/spec/commandable/commandable_spec.rb

@@ -188,14 +188,13 @@ describe Commandable do
     end
     
     it "executes the default command if no command is given" do
-      execute_output_ary(["Klaatu"]).should == ["default method called with: Klaatu"]
+      execute_output_ary(["Klaatu"]).should include("default method called with: Klaatu")
     end
     
     it "executes a default method and a second command" do
-      execute_output_ary(["Klaatu", "not_a_default_method", "28"]).sort.should == [
+      execute_output_ary(["Klaatu", "not_a_default_method", "28"]).should include(
         "default method called with: Klaatu", 
-        "not a default method, called with: Cleveland",
-        "28"].sort
+        "not a default method, called with: Cleveland, 28")
     end
     
   end

data/spec/commandable/help_generator_spec.rb

@@ -113,7 +113,7 @@ describe Commandable do
   Copyright (c) 2011 Acme Inc."""
     end
 
-    let(:c) {Term::ANSIColor}
+    let(:c) {Term::ANSIColorHI}
     
     it "changes the output if color is enabled" do
       Commandable.color_output = false

data/spec/commandable/reset_spec.rb

@@ -18,7 +18,7 @@ describe Commandable do
       from(%{  My Cool App - It does stuff and things!\n  Copyright (c) 2011 Acme Inc.}).
       to(nil)
     }
-    specify {lambda{Commandable.reset_all}.should change{Commandable.commands.length}.from(5).to(1)}
+    specify {lambda{Commandable.reset_all}.should change{Commandable.commands.length}.from(6).to(1)}
     
 
 

data/spec/source_code_examples/default_method.rb

@@ -11,7 +11,7 @@ class DefaultMethods
   
   command 'does other stuff'
   def not_a_default_method(name="Cleveland", age)
-    ["not a default method, called with: #{name}", age]
+    "not a default method, called with: #{name}, #{age}"
   end 
 
 end

data/spec/source_code_examples/default_method_multiparameters.rb

@@ -0,0 +1,17 @@
+@@command_options
+require "commandable"
+
+class DefaultMethodsMultiParameters
+  extend Commandable
+  
+  command 'the default method', :default
+  def default_method_multi(name, optional="optional")
+    "multi default method called with: #{name}, #{optional}"
+  end 
+  
+  command 'does other stuff'
+  def not_a_default_method_multi(name="Cleveland", age)
+    ["multi not a default method, called with: #{name}", age]
+  end 
+
+end

data/spec/source_code_examples/parameter_class.rb

@@ -24,4 +24,9 @@ class ParameterClass
     [number_arg1, string_arg2, array_arg3]
   end
 
+  command "a method with a required parameter"
+  def zaz(required_param, another_required)
+    [required_param, another_required]
+  end
+
 end

data/spec/source_code_examples/test_class.rb

@@ -8,6 +8,3 @@ class TestClass
     "test_method"
   end 
 end
-
-
-puts Commandable.execution_queue([])

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $:.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 'pp'
 require 'term/ansicolor'
 require 'rspec'
 require 'commandable'
@@ -53,3 +54,8 @@ def execute_output_s(argv)
   output = capture_output{Commandable.execute(argv)}
   output[:stdout] + output[:stderr]
 end
+
+def execute_queue(argv)
+  queue = Commandable.execution_queue(argv)
+  queue.collect{|meth| meth[:proc].call}
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commandable
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta01
+  version: 0.2.0.beta2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,23 +9,23 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-03-17 00:00:00.000000000 -04:00
+date: 2011-03-21 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor-hi
-  requirement: &2154595880 !ruby/object:Gem::Requirement
+  requirement: &2154879100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 1.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2154595880
+  version_requirements: *2154879100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154595380 !ruby/object:Gem::Requirement
+  requirement: &2154878600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,22 @@ dependencies:
         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.
+  version_requirements: *2154878600
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &2154878200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154878200
+description: The easiest way to add command line control to your app.\nAdding command
+  line control to your app is as easy as putting 'command "this command does xyz"'
+  above a method.\nParameter lists and a help command are automatically built for
+  you.
 email:
 - mikbe.tk@gmail.com
 executables:
@@ -45,6 +57,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- BUGS.txt
 - Gemfile
 - LICENCE
 - README.markdown
@@ -53,6 +66,9 @@ files:
 - autotest/discover.rb
 - bin/commandable
 - commandable.gemspec
+- features/ansicolor.feature
+- features/setup/env.rb
+- features/step-definitions/step-definitions.rb
 - lib/commandable.rb
 - lib/commandable/app_controller.rb
 - lib/commandable/commandable.rb
@@ -71,6 +87,7 @@ files:
 - 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_multiparameters.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
@@ -124,6 +141,7 @@ test_files:
 - 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_multiparameters.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