seeing_is_believing 0.0.26 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dda86a6b926231e08234e6a6a7c7fde07d650888
-  data.tar.gz: 39ab6eff76179f074c4382d5ffef3d49683bc624
+  metadata.gz: dd476d63d1de8b5fced222b2d26b906a19b4cb5f
+  data.tar.gz: ce1c44ebecbe7c565f47131a554d368299078319
 SHA512:
-  metadata.gz: c4ad0cc0e416f1c1e01b9650a6e5a2143dbeccb4c668478b179e2a3898b0b9655c5b920b334f69e7bce7d748b4204930ab9a5d376b51dc49b727399b40e6c875
-  data.tar.gz: c27f2c5220c0a9e6991384de68dc4c9e3de44f7de954356311fae9989b45d531240f40be3cb6ffca5536820967efd2123aa7353ec2f1cc474566120b634bf311
+  metadata.gz: ee60234e1717c3cde6319b2930ead345af9e94723edfef4784ee479584476041bcaf87d2c896bb247c98b48a38a05062a71767f2bb86102fedcc4d009604b1a1
+  data.tar.gz: 8839249d298c32500fab42c3501eb4dc1705981c01b05932ff12ac94ab30a7e8df5924d39e895b0d971cae19ca7c4620c0caa0ad7ec941bb780057fd4b16e445

data/Readme.md

@@ -151,8 +151,6 @@ Todo
 * Add xmpfilter option to sublime text
 * Update TextMate examples to use same keys as sublime, add xmpfilter option on cmd+opt+N
 * Move as much of the SyntaxAnalyzer as possible over to Parser and ditch Ripper altogether
-* print exceptions at the end of the file, too
-
 
 
 License

data/features/errors.feature

@@ -8,7 +8,7 @@ Feature: Running the binary unsuccessfully
   Scenario: Raising exceptions
     Given the file "raises_exception.rb":
     """
-    raise "ZOMG!"
+    raise "ZOMG\n!!!!"
     """
     And the file "requires_exception_raising_code.rb":
     """
@@ -32,10 +32,20 @@ Feature: Running the binary unsuccessfully
     end                # => nil
 
     def second_defined
-      require_relative 'raises_exception'  # ~> RuntimeError: ZOMG!
+      require_relative 'raises_exception'  # ~> RuntimeError: ZOMG\n!!!!
     end                                    # => nil
 
     first_defined
+
+    # ~> RuntimeError
+    # ~> ZOMG
+    # ~> !!!!
+    # ~>
+    # ~> {{Haiti.config.proving_grounds_dir}}/raises_exception.rb:1:in `<top (required)>'
+    # ~> requires_exception_raising_code.rb:6:in `require_relative'
+    # ~> requires_exception_raising_code.rb:6:in `second_defined'
+    # ~> requires_exception_raising_code.rb:2:in `first_defined'
+    # ~> requires_exception_raising_code.rb:9:in `<main>'
     """
 
   Scenario: Syntactically invalid file
@@ -76,7 +86,7 @@ Feature: Running the binary unsuccessfully
     When I run "seeing_is_believing stack_overflow.rb"
     Then stderr is empty
     And the exit status is 1
-    And stdout is:
+    And stdout includes:
     """
     def m() m end  # ~> SystemStackError: stack level too deep
     m

data/features/examples.feature

@@ -123,6 +123,11 @@ Feature: Running the binary successfully
     # >> some stdout output
 
     # !> some stderr output
+
+    # ~> Exception
+    # ~> message
+    # ~>
+    # ~> backtrace
     __END__
     """
     When I run "seeing_is_believing previous_output.rb"

data/features/flags.feature

@@ -2,6 +2,7 @@ Feature: Using flags
 
   Sometimes you want more control over what comes out, for that we give you flags.
 
+
   Scenario: --start-line
     Given the file "start_line.rb":
     """
@@ -33,6 +34,7 @@ Feature: Using flags
     3  # => 3
     """
 
