defekt 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a806f7634ccc18253176e6eb347f3578bb88bca
-  data.tar.gz: 86b9ad8b7d835ca4dd47a245920ff518dbb45448
+  metadata.gz: 954d8400f90cdb7972f5d7f743264b19f017a8c1
+  data.tar.gz: a3e4787acc89cab5d4dbd3d37be7ddd73a0842e6
 SHA512:
-  metadata.gz: 0e0c78fe9cbf85546f78b735326aecc15bb3c86d1bb58decf0797be25fa9b8e816a08b7b7f22246c48ceacc3c385ed48e8587da179b60c2d0aec14640dbb42ff
-  data.tar.gz: 91f734e72803538cf3e251a56cd04c8f06ba909b20f919f4ff0c159f76071e1d99ff27b357a25b7a4e54225abebd45aae75fc4a7c6e331d0444b28e0a2730169
+  metadata.gz: ec6589474c3151e97fa9294295c2bcc74e145b7865b2684d2e8f7d18663a4fc8aff6cdaa3088e4dcffe5f0e48f16fec890df4f4da8ea9b1f52009eeaaa1a8204
+  data.tar.gz: 70573b204c30eb87828cee86d7750140ef03a88a2896981da6d310a054e8f5bcb3129502e464522c38add127eed2d43811094aeb686f04f56549783dca9fb8b2

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
+  - 1.9.3
   - 2.2.1
+before_install: gem install bundler -v 1.9.1

data/README.md

