matest 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92cbe87cbc8b53490086b363cba0466107e906a5
-  data.tar.gz: 545125006ca70b8c13ca8b5632183e3832731898
+  metadata.gz: 84452e41b4f3cd9abc5a1bbc3f908700a9cc8861
+  data.tar.gz: 68d2dabb2017c46bc31eb36d8b67e918e8eddab7
 SHA512:
-  metadata.gz: d743771c606770155e344f1bdc5c13118a386bdbc1e28ced772ff97108bbc27482772e5e3a69fec9d9c764d2ed637915cf48974aa48ca45f29d74b22dd6567ed
-  data.tar.gz: 686cbd8a5ef598ee08564e4c27ce575895b5f30ed6a044f2dfdb79199ef76876cff2da3b133f168a16a5f6f9c48fc9729f04f98cbe2c5aa70d666b3f8e84e7c8
+  metadata.gz: 16fa8463a914188a962999097d5c9b54182c56dc5ed3f528cf2a010dcf1bf75ae9b62dfa9d8c61ab6402c8116e6fce2181d2398afb2db80c35db6c822f7abd70
+  data.tar.gz: 35dcf6b249937b2a4eed2491dd8d4f2d5ed5c319a1973b45d64189bd38991f4f3127692e084ecb0e0d555810184c3dcffd395159490b7aa676971f6de91d28ad

data/Gemfile

@@ -1,3 +1,3 @@
 source "https://rubygems.org"
-gemspec 
+gemspec
 

data/README.md

@@ -74,15 +74,6 @@ This is important, because the assertion will be evaluated and it will provide t
 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.
