yap-shell 0.5.2 → 0.6.0

data/lib/yap.rb

@@ -1,17 +1,62 @@
-require 'treefell'
+require "term/ansicolor"
+require "tins"
+require "byebug"
+require "pry"
+require "treefell"
+require 'optparse'
 
 module Yap
   require 'yap/configuration'
   require 'yap/shell'
   require 'yap/world'
 
-  def self.run_shell
+  def self.parse_cli_args_for_configuration(args, configuration)
+    OptionParser.new do |opts|
+      opts.on('-h', '--help', 'Prints this help') do
+        puts opts
+        exit
+      end
+
+      opts.on('--skip-first-time', 'Disables creating ~/.yap directory on shell startup') do
+        configuration.skip_first_time = true
+      end
+
+      opts.on('--no-addons', 'Disables auto-loading addons on shell startup') do
+        configuration.use_addons = false
+      end
+
+      opts.on('--no-history', 'Disables auto-loading or saving history') do
+        configuration.use_history = false
+      end
+
+      opts.on('--no-rcfiles', 'Disables auto-loading rcfiles on shell startup') do
+        configuration.use_rcfiles = false
+      end
+    end.parse!(args)
+  end
+
+  def self.run_shell(argv)
     Treefell['shell'].puts "#{self}.#{__callee__} booting shell"
-    addons = [
-      World::Addons.load_directories(configuration.addon_paths),
-      World::Addons.load_rcfiles(configuration.rcfiles)
-    ].flatten
 
-    Shell::Impl.new(addons: addons).repl
+    parse_cli_args_for_configuration(argv, configuration)
+
+    addons_loaded = []
+    if configuration.use_addons?
+      Treefell['shell'].puts "#{self}.#{__callee__} loading addons"
+      addons_loaded.concat \
+        World::Addons.load_directories(configuration.addon_paths)
+    else
+      Treefell['shell'].puts "#{self}.#{__callee__} skipping addons"
+    end
+
+    if configuration.use_rcfiles?
+      Treefell['shell'].puts "#{self}.#{__callee__} loading rcfiles"
+      addons_loaded.concat \
+        World::Addons.load_rcfiles(configuration.rcfiles)
+    else
+      Treefell['shell'].puts "#{self}.#{__callee__} skipping rcfiles"
+    end
+
+    Shell::Impl.new(addons: addons_loaded).repl
   end
 end

data/spec/features/aliases_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe 'Aliases', type: :feature do
+  before do
+    type "alias foo='echo bar'"
+    enter
+    expect { output }.to have_printed(/Setting alias foo done/)
+  end
+
+  it 'sets them' do
+    type 'alias | grep foo'
+    enter
+    expect { output }.to have_printed(/alias foo='echo bar'/)
+  end
+
+  it 'executes them' do
+    type 'foo'
+    enter
+    expect { output }.to have_printed(/bar\n/)
+  end
+
+  it 'unsets them' do
+    type 'unalias foo'
+    enter
+    expect { output }.to have_printed(/Removing alias foo done\n/)
+
+    type 'alias | grep foo'
+    enter
+    expect(output).to_not match(/alias foo='echo bar'/)
+  end
+
+  describe 'conditionals' do
+    before do
+      type "alias fail='non-existent-command'"
+      enter
+      type "alias pass='echo pass'"
+      enter
+      clear_all_output
+    end
+
+    it 'supports logical AND: &&' do
+      type "pass && pass"
+      enter
+      expect { output }.to have_printed(/pass.*\n.*pass/m)
+    end
+
+    it 'supports logical OR: &&' do
+      type "fail || pass"
+      enter
+      expect { error_output }.to have_printed(/yap: command not found: non-existent-command/m)
+      expect { output }.to have_printed(/pass/m)
+      clear_all_output
+
+      type "echo $?"
+      enter
+      expect { output }.to have_printed(/0/m)
+    end
+
+    it 'can combine logical AND and OR' do
+      type "(pass && fail) || pass"
+      enter
+      expect { error_output }.to have_printed(/yap: command not found: non-existent-command/m)
+      expect { output }.to have_printed(/pass.*\n.*pass/m)
+      clear_all_output
+
+      type "(pass || fail) && pass"
+      enter
+      expect { error_output }.to have_not_printed(/yap: command not found: non-existent-command/m)
+      expect { output }.to have_printed(/pass.*\n.*pass/m)
+      clear_all_output
+
+      type "(fail && pass) && pass"
+      enter
+      expect { error_output }.to have_printed(/yap: command not found: non-existent-command/m)
+      expect { output }.to have_not_printed(/pass.*\n.*pass/m)
+    end
+  end
+end

