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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 088b9ff70b1691264f78741d8a0ac2ae7b1afdff
-  data.tar.gz: e895553cdb771ebee4558794ae674be0420b3777
+  metadata.gz: 19acf5dae90b9e2cbad24fb2152392f3d22ab1f2
+  data.tar.gz: 8c9bc8df800a1289cd0997c392027351798cbee1
 SHA512:
-  metadata.gz: df2363ea76fdbfbea79b7a224873bd9beb56d2cc97bd81bf650f43adf46c22e7577715c114d2977232b35f8f47aa6d3c528b1e094ac26b2e1933115b2e9aa82a
-  data.tar.gz: d2a0cb8f4959efed7f3bfa5a47c1f7e3ac93c8d2652e4f6911b77d288b0bb02b3b20299ab589de51a4080e317213e70de697b50b04d8c3204095e3b7476902b8
+  metadata.gz: d2198f2a94a2c5a570c087d8753feec78e71b08ac1b300d8e68cb4439e73111df75e1e610899853ccf33f205fc23330c65de0c9d19fbb24b4eba844f7ba6ce29
+  data.tar.gz: 0e5842837786d01d8d141c679b877074d0c4297059d1e2d80a7fc9f5d48a9e595b5c1be1ee0f3975b6edb70ffc995f97ba1be2076ae4154352c24818896505ac

data/.travis.yml

@@ -6,11 +6,3 @@ rvm:
   - 2.1.2
   - 2.2.0
   - ruby-head
-  - rbx-2
-  - jruby-head
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-2

data/Rakefile

@@ -1,6 +1,6 @@
 desc 'run specs'
 task :spec do
-  sh 'rspec -t ~not_implemented -cf d --fail-fast'
+  sh 'rspec -cf d --fail-fast'
 end
 
 desc 'run cukes'

data/Readme.md

@@ -4,36 +4,28 @@
 Seeing Is Believing
 ===================
 
