seeing_is_believing 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae473580cc4e716bb259237bd9a3f9f0e3983591
-  data.tar.gz: ac008a8042513f1facb360b0056c68f62abc29bb
+  metadata.gz: c9dd0b2eff60a43943a68255a2278300ad4d687d
+  data.tar.gz: c85b26392092e308c2a2dc0fdbaf41371da88a8c
 SHA512:
-  metadata.gz: c1d3d802588b733162f26ef0a55985b9dd1987759f96f45e6af5de45ba531654fb6e92a2db8c6498ce4fc6a8ed0dee44bbc9bbac0d3d01e98b698e903484d186
-  data.tar.gz: 7268519db2a550356f6ca29044ac68177678dd6509f9bcdcd6f24c23676eae14d79167b8a88ee5cb3aa84ce0e76d6ae87259127c4390863863c5ae442af2845d
+  metadata.gz: 21a4e75fa8f2191b74c4305e879f5e53ad67680c3091089a83d0af64cfecc687ef86e1ebd76341717710d18e9c2d57479f0b11017f28cd8cf42da60d4092ecff
+  data.tar.gz: 2afc31b2a89c7f6d0a4ee544b8eb8acdcfceef34c4ae6fce57a0c46f30d2501117fa45628f2100849332715f80bd85d3927bbc4cfab81d34093ad9d67ee98eaf

data/Gemfile

@@ -1,3 +1,2 @@
 source 'http://rubygems.org'
 gemspec
-gem 'pry'

data/features/flags.feature

@@ -528,3 +528,42 @@ Feature: Using flags
     Then the exit status is 0
     And stderr is empty
     And stdout is "1  # => 1"
+
+  Scenario: --interline-align and --no-interline-align determine whether adjacent lines with the same number of results get lined up, it defaults to --align
+    Given the file "interline_alignment.rb":
+    """
+    3.times do |num|
+      num
+        .to_s
+    end
+    """
+    When I run "seeing_is_believing interline_alignment.rb"
+    Then stderr is empty
+    And  the exit status is 0
+    And  stdout is:
+    """
+    3.times do |num|  # => 3
+      num             # => 0,   1,   2
+        .to_s         # => "0", "1", "2"
+    end               # => 3
+    """
+    When I run "seeing_is_believing --interline-align interline_alignment.rb"
+    Then stderr is empty
+    And  the exit status is 0
+    And  stdout is:
+    """
+    3.times do |num|  # => 3
+      num             # => 0,   1,   2
+        .to_s         # => "0", "1", "2"
+    end               # => 3
+    """
+    When I run "seeing_is_believing --no-interline-align interline_alignment.rb"
+    Then stderr is empty
+    And  the exit status is 0
+    And  stdout is:
+    """
+    3.times do |num|  # => 3
+      num             # => 0, 1, 2
+        .to_s         # => "0", "1", "2"
+    end               # => 3
+    """

data/features/regression.feature

@@ -503,3 +503,157 @@ Feature:
     __END__
     """
 
+  @not-implemented
+  Scenario: Interpolating in a heredoc and walking backwards with xmpfilter style to figure out which expression to record (#83)
+    Given the file "heredoc_woes.rb":
+    """
+    <<-HERE # =>
+    1#{1+1}3
+    HERE
+    # =>
+    """
+    When I run "seeing_is_believing -x heredoc_woes.rb"
+    Then stdout is:
+    """
+    <<-HERE # => "123\n"
+    1#{1+1}3
+    HERE
+    # => "123\n"
+    """
+
+  Scenario: Executing correctly in a hostile world
+    Given the file "hostile_world.rb":
+    """
+    # SiB works, but Ruby will explode while trying to make the exception
+    # if we do it later, so we'll make it up here
+    zde = (1/0 rescue $!)
+
+    if RUBY_VERSION != "2.0.0" # this breaks Ruby itself on v2.0.0
+      class Hash
+        undef []
+        undef []=
+        undef fetch
+      end
+    end
+    class IO
+      undef sync
+      undef <<
+      undef flush
+      undef puts
+      undef close
+    end
+    class Queue
+      undef <<
+      undef shift
+      undef clear
+    end
+    class Symbol
+      undef ==
+      undef to_s
+      undef inspect
+    end
+    class String
+      undef ==
+      undef to_s
+      undef to_str
+      undef inspect
+      undef to_i
+    end
+    class Fixnum
+      undef <
+      undef <<
+      undef ==
+      def next # "redefining instead of undefing b/c it comes from Integer"
+      end
+      undef to_s
+      undef inspect
+    end
+    class Array
+      undef pack
+      undef <<
+      undef to_ary
+      undef grep
+      undef first
+      undef []
+      undef []=
+      undef each
+      undef map
+      undef join
+      undef size
+      undef to_s
+    end
+    class << Marshal
+      undef dump
+      undef load
+    end
+    module Kernel
+      undef kind_of?
+      undef block_given?
+    end
+    module Enumerable
+      undef map
+    end
+    class SystemExit
+      undef status
+    end
+    class Exception
+      undef message
+      # undef backtrace # https://bugs.ruby-lang.org/issues/12925
+      def class
+        "totally the wrong thing"
+      end
+    end
+    class << Thread
+      undef new
+      undef current
+    end
+    class Thread
+      undef join
+      undef abort_on_exception
+    end
+    class Class
+      undef new
+      undef allocate
+      undef singleton_class
+      undef class_eval
+    end
+    class BasicObject
+      undef initialize
+    end
+    class Module
+      undef ===
+      undef define_method
+      undef instance_method
+    end
+    class UnboundMethod
+      undef bind
+    end
+    class Method
+      undef call
+    end
+    class Proc
+      undef call
+      undef to_proc
+    end
+    class NilClass
+      undef to_s
+    end
+
+    # ---
+
+    class Zomg
+    end
+
+    Zomg                       # =>
+    class << Zomg
+      attr_accessor :inspect
+    end
+    Zomg.inspect = "lolol"
+    Zomg                       # =>
+    raise zde
+    """
+    When I run "seeing_is_believing -x hostile_world.rb"
+    Then stdout includes 'Zomg                       # => Zomg'
+    And  stdout includes 'Zomg                       # => lolol'
+    And  stdout includes '# ~> ZeroDivisionError'
+    And  stdout includes '# ~> divided by 0'

data/features/xmpfilter-style.feature

@@ -72,6 +72,24 @@ Feature: Xmpfilter style
     #     :wibble=>{:magic_word=>"xyzzy"}}
     """
 
