matest 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3dca823c49ba5da737893a493c8b2d6577fe39a
-  data.tar.gz: ee624abd646826218183f7eb841d0e9eb2430c2c
+  metadata.gz: 19f65ecc765b4eb7cdb7eaf25c6f5648d9c901f2
+  data.tar.gz: ec5e805afbf404d59335d25815b37aeb6cbe4578
 SHA512:
-  metadata.gz: b04d07f356a535fdf18a12073d8cab63d3179e4d70555e91b3576de10b4a2d87b22239a5d160cd88d1c21fb8db023a0a103e8ad8ed94afc0999a33c04d2604f8
-  data.tar.gz: 1f3c6259e4f602eb7d2b1325cbb1255ef023ead69558511eb28bf01a76869f36971cdae788e7218f1a91a72b76330f74f526d64ea3e974b8c38efa6c73ad68fd
+  metadata.gz: 9dfd3eb0dae94b317f4490b9f32ac0c74b0e8f1bb823c186137cd385bb6dca7d96ad9ad4901124254a3e5683f066142246d57bdb9eef6041e7f9736288ba5337
+  data.tar.gz: f41231aa62ed1453868d538734f6355ddc5409c0b9b9afaea4886d35a000f205ffa720f4750d40c2639bf3698a05a716119d7b7aa8e0d8eb4344f7894c82356b

data/README.md

@@ -11,24 +11,8 @@ It doesn't use the usual assertion style (`assert(1, 1)`) nor the rspec style(`1
 It uses natural assertions.
 
 This means that:
-- A test will pass if it returns true
-- A test will fail if it returns false
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'matest'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install matest
+- A test will pass if it returns `true`
+- A test will fail if it returns `false`
 
 ## Usage
 
@@ -61,7 +45,7 @@ scope do
 end
 ```
 
-If the return value of the `spec` block is `true`, the spec will pass and if it's false it will `fail`.
+If the return value of the `spec` block is `true`, the spec will pass and if it's `false` it will fail.
 
 If you return anithing else, you'll get a `NOT A NATURAL ASSERTION` status.
 
@@ -85,10 +69,10 @@ You can skip a test in two possible ways: You can declare a spec whithout a bloc
 
 ```ruby
 scope do
-  xspec "I'll be skipped" do
+  spec "I'll be skipped"
+  xspec "I'll be skipped too" do
     true
   end
-  spec "I'll be skipped too"
 end
 ```
 
@@ -98,11 +82,11 @@ You can skip the whole scope  by using `xscope` instead of `scope`.
 
 Take into account that `xscope` is a no-op so you won't be informed when you skip a scope.
 
-## Let and let!
+## `#let` and `#let!`
 
 Matest steals the `let` and `let!` features from `RSpec` and `Minitest`.
 
-With `let` you can declare a lazy variable valid on the current scope and all sub-scopes.
+With `let` you can declare a lazy variable valid on the current scope and all sub-scopes. `let!` has the same efect, but it won't be lazy (it wil be loaded when defined).
 
 Here are some examples of what you can do with them:
 
