matest 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ef04c88e374d09410f7e524b755d30d75508ef5
-  data.tar.gz: 505f6005edf5df314ffa8b78177e888fa1388bf6
+  metadata.gz: 92cbe87cbc8b53490086b363cba0466107e906a5
+  data.tar.gz: 545125006ca70b8c13ca8b5632183e3832731898
 SHA512:
-  metadata.gz: f364ae4bf2c77c7b1f07abd412306370a824c0d68ae92dbd5092a23f17133ebf176aada8e2a62b33a326d90012286508493d23c297394f00321a1f1fa985e306
-  data.tar.gz: f792735a4069cbc2e2581a16c4cd620e3f8e7d66c360576a58adbdb4a1c90b7e47221a9192054d5e3cb47e5bb32ad10a38394b68d3d781885facdb58ddeed130
+  metadata.gz: d743771c606770155e344f1bdc5c13118a386bdbc1e28ced772ff97108bbc27482772e5e3a69fec9d9c764d2ed637915cf48974aa48ca45f29d74b22dd6567ed
+  data.tar.gz: 686cbd8a5ef598ee08564e4c27ce575895b5f30ed6a044f2dfdb79199ef76876cff2da3b133f168a16a5f6f9c48fc9729f04f98cbe2c5aa70d666b3f8e84e7c8

data/.gitignore

@@ -12,3 +12,5 @@
 *.o
 *.a
 mkmf.log
+tags
+.tags

data/README.md

@@ -1,4 +1,5 @@
 # Matest