+  Scenario: --xmpfilter-style, when displayed on the next line, prints the string across multiple lines
+    Given the file "xmpfilter-prev-line-is-multiline-string.rb":
+    """
+    "0123456789\nabcdefghij\n0123456789\n0123456789\n0123456789\n0123456789\n" # =>
+    # =>
+    """
+    When I run "seeing_is_believing --xmpfilter-style xmpfilter-prev-line-is-multiline-string.rb"
+    Then stdout is:
+    """
+    "0123456789\nabcdefghij\n0123456789\n0123456789\n0123456789\n0123456789\n" # => "0123456789\nabcdefghij\n0123456789\n0123456789\n0123456789\n0123456789\n"
+    # => "0123456789\n" +
+    #    "abcdefghij\n" +
+    #    "0123456789\n" +
+    #    "0123456789\n" +
+    #    "0123456789\n" +
+    #    "0123456789\n"
+    """
+
   Scenario: --xmpfilter-style overrides previous multiline results
     Given the file "xmpfilter-prev-line2.rb":
     """
@@ -410,3 +428,42 @@ Feature: Xmpfilter style
     # ~>
     # ~> xm...
     """
+
+  Scenario: --interline-align and --no-interline-align determine whether adjacent lines with the same number of results get lined up, it defaults to --align
+    Given the file "xmpfilter_interline_alignment.rb":
+    """
+    3.times do |num|
+      num     # =>
+        .to_s # =>
+    end
+    """
+    When I run "seeing_is_believing -x xmpfilter_interline_alignment.rb"
+    Then stderr is empty
+    And  the exit status is 0
+    And  stdout is:
+    """
+    3.times do |num|
+      num     # => 0,   1,   2
+        .to_s # => "0", "1", "2"
+    end
+    """
+    When I run "seeing_is_believing -x --interline-align xmpfilter_interline_alignment.rb"
+    Then stderr is empty
+    And  the exit status is 0
+    And  stdout is:
+    """
+    3.times do |num|
+      num     # => 0,   1,   2
+        .to_s # => "0", "1", "2"
+    end
+    """
+    When I run "seeing_is_believing -x --no-interline-align xmpfilter_interline_alignment.rb"
+    Then stderr is empty
+    And  the exit status is 0
+    And  stdout is:
+    """
+    3.times do |num|
+      num     # => 0, 1, 2
+        .to_s # => "0", "1", "2"
+    end
+    """

data/lib/seeing_is_believing/binary/annotate_every_line.rb

@@ -1,3 +1,5 @@
+require 'seeing_is_believing/binary/interline_align'
+
 class SeeingIsBelieving
   module Binary
     class AnnotateEveryLine
@@ -6,9 +8,10 @@ class SeeingIsBelieving
       end
 
       def initialize(body, results, options={})
-        @options = options
-        @body    = body
-        @results = results
+        @options         = options
+        @body            = body
+        @results         = results
+        @interline_align = InterlineAlign.new(results)
       end
 
       def call
@@ -26,7 +29,11 @@ class SeeingIsBelieving
               result = sprintf "%s: %s", @results.exception.class_name, @results.exception.message.gsub("\n", '\n')
               FormatComment.call(line.size, exception_text, result, options)
             elsif @results[line_number].any?
-              result  = @results[line_number].map { |result| result.gsub "\n", '\n' }.join(', ')
+              if @options[:interline_align]
+                result = @interline_align.call line_number, @results[line_number].map { |result| result.gsub "\n", '\n' }
+              else
+                result = @results[line_number].map { |result| result.gsub "\n", '\n' }.join(', ')
+              end
               FormatComment.call(line.size, value_text, result, options)
             else
               ''

