clive 0.8.1 → 1.0.0

data/spec/clive/type/definitions_spec.rb

@@ -0,0 +1,312 @@
+$: << File.dirname(__FILE__) + '/../..'
+require 'helper'
+
+describe Clive::Type::Object do
+  subject { Clive::Type::Object }
+
+  describe '#valid?' do
+    it 'is always valid' do
+      subject.must_be :valid?, 'a'
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns the argument given' do
+      subject.typecast('a').must_be_kind_of Object
+    end
+  end
+end
+
+describe Clive::Type::String do
+  subject { Clive::Type::String }
+
+  describe '#valid?' do
+    it 'is valid for non nil values' do
+      subject.must_be :valid?, 'a'
+      subject.wont_be :valid?, nil
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns a String' do
+      subject.typecast('a').must_be_kind_of String
+    end
+  end
+end
+
+describe Clive::Type::Symbol do
+  subject { Clive::Type::Symbol }
+
+  describe '#valid?' do
+    it 'is valid for non nil values' do
+      subject.must_be :valid?, 'a'
+      subject.wont_be :valid?, nil
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns a Symbol' do
+      subject.typecast('a').must_be_kind_of Symbol
+    end
+  end
+end
+
+describe Clive::Type::Integer do
+  subject { Clive::Type::Integer }
+
+  describe '#valid?' do
+    it 'is valid for numbers' do
+      %w(120 120.5 .5 120e7 120.5e7).all? {|a|
+        subject.valid?(a) && subject.valid?('-'+a)
+      }.must_be_true
+      subject.wont_be :valid?, 'abc'
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns an Integer' do
+      r = subject.typecast('120.50e7')
+      r.must_be_kind_of Integer
+      r.must_equal 120
+    end
+  end
+end
+
+describe Clive::Type::StrictInteger do
+  subject { Clive::Type::StrictInteger }
+
+  describe '#valid?' do
+    it 'is valid for integers' do
+      %w(120 120e7).all? {|a|
+        subject.valid?(a) &&
+        subject.valid?('-'+a)
+      }.must_be_true
+
+      %w(120.5 .5 120.5e7).all? {|a|
+        subject.valid?(a) &&
+        subject.valid?('-'+a)
+      }.must_be_false
+
+      subject.wont_be :valid?, 'abc'
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns an Integer' do
+      r = subject.typecast('120.50e7')
+      r.must_be_kind_of Integer
+      r.must_equal 120
+    end
+  end
+end
+
+describe Clive::Type::Binary do
+  subject { Clive::Type::Binary }
+
+  describe '#valid?' do
+    it 'is valid for binary numbers' do
+      %w(1 11 101).all? {|a|
+        subject.valid?(a) &&
+        subject.valid?('-'+a) &&
+        subject.valid?('0b'+a) &&
+        subject.valid?('-0b'+a)
+      }.must_be_true
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns an Integer' do
+      r = subject.typecast('0b101')
+      r.must_be_kind_of Integer
+      r.must_equal 5
+    end
+  end
+end
+
+describe Clive::Type::Octal do
+  subject { Clive::Type::Octal }
+
+  describe '#valid?' do
+    it 'is valid for octal numbers' do
+      %w(4 62 701).all? {|a|
+        subject.valid?(a) &&
+        subject.valid?('-'+a) &&
+        subject.valid?('0'+a) &&
+        subject.valid?('0o'+a) &&
+        subject.valid?('-0O'+a)
+      }.must_be_true
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns an Integer' do
+      r = subject.typecast('0257')
+      r.must_be_kind_of Integer
+      r.must_equal 175
+    end
+  end
+end
+
+describe Clive::Type::Hexadecimal do
+  subject { Clive::Type::Hexadecimal }
+
+  describe '#valid?' do
+    it 'is valid for hexadecimal numbers' do
+      %w(aa1 4f 66bb1).all? {|a|
+        subject.valid?(a) &&
+        subject.valid?('-'+a) &&
+        subject.valid?('0x'+a) &&
+        subject.valid?('-0X'+a)
+      }.must_be_true
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns an Integer' do
+      r = subject.typecast('0x4f')
+      r.must_be_kind_of Integer
+      r.must_equal 79
+    end
+  end
+end
+
+describe Clive::Type::Float do
+  subject { Clive::Type::Float }
+
+  describe '#valid?' do
+    it 'is valid for numbers' do
+      %w(120 120.5 .5 120e7 120.5e7).all? {|a|
+        subject.valid?(a) && subject.valid?('-'+a)
+      }.must_be_true
+      subject.wont_be :valid?, 'abc'
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns a Float' do
+      r = subject.typecast('120.50e7')
+      r.must_be_kind_of Float
+      r.must_equal 120.5e7
+    end
+  end
+end
+
+describe Clive::Type::Boolean do
+  subject { Clive::Type::Boolean }
+
+  describe '#valid?' do
+    it 'is valid for various true and false values' do
+      %w(true t yes y on false f no n off).all? {|a| subject.valid? a }.must_be_true
+      subject.wont_be :valid?, 'abc'
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns a Boolean' do
+      subject.typecast('y').must_be_true
+      subject.typecast('off').must_be_false
+    end
+  end
+end
+
+describe Clive::Type::Pathname do
+  subject { Clive::Type::Pathname }
+
+  describe '#valid?' do
+    it 'is valid for non nil values' do
+      subject.must_be :valid?, '~/path'
+      subject.wont_be :valid?, nil
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns a Pathname' do
+      r = subject.typecast('~/path')
+      r.must_be_kind_of Pathname
+      r.to_s.must_equal '~/path'
+    end
+  end
+end
+
+describe Clive::Type::Range do
+  subject { Clive::Type::Range }
+
+  describe '#valid?' do
+    it 'is valid for ranges' do
+      %w(1..5 1...5 1-5).all? {|a| subject.valid? a }.must_be_true
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns a Range for a...z' do
+      r = subject.typecast('a...z')
+      r.must_be_kind_of Range
+      r.must_equal 'a'...'z'
+    end
+
+    it 'returns a Range for a..z' do
+      r = subject.typecast('a..z')
+      r.must_be_kind_of Range
+      r.must_equal 'a'..'z'
+    end
+
+    it 'returns a Range for a-z' do
+      r = subject.typecast('a-z')
+      r.must_be_kind_of Range
+      r.must_equal 'a'..'z'
+    end
+  end
+end
+
+describe Clive::Type::Array do
+  subject { Clive::Type::Array }
+
+  describe '#valid?' do
+    it 'is valud for arrays' do
+      ['a,b,c', '"hello",123,true,"what a sentence"'].all? {|a|
+        subject.valid? a
+      }.must_be_true
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns an Array' do
+      r = subject.typecast('"hello",123,true,"what a sentence"')
+      r.must_be_kind_of Array
+      r.must_equal ['"hello"', '123', 'true', '"what a sentence"']
+    end
+  end
+end
+
+describe Clive::Type::Time do
+  subject { Clive::Type::Time }
+
+  describe '#valid?' do
+    it 'is valid for times' do
+      %w(12:50 12:50:30).all? {|a| subject.valid?(a) }.must_be_true
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns a Time' do
+      subject.typecast('12:50').must_be_kind_of Time
+    end
+  end
+end
+
+describe Clive::Type::Regexp do
+  subject { Clive::Type::Regexp }
+
+  describe '#valid?' do
+    it 'is valid for regular expressions' do
+      %w{/a/ /a[bc](1|2)/ix}.all? {|a| subject.valid?(a) }.must_be_true
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns a Regexp' do
+      subject.typecast('/a/i').must_be_kind_of Regexp
+      subject.typecast('/a/ix').must_equal /a/ix
+    end
+  end
+end