data/spec/features/environment_variables_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe 'Environment variables', type: :feature do
+  it 'sets and gets them with: NAME=value' do
+    type 'FOO=foobarbaz'
+    enter
+
+    type 'echo $FOO'
+    enter
+    expect { output }.to have_printed('foobarbaz')
+  end
+
+  it 'can set multiple on a single line: NAME1=value1 NAME2=value2 etc' do
+    type 'A=b B=c C=d'
+    enter
+    clear_all_output
+
+    type 'echo $A $B $C'
+    enter
+    expect { output }.to have_printed('b c d')
+    clear_all_output
+
+    type 'echo $A$B$C'
+    enter
+    expect { output }.to have_printed('bcd')
+  end
+
+  it 'expands env vars inside of double quotes' do
+    type 'BAR=foobarbaz'
+    enter
+
+    type %|echo "BAR is $BAR"|
+    enter
+    expect { output }.to have_printed('BAR is foobarbaz')
+  end
+
+  it 'does not expand env vars inside of single quotes' do
+    type 'BAR=foobarbaz'
+    enter
+
+    type %|echo 'BAR is $BAR'|
+    enter
+    expect { output }.to have_printed('BAR is $BAR')
+  end
+
+  describe 'setting env vars for a single statement' do
+    it 'makes the env var available to the statement' do
+      type 'BAZ=baz echo $BAZ'
+      enter
+      expect { output }.to have_printed('baz')
+    end
+
+    it 'does not keep the env var around for the next statement' do
+      type 'BAZ=baz echo $BAZ'
+      enter
+      clear_all_output
+
+      type 'echo $BAZ'
+      enter
+      expect { output }.to have_printed('$BAZ')
+    end
+
+    it 'can set multiple env vars for a statement' do
+      type %|FOO=foo BAR='is the' BAZ="fastest pineapple" echo $FOO $BAR $BAZ|
+      enter
+      expect { output }.to have_printed('foo is the fastest pineapple')
+    end
+  end
+end

data/spec/features/filesystem_commands_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe 'Filesystem commands', type: :feature do
+  it 'runs filesystem commands' do
+    touch 'bar.txt'
+    type 'ls .'
+    enter
+
+    expect { output }.to have_printed("bar.txt")
+
+    type 'echo "hello there"'
+    enter
+    expect { output }.to have_printed("hello there\n")
+    clear_all_output
+  end
+
+  it 'pipes filesystem commands' do
+    type "echo 'food' | sed -e 's/o/_/g'"
+    enter
+    expect { output }.to have_printed(/^f__d\n/m)
+  end
+
+  describe 'conditionals' do
+    it 'supports logical AND: &&' do
+      type "echo foo && echo bar"
+      enter
+      expect { output }.to have_printed(/foo.*\n.*bar/m)
+    end
+
+    it 'supports logical OR: &&' do
+      type "non-existent-command || echo bar"
+      enter
+      expect { error_output }.to have_printed(/yap: command not found: non-existent-command/m)
+      expect { output }.to have_printed(/bar/m)
+      clear_all_output
+
+      type "echo $?"
+      enter
+      expect { output }.to have_printed(/0/m)
+    end
+
+    it 'can combine logical AND and OR' do
+      type "(echo foo && non-existent-command) || echo bar"
+      enter
+      expect { error_output }.to have_printed(/yap: command not found: non-existent-command/m)
+      expect { output }.to have_printed(/foo.*\n.*bar/m)
+      clear_all_output
+
+      type "(echo foo || non-existent-command) && echo bar"
+      enter
+      expect { error_output }.to have_not_printed(/yap: command not found: non-existent-command/m)
+      expect { output }.to have_printed(/foo.*\n.*bar/m)
+      clear_all_output
+
+      type "(non-existent-command && echo foo) && echo bar"
+      enter
+      expect { error_output }.to have_printed(/yap: command not found: non-existent-command/m)
+      expect { output }.to have_not_printed(/foo.*\n.*bar/m)
+    end
+  end
+end