+
   Scenario: --end-line
     Given the file "end_line.rb":
     """
@@ -64,6 +66,7 @@ Feature: Using flags
     3 + 3
     """
 
+
   Scenario: --start-line and --end-line
     Given the file "start_and_end_line.rb":
     """
@@ -99,6 +102,7 @@ Feature: Using flags
     4 + 4
     """
 
+
   Scenario: --result-length sets the length of the portion including and after the # =>
     Given the file "result_lengths.rb":
     """
@@ -129,8 +133,14 @@ Feature: Using flags
     # >> aa...
 
     # !> aa...
+
+    # ~> Ru...
+    # ~> aa...
+    # ~>
+    # ~> re...
     """
 
+
   Scenario: --line-length sets the total length of a given line
     Given the file "line_lengths.rb":
     """
@@ -157,6 +167,11 @@ Feature: Using flags
     # >> aaaaaaaaaaaaaaaaaaaaaaaa...
 
     # !> aaaaaaaaaaaaaaaaaaaaaaaa...
+
+    # ~> RuntimeError
+    # ~> aaaaaaaaaaaaaaaaaaaaaaaa...
+    # ~>
+    # ~> line_lengths.rb:7:in `<m...
     """
     Given the file "line_lengths2.rb":
     """
@@ -169,6 +184,7 @@ Feature: Using flags
     When I run "seeing_is_believing --line-length 14 line_lengths2.rb"
     Then stdout is "12345"
 
+
   Scenario: --require
     Given the file "print_1.rb" "puts 1"
     Given the file "print_2.rb" "puts 2"
@@ -185,6 +201,7 @@ Feature: Using flags
     # >> 3
     """
 
+
   Scenario: --program
     When I run "seeing_is_believing --program '1'"
     Then stderr is empty
@@ -194,6 +211,7 @@ Feature: Using flags
     1  # => 1
     """
 
+
   Scenario: --load-path
     Given the file "print_1.rb" "puts 1"
     And the file "some_dir/print_2.rb" "puts 2"
@@ -211,6 +229,7 @@ Feature: Using flags
     """
     And the exit status is 0
 
+
   Scenario: --encoding
     Given the file "utf-8.rb" "'ç'"
     When I run "seeing_is_believing --encoding u utf-8.rb"
@@ -221,6 +240,7 @@ Feature: Using flags
     'ç'  # => "ç"
     """
 
+
   Scenario: --as and stdin
     Given the file "example.rb" "1+1"
     Given the stdin content:
@@ -237,6 +257,7 @@ Feature: Using flags
     __FILE__  # => "example.rb"
     """
 
+
   Scenario: --as and -e
     Given the file "example.rb" "1+1"
     When I run 'seeing_is_believing --as example.rb -e "__FILE__"'
@@ -244,6 +265,7 @@ Feature: Using flags
     And the exit status is 0
     And stdout is '__FILE__  # => "example.rb"'
 
+
   Scenario: --clean
     Given the file "example.rb":
     """
@@ -269,24 +291,28 @@ Feature: Using flags
     1
     """
 
+
   Scenario: --clean on an invalid file will clean
     When I run 'seeing_is_believing --clean -e "1+  # => lkj"'
     Then stderr is empty
     And the exit status is 0
     And stdout is '1+'
 
+
   Scenario: --version
     When I run 'seeing_is_believing --version'
     Then stderr is empty
     And the exit status is 0
     And stdout is '{{SeeingIsBelieving::VERSION}}'
 
+
   Scenario: --help
     When I run "seeing_is_believing --help"
     Then stderr is empty
     And the exit status is 0
     And stdout includes "Usage"
 
+
   Scenario: --timeout
     Given the file "example.rb" "sleep 1"
     When I run "seeing_is_believing --timeout 0.1 example.rb"
@@ -294,6 +320,7 @@ Feature: Using flags
     And the exit status is 2
     And stderr is "Timeout Error after 0.1 seconds!"
 
