rubyshell 1.3.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76b521dcdcb6c325a9b5bad95e4b5257e1c1f75068e04cfbab2b93943f97c829
-  data.tar.gz: 85ce6c941cf287d130b95db931330b8fce358410f6b5f2c9f8061ce904ca143b
+  metadata.gz: ef414945c6e9fc58ca5320103e4abf00d551737dffadd06e171e8ca37330752b
+  data.tar.gz: d1784dc8f6ba9a21ea7e0da4fbde153b4f2f6d980037b572e02fe3c8b86a2e49
 SHA512:
-  metadata.gz: 349e7fd9cfbec0aa350960f8e1f4e4913fc5fbf1b986a92cd8cd5898a77dce160705c5feeb61d57938fc1fc51535555e4320a9c89f4ae15412a34b67ac84dbf8
-  data.tar.gz: 9a851930f86e7bc7652102f4698ed637ea65497e719d893e169c3fa1703643d06f5807b1d0d465742ef987f4204892f07d653fbe744eb10396326c4b30fdc1a0
+  metadata.gz: a993d2b94f11e041a10dafb537a4bfb6395c3d06f81ed19da5cb3fb0b1a5e290d08fe310ee34592447aa90ce0910e714b35941c2bef78f1dbe0fa8abb7692348
+  data.tar.gz: 146e1d266782ea61c73776799d7beadce9fcba0e1659edcf253c85e5c9ae57f143a39e27479d12394ee469bf589185a218ebb007b6b2fd7a6782606ec20a67c9

data/bin/rubyshell

@@ -7,4 +7,12 @@ if ARGV.first&.strip&.start_with? "exec"
   extend RubyShell::Executor # rubocop:disable Style/MixinUsage
 
   load(ARGV.last)
+elsif ARGV.first&.strip&.start_with? "new"
+  file_name = "#{ARGV.last.gsub(".rb", "")}.rb" if ARGV.size > 1
+  file_name ||= "new_script.rb"
+
+  sh do
+    touch file_name
+    chmod "+x", file_name
+  end
 end

data/lib/rubyshell/chain_context.rb

@@ -2,6 +2,10 @@
 
 module RubyShell
   class ChainContext
+    def self.sh(command, *args)
+      method_missing(command, *args)
+    end
+
     def self.method_missing(method_name, *args, &block)
       RubyShell::Chainer.new(RubyShell::Command.new(method_name, *(args << { _manual: true }), &block))
     end

data/lib/rubyshell/chainer.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require "open3"
-
 module RubyShell
   class Chainer
     attr_reader :parts
 
-    def initialize(command)
+    def initialize(command, options = {})
       @parts = [command]
+      @options = options
     end
 
     def handle_chain(operator, chainer)
@@ -33,19 +32,11 @@ module RubyShell
     end
 
     def exec_commands
-      Open3.capture3(to_shell).then do |stdout, stderr, status|
-        unless status.success?
-          raise RubyShell::CommandError.new(command: to_shell, stdout: stdout, stderr: stderr, status: status)
-        end
-
-        stdout.chomp
-      end
-    rescue StandardError => e
-      raise e if e.is_a?(RubyShell::CommandError)
-
-      raise RubyShell::CommandError.new(command: to_shell, message: e.message)
+      RubyShell::TerminalExecutor.capture(to_shell, @options)
     end
 
+    alias exec exec_commands
+
     def to_shell
       parts.map do |part|
         if part.is_a?(RubyShell::Command)

data/lib/rubyshell/command.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-require "open3"
-
 module RubyShell
   class Command
+    attr_accessor :command_name, :options
+
     def initialize(command_name, *args, &block)
       @command_name = command_name
       @args = args
+      @options = extract_options(args)
       @block = block
     end
 
@@ -15,54 +16,69 @@ module RubyShell
     end
 
     def exec_command
-      Open3.capture3(to_shell).then do |stdout, stderr, status|
-        unless status.success?
-          raise RubyShell::CommandError.new(command: to_shell, stdout: stdout, stderr: stderr, status: status)
-        end
-
-        StringWrapper.new(stdout.chomp)
-      end
-    rescue StandardError => e
-      raise e if e.is_a?(RubyShell::CommandError)
-
-      raise RubyShell::CommandError.new(command: to_shell, message: e.message)
+      RubyShell::TerminalExecutor.capture(to_shell, @options)
     end
 
+    alias exec exec_command
+
     def parsed_args
       @args.map do |arg|
         case arg
         when Hash
           map_hash_arg(arg)
         else
-          arg.to_s
+          RubyShell::Sanitizer.sanitize_to_shell(arg.to_s)
         end
       end.flatten
     end
 
     private
 
