yap-shell 0.7.1 → 0.7.2

data/spec/features/shell_expansions_spec.rb

@@ -1,127 +0,0 @@
-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

@@ -1,172 +0,0 @@
-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
-
-    mkdir tmp_dir
-    Dir.chdir tmp_dir
-
-    set_yap_command_line_arguments \
-      '--no-history', '--no-addons', '--no-rcfiles', '--skip-first-time'
-
-    turn_on_debug_log(debug: 'editor')
-    initialize_shell
-
-    if self.class.metadata[:repl] == false
-      # no-op if the test specificaly says it doesn't use a repl
-      # This is likely when we're expecting yap to print information
-      # and exit immediately
-    else
-      type "cd #{tmp_dir}"
-      enter
-
-      type "pwd"
-      enter
-      expect { output }.to have_printed(File.expand_path(tmp_dir))
-    end
-    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
-      elsif self.class.metadata[:repl] == false
-        # no-op if the test specificaly says it doesn't use a repl
-        # This is likely when we're expecting yap to print information
-        # and exit immediately
-      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!
-        clear_all_output(console: true)
-        type 'echo done with this test'
-        enter
-        expect { output }.to have_printed('done with this test')
-      end
-    ensure
-      clear_all_output(console: false)
-      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

@@ -1,30 +0,0 @@
-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

@@ -1,68 +0,0 @@
-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
-
-
-RSpec::Matchers.define :have_printed_lines do |expected|
-  output_seen_so_far = ""
-  current_line = nil
-
-  match do |block|
-    begin
-      expected.lines.each do |line|
-        current_line = line
-        regex = /#{Regexp.escape(line)}/m
-        very_soon do
-          current_output = block.call
-          output_seen_so_far = current_output
-          regex.match(current_output)
-        end
-      end
-      true
-    rescue Timeout::Error
-      false
-    end
-  end
-
-  failure_message do |actual|
-    if expected.is_a?(Regexp)
-      "expected that #{current_line.inspect} would match #{output_seen_so_far.inspect}"
-    else
-      "expected that #{current_line.inspect} would appear in #{output_seen_so_far.inspect}"
-    end
-  end
-
-  def supports_block_expectations?
-    true
-  end
-end
-
-RSpec::Matchers.alias_matcher :have_printed_line, :have_printed_lines
-RSpec::Matchers.alias_matcher :have_line, :have_printed_lines

data/spec/support/very_soon.rb

@@ -1,9 +0,0 @@
-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

data/spec/support/yap_spec_dsl.rb

