yap-shell 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87a1ed22865947c8ef75b2a16007dc72270dab7a
-  data.tar.gz: 38e78b4b608f6ec74c922472d6e965ef0fcccd1e
+  metadata.gz: 7186e70881e605ba5563cd30e9674030c55f4332
+  data.tar.gz: abbfa86bde0fabf472adca6a87843588e8760671
 SHA512:
-  metadata.gz: 66989ed7684b9327859f04c655991b49bbeefeb83706bb14889395e32b75d08ad81a6858d780ac78ad75bb0fc1a35b3b99b8467eac1275d35a51bdca114a65a8
-  data.tar.gz: ed9d4d26e65195606b817ac1f6c46d7ac490cf147cb6e74471e7ce192f41c7e5082ffba2e58e931b61fa83013dfc5f1bcc14b46c39389d24ef4d93159a2cd645
+  metadata.gz: 4498e667793d6009c6a988fd85b3977b7a01d79dee15565e71b9c6b10cc86a844263f9215205bf382e9ad152fde34589890d022a7bdb92d536204e3595df967f
+  data.tar.gz: fb6bff600285457f6aeea74c1fb5bf8d843dbba8b4a3b17c791b69ebd5dd93a5c1e2e0f7b7a660ed64afe468e49a3e2a73801a643d17fa811bfa6055ced9710f

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.3.1

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3.1
+cache: bundler
+gemfile: Gemfile.travis
+script:
+  - bundle exec rspec -fd spec
+notifications:
+  on_success: change
+  on_failure: always
+  on_start: false

data/Gemfile.travis

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'treefell', git: 'https://github.com/zdennis/treefell.git'
+gem 'yap-shell-parser', git: 'https://github.com/zdennis/yap-shell-parser.git'
+gem 'terminal-layout', git: 'https://github.com/zdennis/terminal-layout.git'
+gem 'yap-rawline', git: 'https://github.com/zdennis/rawline.git'

data/README.md

