rubyshell 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d144b65a358ed5bfc9fbb6a7c4e1f1dcc6ad90516f98a8787a07ab84a81943a7
-  data.tar.gz: 06f5260717bc2e232d0d82e231eee1ddf8aa33bd5f640d1de48f52649f2862be
+  metadata.gz: 71600c3dfe95d34a08ae287a966739973ec61f50510dab8c40a99bb4bc6941ad
+  data.tar.gz: 0b8869b6abd73e47bb9991e7b37d4b8c2a819a7126b506d951c41436449c4df6
 SHA512:
-  metadata.gz: 82ffc3ad85d2412d885bfb59fec0835964d1ff8b1d1bb2796d3c0a98d5421c8a8eb62ad7e6d19240b3d10446e72b3cbc72f4ed0ebef461f82a292037490f812b
-  data.tar.gz: 23d6b6f996ce1867dcbc6cb5e1714eb51d4ff49c5f84d0a629cfec01384c911c5c61d6f1e0e3510ba65497911685cee285ee5dc467865c62c46d95b2be3bd15e
+  metadata.gz: a5a707cc81ff623438bf32b2bf64c25a29fe2ebad7d6684ffe0900d64b911570553d3c647b9ea967c7c3b23c77a1a59d4db149783519283f3937f2ef2e8e243d
+  data.tar.gz: decee58de77cbbbe82586c16f4c3a1b92d4097598c38145eb7ea2b394bd6d2a0c4b7d83681f51d321084c687441e63a98094f552288c5bdbdfb6f93810b75df5

data/README.md

@@ -65,6 +65,15 @@ sh do
 end
 ```
 
+### Using without the block
+If you want to start an irb or pry session, and run commands as first-class citizens then do the following.
+
+```ruby
+extend RubyShell::Executor
+
+pwd # => /Users/albertalef/projects/rubyshell
+```
+
 ### Passing arguments
 Here we have different ways to pass arguments to a command.
 You can separate strings, use only one, use hashes, anyway will work
@@ -124,6 +133,17 @@ sh do
 end
 ```
 
+### Executing without a block
+The `sh` method can receive any method call, and execute shell commands
+
+```ruby
+sh.puts pwd # => /Users/albertalef/projects/rubyshell
+
+sh.cd 'examples'
+
+puts sh.pwd  # => /Users/albertalef/projects/rubyshell/examples
+```
+
 ## Complete example
 
 ```ruby

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "bundler/gem_tasks"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rubyshell"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rubyshell

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubyshell"
+
+if ARGV.first&.strip&.start_with? "exec"
+  extend RubyShell::Executor # rubocop:disable Style/MixinUsage
+
+  load(ARGV.last)
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rubyshell/chainer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "open3"
+
 module RubyShell
   class Chainer
     attr_reader :parts
@@ -31,7 +33,17 @@ module RubyShell
     end
 
     def exec_commands
-      `#{to_shell}`.chomp
+      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)
     end
 
     def to_shell

data/lib/rubyshell/command.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "open3"
+
 module RubyShell
   class Command
     def initialize(command_name, *args, &block)
@@ -13,11 +15,17 @@ module RubyShell
     end
 
     def exec_command
-      result = `#{to_shell}`.chomp
+      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
 
-      raise "Command Failed" unless $?.success?
+        StringWrapper.new(stdout.chomp)
+      end
+    rescue StandardError => e
+      raise e if e.is_a?(RubyShell::CommandError)
 
-      result
+      raise RubyShell::CommandError.new(command: to_shell, message: e.message)
     end
 
     def parsed_args
@@ -47,4 +55,14 @@ module RubyShell
       end.compact
     end
   end
+
+  class StringWrapper < String
+    def inspect
+      if $stdin.isatty
+        to_s
+      else
+        super
+      end
+    end
+  end
 end

data/lib/rubyshell/error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RubyShell
+  class CommandError < StandardError
+    def initialize(command:, stdout: "", stderr: "", status: "", message: nil)
+      @command = command
+      @stdout = stdout
+      @stderr = stderr
+      @status = status
+
+      super(message || (stderr.empty? ? stdout : stderr))
+    end
+  end
+end

data/lib/rubyshell/executor.rb

@@ -1,24 +1,20 @@
 # frozen_string_literal: true
 
 module RubyShell
-  class Executor
-    def self.cd(path, &block)
-      Dir.chdir(path, &block)
-    end
-
-    def self.chain(&block)
-      result = RubyShell::ChainContext.class_eval(&block).exec_commands
+  module Executor
+    module_function
 
-      raise "Command Failed" unless $?.success?
+    include RubyShell::OverwritedCommands
 
-      result
+    def chain(&block)
+      RubyShell::ChainContext.class_eval(&block).exec_commands
     end
 
-    def self.method_missing(method_name, *args)
+    def method_missing(method_name, *args)
       RubyShell::Command.new(method_name, *args).exec_command
     end
 
-    def self.respond_to_missing?(_name, _include_private)
+    def respond_to_missing?(_name, _include_private)
       false
     end
   end

data/lib/rubyshell/overwrited_commands.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RubyShell
+  module OverwritedCommands
+    def self.included(mod)
+      mod.extend self
+    end
+
+    def cd(path, &block)
+      Dir.chdir(path, &block)
+    end
+
+    def ls(*args)
+      method_missing(:ls, *args)
+    end
+  end
+end

data/lib/rubyshell/version.rb

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

data/lib/rubyshell.rb

@@ -4,7 +4,9 @@ require_relative "rubyshell/version"
 require_relative "rubyshell/command"
 require_relative "rubyshell/chainer"
 require_relative "rubyshell/chain_context"
+require_relative "rubyshell/overwrited_commands"
 require_relative "rubyshell/executor"
+require_relative "rubyshell/error"
 
 module Kernel
   def sh(&block)

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyshell
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - albertalef
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-01-19 00:00:00.000000000 Z
 dependencies: []
 description: A rubist way to run shell commands
 email:
@@ -20,12 +21,16 @@ files:
 - CHANGELOG.md
 - README.md
 - Rakefile
-- exe/rubyshell
+- bin/console
+- bin/rubyshell
+- bin/setup
 - lib/rubyshell.rb
 - lib/rubyshell/chain_context.rb
 - lib/rubyshell/chainer.rb
 - lib/rubyshell/command.rb
+- lib/rubyshell/error.rb
 - lib/rubyshell/executor.rb
+- lib/rubyshell/overwrited_commands.rb
 - lib/rubyshell/version.rb
 homepage: https://github.com/albertalef/rubyshell
 licenses:
@@ -36,6 +41,7 @@ metadata:
   source_code_uri: https://github.com/albertalef/rubyshell
   changelog_uri: https://github.com/albertalef/rubyshell
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,7 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: A rubist way to run shell commands
 test_files: []

data/exe/rubyshell

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "rubyshell"
-
-require "irb"
-
-IRB.start(__FILE__)