@@ -1,258 +0,0 @@
-require 'fileutils'
-require 'pathname'
-require 'timeout'
-require 'ostruct'
-
-module Yap
-  module Spec
-    class OutputFile
-      def initialize(filepath)
-        @filepath = filepath
-      end
-
-      def clear
-        `> #{@filepath}`
-      end
-
-      def read
-        file = File.open(@filepath, 'rb')
-        file.read.gsub(/\u0000/, '')
-      end
-    end
-
-    class Shell
-      def self.current
-        @instance
-      end
-
-      def self.new(**kwargs)
-        if @instance
-          @instance.stop
-        end
-        @instance = allocate.tap do |instance|
-          instance.send :initialize, **kwargs
-          instance.start
-        end
-      end
-
-      def initialize(dir:, args:, stdout:, stderr:)
-        @childprocess = nil
-        @dir = dir
-        @args = args
-        @stdout = stdout
-        @stderr = stderr
-      end
-
-      def io
-        @childprocess.io if @childprocess
-      end
-
-      def stop
-        if @childprocess
-          @childprocess.stop
-          @childprocess.wait
-        end
-      end
-
-      def start
-        return @childprocess if @childprocess
-        @childprocess = begin
-          process = ChildProcess.build(
-            'ruby',
-            @dir,
-            *@args
-          )
-
-          process.io.stdout = @stdout
-          process.io.stderr = @stderr
-
-          # make stdin available, writable
-          process.duplex = true
-
-          process.cwd = Dir.pwd
-          process.start
-
-          # make sure clean-up child processes, hang if any fail
-          # to stop
-          at_exit do
-            process.stop
-            process.wait
-          end
-
-          process
-        end
-      end
-    end
-
-    module DSL
-      def very_soon(timeout: self.timeout, &block)
-        @wait_for_last_exception = nil
-        begin
-          Timeout.timeout(timeout) do
-            begin
-              block.call
-            rescue RSpec::Expectations::ExpectationNotMetError => ex
-              @wait_for_last_exception = ex
-              sleep 0.1
-              retry
-            end
-          end
-        rescue Timeout::Error
-          raise @wait_for_last_exception
-        rescue Exception => ex
-          raise ex
-        end
-      end
-
-      def touch(path)
-        FileUtils.touch path
-      end
-
-      def mkdir(path)
-        mkdir_p path
-      end
-
-      def mkdir_p(path)
-        unless File.expand_path(path.to_s).include?(tmp_dir.to_s)
-          path = tmp_dir.join(path)
-        end
-        FileUtils.mkdir_p Pathname.new(path).expand_path
-      end
-
-      def chdir(path, &blk)
-        Dir.chdir(path, &blk)
-      end
-
-      def rmdir(path)
-        path = tmp_dir.join(path) unless path == tmp_dir
-        FileUtils.rm_rf Pathname.new(path).expand_path
-      end
-
-      def write_file(filename, contents)
-        filename = tmp_dir.join(filename) unless filename.to_s.include?(tmp_dir.to_s)
-        file = File.new(filename, 'w+')
-        file.write contents
-        file.close
-      end
-
-      def write_executable_script(filename, contents)
-        filename = tmp_dir.join(filename) unless filename.to_s.include?(tmp_dir.to_s)
-        file = File.new(filename, 'w+')
-        file.write contents
-        file.chmod 0755
-        file.close
-      end
-
-      def tmp_dir
-        yap_dir.join('tmp/specroot').expand_path
-      end
-
-      def yap_dir
-        Pathname.new File.dirname(__FILE__) + '/../../'
-      end
-
-      def turn_on_debug_log(file: '/tmp/yap-debug.log', debug: '*')
-        ENV['TREEFELL_OUT'] = file
-        ENV['DEBUG'] = debug
-      end
-
-      def set_yap_command_line_arguments(*args)
-        @yap_command_line_arguments = args.flatten
-      end
-
-      def yap_command_line_arguments
-        @yap_command_line_arguments
-      end
-
-      def initialize_shell
-        Shell.new(
-          dir: yap_dir.join('bin/yap-dev').to_s,
-          args: yap_command_line_arguments,
-          stdout: stdout,
-          stderr: stderr
-        )
-      end
-
-      def reinitialize_shell
-        initialize_shell
-        clear_all_output(console: false)        
-      end
-
-      def shell
-        Shell.current
-      end
-
-      def set_prompt(str)
-        shell.io.stdin.print "!prompt = '#{str}'"
-        enter
-      end
-
-      def typed_content_awaiting_enter?
-        @typed_content_awaiting_enter
-      end
-
-      def type(str)
-        @typed_content_awaiting_enter = true
-        shell.io.stdin.print str
-      end
-
-      def enter
-        @typed_content_awaiting_enter = false
-        shell.io.stdin.print "\r"
-      end
-
-      def clear_all_output(console: true)
-        if console
-          type 'echo done'
-          enter
-          expect { output }.to have_printed_line('done')
-        end
-        output_file.clear
-        error_output_file.clear
-      end
-
-      def output
-        str = ANSIString.new output_file.read
-        without_ansi_str = str.without_ansi.force_encoding(
-          Encoding::ASCII_8BIT
-        ).gsub(/(\x9B|\x1B\[)[0-?]*[ -\/]*[@-~]/n, '')
-      end
-
-      def error_output
-        str = ANSIString.new error_output_file.read
-        str.without_ansi.force_encoding(
-          Encoding::ASCII_8BIT
-        ).gsub(/(\x9B|\x1B\[)[0-?]*[ -\/]*[@-~]/n, '')
-      end
-
-      def output_file
-        @output_file ||= OutputFile.new(stdout.path)
-      end
-
-      def error_output_file
-        @error_output_file ||= OutputFile.new(stderr.path)
-      end
-
-      def stdout
-        yap_dir
-        @stdout ||= begin
-          File.open yap_dir.join('stdout.log').expand_path, 'wb'
-        end
-        @stdout.sync = true
-        @stdout
-      end
-
-      def stderr
-        @stderr ||= begin
-          File.open yap_dir.join('stderr.log').expand_path, 'wb'
-        end
-        @stderr.sync = true
-        @stderr
-      end
-
-      def timeout
-        @timeout ||= 2 # seconds
-      end
-    end
-  end
-end