-Evaluates a file, recording the results of each line of code.
+Evaluates Ruby code, recording the results of each line.
 Integrates with any extensible editor (I've integrated it with many already, see [the list](https://github.com/JoshCheek/seeing_is_believing#editor-integration).
 
 ![example](https://s3.amazonaws.com/josh.cheek/images/scratch/sib-example1.gif)
 
 Watch a [longer video](http://vimeo.com/73866851).
 
-Works in Ruby 1.9, 2.0, 2.1, rubinius (I **think**, need to make better tests), still trying to get it working with Jruby.
+Works in Ruby 1.9, 2.0, 2.1, 2.2, rubinius (I **think**, need to make better tests), still trying to get it working with Jruby.
 
 Use The Binary
 ==============
 
-* Show every line of code (last expression)
-* Show only marked lines (xmpfilter style, except better b/c it understands expressions)
-* Clear annotations when they get in your way (even if code is invalid)
-* Smart enough to show
-  * method arguments
-  * if statement clauses
-  * values in a hash
-  * methods that are chained together across lines
-  * multiline string/symbol/regex
-
-```sh
-$ cat simple_example.rb
+`cat simple_example.rb`
+
+```ruby
 5.times do |i|
   i * 2
 end
+```
 
-
-$ seeing_is_believing simple_example.rb
+`seeing_is_believing simple_example.rb`
+```ruby
 5.times do |i|  # => 5
   i * 2         # => 0, 2, 4, 6, 8
 end             # => 5
@@ -64,7 +56,7 @@ result.exception # => nil
 Install
 =======
 
-Currently requires Ruby 1.9 or 2.0.
+Currently requires Ruby 1.9 or 2.x
 
     $ gem install seeing_is_believing
 
@@ -101,17 +93,65 @@ or current buffer contents with the output of running it through
 Known Issues
 ============
 
-* `BEGIN/END` breaks things and I probably won't ever fix it, because it's annoying and it's really meant for command-line scripts... but there is currently a spec for it.
-* `exit!` ignores callbacks that `SeeingIsBelieving` uses to communicate the results back to the main app. If you call it, `SeeingIsBelieving` will blow up. We could "fix" this by overriding it, but I feel like that would violate the meaning of `exit!`, so basically, just don't call that method.
-* The code to find the data segment is naive, and could wind up interpolating results into a string or something.
+* `begin; else; break; end` this code (an else without a resecue) will emit a warning in Ruby, and is omitted from `Parser`'s AST.
+  As such, I doubt that anyone will ever write it. But if you were to write it, it would blow up, because SiB rewrites your code, wrapping every expression that could have a value.
+  This code will be wrapped. But using the value is syntactically invalid in Ruby, because it constitutes a "void value expression" (aka a nightmare for anyone working with code).
+  I can't easily check it to seee if it's void since it's not in the parsed AST.  But it's so edge taht I don't think it's worth worrying about.
+
+Version 2
+=========
+
+Feature complete, I'll fix bugs in it until version 3 is released, though
+
+Version 3
+=========
 
-Shit that will probably never get done (or if it does, won't be until after 2.0)
-================================================================================
+These need to be done before release:
+
+* Add default to number of captures (1000), require user to explicitly set it to infinity
+* Update changelog with all changes
+* Push the event stream up to the top level so we can expose it via the interface.
+* Get it working on JRuby and Rbx
+* Order frog stickers
+* Figure out how to handle markers
+
+Version 4
+=========
 
 * How about if begin/rescue/end was able to record the result on the rescue section
-* How about if you could configure which kinds of results ou were interested in (e.g. turn on/off recording of method definitions, and other results)
-* What about recording the result of a line inside of a string interpolation, e.g. "a#{\n1\n}b" could record line 2 is 1 and line 3 is "a\n1\nb"
-* If given a file with a Unicode character, but not set Unicode, inform the user
+* How about if you could configure which kinds of results you were interested in
+  (e.g. turn on/off recording of method definitions, and other results)
+* What about recording the result of a line inside of a string interpolation,
+  e.g. "a#{\n1\n}b" could record line 2 is 1 and line 3 is "a\n1\nb"
+  This would require smarter annotators.
+* Allow debugger to take a filename (ie debug to a file insteaad of to stderr)
+* `--cd dir` cd to that dir before executing the code
+* `--cd -` cd to the dir of the file being executed before executing it
+* `--only-show-lines` output only on specified lines (doesn't change stdout/stderr/exceptions)
+* More alignment strategies e.g. `min=40` would align to 40, unless that was too short.
+  Could have fallback strategies, so e.g. `-s min=40,fallback=line`
+* Package Ruby with the editor downloads so that they don't require you to know so fkn much to set it up.
+* Allow user to set marker
+
+Inspiration
+===========
+
+* [Xmpfilter](http://www.rubydoc.info/gems/rcodetools/0.8.5.0/Rcodetools/XMPFilter), which is a part of the [rcodetools gem](https://rubygems.org/gems/rcodetools).
+* Bret Victor's completely inspiring talk [Inventing on Principle](https://www.youtube.com/watch?v=PUv66718DII).
+* My 8th Light mentor, [Doug Bradbury](http://blog.8thlight.com/doug-bradbury/archive.html) who asked me to make it for his Kids Ruby sessions (I don't think we ever finished integrating it, though >.<)
+
+Interestingly, [Swift playground](https://www.youtube.com/watch?v=oY6nQS3MiF8&t=25m51s)
+are very similar (though better integrated since they cerce you into using xcode).
+Released about a year and a half before them, but maybe I should take advantage of
+their marketing anyway: Swift Playgrounds for Ruby!! :P
+
+Shout outs
+==========
+
+* Whitequark for all the work on [Parser](http://github.com/whitequark/parser/), which dramatically dramatically improved SiB (I used to have my own horribly shitty line-based parser)
+* [Travis CI](https://travis-ci.org/JoshCheek/seeing_is_believing)... I love you times a million! So many difficult bugs have been caught by this.
+  It's so easy to work with, astoundingly convenient, helps me guarantee that SiB works on everyone else's computers, too. And it's free since SiB is open source.
+  I literally have a Travis CI sticker on my laptop, I love you that much.
 
 License
 =======

data/bin/seeing_is_believing

@@ -2,5 +2,6 @@
 
 $LOAD_PATH.unshift File.expand_path '../../lib', __FILE__
 
+gem 'parser', '~> 2.2.0.2'
 require 'seeing_is_believing/binary'
 exit SeeingIsBelieving::Binary.call(ARGV, $stdin, $stdout, $stderr)

data/features/deprecated-flags.feature

@@ -5,8 +5,68 @@ Feature: Flags that are deprecated
   As such, these flags will continue to not blow up,
   even though they won't work anymore
 
-  Scenario: --shebang
-    When I run "seeing_is_believing -e 123 --shebang not/a/thing"
+  Scenario: --shebang with errors
+    When I run "seeing_is_believing -e 123 --shebang path/to/bin"
     Then stderr is empty
     And stdout is "123  # => 123"
     And the exit status is 0
+
+  Scenario: --shebang with errors
+    When I run "seeing_is_believing not_a_file.rb --shebang path/to/bin"
+    Then stdout is empty
+    And stderr is:
+    """
+    Error: not_a_file.rb does not exist!
+    Deprecated: `--shebang path/to/bin` SiB now uses the Ruby it was invoked with
+    """
+
+  Scenario: --number-of-captures without errors
+    Given the file "number_of_captures.rb":
+    """
+    5.times do |i|
+      i
+    end
+    """
+    When I run "seeing_is_believing --number-of-captures 2 number_of_captures.rb"
+    Then stderr is empty
+    And stdout is:
+    """
+    5.times do |i|  # => 5
+      i             # => 0, 1, ...
+    end             # => 5
+    """
+    And the exit status is 0
+
+  Scenario: --shebang with errors
+    When I run "seeing_is_believing --shebang not/a/thing not_a_file.rb"
+    Then stdout is empty
+    And stderr is:
+    """
+    Error: not_a_file.rb does not exist!
+    Deprecated: `--shebang not/a/thing` SiB now uses the Ruby it was invoked with
+    """
+
+  Scenario: --number-of-captures with errors
+    When I run "seeing_is_believing not_a_file.rb --number-of-captures 2"
+    Then stdout is empty
+    And stderr is:
+    """
+    Error: not_a_file.rb does not exist!
+    Deprecated: `--number-of-captures 2` use --max-line-captures instead
+    """
+
+  Scenario: --inherit-exit-status without errors
+    Given the file "deprecated_inherit_exit_status.rb" "exit 123"
+    When I run "seeing_is_believing deprecated_inherit_exit_status.rb --inherit-exit-status"
+    Then stdout is "exit 123"
+    And stderr is empty
+    And the exit status is 123
+
+  Scenario: --inherit-exit-status with errors
+    When I run "seeing_is_believing not_a_file.rb --inherit-exit-status"
+    Then stdout is empty
+    And stderr is:
+    """
+    Error: not_a_file.rb does not exist!
+    Deprecated: `--inherit-exit-status` Dash has been removed for consistency, use --inherit-exitstatus
+    """

data/features/errors.feature

@@ -51,29 +51,34 @@ Feature: Running the binary unsuccessfully
   Scenario: Syntactically invalid file
     Given the file "invalid_syntax.rb":
     """
-    'abc
+    'this is valid'
+    'this is not
     """
     When I run "seeing_is_believing invalid_syntax.rb"
-    Then stderr includes "1: unterminated string meets end of file"
+    Then stderr is:
+    """
+    Syntax Error: invalid_syntax.rb:2
+    unterminated string meets end of file
+    """
     And the exit status is 2
     And stdout is empty
 
   Scenario: Passing a nonexistent file
     When I run "seeing_is_believing this_file_does_not_exist.rb"
-    Then stderr is "this_file_does_not_exist.rb does not exist!"
+    Then stderr is "Error: this_file_does_not_exist.rb does not exist!"
     And the exit status is 2
     And stdout is empty
 
   Scenario: Passing unknown options
     Given the file "some_file" "1"
     When I run "seeing_is_believing --unknown-option"
-    Then stderr is 'Unknown option: "--unknown-option"'
+    Then stderr is 'Error: --unknown-option is not an option, see the help screen (-h) for a list of options'
     And the exit status is 2
     And stdout is empty
 
-  Scenario: Passing an unknown option with a value but forgetting the filename
-    When I run "seeing_is_believing --unknown-option some-value"
-    Then stderr is 'Unknown option: "--unknown-option"'
+  Scenario: Reports deprecations with errors
+    When I run "seeing_is_believing this_file_does_not_exist.rb --number-of-captures 10"
+    Then stderr includes "--number-of-captures 10"
     And the exit status is 2
     And stdout is empty
 

data/features/examples.feature

@@ -105,7 +105,7 @@ Feature: Running the binary successfully
       def name
         @name   # => "Josh", "Rick"
       end       # => {{method_result :name}}
-    end
+    end         # => {{method_result :name}}
 
     User.new("Josh").name  # => "Josh"
     User.new("Rick").name  # => "Rick"
@@ -163,11 +163,13 @@ Feature: Running the binary successfully
     # !> goodbye
     """
 
-  Scenario: Respects macros
+  Scenario: Respects macros / magic comments
     Given the file "some_dir/uses_macros.rb":
     """
+    # encoding: EUC-JP
     __FILE__
     __LINE__
+    __ENCODING__
     $stdout.puts "omg"
     $stderr.puts "hi"
     DATA.read
@@ -181,12 +183,14 @@ Feature: Running the binary successfully
     And the exit status is 0
     And stdout is:
     """
+    # encoding: EUC-JP
     __FILE__            # => "some_dir/uses_macros.rb"
-    __LINE__            # => 2
+    __LINE__            # => 3
+    __ENCODING__        # => #<Encoding:EUC-JP>
     $stdout.puts "omg"  # => nil
     $stderr.puts "hi"   # => nil
     DATA.read           # => "1\n2\n"
-    __LINE__            # => 6
+    __LINE__            # => 8
 
     # >> omg
 
@@ -218,3 +222,138 @@ Feature: Running the binary successfully
     Then stderr is empty
     And the exit status is 0
     And stdout is "1 + 1  # => 2"
+
+  Scenario: Can exec another process, it records as many lines get exec'd, passes file descriptors, records exec'd output data
+    Given the stdin content "pass this through"
+    And the file "calls_exec.rb":
+    """
+    $stdout.puts "First program to stdout"
+    $stderr.puts "First program to stderr"
+    exec 'ruby', '-e', '
+      $stdout.puts "Stdin passed to second program: #{gets.inspect}"
+      $stderr.puts "Exec\'d file to stderr"
+      $stdout.flush
+      exec "ruby", "-v"
+    '
+    """
+    When I run "seeing_is_believing calls_exec.rb"
+    Then stderr is empty
+    And stdout is:
+    """
+    $stdout.puts "First program to stdout"  # => nil
+    $stderr.puts "First program to stderr"  # => nil
+    exec 'ruby', '-e', '
+      $stdout.puts "Stdin passed to second program: #{gets.inspect}"
+      $stderr.puts "Exec\'d file to stderr"
+      $stdout.flush
+      exec "ruby", "-v"
+    '
+
+    # >> First program to stdout
+    # >> Stdin passed to second program: "pass this through"
+    # >> {{`ruby -v`.chomp}}
+
+    # !> First program to stderr
+    # !> Exec'd file to stderr
+    """
+    And the exit status is 0
+
+
+  Scenario: Implicit regexp conditional
+    Given the stdin content "abc"
+    And the file "implicit_regex_conditional.rb":
+    """
+    gets
+    if /(.)c/
+      $1
+    end
+    """
+    When I run "seeing_is_believing implicit_regex_conditional.rb"
+    Then stdout is:
+    """
+    gets       # => "abc"
+    if /(.)c/  # => 1
+      $1       # => "b"
+    end        # => "b"
+    """
+
+
+  Scenario: BEGIN and END blocks
+    Given the file "BEGIN_and_END.rb":
+    """
+    # encoding: utf-8
+    p [:a, __LINE__]
+    BEGIN {
+      p [:b, __LINE__]
+      BEGIN { p [:c, __LINE__] }
+    }
+    p [:d, __LINE__]
+    END {
+      p [:e, __LINE__]
+    }
+    p [:f, __LINE__]
+    BEGIN { p [:g, __LINE__] }
+    END { p [:h, __LINE__] }
+    p [:i, __LINE__]
+    "π"
+    """
+    When I run "seeing_is_believing BEGIN_and_END.rb"
+    Then stderr is empty
+    Then stdout is:
+    """
+    # encoding: utf-8
+    p [:a, __LINE__]              # => [:a, 2]
+    BEGIN {
+      p [:b, __LINE__]            # => [:b, 4]
+      BEGIN { p [:c, __LINE__] }  # => [:c, 5]
+    }
+    p [:d, __LINE__]              # => [:d, 7]
+    END {
+      p [:e, __LINE__]            # => [:e, 9]
+    }
+    p [:f, __LINE__]              # => [:f, 11]
+    BEGIN { p [:g, __LINE__] }    # => [:g, 12]
+    END { p [:h, __LINE__] }      # => [:h, 13]
+    p [:i, __LINE__]              # => [:i, 14]
+    "π"                           # => "π"
+
+    # >> [:c, 5]
+    # >> [:b, 4]
+    # >> [:g, 12]
+    # >> [:a, 2]
+    # >> [:d, 7]
+    # >> [:f, 11]
+    # >> [:i, 14]
+    # >> [:h, 13]
+    # >> [:e, 9]
+    """
+    When I run "seeing_is_believing BEGIN_and_END.rb --xmpfilter-style"
+    Then stderr is empty
+    Then stdout is:
+    """
+    # encoding: utf-8
+    p [:a, __LINE__]
+    BEGIN {
+      p [:b, __LINE__]
+      BEGIN { p [:c, __LINE__] }
+    }
+    p [:d, __LINE__]
+    END {
+      p [:e, __LINE__]
+    }
+    p [:f, __LINE__]
+    BEGIN { p [:g, __LINE__] }
+    END { p [:h, __LINE__] }
+    p [:i, __LINE__]
+    "π"
+
+    # >> [:c, 5]
+    # >> [:b, 4]
+    # >> [:g, 12]
+    # >> [:a, 2]
+    # >> [:d, 7]
+    # >> [:f, 11]
+    # >> [:i, 14]
+    # >> [:h, 13]
+    # >> [:e, 9]
+    """