@@ -1,24 +1,22 @@
-# Yap
-
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/zdennis/yap-shell.svg?branch=master)](https://travis-ci.org/zdennis/yap-shell)
 
-## Installation
+# Yap
 
-Add this line to your application's Gemfile:
+Yap is a modern, developer shell. Inspired by shells like bash and zsh it's a modern implementation keeping the good parts and leaving out the rest.
 
-    gem 'yap-shell'
+See the slide deck that [introduces Yap](http://slides.com/zdennis/yaptastic-1#/)
 
-And then execute:
+## Installation
 
-    $ bundle
+This should not go in your Gemfile, you should install from the command line:
 
-Or install it yourself as:
+    > gem install yap-shell
 
-    $ gem install yap-shell
+Then follow the on-screen installation instructions.
 
 ## Usage
 
-TODO: Write usage instructions here
+See the Yap [shell reference](https://github.com/zdennis/yap-shell/wiki/ShellReference)
 
 ## Contributing
 

data/addons/history/history.rb

@@ -3,6 +3,7 @@ class History < Addon
   attr_reader :position
 
   def initialize_world(world)
+    return unless world.configuration.use_history?
     @world = world
 
     @file = world.configuration.path_for('history')

data/addons/history_search/history_search.rb

@@ -80,22 +80,7 @@ class HistorySearch < Addon
       if bytes.any?
         Treefell['shell'].puts "history search found bytes: #{bytes.inspect}"
 
-        # [1,2,3] => try 1,2,3 first ,then 1,2, then 1, then move on
-        nbytes = bytes.dup
-        search_bytes = []
-        loop do
-          if nbytes.empty?
-            break
-          elsif @keys[nbytes]
-            Treefell['shell'].puts "history search found key-binding for bytes=#{nbytes.inspect}"
-            @keys[nbytes].call
-            nbytes = search_bytes
-            search_bytes = []
-          else
-            search_bytes.unshift nbytes[-1]
-            nbytes = nbytes[0..-2]
-          end
-        end
+        search_bytes = process_bytes(bytes)
 
         if search_bytes.any?
           Treefell['shell'].puts "history searching with bytes=#{bytes.inspect}"
@@ -106,12 +91,31 @@ class HistorySearch < Addon
 
     private
 
+    # given [1,2,3] first try [1,2,3]. If no key binding
+    # matches, then try [1,2]. If no keybinding matches try [1].
+    # Execution should flow in left to right, positional order.
+    # This returns an array of left over bytes in the order they
+    # appeared that did not match any keybinding
+    def process_bytes bytes, leftover=[]
+      if bytes.empty?
+        leftover
+      elsif @keys[bytes]
+        @keys[bytes].call
+        leftover
+      else
+        process_bytes(
+          bytes[0..-2],
+          [bytes[-1]].concat(leftover)
+        )
+      end
+    end
+
     def accept
       @done_proc.call(execute: false, result: result)
     end
 
     def cancel
-      @done_proc.call(execute: false, result: result)
+      @done_proc.call(execute: false, result: nil)
     end
 
     def execute

data/bin/yap

@@ -1,58 +1,50 @@
 #!/usr/bin/env ruby
 
-if ENV['YAP_SHELL'] != 'active'
-  # Start YAP with a pristine environment
-  env2keep = {
-    # DISPLAY needs to be inherited in order to launch GUI apps
-    'DISPLAY' => ENV['DISPLAY'],
-    'HOME' => ENV['HOME'],
-    'PATH' => ENV['PATH'],
-
-    # For Yap's sanity
-    'RUBYOPT' => '-rubygems -EUTF-8',
-    'YAP_SHELL' => 'active',
-
-    # Inherit the user's preferred shell
-    'SHELL' => ENV['SHELL'],
-
-    # Necessary for ssh-agent
-    'SSH_AUTH_SOCK' => ENV['SSH_AUTH_SOCK'],
-
-    # DEBUG/TREEFELL_OUT are for debuging yap itself
-    'DEBUG' => ENV['DEBUG'],
-    'TREEFELL_OUT' => ENV['TREEFELL_OUT']
-  }
-
-  ENV.clear
-  env_params = env2keep.each_with_object([]) do |(key,value),arr|
-    next if value.nil?
-    arr << %|#{key}="#{value}"|
-  end.join(' ')
-
-  cmd = %|env -i #{env_params} #{File.expand_path(__FILE__)}|
-  exec cmd
-else
-  file = __FILE__
-  if File.symlink?(file)
-    file = File.readlink(file)
-  end
-
-  trap "SIGTSTP", "IGNORE"
-  trap "SIGINT", "IGNORE"
-  trap "SIGTTIN", "IGNORE"
-  trap "SIGTTOU", "IGNORE"
-
-  $LOAD_PATH.unshift File.dirname(file) + '/../lib'
-
-  ENV['TERM'] ||= 'linux'
-  ENV['YAP_SHELL'] = 'active'
-
-  require "term/ansicolor"
-  require "tins"
-  require "byebug"
-  require "pry"
-  require "yap"
-
-  STDOUT.sync = true
-  Yap.run_shell
+# Start YAP with a pristine environment
+env2keep = {
+  # DISPLAY needs to be inherited in order to launch GUI apps
+  'DISPLAY' => ENV['DISPLAY'],
+  'HOME' => ENV['HOME'],
+  'PATH' => ENV['PATH'],
+
+  # For Yap's sanity
+  'RUBYOPT' => '-rubygems -EUTF-8',
+
+  # Inherit the user's preferred shell
+  'SHELL' => ENV['SHELL'],
+
+  # Necessary for ssh-agent
+  'SSH_AUTH_SOCK' => ENV['SSH_AUTH_SOCK'],
+
+  # DEBUG/TREEFELL_OUT are for debuging yap itself
+  'DEBUG' => ENV['DEBUG'],
+  'TREEFELL_OUT' => ENV['TREEFELL_OUT']
+}
+
+ENV.clear
+env_params = env2keep.each_with_object([]) do |(key,value),arr|
+  # next if value.nil?
+  arr << %|#{key}="#{value}"|
+  ENV[key] = value
+end.join(' ')
+
+file = __FILE__
+if File.symlink?(file)
+  file = File.readlink(file)
 end
+
+trap "SIGTSTP", "IGNORE"
+trap "SIGINT", "IGNORE"
+trap "SIGTTIN", "IGNORE"
+trap "SIGTTOU", "IGNORE"
+
+$LOAD_PATH.unshift File.dirname(file) + '/../lib'
+
+ENV['TERM'] ||= 'linux'
+
+require "yap"
+
+STDOUT.sync = true
+STDERR.sync = true
+
+Yap.run_shell(ARGV)

data/bin/yap-dev

@@ -4,6 +4,5 @@ require 'bundler'
 Bundler.setup
 require 'pry'
 
-ENV['YAP_SHELL'] = 'active'
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 load File.dirname(__FILE__) + '/yap'

data/lib/yap/configuration.rb

@@ -11,6 +11,31 @@ module Yap
     attr_accessor :addon_paths
     attr_accessor :rcfiles
 
+    def self.option(name, type=nil, default: nil)
+      reader_method = name.to_s
+      define_method(reader_method) do
+        return default unless instance_variable_defined?("@#{name}")
+        value = instance_variable_get("@#{name}")
+        return !!value if type == :boolean
+        value
+      end
+
+      writer_method = "#{reader_method}="
+      define_method(writer_method) do |value|
+        instance_variable_set("@#{name}", value)
+      end
+
+      if type == :boolean
+        query_method = "#{reader_method}?"
+        alias_method query_method, reader_method
+      end
+    end
+
+    option :skip_first_time, :boolean, default: false
+    option :use_addons, :boolean, default: true
+    option :use_history, :boolean, default: true
+    option :use_rcfiles, :boolean, default: true
+
     def initialize
       @addon_paths = [
         "#{File.dirname(__FILE__)}/../../addons",

data/lib/yap/shell/builtins/alias.rb

@@ -4,6 +4,8 @@ module Yap::Shell
   require 'yap/shell/aliases'
 
   module Builtins
+    Color = ::Term::ANSIColor
+
     builtin :alias do |args:, stdout:, **kwargs|
       output = []
       if args.empty?
@@ -18,9 +20,23 @@ module Yap::Shell
       else
         name_eq_value = args.map(&:shellsplit).join(' ')
         name, command = name_eq_value.scan(/^(.*?)\s*=\s*(.*)$/).flatten
+        output << "Setting alias #{name} #{Color.green('done')}"
         Yap::Shell::Aliases.instance.set_alias name, command
       end
       stdout.puts output.join("\n")
     end
+
+    builtin :unalias do |args:, stdout:, **kwargs|
+      output = []
+      if args.empty?
+        output << "Usage: unalias <aliasname>"
+      else
+        args.each do |alias_name|
+          Yap::Shell::Aliases.instance.unset_alias alias_name
+          output << "Removing alias #{alias_name} #{Color.green('done')}"
+        end
+      end
+      stdout.puts output.join("\n")
+    end
   end
 end

data/lib/yap/shell/commands.rb

@@ -5,7 +5,6 @@ module Yap::Shell
   require 'yap/shell/execution/result'
 
   class CommandError < StandardError ; end
-  class CommandUnknownError < CommandError ; end
 
   class CommandFactory
     def self.build_command_for(world:, command:, args:, heredoc:, internally_evaluate:, line:)
@@ -14,9 +13,9 @@ module Yap::Shell
       case command
       when ShellCommand then ShellCommand.new(world:world, str:command, args:args, heredoc:heredoc, line:line)
       when BuiltinCommand then BuiltinCommand.new(world:world, str:command, args:args, heredoc:heredoc)
-      when FileSystemCommand  then FileSystemCommand.new(world:world, str:command, args:args, heredoc:heredoc)
+      when FileSystemCommand then FileSystemCommand.new(world:world, str:command, args:args, heredoc:heredoc)
       else
-        raise CommandUnknownError, "Don't know how to execute command: #{command}"
+        UnknownCommand.new(world:world, str:command, args:args, heredoc:heredoc)
       end
     end
   end
@@ -75,6 +74,19 @@ module Yap::Shell
     end
   end
 
+  class UnknownCommand < Command
+    EXIT_CODE = 127
+
+    def execute(stdin:, stdout:, stderr:)
+      stderr.puts "yap: command not found: #{str}"
+      EXIT_CODE
+    end
+
+    def type
+      :BuiltinCommand
+    end
+  end
+
   class FileSystemCommand < Command
     def self.world
       ::Yap::World.instance

data/lib/yap/shell/evaluation/shell_expansions.rb

@@ -39,7 +39,8 @@ module Yap::Shell
       private
 
       def env_expand(str)
-        str.gsub(/\$(\S+)/) do |match,*args|
+        # match "$a", "$a $b", "$a$b", "$cat$dog $foo"
+        str.gsub(/\$([^\$\s]+)/) do |match,*args|
           var_name = match[1..-1]
           if var_name == '?'
             (world.last_result ? world.last_result.status_code.to_s : '0').tap do |expanded|
@@ -60,17 +61,16 @@ module Yap::Shell
         if content
           expansions = content.split(",", -1)
 
-          # Be compatible with Bash/Zsh which only do word-expansion if there
-          # at least one comma listed. E.g. "a_{1,2}" => "a_1 a_2" whereas
-          # "a_{1}" => "a_{1}"
-          if expansions.length > 1
-            expanded = expansions.map { |expansion| str.sub(/\{([^\}]+)\}/, expansion) }.tap do |expanded|
-              Treefell['shell'].puts "shell-expansions expanding words in #{str} to #{expanded}"
-            end
-            return expanded
+          # Break compatibility with Bash/Zsh. They do not expand words
+          # when there is only one word supplied (e.g. "a_{word}"), but this
+          # is counter-intuitive to me. It should behave the same regardless
+          # of the number of words provided to expand.
+          expanded = expansions.map { |expansion| str.sub(/\{([^\}]+)\}/, expansion) }.tap do |expanded|
+            Treefell['shell'].puts "shell-expansions expanding words in #{str} to #{expanded}"
           end
+        else
+          [str]
         end
-        [str]
       end
 
       def process_expansions(expansions, escape_directory_expansions: true)

data/lib/yap/shell/evaluation.rb

@@ -158,7 +158,7 @@ module Yap::Shell
         values = []
         if node.head
           node.head.accept(self)
-          values = stdin.read.split(/\s+/)
+          values = stdin.read.split(/\n|\0/)
         else
           # assume range for now
           values = @current_range_values
@@ -327,10 +327,13 @@ module Yap::Shell
     def process_ArgumentNode(node)
       if node.single_quoted?
         debug_visit(node, 'single quoted argument, performing no expansion')
-        ["'#{node.lvalue}'"]
+        ["#{node.lvalue}"]
       elsif node.double_quoted?
         debug_visit(node, 'double quoted argument, performing variable expansion')
         [variable_expand(node.lvalue)]
+      elsif node.escaped?
+        debug_visit(node, 'escaped argument, skipping variable expansion')
+        [node.lvalue]
       else
         debug_visit(node, 'unquoted argument, performing shell expansion')
         shell_expand(node.lvalue, escape_directory_expansions: false)
@@ -388,16 +391,38 @@ module Yap::Shell
         case redirect.kind
         when "<"
           stdin = redirect.target
+          stdin = File.open(stdin, "rb") if stdin.is_a?(String)
         when ">", "1>"
           stdout = redirect.target
+          stdout = File.open(stdout, "wb") if stdout.is_a?(String)
         when "1>&2"
-          stderr = :stdout
+          stdout = redirect.target
+          stdout = File.open(stdout, "wb") if stdout.is_a?(String)
+          stderr = stdout
         when "2>"
           stderr = redirect.target
+          stderr = File.open(stderr, "wb") if stderr.is_a?(String)
         when "2>&1"
-          stdout = :stderr
+          stderr = redirect.target
+          stderr = File.open(stderr, "wb") if stderr.is_a?(String)
+          stdout = stderr
+        when "1>>", ">>"
+          stdout = redirect.target
+          stdout = File.open(stdout, "ab") if stdout.is_a?(String)
+        when "2>>"
+          stderr = redirect.target
+          stderr = File.open(stderr, "ab") if stderr.is_a?(String)
+        when "&>"
+          stdout = redirect.target
+          stdout = File.open(stdout, "wb") if stdout.is_a?(String)
+          stderr = stdout
+        when "&>>"
+          stdout = redirect.target
+          stdout = File.open(stdout, "ab") if stdout.is_a?(String)
+          stderr = stdout
         end
       end
+
       [stdin, stdout, stderr]
     end
 

data/lib/yap/shell/execution/context.rb

@@ -59,7 +59,8 @@ module Yap::Shell::Execution
             world:  world
           )
 
-          @saved_tty_attrs = Termios.tcgetattr(STDIN)
+          @saved_tty_attrs = Termios.tcgetattr(STDIN) if STDIN.isatty
+
           Treefell['shell'].puts "firing :before_execute for #{command}"
           self.class.fire :before_execute, world, command: command
 
@@ -90,7 +91,7 @@ module Yap::Shell::Execution
           self.class.fire :after_execute, world, command: command, result: result
 
           results << process_execution_result(execution_context:execution_context, result:result)
-          Termios.tcsetattr(STDIN, Termios::TCSANOW, @saved_tty_attrs)
+          Termios.tcsetattr(STDIN, Termios::TCSANOW, @saved_tty_attrs) if STDIN.isatty
         end
       end
 

data/lib/yap/shell/execution/file_system_command_execution.rb

@@ -27,16 +27,6 @@ module Yap::Shell::Execution
           # Set the process group of the forked to child to that of the
           Process.setpgrp
 
-          # Start a new process group as the session leader. Now we are
-          # responsible for sending signals that would have otherwise
-          # been propagated to the process, e.g. SIGINT, SIGSTOP, SIGCONT, etc.
-          stdin  = File.open(stdin, "rb") if stdin.is_a?(String)
-          stdout = File.open(stdout, "wb") if stdout.is_a?(String)
-          stderr = File.open(stderr, "wb") if stderr.is_a?(String)
-
-          stdout = stderr if stdout == :stderr
-          stderr = stdout if stderr == :stdout
-
           $stdin.reopen stdin
           $stdout.reopen stdout
           $stderr.reopen stderr
@@ -72,7 +62,7 @@ module Yap::Shell::Execution
       end
 
       # Set terminal's process group to that of the child process
-      Termios.tcsetpgrp STDIN, pid
+      Termios.tcsetpgrp STDIN, pid if STDIN.isatty
       pid, status = Process.wait2(pid, Process::WUNTRACED) if wait
 
       # If we're not printing to the terminal then close in/out/err. This
@@ -92,12 +82,14 @@ module Yap::Shell::Execution
       # if the pid that just stopped was the process group owner then
       # give it back to the us so we can become the foreground process
       # in the terminal
-      if pid == Termios.tcgetpgrp(STDIN)
-        Treefell['shell'].puts <<-DEBUG.gsub(/^\s*\|/, '')
-          |restoring process group for STDIN to yap process with pid=#{Process.pid}
-        DEBUG
-        Process.setpgid Process.pid, Process.pid
-        Termios.tcsetpgrp STDIN, Process.pid
+      if STDIN.isatty
+        if pid == Termios.tcgetpgrp(STDIN)
+          Treefell['shell'].puts <<-DEBUG.gsub(/^\s*\|/, '')
+            |restoring process group for STDIN to yap process with pid=#{Process.pid}
+          DEBUG
+          Process.setpgid Process.pid, Process.pid
+          Termios.tcsetpgrp STDIN, Process.pid
+        end
       end
 
       # if the reason we stopped is from being suspended

data/lib/yap/shell/repl.rb

@@ -38,14 +38,9 @@ module Yap::Shell
             line << more_input
             retry
           end
-        rescue ::Yap::Shell::CommandUnknownError => ex
-          Treefell['shell'].puts "rescued #{ex}, telling user"
-          puts "  CommandError: #{ex.message}"
         rescue ::Yap::Shell::Parser::ParseError => ex
           Treefell['shell'].puts "rescued #{ex}, telling user"
           puts "  Parse error: #{ex.message}"
-        ensure
-          @world.editor.reset_line
         end
 
         ensure_process_group_controls_the_tty
@@ -209,6 +204,8 @@ module Yap::Shell
     # if we haven't been made the process group controlling the TTY that we
     # become so. This method intentionally blocks.
     def ensure_process_group_controls_the_tty
+      return unless STDIN.isatty
+
       tty_pgrp = Termios.tcgetpgrp(STDIN)
       while ![Process.pid, Process.getpgrp].include?(tty_pgrp)
         Termios.tcsetpgrp(STDIN, Process.pid)

data/lib/yap/shell/version.rb

@@ -1,5 +1,5 @@
 module Yap
   module Shell
-    VERSION = "0.5.2"
+    VERSION = "0.6.0"
   end
 end

data/lib/yap/shell.rb

@@ -11,7 +11,6 @@ module Yap
 
     autoload :CommandFactory, "yap/shell/commands"
     autoload :CommandError,  "yap/shell/commands"
-    autoload :CommandUnknownError,  "yap/shell/commands"
     autoload :BuiltinCommand,  "yap/shell/commands"
     autoload :FileSystemCommand,  "yap/shell/commands"
     autoload :RubyCommand,  "yap/shell/commands"
@@ -102,7 +101,14 @@ module Yap
           @world.editor.puts "^C"
           retry
         rescue Exception => ex
-          binding.pry unless ex.is_a?(SystemExit)
+          if !ex.is_a?(SystemExit)
+            if $stdout.isatty
+              binding.pry
+            else
+              $stdout.puts ex.message
+              raise ex
+            end
+          end
         end
       end
     end

data/lib/yap/world.rb

@@ -33,24 +33,28 @@ module Yap
 
       # ensure yap directory exists
       if !File.exists?(configuration.yap_path)
-        puts
-        puts yellow("Yap directory not found: #{configuration.yap_path}")
-        puts
-        puts "Initializing yap for the first time:"
-        puts
-
-        print "    Creating #{configuration.yap_path} "
-        FileUtils.mkdir_p configuration.yap_path
-        puts green("done")
-
-        print "    Creating default #{configuration.preferred_yaprc_path} "
-        FileUtils.cp configuration.yaprc_template_path, configuration.yap_path
-        puts green("done")
-        puts
-        puts "To tweak yap take a look at #{configuration.preferred_yaprc_path}."
-        puts
-        puts "Reloading shell"
-        reload!
+        if configuration.skip_first_time?
+          # skipping first time
+        else
+          puts
+          puts yellow("Yap directory not found: #{configuration.yap_path}")
+          puts
+          puts "Initializing yap for the first time:"
+          puts
+
+          print "    Creating #{configuration.yap_path} "
+          FileUtils.mkdir_p configuration.yap_path
+          puts green("done")
+
+          print "    Creating default #{configuration.preferred_yaprc_path} "
+          FileUtils.cp configuration.yaprc_template_path, configuration.yap_path
+          puts green("done")
+          puts
+          puts "To tweak yap take a look at #{configuration.preferred_yaprc_path}."
+          puts
+          puts "Reloading shell"
+          reload!
+        end
       end
 
       @editor = RawLine::Editor.create(dom: dom)
@@ -147,6 +151,7 @@ module Yap
     end
 
     def foreground?
+      return unless STDIN.isatty
       Process.getpgrp == Termios.tcgetpgrp($stdout)
     end