+
   Scenario: --timeout
     Given the file "example.rb" "1 + 1"
     When I run "seeing_is_believing --timeout 1.0 example.rb"
@@ -301,6 +328,7 @@ Feature: Using flags
     And the exit status is 0
     And stdout is "1 + 1  # => 2"
 
+
   Scenario: --alignment-strategy file
     Given the file "file_alignments.rb":
     """
@@ -405,6 +433,7 @@ Feature: Using flags
     When I run "seeing_is_believing --inherit-exit-status exit_status.rb"
     Then the exit status is 123
 
+
   # 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"
@@ -413,6 +442,7 @@ Feature: Using flags
     When I run "seeing_is_believing --inherit-exit-status exception_exit_status.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"
@@ -420,7 +450,7 @@ Feature: Using flags
     When I run "seeing_is_believing --inherit-exit-status exit_status_in_at_exit_block.rb"
     Then the exit status is 10
 
-  # after making this use the parser instead of regexes, add a test showing that the line `"1 # =>"` does not get updated
+
   Scenario: --xmpfilter-style
     Given the file "magic_comments.rb":
     """
@@ -449,3 +479,36 @@ Feature: Using flags
     "omg2"
     # => "omg2"
     """
+
+  Scenario: --debug
+    Given the file "simple_program.rb":
+    """
+    # encoding: utf-8
+    1# 123
+    2
+    """
+    When I run "seeing_is_believing --debug simple_program.rb"
+    Then stderr is empty
+    And the exit status is 0
+    # source without comments
+    And stdout includes "SOURCE WITHOUT COMMENTS:"
+    And stdout includes:
+    """
+    # encoding: utf-8
+    1
+    2
+    """
+    # expression evaluation
+    And stdout includes "EXPRESSION EVALUATION:"
+    And stdout includes "GENERATED"
+    # translated program
+    And stdout includes "TRANSLATED PROGRAM:"
+    And stdout includes "$seeing_is_believing_current_result"
+    # result
+    And stdout includes "RESULT:"
+    And stdout includes:
+    """
+    # encoding: utf-8
+    1# 123
+    2  # => 2
+    """

data/features/regression.feature

@@ -3,6 +3,7 @@ Feature:
   As the dev who wrote SeeingIsBelieving
   I want to have tests on those bugs that I found and could not have predicted
 
+
   Scenario: A program containing a single comment
     Given the stdin content "# single comment"
     When I run "seeing_is_believing"
@@ -10,6 +11,7 @@ Feature:
     And the exit status is 0
     And stdout is "# single comment"
 
+
   Scenario: Name error just fucks everything
     Given the file "no_method_error.rb":
     """
@@ -21,8 +23,14 @@ Feature:
     And stdout is:
     """
     a  # ~> NameError: undefined local variable or method `a' for main:Object
+
+    # ~> NameError
+    # ~> undefined local variable or method `a' for main:Object
+    # ~>
+    # ~> no_method_error.rb:1:in `<main>'
     """
 
+
   Scenario: Errors being raised in the evaluated code that don't exist in the evaluating code
     Given the file "raising_custom_errors.rb":
     """
@@ -37,6 +45,7 @@ Feature:
     Then stderr is empty
     And the exit status is 1
 
+
   Scenario: statements that inherit void value expressions
     Given the file "statements_that_inherit_void_value_expressions.rb":
     """
@@ -60,6 +69,7 @@ Feature:
     m             # => 1
     """
 
+
   Scenario: comments aren't updated with values
     Given the file "comments_arent_updated_with_values.rb":
     """
@@ -73,6 +83,7 @@ Feature:
     2 # some other comment
     """
 
+
   # NOTE: Don't change the body of this file, it's nondeterministic
   # I have no idea why this particular string fucks Parser up, but other similar ones don't
   # We can probably remove this once parser reaches 2.0.0, they've fixed this bug now.
@@ -100,3 +111,55 @@ Feature:
     2  # => 2
     __END__
     """
