seeing_is_believing 3.3.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0c1356fef9747e418a57e2f151e4bc2f7625d6d8
-  data.tar.gz: 27c33822870a7f0bf0f25172ed626d581b1b4906
+SHA256:
+  metadata.gz: 138b4f2170848590bd310474298ed1c36861d74ae7e9e728d7d06343eaa2aa60
+  data.tar.gz: 98eeba43fe979029095e9efb5de96f33f405ec2729ffc80c5063f179aaaa6fd0
 SHA512:
-  metadata.gz: b4ba3ac50ac5ac732c097e7dcffebdcd58c7345f8f40df8b1086b33c9d9ef69b5e030ebf139401edc57e89622475eeab1c0cf2a92b966bd0671c9bad6181e144
-  data.tar.gz: 8bc5907b40214aa58377aec602033e08e47837239bed71d028e3833c4d9a75f28b59e88c55ec04f6c751e4a577695fb9175407b22340bfa3e41fcf7a5d8eb282
+  metadata.gz: 44f5ac4f46b544ed8ca22a8429aa85add4b45eb2626acd84b91f988c5d86f6ee6903791b2b5a876187ac4e8e998dd967f7c72585e842df86f513d29acbb0aae1
+  data.tar.gz: f3c96b87441107d7e5b9eef52c523a1bf8b13b20276cbcd00b1b9d4d1ec9781420b0f1c8aeb4cc40a245bb08051439c35770dcb65b8554b67b228a0db84b3115

data/.github/workflows/test.yml

@@ -0,0 +1,39 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Install binstubs (no rubygems / bundler at runtime, makes tests much much faster)
+      run: rake install
+    - name: Run rspec tests
+      run: rake spec
+    - name: Run cucumber features
+      run: rake cuke

data/{Readme.md → README.md}

