power_assert 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac2d67b15f362a642ebe57434047e526ddc386dc
-  data.tar.gz: dc515760f9b1fa257188a4745a2a713d6522be6d
+  metadata.gz: 1afb2223a3e268c8295564a49a13c7feff085da7
+  data.tar.gz: d37fc4cfd92f123df5863ce90ed70e68da566a34
 SHA512:
-  metadata.gz: 956fc1290880bf653dc70c59b35216db33e8bbe09517a04639b47c1d3e81c642fe682d829e1d71ecb36fc2e3f7e3c4bb04727ffa6a1ea8814b7b4621a437dd28
-  data.tar.gz: b18c7f57d7cbe043fa4b621914a8426569f81654ccec756054d8806749f78d467d5b830776411088ea7ac839d4e09f65f9d3be31783bcd31c829f9dc647e3f18
+  metadata.gz: 72b22a8fe4dcf9905a19b22b6081af7273fdba4ddfdea9b7cca07c852ed3c6a5bfb5ab2db6042079a95e4e78f18736d0a034a7384aec170eab6ca16b32a4cfa5
+  data.tar.gz: 4946106cb77a3f81a457a8585f63e1c58ae81a2773d9065e58dce7e95b1a422cfa549668f38b4e5e5af1e2eb064b17bfa4abe63d60fe6a8d99d7abde86e7c33e

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.2
+  - 2.1
   - ruby-head

data/README.rdoc

@@ -3,7 +3,13 @@
 Power Assert for Ruby.
 
 == Related Projects
