andyw8-seeing_is_believing 4.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04dfa621b8e9f0c3665c40b6d34aa79c44eccda6149d7cf5515b25addbb01cc5
+  data.tar.gz: f22fc3fa9ae8086a8da413a3018745743299b7bbbb6063b6e040f26673024def
+SHA512:
+  metadata.gz: 93c3630f95d6aecb4c7295f734e2cf204ed69ea2a8052c87903138f990495bb3930abd5affcdd4ebcde4c196b5aa5f231f0e55ee6f622877e4fcad1864b23bee
+  data.tar.gz: b286233f3834792d3d1ef41a406e960711f7eb436a5e6b5887e5bd61756e746e7bc9169d5126de0317e2aae00cfb18ccd69eb598c73976adcf8646e2b90356fa

data/.github/workflows/test.yml

@@ -0,0 +1,60 @@
+# 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
+#
+# This file is heavily based on this example:
+# https://github.com/ruby/setup-ruby/blob/477b21f02be01bcb8030d50f37cfec92bfa615b6/.github/workflows/test.yml
+
+name: Test
+
+# quoting because https://twitter.com/josh_cheek/status/1406699258649190403
+"on":
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false # Just to see where we're at outside of Windows
+      matrix:
+        os:
+        - 'ubuntu-20.04'
+        - 'windows-2016'
+        - 'windows-2019'
+        - 'macos-10.15'
+        # This is currently unavailable: https://github.com/actions/virtual-environments/issues/2486
+        # - 'macos-11.0'
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+
+    name: MRI ${{ matrix.ruby }} / ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    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@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    # This is honestly super confusing for me.
+    # https://github.com/JoshCheek/seeing_is_believing/runs/2870747499?check_suite_focus=true
+    - name: Fuckit, try installing bundler explicitly
+      run:  gem install bundler
+
+    - name: Install binstubs (no rubygems / bundler at runtime, makes tests much much faster)
+      run:  rake install
+
+    - name: Run rspec tests
+      run:  bundle/bin/rake spec
+
+    - name: Run cucumber features
+      run:  bundle/bin/rake cuke

data/.gitignore

