yap-shell 0.5.2 → 0.6.0

data/spec/features/redirection_spec.rb

@@ -0,0 +1,225 @@
+require 'spec_helper'
+
+describe 'I/O Redirection', type: :feature do
+  before do
+    write_executable_script 'fail', <<-SCRIPT.strip_heredoc
+      |#!/bin/sh
+      |>&2 echo fail $1
+      |exit 1
+    SCRIPT
+  end
+
+  describe 'STDOUT' do
+    it 'redirects with: >' do
+      type 'echo foo > output.txt'
+      enter
+      clear_all_output
+
+      type 'cat output.txt'
+      enter
+      expect { output }.to have_printed('foo')
+    end
+
+    it 'redirects with: 1>' do
+      type 'echo hrm 1> output.txt'
+      enter
+      clear_all_output
+
+      type 'cat output.txt'
+      enter
+      expect { output }.to have_printed('hrm')
+    end
+
+    it 'overwrites the file' do
+      type 'echo foo > output.txt'
+      enter
+      type 'echo bar > output.txt'
+      enter
+      clear_all_output
+
+      type 'cat output.txt'
+      enter
+      expect { output }.to have_printed('bar')
+      expect { output }.to have_not_printed('foo')
+    end
+
+    describe 'appending' do
+      before do
+        type 'echo foo > output.txt'
+        enter
+        type 'cat output.txt'
+        enter
+        expect { output }.to have_printed(/foo/)
+        clear_all_output
+      end
+
+      it 'appends with: >>' do
+        type 'echo bar >> output.txt'
+        enter
+        type 'cat output.txt'
+        enter
+        expect { output }.to have_printed(/foo.*\n.*bar/)
+      end
+
+      it 'appends with: 1>>' do
+        type 'echo bar 1>> output.txt'
+        enter
+        type 'cat output.txt'
+        enter
+        expect { output }.to have_printed(/foo.*\n.*bar/)
+      end
+    end
+  end
+
+  describe 'STDERR' do
+    it 'redirects with: 2>' do
+      type './fail foo 2> error.txt'
+      enter
+      clear_all_output
+
+      type 'cat error.txt'
+      enter
+      expect { output }.to have_printed('fail foo')
+    end
+
+    it 'overwrites the file' do
+      type './fail foo 2> error.txt'
+      enter
+      type './fail bar 2> error.txt'
+      enter
+      clear_all_output
+
+      type 'cat error.txt'
+      enter
+      expect { output }.to have_printed('fail bar')
+      expect { output }.to have_not_printed('fail foo')
+      clear_all_output
+    end
+
+    describe 'appending' do
+      before do
+        type './fail caz 2> error.txt'
+        enter
+        type 'cat error.txt'
+        enter
+        expect { output }.to have_printed(/fail caz/)
+        clear_all_output
+      end
+
+      it 'appends with: 2>>' do
+        type './fail box 2>> error.txt'
+        enter
+        type 'cat error.txt'
+        enter
+        expect { output }.to have_printed(/fail caz.*\n.*fail box/)
+      end
+    end
+  end
+
+  describe 'STDOUT and STDERR separately for a command' do
+    before do
+      write_executable_script 'print-stuff', <<-SCRIPT.strip_heredoc
+        |#!/bin/sh
+        |echo 'normal foo'
+        |(>&2 echo 'error foo')
+      SCRIPT
+    end
+
+    it 'redirects with: > and 2>' do
+      type './print-stuff > stdout.txt 2> stderr.txt'
+      enter
+      clear_all_output
+
+      type 'cat stdout.txt'
+      enter
+      expect { output }.to have_printed('normal foo')
+      clear_all_output
+
+      type 'cat stdout.txt'
+      enter
+      expect { output }.to have_not_printed('error foo')
+      clear_all_output
+
+      type 'cat stderr.txt'
+      enter
+      expect { output }.to have_printed('error foo')
+      clear_all_output
+
+      type 'cat stderr.txt'
+      enter
+      expect { output }.to have_not_printed('normal foo')
+    end
+
+    it 'redirects with: 1> and 2>' do
+      type './print-stuff 1> stdout.txt 2> stderr.txt'
+      enter
+      clear_all_output
+
+      type 'cat stdout.txt'
+      enter
+      expect { output }.to have_printed('normal foo')
+      clear_all_output
+
+      type 'cat stdout.txt'
+      enter
+      expect { output }.to have_not_printed('error foo')
+      clear_all_output
+
+      type 'cat stderr.txt'
+      enter
+      expect { output }.to have_printed('error foo')
+      clear_all_output
+
+      type 'cat stderr.txt'
+      enter
+      expect { output }.to have_not_printed('normal foo')
+    end
+  end
+
+  describe 'STDOUT and STDERR pointing to the same file' do
+    before do
+      write_executable_script 'echo-stdout-and-stderr', <<-SCRIPT.strip_heredoc
+        |#!/bin/sh
+        |echo $1
+        |>&2 echo $2
+      SCRIPT
+    end
+
+    it 'redirects and overwrites with: &>' do
+      type './echo-stdout-and-stderr foo bar &> output-and-error.txt'
+      enter
+      type 'cat output-and-error.txt'
+      enter
+      expect { output }.to have_printed(/foo.*\n.*bar/m)
+    end
+
+    it 'redirects and overwrites with: 2>&1' do
+      type './echo-stdout-and-stderr bar foo 2>&1 output-and-error.txt'
+      enter
+      type 'cat output-and-error.txt'
+      enter
+      expect { output }.to have_printed(/bar.*\n.*foo/m)
+    end
+
+    it 'redirects and appends with: &>>' do
+      type './echo-stdout-and-stderr howdy hey &>> output-and-error.txt'
+      enter
+      type 'cat output-and-error.txt'
+      enter
+      expect { output }.to have_printed(/howdy.*\n.*hey/m)
+    end
+  end
+
+  describe 'STDIN' do
+    it 'redirect  with: <' do
+      type 'echo foo > stdin.txt'
+      enter
+      clear_all_output
+
+      type 'cat < stdin.txt'
+      enter
+      expect { output }.to have_printed('foo')
+    end
+  end
+
+end