data/spec/features/first_time_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'Running Yap for the first time', type: :feature, forks: true do
+  before do
+    # do not pass in --skip-first-time
+    set_yap_command_line_arguments \
+      '--no-history', '--no-addons', '--no-rcfiles'
+
+    turn_on_debug_log(debug: 'editor')
+    reinitialize_shell
+  end
+
+  it 'tells the user it has been initialized' do
+    home_dir = tmp_dir.to_s
+    message = <<-EOT.gsub(/^\s*\|/, '').chomp
+      |Yap directory not found: #{home_dir}/.yap
+      |
+      |Initializing yap for the first time:
+      |
+      |    Creating #{home_dir}/.yap done
+      |    Creating default #{home_dir}/.yap/yaprc done
+      |
+      |To tweak yap take a look at #{home_dir}/.yap/yaprc.
+      |
+      |Reloading shell
+    EOT
+    expect { output }.to have_printed(message)
+  end
+
+  it 'creates a $HOME/.yap/ directory for yap things to go' do
+    expect { output }.to have_printed('Reloading shell')
+
+    dot_yap_dir = tmp_dir.join('.yap').to_s
+    expect(Dir.exist?(dot_yap_dir)).to be(true)
+  end
+
+  it 'creates a default .yap/yaprc rcfile' do
+    expect { output }.to have_printed('Reloading shell')
+
+    yaprc = tmp_dir.join('.yap/yaprc').to_s
+    templaterc = yap_dir.join('rcfiles/yaprc')
+    expect(File.exist?(yaprc)).to be(true)
+    expect(IO.read(yaprc)).to eq(IO.read(templaterc))
+  end
+end