@@ -0,0 +1,19 @@
+# Transient test files
+proving_grounds/*
+
+# Don't accidentally commit gems generated from the source code
+*.gem
+
+# Since it's a gem, don't lock it down to specific versions
+Gemfile.lock
+
+# local notes about what I'm working on
+todo
+
+# Bundler stores its configuration information here
+.bundle
+
+# Where I'm vendoring gems for the standalone environment
+# Going with this location b/c Bundler winds up creating this dir anyway
+# to make `require "bundler/setup"` work
+bundle

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,70 @@
+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
+===================
+
+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](docs/example.gif)
+
+
+Helpful links
+-------------
+
+* [Install](https://github.com/JoshCheek/seeing_is_believing/wiki/Installation)
+* [Integrate with your editor](https://github.com/JoshCheek/seeing_is_believing/wiki/Editor-Integration)
+* [Use as a library](https://github.com/JoshCheek/seeing_is_believing/wiki/Library-example)
+* [Use on the command line](https://github.com/JoshCheek/seeing_is_believing/wiki/Command-Line-Usage)
+* [Pro Tips (useful patterns)](https://github.com/JoshCheek/seeing_is_believing/wiki/Pro-Tips)
+* [Features](https://github.com/JoshCheek/seeing_is_believing/tree/master/features)
+* [Potential Future Features](https://github.com/JoshCheek/seeing_is_believing/wiki/Potential-future-features)
+* [Set up it up for development work](https://github.com/JoshCheek/seeing_is_believing/wiki/Setting-it-up-for-Development)
+
+
+Examples
+--------
+
+* Watch a [longer video](http://vimeo.com/73866851).
+* Watch John Cinnamond use it in a [presentation](http://brightonruby.com/2016/the-point-of-objects-john-cinnamond/)
+  at the 10:22 minute mark.
+* [Avdi](https://github.com/avdi) uses it in [Ruby Tapas](https://www.rubytapas.com/),
+  an amazing resource for developers in general and Ruby Developers in particular!
+
+
+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.
+
+
+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 >.<)
+
+
+Shout outs
+-----------
+
+* Whitequark for all the work on [Parser](http://github.com/whitequark/parser/)
+
+
+License
+-------
+
+<a href="http://www.wtfpl.net/"><img src="http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl.svg" height="20" alt="WTFPL" /></a>
+
+    Copyright (C) 2014 Josh Cheek <josh.cheek@gmail.com>
+
+    This program is free software. It comes without any warranty,
+    to the extent permitted by applicable law.
+    You can redistribute it and/or modify it under the terms of the
+    Do What The Fuck You Want To Public License,
+    Version 2, as published by Sam Hocevar.
+    See http://www.wtfpl.net/ for more details.

data/Rakefile

@@ -0,0 +1,88 @@
+Bundler::GemHelper.install_tasks
+
+desc 'Have Bundler setup a standalone environment -- run tests in this, b/c its much faster'
+task :install do
+  # 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'
+
+  next if Dir.exist? 'bundle'
+
+  # Install gems locally, into the directory "bundle" so that we can run without rubygems
+  sh 'bundle', 'install', '--standalone'
+
+  # Generate "binstubs" (wrappers around the gems executable files) that are configured to understand the standalone location
+  sh 'bundle', 'binstubs', '--all', '--path', 'bundle/bin'
+end
+
+
+desc 'Remove generated and irrelevant files'
+task :clean do
+  rm_rf %w[bundle .bundle Gemfile.lock proving_grounds tags] + Dir['*.gem']
+end
+
+
+directory 'bundle' do
+  $stderr.puts "\e[31mLooks like the gems aren\'t installed, run `rake install` to install them\e[39m"
+  exit 1
+end
+
+
+def require_paths
+  require 'bundler'
+  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'
+task :require_paths, [:delimiter] => :bundle do |*, options|
+  puts require_paths.join(options.fetch(:delimiter, ' '))
+end
+
+desc 'Run specs'
+task spec: :bundle do
+  sh 'ruby', '--disable-gem', *require_paths, '-S', 'bundle/bin/rspec', '--fail-fast'
+end
+
+desc 'Run cukes'
+task cuke: :bundle do
+  require 'bundler'
+  platform_filter = Gem.win_platform? ? %W[--tags ~@not-windows] : []
+  ruby_version_without_patchlevel = RUBY_VERSION[/^\d+\.\d+/]
+  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}",
+      *platform_filter
+end
+
+desc 'Generate tags for quick navigation'
+task tags: :bundle do
+  excludes = %w[tmp tmpgem bundle proving_grounds].map { |dir| "--exclude=#{dir}" }
+  sh 'ruby', '--disable-gem',
+     *require_paths,
+     '-S', 'bundle/bin/ripper-tags',
+     '-R', *excludes
+end
+task ctags: :tags # an alias
+
+
+desc 'Run all specs and cukes'
+task default: [:spec, :cuke]
+
+desc 'Install dependencies and run tests (mainly for Travis CI)'
+task ci: [:spec, :cuke]
+
+def self.which(exe)
+  dirs = ENV["PATH"].split(File::PATH_SEPARATOR)
+  exts = [""]
+  exts.concat(ENV["PathExt"].to_s.split(File::PATH_SEPARATOR))
+  candidates = dirs.product(exts) { |dir, ext| File.join(dir, exe + ext) }
+  exe_path = candidates.find { |c| File.executable?(c) }
+end

data/appveyor.yml

@@ -0,0 +1,32 @@
+# Based this off of https://github.com/rspec/rspec-core/blob/22ed96bb3dbb0214dc48d6b8490ade04cdf8eedd/appveyor.yml
+# Docs are at https://www.appveyor.com/docs
+
+# I don't really understand what this is for
+version: "{build}"
+
+# This will build all PRs targetting matching branches.
+# Without this, each PR builds twice -- once for the PR branch HEAD,
+# and once for the merge commit that github creates for each mergable PR.
+branches:
+  only:
+    - master
+    - /.*-maintenance$/
+
+# Disable normal Windows builds in favor of our test script.
+build: off
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - rake install
+
+test_script:
+  - bundle exec rake ci
+
+environment:
+  matrix:
+    - ruby_version: '25'
+    - ruby_version: '26'
+    - ruby_version: '27'
+    - ruby_version: '30'

data/bin/seeing_is_believing

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.realpath('../lib', __dir__)
+$LOAD_PATH.unshift lib_dir
+
+require 'seeing_is_believing/binary'
+exit SeeingIsBelieving::Binary.call(ARGV, $stdin, $stdout, $stderr)

data/features/deprecated-flags.feature

@@ -0,0 +1,91 @@
+Feature: Flags that are deprecated
+
+  Features get added, features get removed.
+  Don't want to blow up just b/c of removal of some feature.
+  As such, these flags will continue to not blow up,
+  even though they won't work anymore
+
+  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
+    """
+
+  Scenario: -K without errors
+    Given the file "deprecated_K.rb" "__ENCODING__"
+    When I run "seeing_is_believing -Ke deprecated_K.rb"
+    Then stdout is '__ENCODING__  # => #<Encoding:EUC-JP>'
+    And stderr is empty
+    When I run "seeing_is_believing -Ku deprecated_K.rb"
+    Then stdout is '__ENCODING__  # => #<Encoding:UTF-8>'
+    And stderr is empty
+
+  Scenario: -K with errors
+    Given the file "deprecated_K.rb" "__ENCODING__"
+    When I run "seeing_is_believing -Ke not_a_file.rb"
+    Then stdout is empty
+    And stderr is:
+    """
+    Error: not_a_file.rb does not exist!
+    Deprecated: `-Ke` The ability to set encodings is deprecated. If you need this, details are at https://github.com/JoshCheek/seeing_is_believing/wiki/Encodings
+    """

data/features/errors.feature

@@ -0,0 +1,155 @@
+Feature: Running the binary unsuccessfully
+
+  Sometimes I mess up and use the program in a way that doesn't work.
+  I'd like it to be helpful in these situations so I can fix my use.
+
+  # show that it displays next to the first place in the file
+  # and should maybe print the stacktrace at the bottom
+  Scenario: Raising exceptions
+    Given the file "raises_exception.rb":
+    """
+    raise "ZOMG\n!!!!"
+    """
+    And the file "requires_exception_raising_code.rb":
+    """
+    def first_defined
+      second_defined
+    end
+
+    def second_defined
+      require_relative 'raises_exception'
+    end
+
+    first_defined
+    """
+    When I run "seeing_is_believing requires_exception_raising_code.rb"
+    Then stderr is empty
+    And the exit status is 1
+    And stdout is:
+    """
+    def first_defined
+      second_defined
+    end                # => {{method_result :first_defined}}
+
+    def second_defined
+      require_relative 'raises_exception'  # ~> RuntimeError: ZOMG\n!!!!
+    end                                    # => {{method_result :second_defined}}
+
+    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>'
+    """
+
+  @not-windows
+  Scenario: Raising multiple exceptions
+    Given the file "multiple_exceptions.rb":
+    """
+    if pid = fork #
+      Process.wait pid #
+      raise "parent"
+    else
+      raise "child"
+    end
+
+    """
+    When I run "seeing_is_believing multiple_exceptions.rb"
+    Then stderr is empty
+    And the exit status is 1
+    And stdout is:
+    """
+    if pid = fork #
+      Process.wait pid #
+      raise "parent"  # ~> RuntimeError: parent
+    else
+      raise "child"   # ~> RuntimeError: child
+    end
+
+    # ~> RuntimeError
+    # ~> child
+    # ~>
+    # ~> multiple_exceptions.rb:5:in `<main>'
+
+    # ~> RuntimeError
+    # ~> parent
+    # ~>
+    # ~> multiple_exceptions.rb:3:in `<main>'
+    """
+    When I run "seeing_is_believing multiple_exceptions.rb -x"
+    Then stderr is empty
+    And the exit status is 1
+    And stdout is:
+    """
+    if pid = fork #
+      Process.wait pid #
+      raise "parent" # ~> RuntimeError: parent
+    else
+      raise "child" # ~> RuntimeError: child
+    end
+
+    # ~> RuntimeError
+    # ~> child
+    # ~>
+    # ~> multiple_exceptions.rb:5:in `<main>'
+
+    # ~> RuntimeError
+    # ~> parent
+    # ~>
+    # ~> multiple_exceptions.rb:3:in `<main>'
+    """
+
+  Scenario: Syntactically invalid file
+    Given the file "invalid_syntax.rb":
+    """
+    'this is valid'
+    'this is not
+    """
+    When I run "seeing_is_believing invalid_syntax.rb"
+    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 "Error: this_file_does_not_exist.rb does not exist!"
+    And the exit status is 2
+    And stdout is empty
+
+  Scenario: Passing unknown flags
+    Given the file "some_file" "1"
+    When I run "seeing_is_believing --unknown-flag"
+    Then stderr is 'Error: --unknown-flag is not a flag, see the help screen (-h) for a list of options'
+    And the exit status is 2
+    And stdout is empty
+
+  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
+
+  Scenario: Stack overflow
+    Given the file "stack_overflow.rb":
+    """
+    def m() m end
+    m
+    """
+    When I run "seeing_is_believing stack_overflow.rb"
+    Then stderr is empty
+    And the exit status is 1
+    And stdout includes:
+    """
+    def m() m end  # ~> SystemStackError: stack level too deep
+    m
+    """