@@ -147,6 +131,28 @@ scope do
 end
 ```
 
+## Matchers
+
+Matest doesn't come with predefined matchers, it doesn't need them. In fact, the concept of a matcher is not required, because of the natural assertions nature of the library.
+
+But you can define helper methods to *assert* long, complex or repeated logic:
+
+```ruby
+def is_even?(val)
+  val % 2 == 0
+end
+
+scope do
+  spec do
+    is_even?(4)
+  end
+
+  spec do
+    ! is_even?(5)
+  end
+end
+```
+
 ## Aliases
 
 You may be used to other keywords provenient from different testing frameworks. Matest has a couple of alias that you may use indistinctly to fit your style.
@@ -161,6 +167,22 @@ You may be used to other keywords provenient from different testing frameworks.
 - `test` (and `xtest`)
 - `example` (and `xexample`)
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'matest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install matest
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/matest/fork )

data/lib/matest.rb

@@ -1,13 +1,18 @@
 require "matest/version"
 require "matest/spec_status"
+require "matest/spec_printer"
+
+
 module Matest
   class Runner
     attr_reader :example_groups
     attr_reader :info
+    attr_reader :printer
 
-    def initialize
+    def initialize(printer: SpecPrinter.new)
       @example_groups = []
-      @info = {}
+      @info           = {}
+      @printer        = printer
     end
 
     def self.runner
@@ -26,60 +31,26 @@ module Matest
       example_groups.each do |current_group|
         current_group.execute!
       end
-      print_messages
-    end
-
-    def print_messages
-      puts "\n\n### Messages ###"
-
-      statuses = []
-      info[:success] = true
-      info[:num_specs] = { total: 0 }
-
-      example_groups.each do |current_group|
-        current_group.statuses.each do |status|
-          info[:num_specs][:total] += 1
-
-          info[:num_specs][status.name] ||= 0
-          info[:num_specs][status.name] += 1
-
-          if status.is_a?(Matest::SpecPassed)
-          else
-            if status.is_a?(Matest::SpecFailed)
-              info[:success] = false
-            end
-            puts "\n[#{status.name}] #{status.description}"
-            if status.is_a?(Matest::NotANaturalAssertion)
-              info[:success] = false
-              puts "  # => #{status.result.inspect}"
-            end
-            if status.is_a?(Matest::ExceptionRaised)
-              info[:success] = false
-              puts "EXCEPTION >> #{status.result}"
-              status.result.backtrace.each do |l|
-                puts "  #{l}"
-              end
-
-            end
-            puts "  #{status.location}:"
-          end
-        end
-      end
+      printer.print(self)
     end
   end
 
   class SkipMe; end
 
   class Example
-    attr_reader :example_block
-    attr_reader :description
+    def example_block
+      @__example_block
+    end
+    def description
+      @__description
+    end
 
     def initialize(example_block, description, lets)
-      @example_block = example_block
-      @description = description
+      @__example_block = example_block
+      @__description = description
       lets.each do |let|
         self.class.let(let.var_name, &let.block)
-      send(let.var_name) if let.and_call
+        send(let.var_name) if let.and_call
       end
     end
 
@@ -92,20 +63,24 @@ module Matest
         instance_variable_set(:"@#{var_name}", block.call)
       end
     end
+
+    def track
+      instance_variables.reject {|i| i.to_s =~ /\A@__/}.map {|i| [i, instance_variable_get(i)] }
+    end
   end
 
   class Let
     attr_reader :var_name
     attr_reader :block
     attr_reader :and_call
-    
+
     def initialize(var_name, block, and_call=false)
       @var_name = var_name
       @block = block
       @and_call = and_call
     end
   end
-  
+
   class ExampleGroup
     attr_reader :scope_block
     attr_reader :specs
@@ -169,14 +144,13 @@ module Matest
                                 else
                                   Matest::NotANaturalAssertion
                                 end
-                 status_class.new(spec.example_block, result, spec.description)
+                 status_class.new(spec, result)
                rescue Exception => e
-                 Matest::ExceptionRaised.new(spec.example_block, e, spec.description)
+                 Matest::ExceptionRaised.new(spec, e, spec.description)
                end
       @statuses << status
       status
     end
-
   end
 end
 

data/lib/matest/spec_printer.rb

@@ -0,0 +1,47 @@
+module Matest
+
+  class SpecPrinter
+
+    def print(runner)
+      puts "\n\n### Messages ###"
+
+      statuses = []
+      runner.info[:success] = true
+      runner.info[:num_specs] = { total: 0 }
+
+      runner.example_groups.each do |current_group|
+        current_group.statuses.each do |status|
+          runner.info[:num_specs][:total] += 1
+
+          runner.info[:num_specs][status.name] ||= 0
+          runner.info[:num_specs][status.name] += 1
+
+          if status.is_a?(Matest::SpecPassed)
+          else
+            puts "\n[#{status.name}] #{status.description}"
+            if status.is_a?(Matest::SpecFailed)
+              runner.info[:success] = false
+              puts "Variables: "
+              status.example.track.each do |var, val|
+                puts "  #{var}: #{val.inspect}"
+              end
+            end
+            if status.is_a?(Matest::NotANaturalAssertion)
+              runner.info[:success] = false
+              puts "  # => #{status.result.inspect}"
+            end
+            if status.is_a?(Matest::ExceptionRaised)
+              runner.info[:success] = false
+              puts "EXCEPTION >> #{status.result}"
+              status.result.backtrace.each do |l|
+                puts "  #{l}"
+              end
+
+            end
+            puts "  #{status.location}:"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/matest/spec_status.rb

@@ -1,17 +1,19 @@
 module Matest
   class SpecStatus
-    attr_reader :block
-    attr_reader :description
+    attr_reader :example
     attr_reader :result
 
-    def initialize(block, result, description=nil)
-      @block = block
+    def initialize(example, result, description=nil)
+      @example = example
       @result = result
-      @description = description
     end
 
     def location
-      "%s:%d" % block.source_location
+      "%s:%d" % example.example_block.source_location
+    end
+
+    def description
+      example.description
     end
   end
 

data/lib/matest/version.rb

@@ -1,3 +1,3 @@
 module Matest
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/matest_specs/failing_spec.rb

@@ -0,0 +1,7 @@
+scope do
+  let(:a) { true }
+  spec do
+    @b = false
+    a == @b
+  end
+end

data/spec/matest_specs/matchers_spec.rb

@@ -0,0 +1,12 @@
+def is_even?(val)
+  val % 2 == 0
+end
+scope do
+  spec do
+    is_even?(4)
+  end
+
+  spec do
+    ! is_even?(5)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: matest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Federico Iachetti
@@ -53,10 +53,13 @@ files:
 - Rakefile
 - bin/mt
 - lib/matest.rb
+- lib/matest/spec_printer.rb
 - lib/matest/spec_status.rb
 - lib/matest/version.rb
 - matest.gemspec
 - spec/matest_spec.rb
+- spec/matest_specs/failing_spec.rb
+- spec/matest_specs/matchers_spec.rb
 - spec/matest_specs/nested_scopes_spec.rb
 - spec/matest_specs/passing_spec.rb
 - spec/matest_specs/scope_spec.rb
@@ -89,6 +92,8 @@ specification_version: 4
 summary: Tests gasoleros (cheap tests).
 test_files:
 - spec/matest_spec.rb
+- spec/matest_specs/failing_spec.rb
+- spec/matest_specs/matchers_spec.rb
 - spec/matest_specs/nested_scopes_spec.rb
 - spec/matest_specs/passing_spec.rb
 - spec/matest_specs/scope_spec.rb