@@ -162,9 +153,9 @@ In case the test fails, you'll get an extensive explanation about why.
 To show a trivial example:
 
 ```ruby
-scope "hola" do
+scope do
   let(:three) { 3 }
-  spec "chau" do
+  spec "Printing Failing Specs" do
     one = 2
     two = 2
     @one_plus_two_plus_three = one + two + three
@@ -182,7 +173,7 @@ F
 
 ### Messages ###
 
-[FAILING] chau
+[FAILING] Printing Failing Specs
 Location:
   spec/matest_specs/printing_assertion_spec.rb:3:
 Assertion: 

data/lib/matest.rb

@@ -1,208 +1,15 @@
 require "matest/version"
+
+require "matest/runner"
+require "matest/example_group"
+require "matest/example"
 require "matest/example_block"
+require "matest/let"
+require "matest/skip_me"
 require "matest/spec_status"
 require "matest/spec_printer"
-
+require "matest/top_level_methods"
 
 module Matest
-  class Runner
-    attr_reader :example_groups
-    attr_reader :info
-    attr_reader :printer
-
-    def initialize(options={})
-      @example_groups = []
-      @info           = {}
-      @printer        = options[:printer] || SpecPrinter.new
-    end
-
-    def self.runner
-      @runner ||= new
-    end
-
-    def <<(example_group)
-      example_groups << example_group
-    end
-
-    def load_file(file)
-      load(file)
-    end
-
-    def execute!
-      example_groups.each do |current_group|
-        current_group.execute!
-      end
-      printer.print(self)
-    end
-  end
-
-  class SkipMe; end
-
-  class Example
-    def initialize(example_block, description, lets)
-      @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.block)
-    end
-
-    def self.let(var_name, &block)
-      define_method(var_name) do
-        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_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
-    attr_reader :var_name
-    attr_reader :block
-    attr_reader :bang
-
-    def initialize(var_name, block, bang=false)
-      @var_name = var_name
-      @block = block
-      @bang = bang
-    end
-  end
-
-  class ExampleGroup
-    attr_reader :scope_block
-    attr_reader :specs
-    attr_reader :lets
-    attr_reader :statuses
-
-    def initialize(scope_block)
-      @scope_block = scope_block
-      @specs       = []
-      @lets        = []
-      @statuses    = []
-    end
-
-    def spec(description=nil, &block)
-      current_example = block_given? ? block : ->(*) { Matest::SkipMe.new }
-      specs << Example.new(current_example, description, lets)
-    end
-
-    def execute!
-      instance_eval(&scope_block)
-      specs.shuffle.each do |spec, desc|
-        res = run_spec(spec)
-        print res
-      end
-
-    end
-
-    def xspec(description=nil, &block)
-      spec(description)
-    end
-
-    alias :it :spec
-    alias :xit :xspec
-
-    alias :test :spec
-    alias :xtest :xspec
-
-    alias :example :spec
-    alias :xexample :xspec
-
-
-    def self.let(var_name, &block)
-      define_method(var_name) do
-        instance_variable_set(:"@#{var_name}", block.call)
-      end
-    end
-
-    def let(var_name, bang=false, &block)
-      lets << Let.new(var_name, block, bang=false)
-    end
-
-    def let!(var_name, &block)
-      lets << Let.new(var_name, block, bang=true)
-    end
-
-    def run_spec(spec)
-      status = begin
-                 result = spec.call
-                 status_class = case result
-                                when true
-                                  Matest::SpecPassed
-                                when false
-                                  Matest::SpecFailed
-                                when Matest::SkipMe
-                                  Matest::SpecSkipped
-                                else
-                                  Matest::NotANaturalAssertion
-                                end
-                 status_class.new(spec, result)
-               rescue Exception => e
-                 Matest::ExceptionRaised.new(spec, e, spec.description)
-               end
-      @statuses << status
-      status
-    end
-  end
-end
-
-def scope(description=nil, &block)
-  Matest::Runner.runner << Matest::ExampleGroup.new(block)
-end
-
-def xscope(description=nil, &block)
-  # no-op
 end
 
-alias :describe :scope
-alias :xdescribe :xscope
-
-alias :context :scope
-alias :xcontext :xscope
-
-alias :group :scope
-alias :xgroup :xscope

data/lib/matest/evaluator.rb

@@ -0,0 +1,47 @@
+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 Evaluator
+    def initialize(example, block)
+      @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
+end

data/lib/matest/example.rb

@@ -0,0 +1,92 @@
+module Matest
+  class Example
+    def initialize(example_block, description, lets)
+      @example_block__for_internal_use = ExampleBlock.new(example_block)
+      @description__for_internal_use = description
+      @lets__for_internal_use = lets
+      lets.each do |let|
+        self.class.let(let.var_name, &let.block)
+        send(let.var_name) if let.bang
+      end
+    end
+
+    def lets
+      @lets__for_internal_use
+    end
+    
+    def example_block
+      @example_block__for_internal_use
+    end
+
+    def description
+      @description__for_internal_use
+    end
+
+    def call
+      instance_eval(&example_block.block)
+    end
+
+    def self.let(var_name, &block)
+      define_method(var_name) do
+        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_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
+
+    def just_before_assertion
+      # return a clone of self, but with
+      ExampleBeforeAssertion.new(example_block.block, description, lets)
+    end
+  end
+
+  private
+
+  class ExampleBeforeAssertion < Example
+    def initialize(example_block, description, lets)
+      super
+      set_state
+    end
+
+    def set_state
+      before_sexp = example_block.sexp[0..-2]
+      @code = Sorcerer.source(before_sexp)
+      eval(@code)
+    end
+
+    def before_assertion_block
+      eval("proc { #{@code} }")
+    end
+    
+  end
+end

data/lib/matest/example_group.rb

@@ -0,0 +1,80 @@
+module Matest
+  class ExampleGroup
+    attr_reader :scope_block
+    attr_reader :specs
+    attr_reader :lets
+    attr_reader :statuses
+
+    attr_accessor :printer
+    
+    def initialize(scope_block)
+      @scope_block = scope_block
+      @specs       = []
+      @lets        = []
+      @statuses    = []
+    end
+
+    def spec(description=nil, &block)
+      current_example = block_given? ? block : ->(*) { Matest::SkipMe.new }
+      specs << Example.new(current_example, description, lets)
+    end
+
+    def execute!
+      instance_eval(&scope_block)
+      specs.shuffle.each do |spec, desc|
+        res = run_spec(spec)
+        printer.print(res)
+      end
+
+    end
+
+    def xspec(description=nil, &block)
+      spec(description)
+    end
+
+    alias :it :spec
+    alias :xit :xspec
+
+    alias :test :spec
+    alias :xtest :xspec
+
+    alias :example :spec
+    alias :xexample :xspec
+
+
+    def self.let(var_name, &block)
+      define_method(var_name) do
+        instance_variable_set(:"@#{var_name}", block.call)
+      end
+    end
+
+    def let(var_name, bang=false, &block)
+      lets << Let.new(var_name, block, bang=false)
+    end
+
+    def let!(var_name, &block)
+      lets << Let.new(var_name, block, bang=true)
+    end
+
+    def run_spec(spec)
+      status = begin
+                 result = spec.call
+                 status_class = case result
+                                when true
+                                  Matest::SpecPassed
+                                when false
+                                  Matest::SpecFailed
+                                when Matest::SkipMe
+                                  Matest::SpecSkipped
+                                else
+                                  Matest::NotANaturalAssertion
+                                end
+                 status_class.new(spec, result)
+               rescue Exception => e
+                 Matest::ExceptionRaised.new(spec, e, spec.description)
+               end
+      @statuses << status
+      status
+    end
+  end
+end

data/lib/matest/let.rb

@@ -0,0 +1,13 @@
+module Matest
+  class Let
+    attr_reader :var_name
+    attr_reader :block
+    attr_reader :bang
+
+    def initialize(var_name, block, bang=false)
+      @var_name = var_name
+      @block = block
+      @bang = bang
+    end
+  end
+end

data/lib/matest/runner.rb

@@ -0,0 +1,34 @@
+module Matest
+  class Runner
+    attr_reader :example_groups
+    attr_reader :info
+    attr_reader :printer
+
+    def initialize(options={})
+      @example_groups = []
+      @info           = {}
+      @printer        = options[:printer] || SpecPrinter.new
+    end
+
+    def self.runner
+      @runner ||= new
+    end
+
+    def <<(example_group)
+      example_group.printer = printer
+      example_groups << example_group
+    end
+
+    def load_file(file)
+      load(file)
+    end
+
+    def execute!
+      example_groups.each do |current_group|
+        current_group.execute!
+      end
+      printer.print_messages(self)
+    end
+  end
+
+end

data/lib/matest/skip_me.rb

@@ -0,0 +1,3 @@
+module Matest
+  class SkipMe; end
+end

data/lib/matest/spec_printer.rb

@@ -1,53 +1,12 @@
-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 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
+require "matest/evaluator"
 
+module Matest
   class SpecPrinter
-    def print(runner)
+    def print(res)
+      super res
+    end
+    
+    def print_messages(runner)
       puts "\n\n### Messages ###"
 
       statuses = []
@@ -86,6 +45,11 @@ module Matest
             if status.is_a?(Matest::NotANaturalAssertion)
               runner.info[:success] = false
               puts "  # => #{status.result.inspect}"
+              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::ExceptionRaised)
               runner.info[:success] = false
@@ -101,16 +65,17 @@ module Matest
     end
 
     def print_subexpression(code, status)
-      result = Evaluator.new(status.example, status.example.example_block.block).eval_string(code)
+      just_before_assertion = status.example.just_before_assertion
+      result = Evaluator.new(just_before_assertion, just_before_assertion.before_assertion_block).eval_string(code)
       if result.class != Matest::EvalErr
         puts <<-CODE
-  "#{code}" =>
-    #{result}
+  #{code}
+    # => #{result}
       CODE
       else
         puts <<-CODE
   The assertion couldn't be explained.
-  The error message was: 
+  The error message was:
     #{result}
   Make sure you are not calling any local vaiables on your code assertion.
       CODE

data/lib/matest/top_level_methods.rb

@@ -0,0 +1,16 @@
+def scope(description=nil, &block)
+  Matest::Runner.runner << Matest::ExampleGroup.new(block)
+end
+
+def xscope(description=nil, &block)
+  # no-op
+end
+
+alias :describe :scope
+alias :xdescribe :xscope
+
+alias :context :scope
+alias :xcontext :xscope
+
+alias :group :scope
+alias :xgroup :xscope

data/lib/matest/version.rb

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

data/spec/matest_specs/printing_assertion_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matest
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Federico Iachetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2015-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,9 +67,16 @@ files:
 - Rakefile
 - bin/matest
 - lib/matest.rb
+- lib/matest/evaluator.rb
+- lib/matest/example.rb
 - lib/matest/example_block.rb
+- lib/matest/example_group.rb
+- lib/matest/let.rb
+- lib/matest/runner.rb
+- lib/matest/skip_me.rb
 - lib/matest/spec_printer.rb
 - lib/matest/spec_status.rb
+- lib/matest/top_level_methods.rb
 - lib/matest/version.rb
 - matest.gemspec
 - spec/matest_spec.rb