data/spec/features/repetition_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe 'Repetition', type: :feature do
+  describe 'N.times: statement' do
+    it 'runs the line N times' do
+      type '5.times : echo foo'
+      enter
+      expect { output }.to have_printed(/(.*foo){5}/m)
+    end
+
+    it 'is not white-space sensitive' do
+      type '5.times               :                 echo foo'
+      enter
+      expect { output }.to have_printed(/(.*foo){5}/m)
+    end
+  end
+
+  describe 'N.times: statement1 ; statement2' do
+    it 'runs all the statements on the line N times' do
+      type '3.times : echo foo ; echo bar'
+      enter
+      expect { output }.to have_printed(/(.*foo.*bar){3}/m)
+    end
+
+    it 'is not white-space sensitive' do
+      type '3.times:echo foo ; echo bar'
+      enter
+      expect { output }.to have_printed(/(.*foo.*bar){3}/m)
+    end
+  end
+
+  describe 'parameters' do
+    it 'supplies an index for each execution' do
+      type '3.times as n: echo foo$n ; echo bar$n '
+      enter
+      expect { output }.to have_printed(/foo1.*bar1.*foo2.*bar2.*foo3.*bar3/m)
+    end
+
+    it 'does not overwrite existing variables with the same name' do
+      type "n='hello world'"
+      enter
+      type '3.times as n: echo $n'
+      enter
+      expect { output }.to have_printed(/1.*2.*3/m)
+      clear_all_output
+
+      type 'echo $n'
+      enter
+      expect { output }.to have_printed('hello world')
+    end
+  end
+
+  describe 'repetition with blocks' do
+    it 'runs the code inside the block N times' do
+      type '4.times { echo foo }'
+      enter
+      expect { output }.to have_printed(/(.*foo){4}/m)
+    end
+
+    xit 'requires white-space before the opening curly brace' do
+      # this breaks everything :(
+      type '4.times{ echo foo }'
+      enter
+      expect { output }.to have_printed(/Infinite loop detected/m)
+      skip 'Provide a better error message for the user.'
+    end
+
+    it 'requires white-space before the closing curly brace' do
+      type '4.times { echo foo}'
+      enter
+      expect { output }.to have_printed(/Parse error/m)
+      # should this be an error? Really? We can't tell that we're in a block
+      # and we've got a closing curly brace right there?
+      skip 'Provide a better error message for the user.'
+    end
+
+    it 'does not require white-space after the opening curly brace' do
+      type '4.times {echo foo }'
+      enter
+      expect { output }.to have_printed(/(.*foo){4}/m)
+    end
+
+    it 'does not require white-space after the closing curly brace' do
+      type '4.times { echo foo };'
+      enter
+      expect { output }.to have_printed(/Parse error/m)
+      skip "This shouldn't be an error"
+    end
+
+    describe 'block parameters' do
+      it 'supplies an index for each execution' do
+        type 'echo beg ; 4.times { |n| echo $n } ; echo end'
+        enter
+        expect { output }.to have_printed(/beg.*\n.*1.*2.*3.*4.*\n.*end/m)
+      end
+
+      it 'does not overwrite existing variables with the same name' do
+        type "n='hello world'"
+        enter
+        type 'echo beg ; 3.times { |n| echo $n } ; echo end'
+        enter
+        expect { output }.to have_printed(/beg.*\n.*1.*2.*3.*\n.*end/m)
+        clear_all_output
+
+        type 'echo $n'
+        enter
+        expect { output }.to have_printed('hello world')
+      end
+
+      it 'can step thru the repetition in groups based on how many block params are provided' do
+        type 'echo beg ; 5.times { |a, b| echo $a $b } ; echo end'
+        enter
+        expect { output }.to have_printed(/beg.*\n.*1 2.*\n.*3 4.*\n.*5.*\n.*end/m)
+      end
+    end
+  end
+
+end