data/lib/seeing_is_believing/binary/annotate_marked_lines.rb

@@ -82,9 +82,10 @@ class SeeingIsBelieving
       end
 
       def initialize(body, results, options={})
-        @options = options
-        @body    = body
-        @results = results
+        @options         = options
+        @body            = body
+        @results         = results
+        @interline_align = InterlineAlign.new(results)
       end
 
       # seems like maybe this should respect the alignment strategy (not what xmpfilter does, but there are other ways I'd like to deviate anyway)
@@ -114,8 +115,13 @@ class SeeingIsBelieving
               whitespace = " " if whitespace.empty?
               [whitespace, FormatComment.call(0, exception_prefix, exception_result, @options)]
             elsif normal_annotation
-              annotation = @results[comment.line_number].map { |result| result.gsub "\n", '\n' }.join(', ')
-              [comment.whitespace, FormatComment.call(comment.text_col, value_prefix, annotation, @options)]
+              if @options[:interline_align]
+                annotation = @interline_align.call comment.line_number, @results[comment.line_number].map { |result| result.gsub "\n", '\n' }
+                [comment.whitespace, FormatComment.call(comment.text_col, value_prefix, annotation, @options)]
+              else
+                annotation = @results[comment.line_number].map { |result| result.gsub "\n", '\n' }.join(', ')
+                [comment.whitespace, FormatComment.call(comment.text_col, value_prefix, annotation, @options)]
+              end
             elsif pp_annotation
               result     = @results[pp_map[comment.line_number], :pp]
               annotation = result.map { |result| result.chomp }.join("\n,") # ["1\n2", "1\n2", ...

data/lib/seeing_is_believing/binary/config.rb

@@ -102,6 +102,7 @@ class SeeingIsBelieving
             self.lib_options.rewrite_code  = AnnotateMarkedLines.code_rewriter(markers)
             self.remove_value_prefixes     = false
             self.lib_options.require_files << 'pp'
+            self.lib_options.require_files << 'seeing_is_believing/customize_pp'
 
           when '-i', '--inherit-exitstatus', '--inherit-exit-status'
             self.inherit_exitstatus = true
@@ -186,6 +187,12 @@ class SeeingIsBelieving
               end
             end
 
+          when '--interline-align'
+            self.annotator_options.interline_align = true
+
+          when '--no-interline-align'
+            self.annotator_options.interline_align = false
+
           when '--shebang'
             executable = args.shift
             if executable
@@ -301,6 +308,8 @@ Options:
                                    chunk (DEFAULT) =>  each chunk of code is at the same alignment
                                    file            =>  the entire file is at the same alignment
                                    line            =>  each line is at its own alignment
+       --[no-]-interline-align   # align results on adjacent lines when they have the same number of results
+                                   defautls to --align
   -t,  --timeout-seconds s       # how long to evaluate the source file before timing out
                                    0 means it will never timeout (this is the default)
                                    accepts floating point values (e.g. 0.5 would timeout after half a second)

data/lib/seeing_is_believing/binary/data_structures.rb

@@ -39,6 +39,7 @@ class SeeingIsBelieving
       attribute(:markers)            { Markers.new }
       attribute(:max_line_length)    { Float::INFINITY }
       attribute(:max_result_length)  { Float::INFINITY }
+      predicate(:interline_align)    { true }
     end
 
 

data/lib/seeing_is_believing/binary/interline_align.rb

@@ -0,0 +1,57 @@
+class SeeingIsBelieving
+  module Binary
+    class InterlineAlign
+      def initialize(results)
+        @results        = results
+        @format_strings = {}
+      end
+
+      def call(lineno, results)
+        format_string_for_line(lineno) % results
+      end
+
+      private
+
+      attr_accessor :results
+
+      def format_string_for_line(lineno)
+        group = groups_with_same_number_of_results(@results)[lineno]
+        format_string_for(results, group, lineno)
+      end
+
+      def groups_with_same_number_of_results(results)
+        @grouped_by_no_results ||= begin
+          length = 0
+          groups = 1.upto(results.num_lines)
+                    .slice_before { |num|
+                      new_length = results[num].length
+                      slice      = length != new_length
+                      length     = new_length
+                      slice
+                    }.to_a
+
+          groups.each_with_object Hash.new do |group, lineno_to_group|
+            group.each { |lineno| lineno_to_group[lineno] = group }
+          end
+        end
+      end
+
+      def format_string_for(results, group, lineno)
+        @format_strings[lineno] ||= begin
+          index = group.index lineno
+          group
+            .map { |lineno| results[lineno] }
+            .transpose
+            .map { |col|
+              lengths = col.map(&:length)
+              max     = lengths.max
+              crnt    = lengths[index]
+              "%-#{crnt}s,#{" "*(max-crnt)} "
+            }
+            .join
+            .sub(/, *$/, "")
+        end
+      end
+    end
+  end
+end