fis-test 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjBiZDQ0MWMxNDU4YjVmMmMwNWI2ZTZhMzA1YTczZjZkN2IxODk3Zg==
+    MDQ4OTk4YmZkZmQ5MmJkN2U1NzZlNTlhYWRmYWEwZmNmMGRiMzU1Mw==
   data.tar.gz: !binary |-
-    MDdlYTY1MWRkZTU0OTk1OWFhZjY2MWVjYTIyZDBjMzI4YjBiMjY2MA==
+    YWQ5NDM4ZmJiMGVhYjQ3N2Y0OWQ0NGY3MjdkZDdlN2Q2ZjhkZGEyOQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDM1NjdlMzI5ODYzNTU4ZTVmNTMxZjBkODkzM2Y0YWUyYTA5YzBkM2QwZDVi
-    Y2ZkZDhhN2Y1YTc0ZjI1YjRkZTkwNWZlZmQ2MDU4N2ZhMWFiMGU2NmQ4YThk
-    ZTk5M2VmOWVhNWZlNWFiNTU2NmYyZTVlYWE2MTVlOWUxZjYyNTE=
+    NDljZmRhMDhlMTBlZWFiNWFjNGE0MmUwMzg3YmNlNjdlODcwZjQ0M2U1NmZk
+    OWQyNjMwNmZmMzRmYTM2M2E3NjZmOGYxYjEwNGNmZTc5ZmNlNjZhOGNiY2Iy
+    ZmU4NzcxYjVlMDc3NjUwMTE0OTQ1ZGE1MTU5ZDg2YjExMjU5MjY=
   data.tar.gz: !binary |-
-    N2NiMWYxYTEwNzM5YjM2ZTBjZWY1OTg4MWUxYzNiZTU4MDAxZjMzMTUzZDY2
-    MzgzOWNkNmYwNmZiNTcxOTk5NDNjN2E0NGM1ZjQ1ZWQyNjhiNTcyMmYxYmRl
-    ZmM5NmM5MmU1ZTFkZmY3ZWE2N2Q2OTBjY2JiNjY3ZjMyYmZhNmI=
+    MTAyYTAwNDllMmU1YTFkMDZhMmEyZTViNjc2MDA1OTRiN2RhMGRkOGViNDkx
+    OTAzOGUzNDJiYTQxYWZhZGY3ODZmZGNjNTM0YTQ1Nzc5NGYyYTIyYmUyMGQz
+    YTcxZTU5MmQ2YzljYTQ1N2NkYmM5NTMyZTNiNjA3YjIwZjUxNTM=

data/README.md

@@ -23,7 +23,25 @@ Or install it yourself as:
 The core of `fis-test` is the following structure.
 
 ```ruby
+require 'fis/test'
+
+extend Fis::Test
+
+test 'a Song should have name' do
+  s = Song.new
+  s.name = "Get Lucky"
+  assert_equal s.name, "Get Lucky"
+end
+```
+You can easily skip a test if necessary
+
+```ruby
+require 'fis/test'
+
+extend Fis::Test
+
 test 'a Song should have name' do
+  skip("skip this for now")
   s = Song.new
   s.name = "Get Lucky"
   assert_equal s.name, "Get Lucky"
@@ -32,25 +50,30 @@ end
 
 `test` is a simple wrapper method to give you some nice output.
 
-`assert` and `assert_equal` are all you get.
+`assert`, `assert_equal`, and `skip` are all you get.
 
 No setup/teardown. You can DRY your code with simple helper methods.
 
 ```ruby
+require 'fis/test'
 
-def setup_song
-  @song = Song.new
-end
+class SongTest
+  extend Fis::Test
 
-def teardown_song
-  @song = nil
-end
+  def setup_song
+    @song = Song.new
+  end
 