+* {test-unit}[https://github.com/test-unit/test-unit](>= 3.0.0)
 * {test-unit-power_assert}[https://github.com/k-tsj/test-unit-power_assert]
 * {minitest-power_assert}[https://github.com/hsbt/minitest-power_assert]
+* {pry-power_assert}[https://github.com/yui-knk/pry-power_assert]
+* {power_p}[https://github.com/k-tsj/power_p]
+
+== Reference
+* {Power Assert in Ruby (at RubyKaigi 2014) // Speaker Deck}[https://speakerdeck.com/k_tsj/power-assert-in-ruby]
 
 == Travis Build Status {<img src="https://secure.travis-ci.org/k-tsj/power_assert.png"/>}[http://travis-ci.org/k-tsj/power_assert]

data/lib/power_assert.rb

@@ -9,18 +9,43 @@ rescue
 end
 
 require 'power_assert/version'
-
 require 'ripper'
 
-# NB: API is not fixed
-
 module PowerAssert
+  class << self
+    def configuration
+      @configuration ||= Configuration[false]
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def start(assertion_proc, assertion_method: nil)
+      yield Context.new(assertion_proc, assertion_method)
+    end
+  end
+
+  Configuration = Struct.new(:lazy_inspection)
+  private_constant :Configuration
+
+  class InspectedValue
+    def initialize(value)
+      @value = value
+    end
+
+    def inspect
+      @value
+    end
+  end
+  private_constant :InspectedValue
+
   class Context
     Value = Struct.new(:name, :value, :column)
     Ident = Struct.new(:type, :name, :column)
 
     TARGET_CALLER_DIFF = {return: 5, c_return: 4}
-    TARGET_CALLER_INDEX = {return: 3, c_return: 2}
+    TARGET_INDEX_OFFSET = {bmethod: 3, method: 2}
 
     attr_reader :message_proc
 
@@ -36,20 +61,19 @@ module PowerAssert
       @assertion_proc = assertion_proc
       @assertion_method_name = assertion_method.to_s
       @message_proc = -> {
-        @assertion_message ||=
-          @base_caller_length > 0 ? assertion_message(@line || '',
-                                                      methods || [],
-                                                      return_values,
-                                                      refs || [],
-                                                      assertion_proc.binding).freeze :
-                                    nil
+        return nil if @base_caller_length < 0
+        @message ||= build_assertion_message(@line || '', methods || [], return_values, refs || [], assertion_proc.binding).freeze
       }
       @proc_local_variables = assertion_proc.binding.eval('local_variables').map(&:to_s)
+      target_thread = Thread.current
       @trace = TracePoint.new(:return, :c_return) do |tp|
         next if method_ids and ! method_ids.include?(tp.method_id)
         locs = tp.binding.eval('caller_locations')
-        if locs.length - @base_caller_length == TARGET_CALLER_DIFF[tp.event]
-          idx = TARGET_CALLER_INDEX[tp.event]
+        current_diff = locs.length - @base_caller_length
+        target_diff = TARGET_CALLER_DIFF[tp.event]
+        is_target_bmethod = current_diff < target_diff
+        if (is_target_bmethod or current_diff == target_diff) and Thread.current == target_thread
+          idx = target_diff - TARGET_INDEX_OFFSET[is_target_bmethod ? :bmethod : :method]
           unless path
             path = locs[idx].path
             lineno = locs[idx].lineno
@@ -59,7 +83,8 @@ module PowerAssert
             method_ids = methods.map(&:name).map(&:to_sym).uniq
           end
           if path == locs[idx].path and lineno == locs[idx].lineno
-            return_values << Value[tp.method_id.to_s, tp.return_value, nil]
+            val = PowerAssert.configuration.lazy_inspection ? tp.return_value : InspectedValue.new(tp.return_value.inspect)
+            return_values << Value[tp.method_id.to_s, val, nil]
           end
         end
       end
@@ -78,8 +103,8 @@ module PowerAssert
       end
     end
 
-    def assertion_message(line, methods, return_values, refs, proc_binding)
-      set_column(line, methods, return_values)
+    def build_assertion_message(line, methods, return_values, refs, proc_binding)
+      set_column(methods, return_values)
       ref_values = refs.map {|i| Value[i.name, proc_binding.eval(i.name), i.column] }
       vals = (return_values + ref_values).find_all(&:column).sort_by(&:column).reverse
       if vals.empty?
@@ -98,7 +123,7 @@ module PowerAssert
       ret.join("\n")
     end
 
-    def set_column(line, methods, return_values)
+    def set_column(methods, return_values)
       methods = methods.dup
       return_values.each do |val|
         idx = methods.index {|method| method.name == val.name }
@@ -125,7 +150,11 @@ module PowerAssert
       when :binary
         handle_columnless_ident(extract_idents(sexp[1]), sexp[2], extract_idents(sexp[3]))
       when :call
-        [sexp[1], sexp[3]].flat_map {|s| extract_idents(s) }
+        if sexp[3] == :call
+          handle_columnless_ident(extract_idents(sexp[1]), :call, [])
+        else
+          [sexp[1], sexp[3]].flat_map {|s| extract_idents(s) }
+        end
       when :array
         sexp[1] ? sexp[1].flat_map {|s| extract_idents(s) } : []
       when :command_call
@@ -134,7 +163,12 @@ module PowerAssert
         handle_columnless_ident(extract_idents(sexp[1]), :[], extract_idents(sexp[2]))
       when :method_add_arg
         idents = extract_idents(sexp[1])
-        idents[0..-2] + extract_idents(sexp[2]) + [idents[-1]]
+        if idents.empty?
+          # idents may be empty(e.g. ->{}.())
+          extract_idents(sexp[2])
+        else
+          idents[0..-2] + extract_idents(sexp[2]) + [idents[-1]]
+        end
       when :args_add_block
         _, (tag, ss0, *ss1), _ = sexp
         if tag == :args_add_star
@@ -192,7 +226,8 @@ module PowerAssert
     MID2SRCTXT = {
       :[] => '[',
       :+@ => '+',
-      :-@ => '-'
+      :-@ => '-',
+      :call => '('
     }
 
     def handle_columnless_ident(left_idents, mid, right_idents)
@@ -218,11 +253,6 @@ module PowerAssert
     end
   end
   private_constant :Context
-
-  def start(assertion_proc, assertion_method: nil)
-    yield Context.new(assertion_proc, assertion_method)
-  end
-  module_function :start
 end
 
 if defined? RubyVM

data/lib/power_assert/version.rb

@@ -1,3 +1,3 @@
 module PowerAssert
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/power_assert.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.email       = ['kazuki@callcc.net']
   s.homepage    = 'https://github.com/k-tsj/power_assert'
   s.summary     = %q{Power Assert for Ruby}
-  s.description = %q{Power Assert for Ruby}
+  s.description = %q{Power Assert for Ruby. Power Assert shows each value of variables and method calls in the expression. It is useful for testing, providing which value wasn't correct when the condition is not satisfied.}
 
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")

data/test/test_power_assert.rb

@@ -106,6 +106,13 @@ class TestPowerAssert < Test::Unit::TestCase
 
     [[[:method, "b", 5]],
       ':"a#{b}c"'],
+
+    # not supported
+    [[],
+      '->{}.()'],
+
+    [[[:method, "a", 0], [:method, "b", 3], [:method, "call", 2]],
+      'a.(b)'],
   ]
 
   EXTRACT_METHODS_TEST.each_with_index do |(expect, source), idx|
@@ -124,6 +131,10 @@ class TestPowerAssert < Test::Unit::TestCase
     end
   end
 
+  define_method(:bmethod) do
+    false
+  end
+
   def test_assertion_message
     a = 0
     @b = 1
@@ -214,5 +225,45 @@ END
 END
       ! a != (+a == -a)
     }
+
+    assert_equal <<END.chomp, assertion_message {
+      bmethod
+      |
+      false
+END
+      bmethod
+    }
+  end
+
+  def test_lazy_inspection
+    PowerAssert.configure do |c|
+      assert !c.lazy_inspection
+    end
+    assert_equal <<END.chomp, assertion_message {
+      'a'.sub(/./, 'b').sub!(/./, 'c')
+          |             |
+          |             "c"
+          "b"
+END
+      'a'.sub(/./, 'b').sub!(/./, 'c')
+    }
+
+    PowerAssert.configure do |c|
+      c.lazy_inspection = true
+    end
+    begin
+      assert_equal <<END.chomp, assertion_message {
+        'a'.sub(/./, 'b').sub!(/./, 'c')
+            |             |
+            |             "c"
+            "c"
+END
+        'a'.sub(/./, 'b').sub!(/./, 'c')
+      }
+    ensure
+      PowerAssert.configure do |c|
+        c.lazy_inspection = false
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_assert
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Kazuki Tsujimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-05 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -52,7 +52,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Power Assert for Ruby
+description: Power Assert for Ruby. Power Assert shows each value of variables and
+  method calls in the expression. It is useful for testing, providing which value
+  wasn't correct when the condition is not satisfied.
 email:
 - kazuki@callcc.net
 executables: []
@@ -65,6 +67,7 @@ files:
 - BSDL
 - COPYING
 - Gemfile
+- LEGAL
 - README.rdoc
 - Rakefile
 - lib/power_assert.rb