seeing_is_believing 3.0.0.beta.4 → 3.0.0.beta.5

data/features/flags.feature

@@ -85,21 +85,21 @@ Feature: Using flags
     Then stdout is "12345"
 
 
-  Scenario: --number-of-captures determines how many times a line will be recorded
-    Given the file "number_of_captures.rb":
+  Scenario: --max-line-captures determines how many times a line will be recorded
+    Given the file "max_line_captures.rb":
     """
     5.times do |i|
       i
     end
     """
-    When I run "seeing_is_believing --number-of-captures 4 number_of_captures.rb"
+    When I run "seeing_is_believing --max-line-captures 4 max_line_captures.rb"
     Then stdout is:
     """
     5.times do |i|  # => 5
       i             # => 0, 1, 2, 3, ...
     end             # => 5
     """
-    When I run "seeing_is_believing --number-of-captures 5 number_of_captures.rb"
+    When I run "seeing_is_believing --max-line-captures 5 max_line_captures.rb"
     Then stdout is:
     """
     5.times do |i|  # => 5
@@ -251,17 +251,17 @@ Feature: Using flags
     And stdout includes "Examples:"
 
 
-  Scenario: --timeout
+  Scenario: --timeout-seconds
     Given the file "will_timeout.rb" "sleep 1"
-    When I run "seeing_is_believing --timeout 0.1 will_timeout.rb"
+    When I run "seeing_is_believing --timeout-seconds 0.1 will_timeout.rb"
     Then stdout is empty
     And the exit status is 2
     And stderr is "Timeout Error after 0.1 seconds!"
 
 
-  Scenario: --timeout
+  Scenario: --timeout-seconds
     Given the file "will_not_timeout.rb" "1 + 1"
-    When I run "seeing_is_believing --timeout 1.0 will_not_timeout.rb"
+    When I run "seeing_is_believing --timeout-seconds 1.0 will_not_timeout.rb"
     Then stderr is empty
     And the exit status is 0
     And stdout is "1 + 1  # => 2"
@@ -367,28 +367,60 @@ Feature: Using flags
     """
 
 
-  Scenario: --inherit-exit-status
-    Given the file "exit_status.rb" "exit 123"
-    When I run "seeing_is_believing exit_status.rb"
+  Scenario: --inherit-exitstatus causes SiB to exit with the status of the evaluated file
+    Given the file "exitstatus.rb" "exit 123"
+
+    When I run "seeing_is_believing exitstatus.rb"
     Then the exit status is 1
-    When I run "seeing_is_believing --inherit-exit-status exit_status.rb"
+    And  stderr is empty
+    And stdout is "exit 123"
+
+    When I run "seeing_is_believing -i exitstatus.rb"
     Then the exit status is 123
+    And  stderr is empty
+    And stdout is "exit 123"
+
+
+  Scenario: --inherit-exitstatus works with exit!
+    Given the file "exit_bang.rb":
+    """
+    :hello
+    exit! 100
+    """
+
+    When I run "seeing_is_believing exit_bang.rb"
+    Then stderr is empty
+    And the exit status is 1
+    And stdout is:
+    """
+    :hello     # => :hello
+    exit! 100
+    """
+
+    When I run "seeing_is_believing -i exit_bang.rb"
+    Then stderr is empty
+    And the exit status is 100
+    And stdout is:
+    """
+    :hello     # => :hello
+    exit! 100
+    """
 
 
-  # Show that Ruby exceptions exit with 1, and --inherit-exit-status does as well
-  Scenario: --inherit-exit-status
-    Given the file "exception_exit_status.rb" "raise Exception"
-    When I run "ruby exception_exit_status.rb"
+  # Show that Ruby exceptions exit with 1, and --inherit-exitstatus does as well
+  Scenario: --inherit-exitstatus
+    Given the file "exception_exitstatus.rb" "raise Exception"
+    When I run "ruby exception_exitstatus.rb"
     Then the exit status is 1
