yap-shell 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70c4b7a17173c5d2f16dd2d318ad7fca64121c2b
-  data.tar.gz: f17c759ac10afbb5ed4d9bac3c47cdfc2e8590f8
+  metadata.gz: cca1d07b231bb416a8b295be3f63df4d343de0c9
+  data.tar.gz: 152bf268dedcba028e1f288a781f47fc818b780f
 SHA512:
-  metadata.gz: e998bdac5eccd88ff29438bed0dc970371453a11e300049988b328174940a179c94d3f3ce90e061500ff3c87022517baa7380ae7d88d41304c31c234d092fea9
-  data.tar.gz: 6c7b6164c54f5dc7a3a1cca6a2a78d15dd7a31af58782cb7a7f4b0ff57cce86d3893aa920d668d3f054602a48e80be5b7ef331ca1720af0ca637d766c2ee3e69
+  metadata.gz: 5fcb45c7edd79541be56467df065440dd90b723d8291733407c9bf76a63b896ec46a62278cd4acdb65064bcaf6e2fb97461e97ccdd3669434d5879f866078df9
+  data.tar.gz: e600e1906665cf39be024ec45dd1fc88ecc397ff898e81adb129b2e1392a0d837bbd47c716b15eb75be4e394addb769c0ec8bd425a223a05ae1abb5d846f7469

data/.gitignore

@@ -20,3 +20,5 @@ tmp
 *.o
 *.a
 mkmf.log
+
+wiki/

data/addons/history/history.rb

@@ -22,6 +22,7 @@ class History < Addon
   end
 
   def save
+    debug_log "saving history file=#{file.inspect}"
     File.open(file, "a") do |file|
       # Don't write the YAML header because we're going to append to the
       # history file, not overwrite. YAML works fine without it.
@@ -40,6 +41,7 @@ class History < Addon
   private
 
   def load_history
+    debug_log "loading history file=#{file.inspect}"
     at_exit { save }
 
     if File.exists?(file) && File.readable?(file)

data/addons/keyboard_macros/keyboard_macros.rb

@@ -1,6 +1,20 @@
 class KeyboardMacros < Addon
   require 'keyboard_macros/cycle'
 
+  module PrettyPrintKey
+    # ppk means "pretty print key". For example, it returns \C-g if the given
+    # byte is 7.
+    def ppk(byte)
+      if byte && byte.ord <= 26
+        '\C-' + ('a'..'z').to_a[byte.ord - 1]
+      else
+        byte.inspect
+      end
+    end
+  end
+
+  include PrettyPrintKey
+
   DEFAULT_TRIGGER_KEY = :ctrl_g
   DEFAULT_CANCEL_KEY = " "
   DEFAULT_TIMEOUT_IN_MS = 500
@@ -24,7 +38,29 @@ class KeyboardMacros < Addon
     @cancel_on_unknown_sequences = false
   end
 
+  def cancel_key=(key)
+    debug_log "setting default cancel_key key=#{ppk(key)}"
+    @cancel_key = key
+  end
+
+  def cancel_on_unknown_sequences=(true_or_false)
+    debug_log "setting default cancel_on_unknown_sequences=#{true_or_false}"
+    @cancel_on_unknown_sequences = true_or_false
+  end
+
+  def timeout_in_ms=(milliseconds)
+    debug_log "setting default timeout_in_ms milliseconds=#{milliseconds.inspect}"
+    @timeout_in_ms = milliseconds
+  end
+
+  def trigger_key=(key)
+    debug_log "setting default trigger_key key=#{ppk(key)}"
+    @trigger_key = key
+  end
+
   def configure(cancel_key: nil, trigger_key: nil, &blk)
+    debug_log "configure cancel_key=#{ppk(cancel_key)} trigger_key=#{ppk(trigger_key)} block_given?=#{block_given?}"
+
     cancel_key ||= @cancel_key
     trigger_key ||= @trigger_key
 
@@ -45,12 +81,18 @@ class KeyboardMacros < Addon
 
     world.unbind(trigger_key)
     world.bind(trigger_key) do
+      debug_log "macro triggered key=#{ppk(trigger_key)}"
+
       begin
         @previous_result = nil
         @stack << OpenStruct.new(configuration: configuration)
         configuration.start.call if configuration.start
+
+        debug_log "taking over keyboard input processing from editor"
         world.editor.keyboard_input_processors.push(self)
-        world.editor.input.wait_timeout_in_seconds = 0.1
+
+        wait_timeout_in_seconds = 0.1
+        world.editor.input.wait_timeout_in_seconds = wait_timeout_in_seconds
       ensure
         queue_up_remove_input_processor(&configuration.stop)
       end
