command-unit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmNiYmM2MjU5Y2M4ZGY0ZTU4ZTgwNDYyMmUxMDgxNTIxMDJiZmM1NQ==
+    MGZkZDc0ZWNmMGYyODczMDBjMTNlN2YzYjhmMTk1NjQxMDA5ZGQ2Yg==
   data.tar.gz: !binary |-
-    MWMyZTc3N2FjNWMxZjcwMzNlNWI4YWU5ZjNkMDc5ZTFjM2U2M2UyMQ==
+    ZTlhYmIzYmFlNzg3YTkyOThlMzA3NTU3NDRlNzhmNGQ3OTc1NDhjOQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDRhZGRkMDM0N2RhNzU3ZTRlZmQ3YjU1OTAwZmQxMmU0NmExOTFlMjc4NjUy
-    ODhjYjYyMmJhYjVmMjQ5Y2I1MjBkMWRhMjU3ZDgzYzA3MWY3MTI5MDkxMzI0
-    M2RhYjkyYjE5YjMxODk0NTZhMTQ3MTFkNTA1Nzc5YzAwNjY3ZTU=
+    NGM2ZjE2OTEyYzgzYmQxMjJiNjU5MWY3YWNlYmY4NjlmNDZhODEyN2IxOTk2
+    OGI2ZWY5Mzc5ZWQ2ZmVjZmM0Zjg4MjliNGVhM2YzOTYwYTYzYWY1NDA4ZTI5
+    NmFlMWJiYjYyZGY3ZGZhYjliOGM4MDcxYmY0NzE3ZWFlYWMzMjQ=
   data.tar.gz: !binary |-
-    NjVlODMyMmEwMDUzZTljZjA5Y2FjMzVmZmE0Y2FiMWZmMDhjODllYTUxZDU5
-    NzVjN2YxNDkzNzhjOWE2ODY3ZjA5MzcyYjdmMWE5NTQ3ZThmMTM3NzMxOTc2
-    M2QxNzgzN2JjZDJlMjZkYzcyMDYzNzBkNDNiMTM4YWExZmE5NWE=
+    YzNhZDlkMmRhNzkwZTFiZGFhN2Q0YWM0YWVjODk4YTE5Yjg1YmM3Y2Q5ZjQ3
+    YTYzMzczZWUyMjI1YzdhNmMwMzQyYTVhNjQzNzUzMmEyZGYwYjIxYjZlYjk0
+    MTUzZGE0YWJlYTU0NTQ0YTdiMTcxOGYwYzI5NjM3MmEzY2RmNzA=

data/README.md

@@ -11,7 +11,52 @@ Written in Ruby, designed to test command line apps, whether they're written in
 Tests are written in Command Unit itself, so no need for any external dependencies yet. I might make this a fundamental requirement of future development, but I'll see how far the project can go on basic Ruby first.
 
 ## This is alpha software
-So far I've only tested this on Ruby 1.9.3, others may work but I'm not considering support on any other platforms until I've got a stable/useful release out.
+So far I've only tested this on Ruby 1.9.3, others may work but I'm not considering support on any other platforms until I've got a stable/useful release out. The code itself is very rough-and ready, and could benefit from quite a lot of refactoring, especially in [scenario.rb](/samsalisbury/command-unit/blob/master/lib/command-unit/scenario.rb).
+
+## Features
+- No dependencies apart from Ruby itself
+- Assertion helpers (these need work)
+- Clear, readable, colour console output
+- All command-unit tests written using command-unit itself
+- Expectations require a description, making test more useful as documentation
+- Hooks, you can inject your own code easily to respond to tests running/passing/failing.
+- 
+
+## Minimalist usage example
+ ```ruby
+require 'command-unit'
+include CommandUnit
+scenario 'Writing tests in Command Unit' do
+	
+	when_i 'do something wacky' do |context|
+		context[:data] = 'call a method or something here'
+	end
+
+	i_expect "to receive a string containing 'or' do |context|
+		expect context[:data], &contains('or')
+	end
+
+	i_expect "the string to exactly equal 'or'" do |context|
+		expect context[:data], &is_equal_to('or')
+	end
+
+end
+
+run
+```
+Output:
+```
+Running 1 scenarios...
+
+Running scenario 1: Writing tests in Command Unit
+	When I do something wacky
+		I expect to receive a string containing 'or'...Success! 
+		I expect the string to exactly equal 'or'...Failure!
+Expecting exactly 'or', but got 'call a method or something here'
+Scenario 1 finished, 1 tests, 2 expectations with 1 successful and 1 failures.
+
+Ran 1 scenarios, 0 passed, 1 failed (tests passed: 0, failed: 1) (expectations passed: 1, failed: 1)
+```
 
 ## Installation
 `gem install command-unit`
