commandable 0.2.0.beta01

data/spec/commandable/help_generator_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+describe Commandable do
+
+  before(:each) { Commandable.reset_all }
+
+  # Mostly de-brittled these tests...
+
+  context "when setting verbose_parameters" do
+    
+    it "prints short parameters when false" do
+      Commandable.verbose_parameters = false
+      load 'parameter_class.rb'
+      Commandable.help.to_s.should_not match("1492")
+    end
+    
+    it "prints short parameters when false" do
+      Commandable.verbose_parameters = true
+      load 'parameter_class.rb'
+      Commandable.help.to_s.should match("1492")
+    end
+    
+  end
+
+  context "when generating the help command" do
+
+    it "has a help command when no commands have been added" do
+      Commandable.commands.first[0].should == :help
+    end
+  
+    it "still has the help command after Commandable is cleared" do
+      load 'parameter_class.rb'
+      Commandable.clear_commands
+      Commandable.commands.first[0].should == :help
+    end
+    
+    it "always has the help command as the last command (so it's pretty)" do
+      load 'parameter_class.rb'
+      Commandable.help.compact.last.should match(/help/)
+    end
+  
+  end
+
+  context "when formating the help message" do
+    
+    it "formats a basic help message with commands sorted alphabetically (help last)" do
+      load 'parameter_class.rb'
+      Commandable.help.to_s.should match(/Usage:(.*)Command(.*)bar(.*)baz(.*)foo(.*)qux(.*)help/)
+    end
+
+    it "adds the application name to the help output if it's given" do
+      load 'parameter_class.rb'
+      Commandable.app_name = "mycoolapp"
+      Commandable.help.to_s.should match(/Usage: mycoolapp <command>/)
+    end
+
+    it "adds appliction information if given" do
+      load 'parameter_class.rb'
+      Commandable.app_name = "mycoolapp"
+      app_info = 
+"""
+  My Cool App - It does stuff and things!
+  Copyright (c) 2011 Acme Inc.
+"""
+      Commandable.app_info = app_info
+      Commandable.help.inspect.should match(/My Cool App - It does stuff and things(.*)Copyright \(c\) 2011 Acme Inc/)
+    end
+
+    it "adds (default) to the end of the default command description when printing" do
+      load 'default_method.rb'
+      Commandable.help.to_s.should match(/\(default\)/)
+    end
+
+    context "and there are no parameters" do
+      
+      before(:each){load 'parameter_free.rb' }
+      
+      it "hides the Parameters header" do
+        execute_output_s([]).should_not match(/Command Parameters/)
+      end
+
+      it "hides the doesn't show [parameters] in the usage instructions" do
+        Commandable.app_name = "fakeapp"
+        execute_output_s([]).should_not match(/\[parameters\]/)
+      end
+
+
+    end
+    
+    context "and there is a new line in a description" do
+      
+      it "indents the new line to match the preceding line" do
+        load("multi_line_description.rb")
+        execute_output_s(["blah"]).should match(/                                  so you can have really long descriptions\n                                  And another line/)
+      end
+      
+      it "indents the new line to match the preceding line" do
+        load("multi_line_description_no_params.rb")
+        execute_output_s(["blah"]).should match(/                                 so you can have really long descriptions\n                                 And another line/)
+      end
+      
+    end
+    
+  end
+
+  context "when using color_output" do
+
+    before(:each) do 
+      load 'private_methods_bad.rb'
+      Commandable.app_name = "mycoolapp"
+      Commandable.app_info = 
+"""  My Cool App - It does stuff and things!
+  Copyright (c) 2011 Acme Inc."""
+    end
+
+    let(:c) {Term::ANSIColor}
+    
+    it "changes the output if color is enabled" do
+      Commandable.color_output = false
+      lambda {Commandable.color_output = true}.should change{Commandable.help}
+    end
+
+    it "resets text to plain if colors are turned off" do
+      Commandable.color_output = true
+      lambda {Commandable.color_output = false}.should change{Commandable.help}
+    end
+
+    context "when a specific setting's color is changed" do
+      
+      before(:each) { Commandable.color_output = true } 
+
+      # This seems ripe for meta-zation
+      context "when app_info is changed" do
+        specify {lambda {Commandable.color_app_info = c.black}.should change{Commandable.help}}
+      end
+
+      context "when app_name is changed" do
+        specify {lambda {Commandable.color_app_name = c.black}.should change{Commandable.help}}
+      end
+
+      context "when color_command is changed" do
+        specify {lambda {Commandable.color_command = c.black}.should change{Commandable.help}}
+      end
+
+      context "when color_description is changed" do
+        specify {lambda {Commandable.color_description = c.black}.should change{Commandable.help}}
+      end
+
+      context "when color_parameter is changed" do
+        specify {lambda {Commandable.color_parameter = c.black}.should change{Commandable.help}}
+      end
+
+      context "when color_usage is changed" do
+        specify {lambda {Commandable.color_usage = c.black}.should change{Commandable.help}}
+      end
+
+      context "when there is an error" do
+        
+        specify { lambda {Commandable.color_error_word = c.magenta}.should change{capture_output{Commandable.execute(["fly", "navy"])}}}
+        specify { lambda {Commandable.color_error_name = c.intense_red}.should change{capture_output{Commandable.execute(["fly", "navy"])}}}
+        specify { lambda {Commandable.color_error_description = c.black + c.bold}.should change{capture_output{Commandable.execute(["fly", "navy"])}}}
+        
+      end
+      
+    end
+
+  end
+
+end

