oktobertest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2766bd05820c2140c972c6cb72d2a9bf08f0034f
+  data.tar.gz: 536b310425a0d6b4b845c36ee2500a1720044313
+SHA512:
+  metadata.gz: dac4ac71b09de1b9c7a4b59416bb374ef6f0bc4951c13f3a93c63e58fc93e22ea32489c1805cf0d160b68960e0c2c54e5a44976f0e479b20d4fec17275ff8612
+  data.tar.gz: f565aab1347b5fa094d0a3e1efa251bae18e2a76f2f4aa633eb3cef45b86a5c6c5a7a208ba0b73edc9975bcf3b6ab76bdd980522d45225ab3414fd18f6a5b6fb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Patricio Mac Adden <patriciomacadden@gmail.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# Oktobertest
+
+Small test library.
+
+## Why?
+
+This is a project I started over the weekend. I was looking at [Cutest](https://github.com/djanowski/cutest)
+and I thought: "It shouldn't be so difficult to make a test library".
+
+### Features
+
+* Setup - Test - Teardown model.
+* Each `test` is an instance of `Oktobertest::Test`, which means that each test
+runs its own context.
+* Each `scope` is an instance of `Oktobertest::Scope`. Methods defined in a
+scope are copied into each `test` it contains.
+* Extensible: it's easy to add more assertions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oktobertest', group: :test
+# or this if you want to use oktobertest master
+# gem 'oktobertest', group: :test, github: 'patriciomacadden/oktobertest'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install oktobertest
+```
+
+## Usage
+
+### Example
+
+```ruby
+scope do
+  setup do
+    @foo = 'foo'
+  end
+
+  test 'this test will pass' do
+    assert @foo == 'foo'
+  end
+
+  test 'this test will pass too' do
+    assert_raises RuntimeError do
+      raise RuntimeError
+    end
+  end
+
+  test 'this test will fail' do
+    flunk 'fail!'
+  end
+
+  test 'skip this one!' do
+    skip
+  end
+end
+```
+
+### Assertions
+
+For now there are 2 assertions:
+
+* `assert`: fails unless the given condition is true.
+* `assert_raises`: fails unless the given block raises the given exception.
+
+And there is a way of making tests fail (`flunk`) and skipping them (`skip`).
+
+#### How to add assertions?
+
+That's quite simple. Just define them in the `Oktobertest::Assertions` module:
+
+```ruby
+module Oktobertest
+  module Assertions
+    def assert_equal(expected, actual, message = nil)
+      message ||= "#{expected.inspect} is not equal to #{actual.inspect}"
+      assert expected == actual, message
+    end
+  end
+end
+```
+
+### Running the test suite
+
+You can run the test suite using `rake` or the `ok` command.
+
+Using `rake`:
+
+```ruby
+require 'oktobertest'
+
+task :test do
+  Oktobertest.run Dir['test/*_test.rb']
+end
+
+task default: :test
+```
+
+Using `ok`:
+
+```bash
+$ ok test/*_test.rb
+```
+
+Please check the default options by running `ok`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See the [LICENSE](https://github.com/patriciomacadden/oktobertest/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'oktobertest'
+
+desc 'Run the tests'
+task :test do
+  Oktobertest.run Dir['test/*_test.rb']
+end
+
+task default: :test

data/bin/ok

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+puts 'usage: ok [-r lib] [-s scope] [-t test] [-v] file ...' if ARGV.empty?
+
+require 'clap'
+require_relative '../lib/oktobertest'
+
+files = Clap.run ARGV,
+  '-r' => ->(file) { require file },
+  '-s' => ->(name) { Oktobertest.run_scope = name },
+  '-t' => ->(name) { Oktobertest.run_test = name },
+  '-v' => -> { puts Oktobertest::VERSION }
+
+Oktobertest.run files if files.any?

data/lib/oktobertest.rb

@@ -0,0 +1,144 @@
+module Oktobertest
+  VERSION = '0.0.1'
+
+  TestFailed = Class.new StandardError
+  TestSkipped = Class.new StandardError
+
+  def self.run(files)
+    files.each { |file| load file }
+    puts
+    errors.each do |error|
+      case error
+      when TestFailed
+        file, line, _ = error.backtrace[2].split(':')
+        print "\nerror: #{error.message}"
+      when TestSkipped
+        file, line, _ = error.backtrace[1].split(':')
+        print "\nskip"
+        print ": #{error.message}" unless error.message == error.class.name
+      else
+        file, line, _ = error.backtrace[0].split(':')
+        print "\nerror: #{error.message}"
+      end
+      print "\nfile: #{file}\nline: #{line}\n"
+    end
+  end
+
+  def self.run_test=(name)
+    @run_test = name
+  end
+
+  def self.run_test
+    @run_test
+  end
+
+  def self.run_scope=(name)
+    @run_scope = name
+  end
+
+  def self.run_scope
+    @run_scope
+  end
+
+  module Assertions
+    def assert(value, message = nil)
+      message ||= "condition is not true: #{value.inspect}"
+      flunk message unless !!value
+    end
+
+    def assert_raises(exception, message = nil)
+      begin
+        yield
+      rescue => error
+      ensure
+        message ||= "block doesn't raise #{exception}"
+        flunk message unless error.kind_of? exception
+      end
+    end
+
+    def flunk(message = nil)
+      raise TestFailed, message
+    end
+
+    def skip(message = nil)
+      raise TestSkipped, message
+    end
+  end
+
+  class Scope
+    def initialize(name = nil, &block)
+      @name, @block = name, block
+      @setup, @teardown = [], []
+    end
+
+    def run
+      instance_eval &@block
+    end
+
+    protected
+
+    def test(name = nil, &block)
+      if !Oktobertest.run_test || Oktobertest.run_test == name
+        test = Test.new(name, &block)
+        singleton_methods.each { |m| test.define_singleton_method m, &method(m) }
+        @setup.each { |b| test.instance_eval &b }
+        test.run
+        @teardown.each { |b| test.instance_eval &b }
+      end
+    end
+
+    def setup(&block)
+      @setup << block
+    end
+
+    def teardown(&block)
+      @teardown << block
+    end
+
+    def scope(name = nil, &block)
+      if !Oktobertest.run_scope || Oktobertest.run_scope == name
+        scope = Scope.new(name, &block)
+        singleton_methods.each { |m| scope.define_singleton_method m, &method(m) }
+        @setup.each { |b| scope.setup &b }
+        @teardown.each { |b| scope.teardown &b }
+        scope.run
+      end
+    end
+  end
+
+  class Test
+    include Assertions
+
+    def initialize(name = nil, &block)
+      @name, @block = name, block
+    end
+
+    def run
+      instance_eval &@block
+      print '.'
+    rescue TestFailed => error
+      Oktobertest.errors << error
+      print 'F'
+    rescue TestSkipped => error
+      Oktobertest.errors << error
+      print 'S'
+    rescue StandardError => error
+      Oktobertest.errors << error
+      print 'E'
+    end
+  end
+
+  private
+
+  def self.errors
+    @errors ||= []
+  end
+end
+
+module Kernel
+  def scope(name = nil, &block)
+    if !Oktobertest.run_scope || Oktobertest.run_scope == name
+      Oktobertest::Scope.new(name, &block).run
+    end
+  end
+end

data/oktobertest.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oktobertest'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'oktobertest'
+  spec.version       = Oktobertest::VERSION
+  spec.authors       = ['Patricio Mac Adden']
+  spec.email         = ['patriciomacadden@gmail.com']
+  spec.summary       = %q{Small test library}
+  spec.description   = %q{Small test library}
+  spec.homepage      = 'https://github.com/patriciomacadden/oktobertest'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+
+  spec.add_runtime_dependency 'clap', '~> 1.0.0'
+end

data/test/assertions_test.rb

@@ -0,0 +1,43 @@
+scope 'assert' do
+  test 'passes if the value is true' do
+    assert true
+  end
+
+  test 'fails if the value is false' do
+    assert_raises Oktobertest::TestFailed do
+      assert false
+    end
+  end
+end
+
+scope 'assert_raises' do
+  test 'passes if the block raises the given exception' do
+    assert_raises RuntimeError do
+      raise RuntimeError
+    end
+  end
+
+  test 'fails if the block does not raise the given exception' do
+    assert_raises Oktobertest::TestFailed do
+      assert_raises RuntimeError do
+        raise ArgumentError
+      end
+    end
+  end
+end
+
+scope 'flunk' do
+  test 'raises Oktobertest::TestFailed exception' do
+    assert_raises Oktobertest::TestFailed do
+      flunk
+    end
+  end
+end
+
+scope 'skip' do
+  test 'raises Oktobertest::TestSkipped exception' do
+    assert_raises Oktobertest::TestSkipped do
+      skip
+    end
+  end
+end

data/test/fixtures/error_test.rb

@@ -0,0 +1,3 @@
+scope do
+  test { raise RuntimeError }
+end

data/test/fixtures/failing_test.rb

@@ -0,0 +1,3 @@
+scope do
+  test { assert false }
+end

data/test/fixtures/run_scope_test.rb

@@ -0,0 +1,19 @@
+scope 'run this' do
+  test 'run this' do
+    assert true
+  end
+
+  test 'and this' do
+    assert true
+  end
+end
+
+scope 'and not this' do
+  test 'run this' do
+    assert false
+  end
+
+  test 'and this' do
+    assert false
+  end
+end

data/test/fixtures/run_test_test.rb

@@ -0,0 +1,9 @@
+scope do
+  test 'run this' do
+    assert true
+  end
+
+  test 'and not this' do
+    assert false
+  end
+end

data/test/fixtures/skipped_test.rb

@@ -0,0 +1,3 @@
+scope do
+  test { skip }
+end

data/test/fixtures/successful_test.rb

@@ -0,0 +1,3 @@
+scope do
+  test { assert true }
+end

data/test/oktobertest_test.rb

@@ -0,0 +1,55 @@
+scope do
+  test 'successful run' do
+    expected = ".\n"
+    output = %x(bin/ok test/fixtures/successful_test.rb)
+    assert expected == output
+  end
+
+  test 'errored run' do
+    expected = <<EOS
+E
+
+error: RuntimeError
+file: test/fixtures/error_test.rb
+line: 2
+EOS
+    output = %x(bin/ok test/fixtures/error_test.rb)
+    assert expected == output
+  end
+
+  test 'failed run' do
+    expected = <<EOS
+F
+
+error: condition is not true: false
+file: test/fixtures/failing_test.rb
+line: 2
+EOS
+    output = %x(bin/ok test/fixtures/failing_test.rb)
+    assert expected == output
+  end
+
+  test 'run with skipped tests' do
+    expected = <<EOS
+S
+
+skip
+file: test/fixtures/skipped_test.rb
+line: 2
+EOS
+    output = %x(bin/ok test/fixtures/skipped_test.rb)
+    assert expected == output
+  end
+
+  test 'run only one scope' do
+    expected = "..\n"
+    output = %x(bin/ok -s 'run this' test/fixtures/run_scope_test.rb)
+    assert expected == output
+  end
+
+  test 'run only one test' do
+    expected = ".\n"
+    output = %x(bin/ok -t 'run this' test/fixtures/run_test_test.rb)
+    assert expected == output
+  end
+end

data/test/scope_test.rb

@@ -0,0 +1,37 @@
+scope do
+  def foo
+    'foo'
+  end
+
+  test 'responds to foo' do
+    assert foo == 'foo'
+  end
+
+  scope do
+    test 'responds to foo too' do
+      assert foo == 'foo'
+    end
+  end
+end
+
+scope do
+  setup do
+    @foo = 'foo'
+  end
+
+  scope do
+    setup do
+      @bar = 'bar'
+    end
+
+    test 'foo and bar must be defined' do
+      assert @foo == 'foo'
+      assert @bar == 'bar'
+    end
+  end
+
+  test 'foo must be defined and bar wont be' do
+    assert @foo == 'foo'
+    assert @bar.nil?
+  end
+end

data/test/setup_test.rb

@@ -0,0 +1,56 @@
+scope do
+  setup do
+    @foo = 'foo'
+  end
+
+  test 'foo is defined' do
+    assert @foo == 'foo'
+  end
+
+  scope do
+    test 'foo is defined too' do
+      assert @foo == 'foo'
+    end
+  end
+end
+
+scope do
+  setup do
+    @foo = 'foo'
+  end
+
+  test 'foo is defined' do
+    assert @foo == 'foo'
+    @foo = 'bar'
+  end
+
+  test 'foo is not changed' do
+    assert @foo == 'foo'
+  end
+end
+
+scope do
+  setup do
+    @foo = 'foo'
+  end
+
+  setup do
+    @bar = 'bar'
+  end
+
+  test 'both foo and bar are defined, but baz is not' do
+    assert @foo == 'foo'
+    assert @bar == 'bar'
+    assert @baz.nil?
+  end
+
+  setup do
+    @baz = 'baz'
+  end
+
+  test 'both foo, bar and baz are defined' do
+    assert @foo == 'foo'
+    assert @bar == 'bar'
+    assert @baz == 'baz'
+  end
+end

data/test/teardown_test.rb

@@ -0,0 +1,13 @@
+scope do
+  setup do
+    @foo = 'foo'
+  end
+
+  test 'after this test @foo is changed' do
+    @foo = 'bar'
+  end
+
+  teardown do
+    assert @foo == 'bar'
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: oktobertest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patricio Mac Adden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: clap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Small test library
+email:
+- patriciomacadden@gmail.com
+executables:
+- ok
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ok
+- lib/oktobertest.rb
+- oktobertest.gemspec
+- test/assertions_test.rb
+- test/fixtures/error_test.rb
+- test/fixtures/failing_test.rb
+- test/fixtures/run_scope_test.rb
+- test/fixtures/run_test_test.rb
+- test/fixtures/skipped_test.rb
+- test/fixtures/successful_test.rb
+- test/oktobertest_test.rb
+- test/scope_test.rb
+- test/setup_test.rb
+- test/teardown_test.rb
+homepage: https://github.com/patriciomacadden/oktobertest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Small test library
+test_files:
+- test/assertions_test.rb
+- test/fixtures/error_test.rb
+- test/fixtures/failing_test.rb
+- test/fixtures/run_scope_test.rb
+- test/fixtures/run_test_test.rb
+- test/fixtures/skipped_test.rb
+- test/fixtures/successful_test.rb
+- test/oktobertest_test.rb
+- test/scope_test.rb
+- test/setup_test.rb
+- test/teardown_test.rb