data/spec/features/shell_expansions_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe 'Shell expansions', type: :feature do
+  describe 'aliases' do
+    before do
+      type 'alias foo="echo bar"'
+      enter
+      expect { output }.to have_printed('Setting alias foo')
+    end
+
+    it 'expands aliases found in command position' do
+      type 'foo'
+      enter
+      expect { output }.to have_printed('bar')
+    end
+
+    it 'does not expand aliases found in argument position' do
+      type 'echo foo'
+      enter
+      expect { output }.to have_printed('foo')
+      expect { output }.to have_not_printed('bar')
+    end
+  end
+
+  describe 'environment variable expansion' do
+    it 'expands upper-case env vars with a preceding $' do
+      type 'FOO=bar echo $FOO'
+      enter
+      expect { output }.to have_printed('bar')
+    end
+
+    it 'expands lower-case vars with a preceding $' do
+      type 'foo=bar echo $foo'
+      enter
+      expect { output }.to have_printed('bar')
+    end
+
+    it 'is case sensitive' do
+      type 'foo=bar echo $foo'
+      enter
+      expect { output }.to have_printed('bar')
+
+      type 'echo $FOO'
+      enter
+      expect { output }.to have_printed('$FOO')
+    end
+
+    it 'does not expand escaped env vars' do
+      type 'FOO=bar echo \\$FOO'
+      enter
+      expect { output }.to have_printed('$FOO')
+    end
+  end
+
+  describe 'exit status for last command: $?' do
+    it 'prints whatever the exit status of the last command was' do
+      write_executable_script 'exit-with-status-code', <<-SCRIPT.strip_heredoc
+        |#!/bin/sh
+        |exit $1
+      SCRIPT
+
+      type './exit-with-status-code 0 ; echo $?'
+      enter
+      expect { output }.to have_printed('0')
+
+      type './exit-with-status-code 1 ; echo $?'
+      enter
+      expect { output }.to have_printed('1')
+
+      type './exit-with-status-code 99 ; echo $?'
+      enter
+      expect { output }.to have_printed('99')
+    end
+  end
+
+  describe 'word expansions using curly braces' do
+    it 'expands in command position' do
+      type 'foo_{}'
+      enter
+      expect { error_output }.to have_printed('yap: command not found: foo_')
+    end
+
+    describe 'arguments' do
+      it 'expands no words' do
+        type 'echo foo_{}'
+        enter
+        expect { output }.to have_printed('foo_')
+      end
+
+      it 'expands single words' do
+        type 'echo foo_{bar}'
+        enter
+        expect { output }.to have_printed('foo_bar')
+      end
+
+      it 'multiple words in comma-separated list' do
+        type 'echo foo_{bar,bay,baz}'
+        enter
+        expect { output }.to have_printed('foo_bar foo_bay')
+      end
+
+      it 'expands environment variables' do
+        type 'FOO=huzzah echo foo_{$FOO}'
+        enter
+        expect { output }.to have_printed('foo_huzzah')
+      end
+
+      it 'does not expand environment variables in double quotes' do
+        type 'FOO=huzzah echo foo_{"$FOO"}'
+        enter
+        expect { output }.to have_printed('foo_{$FOO}')
+      end
+
+      it 'does not expand environment variables in single quotes' do
+        type %|FOO=huzzah echo foo_{'$FOO'}|
+        enter
+        expect { output }.to have_printed('foo_{$FOO}')
+      end
+
+      it 'treats ~ as any a normal character, not home directory expansion' do
+        type 'echo foo_{~}'
+        enter
+        expect { output }.to have_printed('foo_~')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,162 @@
+require 'ansi_string'
+require 'childprocess'
+require 'pry'
+
+Dir[File.dirname(__FILE__) + '/support/**/**/*.rb'].each do |file|
+  require file
+end
+
+class String
+  def strip_heredoc
+    gsub(/^\s*\|/, '')
+  end
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.include Yap::Spec::DSL
+
+  config.before(:all, type: :feature) do
+    ENV['HOME'] = tmp_dir.to_s
+
+    set_yap_command_line_arguments \
+      '--no-history', '--no-addons', '--no-rcfiles', '--skip-first-time'
+
+    turn_on_debug_log(debug: 'editor')
+
+    initialize_shell
+
+    mkdir tmp_dir
+    Dir.chdir tmp_dir
+
+    type "cd #{tmp_dir}"
+    enter
+
+    type "pwd"
+    enter
+    expect { output }.to have_printed(File.expand_path(tmp_dir))
+    clear_all_output
+  end
+
+  config.after(:all, type: :feature) do
+    shell.stop if shell
+  end
+
+  config.after(:each, type: :feature) do
+    begin
+      if self.class.metadata[:forks]
+        # no-op because the example will cause yap to fork inside the child
+        # childprocess and will break the IO pipes we know about in the test
+      else
+        enter if typed_content_awaiting_enter?
+
+        # Use yap to tell us when it's done doing whatever is was doing.
+        # This ensures we don'try to clean up before yap is done!
+        type 'echo done with this test'
+        enter
+        expect { output }.to have_printed('done with this test')
+      end
+      clear_all_output
+    ensure
+      Dir.chdir(tmp_dir) do
+        # remove all files including hidden but not current directory and
+        # parent directory
+        FileUtils.rm_rf Dir.glob('{.,}*') - %w(. ..)
+      end
+    end
+  end
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/matchers/have_not_printed.rb