data/spec/clive/type_spec.rb

@@ -0,0 +1,107 @@
+$: << File.dirname(__FILE__) + '/..'
+require 'helper'
+
+describe Clive::Type do
+
+  subject { Class.new(Clive::Type) }
+  let(:instance) { Clive::Type.new }
+
+  describe '#valid?' do
+    it 'returns false' do
+      instance.valid?('arg').must_be_false
+    end
+  end
+
+  describe '#typecast' do
+    it 'returns nil' do
+      instance.typecast('arg').must_be_nil
+    end
+  end
+
+  describe '.find_class' do
+    it 'returns the correct Type subclass' do
+      s = Clive::Type::Integer
+      subject.find_class('Integer').must_equal s
+      subject.find_class('Clive::Integer').must_equal s
+      subject.find_class('I::Dont::Exist::Integer').must_equal s
+    end
+
+    it 'returns nil if it can not be found' do
+      subject.find_class('What::No').must_be_nil
+    end
+  end
+
+  describe '.match' do
+    it 'sets a proc given a symbol' do
+      sym, obj = mock, Object.new
+      sym.expects(:to_proc).with().returns(obj)
+
+      subject.match sym
+      subject.instance_variable_get(:@valid).must_equal obj
+    end
+
+    it 'sets a proc given a regular expression' do
+      subject.match /a|b|c/
+      subject.instance_variable_get(:@valid).class.must_equal Proc
+    end
+  end
+
+  describe '.refute' do
+    it 'sets a proc given a symbol' do
+      subject.refute :odd?
+      subject.instance_variable_get(:@valid).class.must_equal Proc
+    end
+
+    it 'sets a proc given a regular expression' do
+      subject.refute /a|b|c/
+      subject.instance_variable_get(:@valid).class.must_equal Proc
+    end
+  end
+
+  describe '.cast' do
+    it 'sets a symbol' do
+      subject.cast :to_i
+      subject.instance_variable_get(:@cast).must_equal [:to_i, []]
+    end
+  end
+
+  describe '.valid?' do
+    describe 'if @valid has been set' do
+      it 'calls the block' do
+        sym, prc = mock, mock
+        sym.expects(:to_proc).with().returns(prc)
+        prc.expects(:call).with('arg').returns(true)
+
+        subject.match sym
+        subject.valid? 'arg'
+      end
+    end
+
+    describe 'if @valid has not been set' do
+      it 'calls #valid?' do
+        subject.any_instance.expects(:valid?).with('arg')
+        subject.valid? 'arg'
+      end
+    end
+  end
+
+  describe '.typecast' do
+    describe 'if @cast has been set' do
+      it 'uses the method set' do
+        arg = mock
+        arg.expects(:send).with(:to_i).returns(true)
+
+        subject.cast :to_i
+        subject.typecast arg
+      end
+    end
+
+    describe 'if @cast has not been set' do
+      it 'calls #typecast' do
+        subject.any_instance.expects(:typecast).with('arg')
+        subject.typecast 'arg'
+      end
+    end
+  end
+
+end