-    When I run "seeing_is_believing --inherit-exit-status exception_exit_status.rb"
+    When I run "seeing_is_believing -i exception_exitstatus.rb"
     Then the exit status is 1
 
 
-  Scenario: --inherit-exit-status in an at_exit block
-    Given the file "exit_status_in_at_exit_block.rb" "at_exit { exit 10 }"
-    When I run "seeing_is_believing exit_status_in_at_exit_block.rb"
+  Scenario: --inherit-exitstatus in an at_exit block
+    Given the file "exitstatus_in_at_exit_block.rb" "at_exit { exit 10 }"
+    When I run "seeing_is_believing exitstatus_in_at_exit_block.rb"
     Then the exit status is 1
-    When I run "seeing_is_believing --inherit-exit-status exit_status_in_at_exit_block.rb"
+    When I run "seeing_is_believing -i exitstatus_in_at_exit_block.rb"
     Then the exit status is 10
 
 
@@ -400,14 +432,13 @@ Feature: Using flags
     2
     """
     When I run "seeing_is_believing --debug simple_program.rb"
-    Then stderr is empty
+    Then stdout is empty
     And the exit status is 0
-    And stdout includes "TRANSLATED PROGRAM:"
-    And stdout includes "$SiB"
-    And stdout includes "RESULT:"
-    And stdout includes "@results="
-    And stdout includes "OUTPUT:"
-    And stdout includes:
+    And stderr includes "REWRITTEN PROGRAM:"
+    And stderr includes "$SiB"
+    And stderr includes "EVENTS:"
+    And stderr includes "OUTPUT:"
+    And stderr includes:
     """
     # encoding: utf-8
     1# 123
@@ -445,7 +476,36 @@ Feature: Using flags
         },
         "stdout": "b\n",
         "stderr": "c\n",
-        "exit_status": 1
+        "exitstatus": 1
       }
     """
 
+  Scenario: --stream prints events from the event stream as they are seen
+    Given the file "record_event_stream.rb" "3.times { |i| p i }"
+    When I run "seeing_is_believing record_event_stream.rb --stream"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout includes:
+    """
+    ["stdout",{"value":"0\n"}]
+    """
+    And stdout includes:
+    """
+    ["exitstatus",{"value":0}]
+    """
+    And stdout includes:
+    """
+    ["max_line_captures",{"value":-1,"is_infinity":true}]
+    """
+
+  Scenario: --stream respects the exit status
+    When I run "seeing_is_believing -ie 'exit 12' --stream"
+    Then stderr is empty
+    And the exit status is 12
+
+  Scenario: --stream sees leading data even with a hostile BEGIN block.
+    When I run "seeing_is_believing -e 'BEGIN { exit! }' --stream"
+    Then stdout includes:
+    """
+    ["sib_version",{"value":"{{SeeingIsBelieving::VERSION}}"}]
+    """

data/features/regression.feature

@@ -184,7 +184,7 @@ Feature:
     """
     class CreditCard
 
-    end
+    end  # => nil
 
     describe CreditCard do  # ~> NoMethodError: undefined method `describe' for main:Object
 
@@ -224,7 +224,7 @@ Feature:
       def inspect
         "<PROC>"   # => "<PROC>", "<PROC>", "<PROC>", "<PROC>", "<PROC>", "<PROC>", "<PROC>", "<PROC>", "<PROC>", "<PROC>", "<PROC>", "<PROC>"
       end          # => {{method_result :inspect}}
