wrong 0.6.3 → 0.7.0

data/README.markdown

@@ -100,6 +100,8 @@ If you want to compare floats, try this:
 
 If you don't want `close_to?` cluttering up `Float` in your test runs then use `include Wrong::Assert` instead of `include Wrong`.
 
+`close_to?` also works on `Time`s, `Date`s, and `DateTime`s. (The default tolerance of 1 msec may be too small for you.)
+
 ### d
 
 We also implement the most amazing debugging method ever, `d`, which gives you a sort of mini-wrong wherever you want it
@@ -251,29 +253,30 @@ Wrong is compatible with RSpec and MiniTest::Spec, and probably Cucumber too, so
 Here's an RSpec example:
 
 	require "wrong/adapters/rspec"
-	Wrong.config.alias_assert :expect_that
+	Wrong.config.alias_assert :expect, override: true
 
 	describe BleuCheese do
 	  it "stinks" do
-	    expect_that { BleuCheese.new.smell > 9000 }
+	    cheese = BleuCheese.new
+	    expect { cheese.smell > 9000 }
 	  end
 	end
 
 This makes your code read like a BDD-style DSL, without RSpec's "should" syntax (which is, let's face it, pretty weird the first few hundred times you have to use it). Compare
 
-    expect_that { BleuCheese.new.smell > 9000 }
+    expect { cheese.smell > 9000 }
 
  to
 
-    BleuCheese.new.smell.should > 9000
+    cheese.smell.should be > 9000
 