@@ -19,5 +64,12 @@ So far I've only tested this on Ruby 1.9.3, others may work but I'm not consider
 ## Development
 Unpack the gem with `gem unpack command-unit`
 Run tests:
-    $ cd command-unit-0.0.1
-    $ ruby test/test.rb
+```
+    $ cd command-unit-0.0.3
+    $ ruby test/test.rb
+```
+
+## More?
+This is fairly experimental, and I know a lot of people probably won't like it, or will think it needless (why not just use rspec?!), but it satisfies a need I have right now, and I'm happy so far.
+
+I'd really love to hear any constructive criticism on both the code and the conventions in test-writing that command-unit enforces, you can email me at samsalisbury@gmail.com

data/changelog.md

@@ -1,10 +1,15 @@
 # Command Unit changelog
 
-- 0.0.2 lots of changes:
+- 0.0.3 2013-08-18
+  * Expectation helpers
+    - These need to be rethought, as they require too manu ugly ampersands in the tests
+- 0.0.2 2013-08-18
   * More useful output:
     - Colours
     - Totals
   * Namespaces to help with splitting up tests
   * More self-tests
-- 0.0.1 some basic assertions
-- 0.0.0 initial release
+- 0.0.1 2013-08-17
+  * some basic assertions
+- 0.0.0 2013-08-17
+  * initial release, nothing much useful yet

data/command-unit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "command-unit"
-  s.version           = "0.0.2"
+  s.version           = "0.0.3"
   s.platform          = Gem::Platform::RUBY
   s.author           = "Samuel R. Salisbury"
   s.email             = "samsalisbury@gmail.com"

data/examples/minimal_scenario.rb

@@ -0,0 +1,20 @@
+require_relative '../lib/command-unit'
+include CommandUnit
+
+scenario 'Writing tests in Command Unit' do
+	
+	when_i 'do something wacky' do |context|
+		context[:data] = 'call a method or something here'
+	end
+
+	i_expect "to receive a string containing 'or'" do |context|
+		expect context[:data], &contains('or')
+	end
+
+	i_expect "the string to exactly equal 'or'" do |context|
+		expect context[:data], &is_equal_to('or')
+	end
+
+end
+
+run

data/lib/command-unit.rb

@@ -4,6 +4,7 @@ require_relative 'command-unit/test'
 require_relative 'command-unit/expectation'
 require_relative 'command-unit/expectation_result'
 require_relative 'command-unit/hooks'
+require_relative 'command-unit/expectation_helpers'
 
 module CommandUnit
 
@@ -101,12 +102,4 @@ module CommandUnit
     @@current_scenario.current_test.add_expectation Expectation.new(desc, &i_expect_block)
   end
 
-  def pass(desc = '')
-    ExpectationResult.new(desc, true)
-  end
-
-  def fail(desc = '')
-    ExpectationResult.new(desc, false)
-  end
-
 end

data/lib/command-unit/expectation_helpers.rb

@@ -0,0 +1,52 @@
+module CommandUnit
+
+	def pass(desc = '')
+		ExpectationResult.new(desc, true)
+	end
+
+	def fail(desc = '')
+		ExpectationResult.new(desc, false)
+	end
+
+	def expect(thing, &proc)
+		if proc.nil?
+			if thing == true
+				return ExpectationResult.new('', true)
+			elsif thing == false
+				return ExpectationResult.new('Expected true but was false.', false)
+			else
+				raise "CommandUnit::expect requires either true, false or any other value with a Proc"
+			end
+		end
+
+		result = proc.call(thing)
+		if result.is_a? Array
+			return ExpectationResult.new(result[1], result[0])
+		else
+			return ExpectationResult.new('', result)	
+		end
+	end
+
+	def is_equal_to(this_thing)
+		return Proc.new do |other_thing|
+			if other_thing == this_thing
+				true
+			else
+				[false, "Expecting exactly '#{this_thing}', but got '#{other_thing}'"]
+			end
+		end
+	end
+
+	def contains(this_thing)
+		return Proc.new do |collection|
+			if not collection.respond_to? :include?
+				[false, "Unable to test if '#{collection}' contains '#{this_thing}' as it has no include? method."]
+			elsif collection.include? this_thing
+				true
+			else
+				[false, "Expected '#{collection}' to contain '#{this_thing}'."]
+			end
+		end
+	end
+
+end