data/spec/features/grouping_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe 'Grouping commands', type: :feature do
+  before do
+    write_executable_script 'pass', <<-SCRIPT.strip_heredoc
+      |#!/bin/sh
+      |echo pass $1
+      |exit 0
+    SCRIPT
+
+    write_executable_script 'fail', <<-SCRIPT.strip_heredoc
+      |#!/bin/sh
+      |echo fail $1
+      |exit 1
+    SCRIPT
+  end
+
+  describe 'using parentheses' do
+    it 'works with: (command1 && command2) || command3' do
+      type '(./pass 1 && ./fail 2) || ./pass 3'
+      enter
+      expect { output }.to have_printed(/pass 1.*fail 2.*pass 3/m)
+      clear_all_output
+
+      type '(./fail 1 && ./pass 2) || ./pass 3'
+      enter
+      expect { output }.to have_printed(/fail 1.*pass 3/m)
+      expect { output }.to have_not_printed(/pass 2/m)
+    end
+
+    it 'works with: (command1 && command2 && command3) || command4' do
+      type '(./pass 1 && ./fail 2 && ./pass 3) || ./pass 4'
+      enter
+      expect { output }.to have_printed(/pass 1.*fail 2.*pass 4/m)
+      expect { output }.to have_not_printed(/pass 1.*fail 2.*pass 3.*pass 4/m)
+      clear_all_output
+
+      type '(./fail 1 && ./pass 2 && ./pass 3) || ./pass 4'
+      enter
+      expect { output }.to have_printed(/fail 1.*pass 4/m)
+      expect { output }.to have_not_printed(/pass 2.*pass 3/m)
+    end
+
+    it 'works with: (command1 || command2) && command4' do
+      type '(./fail 1 || ./pass 2) && ./pass 3'
+      enter
+      expect { output }.to have_printed(/fail 1.*pass 2.*pass 3/m)
+
+      type '(./pass 1 || ./fail 2) && ./pass 3'
+      enter
+      expect { output }.to have_printed(/pass 1.*pass 3/m)
+      expect { output }.to have_not_printed(/fail 2/m)
+    end
+
+    it 'works with: (command1 && command2) && command4' do
+      type '(./fail 1 && ./pass 2) && ./pass 3'
+      enter
+      expect { output }.to have_printed(/fail 1/m)
+      expect { output }.to have_not_printed(/.*pass 2.*pass 3/m)
+      clear_all_output
+
+      type '(./pass 1 && ./fail 2) && ./pass 3'
+      enter
+      expect { output }.to have_printed(/pass 1.*fail 2/m)
+      expect { output }.to have_not_printed(/pass 3/m)
+    end
+
+    it 'works with: (command1 || command2) || command4' do
+      type '(./fail 1 || ./pass 2) || ./pass 3'
+      enter
+      expect { output }.to have_printed(/fail 1.*pass 2/m)
+      expect { output }.to have_not_printed(/pass 3/m)
+
+      type '(./pass 1 || ./fail 2) || ./pass 3'
+      enter
+      expect { output }.to have_printed(/pass 1/m)
+      expect { output }.to have_not_printed(/fail 2.*pass 3/m)
+    end
+  end
+
+end