-    end
+    end            # => {{method_result :inspect}}
 
     generic_fib_gen = -> current, prev {
       -> {
@@ -290,7 +290,11 @@ Feature:
     {{'.' * 100_000}}
     """
     When I run "seeing_is_believing long_invalid_data_segment.rb"
-    Then stderr includes "1: unterminated string meets end of file"
+    Then stderr is:
+    """
+    Syntax Error: long_invalid_data_segment.rb:1
+    unterminated string meets end of file
+    """
     And the exit status is 2
     And stdout is empty
 
@@ -390,7 +394,7 @@ Feature:
     class Object
       def !(a)
       end         # => {{method_result :!}}
-    end
+    end           # => {{method_result :!}}
     """
 
 
@@ -441,22 +445,62 @@ Feature:
     Thread.new { Queue.new.shift }.join  # ~> fatal
     """
 
-  @wip
+
   Scenario: Xmpfilter does not write the error messages inside of strings
     Given the file "error_within_string.rb":
     """
-    raise(ArgumentError, "line1
-          line2")
+    1.send "a
+    b"
     """
     When I run "seeing_is_believing --xmpfilter-style error_within_string.rb"
+    Then stdout includes:
+    """
+    1.send "a
+    b"
+
+    # ~> NoMethodError
+    # ~> undefined method `a
+    # ~> b' for 1:Fixnum
+    """
+
+
+  # not going to get too detailed on what it prints, b/c that message seems pretty fragile,
+  # but just generally that it doesn't fkn blow up
+  Scenario: https://github.com/JoshCheek/seeing_is_believing/issues/46
+    Given the file "json_and_encodings.rb":
+    """
+    # encoding: utf-8
+    require 'json'
+    JSON.parse JSON.dump("√")
+    """
+    When I run "seeing_is_believing json_and_encodings.rb"
+    Then stderr is empty
+    And the exit status is 1
+    And stdout includes:
+    """
+    require 'json'             # => true
+    JSON.parse JSON.dump("√")
+    """
+
+
+  Scenario: Correctly identify end of file
+    Given the file "fake_data_segment.rb":
+    """
+    puts "output"
+    "
+    __END__
+    "
+    __END__
+    """
+    When I run "seeing_is_believing fake_data_segment.rb"
     Then stdout is:
     """
-    raise(ArgumentError, "line1
-          line2")                # ~> ArgumentError: line1\n      line2
+    puts "output"  # => nil
+    "
+    __END__
+    "              # => "\n__END__\n"
 
-    # ~> ArgumentError
-    # ~> line1
-    # ~>       line2
-    # ~>
-    # ~> f4.rb:1:in `<main>'
+    # >> output
+    __END__
     """
+

data/features/support/env.rb

@@ -27,6 +27,10 @@ Then 'stdout is exactly:' do |code|
   expect(@last_executed.stdout).to eq eval_curlies(code)
 end
 
+Then 'stdout is exactly "$code"' do |code|
+  expect(@last_executed.stdout).to eq eval_curlies(code)
+end
+
 Then 'stdout is the JSON:' do |json|
   require 'json'
   expected = JSON.parse(json)

data/features/xmpfilter-style.feature

@@ -3,13 +3,6 @@ Feature: Xmpfilter style
   Support the same (or highly similar) interface as xmpfilter,
   so that people who use that lib can easily transition to SiB.
 
-  TODO:
-  * multiple values on pp lines
-  * show that exceptions respect line-length restriction flags
-  * Scenario: pp output on line with exception
-  * when input has previously identified exception
-
-
   Scenario: --xmpfilter-style Generic updating of marked lines
     Given the file "magic_comments.rb":
     """
@@ -149,7 +142,7 @@ Feature: Xmpfilter style
     """
 
 
-  Scenario: Cleaning previous output
+  Scenario: Cleaning previous output does not clean the xmpfilter annotations
     Given the file "xmpfilter_cleaning.rb":
     """
     # commented out # => previous annotation
@@ -157,55 +150,60 @@ Feature: Xmpfilter style
     # => "1111111111...
     #    "1111111111...
     # normal comment
-    # => 123
+
+    {foo: 42, bar: {baz: 1, buz: 2, fuz: 3}, wibble: {magic_word: "xyzzy"}}
+    # => {:foo=>42,
+    #     :bar=>{:baz=>1, :buz=>2, :fuz=>3},
+    #     :wibble=>{:magic_word=>"xyzzy"}}
     """
     When I run "seeing_is_believing --xmpfilter-style --clean xmpfilter_cleaning.rb"
     Then stdout is:
     """
     # commented out # => previous annotation
-    1
+    1 # =>
+    # =>
     # normal comment
+
+    {foo: 42, bar: {baz: 1, buz: 2, fuz: 3}, wibble: {magic_word: "xyzzy"}}
+    # =>
     """
 
 
-  @wip
-  Scenario: Correctly cleans/rewrites when the First line of inspection is indented more than its children
-    Given the file "indented_inspection.rb":
+  # Not totally in love with this, but it'll do unless I can think of something better.
+  Scenario: Error raised on an annotated line preserves the annotation
+    Given the file "error_on_annotated_line.a.rb":
     """
-    obj = Object.new
-    def obj.inspect
-      " 1 \n2 2\n"
-    end
-    obj
+    "a"+1 # =>
     # =>
     """
-    When I run "seeing_is_believing -x indented_inspection.rb | seeing_is_believing -x"
-    Then stdout is:
+    When I run "seeing_is_believing --xmpfilter-style error_on_annotated_line.a.rb"
+    Then stdout includes:
     """
-    obj = Object.new
-    def obj.inspect
-      " 1 \n2 2\n"
-    end
-    obj
-    # =>  1
-    #    2 2
+    "a"+1 # => TypeError:
+    """
+    And stdout includes:
     """
+    # =>
 
-  # this one needs a bit more thought put into it, but I'm kinda fading now
-  @wip
-  Scenario: Error raised on an annotated line does not wipe it out
-    Given the file "error_on_annotated_line.rb":
+    # ~> TypeError
+    """
+    Given the file "error_on_annotated_line.b.rb":
     """
-    a # =>
+    "a"+"1" # => TypeError: no implicit conversion of Fixnum into String
+    # =>
+
+    # ~> TypeError
+    # ~> no implicit conversion of Fixnum into String
     """
-    When I run "seeing_is_believing --xmpfilter-style error_on_annotated_line.rb"
-    Then I stdout is:
+    When I run "seeing_is_believing --xmpfilter-style error_on_annotated_line.b.rb"
+    Then stdout is:
     """
-    idk, but we need to be able to fix the thing and run it again
-    without losing the annotation
+    "a"+"1" # => "a1"
+    # => "a1"
     """
 
 
+  # maybe can't fix this as it depends on the implementation of PP.pp
   @not-implemented
   Scenario: It can record values even when method is overridden
     Given the file "pretty_inspect_with_method_overridden.rb":
@@ -219,3 +217,150 @@ Feature: Xmpfilter style
     def method()end; self # => main
     # => main
     """
+
+
+  # Choosing this output style b/c it's what xmpfilter chooses,
+  # and it works conveniently with what's already in place.
+  #
+  # It looks better with the comma on the preceding line, but harder to identify the individual results.
+  #
+  # It looks better with an empty line between the results, but if the user strips trailing whitespace inbetween runs,
+  # it will confuse the annotations for normal comments.
+  #
+  # Might be cool to have it do a value comment before each result, instead of a comma.
+  # But at present, it doesn't wipe out "useless" value comments,
+  # e.g. cleaning this would leave three value markers after the hash.
+  Scenario: Multiline output that is repeatedly invoked
+    Given the file "mutltiline_output_repeatedly_invoked.rb":
+    """
+    3.times do
+      {foo: 42, bar: {baz: 1, buz: 2, fuz: 3}, wibble: {magic_word: "xyzzy"}}
+      # =>
+    end
+    """
+    When I run "seeing_is_believing -x mutltiline_output_repeatedly_invoked.rb"
+    Then stdout is:
+    """
+    3.times do
+      {foo: 42, bar: {baz: 1, buz: 2, fuz: 3}, wibble: {magic_word: "xyzzy"}}
+      # => {:foo=>42,
+      #     :bar=>{:baz=>1, :buz=>2, :fuz=>3},
+      #     :wibble=>{:magic_word=>"xyzzy"}}
+      #    ,{:foo=>42,
+      #     :bar=>{:baz=>1, :buz=>2, :fuz=>3},
+      #     :wibble=>{:magic_word=>"xyzzy"}}
+      #    ,{:foo=>42,
+      #     :bar=>{:baz=>1, :buz=>2, :fuz=>3},
+      #     :wibble=>{:magic_word=>"xyzzy"}}
+    end
+    """
+    When I run "seeing_is_believing -x mutltiline_output_repeatedly_invoked.rb | seeing_is_believing -x"
+    Then stdout is:
+    """
+    3.times do
+      {foo: 42, bar: {baz: 1, buz: 2, fuz: 3}, wibble: {magic_word: "xyzzy"}}
+      # => {:foo=>42,
+      #     :bar=>{:baz=>1, :buz=>2, :fuz=>3},
+      #     :wibble=>{:magic_word=>"xyzzy"}}
+      #    ,{:foo=>42,
+      #     :bar=>{:baz=>1, :buz=>2, :fuz=>3},
+      #     :wibble=>{:magic_word=>"xyzzy"}}
+      #    ,{:foo=>42,
+      #     :bar=>{:baz=>1, :buz=>2, :fuz=>3},
+      #     :wibble=>{:magic_word=>"xyzzy"}}
+    end
+    """
+
+
+  Scenario: Multiline values where the first line is indented more than the successive lines use a nonbreaking space
+    Given the file "inspect_tree.rb":
+    """
+    bst = Object.new
+    def bst.inspect
+      "   4\n"\
+      " 2   6\n"\
+      "1 3 5 7\n"
+    end
+    bst
+    # =>
+    """
+    When I run "seeing_is_believing --xmpfilter-style inspect_tree.rb"
+    # NOTE: The first space after the => is a nonbreaking space
+    Then stdout is:
+    """
+    bst = Object.new
+    def bst.inspect
+      "   4\n"\
+      " 2   6\n"\
+      "1 3 5 7\n"
+    end
+    bst
+    # =>    4
+    #     2   6
+    #    1 3 5 7
+    """
+
+
+  Scenario: Leading whitespace on nextline, but not multiline uses normal spaces
+    Given the file "nextline_with_leading_whitespace_but_not_multiline.rb":
+    """
+    o = Object.new
+    def o.inspect; " o" end
+    o
+    # =>
+    """
+    When I run "seeing_is_believing --xmpfilter-style nextline_with_leading_whitespace_but_not_multiline.rb"
+    Then stdout is:
+    """
+    o = Object.new
+    def o.inspect; " o" end
+    o
+    # =>  o
+    """
+
+
+
+  Scenario: Xmpfilter uses the same comment formatting as normal
+    Given the file "xmpfilter_result_lengths.rb":
+    """
+    $stdout.puts "a"*100
+    $stderr.puts "a"*100
+
+                 "a"    # =>
+                 "aa"   # =>
+                 "aaa"  # =>
+                 "aaaa" # =>
+
+    {foo: 42, bar: {baz: 1, buz: 2, fuz: 3}, wibble: {magic_word: "xyzzy"}}
+    # =>
+
+    raise "a"*100
+    """
+    When I run "seeing_is_believing -x --result-length 10 xmpfilter_result_lengths.rb"
+    Then stderr is empty
+    And stdout is:
+    """
+    $stdout.puts "a"*100
+    $stderr.puts "a"*100
+
+                 "a"    # => "a"
+                 "aa"   # => "aa"
+                 "aaa"  # => "aaa"
+                 "aaaa" # => "a...
+
+    {foo: 42, bar: {baz: 1, buz: 2, fuz: 3}, wibble: {magic_word: "xyzzy"}}
+    # => {:...
+    #     :...
+    #     :...
+
+    raise "a"*100 # ~> Ru...
+
+    # >> aa...
+
+    # !> aa...
+
+    # ~> Ru...
+    # ~> aa...
+    # ~>
+    # ~> xm...
+    """