data/test/scenarios/expectation_helper_tests.rb

@@ -0,0 +1,123 @@
+include CommandUnit
+
+def expect_passing(result)
+	if not result.is_a? ExpectationResult
+		fail 'Expecting an ExpectationResult'
+	elsif result.success? != true
+		fail 'Expecting a pass'
+	else
+		pass
+	end
+end
+
+def expect_failing(result)
+	if not result.is_a? ExpectationResult
+		fail 'Expecting an ExpectationResult'
+	elsif result.success? != false
+		fail 'Expecting a failure'
+	else
+		pass
+	end
+end
+
+def expect_failing_with_message(result, expected_message)
+	if not result.is_a? ExpectationResult
+		fail 'Expecting an ExpectationResult'
+	elsif result.success? != false
+		fail 'Expecting a failure'
+	elsif result.message != expected_message
+		fail "Expecting failure message '#{expected_message}', but got '#{result.message}'"
+	else
+		pass
+	end
+end
+
+scenario :command_unit, 'Using expectation helpers' do
+	
+	when_i 'use the expect helper with a boolean true' do |context|
+		context[:result] = expect true
+	end
+
+	i_expect 'to get a passing result' do |context|
+		expect_passing context[:result]
+	end
+
+	when_i 'use the expect helper with a boolean false' do |context|
+		context[:result] = expect false
+	end
+
+	i_expect 'to get a failing result' do |context|
+		expect_failing context[:result]
+	end
+
+	i_expect 'to get a failing result with message saying "Expected true but was false."' do |context|
+		expect_failing_with_message context[:result], 'Expected true but was false.'
+	end
+
+	when_i 'use the expect helper with a value and a Proc returning true' do |context|
+		context[:result] = expect 'anything' do
+			true
+		end
+	end
+
+	i_expect 'to get a passing result' do |context|
+		expect_passing context[:result]
+	end
+
+	when_i 'use the expect helper with a value and a Proc returning false' do |context|
+		context[:result] = expect 'anything' do
+			false
+		end
+	end
+
+	i_expect 'to get a failing result' do |context|
+		expect_failing context[:result]
+	end
+
+	when_i 'use the expect helper with a value and a Proc returning false and a message' do |context|
+		context[:result] = expect 'anything' do
+			[false, 'Failure message']
+		end
+	end
+
+	i_expect 'to get a failing result' do |context|
+		expect_failing_with_message context[:result], 'Failure message'
+	end
+
+	when_i 'use the expect helper with is_equal_to and the things are equal' do |context|
+		context[:result] = expect(123, &is_equal_to(123))
+	end
+
+	i_expect 'to get a passing result' do |context|
+		expect_passing context[:result]
+	end
+
+	when_i 'use the expect helper with is_equal_to and the things are not equal' do |context|
+		context[:result] = expect('my random string', &is_equal_to('my unequal string'))
+	end
+
+	i_expect 'to get a failing result' do |context|
+		expect_failing context[:result]
+	end
+
+	when_i 'use the expect helper with contains returns true when one string contains another' do |context|
+		context[:result] = expect "This is a string.", &contains('is a st')
+	end
+
+	i_expect 'to get a passing result' do |context|
+		expect_passing context[:result]
+	end
+
+	when_i 'use the expect helper with contains returns true when one string does not contain another' do |context|
+		context[:result] = expect "This is a string.", &contains('pancreas')
+	end
+
+	i_expect 'to get a failing result' do |context|
+		expect_failing context[:result]
+	end
+
+	i_expect 'to get a failing result with message saying "Expected \'This is a string.\' to contain \'pancreas\'."' do |context|
+		expect_failing_with_message context[:result], "Expected 'This is a string.' to contain 'pancreas'."
+	end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command-unit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Samuel R. Salisbury
@@ -22,8 +22,10 @@ files:
 - README.md
 - changelog.md
 - command-unit.gemspec
+- examples/minimal_scenario.rb
 - lib/command-unit.rb
 - lib/command-unit/expectation.rb
+- lib/command-unit/expectation_helpers.rb
 - lib/command-unit/expectation_result.rb
 - lib/command-unit/hooks
 - lib/command-unit/hooks.rb
@@ -33,6 +35,7 @@ files:
 - lib/string/console_colours.rb
 - test/quick-test.rb
 - test/scenarios/empty_scenario.rb
+- test/scenarios/expectation_helper_tests.rb
 - test/scenarios/one_test_one_failing_expectation.rb
 - test/scenarios/one_test_one_passing_expectation.rb
 - test/test.rb