+
+
+  Scenario: Unintentional magic comment on not-first line
+    Given the file "wtf.rb":
+    """
+    1
+    # Transfer-Encoding: chunked
+    """
+    When I run "seeing_is_believing wtf.rb"
+    Then stdout is:
+    """
+    1  # => 1
+    # Transfer-Encoding: chunked
+    """
+
+
+  Scenario: The file contains content that looks like previous output, should not be removed
+    Given the file "not_actually_previous_output.rb":
+    """
+    "1 # => 1"
+    "2 # ~> SomeError: some message"
+
+    "# >> some stdout"
+
+    "# !> some stderr"
+    """
+    When I run "seeing_is_believing not_actually_previous_output.rb"
+    Then stdout is:
+    """
+    "1 # => 1"                        # => "1 # => 1"
+    "2 # ~> SomeError: some message"  # => "2 # ~> SomeError: some message"
+
+    "# >> some stdout"  # => "# >> some stdout"
+
+    "# !> some stderr"  # => "# !> some stderr"
+    """
+
+
+  Scenario: Multiple leading inline comments should make it through to the final program
+    Given the file "multiple_leading_comments.rb":
+    """
+    #!/usr/bin/env ruby
+    # encoding: utf-8
+    'ç'
+    """
+    When I run "seeing_is_believing multiple_leading_comments.rb"
+    Then stdout is:
+    """
+    #!/usr/bin/env ruby
+    # encoding: utf-8
+    'ç'  # => "ç"
+    """

data/lib/seeing_is_believing.rb

@@ -5,6 +5,7 @@ require 'timeout'
 require 'seeing_is_believing/queue'
 require 'seeing_is_believing/result'
 require 'seeing_is_believing/version'
+require 'seeing_is_believing/debugger'
 require 'seeing_is_believing/expression_list'
 require 'seeing_is_believing/remove_inline_comments'
 require 'seeing_is_believing/evaluate_by_moving_files'
@@ -18,9 +19,9 @@ class SeeingIsBelieving
     new(*args).call
   end
 
-  def initialize(string_or_stream, options={})
-    @string          = string_or_stream
-    @stream          = to_stream string_or_stream
+  def initialize(program, options={})
+    program_string   = RemoveInlineComments::NonLeading.call program
+    @stream          = to_stream program_string
     @matrix_filename = options[:matrix_filename]
     @filename        = options[:filename]
     @stdin           = to_stream options.fetch(:stdin, '')
@@ -29,6 +30,9 @@ class SeeingIsBelieving
     @encoding        = options.fetch :encoding, nil
     @line_number     = 1
     @timeout         = options[:timeout]
+    @debugger        = options.fetch :debugger, Debugger.new(enabled: false)
+
+    debugger.context("SOURCE WITHOUT COMMENTS") { program_string }
   end
 
   # I'd like to refactor this, but I was unsatisfied with the three different things I tried.
@@ -71,6 +75,7 @@ class SeeingIsBelieving
 
       # build the program
       program = leading_comments << record_exceptions_in(body) << data_segment
+      debugger.context("TRANSLATED PROGRAM") { program }
 
       # return the result
       result_for program, max_line_number
@@ -79,14 +84,14 @@ class SeeingIsBelieving
 
   private
 
-  attr_reader :stream, :matrix_filename
+  attr_reader :stream, :matrix_filename, :debugger
 
   def expression_list
-    @expression_list ||= ExpressionList.new get_next_line:  lambda { next_line_queue.dequeue },
+    @expression_list ||= ExpressionList.new debugger:       debugger,
+                                            get_next_line:  lambda { next_line_queue.dequeue },
                                             peek_next_line: lambda { next_line_queue.peek },
                                             on_complete:    lambda { |line, children, completions, offset|
-                                              expression = RemoveInlineComments.call \
-                                                [line, *children, *completions].map(&:chomp).join("\n")
+                                              expression = [line, *children, *completions].map(&:chomp).join("\n")
 
                                               if do_not_record? expression
                                                 expression + "\n"