-and consider which one more clearly describes the desired behavior. The object under test doesn't really have a `should` method, so why should it magically get one during a test? And in what human language is "should greater than" a valid phrase?
+and consider which one more clearly describes the desired behavior. The object under test doesn't really have a `should` method, so why should it magically get one during a test?
 
 Warning: currently the use of `alias_assert :expect` is **not** compatible with RSpec, since RSpec also defines `expect` as a synonym for `lambda`. If you really want to use `expect` as an alias form `assert`, then use `Wrong.config.alias_assert :expect, :override => true`. See [issue #6](https://github.com/sconover/wrong/issues/6) for more details.
 
 ## Algorithm ##
 
-So wait a second. How do we do it? Doesn't Ruby have [poor support for AST introspection](http://blog.zenspider.com/2009/04/parsetree-eol.html)? Well, yes, it does, so we cheat: we figure out what file and line the assert block is defined in, then open the file, read the code, and parse it directly using Ryan Davis' amazing [RubyParser](http://parsetree.rubyforge.org/ruby_parser/) and [Ruby2Ruby](http://seattlerb.rubyforge.org/ruby2ruby/). You can bask in the kludge by examining `chunk.rb` and `assert.rb`. If you find some code it can't parse, please send it our way. As a failsafe we also use Sourcify, which has yet another home baked RACC parser, so we have many chances to parse your code.
+So wait a second. How do we do it? Doesn't Ruby have [poor support for AST introspection](http://blog.zenspider.com/2009/04/parsetree-eol.html)? Well, yes, it does, so we cheat: we figure out what file and line the assert block is defined in, then open the file, read the code, and parse it directly using Ryan Davis' amazing [RubyParser](http://parsetree.rubyforge.org/ruby_parser/) and [Ruby2Ruby](http://seattlerb.rubyforge.org/ruby2ruby/). You can bask in the kludge by examining `chunk.rb` and `assert.rb`. If you find some code it can't parse, please send it our way.
 
 Before you get your knickers in a twist about how this is totally unacceptable because it doesn't support this or that use case, here are our caveats and excuses:
 
@@ -462,7 +465,7 @@ If you're in Ruby 1.8, you **really** shouldn't do it! But if you do, you can us
 
 ## Bugs ##
 
-* assert doesn't work (can't find the source code) from inside a "Dir.chdir" block
+* see Github Issues <http://github.com/sconover/wrong/issues>
 
 ## todo ##
 

data/lib/wrong.rb

@@ -5,6 +5,7 @@ require "predicated"
 require "wrong/assert"
 require "wrong/helpers"
 require "wrong/chunk"
+require "wrong/terminal"
 require "wrong/sexp_ext"
 require "wrong/version"
 require "wrong/config"

data/lib/wrong/adapters/rspec.rb

@@ -1,4 +1,5 @@
 require "wrong"
+require "wrong/terminal"
 
 if Object.const_defined? :RSpec
   # RSpec 2
@@ -58,6 +59,9 @@ if Object.const_defined? :RSpec
    end
  end
 
+  # tweak terminal width so exceptions wrap properly inside RSpec output
+  Wrong::Terminal.width -= 7
+
 elsif Object.const_defined? :Spec
   # RSpec 1
  Spec::Runner.configure do |config|

data/lib/wrong/assert.rb

@@ -5,7 +5,6 @@ require "predicated/to/sentence"
 require "wrong/chunk"
 require "wrong/config"
 require "wrong/failure_message"
-require "wrong/ruby2ruby_patch" # need to patch it after some other stuff loads
 require "wrong/rainbow"
 
 module Wrong
@@ -68,7 +67,7 @@ module Wrong
       value = !value if valence == :deny
       if value
         if Wrong.config[:verbose]
-          code = Wrong::Chunk.from_block(block, depth + 2).code 
+          code = Wrong::Chunk.from_block(block, depth + 2).code
           if Wrong.config[:color]
             explanation = explanation.color(:blue) if explanation
             code = code.color(:green)

data/lib/wrong/chunk.rb

@@ -2,18 +2,6 @@ require 'ruby_parser'
 require 'ruby2ruby'
 require 'pp'
 
-def require_optionally(library)
-  begin
-    require library
-  rescue LoadError => e
-    raise e unless e.message == "no such file to load -- #{library}" or
-      e.message == "cannot load such file -- #{library}" # 1.9.3 changed the error message
-  end
-end
-
-require_optionally "ParseTree"
-require_optionally "sourcify"
-
 require "wrong/config"
 require "wrong/sexp_ext"
 require "wrong/capturing"
@@ -60,21 +48,11 @@ module Wrong
     end
 
     def build_sexp
-      sexp = begin
-        unless @block.nil? or @block.is_a?(String) or !Object.const_defined?(:Sourcify)
-          # first try sourcify
-          @block.to_sexp[3] # the [3] is to strip out the "proc {" sourcify adds to everything
-        end
-      rescue Exception => e
-        # sourcify failed, so fall through
-      end
-
-      # next try glomming
-      sexp ||= glom(if @file == "(irb)"
-                      IRB.CurrentContext.all_lines
-                    else
-                      read_source_file(@file)
-                    end)
+      glom(if @file == "(irb)"
+             IRB.CurrentContext.all_lines
+           else
+             read_source_file(@file)
+           end)
     end
 
     def read_source_file(file)
@@ -95,7 +73,6 @@ module Wrong
       while sexp.nil? && line_index + c < lines.size
         begin
           @chunk = lines[line_index..line_index+c].join("\n")
-
           capturing(:stderr) do  # new RubyParser is too loud
             sexp = @parser.parse(@chunk)
           end
@@ -164,148 +141,6 @@ module Wrong
       end
     end
 
-    def details
-      @details ||= build_details
-    end
-
-    def pretty_value(value, starting_col = 0, indent_wrapped_lines = 6, width = Chunk.terminal_width)
-      # inspected = value.inspect
-
-      # note that if the first line overflows due to the starting column then pp won't wrap it right
-      inspected = PP.pp(value, "", width - starting_col).chomp
-
-      # this bit might be redundant with the pp call now
-      indented = indent_all(6, inspected)
-      if width
-        wrap_and_indent(indented, starting_col, indent_wrapped_lines, width)
-      else
-        indented
-      end
-    end
-
-    private
-
-    # todo: move to FailureMessage?
-    def build_details
-      require "wrong/rainbow" if Wrong.config[:color]
-      s = ""
-      parts = self.parts
-      parts.shift # remove the first part, since it's the same as the code
-
-      details = []
-
-      if parts.size > 0
-        parts.each do |part|
-          begin
-            value = eval(part, block.binding)
-            unless part == value.inspect # this skips literals or tautologies
-              if part =~ /\n/m
-                part.gsub!(/\n/, newline(2))
-                part += newline(3)
-              end
-              value = pretty_value(value, (4 + part.length + 4))
-              if Wrong.config[:color]
-                part = part.color(:blue)
-                value = value.color(:magenta)
-              end
-              details << indent(4, part, " is ", value)
-            end
-          rescue Exception => e
-            raises = "raises #{e.class}"
-            if Wrong.config[:color]
-              part = part.color(:blue)
-              raises = raises.bold.color(:red)
-            end
-            formatted_exeption = if e.message and e.message != e.class.to_s
-                                   indent(4, part, " ", raises, ": ", indent_all(6, e.message))
-                                 else
-                                   indent(4, part, " ", raises)
-                                 end
-            details << formatted_exeption
-          end
-        end
-      end
-
-      details.uniq!
-      if details.empty?
-        ""
-      else
-        "\n" + details.join("\n") + "\n"
-      end
-
-    end
-
-public # don't know exactly why this needs to be public but eval'ed code can't find it otherwise
-    def indent(indent, *s)
-      "#{" " * indent}#{s.join('')}"
-    end
-
-    def newline(indent)
-      "\n" + self.indent(indent)
-    end
-
-    def indent_all(amount, s)
-      s.gsub("\n", "\n#{indent(amount)}")
-    end
-
-    def wrap_and_indent(indented, starting_col, indent_wrapped_lines, full_width)
-      first_line = true
-      width = full_width - starting_col # the first line is essentially shorter
-      indented.split("\n").map do |line|
-        s = ""
-        while line.length > width
-          s << line[0...width]
-          s << newline(indent_wrapped_lines)
-          line = line[width..-1]
-          if first_line
-            width += starting_col - indent_wrapped_lines
-            first_line = false
-          end
-        end
-        s << line
-        s
-      end.join("\n")
-    end
-
-    # Returns [width, height] of terminal when detected, nil if not detected.
-    # Think of this as a simpler version of Highline's Highline::SystemExtensions.terminal_size()
-    # Lifted from https://github.com/cldwalker/hirb/blob/master/lib/hirb/util.rb#L59
-    #
-    # See also http://stackoverflow.com/questions/2068859/how-to-get-the-width-of-terminal-window-in-ruby
-    #  https://github.com/genki/ruby-terminfo/blob/master/lib/terminfo.rb
-    #  http://www.mkssoftware.com/docs/man1/stty.1.asp
-
-
-    def self.terminal_size
-      @@terminal_size ||= begin
-        if (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/)
-          [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
-        elsif (RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput')
-          [`tput cols`.to_i, `tput lines`.to_i]
-        elsif STDIN.tty? && command_exists?('stty')
-          `stty size`.scan(/\d+/).map { |s| s.to_i }.reverse
-        else
-          nil
-        end
-      rescue
-        nil
-      end
-    end
-
-    def self.terminal_width
-      (@terminal_width ||= nil) || (terminal_size && terminal_size.first) || 80
-    end
-
-    def self.terminal_width= forced_with
-      @terminal_width = forced_with
-    end
-
-    # Determines if a shell command exists by searching for it in ENV['PATH'].
-    def self.command_exists?(command)
-      ENV['PATH'].split(File::PATH_SEPARATOR).any? {|d| File.exists? File.join(d, command) }
-    end
-
-
   end
 
 end

data/lib/wrong/close_to.rb

@@ -1,8 +1,14 @@
 module Wrong
   module CloseTo
     def close_to?(other, tolerance = 0.001)
-      (self.to_f - other.to_f).abs < tolerance
+      if respond_to? :to_f
+        (self.to_f - other.to_f).abs < tolerance
+      elsif respond_to? :to_time
+        self.to_time.close_to?( other.to_time, tolerance)
+      end
     end
   end
   Numeric.send :include, CloseTo
+  Date.send :include, CloseTo
+  Time.send :include, CloseTo
 end

data/lib/wrong/config.rb

@@ -10,7 +10,7 @@ module Wrong
     end
     Config.new settings
   end
-  
+
   def self.config
     @config ||= load_config
   end
@@ -72,8 +72,8 @@ module Wrong
       self[:aliases][:deny]
     end
 
-    def assert_methods
-      assert_method_names + deny_method_names
+    def hidden_methods
+      assert_method_names + deny_method_names + [:eventually]
     end
   end
 end

data/lib/wrong/d.rb

@@ -21,6 +21,7 @@ module Wrong
 
       # look for a "d" inside the block
       sexp.each_subexp do |subexp|
+      #sexp.deep_each do |subexp|  # todo: try to use deep_each
         if subexp.d?
           sexp = subexp[3] # swap in the block part of the nested d call
         end
@@ -28,7 +29,7 @@ module Wrong
 
       code = sexp.to_ruby
       value = eval(code, block.binding, called_from[0], called_from[1].to_i)
-      width = Chunk.terminal_width
+      width = Terminal.width
       value = PP.pp(value, "", width - (code.size + 3)).chomp
 
       if Wrong.config[:color]

data/lib/wrong/failure_message.rb

@@ -1,3 +1,6 @@
+require "wrong/chunk"
+require "wrong/terminal"
+
 module Wrong
   class FailureMessage
     @@formatters = []
@@ -40,7 +43,6 @@ module Wrong
       end
     end
 
-
     attr_accessor :chunk, :valence, :explanation
 
     def initialize(chunk, valence, explanation)
@@ -57,20 +59,89 @@ module Wrong
       message << basic
 
       formatted_message = if predicate && !(predicate.is_a? Predicated::Conjunction)
-        if formatter = FailureMessage.formatter_for(predicate)
-          colored(:bold, formatter.describe)
-        end
-      end
+                            if formatter = FailureMessage.formatter_for(predicate)
+                              colored(:bold, formatter.describe)
+                            end
+                          end
 
-      unless chunk.details.empty? and formatted_message.nil?
+      unless details.empty? and formatted_message.nil?
         message << ", but"
       end
 
       message << formatted_message if formatted_message
-      message << chunk.details unless chunk.details.empty?
+      message << details unless details.empty?
       message
     end
 
+    def details
+      @details ||= begin
+        require "wrong/rainbow" if Wrong.config[:color]
+        s = ""
+        parts = chunk.parts
+
+        parts.shift while parts.first == "()" # the parser adds this sometimes
+        parts.shift # remove the first part, since it's the same as the code
+
+        details = []
+
+        if parts.size > 0
+          parts.each do |part|
+            begin
+              value = eval(part, chunk.block.binding)
+              unless part == value.inspect # this skips literals or tautologies
+                if part =~ /\n/m
+                  part.gsub!(/\n/, newline(2))
+                  part += newline(3)
+                end
+                value = pretty_value(value, (4 + part.length + 4))
+                if Wrong.config[:color]
+                  part = part.color(:blue)
+                  value = value.color(:magenta)
+                end
+                details << indent(4, part, " is ", value)
+              end
+            rescue Exception => e
+              raises = "raises #{e.class}"
+              if Wrong.config[:color]
+                part = part.color(:blue)
+                raises = raises.bold.color(:red)
+              end
+              formatted_exeption = if e.message and e.message != e.class.to_s
+                                     indent(4, part, " ", raises, ": ", indent_all(6, e.message))
+                                   else
+                                     indent(4, part, " ", raises)
+                                   end
+              details << formatted_exeption
+            end
+          end
+        end
+
+        details.uniq!
+        if details.empty?
+          ""
+        else
+          "\n" + details.join("\n") + "\n"
+        end
+      end
+
+    end
+
+    # todo: use awesome_print
+    def pretty_value(value, starting_col = 0, indent_wrapped_lines = 6, width = Terminal.width)
+      # inspected = value.inspect
+
+      # note that if the first line overflows due to the starting column then pp won't wrap it right
+      inspected = PP.pp(value, "", width - starting_col).chomp
+
+      # this bit might be redundant with the pp call now
+      indented = indent_all(6, inspected)
+      if width
+        wrap_and_indent(indented, starting_col, indent_wrapped_lines, width)
+      else
+        indented
+      end
+    end
+
     protected
     def code
       @code ||= chunk.code
@@ -98,5 +169,36 @@ module Wrong
       end
     end
 
+    def indent(indent, *s)
+      "#{" " * indent}#{s.join('')}"
+    end
+
+    def newline(indent)
+      "\n" + self.indent(indent)
+    end
+
+    def indent_all(amount, s)
+      s.gsub("\n", "\n#{indent(amount)}")
+    end
+
+    def wrap_and_indent(indented, starting_col, indent_wrapped_lines, full_width)
+      first_line = true
+      width = full_width - starting_col # the first line is essentially shorter
+      indented.split("\n").map do |line|
+        s = ""
+        while line.length > width
+          s << line[0...width]
+          s << newline(indent_wrapped_lines)
+          line = line[width..-1]
+          if first_line
+            width += starting_col - indent_wrapped_lines
+            first_line = false
+          end
+        end
+        s << line
+        s
+      end.join("\n")
+    end
+
   end
 end