seeing_is_believing 3.6.0 → 3.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2191c3427344ea922d31c319fe5442b7cc548d35
-  data.tar.gz: c9d3e073bbeb2d093a69ffbea07f287750b42f73
+SHA256:
+  metadata.gz: abaf2ec44d75ad4ca500c71bf90128baea06be5c0bd61fef5a0de81a402fef49
+  data.tar.gz: b487790b90fb61b27e77fee26622c8210a0b6e435c2084205bb791bcf3e28c08
 SHA512:
-  metadata.gz: bbfb8141efc9ca5a3ec5eaaae28588439b593911eb411305843d39d5b42ab0d670386c0934e95d2b709f90e2d5a80133637b7b6e2181ef37387530387b8caa31
-  data.tar.gz: 37148dff2dd6e2231a1a8be45437f41160e747eef14e52f5df2bb68258ec630ffe2345ea310b47b1b432507cf9253c9c2b7dca26d59d98f0c786df4a55087ad2
+  metadata.gz: '03996ee758737b276089eec6037a0c999678097759fc1dac9a1a338eae62327cb5d76253e0c491ae77a7e0852edb104da629e59db1c60228c43076d100ae8215'
+  data.tar.gz: 915f7e561d0bcb18f863c068e72305fa445f1b4f5f9d390843478a4ddb662cf8c38af388d5cc8da5f9ddaeeba1e569ad803c5d5c5b913d92bc6642e60155484e

data/Rakefile

@@ -1,6 +1,6 @@
 desc 'Have Bundler setup a standalone environment -- run tests in this, b/c its faster and safer'
 task :install do
-  # Running without rubygems  # http://myronmars.to/n/dev-blog/2012/03/faster-test-boot-times-with-bundler-standalone
+  # Running without rubygems http://myronmars.to/n/dev-blog/2012/03/faster-test-boot-times-with-bundler-standalone
   which("bundle")     or sh 'gem', 'install', 'bundler', '--no-ri', '--no-rdoc'
   Dir.exist? 'bundle' or sh 'bundle', 'install', '--standalone', '--binstubs', 'bundle/bin'
 end

data/features/regression.feature

@@ -834,3 +834,84 @@ Feature:
     Then stdout is "1  # => 1"
     When I run "seeing_is_believing -e '1;'"
     Then stdout is "1;  # => 1"