@@ -60,6 +102,8 @@ class KeyboardMacros < Addon
   end
 
   def cycle(name, &cycle_thru_blk)
+    debug_log "defining cycle name=#{name.inspect}"
+
     @cycles ||= {}
     if block_given?
       cycle = KeyboardMacros::Cycle.new(
@@ -126,7 +170,6 @@ class KeyboardMacros < Addon
 
   def process_result(result)
     if result.is_a?(String)
-      $z.puts "WRITING: #{result}"
       @world.editor.write result, add_to_line_history: false
       @previous_result = result
     end
@@ -146,13 +189,17 @@ class KeyboardMacros < Addon
   end
 
   def cancel_processing
+    debug_log "cancel_processing"
     @event_id = nil
     @stack.reverse.each do |definition|
       definition.configuration.stop.call if definition.configuration.stop
     end
     @stack.clear
     if world.editor.keyboard_input_processors.last == self
+      debug_log "giving keyboard input processing control back"
       world.editor.keyboard_input_processors.pop
+
+      debug_log "restoring default editor input timeout"
       world.editor.input.restore_default_timeout
     end
   end
@@ -171,8 +218,14 @@ class KeyboardMacros < Addon
   end
 
   class Configuration
+    include PrettyPrintKey
+
     attr_reader :cancellation, :trigger_key, :keymap
 
+    def debug_log(*args)
+      KeyboardMacros.debug_log(*args)
+    end
+
     def initialize(cancellation: nil, editor:, keymap: {}, trigger_key: nil)
       @cancellation = cancellation
       @editor = editor
@@ -183,6 +236,8 @@ class KeyboardMacros < Addon
       @on_stop_blk = nil
       @cycles = {}
 
+      debug_log "configuring a macro trigger_key=#{ppk(trigger_key)}"
+
       if @cancellation
         define @cancellation.cancel_key, -> { @cancellation.call }
       end
@@ -199,6 +254,8 @@ class KeyboardMacros < Addon
     end
 
     def cycle(name, &cycle_thru_blk)
+      debug_log "defining a cycle on macro name=#{name.inspect}"
+
       if block_given?
         cycle = KeyboardMacros::Cycle.new(
           cycle_proc: cycle_thru_blk,
@@ -217,6 +274,7 @@ class KeyboardMacros < Addon
     end
 
     def define(sequence, result=nil, fragment: false, &blk)
+      debug_log "defining macro sequence=#{sequence.inspect} result=#{result.inspect} fragment=#{fragment.inspect} under macro #{ppk(trigger_key)}"
       unless result.respond_to?(:call)
         string_result = result
         result = -> { string_result }

data/addons/tab_completion/tab_completion.rb

@@ -26,6 +26,8 @@ class TabCompletion < Addon
     def to_s
       @text
     end
+    alias :to_str :to_s
+    alias :inspect :to_s
   end
 
   COMPLETIONS = [ BasicCompletion ]
@@ -69,6 +71,8 @@ class TabCompletion < Addon
     @display_procs = DISPLAY_PROCS.dup
 
     editor.on_word_complete do |event|
+      debug_log "on_word_complete event: #{event}"
+
       sub_word = event[:payload][:sub_word]
       word = event[:payload][:word]
       actual_completion = event[:payload][:completion]
@@ -98,6 +102,8 @@ class TabCompletion < Addon
     end
 
     editor.on_word_complete_no_match do |event|
+      debug_log "on_word_complete_no_match event: #{event}"
+
       sub_word = event[:payload][:sub_word]
       word = event[:payload][:word]
       editor.content_box.children = []
@@ -105,6 +111,8 @@ class TabCompletion < Addon
     end
 
     editor.on_word_complete_done do |event|
+      debug_log "on_word_complete_done event: #{event}"
+
       # TODO: add a better way to clear content
       editor.content_box.children = []
     end
@@ -112,15 +120,19 @@ class TabCompletion < Addon
 
   def add_completion(name, pattern, &blk)
     raise ArgumentError, "Must supply block!" unless block_given?
+    debug_log "NO-OP add_completion for name=#{name.inspect} pattern=#{pattern.inspect} block?=#{block_given?}"
     # @completions.push CustomCompletion.new(name:name, pattern:pattern, world:world, &blk)
   end
 
   def set_decoration(type, &blk)
     raise ArgumentError, "Must supply block!" unless block_given?
+    debug_log "set_decoration for type=#{name.inspect}"
     @style_procs[type] = blk
   end
 
   def complete(word, words, word_index)
+    debug_log "complete word=#{word.inspect} words=#{words.inspect} word_index=#{word_index.inspect}"
+
     matches = @completions.sort_by(&:priority).reverse.map do |completion|
       if completion.respond_to?(:call)
         completion.call
@@ -135,6 +147,7 @@ class TabCompletion < Addon
       end
     end.flatten
 
+    debug_log "complete possible matches are #{matches.inspect}"
     matches
   end
 

data/bin/yap-dev

@@ -4,9 +4,5 @@ require 'bundler'
 Bundler.setup
 require 'pry'
 
-$z = File.open("/tmp/z.log", "w+")
-$z.sync = true
-
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-
 load File.dirname(__FILE__) + '/yap'

data/lib/tasks/gem.rake

@@ -2,7 +2,7 @@ namespace :bump do
   namespace :version do
     class ProjectVersion
       FILE = File.dirname(__FILE__) + '/../yap/shell/version.rb'
-      PATTERN = /VERSION\s*=\s*"(\d+)\.(\d+)\.(\d+)"/m
+      PATTERN = /VERSION\s*=\s*['"](\d+)\.(\d+)\.(\d+)['"]/m
 
       def initialize(file=FILE, pattern=PATTERN)
         @file = file

data/lib/yap.rb

@@ -1,9 +1,12 @@
+require 'treefell'
+
 module Yap
   require 'yap/configuration'
   require 'yap/shell'
   require 'yap/world'
 
   def self.run_shell
+    Treefell['shell'].puts "#{self}.#{__callee__} booting shell"
     addons = [
       World::Addons.load_directories(configuration.addon_paths),
       World::Addons.load_rcfiles(configuration.rcfiles)

data/lib/yap/shell.rb

@@ -37,6 +37,8 @@ module Yap
         @stdout.sync = true
         @stderr.sync = true
 
+        addons_str = "\n  - " + addons.map(&:class).map(&:name).join("\n  - ")
+        Treefell['shell'].puts "Constructing world instance with addons: #{addons_str}"
         @world = Yap::World.instance(addons:addons)
       end
 
@@ -69,8 +71,16 @@ module Yap
         )
 
         @world.repl.on_input do |input|
+          Treefell['shell'].puts "repl received input: #{input.inspect}"
           evaluation = Yap::Shell::Evaluation.new(stdin:@stdin, stdout:@stdout, stderr:@stderr, world:@world)
           evaluation.evaluate(input) do |command, stdin, stdout, stderr, wait|
+            Treefell['shell'].puts <<-DEBUG.gsub(/^\s*\|/, '')
+              |adding #{command} to run in context of:
+              |  stdin: #{stdin.inspect}
+              |  stdout: #{stdout.inspect}
+              |  stderr: #{stderr.inspect}
+              |  wait for child process to complete? #{wait.inspect}
+            DEBUG
             context.clear_commands
             context.add_command_to_run command, stdin:stdin, stdout:stdout, stderr:stderr, wait:wait
 
@@ -81,12 +91,14 @@ module Yap
         end
 
         begin
+          Treefell['shell'].puts "enter interactive mode"
           @world.interactive!
         # rescue Errno::EIO => ex
         #   # This happens when yap is no longer the foreground process
         #   # but it tries to receive input/output from the tty. I believe it
         #   # is a race condition when launching a child process.
         rescue Interrupt
+          Treefell['shell'].puts "^C"
           @world.editor.puts "^C"
           retry
         rescue Exception => ex

data/lib/yap/shell/aliases.rb

@@ -7,6 +7,7 @@ module Yap::Shell
     def initialize
       @file = ENV["HOME"] + "/.yapaliases.yml"
       @aliases = begin
+        Treefell['shell'].puts "reading aliases from disk: #{@file}"
         YAML.load_file(@file)
       rescue
         {}
@@ -18,16 +19,21 @@ module Yap::Shell
     end
 
     def fetch_alias(name)
-      @aliases[name]
+      @aliases[name].tap do |contents|
+        Treefell['shell'].puts "alias fetched name=#{name} contents=#{contents.inspect}"
+      end
     end
 
-    def set_alias(name, command)
-      @aliases[name] = command
-      File.write @file, @aliases.to_yaml
+    def set_alias(name, contents)
+      @aliases[name] = contents
+      Treefell['shell'].puts "alias set name=#{name} to #{contents.inspect}"
+      write_to_disk
     end
 
     def unset_alias(name)
       @aliases.delete(name)
+      Treefell['shell'].puts "alias unset name=#{name}"
+      write_to_disk
     end
 
     def has_key?(key)
@@ -40,5 +46,13 @@ module Yap::Shell
         h
       end
     end
+
+    private
+
+    def write_to_disk
+      File.write(@file, @aliases.to_yaml).tap do
+        Treefell['shell'].puts "aliases written to disk: #{@file}"
+      end
+    end
   end
 end

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

@@ -16,7 +16,7 @@ module Yap::Shell
         end
         output << ""
       else
-        name_eq_value = args.first
+        name_eq_value = args.map(&:shellsplit).join(' ')
         name, command = name_eq_value.scan(/^(.*?)\s*=\s*(.*)$/).flatten
         Yap::Shell::Aliases.instance.set_alias name, command
       end

data/lib/yap/shell/commands.rb

@@ -33,6 +33,12 @@ module Yap::Shell
       @line = line
     end
 
+    def to_s
+      "#{self.class.name}(#{str.inspect})"
+    end
+    alias :to_str :to_s
+    alias :inspect :to_s
+
     def to_executable_str
       raise NotImplementedError, ":to_executable_str must be implemented by including object."
     end
@@ -90,6 +96,12 @@ module Yap::Shell
       :FileSystemCommand
     end
 
+    def to_s
+      "#{self.class.name}(#{to_executable_str.inspect})"
+    end
+    alias :to_str :to_s
+    alias :inspect :to_s
+
     def to_executable_str
       [
         str,

data/lib/yap/shell/evaluation.rb

@@ -14,22 +14,39 @@ module Yap::Shell
 
     def evaluate(input, &blk)
       @blk = blk
+      debug_log "evaluation begins input=#{input.inspect}"
       @input = recursively_find_and_replace_command_substitutions(input)
+      debug_log "recursive find/replace command substitutions results in input=#{@input.inspect}"
       ast = Parser.parse(@input)
-      ast.accept(self)
+      debug_log "parsed input into AST: #{ast}"
+      debug_log "beginning to walk AST"
+      ast.accept(self).tap do
+        debug_log "done walking AST"
+      end
     end
 
     def set_last_result(result)
+      debug_log "evaluation setting last result=#{result.inspect}"
       @world.last_result = result
     end
 
     private
 
+    def debug_log(message)
+      Treefell['shell'].puts message
+    end
+
+    def debug_visit(node, msg='')
+      calling_method = caller[0][/`.*'/][1..-2]
+      debug_log "evaluation #{calling_method} node=#{node} #{msg}"
+    end
+
     # +recursively_find_and_replace_command_substitutions+ is responsible for recursively
     # finding and expanding command substitutions, in a depth first manner.
     def recursively_find_and_replace_command_substitutions(input)
       input = input.dup
       Parser.each_command_substitution_for(input) do |substitution_result, start_position, end_position|
+        debug_log "found command substitution at position=#{(start_position..end_position)} #{substitution_result.inspect}"
         result = recursively_find_and_replace_command_substitutions(substitution_result.str)
         position = substitution_result.position
         ast = Parser.parse(result)
@@ -37,7 +54,19 @@ module Yap::Shell
           r,w = IO.pipe
           @stdout = w
           ast.accept(self)
-          input[position.min...position.max] = r.read.chomp
+
+          output = r.read.chomp
+
+          # Treat consecutive newlines in output as a single space
+          output = output.gsub(/\n+/, ' ')
+
+          # Double quote the output and escape any double quotes already
+          # existing
+          output = %|"#{output.gsub(/"/, '\\"')}"|
+
+          # Put thd output back into the original input
+          debug_log "replacing command substitution at position=#{(position.min...position.max)} with #{output.inspect}"
+          input[position.min...position.max] = output
         end
       end
       input
@@ -51,11 +80,13 @@ module Yap::Shell
     ######################################################################
 
     def visit_CommandNode(node)
+      debug_visit(node)
       @aliases_expanded ||= []
       @command_node_args_stack ||= []
       with_standard_streams do |stdin, stdout, stderr|
         args = process_ArgumentNodes(node.args)
-        if !node.literal? && !@aliases_expanded.include?(node.command) && _alias=Aliases.instance.fetch_alias(node.command)
+        if !node.literal? && !@aliases_expanded.include?(node.command) && Aliases.instance.has_key?(node.command)
+          _alias=Aliases.instance.fetch_alias(node.command)
           @suppress_events = true
           @command_node_args_stack << args
           ast = Parser.parse(_alias)
@@ -66,7 +97,7 @@ module Yap::Shell
         else
           cmd2execute = variable_expand(node.command)
           final_args = (args + @command_node_args_stack).flatten.map(&:shellescape)
-          expanded_args = shell_expand(final_args)
+          expanded_args = final_args
           command = CommandFactory.build_command_for(
             world: world,
             command: cmd2execute,
@@ -82,10 +113,12 @@ module Yap::Shell
     end
 
     def visit_CommentNode(node)
+      debug_visit(node)
       # no-op, do nothing
     end
 
     def visit_RangeNode(node)
+      debug_visit(node)
       range = node.head.value
       if node.tail
         @current_range_values = range.to_a
@@ -97,6 +130,7 @@ module Yap::Shell
     end
 
     def visit_RedirectionNode(node)
+      debug_visit(node)
       filename = node.target
 
       if File.directory?(filename)
@@ -114,6 +148,8 @@ module Yap::Shell
     end
 
     def visit_BlockNode(node)
+      debug_visit(node)
+
       with_standard_streams do |stdin, stdout, stderr|
         # Modify @stdout and @stderr for the first command
         stdin, @stdout = IO.pipe
@@ -150,10 +186,10 @@ module Yap::Shell
           end
         end
       end
-
     end
 
     def visit_NumericalRangeNode(node)
+      debug_visit(node)
       node.range.each do |n|
         if node.tail
           if node.reference
@@ -169,6 +205,7 @@ module Yap::Shell
     end
 
     def visit_StatementsNode(node)
+      debug_visit(node)
       Yap::Shell::Execution::Context.fire :before_statements_execute, @world unless @suppress_events
       node.head.accept(self)
       if node.tail
@@ -194,9 +231,10 @@ module Yap::Shell
     #    5
     #
     def visit_EnvWrapperNode(node)
+      debug_visit(node)
       with_env do
         node.env.each_pair do |env_var_name, arg_node|
-          world.env[env_var_name] = process_ArgumentNode(arg_node)
+          world.env[env_var_name] = process_EnvArgumentNode(arg_node)
         end
         node.node.accept(self)
       end
@@ -213,13 +251,15 @@ module Yap::Shell
     # they cleared or overridden.
     #
     def visit_EnvNode(node)
+      debug_visit(node)
       node.env.each_pair do |key, arg_node|
-        world.env[key] = process_ArgumentNode(arg_node)
+        world.env[key] = process_EnvArgumentNode(arg_node)
       end
       Yap::Shell::Execution::Result.new(status_code:0, directory:Dir.pwd, n:1, of:1)
     end
 
     def visit_ConditionalNode(node)
+      debug_visit(node)
       case node.operator
       when '&&'
         node.expr1.accept self
@@ -237,6 +277,8 @@ module Yap::Shell
     end
 
     def visit_PipelineNode(node, options={})
+      debug_visit(node)
+
       with_standard_streams do |stdin, stdout, stderr|
         # Modify @stdout and @stderr for the first command
         stdin, @stdout = IO.pipe
@@ -260,6 +302,8 @@ module Yap::Shell
     end
 
     def visit_InternalEvalNode(node)
+      debug_visit(node)
+
       command = CommandFactory.build_command_for(
         world: world,
         command: node.command,
@@ -281,10 +325,31 @@ module Yap::Shell
     end
 
     def process_ArgumentNode(node)
-      if node.quoted?
-        variable_expand(node.lvalue)
+      if node.single_quoted?
+        debug_visit(node, 'single quoted argument, performing no expansion')
+        ["'#{node.lvalue}'"]
+      elsif node.double_quoted?
+        debug_visit(node, 'double quoted argument, performing variable expansion')
+        [variable_expand(node.lvalue)]
       else
-        shell_expand(node.lvalue, escape_directory_expansions: false).first
+        debug_visit(node, 'unquoted argument, performing shell expansion')
+        shell_expand(node.lvalue, escape_directory_expansions: false)
+      end
+    end
+
+    # process_EnvArgumentNode is separate from process_ArgumentNode since
+    # it doesn't allow full shell expansion. For example, the following
+    # will not be expanded to "FOO=a_1 a_2", it will be stored as provided:
+    #
+    #   > FOO=a_{1,2}
+    #
+    def process_EnvArgumentNode(node)
+      if node.single_quoted?
+        debug_visit(node, 'single quoted argument, performing no expansion')
+        node.lvalue
+      else
+        debug_visit(node, 'not singled quoted argument, performing variable expansion')
+        variable_expand(node.lvalue)
       end
     end
 
@@ -316,6 +381,8 @@ module Yap::Shell
     end
 
     def stream_redirections_for(node)
+      debug_visit(node)
+
       stdin, stdout, stderr = @stdin, @stdout, @stderr
       node.redirects.each do |redirect|
         case redirect.kind