rash-command-shell 0.2.2 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d2870af889b41fda5f16c62f4f181c09ae843cc61ef4391596078c723c13269
-  data.tar.gz: 0e4e282af5b0940e63478b62985238e427969f2d95e7fccb6e25afc7f18f7c3b
+  metadata.gz: 00dbd88cd56e1de80255ce40b9a061048ae8ec96b70cb0dc5c36a78589e73c68
+  data.tar.gz: f31d65ea147f7c3fa5516d51b38e70c28fa3cadb482427393887f9d42ef34321
 SHA512:
-  metadata.gz: ca2658254fe315de5c6902a301d1a5d7f210e68630f9ac0677d811af697a2b334e6f185882d4ac8e725e56ee3e8dad777f8b09e7a5db9159914fb2dbecf9a589
-  data.tar.gz: 2820b7e820e1a28fdf87e898cc284b8c8a9be53193fd72047b61cc6036ba51eb2fa92e2b0dc687e73f258a8af7854a89320230bf349b71cc8d5d3e09ee46ca62
+  metadata.gz: e4194630eb9dbe5b1c4ad8afb9eb09e232b801eab51d06560cc1c41404d4202ade769c22a4da4f878f9d95ca213566635b90472e6c507e66578ddd2f465921f0
+  data.tar.gz: 5a12911de5b15ed865d14773b34b2a51f0efea3a3159bf29821eda79cf0ba7459429c7e4b1d95290cf03701745b4c914e4d9b8745906985e82a113f7be8351ab

data/bin/rash

@@ -4,7 +4,7 @@ if ARGV.empty?
   exec("irb", "-r", "rash", *ARGV)
 elsif ARGV[0] =~ /(-)?-v(ersion)?/
   puts "Rash (c) 2020 Kellen Watt"
-  puts "Version 0.2.2" # I may forget to update this
+  puts "Version 0.4.2" # I may forget to update this
 elsif File.exists?(ARGV[0]) && !File.directory?(ARGV[0])
   require "rash"
   file = ARGV.shift

data/lib/rash.rb

@@ -12,9 +12,24 @@ class Environment
     Dir.chdir(dir.nil? ? "~" : dir.to_s)
     @working_directory = Dir.pwd
     ENV["OLDPWD"] = old.to_s
+    ENV["PWD"] = Dir.pwd
     Dir.pwd
   end
-  
+
+  # Note that this works regardless of which version of chdir is used.
+  def push_dir(dir = nil)
+    @directory_stack.push(Dir.pwd)
+    self.chdir(dir)
+  end
+
+  def pop_dir
+    self.chdir(@directory_stack.pop) if @directory_stack.size > 0
+  end
+
+  def dirs
+    @directory_stack
+  end
+
   def add_path(path) 
     ENV["PATH"] += File::PATH_SEPARATOR + (path.respond_to?(:path) ? path.path : path.to_s)
   end
@@ -64,6 +79,10 @@ class Environment
     end
   end
 
+  def name?(v)
+    v.kind_of?(String) || v.kind_of?(Symbol)
+  end
+
   private
 
   def common_init
@@ -76,6 +95,8 @@ class Environment
 
     @active_pipelines = []
 