+
+
+  Scenario: A spy / proxy class (Issue #136)
+    Given the file "spy_class.rb":
+    """
+    class String
+      def self.===(obj)
+        true
+      end
+    end
+    class Spy < BasicObject
+      def method_missing(name, *args, &block)
+        self
+      end
+    end
+    Spy.new  # =>
+    """
+    When I run "seeing_is_believing -x spy_class.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout includes "Spy.new  # => #<Spy:"
+
+
+  Scenario: Refined inspect
+    Given the file "refined_inspect.rb":
+    """
+    module Humanize
+      refine Float do
+        def inspect
+          rounded = "%.2f" % self
+          rounded.reverse!
+          rounded.gsub! /(\d{3})/, '\1,'
+          rounded.chomp! ","
+          rounded.reverse!
+          rounded
+        end #
+      end
+    end
+    using Humanize
+    12345.6789  # =>
+    """
+    When I run "seeing_is_believing refined_inspect.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    module Humanize
+      refine Float do
+        def inspect
+          rounded = "%.2f" % self         # => "12345.68"
+          rounded.reverse!                # => "86.54321"
+          rounded.gsub! /(\d{3})/, '\1,'  # => "86.543,21"
+          rounded.chomp! ","              # => nil
+          rounded.reverse!                # => "12,345.68"
+          rounded                         # => "12,345.68"
+        end #
+      end                                 # => #<refinement:Float@Humanize>
+    end                                   # => #<refinement:Float@Humanize>
+    using Humanize                        # => main
+    12345.6789                            # => 12,345.68
+    """
+    When I run "seeing_is_believing refined_inspect.rb -x"
+    Then stderr is empty
+    And the exit status is 0
+    Then stdout is:
+    """
+    module Humanize
+      refine Float do
+        def inspect
+          rounded = "%.2f" % self
+          rounded.reverse!
+          rounded.gsub! /(\d{3})/, '\1,'
+          rounded.chomp! ","
+          rounded.reverse!
+          rounded
+        end #
+      end
+    end
+    using Humanize
+    12345.6789  # => 12,345.68
+    """

data/lib/seeing_is_believing/binary/annotate_marked_lines.rb

@@ -7,7 +7,7 @@ require 'seeing_is_believing/code'
 
 class SeeingIsBelieving
   module Binary
-    # Based on the behaviour of xmpfilger (a binary in the rcodetools gem)
+    # Based on the behaviour of xmpfilter (a binary in the rcodetools gem)
     # See https://github.com/JoshCheek/seeing_is_believing/issues/44 for more details
     class AnnotateMarkedLines
       def self.map_markers_to_linenos(program, markers)
@@ -64,7 +64,7 @@ class SeeingIsBelieving
               # 79 - "# => ".length # => 4
               # ALSO: This should be configurable, b/c otherwise you have to go into the guts of `pp`
               #       https://gist.github.com/JoshCheek/6472c8f334ae493f4ab1f7865e2470e5
-              inspect = "))"
+              inspect = ")) { |v| v.inspect }"
               pp      = ")) { |v| PP.pp v, '', 74 }"
 
               should_inspect = inspect_linenos.include? line_number

data/lib/seeing_is_believing/binary/format_comment.rb

@@ -1,3 +1,7 @@
+# Polyfill String#scrub on Ruby 2.0.0
+require 'seeing_is_believing/compatibility'
+using SeeingIsBelieving::Compatibility
+
 class SeeingIsBelieving
   module Binary
     # not sure I like this name, it formats comments that show results
@@ -64,12 +68,11 @@ class SeeingIsBelieving
       end
 
       def escape_non_printable(str, omissions)
-        str.each_char
-          .map { |char|
-            next char if 0x20 <= char.ord # above this has a printable representation
-            next char if omissions.include? char
-            char.inspect[1...-1]
-          }.join('')
+        str.scrub { |c| c.inspect[1...-1] }
+           .gsub(/[\u0000-\u0020]/) { |char|
+              next char if omissions.include? char
+              char.inspect[1...-1]
+           }
       end
     end
   end

data/lib/seeing_is_believing/compatibility.rb

@@ -0,0 +1,28 @@
+class SeeingIsBelieving
+  module Compatibility
+  end
+end
+
+# Ruby 2.0.0 is soooooo painful >.<
+# want to stop supporting this so bad!!
+is_v2_0 = !String.instance_methods.include?(:scrub)
+
+is_v2_0 && begin
+  old_verbose, $VERBOSE = $VERBOSE, nil
+  module SeeingIsBelieving::Compatibility
+    refine String do
+      def scrub(char=nil, &block)
+        char && block = lambda { |c| char }
+        each_char.inject("") do |new_str, char|
+          if char.valid_encoding?
+            new_str << char
+          else
+            new_str << block.call(char)
+          end
+        end
+      end
+    end
+  end
+ensure
+  $VERBOSE = old_verbose
+end

data/lib/seeing_is_believing/evaluate_by_moving_files.rb

@@ -39,7 +39,7 @@ class SeeingIsBelieving
       self.timeout_seconds   = options.delete(:timeout_seconds)    || 0 # 0 is the new infinity
       self.provided_input    = options.delete(:provided_input)     || String.new
       self.event_handler     = options.delete(:event_handler)      || raise(ArgumentError, "must provide an :event_handler")
-      self.load_path_flags   = (options.delete(:load_path_dirs)    || []).map { |dir| ['-I', dir] }.flatten
+      self.load_path_flags   = (options.delete(:load_path_dirs)    || []).flat_map { |dir| ['-I', dir] }
       self.require_flags     = (options.delete(:require_files)     || ['seeing_is_believing/the_matrix']).map { |filename| ['-r', filename] }.flatten
       self.max_line_captures = (options.delete(:max_line_captures) || Float::INFINITY) # (optimization: child stops producing results at this number, even though it might make more sense for the consumer to stop emitting them)
       self.local_cwd         = options.delete(:local_cwd)          || false

data/lib/seeing_is_believing/event_stream/consumer.rb

@@ -4,6 +4,10 @@ require 'seeing_is_believing/event_stream/events'
 require 'seeing_is_believing/error'
 require 'thread'
 
+# Polyfill String#scrub on Ruby 2.0.0
+require 'seeing_is_believing/compatibility'
+using SeeingIsBelieving::Compatibility
+
 class SeeingIsBelieving
   module EventStream
     class Consumer
@@ -60,15 +64,7 @@ class SeeingIsBelieving
         rescue EncodingError
           str = str.force_encoding(Encoding::UTF_8)
         end
-        return str.scrub('�') if str.respond_to? :scrub
-        # basically reimplement scrub, b/c it's not implemented on 2.0.0
-        str.each_char.inject("") do |new_str, char|
-          if char.valid_encoding?
-            new_str << char
-          else
-            new_str << '�'
-          end
-        end
+        str.scrub('�')
       end
 
       def initialize(streams)
@@ -169,51 +165,51 @@ class SeeingIsBelieving
         end
       end
 
-      def extract_token(line)
+      def shift_token(line)
         event_name = line[/[^ ]+/]
         line.sub!(/^\s*[^ ]+\s*/, '')
         event_name
       end
 
       # For a consideration of many different ways of passing the message, see 5633064
-      def extract_string(line)
-        str = Marshal.load extract_token(line).unpack('m0').first
+      def shift_string(line)
+        str = Marshal.load shift_token(line).unpack('m0').first
         Consumer.fix_encoding(str)
       end
 
       def event_for(original_line)
         line       = original_line.chomp
-        event_name = extract_token(line).intern
+        event_name = shift_token(line).intern
         case event_name
         when :result
-          line_number = extract_token(line).to_i
-          type        = extract_token(line).intern
-          inspected   = extract_string(line)
+          line_number = shift_token(line).to_i
+          type        = shift_token(line).intern
+          inspected   = shift_string(line)
           Events::LineResult.new(type: type, line_number: line_number, inspected: inspected)
         when :maxed_result
-          line_number = extract_token(line).to_i
-          type        = extract_token(line).intern
+          line_number = shift_token(line).to_i
+          type        = shift_token(line).intern
           Events::ResultsTruncated.new(type: type, line_number: line_number)
         when :exception
           Events::Exception.new \
-            line_number: extract_token(line).to_i,
-            class_name:  extract_string(line),
-            message:     extract_string(line),
-            backtrace:   extract_token(line).to_i.times.map { extract_string line }
+            line_number: shift_token(line).to_i,
+            class_name:  shift_string(line),
+            message:     shift_string(line),
+            backtrace:   shift_token(line).to_i.times.map { shift_string line }
         when :max_line_captures
-          token = extract_token(line)
+          token = shift_token(line)
           value = token =~ /infinity/i ? Float::INFINITY : token.to_i
           Events::MaxLineCaptures.new(value: value)
         when :num_lines
-          Events::NumLines.new(value: extract_token(line).to_i)
+          Events::NumLines.new(value: shift_token(line).to_i)
         when :sib_version
-          Events::SiBVersion.new(value: extract_string(line))
+          Events::SiBVersion.new(value: shift_string(line))
         when :ruby_version
-          Events::RubyVersion.new(value: extract_string(line))
+          Events::RubyVersion.new(value: shift_string(line))
         when :filename
-          Events::Filename.new(value: extract_string(line))
+          Events::Filename.new(value: shift_string(line))
         when :exec
-          Events::Exec.new(args: extract_string(line))
+          Events::Exec.new(args: shift_string(line))
         else
           raise UnknownEvent, original_line.inspect
         end

data/lib/seeing_is_believing/event_stream/producer.rb

@@ -49,9 +49,13 @@ class SeeingIsBelieving
         if count < max_line_captures
           begin
             if block_given?
-              inspected = yield(value).to_str
+              inspected = yield(value)
             else
-              inspected = value.inspect.to_str
+              inspected = value.inspect
+            end
+            unless String === inspected
+              inspected = inspected.to_str
+              raise unless String === inspected
             end
           rescue *StackErrors
             # this is necessary because SystemStackError won't show the backtrace of the method we tried to call
@@ -76,9 +80,11 @@ class SeeingIsBelieving
       # records the exception, returns the exitstatus for that exception
       def record_exception(line_number, exception)
         return exception.status if SystemExit === exception # TODO === is not in the list
-        if !line_number && filename
-          begin line_number = exception.backtrace.grep(/#{filename.to_s}/).first[/:\d+/][1..-1].to_i
-          rescue NoMethodError
+        unless line_number
+          if filename
+            begin line_number = exception.backtrace.grep(/#{filename.to_s}/).first[/:\d+/][1..-1].to_i
+            rescue NoMethodError
+            end
           end
         end
         line_number ||= -1

data/lib/seeing_is_believing/safe.rb

@@ -1,6 +1,13 @@
 # require this before anything else, b/c it expects the world to be sane when it is loaded
 class SeeingIsBelieving
   module Safe
+
+    # Subclasses must refine before superclasses in older Rubies, otherwise
+    # it finds the superclass method and behaves unexpectedly.
+    refine String.singleton_class do
+      alias === ===
+    end
+
     refine Class do
       alias === ===
     end

data/lib/seeing_is_believing/version.rb

@@ -1,3 +1,3 @@
 class SeeingIsBelieving
-  VERSION = '3.6.0'
+  VERSION = '3.6.1'
 end

data/lib/seeing_is_believing/wrap_expressions_with_inspect.rb

@@ -9,7 +9,7 @@ class SeeingIsBelieving
           "$SiB.record_result(:inspect, #{line_number}, ("
         },
         after_each:  -> line_number {
-          "))"
+          ")) { |v| v.inspect }"
         }
     end
   end

data/spec/binary/format_comment_spec.rb

@@ -60,7 +60,10 @@ RSpec.describe SeeingIsBelieving::Binary::FormatComment do
 
   def assert_printed(c, printed)
     c = c.force_encoding 'utf-8'
-    expect(result_for 0, '', c).to eq printed
+    result = result_for 0, '', c
+    expect(result).to eq printed
+    expect(result.encoding).to eq Encoding::UTF_8
+    expect(result).to be_valid_encoding
   end
 
   it 'escapes any non-printable characters' do
@@ -192,6 +195,7 @@ RSpec.describe SeeingIsBelieving::Binary::FormatComment do
     assert_printed 124.chr , "|"
     assert_printed 125.chr , "}"
     assert_printed 126.chr , "~"
+    assert_printed 127.chr, "\u007F"
   end
 
   it 'can be given a list of characters to not escape' do

data/spec/event_stream_spec.rb

@@ -437,6 +437,13 @@ module SeeingIsBelieving::EventStream
         end
       end
 
+      it 'works with objects whose boolean inquiries have been messed with (#131)' do
+        exception = begin; raise; rescue; $!; end
+        bad_bool  = Object.new
+        def bad_bool.!(*) raise; end
+        producer.record_exception bad_bool, exception # should not explode
+      end
+
       context 'recorded line number | line num is provided | it knows the file | exception comes from within file' do
         let(:exception) { begin; raise "zomg"; rescue; $!; end }
         let(:linenum)   { __LINE__ - 1 }

data/spec/seeing_is_believing_spec.rb

@@ -531,6 +531,13 @@ RSpec.describe SeeingIsBelieving do
     expect(result.exception.message).to match /recursive/i
   end
 
+  it 'does not blow up when returning an object that recursively responds to everything' do
+    result = invoke('obj = BasicObject.new
+                     def obj.method_missing(*) self; end
+                     obj')
+    expect(result[3][0]).to start_with '#<BasicObject:'
+  end
+
   it 'does not blow up when the first line looks like it might have a magic comment in it (#126)' do
     expect(values_for "1+1 # and a comment with 'Accept-Encoding: gzip' in it").to eq [['2']]
   end
@@ -547,6 +554,25 @@ RSpec.describe SeeingIsBelieving do
     expect(values_for 'o = BasicObject.new; def o.inspect; "some obj"; end; o').to eq [['some obj']]
   end
 
+  it 'sees refined inspect (#128)' do
+    result = invoke <<-RUBY
+    module BinMeUp
+      refine Fixnum do
+        def inspect
+          "%08b" % self
+        end
+      end
+    end
+    using BinMeUp
+    5
+    RUBY
+    expect(result[9]).to eq ['00000101']
+  end
+
+  it 'works when the exception does not have a backtrace (#134)' do
+
+  end
+
   it 'respects timeout, even when children do semi-ridiculous things, it cleans up children rather than orphaning them' do
     pre    = Time.now
     result = invoke <<-CHILD, timeout_seconds: 0.5
@@ -783,14 +809,18 @@ RSpec.describe SeeingIsBelieving do
                      end').stderr).to eq ''
     end
 
-    specify 'when String does not have ==, to_s, inspect, to_i' do
+    specify 'when String does not have ==, to_s, inspect, to_i, ===' do
       expect(invoke('class String
                        undef ==
                        undef to_s
                        undef to_str
                        undef inspect
                        undef to_i
-                     end').stderr).to eq ''
+                     end
+                     class << String
+                       undef ===
+                     end
+                    ').stderr).to eq ''
     end
 
     specify 'when Fixnum does not have <, <<, next, ==, inspect, to_s' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.6.1
 platform: ruby
 authors:
 - Josh Cheek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2018-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -189,6 +189,7 @@ files:
 - lib/seeing_is_believing/binary/remove_annotations.rb
 - lib/seeing_is_believing/binary/rewrite_comments.rb
 - lib/seeing_is_believing/code.rb
+- lib/seeing_is_believing/compatibility.rb
 - lib/seeing_is_believing/customize_pp.rb
 - lib/seeing_is_believing/debugger.rb
 - lib/seeing_is_believing/error.rb
@@ -287,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: seeing_is_believing
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Records results of every line of code in your file