data/spec/clive_spec.rb

@@ -0,0 +1,60 @@
+$: << File.dirname(__FILE__)
+require 'helper'
+
+# For some reason Class.new(Clive) { Boolean } throws an error?
+class IncludingCliveReferenceTest < Clive
+  opt :name, :as => Boolean
+end
+
+describe Clive do
+
+  describe 'inheriting Clive' do
+    subject { Class.new(Clive) }
+
+    it 'responds to all the methods in Base' do
+      (Clive::Base.instance_methods - Object.instance_methods).each do |meth|
+        subject.must_respond_to meth.to_sym
+      end
+    end
+
+    it 'allows you to reference Types' do
+      IncludingCliveReferenceTest.find('--name').args.first.type.
+        must_equal Clive::Type::Boolean
+    end
+
+    it 'allows you to get the Base instance' do
+      subject.instance.must_be_kind_of Clive::Base
+    end
+  end
+
+  describe 'initializing Clive' do
+    subject { Clive.new }
+
+    it 'actually initializes Clive::Base' do
+      subject.must_be_instance_of Clive::Base
+    end
+
+    it 'does not allow you to reference Types' do
+      # For some reason this works in 1.9.2, possibly others, but it should
+      # definitely not be relied on to work as it will raise a NameError under
+      # most versions.
+      unless RUBY_VERSION =~ /^1.9.2/
+        this { Clive.new { Boolean } }.must_raise NameError
+      end
+    end
+
+  end
+
+  describe 'Clive#()' do
+    subject { Clive(:verbose, [:b, :bare]) }
+
+    it 'creates an option for symbols passed' do
+      subject.must_have_option :verbose
+    end
+
+    it 'uses both names if given as an array' do
+      subject.find_option(:b).must_equal subject.find_option(:bare)
+    end
+  end
+
+end