+[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/iachettifederico/matest?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Tests Gasoleros (Very cheap tests)
 
@@ -59,6 +60,29 @@ scope "a description" do
 end
 ```
 
+## Constraints
+
+A couple of constraints must b taken into account, and this is extremely important.
+
+### The assertion MUST return a boolean
+
+The assertion is the last statement of the block and it must return either true or false.
+This is important, because the assertion will be evaluated and it will provide the status o the test.
+
+### Assertion expression
+
+The assertion can be any expression that returns a boolean value, BUT IT CANNOT CONTAIN LOCAL VARIABLES.
+If the assertion contains a local variable and it fails, the code that explains it bit by bit will throw an error.
+
+### The assertion MUST be idempotent
+
+Once the code is run, the state of the block gets saved.
+If the test fails, the assertion will be re-run a couple of times.
+So if you are popping the last element of an array inside the assertion, each time it gets run, you'll be popping the next element on the chain.
+The reason for this is that Matest will show you the result of each part of the expression and for that, it needs to re-run each part.
+
+Removing this constraint is a high priority on my todo list. But I'm considering the threadoffs of doing it. I'll be happy to pair or discuss on this matter.
+
 ## Raising Errors
 
 If your test raises an error during the run, youll get an `ERROR` status and you'll see the backtrace.
@@ -133,7 +157,47 @@ end
 
 ## The output
 
-In case the test fails, the instance variables you define inside it as well as the ones defined by `let` and `let!` are tracked and you'll see their final values in the output.
+In case the test fails, you'll get an extensive explanation about why.
+
+To show a trivial example:
+
+```ruby
+scope "hola" do
+  let(:three) { 3 }
+  spec "chau" do
+    one = 2
+    two = 2
+    @one_plus_two_plus_three = one + two + three
+    @res = 3
+    
+    @one_plus_two_plus_three.to_i == @res
+  end
+end
+```
+
+It fails and the output will be
+
+```
+F
+
+### Messages ###
+
+[FAILING] chau
+Location:
+  spec/matest_specs/printing_assertion_spec.rb:3:
+Assertion: 
+  @one_plus_two_plus_three.to_i == @res
+Variables: 
+  @one_plus_two_plus_three: 7
+  @res: 3
+Lets: 
+  three: 3
+Explanation:
+  "@one_plus_two_plus_three.to_i == @res" =>
+    false
+  "@one_plus_two_plus_three.to_i" =>
+    7
+```
 
 ## Matchers
 

data/lib/matest.rb

@@ -1,4 +1,5 @@
 require "matest/version"
+require "matest/example_block"
 require "matest/spec_status"
 require "matest/spec_printer"
 
@@ -38,35 +39,65 @@ module Matest
   class SkipMe; end
 
   class Example
-    def example_block
-      @__example_block
-    end
-    def description
-      @__description
-    end
-
     def initialize(example_block, description, lets)
-      @__example_block = example_block
-      @__description = description
+      @example_block__for_internal_use = ExampleBlock.new(example_block)
+      @description__for_internal_use = description
       lets.each do |let|
         self.class.let(let.var_name, &let.block)
         send(let.var_name) if let.bang
       end
     end
 
+    def example_block
+      @example_block__for_internal_use
+    end
+
+    def description
+      @description__for_internal_use
+    end
+
     def call
-      instance_eval(&example_block)
+      instance_eval(&example_block.block)
     end
 
     def self.let(var_name, &block)
       define_method(var_name) do
-        instance_variable_set(:"@#{var_name}", block.call)
+        instance_variable_set(:"@#{var_name}__from_let", block.call)
+      end
+    end
+
+    def self.local_var(var_name)
+      define_method(var_name) do
+        instance_variable_get(:"@#{var_name}")
+      end
+      define_method("#{var_name}=") do |value|
+        instance_variable_set(:"@#{var_name}", value)
       end
     end
 
-    def track
-      instance_variables.reject {|i| i.to_s =~ /\A@__/}.map {|i| [i, instance_variable_get(i)] }
+    def track_variables
+      instance_variables.reject {|var|
+        var.to_s =~ /__for_internal_use\Z/ || var.to_s =~ /__from_let\Z/
+      }.map {|var| [var, instance_variable_get(var)] }
     end
+
+    def track_lets
+      instance_variables.select {|var|
+        var.to_s =~ /__from_let\Z/
+      }.map {|var|
+        name = var.to_s
+        name["__from_let"] = ""
+        name[0] = ""
+        [name, instance_variable_get(var)]
+      }
+    end
+
+    def without_block
+      the_new = self.clone
+      the_new.instance_variable_set(:@example_block__for_internal_use, nil)
+      the_new
+    end
+
   end
 
   class Let

data/lib/matest/example_block.rb

@@ -0,0 +1,50 @@
+require "ripper"
+require "sorcerer"
+
+class ExampleBlock
+  attr_reader :block
+  attr_reader :code
+  attr_reader :sexp
+  attr_reader :assertion
+  attr_reader :assertion_sexp
+
+  def initialize(block)
+    @block = block
+
+    @code = generate_code
+
+    @sexp = Ripper::SexpBuilder.new(code).parse.last
+    @assertion_sexp = @sexp.last
+    @assertion = Sorcerer.source(assertion_sexp)
+  end
+
+  def call
+    block.call
+  end
+
+  def source_location
+    block.source_location
+  end
+
+  private
+
+  def generate_code
+    file = File.open(block.source_location.first)
+    source = file.read
+    lines = source.each_line.to_a
+
+    lineno = block.source_location.last
+
+    current_line = lineno-1
+    valid_lines = [lines[current_line]]
+
+    valid_lines
+
+    until Ripper::SexpBuilder.new(valid_lines.join("\n")).parse
+      current_line += 1
+      valid_lines << lines[current_line]
+    end
+    code_array = valid_lines[1..-2]
+    code_array.join
+  end
+end

data/lib/matest/spec_printer.rb

@@ -1,7 +1,52 @@
 module Matest
+  class EvalErr
+    def initialize(str)
+      @string = str
+    end
+    def size
+      inspect.size
+    end
+    def to_s
+      @string
+    end
+    def inspect
+      @string
+    end
+  end
 
-  class SpecPrinter
+  class Evaluator
+    def initialize(example, block)
+      # @example = Marshal.load( Marshal.dump(example) )
+      @example = example
+      @block = block
+    end
+
+    def eval_string(exp_string)
+      limit_length(eval_in_context(exp_string).inspect)
+    rescue StandardError => ex
+      EvalErr.new("#{ex.class}: #{ex.message}")
+    end
+
+    private
+
+    MAX_INSPECT_SIZE = 2000
+
+    def limit_length(string)
+      if string.size > MAX_INSPECT_SIZE
+        string[0..MAX_INSPECT_SIZE] + " (...truncated...)"
+      else
+        string
+      end
+    end
+
+    def eval_in_context(exp_string)
+      exp_proc = "proc { #{exp_string} }"
+      blk = eval(exp_proc, @block.binding)
+      @example.instance_eval(&blk)
+    end
+  end
 
+  class SpecPrinter
     def print(runner)
       puts "\n\n### Messages ###"
 
@@ -16,15 +61,27 @@ module Matest
           runner.info[:num_specs][status.name] ||= 0
           runner.info[:num_specs][status.name] += 1
 
-          if status.is_a?(Matest::SpecPassed)
-          else
+          if !status.is_a?(Matest::SpecPassed)
             puts "\n[#{status.name}] #{status.description}"
+            puts "Location:\n  #{status.location}:"
+
             if status.is_a?(Matest::SpecFailed)
               runner.info[:success] = false
+              puts "Assertion: \n  #{status.example.example_block.assertion}"
               puts "Variables: "
-              status.example.track.each do |var, val|
+              status.example.track_variables.each do |var, val|
                 puts "  #{var}: #{val.inspect}"
               end
+              puts "Lets: "
+              status.example.track_lets.each do |var, val|
+                puts "  #{var}: #{val.inspect}"
+              end
+
+              puts "Explanation:"
+              subexpressions = Sorcerer.subexpressions(status.example.example_block.assertion_sexp).reverse.uniq.reverse
+              subexpressions.each do |code|
+                print_subexpression(code, status)
+              end
             end
             if status.is_a?(Matest::NotANaturalAssertion)
               runner.info[:success] = false
@@ -38,10 +95,26 @@ module Matest
               end
 
             end
-            puts "  #{status.location}:"
           end
         end
       end
     end
+
+    def print_subexpression(code, status)
+      result = Evaluator.new(status.example, status.example.example_block.block).eval_string(code)
+      if result.class != Matest::EvalErr
+        puts <<-CODE
+  "#{code}" =>
+    #{result}
+      CODE
+      else
+        puts <<-CODE
+  The assertion couldn't be explained.
+  The error message was: 
+    #{result}
+  Make sure you are not calling any local vaiables on your code assertion.
+      CODE
+      end
+    end
   end
 end

data/lib/matest/version.rb

@@ -1,3 +1,3 @@
 module Matest
-  VERSION = "1.1.4"
+  VERSION = "1.2.0"
 end

data/matest.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "sorcerer", "~> 1.0.2"
 end

data/spec/matest_specs/aliases_spec.rb

@@ -1,65 +1,65 @@
 scope do
   spec { true }
-  xspec { true }
+  xspec { false }
 
   example { true }
-  xexample { true }
+  xexample { false }
 
   it { true }
-  xit { true }
+  xit { false }
 end
 
 describe do
   spec { true }
-  xspec { true }
+  xspec { false }
 
   example { true }
-  xexample { true }
+  xexample { false }
 
   it { true }
-  xit { true }
+  xit { false }
 end
 
 context do
   spec { true }
-  xspec { true }
+  xspec { false }
 
   example { true }
-  xexample { true }
+  xexample { false }
 
   it { true }
-  xit { true }
+  xit { false }
 end
 
 xscope do
   spec { true }
-  xspec { true }
+  xspec { false }
 
   example { true }
-  xexample { true }
+  xexample { false }
 
   it { true }
-  xit { true }
+  xit { false }
 end
 
 xdescribe do
   spec { true }
-  xspec { true }
+  xspec { false }
 
   example { true }
-  xexample { true }
+  xexample { false }
 
   it { true }
-  xit { true }
+  xit { false }
 end
 
 xcontext do
   spec { true }
-  xspec { true }
+  xspec { false }
 
   example { true }
-  xexample { true }
+  xexample { false }
 
   it { true }
-  xit { true }
+  xit { false }
 end

data/spec/matest_specs/printing_assertion_spec.rb

@@ -0,0 +1,35 @@
+scope "hola" do
+  let(:three) { 3 }
+  xspec "chau" do
+    one = 2
+    two = 2
+
+    @one_plus_two_plus_three = one + two + three
+    @res = 3
+    @one_plus_two_plus_three.to_i == @res
+  end
+
+  xspec "again?" do
+    @arr = %w[a b c d e]
+
+    @arr.pop == "k"
+  end
+
+  spec  do
+    a = 4
+
+    a == 5
+  end
+end
+
+# @one_plus_two == @res.to_i => false
+# @one_plus_two => 4
+# @res => "3"
+# @res.to_i => 3
+
+
+## ON EXAMPLE
+# on call:
+#   - run the spec without the assertion
+#   - save the state
+#   - and then run the assertion.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matest
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Federico Iachetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2015-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sorcerer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 description: Natural assertions test suite.
 email:
 - iachetti.federico@gmail.com
@@ -53,6 +67,7 @@ files:
 - Rakefile
 - bin/matest
 - lib/matest.rb
+- lib/matest/example_block.rb
 - lib/matest/spec_printer.rb
 - lib/matest/spec_status.rb
 - lib/matest/version.rb
@@ -63,6 +78,7 @@ files:
 - spec/matest_specs/matchers_spec.rb
 - spec/matest_specs/nested_scopes_spec.rb
 - spec/matest_specs/passing_spec.rb
+- spec/matest_specs/printing_assertion_spec.rb
 - spec/matest_specs/scope_spec.rb
 - spec/matest_specs/scoping_stuff_spec.rb
 - spec/matest_specs/spec_helper.rb
@@ -87,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Tests gasoleros (cheap tests).
@@ -98,6 +114,7 @@ test_files:
 - spec/matest_specs/matchers_spec.rb
 - spec/matest_specs/nested_scopes_spec.rb
 - spec/matest_specs/passing_spec.rb
+- spec/matest_specs/printing_assertion_spec.rb
 - spec/matest_specs/scope_spec.rb
 - spec/matest_specs/scoping_stuff_spec.rb
 - spec/matest_specs/spec_helper.rb