data/spec/commandable/helpers_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Commandable do
+
+  context "when parsing optional parameters" do
+    
+    before(:each) {load 'private_methods_bad.rb'}
+    
+    specify {PrivateMethods.send(:parse_optional, "def bar(x=14243)", "x").should == "14243"} 
+    specify {PrivateMethods.send(:parse_optional,"def bar x = 144444", "x").should == "144444"}
+    specify {PrivateMethods.send(:parse_optional,"def bar x=12", "x").should == "12"}
+    specify {PrivateMethods.send(:parse_optional,'def bar (x="42", y)', "x").should == "\"42\""}
+    specify {PrivateMethods.send(:parse_optional,'def bar(y="kjljlj",x="I love Ruby")', "x").should == "\"I love Ruby\""}
+    
+  end
+  
+end

data/spec/commandable/reset_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Commandable do
+
+  before(:each) do
+    Commandable.reset_all
+    load 'parameter_class.rb'
+    Commandable.app_name = "mycoolapp"
+    Commandable.app_info = 
+"""  My Cool App - It does stuff and things!
+  Copyright (c) 2011 Acme Inc."""
+  end
+  
+  context "when reseting all values" do
+     
+    specify {lambda{Commandable.reset_all}.should change{Commandable.app_name}.from("mycoolapp").to(nil)}
+    specify {lambda{Commandable.reset_all}.should change{Commandable.app_info}.
+      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)}
+    
+
+
+  end
+end

data/spec/commandable/xor_groups_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Commandable do
+
+  before(:each) do
+    Commandable.reset_all
+    Commandable.color_output = true
+    load 'xor_class.rb'
+  end
+  
+  context "when exclusive methods are specified" do
+
+    # this seems like I'm testing internal state instead of specifying behavior...
+    specify {Commandable.commands[:xor_method1][:xor].should == :xor}
+    specify {Commandable.commands[:normal_method][:xor].should be_nil}
+    specify {Commandable.commands[:xor_method3][:xor].should == :xor_group}
+    
+    context "when more than one members of an exclusive group is used" do
+      
+      specify{lambda{Commandable.execution_queue(["xor_method1", "xor_method2"])}.should raise_error(Commandable::ExclusiveMethodClashError)}
+      specify{lambda{Commandable.execution_queue(["xor_method3", "xor_method4"])}.should raise_error(Commandable::ExclusiveMethodClashError)}
+      specify{lambda{Commandable.execution_queue(["xor_method1", "xor_method3"])}.should_not raise_error}
+      specify{lambda{Commandable.execution_queue(["normal_method", "xor_method3"])}.should_not raise_error}
+      specify{lambda{Commandable.execution_queue(["normal_method", "normal_method2"])}.should_not raise_error}
+      
+    end
+    
+    context "when printing help" do
+    
+      it "puts the default xor group :xor in the description" do
+        execute_output_s(["help"]).should match(/xor/)
+      end
+    
+      it "puts the xor group :xor_group in the description" do
+        execute_output_s(["help"]).should match(/xor/)
+      end
+    
+    end
+    
+    
+  end
+  
+end

data/spec/source_code_examples/class_command_no_command.rb