@@ -0,0 +1,30 @@
+RSpec::Matchers.define :have_not_printed do |expected|
+  output_seen_so_far = ""
+
+  match do |block|
+    regex = expected
+    regex = /#{Regexp.escape(regex)}/m unless regex.is_a?(Regexp)
+    begin
+      very_soon do
+        current_output = block.call
+        output_seen_so_far << current_output
+        current_output.length > 0
+      end
+    rescue Timeout::Error
+      return true # we didn't see it, make the assumption we're good
+    end
+    !regex.match(output_seen_so_far)
+  end
+
+  failure_message do |actual|
+    if expected.is_a?(Regexp)
+      "expected that #{expected.inspect} would not match #{output_seen_so_far.inspect}"
+    else
+      "expected that #{expected.inspect} would not appear in #{output_seen_so_far.inspect}"
+    end
+  end
+
+  def supports_block_expectations?
+    true
+  end
+end

data/spec/support/matchers/have_printed.rb

@@ -0,0 +1,30 @@
+RSpec::Matchers.define :have_printed do |expected|
+  output_seen_so_far = ""
+
+  match do |block|
+    begin
+      regex = expected
+      regex = /#{Regexp.escape(regex)}/m unless regex.is_a?(Regexp)
+      very_soon do
+        current_output = block.call
+        output_seen_so_far << current_output
+        regex.match(current_output)
+      end
+      true
+    rescue Timeout::Error
+      false
+    end
+  end
+
+  failure_message do |actual|
+    if expected.is_a?(Regexp)
+      "expected that #{expected.inspect} would match #{output_seen_so_far.inspect}"
+    else
+      "expected that #{expected.inspect} would appear in #{output_seen_so_far.inspect}"
+    end
+  end
+
+  def supports_block_expectations?
+    true
+  end
+end

data/spec/support/very_soon.rb

@@ -0,0 +1,9 @@
+def very_soon(timeout: 5, &block)
+  Timeout.timeout(timeout) do
+    loop do
+      result = block.call
+      break result if result
+      sleep 0.1
+    end
+  end
+end