-test 'a Song should have name' do
-  setup_song
-  @song.name = "Get Lucky"
-  assert_equal @song.name, "Get Lucky"
-  teardown_song
+  def teardown_song
+    @song = nil
+  end
+
+  test 'a Song should have name' do
+    setup_song
+    @song.name = "Get Lucky"
+    assert_equal @song.name, "Get Lucky"
+    teardown_song
+  end
 end
 ```
 
@@ -64,12 +87,17 @@ That's it! Write tests. Stop writing code.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Notes
+
+*This is a very early release. It needs a lot of work.* I would wait to use this for a bit.
+
 ## TODO
 
 - Write tests for the tests.
 - Automate setup/teardown method calls if they exist
 - More modularity for test groups
 - Better output
+- fix extend / include confusion, better/easier way to get to testing methods.
 
 ## Caveats
 

data/fis-test.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "colorize", "~> 0.5.8"
 end

data/lib/fis/test.rb

@@ -1,28 +1,29 @@
 require "fis/test/version"
+require 'colorize'
 
 module Fis
   module Test
+    class SkippedError < StandardError
+    end
+
     def test(title, &b)
       begin
         if b
           result = b.call
-          if result.is_a?(Array)
-            puts "fail: #{title}"
-            puts "      expected #{result.first} to equal #{result.last}"
-          elsif result
-            puts "pass: #{title}"
-          else
-            puts "fail: #{title}"
-          end
+          puts evaluate(result, title)
         else
-          puts "pending: #{title}"
+          puts "pending:".blue + " #{title}"
         end
       rescue => e
-        puts "fail: #{title}"
-        puts e
+        puts exception_handler(e, title)
       end
     end
 
+    def skip(message=nil)
+      message ||= "skipped."
+      raise SkippedError.new(message)
+    end
+
     def assert(statement)
       !!statement
     end
@@ -34,5 +35,26 @@ module Fis
         [expected, actual]
       end
     end
+
+    private
+
+    def exception_handler(e, title)
+      if e.class == Fis::Test::SkippedError
+        "skipped:".blue + " #{e.message}"
+      else
+        "fail:".red + " #{title}\n#{e}\n#{e.backtrace.first}"
+      end
+    end
+
+    def evaluate(result, title)
+      if result.is_a?(Array)
+        "fail:".red + " #{title}\n      expected #{result.first} to equal #{result.last}"
+      elsif result
+        "pass:".green + " #{title}"
+      else
+        "fail:".red + " #{title}"
+      end
+    end
+
   end
 end

data/lib/fis/test/version.rb

@@ -1,5 +1,5 @@
 module Fis
   module Test
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/fis/test/test_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../../lib/fis/test'
+
+extend Fis::Test
+
+
+test 'should fail if result is false' do
+
+  # test 'this is a failing assertion' do
+  #   assert false
+  # end
+
+  result = false
+  title = "this is a failing assertion"
+  assert_equal self.send(:evaluate, result, title), "fail: #{title}"
+end
+
+test 'should return true when the result is true' do
+
+  # test 'this is a passing assertion' do
+  #   assert false
+  # end
+
+  result = true
+  title = "this is a passing assertion"
+  assert_equal self.send(:evaluate, result, title), "pass: #{title}"
+end
+
+test 'should return the expected/actual return when an assert_equal is true' do
+
+  # test 'this is a failing assert_equal statement' do
+  #   assert_equal true, false
+  # end
+
+  result = [true, false]
+  title = "this is a failing assert_equal statement"
+  assert_equal self.send(:evaluate,result, title) , "fail: #{title}\n      expected #{result.first} to equal #{result.last}"
+end
+
+test 'should skip if the skip method is used' do
+
+  # test 'This is a skipped assertion' do
+  #   skip("skipping")
+  #   assert_equal true, false
+  # end
+
+  error = Fis::Test::SkippedError.new("skipping")
+  title = "This is a skipped assertion"
+  assert_equal self.send(:exception_handler,error, title), "skipped: #{error.message}"
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fis-test
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - aviflombaum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.8
 description: Really simple testing framework used at Flatiron School
 email:
 - avi@flombaum.com
@@ -45,14 +59,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - fis-test.gemspec
-- fis-test/.gitignore
 - lib/fis/test.rb
 - lib/fis/test/version.rb
+- test/fis/test/test_test.rb
 homepage: http://github.com/flatiron-school/test
 licenses:
 - MIT
@@ -77,4 +92,5 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: 32 lines of code, the majority of what you need to write tests.
-test_files: []
+test_files:
+- test/fis/test/test_test.rb