@@ -1,6 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/defekt.svg)](http://badge.fury.io/rb/defekt)
+[![Build Status](https://travis-ci.org/kodnin/defekt.svg?branch=master)](https://travis-ci.org/kodnin/defekt)
+
 # Defekt
 
-A micro testing framework in Ruby.
+A micro testing framework.
 
 ## Installation
 
@@ -20,7 +23,40 @@ Or install it yourself as:
 
 ## Usage
 
-Usage instructions will be provided soon.
+Inherit test classes from ```Defekt::Base``` and define tests prefixed with ```test_```. ```before``` and ```after``` methods are optional, which will be invoked around a test.
+
+```ruby
+require 'defekt'
+
+class Person
+  attr_reader :name
+
+  def initialize(name)
+    @name = name
+  end
+end
+
+class PersonTest < Defekt::Base
+  def before
+    @person = Person.new('kodnin')
+  end
+
+  def test_initialize
+    instance_of! Person, @person
+  end
+
+  def test_name
+    equal_to! 'kodnin', @person.name
+  end
+
+  def test_age
+    @person.stub(:age) { 'unknown' }
+    equal_to! 'unknown', @person.age
+  end
+end
+
+Defekt::Runner.new(Defekt::Collection.new(Defekt::Base)).run.report
+```
 
 ## Development
 

data/bin/console

@@ -2,6 +2,6 @@
 
 require 'bundler/setup'
 require 'defekt'
-
 require 'pry'
+
 Pry.start

data/defekt.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['kodnin@gmail.com']
 
   spec.summary       = 'Micro testing framework'
-  spec.description   = 'Micro testing framework in Ruby'
+  spec.description   = 'Micro testing framework'
   spec.homepage      = 'https://github.com/kodnin/defekt'
   spec.license       = 'MIT'
 
@@ -19,8 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.5.1'
-  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'minitest', '~> 5.5'
+  spec.add_development_dependency 'pry', '~> 0.10'
 end

data/lib/defekt.rb

@@ -1,4 +1,8 @@
+require 'defekt/assertions'
+require 'defekt/base'
+require 'defekt/collection'
+require 'defekt/errors'
+require 'defekt/object'
+require 'defekt/runner'
+require 'defekt/test'
 require 'defekt/version'
-
-module Defekt
-end

data/lib/defekt/assertions.rb

@@ -0,0 +1,45 @@
+module Defekt
+  module Assertions
+    def true!(value)
+      unless value
+        raise Errors::TrueError, message(value, 'is not', true)
+      end
+    end
+
+    def equal_to!(expected, actual)
+      unless actual == expected
+        raise Errors::EqualToError, message(actual, 'is not equal to', expected)
+      end
+    end
+
+    def identical_to!(expected, actual)
+      unless actual.equal?(expected)
+        raise Errors::IdenticalToError, message(actual, 'is not identical to', expected)
+      end
+    end
+
+    def included_in!(collection, member)
+      unless collection.include?(member)
+        raise Errors::IncludedInError, message(member, 'is not included in', collection)
+      end
+    end
+
+    def instance_of!(klass, instance)
+      unless instance.instance_of?(klass)
+        raise Errors::InstanceOfError, message(instance, 'is not an instance of', klass)
+      end
+    end
+
+    def kind_of!(klass, instance)
+      unless instance.kind_of?(klass)
+        raise Errors::KindOfError, message(instance, 'is not a kind of', klass)
+      end
+    end
+
+    private
+
+    def message(object1, text, object2)
+      "~#{object1}~ #{text} #{object2}"
+    end
+  end
+end

data/lib/defekt/base.rb

@@ -0,0 +1,25 @@
+module Defekt
+  class Base
+    include Assertions
+
+    def before
+    end
+
+    def after
+    end
+
+    def self.children
+      @children ||= []
+    end
+
+    def self.descendants
+      children + children.map(&:descendants).flatten
+    end
+
+    private
+
+    def self.inherited(klass)
+      children.push(klass)
+    end
+  end
+end

data/lib/defekt/collection.rb

@@ -0,0 +1,31 @@
+module Defekt
+  class Collection
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def all
+      @all ||= @klass.descendants.flat_map do |klass|
+        klass.instance_methods.grep(/^test_/).map do |methot|
+          Test.new(klass.instance_method(methot))
+        end
+      end
+    end
+
+    def passed
+      @passed ||= all.select(&:passed?)
+    end
+
+    def failed
+      @failed ||= all.select(&:failed?)
+    end
+
+    def errored
+      @errored ||= all.select(&:errored?)
+    end
+
+    def broken
+      @broken ||= all.select(&:broken?)
+    end
+  end
+end

data/lib/defekt/errors.rb

@@ -0,0 +1,19 @@
+module Defekt
+  module Errors
+    class BaseError < StandardError
+      def message
+        "#{super} (#{self.class.name})"
+      end
+
+      def self.name
+        super.sub('Defekt::Errors::', '')
+      end
+    end
+
+    private
+
+    def self.const_missing(klass)
+      const_set(klass, Class.new(BaseError))
+    end
+  end
+end

data/lib/defekt/object.rb

@@ -0,0 +1,6 @@
+class Object
+  def stub(methot, &block)
+    raise ArgumentError, 'block is required' unless block
+    define_singleton_method(methot, block)
+  end
+end

data/lib/defekt/runner.rb

@@ -0,0 +1,39 @@
+require 'benchmark'
+
+module Defekt
+  class Runner
+    attr_reader :collection, :benchmark
+
+    def initialize(collection)
+      @collection = collection
+    end
+
+    def run
+      @benchmark = Benchmark.measure do
+        collection.all.shuffle.each { |test| print test.run }
+      end
+      self
+    end
+
+    def report
+      puts nil, nil
+      puts report_broken, nil if collection.broken.any?
+      puts statistics
+      self
+    end
+
+    def statistics
+      "#{collection.passed.length} passed, #{collection.failed.length} failed" +
+        ", #{collection.errored.length} errored of #{collection.all.length} " +
+        "tests (in #{benchmark.real.round(3)} seconds)"
+    end
+
+    private
+
+    def report_broken
+      collection.broken.flat_map do |test|
+        [test.summary, "  #{test.error.message}"]
+      end.join("\n")
+    end
+  end
+end

data/lib/defekt/test.rb

@@ -0,0 +1,65 @@
+module Defekt
+  class Test
+    attr_reader :methot, :error
+
+    def initialize(methot)
+      @methot = methot
+    end
+
+    def instance
+      @instance ||= methot.owner.new
+    end
+
+    def run
+      @ran = true
+
+      begin
+        instance.before
+        methot.bind(instance).call
+        '.'
+      rescue => e
+        @error = e
+        status.chars.first
+      ensure
+        instance.after
+      end
+    end
+
+    def summary
+      "#{methot.owner}##{methot.name} at #{methot.source_location.join(':')} #{status}"
+    end
+
+    def ran?
+      !!@ran
+    end
+
+    def passed?
+      ran? && error.nil?
+    end
+
+    def failed?
+      ran? && !passed? && error.kind_of?(Errors::BaseError)
+    end
+
+    def errored?
+      ran? && !failed? && error.kind_of?(Exception)
+    end
+
+    def broken?
+      failed? || errored?
+    end
+
+    def status
+      case
+      when passed?
+        'passed'
+      when failed?
+        'failed'
+      when errored?
+        'errored'
+      else
+        'did not run'
+      end
+    end
+  end
+end

data/lib/defekt/version.rb

@@ -1,3 +1,3 @@
 module Defekt
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defekt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - David Boot
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,29 +44,29 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.5.1
+        version: '5.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.5.1
+        version: '5.5'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
-description: Micro testing framework in Ruby
+        version: '0.10'
+description: Micro testing framework
 email:
 - kodnin@gmail.com
 executables: []
@@ -84,6 +84,13 @@ files:
 - bin/setup
 - defekt.gemspec
 - lib/defekt.rb
+- lib/defekt/assertions.rb
+- lib/defekt/base.rb
+- lib/defekt/collection.rb
+- lib/defekt/errors.rb
+- lib/defekt/object.rb
+- lib/defekt/runner.rb
+- lib/defekt/test.rb
 - lib/defekt/version.rb
 homepage: https://github.com/kodnin/defekt
 licenses:
@@ -97,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="