@@ -1,5 +1,8 @@
-Unix/Mac: [![Unix Build Status](https://secure.travis-ci.org/JoshCheek/seeing_is_believing.svg?branch=master)](http://travis-ci.org/JoshCheek/seeing_is_believing)   
-Windows:  [![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/JoshCheek/seeing_is_believing?branch=master&svg=true)](https://ci.appveyor.com/project/JoshCheek/seeing-is-believing)
+https://github.com/JoshCheek/seeing_is_believing/workflows/Ruby/badge.svg
+
+Unix/Mac: [![Unix Build Status](https://github.com/JoshCheek/seeing_is_believing/workflows/Test/badge.svg)](https://github.com/JoshCheek/seeing_is_believing/actions?query=workflow%3ATest)
+  
+Appveyor:  [![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/JoshCheek/seeing_is_believing?branch=master&svg=true)](https://ci.appveyor.com/project/JoshCheek/seeing-is-believing)
 
 Seeing Is Believing
 ===================
@@ -8,7 +11,7 @@ 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/wiki/Editor-Integration)).
 If you like Swift Playgrounds, you'll like SiB.
 
-![example](https://s3.amazonaws.com/josh.cheek/images/scratch/sib-example1.gif)
+![example](docs/example.gif)
 
 
 Helpful links
@@ -38,10 +41,6 @@ Known Issues
 ------------
 
 * Assumes utf-8 everywhere. If this is an issue, please see the [encodings](https://github.com/JoshCheek/seeing_is_believing/wiki/Encodings) section of the wiki.
-* `begin; else; break; end` this code (an else without a rescue) 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 pointless time sink and the cause of many bugs in SiB).
-  Unfortunately, I can't easily check it to see if it's void since it's not in the parsed AST.  But it's so edge that I don't think it's worth worrying about.
 
 
 Inspiration
@@ -53,12 +52,10 @@ Inspiration
 
 
 Shout outs
-----------
+-----------
+
+* Whitequark for all the work on [Parser](http://github.com/whitequark/parser/)
 
-* 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/Rakefile

@@ -1,26 +1,13 @@
 desc 'Have Bundler setup a standalone environment -- run tests in this, b/c its faster and safer'
 task :install do
-  exe_path = which("bundle")
-  unless exe_path
-    sh 'gem', 'install', 'bundler', '--no-ri', '--no-rdoc'
-  end
-
-  unless Dir.exist? 'bundle'
-    # Running without rubygems  # http://myronmars.to/n/dev-blog/2012/03/faster-test-boot-times-with-bundler-standalone
-    sh 'bundle', 'install', '--standalone', '--binstubs', 'bundle/bin'
-  end
+  # 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
 
 desc 'Remove generated and irrelevant files'
 task :clean do
-  rm_rf [
-            'bundle',
-            '.bundle',
-            'Gemfile.lock',
-            'proving_grounds',
-            'tags',
-            *Dir['*.gem'],
-        ]
+  rm_rf %w[bundle .bundle Gemfile.lock proving_grounds tags] + Dir['*.gem']
 end
 
 directory 'bundle' do
@@ -30,11 +17,11 @@ end
 
 def require_paths
   require 'bundler'
-  requrable_paths = Bundler.load.specs.flat_map { |spec|
-    spec.require_paths.map do |path|
-      File.join(spec.full_gem_path, path)
-    end
-  }.flat_map { |p| ['-I', p] }
+  Bundler.load.specs.flat_map do |spec|
+    spec.require_paths
+        .map { |path| File.join spec.full_gem_path, path }
+        .flat_map { |p| ['-I', p] }
+  end
 end
 
 desc 'Print the require paths for arbitrary binary execution'
@@ -55,6 +42,8 @@ task cuke: :bundle do
   sh 'ruby', '--disable-gem',
      *require_paths,
      '-S', 'bundle/bin/cucumber',
+     '--quiet',     # omit stepdefs, which are usually spammy for me https://twitter.com/josh_cheek/status/1082767053071765504
+     '--fail-fast', # stop as soon as we see an error (don't waste CI time, don't make it hard to find error info later)
      '--tags', '~@not-implemented',
      '--tags', "~@not-#{RUBY_VERSION}",
      '--tags', "~@not-#{ruby_version_without_patchlevel}",
@@ -78,7 +67,7 @@ task default: [:spec, :cuke]
 desc 'Install dependencies and run tests (mainly for Travis CI)'
 task ci: [:spec, :cuke]
 
-def which(exe)
+def self.which(exe)
   dirs = ENV["PATH"].split(File::PATH_SEPARATOR)
   exts = [""]
   exts.concat(ENV["PathExt"].to_s.split(File::PATH_SEPARATOR))

data/appveyor.yml

@@ -26,4 +26,6 @@ test_script:
 
 environment:
   matrix:
-    - ruby_version: '21'
+    - ruby_version: '24'
+    - ruby_version: '25'
+    - ruby_version: '26'

data/features/flags.feature

@@ -268,7 +268,7 @@ Feature: Using flags
 
 
   Scenario: --alignment-strategy file
-    Given the file "file_alignments.rb":
+     Given the file "file_alignments.rb":
     """
     # comment
     1
@@ -600,3 +600,253 @@ Feature: Using flags
         .to_s         # => "0", "1", "2"
     end               # => 3
     """
+
+
+  Scenario: --local-cwd causes the current working directory to be the same as the file
+    Given the file "subdir/cwd_of_file_test.rb" "__FILE__"
+    When I run "seeing_is_believing subdir/cwd_of_file_test.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '__FILE__  # => "subdir/cwd_of_file_test.rb"'
+    When I run "seeing_is_believing subdir/cwd_of_file_test.rb --local-cwd"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '__FILE__  # => "cwd_of_file_test.rb"'
+
+
+  Scenario: --toggle-mark adds a mark to the line if it is unmarked and exists
+    Given the file "unmarked.rb":
+    """
+    1
+    2
+    """
+    When I run "seeing_is_believing unmarked.rb --toggle-mark 1"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '{{"1  # => \n2"}}'
+    When I run "seeing_is_believing unmarked.rb --toggle-mark 2"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '{{"1\n2  # => "}}'
+    When I run "seeing_is_believing unmarked.rb --toggle-mark 3"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '{{"1\n2"}}'
+
+
+  Scenario: --toggle-mark doesn't add a mark to the line if it has a comment or can't be commented
+    Given the file "no_toggle_line_here.rb":
+    """
+    1 # comment
+    "2
+    "
+    """
+    When I run "seeing_is_believing no_toggle_line_here.rb --toggle-mark 1"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1 # comment
+    "2
+    "
+    """
+    When I run "seeing_is_believing no_toggle_line_here.rb --toggle-mark 2"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1 # comment
+    "2
+    "
+    """
+    When I run "seeing_is_believing no_toggle_line_here.rb --toggle-mark 3"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1 # comment
+    "2
+    "  # =>{{" "}}
+    """
+
+
+  Scenario: --toggle-mark removes a mark from the line if it is marked and exists
+    Given the file "marked.rb":
+    """
+    1      # =>
+    2 + 2  # =>
+    """
+    When I run "seeing_is_believing marked.rb --toggle-mark 1"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '{{"1\n2 + 2  # => "}}'
+    When I run "seeing_is_believing marked.rb --toggle-mark 2"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '{{"1      # => \n2 + 2"}}'
+    When I run "seeing_is_believing marked.rb --toggle-mark 3"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is '{{"1      # => \n2 + 2  # => "}}'
+
+
+  Scenario: --toggle-mark removes error lines, and stdout/stderr output
+    Given the file "output_to_toggle_off.rb":
+    """
+    1 + "a" # ~> b
+    # >> c
+    # !> d
+    # ~> e
+    """
+    When I run "seeing_is_believing output_to_toggle_off.rb --toggle-mark 1"
+    Then stdout is:
+    """
+    1 + "a"
+    # >> c
+    # !> d
+    # ~> e
+    """
+    When I run "seeing_is_believing output_to_toggle_off.rb --toggle-mark 2"
+    Then stdout is:
+    """
+    1 + "a" # ~> b
+
+    # !> d
+    # ~> e
+    """
+    When I run "seeing_is_believing output_to_toggle_off.rb --toggle-mark 3"
+    Then stdout is:
+    """
+    1 + "a" # ~> b
+    # >> c
+
+    # ~> e
+    """
+    When I run "seeing_is_believing output_to_toggle_off.rb --toggle-mark 4"
+    Then stdout is:
+    """
+    1 + "a" # ~> b
+    # >> c
+    # !> d
+    """
+
+
+  Scenario: --toggle-mark respects the --alignment-strategy of file and updates any existing annotations to respect it
+    Given the file "toggle_mark_with_file_alignment.rb":
+    """
+    1
+
+    1 + 1 # => 2
+    1 + 1 + 1 # => 3
+    1 + 1 + 1 + 1
+    """
+    When I run "seeing_is_believing --toggle-mark 1 --alignment-strategy file toggle_mark_with_file_alignment.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1              # =>{{" "}}
+
+    1 + 1          # => 2
+    1 + 1 + 1      # => 3
+    1 + 1 + 1 + 1
+    """
+    When I run "seeing_is_believing --toggle-mark 3 --alignment-strategy file toggle_mark_with_file_alignment.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1
+
+    1 + 1
+    1 + 1 + 1      # => 3
+    1 + 1 + 1 + 1
+    """
+
+
+  Scenario: --toggle-mark respects the --alignment-strategy of chunk and updates any existing annotations to respect it
+    Given the file "toggle_mark_with_chunk_alignments.rb":
+    """
+    1+1# => 2
+    1+1+1
+    1+1+1+1
+
+    1 + 1
+    # comment in the middle!
+    1
+    """
+    When I run "seeing_is_believing --toggle-mark 2 --alignment-strategy chunk toggle_mark_with_chunk_alignments.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1+1      # => 2
+    1+1+1    # =>{{" "}}
+    1+1+1+1
+
+    1 + 1
+    # comment in the middle!
+    1
+    """
+    When I run "seeing_is_believing --toggle-mark 5 --alignment-strategy chunk toggle_mark_with_chunk_alignments.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1+1      # => 2
+    1+1+1
+    1+1+1+1
+
+    1 + 1  # =>{{" "}}
+    # comment in the middle!
+    1
+    """
+    When I run "seeing_is_believing --toggle-mark 1 --alignment-strategy chunk toggle_mark_with_chunk_alignments.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1+1
+    1+1+1
+    1+1+1+1
+
+    1 + 1
+    # comment in the middle!
+    1
+    """
+
+
+  Scenario: --toggle-mark respects the --alignment-strategy of line and updates any existing annotations to respect it
+    Given the file "toggle_mark_with_line_alignments.rb":
+    """
+    1
+    1 + 1# => x
+    1 + 1 + 1
+    """
+    When I run "seeing_is_believing --toggle-mark 1 --alignment-strategy line toggle_mark_with_line_alignments.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1  # =>{{" "}}
+    1 + 1  # => x
+    1 + 1 + 1
+    """
+    When I run "seeing_is_believing --toggle-mark 2 --alignment-strategy line toggle_mark_with_line_alignments.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1
+    1 + 1
+    1 + 1 + 1
+    """
+    When I run "seeing_is_believing --toggle-mark 3 --alignment-strategy line toggle_mark_with_line_alignments.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    1
+    1 + 1  # => x
+    1 + 1 + 1  # =>{{" "}}
+    """

data/features/regression.feature

@@ -267,6 +267,8 @@ Feature:
     """
 
 
+  # ChildProcess doesn't seem to handle this well in Windows. IDK.
+  @not-windows
   Scenario: Long DATA segment in a valid file
     Given the file "long_valid_data_segment.rb":
     """
@@ -434,6 +436,9 @@ Feature:
     """
 
 
+  # 2.4 and 2.5 don't correclty detect deadlock on Windows: https://bugs.ruby-lang.org/issues/16110
+  @not-2.4
+  @not-2.5
   Scenario: Deadlocked
     Given the file "deadlocked.rb":
     """
@@ -465,29 +470,6 @@ Feature:
     """
 
 
-  # See this issue for the issue we're testing for: https://github.com/JoshCheek/seeing_is_believing/issues/46
-  # See this issue for why we turn it off on 2.4: https://github.com/flori/json/issues/309
-  #
-  # 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
-  @not-2.4
-  Scenario: Old JSON bug
-    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("√")
-    """
-
-
   # https://github.com/JoshCheek/seeing_is_believing/wiki/Encodings
   # https://github.com/JoshCheek/seeing_is_believing/issues/109
   Scenario: Assumes utf-8 for files regardless of what Ruby thinks
@@ -753,3 +735,164 @@ Feature:
     require 'seeing_is_believing'               # => true
     SeeingIsBelieving.call("1+1").result[1][0]  # => "2"
     """
+
+
+  Scenario: Errors should not blow away comments (Issue #120)
+    Given the file "sib_with_error_on_uncommented_line.rb" "dne"
+    And   the file "sib_with_error_on_commented_line.rb" "dne # this doesn't exist!"
+    When I run "seeing_is_believing -x sib_with_error_on_uncommented_line.rb"
+    Then stdout is:
+    """
+    dne # ~> NameError: undefined local variable or method `dne' for main:Object
+
+    # ~> NameError
+    # ~> undefined local variable or method `dne' for main:Object
+    # ~>
+    # ~> sib_with_error_on_uncommented_line.rb:1:in `<main>'
+    """
+    When I run "seeing_is_believing -x sib_with_error_on_commented_line.rb"
+    Then stdout is:
+    """
+    dne # this doesn't exist!
+
+    # ~> NameError
+    # ~> undefined local variable or method `dne' for main:Object
+    # ~>
+    # ~> sib_with_error_on_commented_line.rb:1:in `<main>'
+    """
+    When I run "seeing_is_believing sib_with_error_on_uncommented_line.rb"
+    Then stdout is:
+    """
+    dne  # ~> NameError: undefined local variable or method `dne' for main:Object
+
+    # ~> NameError
+    # ~> undefined local variable or method `dne' for main:Object
+    # ~>
+    # ~> sib_with_error_on_uncommented_line.rb:1:in `<main>'
+    """
+    When I run "seeing_is_believing sib_with_error_on_commented_line.rb"
+    Then stdout is:
+    """
+    dne # this doesn't exist!
+
+    # ~> NameError
+    # ~> undefined local variable or method `dne' for main:Object
+    # ~>
+    # ~> sib_with_error_on_commented_line.rb:1:in `<main>'
+    """
+
+
+  Scenario: Errors on files read from stdin with --local-cwd are matched to the correct lines
+    Given the file "local_cwd_and_error_on_uncommented_line.rb" "dne"
+    When I run "seeing_is_believing --local-cwd < local_cwd_and_error_on_uncommented_line.rb"
+    Then stdout includes "dne  # ~> NameError: undefined local variable or method `dne' for main:Object"
+
+
+  Scenario: Inspects strings even when they have a singleton class (Issue #118)
+    Given the file "result_of_inspect_has_a_singleton_class.rb":
+    """
+    str = "a string"
+    def str.inspect
+      self
+    end
+    str  # =>
+    """
+    When I run "seeing_is_believing -x result_of_inspect_has_a_singleton_class.rb"
+    Then stderr is empty
+    And the exit status is 0
+    And stdout is:
+    """
+    str = "a string"
+    def str.inspect
+      self
+    end
+    str  # => a string
+    """
+
+
+  Scenario: The last line can end in a semicolon
+    When I run "seeing_is_believing -e '1'"
+    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
+    """