clive 0.8.1 → 1.0.0

data/spec/clive/output_spec.rb

@@ -1,5 +1,89 @@
-require 'spec_helper'
+$: << File.dirname(__FILE__) + '/..'
+require 'helper'
 
 describe Clive::Output do
+  subject { Clive::Output }
+  
+  describe '#pad' do
+    it 'pads a string to the right' do
+      subject.pad('a', 5, '-').must_equal 'a----'
+    end
+    
+    it 'ignores colour codes' do
+      subject.pad('a'.red, 5,'-').must_equal 'a'.red + '----'
+    end
+    
+    it 'returns the string if it exceeds the length' do
+      subject.pad('abcdef', 5, '-').must_equal 'abcdef'
+    end
+  end
+  
+  describe '#wrap_text' do
+    let(:text) { "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }
+    
+    let :result do
+      "Lorem ipsum dolor
+      sit amet,
+      consectetur
+      adipisicing elit,
+      sed do eiusmod
+      tempor incididunt ut
+      labore et dolore
+      magna aliqua."
+    end
+    
+    it 'wraps the text' do
+      subject.wrap_text(text, 6, 26).must_equal result
+    end
+  end
+  
+  describe '#terminal_width' do
+    it 'returns the width of the terminal' do
+      ENV['COLUMNS'] = '80'
+      subject.terminal_width.must_equal 80
+    end
+  end
+  
+end
 
-end
+describe String do
+
+  describe '#colour' do
+    it 'adds the correct escape codes' do
+      "str".colour(5).must_equal "\e[5mstr\e[0m"
+    end
+    
+    it 'adds multiple codes' do
+      "str".l_red.bold.green_bg.blink.underline.must_equal "\e[4m\e[5m\e[42m\e[1m\e[91mstr\e[0m"
+    end
+  end
+  
+  describe '#clear_colours' do
+    it 'removes all colour codes' do
+      "str".red.blue_bg.bold.blink.clear_colours.must_equal "str"
+    end
+  end
+  
+  describe '#colour!' do
+    it 'adds the correct escape codes' do
+      s = "str"
+      s.colour!(5)
+      s.must_equal "\e[5mstr\e[0m"
+    end
+    
+    it 'adds multiple codes' do
+      s = "str"
+      s.l_red!.bold!.green_bg!.blink!.underline!
+      s.must_equal "\e[4m\e[5m\e[42m\e[1m\e[91mstr\e[0m"
+    end
+  end
+  
+  describe '#clear_colours!' do
+    it 'removes all colours' do
+      s = "str".red.green_bg.bold.blink
+      s.clear_colours!
+      s.must_equal "str"
+    end
+  end
+
+end

data/spec/clive/parser_spec.rb

@@ -1,106 +1,226 @@
-require 'spec_helper'
+$: << File.dirname(__FILE__) + '/..'
+require 'helper'
 
 describe Clive::Parser do
 
-  subject {
-    class CLI
-      include Clive::Parser
-    end
-    CLI
-  }
-  
-  it "keeps track of its class" do
-    subject.instance_variable_get("@klass").should == CLI
-  end
-  
-  describe "#base" do
-    it "has a 'base' command" do
-      subject.base.should be_kind_of Clive::Command
+  describe 'help command' do
+    subject { Clive.new(:name => '...') { command(:new) { opt :f, :force } } }
+
+    describe 'with no argument' do
+      it 'prints the help' do
+        this {
+          subject.run s 'help'
+        }.must_output <<EOS
+Usage: ... [command] [options]
+
+  Commands:
+    new
+    help [<command>]      \e[90m# \e[0m\e[90mDisplay help\e[0m
+
+  Options:
+    -h, --help            \e[90m# \e[0m\e[90mDisplay this help message\e[0m
+EOS
+      end
     end
-  end
-  
-  describe "#parse" do
-    it "should call #run on 'base'" do
-      subject.base.should_receive(:run).with([])
-      subject.parse([])
+
+    describe 'with an argument' do
+      it 'prints help for that command' do
+        this {
+          subject.run s 'help new'
+        }.must_output <<EOS
+Usage: ... new [options]
+
+  Options:
+    -f, --force
+    -h, --help        \e[90m# \e[0m\e[90mDisplay this help message\e[0m
+EOS
+      end
+
+      it 'prints an error if command does not exist' do
+        this {
+          subject.run s 'help missing'
+        }.must_output "Error: command missing could not be found. Try `help` to see the available commands.\n"
+      end
     end
+
   end
-  
-  describe "#flag" do
-    it "adds a new flag to 'base'" do
-      expect {
-        subject.flag(:t, :test, :arg => "NAME") {|i| puts i }
-      }.should change {subject.base.flags.size}.by(1)
+
+  describe 'single option' do
+    subject {
+      Clive.new {
+        opt :force
+      }
+    }
+
+    it 'runs the option' do
+      r = subject.run s '--force'
+      r.must_have :force
     end
   end
-  
-  describe "#switch" do
-    it "adds a new switch to 'base'" do
-      expect {
-        subject.switch(:t, :test) {}
-      }.should change {subject.base.switches.size}.by(1)
+
+  describe 'single option with block' do
+    subject {
+      Clive.new {
+        opt(:force) { print "forced" }
+      }
+    }
+
+    it 'runs the option' do
+      this {
+        subject.run s '--force'
+      }.must_output "forced"
     end
   end
 
-  describe "#command" do
-    it "adds a new command to 'base'" do
-      expect {
-        subject.command(:command) {}
-      }.should change {subject.base.commands.size}.by(1)
+  describe 'single option with argument' do
+    subject {
+      Clive.new {
+        opt :name, :arg => '<name>'
+      }
+    }
+
+    it 'runs the option' do
+      r = subject.run s '--name "John Doe"'
+      r.name.must_equal 'John Doe'
     end
   end
-  
-  describe "#bool" do
-    it "adds a new bool to 'base'" do
-      expect {
-        subject.bool(:boo) {}
-      }.should change {subject.base.bools.size}.by(2)
+
+  describe 'single option with argument with block' do
+    subject {
+      Clive.new {
+        opt(:name, :arg => '<name>') {|name| print "I am #{name}" }
+      }
+    }
+
+    it 'runs the option' do
+      this {
+        subject.run s '--name "John Doe"'
+      }.must_output "I am John Doe"
     end
   end
-  
-  describe "#desc" do
-    it "sets current desc for 'base'" do
-      subject.desc "test"
-      subject.base.instance_variable_get("@current_desc").should == "test"
+
+  describe 'single option with arguments' do
+    subject {
+      Clive.new {
+        opt :name, :arg => '<first> <last>'
+      }
+    }
+
+    it 'runs the option' do
+      r = subject.run s '--name John Doe'
+      r.name.must_equal ['John', 'Doe']
     end
   end
-  
-  describe "#help_formatter" do
-    it "sets the help formatter for 'base'" do
-      subject.base.should_receive(:help_formatter).with(:white)
-      subject.help_formatter(:white)
+
+  describe 'single option with arguments with block' do
+    subject {
+      Clive.new {
+        opt(:name, :arg => '<first> <last>') { print "I am #{first} #{last}" }
+      }
+    }
+
+    it 'runs the option' do
+      this {
+        subject.run s '--name John Doe'
+      }.must_output "I am John Doe"
     end
   end
-  
-  describe "#option_var" do
-    before { subject.option_var(:test, 1) }
-  
-    it "creates a getter" do
-      subject.should respond_to :test
-    end
-    
-    it "creates a setter" do
-      subject.should respond_to :test=
-      subject.test = 2
-    end
-    
-    it "sets a default value" do
-      subject.test.should == 1
+
+  describe 'Boolean options' do
+    subject {
+      Clive.new {
+        bool :force
+        bool :auto
+      }
+    }
+
+    it 'runs the options' do
+      r = subject.run s '--no-force --auto'
+      r.wont_have :force
+      r.must_have :auto
     end
   end
-  
-  describe "#option_hash" do
-    it "uses #option_var with empty hash" do
-      subject.should_receive(:option_var).with(:test, {})
-      subject.option_hash(:test)
+
+  describe 'Commands' do
+    describe 'with options and arguments' do
+      subject {
+        Clive.new {
+          command :new, :args => '<dir>' do
+            bool :force
+            opt :name, :arg => '<name>'
+          end
+        }
+      }
+
+      let(:result) { {:new => {:args => '~/somewhere', :force => true, :name => 'New'}} }
+
+      it 'runs properly with arguments after options' do
+        r = subject.run s 'new --force --name New ~/somewhere'
+        r.must_equal result
+      end
+
+      it 'runs properly with options after arguments' do
+        r = subject.run s 'new ~/somewhere --force --name New'
+        r.must_equal result
+      end
+
+      it 'runs properly with arguments between options' do
+        r = subject.run s 'new --force ~/somewhere --name New'
+        r2 = subject.run s 'new --name New ~/somewhere --force'
+        r2.must_equal r
+        r2.args.must_equal r.args
+        r.must_equal result
+      end
+
+      it 'runs properly with excessive arguemnts' do
+        r = subject.run s 'new ~/somewhere Hello Other'
+        r.new.args.must_equal '~/somewhere'
+        r.args.must_equal ['Hello', 'Other']
+      end
     end
-  end
-  
-  describe "#option_array" do
-    it "uses #option_var with empty array" do
-      subject.should_receive(:option_var).with(:test, [])
-      subject.option_array(:test)
+
+    describe 'with options and optional arguments' do
+      subject {
+        Clive.new {
+          command :new, :args => '[<dir>]' do
+            bool :force
+            opt :name, :arg => '<name>'
+          end
+        }
+      }
+
+      let(:result) { {:new => {:force => true, :name => 'New', :args => nil}} }
+      let(:with_argument) { {:new => {:force => true, :name => 'New', :args => '~/somewhere'}} }
+
+      it 'runs properly with just options' do
+        r = subject.run s 'new --force --name New'
+        r.must_equal result
+      end
+
+      it 'runs properly with arguments after options' do
+        r = subject.run s 'new --force --name New ~/somewhere'
+        r.must_equal with_argument
+      end
+
+      it 'runs properly with options after arguments' do
+        r = subject.run s 'new ~/somewhere --force --name New'
+        r.must_equal with_argument
+      end
+
+      it 'runs properly with arguments between options' do
+        r = subject.run s 'new --force ~/somewhere --name New'
+        r2 = subject.run s 'new --name New ~/somewhere --force'
+        r2.must_equal r
+        r2.args.must_equal r.args
+        r.must_equal with_argument
+      end
+
+      it 'runs properly with excessive arguemnts' do
+        r = subject.run s 'new ~/somewhere Hello Other'
+        r[:new][:args].must_equal '~/somewhere'
+        r.args.must_equal ['Hello', 'Other']
+      end
     end
   end
 
-end
+end

data/spec/clive/struct_hash_spec.rb

@@ -0,0 +1,82 @@
+$: << File.dirname(__FILE__) + '/..'
+require 'helper'
+
+describe Clive::StructHash do
+
+  subject { Clive::StructHash }
+
+  describe '#[]' do
+    it 'gets the value' do
+      sh = subject.new(:a => 1)
+      sh[:a].must_equal 1
+    end
+  end
+
+  describe '#store' do
+    it 'stores a key' do
+      sh = subject.new
+      sh.store :life, 42
+      sh.life.must_equal 42
+    end
+
+    it 'stores multiple keys' do
+      sh = subject.new
+      sh.store %w(life answer), 42
+      sh.life.must_equal 42
+      sh.answer.must_equal 42
+    end
+  end
+
+  describe 'named getter methods' do
+    it 'gets the value' do
+      sh = subject.new(:L => 42, :life => 42)
+      sh.life.must_equal 42
+      sh.L.must_equal 42
+    end
+  end
+
+  describe 'named predicate methods' do
+    it 'is true if key exists' do
+      subject.new(:answer => 42).must_have :answer?
+    end
+
+    it 'is false if key does not exist' do
+      subject.new(:answer => 42).wont_have :question?
+    end
+  end
+
+  describe '#to_struct' do
+    it 'uses the first names given to store' do
+      sh = subject.new
+      sub = subject.new(:life => 42)
+
+      sh.store %w(admin a), true
+      sh.store %w(name n), ['John', 'Doe']
+      sh.store %w(sub other command), sub
+
+      test = sh.to_struct('Person')
+      test.admin.must_equal true
+      test.wont_respond_to :a
+      test.name.must_equal ['John', 'Doe']
+      test.wont_respond_to :n
+      test.sub.must_equal sub
+      test.wont_respond_to :other
+      test.wont_respond_to :command
+      test.sub.class.must_equal subject
+    end
+  end
+
+  describe '#to_h' do
+    it 'uses the first names given to store' do
+      sh = subject.new
+      sub = subject.new(:life => 42)
+
+      sh.store %w(admin a), true
+      sh.store %w(name n), ['John', 'Doe']
+      sh.store %w(sub other command), sub
+
+      sh.to_h.must_equal :admin => true, :name => ['John', 'Doe'], :sub => {:life => 42}
+    end
+  end
+
+end