+    @directory_stack = []
+
     @prompt = {
       AUTO_INDENT: true,
       RETURN: ""
@@ -105,6 +126,7 @@ require_relative "rash/redirection"
 require_relative "rash/aliasing"
 require_relative "rash/jobcontrol"
 require_relative "rash/pipeline"
+require_relative "rash/capturing"
 
 $env = Environment.new
 
@@ -120,6 +142,17 @@ def cd(dir = nil)
   $env.chdir(d)
 end
 
+def pushd(dir = nil)
+  case dir
+  when File, Dir
+    dir = dir.path if File.directory(dir.path)
+  end
+  $env.push_dir(dir)
+end
+
+def popd
+  $env.pop_dir
+end
 
 def run(file, *args)
   filename = file.to_s
@@ -128,7 +161,6 @@ def run(file, *args)
     raise SystemCallError.new("No such executable file - #{exe}", Errno::ENOENT::Errno)
   end
   $env.dispatch(exe, *args, literal: true)
-  # system(exe, *args.flatten.map{|a| a.to_s}, {out: $stdout, err: $stderr, in: $stdin, umask: $env.umask})
 end
 
 alias cmd __send__
@@ -151,7 +183,7 @@ end
 
 
 def which(command)
-  cmd = File.expand_path(command)
+  cmd = File.expand_path(command.to_s)
   return cmd if File.executable?(cmd) && !File.directory?(cmd)
   
   exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
@@ -165,6 +197,11 @@ def which(command)
   nil
 end
 
+# This breaks some default IRB functionality
+# def self.respond_to_missing?(m, *args)
+#   
+#   which(m.to_s) || ($env.alias?(m) && !$env.aliasing_disabled) || $env.local_method?(m) || super
+# end
 
 # Note that I defy convention and don't define `respond_to_missing?`. This
 # is because doing so screws with irb.

data/lib/rash/capturing.rb

@@ -0,0 +1,45 @@
+class Environment
+  def capture_block(&block)
+    raise ArgumentError.new("no block provided") unless block_given?
+    result = nil
+    old_pipeline = @in_pipeline
+    begin
+      reader, writer = IO.pipe
+      self.stdout = writer
+      @in_pipeline = false
+      block.call
+    ensure
+      @in_pipeline = old_pipeline
+      reset_stdout
+      writer.close
+      result = reader.read
+      reader.close
+    end
+    result
+  end
+
+  def capture_command(m, *args)
+    raise NameError.new("no such command", m) unless which(m) || ($env.alias?(m) && !$env.aliasing_disabled)
+    result = nil
+    begin 
+      reader, writer = IO.pipe
+      system_command(m, *args, out: writer)
+    ensure
+      writer.close
+      result = reader.read
+      reader.close
+    end
+    result
+  end
+end
+
+# This explicitly doesn't support pipelining, as the output is ripped out of sequence.
+def capture(*cmd, &block)
+  if block_given?
+    $env.capture_block(&block)
+  elsif cmd.size > 0 && (which(cmd[0]) || ($env.alias?(m) && !$env.aliasing_disabled))
+    $env.capture_command(cmd[0].to_s, *cmd[1..])
+  else
+    raise ArgumentError.new("nothing to capture from")
+  end
+end

data/lib/rash/ext/filesystem.rb

@@ -6,30 +6,56 @@ class Environment
   def initialize
     common_init
     @working_directory = Directory.root("/") 
-    traverse_filetree("/", Dir.pwd)
   end
 
   def chdir(dir = nil)
     old = @working_directory
-    traverse_filetree(Dir.pwd, (dir.nil? ? "~" : dir.to_s))
+    traverse_filetree(@working_directory.to_s, (dir.nil? ? "~" : dir.to_s))
     ENV["OLDPWD"] = old.to_s
+    ENV["PWD"] = Dir.pwd
     Dir.pwd
   end
 
-  def local_def(name, &block)
-    @working_directory.add_local_method(name.to_sym, &block)
+  def local_def(name, locked: false, &block)
+    @working_directory.add_local_method(name, &block)
+    @working_directory.lock_method(name) if locked
+    name.to_sym
   end
 
   def local_undef(name)
-    @working_directory.clear_local_method(name.to_sym)
+    @working_directory.clear_local_method(name)
   end
 
   def local_method?(name)
-    @working_directory.local_methods.key?(name.to_sym)
+    @working_directory.local_method?(name)
+  end
+
+  def local_methods
+    @working_directory.local_methods
   end
 
   def local_call(name, *args, &block)
-    @working_directory.local_methods[name.to_sym].call(*args, &block)
+    @working_directory.local_method(name).call(*args, &block)
+  end
+
+  def local_var(name, v = nil, locked: false)
+    res = nil
+    if v.nil?
+      res = @working_directory.local_variable(name)
+    else
+      @working_directory.set_local_variable(name, v)
+      res = v
+    end
+    @working_directory.lock_variable(name) if locked
+    res
+  end
+  
+  def local_var?(name)
+    @working_directory.local_variable?(name)
+  end
+  
+  def local_vars
+    @working_directory.local_variables
   end
 
   private
@@ -65,7 +91,6 @@ class Environment
   end
 
   class Directory
-    attr_reader :local_methods
     attr_reader :parent, :children
 
     def self.root(dir)
@@ -76,9 +101,121 @@ class Environment
       @path = Dir.new(dir)
       @parent = parent
       @children = []
-      @local_methods = parent&.local_methods.dup || {}
+      @local_methods = {}
+      @locked_methods = []
+      @local_variables = {}
+      @locked_variables = []
+    end
+
+    ######################
+    # Local method methods
+    ######################
+
+    def local_method(name)
+      name = name.to_sym
+      @local_methods[name] || @parent&.unlocked_local_method(name)
+    end
+
+    def local_method?(name)
+      name = name.to_sym
+      @local_methods.key?(name) || !!@parent&.unlocked_local_method?(name)
+    end
+    
+    def local_methods
+      @local_methods.keys + (@parent&.unlocked_local_methods).to_a
+    end
+
+    def add_local_method(name, &block)
+      raise ArgumentError.new "no method body provided" unless block_given?
+      @local_methods[name.to_sym] = block # if name already exists, its function is overriden
+      name.to_sym
+    end
+
+    def unlocked_local_method(name)
+      name = name.to_sym
+      @local_methods[name] || @parent&.unlocked_local_method(name)
+    end
+
+    def unlocked_local_method?(name)
+      name = name.to_sym
+      @local_methods.filter{|k, v| !@locked_methods.include?(k)}.key?(name) ||
+        !!@parent&.unlocked_local_method?(name)
+    end
+
+    def unlocked_local_methods
+      @local_methods.filter{|k, v| !@locked_methods.include?(k)}.keys + (@parent&.unlocked_local_methods).to_a
+    end
+
+    def lock_method(name)
+      n = name.to_sym
+      raise NameError.new("#{name} is not a local method", n) unless @local_methods.key?(n)
+      @locked_methods << n unless @locked_methods.include?(n)
+      n
+    end
+
+    # might not be useful
+    def clear_local_method(name)
+      @local_methods.delete(name.to_sym)
+      name.to_sym
+    end
+
+    ######################
+    # Local variable stuff
+    ######################
+
+    def local_variable(name)
+      name = name.to_sym
+      @local_variables[name] || @parent&.unlocked_local_variable(name)
+    end
+    
+    def local_variable?(name)
+      @local_variables.include?(name.to_sym) || !!@parent&.unlocked_local_variable?(name.to_sym)
+    end
+    
+    def local_variables
+      @local_variables.keys + (@parent&.unlocked_local_variables).to_a
+    end
+    
+    def set_local_variable(name, value)
+      name = name.to_sym
+      if !@local_variables.key?(name) && @parent&.unlocked_local_variable?(name)
+        @parent&.set_local_variable(name, value)
+      else
+        @local_variables[name] = value
+      end
+    end
+    
+    def unlocked_local_variable(name)
+      name = name.to_sym
+      @local_variables.filter{|k| !@locked_variables.include?(k)}[name] || @parent&.unlocked_local_variable(name)
+    end
+
+    def unlocked_local_variables
+      @local_variables.keys.filter{|k| !@locked_variables.include?(k)} + (@parent&.unlocked_local_variables).to_a
     end
 
+    def unlocked_local_variable?(name)
+      name = name.to_sym
+      @local_variables.filter{|k,_v| !@locked_variables.include?(k)}.key?(name) ||
+        !!@parent&.unlocked_local_variable?(name)
+    end
+    
+    def lock_variable(name)
+      n = name.to_sym
+      raise NameError.new("#{name} is not a local variable", n) unless @local_variables.key?(n)
+      @locked_variables << n unless @locked_variables.include?(n)
+      n
+    end
+    
+    def clear_local_variable(name)
+      @local_variables.delete(name.to_sym)
+      name.to_sym
+    end
+
+    ###########################
+    # Generic traversal methods
+    ###########################
+
     def root?
       parent.nil?
     end
@@ -101,18 +238,6 @@ class Environment
       dir
     end
 
-    def add_local_method(name, &block)
-      raise ArgumentError.new "no method body provided" unless block_given?
-      @local_methods[name] = block # if name already exists, its function is overriden
-      name
-    end
-
-    # might not be useful
-    def clear_local_method(name)
-      @local_methods.delete(name)
-      name
-    end
-
     def to_s
       @path.path
     end
@@ -121,10 +246,9 @@ end
 
 # still could absolutely be more cleaned up, but it works
 def self.method_missing(m, *args, &block)
-  exe = which(m.to_s)
   if $env.local_method?(m)
     $env.local_call(m, *args, &block)
-  elsif exe || ($env.alias?(m) && !$env.aliasing_disabled)
+  elsif which(m.to_s) || ($env.alias?(m) && !$env.aliasing_disabled)
     $env.dispatch(m, *args)
   else
     super
@@ -132,3 +256,4 @@ def self.method_missing(m, *args, &block)
 end
 
 $env = Environment.new
+$env.chdir(Dir.pwd)

data/lib/rash/jobcontrol.rb

@@ -1,6 +1,6 @@
 class Environment
   def jobs
-    @active_jobs.keep_if {|pid| Process.kill(0, pid) rescue false}
+    @active_jobs.keep_if{|pid| Process.kill(0, pid) rescue false}.dup
   end
 
   def async(&block)

data/lib/rash/pipeline.rb

@@ -4,6 +4,10 @@ class Environment
     @in_pipeline
   end
 
+  def synced_pipeline?
+    @in_pipeline && @synchronous_pipeline
+  end
+
   def make_pipeline(&block) 
     raise IOError.new("pipelining already enabled") if @in_pipeline
     start_pipeline
@@ -14,9 +18,21 @@ class Environment
     end
     nil
   end
+
+  def make_sync_pipeline(&block)
+    raise IOError.new("pipelining already enabled") if @in_pipeline
+    start_sync_pipeline
+    begin
+      block.call
+    ensure
+      end_sync_pipeline
+    end
+    nil
+  end
   
   def as_pipe_command(&block)
     raise IOError.new("pipelining not enabled") unless @in_pipeline
+    return as_sync_pipe_command(&block) if @synchronous_pipeline
     
     input = (@active_pipelines.empty? ? $stdin : @active_pipelines.last.reader)
     @active_pipelines << Pipeline.new
@@ -38,28 +54,81 @@ class Environment
     nil
   end
 
+  def as_sync_pipe_command(&block)
+    raise IOError.new("pipelining not enabled") unless @in_pipeline
+    raise IOError.new("pipeline is not synchronous") unless @synchronous_pipeline
+   
+    @next_pipe.close
+    @next_pipe = Pipeline.new # flush the output pipe
+    @prev_pipe.writer.close
+
+    input = (@first_sync_command ? $stdin : @prev_pipe.reader)
+    @first_sync_command = false
+    output = @next_pipe.writer
+    error = ($stderr == $stdout ? @next_pipe.writer : $stdin)
+
+    pid = fork do
+      @in_pipeline = false
+      @synchronous_pipeline = false
+      $stdin = input
+      $stdout = output
+      $stderr = error
+      block.call
+      exit!(true)
+    end
+
+    Process.wait(pid)
+    @prev_pipe, @next_pipe = @next_pipe, @prev_pipe
+    nil
+  end
+
   private
   
   def start_pipeline
     @in_pipeline = true
   end
 
+  def start_sync_pipeline
+    @in_pipeline = true
+    @synchronous_pipeline = true
+    @first_sync_command = true
+    @prev_pipe = Pipeline.new
+    @next_pipe = Pipeline.new
+  end
+
   def end_pipeline
     raise IOError.new("pipelining not enabled") unless @in_pipeline
     @in_pipeline = false
     if @active_pipelines.size > 0
-      Process.wait(@active_pipelines.last.pid)
-      @active_pipelines.last.writer.close # probably redundant, but leaving it for now
-      IO.copy_stream(@active_pipelines.last.reader, $stdout)
-      @active_pipelines.pop.close
-      @active_pipelines.reverse_each {|pipe| pipe.terminate}
-      @active_pipelines.clear
+      begin
+        Process.wait(@active_pipelines.last.pid)
+        @active_pipelines.last.writer.close # probably redundant, but leaving it for now
+        IO.copy_stream(@active_pipelines.last.reader, $stdout)
+        @active_pipelines.pop.close
+        @active_pipelines.reverse_each {|pipe| pipe.terminate}
+      ensure
+        @active_pipelines.clear
+      end
     end
   end
 
+  def end_sync_pipeline
+    raise IOError.new("pipelining not enabled") unless @in_pipeline
+    raise IOError.new("pipeline is not synchronous") unless @synchronous_pipeline
+    @next_pipe.close
+    @prev_pipe.writer.close
+    IO.copy_stream(@prev_pipe.reader, $stdout)
+    @prev_pipe.close
+
+    @next_pipe = @prev_pipe = @first_sync_command = nil
+    @synchronous_pipeline = @in_pipeline = false
+  end
+
   # special method to be referenced from Environment#dispatch. Do not use directly
   def add_pipeline(m, *args)
     raise IOError.new("pipelining not enabled") unless @in_pipeline
+    return add_sync_pipeline(m, *args) if @synchronous_pipeline
+
     input = (@active_pipelines.empty? ? $stdin : @active_pipelines.last.reader)
     @active_pipelines << Pipeline.new
     output = @active_pipelines.last.writer
@@ -73,6 +142,23 @@ class Environment
     @active_pipelines.last.link_process(pid)
   end
 
+  def add_sync_pipeline(m, *args)
+    raise IOError.new("pipelining not enabled") unless @in_pipeline
+    raise IOError.new("pipeline is not synchronous") unless @synchronous_pipeline
+
+    # Ensure pipe is empty for writing
+    @next_pipe.close
+    @next_pipe = Pipeline.new
+    @prev_pipe.writer.close
+
+    input = (@first_sync_command ? $stdin : @prev_pipe.reader)
+    @first_sync_command = false
+    error = ($stderr == $stdout ? @next_pipe.writer : $stdin)
+    system_command(m, *args, out: @next_pipe.writer, input: input, err: error, except: true)
+    @prev_pipe, @next_pipe = @next_pipe, @prev_pipe
+    nil
+  end
+
   class Pipeline
     attr_reader :writer, :reader, :pid
 
@@ -92,7 +178,7 @@ class Environment
 
     def terminate
       self.close
-      Process.kill(:PIPE, @pid)
+      Process.kill(:TERM, @pid)
       Process.wait(@pid)
     end
 
@@ -103,6 +189,10 @@ class Environment
 end
 
 
-def in_pipeline(&block) 
-  $env.make_pipeline(&block)
+def in_pipeline(async: true, &block)
+  if async
+    $env.make_pipeline(&block)
+  else
+    $env.make_sync_pipeline(&block)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rash-command-shell
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.2
 platform: ruby
 authors:
 - Kellen Watt
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: A Ruby-based shell
+description: A Ruby-based command shell
 email:
 executables:
 - rash
@@ -34,6 +34,7 @@ files:
 - bin/rash
 - lib/rash.rb
 - lib/rash/aliasing.rb
+- lib/rash/capturing.rb
 - lib/rash/ext/filesystem.rb
 - lib/rash/jobcontrol.rb
 - lib/rash/pipeline.rb