data/spec/features/line_editing_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe 'Line editing', type: :feature do
+  let(:left_arrow) { [?\e, ?[, ?D].join }
+  let(:right_arrow) { [?\e, ?[, ?C].join }
+  let(:backspace){ [?\C-?].join }
+  let(:delete){ [?\e, ?[, ?3, ?~].join }
+
+  it 'Left/Right arrow keys move cursor one position left/right' do
+    # cursor is right the 'o'
+    type 'echo hli'
+
+    # let's fix this
+    type left_arrow
+    type left_arrow
+    type 'e'
+
+    type right_arrow
+    type right_arrow
+    type 'copter'
+    enter
+    expect { output }.to have_printed('helicopter')
+  end
+
+  it 'Backspace deletes one character left of the cursor, moving the cursor with it' do
+    type 'echo hello worfd'
+    type left_arrow
+    type backspace
+    type 'l'
+    enter
+    expect { output }.to have_printed('hello world')
+  end
+
+  it 'Delete deletes the character under the cursor, leaving the cursor where it is' do
+    type 'echo hello world'
+    6.times { type left_arrow }
+    6.times { type delete }
+    enter
+    expect { output }.to have_printed('hello')
+    expect { output }.to have_not_printed('world')
+  end
+
+  describe 'line navigation (default key bindings)' do
+    it 'Ctrl-a moves to beginning of line' do
+      type 'o hello world'
+      type ?\C-a
+      type 'ech'
+      enter
+      expect { output }.to have_printed('hello world')
+    end
+
+    it 'Ctrl-e moves to end of line' do
+      type 'o hello'
+      type ?\C-a
+      type 'ech'
+      type ?\C-e
+      type ' world'
+      enter
+      expect { output }.to have_printed('hello world')
+    end
+
+    it 'Ctrl-b moves backward one line at a time' do
+      type 'echo hello ld'
+      type ?\C-b
+      type 'wor'
+      enter
+      expect { output }.to have_printed(/^hello world/)
+      clear_all_output
+
+      type 'echo hello world' #, ?\C-b, ?\C-b, 'foo'].join
+      type ?\C-b
+      type ?\C-b
+      type 'foo '
+      enter
+      expect { output }.to have_printed(/^foo hello world/)
+    end
+
+    it 'Ctrl-f moves forward one word at a time' do
+      type 'echo hello world'
+      type ?\C-a
+      type ?\C-f
+      type 'bob says '
+      enter
+      expect { output }.to have_printed('bob says hello world')
+      clear_all_output
+
+      type 'echo hello world'
+      type ?\C-a
+      type ?\C-f
+      type ?\C-f
+      type 'foo '
+      enter
+      expect { output }.to have_printed('hello foo world')
+    end
+
+    it 'Ctrl-k kills text forward from the cursor position' do
+      type 'echo hello world'
+      type ?\C-b
+      type ?\C-k
+      enter
+      expect { output }.to have_printed('hello')
+      clear_all_output
+
+      type 'echo hello world'
+      type ?\C-b
+      type ?\C-b
+      type ?\C-k
+      type 'foo'
+      enter
+      expect { output }.to have_printed('foo')
+    end
+
+    it 'Ctrl-y does not insert when there is no killed text' do
+      type 'echo "hello world"'
+      type left_arrow
+      type ?\C-y
+      enter
+      expect { output }.to have_printed('hello world')
+      clear_all_output
+    end
+
+    it 'Ctrl-y inserts the last killed text where the cursor is' do
+      type 'echo hello world'
+      type ?\C-b
+      type ?\C-k
+      type 'delightful '
+      type ?\C-y
+      enter
+      expect { output }.to have_printed('hello delightful world')
+      clear_all_output
+    end
+
+    it 'Ctrl-w deletes a word backwards, adding it to the kill ring' do
+      type 'echo hello world'
+      type ?\C-w
+      enter
+      expect { output }.to have_printed('hello')
+      clear_all_output
+
+      type 'echo hello world'
+      type ?\C-w
+      type ?\C-w
+      type 'nope'
+      enter
+      expect { output }.to have_printed('nope')
+      expect { output }.to have_not_printed('hello world')
+
+      type 'echo '
+      type ?\C-y
+      enter
+      expect { output }.to have_printed('hello')
+      expect { output }.to have_not_printed('world')
+    end
+
+    it 'Ctrl-u deletes from the cursor to the beginning of the line, adding to the killing as ring' do
+      type 'echo hello world'
+      type ?\C-u
+      type 'echo '
+      type ?\C-y
+      enter
+      expect { output }.to have_printed('echo hello world')
+    end
+
+  end
+
+end

data/spec/features/range_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'Ranges', type: :feature do
+  describe 'line repetition: (M..N): statement' do
+    it 'runs the line N times' do
+      type '(0..2) : echo foo'
+      enter
+      expect { output }.to have_printed(/(.*foo){3}/m)
+    end
+  end
+
+  describe 'line repetition w/parameter: (M..N) as n: statement' do
+    it 'runs the line N times supplying an index' do
+      type '(0..2) as n: echo foo $n'
+      enter
+      expect { output }.to have_printed(/foo 0.*\n.*foo 1.*\n.*foo 2/m)
+    end
+  end
+
+  describe 'block repetition: (M..N) { statement } ; echo bar' do
+    it 'runs the block N times' do
+      type 'echo baz; (0..2) { echo foo } ; echo bar'
+      enter
+      expect { output }.to have_printed(/baz.*\n(.*foo){3}.*\n.*bar/m)
+    end
+  end
+
+  describe 'block repetition w/parameter: (M..N) { |n| statement }' do
+    it 'runs the block N times supplying an index' do
+      type 'echo baz ; (0..2) { |n| echo foo $n } ; echo bar'
+      enter
+      expect { output }.to have_printed(/baz.*\n.*foo 0.*\n.*foo 1.*\n.*foo 2.*\n.*bar/m)
+    end
+  end
+end