+    def method_missing(method_name, *args, &block)
+      if method_name.start_with?(/[^A-Za-z0-9]/)
+        RubyShell::Chainer.new(self).send(method_name, *args, block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(_name, _include_private)
+      false
+    end
+
+    def extract_options(args)
+      args.reduce({}) do |acc, value|
+        next acc unless value.is_a?(Hash)
+
+        acc.merge(value)
+      end
+    end
+
     def map_hash_arg(arg)
       arg.map do |k, v|
         next if k.start_with?("_")
 
-        key = if k.length == 1
-                "-#{k}"
-              else
-                "--#{k}"
-              end
-
-        [key, v.is_a?(TrueClass) ? nil : "'#{v}'"].compact.join(" ")
+        if v.is_a?(Array)
+          v.map do |e|
+            map_hash_entry_to_string(k, e)
+          end.join(" ")
+        else
+          map_hash_entry_to_string(k, v)
+        end
       end.compact
     end
-  end
 
-  class StringWrapper < String
-    def inspect
-      if $stdin.isatty
-        to_s
-      else
-        super
-      end
+    def map_hash_entry_to_string(key, value)
+      key_string = if key.length == 1
+                     "-#{key}"
+                   else
+                     "--#{key}"
+                   end
+
+      [
+        key_string,
+        value.is_a?(TrueClass) ? nil : RubyShell::Sanitizer.sanitize_to_shell("'#{value}'")
+      ].compact.join(" ")
     end
   end
 end

data/lib/rubyshell/executor.rb

@@ -11,7 +11,13 @@ module RubyShell
     end
 
     def method_missing(method_name, *args)
-      RubyShell::Command.new(method_name, *args).exec_command
+      command = RubyShell::Command.new(method_name.to_s.gsub(/!$/, ""), *args)
+
+      if method_name.to_s.match?(/!$/)
+        command
+      else
+        command.exec_command
+      end
     end
 
     def respond_to_missing?(_name, _include_private)

data/lib/rubyshell/results/string_result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyShell
+  module Results
+    class StringResult < String
+      def inspect
+        if $stdin.isatty
+          to_s
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/rubyshell/sanitizer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RubyShell
+  module Sanitizer
+    SAFE_REGEX = /"/.freeze
+
+    # Inspired on https://github.com/ruby/shellwords/blob/master/lib/shellwords.rb
+    def self.sanitize_to_shell(string)
+      return unless string
+
+      raise ArgumentError, "NUL character" if string.index("\0")
+
+      string = string.to_s.dup
+
+      if string.match?(/\A(["'])(.*)\1\z/m)
+        inner = string[1..-2]
+
+        inner.gsub!(SAFE_REGEX) { |ch| "\\#{ch}" }
+
+        string.replace("\"#{inner}\"")
+      else
+        string.gsub!(SAFE_REGEX) { |ch| "\\#{ch}" }
+      end
+
+      string
+    end
+  end
+end

data/lib/rubyshell/terminal_executor.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module RubyShell
+  module TerminalExecutor
+    SELECT_TIMEOUT = Rational(1, 20).freeze
+
+    def self.capture(command, options) # rubocop:disable Metris/MethodLength,Metrics/CyclomaticComplexity,Metrix/AbcSize,Metrics/PerceivedComplexity
+      stdin_value = if options[:_stdin].is_a?(RubyShell::Command) || options[:_stdin].is_a?(RubyShell::Chainer)
+                      options[:_stdin].exec
+                    else
+                      options[:_stdin]
+                    end
+
+      Open3.popen3(command) do |stdin, stdout, stderr, w_thread|
+        stdin.write(stdin_value) if stdin_value
+
+        stdin.close
+
+        stdout.binmode
+        stderr.binmode
+
+        output = +""
+        error = +""
+        ios = { stdout => output, stderr => error }
+
+        status = nil
+
+        # What was my idea here:
+        # If has not any io readable and the program exited in the previous loop, stop
+        until ios.empty?
+          status ||= w_thread.join(0)
+
+          readable, = IO.select(ios.keys, nil, nil, 0)
+
+          break if !readable && status
+          next unless readable
+
+          readable.each do |io|
+            loop do
+              chunk = io.read_nonblock(4096, exception: false)
+              case chunk
+              when :wait_readable
+                break
+              when nil
+                ios.delete(io)
+                break
+              else
+                ios[io] << chunk
+              end
+            end
+          end
+        end
+
+        status = w_thread.value
+
+        if status && !status.success?
+          raise RubyShell::CommandError.new(
+            command: command,
+            stdout: output,
+            stderr: error,
+            status: status
+          )
+        end
+
+        RubyShell::Results::StringResult.new(output.chomp)
+      end
+    rescue StandardError => e
+      raise e if e.is_a?(RubyShell::CommandError)
+
+      raise RubyShell::CommandError.new(command: command, message: e.message)
+    end
+  end
+end

data/lib/rubyshell/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyShell
-  VERSION = "1.3.5"
+  VERSION = "1.4.0"
 end

data/lib/rubyshell.rb

@@ -7,13 +7,24 @@ require_relative "rubyshell/chain_context"
 require_relative "rubyshell/overwrited_commands"
 require_relative "rubyshell/executor"
 require_relative "rubyshell/error"
+require_relative "rubyshell/results/string_result"
+require_relative "rubyshell/terminal_executor"
+require_relative "rubyshell/sanitizer"
 
 module Kernel
-  def sh(&block)
-    if block.nil?
+  def sh(command = nil, *args, &block)
+    if command
+      RubyShell::Executor.send(command, *args)
+    elsif block.nil?
       RubyShell::Executor
     else
       RubyShell::Executor.class_eval(&block)
     end
   end
 end
+
+class String
+  def quoted
+    "\"#{self}\""
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyshell
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.4.0
 platform: ruby
 authors:
 - albertalef
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-20 00:00:00.000000000 Z
+date: 2026-01-23 00:00:00.000000000 Z
 dependencies: []
 description: A rubist way to run shell commands
 email:
@@ -31,6 +31,9 @@ files:
 - lib/rubyshell/error.rb
 - lib/rubyshell/executor.rb
 - lib/rubyshell/overwrited_commands.rb
+- lib/rubyshell/results/string_result.rb
+- lib/rubyshell/sanitizer.rb
+- lib/rubyshell/terminal_executor.rb
 - lib/rubyshell/tty/irb.rb
 - lib/rubyshell/version.rb
 homepage: https://github.com/albertalef/rubyshell