@@ -0,0 +1,27 @@
+@@command_options
+require "commandable"
+
+class ClassCommandNoCommand
+  extend Commandable
+
+  command 'a method with a command'
+  def class_command_method1
+    "class_command_method1"
+  end
+
+  # this method should not be in the commands list
+  def class_no_command_method1(flappity)
+    "class_no_command_method1: #{flappity}"
+  end
+
+  command 'another method with a command'
+  def class_command_method2(some_parameter)
+    "class_command_method2: #{some_parameter}"
+  end
+  
+  # this method shouldn't be in the list either
+  def class_no_command_method2(flippity)
+    "class_no_command_method2: #{flippity}"
+  end
+
+end

data/spec/source_code_examples/class_methods.rb

@@ -0,0 +1,20 @@
+@@command_options
+require "commandable"
+
+class ClassMethods
+  
+  extend Commandable
+
+  command 'does some stuff'
+  def self.class_method(string_arg1)
+    string_arg1
+  end
+  
+  command "another one"
+  class << self
+    def class_method2(integer_arg1)
+      integer_arg1
+    end
+  end
+
+end

data/spec/source_code_examples/class_methods_nested.rb

@@ -0,0 +1,31 @@
+@@command_options
+require "commandable"
+
+class ClassMethodsNested
+
+  class << self
+    extend Commandable
+    
+    command "class foo, look at you!"
+    def class_foo(int_arg1, number_arg2)
+      [int_arg1, number_arg2]
+    end
+
+    command "classy bar? probably not"
+    def class_bar(int_arg1, string_arg2="Number 42")
+      [int_arg1, string_arg2]
+    end
+      
+    command "run me for stuff to happen"
+    def class_qux string_arg1 ="1492", string_arg2 = "I'm a tricky one"
+      [string_arg1, string_arg2]
+    end
+      
+    command "I'm another function!"
+    def class_baz number_arg1, string_arg2 = "blorp", *array_arg3
+      [number_arg1, string_arg2, array_arg3]
+    end
+ 
+  end
+
+end

data/spec/source_code_examples/command_no_command.rb

@@ -0,0 +1,27 @@
+@@command_options
+require "commandable"
+
+class CommandNoCommand
+  extend Commandable
+
+  command 'a method with a command'
+  def command_method1
+    "command_method1"
+  end
+
+  # this method should not be in the commands list
+  def no_command_method1(flappity)
+    "no_command_method1"
+  end
+
+  command 'another method with a command'
+  def command_method2(some_parameter)
+    "command_method2"
+  end
+  
+  # this method shouldn't be in the list either
+  def no_command_method2(flippity)
+    "no_command_method2"
+  end
+
+end

data/spec/source_code_examples/deep_class.rb

@@ -0,0 +1,14 @@
+@@command_options
+require "commandable"
+
+module TopModule
+  class ParentClass
+    class DeepClass
+      extend Commandable
+      command 'this is a deep method call'
+      def deep_method
+        "you called a deep method"
+      end 
+    end
+  end
+end

data/spec/source_code_examples/default_method.rb

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

data/spec/source_code_examples/default_method_no_params.rb

@@ -0,0 +1,17 @@
+@@command_options
+require "commandable"
+
+class DefaultMethodNoParams
+  extend Commandable
+  
+  command 'does some stuff', :default
+  def default_no_params
+    "default method called, has no params"
+  end 
+  
+  command 'does other stuff'
+  def not_a_default_method(name="Cleveland", age)
+    ["not a default method: #{name}", age]
+  end 
+
+end

data/spec/source_code_examples/multi_line_description.rb

@@ -0,0 +1,17 @@
+@@command_options
+require "commandable"
+
+class MultiLineDescription
+  extend Commandable
+
+  command "this description will be on multiple lines\nso you can have really long descriptions\nAnd another line\nAnd another"
+  def multiline_function1
+    "multiline_function1"
+  end
+
+  command "Line one is short line two blah, blah! Oh, and blah!"
+  def multiline_function2(foo)
+    "multiline_function2: #{foo}"
+  end
+
+end

data/spec/source_code_examples/multi_line_description_no_params.rb

@@ -0,0 +1,17 @@
+@@command_options
+require "commandable"
+
+class MultiLineDescriptionNoParams
+  extend Commandable
+
+  command "this description will be on multiple lines\nso you can have really long descriptions\nAnd another line\nAnd another"
+  def multiline_function_no_params1
+    "multiline_function_no_params1"
+  end
+
+  command "Line one is short line two blah, blah! Oh, and blah!"
+  def multiline_function_no_params2
+    "multiline_function_no_params2"
+  end
+
+end