rubyshell 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92236debc6db9910906ad252418dba0a4ac9ddf0daf38db48da5e1e4c32271de
-  data.tar.gz: bea76bd0b7facd9c3f17a1183a9f4a879a03010993be67ac10fc0801ddd3e8bc
+  metadata.gz: 3dc52bfe0cf67de6392904a19c61eecd1ba03d309ed0b71fe7c9f62c43a99389
+  data.tar.gz: 99ec7930b2fb5223efe6533fee5357ea1a18ee8501267479157d533e9be687e5
 SHA512:
-  metadata.gz: f6bc249bfb8be17588835d14ed078479454f0c233b0f37858462c7031455ace9469e226bae1acbee9a557675dba3631316101179163e9fca567e03a23e7f446c
-  data.tar.gz: 4222c04f51a013f242331a5679578fbb1cd40daafa8f8dba11c53ab7c76658a28f7104909987511fdb1a557a0a5140b22424eee79b599d635056a7f028bf9382
+  metadata.gz: f44145f622774e54812697bb03a16e06f5b1a5f4dedbe3832879af9f500144a1b81a67424a0567b0a738efa713c5d849321f58ba6281fe8c2d573e53d04343b3
+  data.tar.gz: 6b213e46dd112c32449cfab374cafefaa41265dfdc4b32152bfeac6757757266bdb56e81dc975f9c816c8818edc1d5533e28bebacdda510310f2fb43c7a2b83b

data/README.md

@@ -11,41 +11,39 @@
   <a href="https://rubygems.org/gems/rubyshell">
     <img src="https://img.shields.io/gem/dt/rubyshell.svg?label=Downloads&colorA=004d99&colorB=0073e6" alt="Gem Version">
   </a>
-  <a href="https://github.com/albertalef/rubysh/actions">
-    <img src="https://github.com/albertalef/rubysh/workflows/CI/badge.svg" alt="Build Status">
+  <a href="https://github.com/albertalef/rubyshell/actions/workflows/main.yml">
+    <img src="https://github.com/albertalef/rubyshell/actions/workflows/main.yml/badge.svg" alt="Build Status">
   </a>
   <a href="https://opensource.org/licenses/MIT">
     <img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License">
   </a>
 
   <p align="center">
-    <a href="Examples">Examples</a>
+    <a href="#installation">Installation</a>
     ·
-    <a href="Instalation">Instalation</a>
+    <a href="#usage">Usage</a>
     ·
-    <a href="Documentation">Documentation</a>
+    <a href="#complete-example">Examples</a>
     ·
-    <a href="Contributing">Contributing</a>
+    <a href="#contributing">Contributing</a>
+    ·
+    <a href="#sponsors">Sponsors</a>
   </p>
 </p>
 <br />
 <br />
 
 ```ruby
-cd "/log" do
-  ls.each_line do |line|
-    puts cat(line)
+  cd "/log" do
+    ls.each_line do |line|
+      puts cat(line)
+    end
   end
-end
 ```
 
 Yes, that’s valid Ruby!
 `ls` and `cat` are just shell commands, but **RubyShell** makes them behave like Ruby methods.
 
-## Usage
-
-
-
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -56,12 +54,119 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install rubyshell
 
-## Todo
+## Usage
+
+### Calling a shell command
+With RubyShell, every shell command can be used inside the ruby, you just need to call
+
+```ruby
+sh do
+  puts pwd # => /Users/albertalef/projects/rubyshell
+end
+```
+
+### 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
+
+```ruby
+sh do
+  docker("ps", all: true) # Using hash syntax = docker ps --all
+
+  docker("ps", a: true) # Using hash syntax = docker ps -a
+
+  docker("ps", '-a') # Passing multiple strings = docker ps -a
+
+  docker("ps -a") # Passing one string = docker ps -a
+end
+```
+
+### Changing folder
+Has two possible ways, changing the folder of the code, or running code only inside a folder 
+
+##### Chaging code folder
+```ruby
+sh do
+  puts pwd # => /Users/albertalef/projects/rubyshell
+
+  cd 'examples'
+
+  puts pwd  # => /Users/albertalef/projects/rubyshell/examples
+end
+```
+
+##### Executing code inside another folder
+
+```ruby
+sh do
+  cd 'examples' do
+    puts pwd  # => /Users/albertalef/projects/rubyshell/examples
+  end
+
+  puts pwd  # => /Users/albertalef/projects/rubyshell
+end
+```
+
+### Chaining commands
+The `chain` method make possible we use shell operators inside the ruby, like `& && | > >> < <<`
+
+```ruby
+sh do
+  chain { echo "Dummy text" >> "dummy.txt" }
+  
+  puts cat("dummy.txt") # => "Dummy text"
+end
+
+sh do
+  number_of_files = chain { ls | wc('-l') }.chomp
+
+  puts number_of_files # => 5
+end
+```
+
+## Complete example
+
+```ruby
+#!/usr/bin/env ruby
+
+require "rubyshell"
+require "securerandom"
+
+sh do
+  mkdir "files"
+
+  cd "files" do
+    5.times do |i|
+      chain do
+        echo(SecureRandom.alphanumeric(16)) >> "#{i}.txt"
+      end
+    end
+
+    puts "Number of Files: #{ls.lines.count}"
+
+    ls.each_line do |filename|
+      puts cat(filename)
+    end
+  end
+ensure
+  rm "-rf files"
+end
+
+# Running:
+#
+# ❯ ./examples/example1.rb
+#
+# Number of Files: 5
+# o6Kw8KHvWJnLGSeQ
+# qkRKcZHqu2Moq1se
+# nUPluln9GM1ydtoz
+# rkdYsc1RBhkeN1dq
+# ZPXZMqzYfyFfjPHF
+```
+
+## Coming
 
-- [ ] Usage
-- [ ] More examples
-- [ ] Tests
-- [ ] Github Action
+- Support to Streams
 
 ## Development
 

data/lib/rubyshell/chain_context.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 
 module RubyShell
   class ChainContext
-    def self.method_missing(method_name, *args, &)
-      RubyShell::Chainer.new(RubyShell::Command.new(method_name, *(args << {_manual: true}), &))
+    def self.method_missing(method_name, *args, &block)
+      RubyShell::Chainer.new(RubyShell::Command.new(method_name, *(args << { _manual: true }), &block))
     end
 
-    def self.respond_to_missing?(name, _include_private)
+    def self.respond_to_missing?(_name, _include_private)
       false
     end
   end

data/lib/rubyshell/chainer.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
 
 module RubyShell
   class Chainer
+    attr_reader :parts
+
     def initialize(command)
       @parts = [command]
     end
@@ -9,13 +12,13 @@ module RubyShell
       @parts = [
         *@parts,
         operator.to_s,
-        *(chainer.is_a?(RubyShell::Chainer) ? chainer.parts : chainer),
+        *(chainer.is_a?(RubyShell::Chainer) ? chainer.parts : chainer)
       ]
 
       self
     end
 
-    def method_missing(method_name, *args, &)
+    def method_missing(method_name, *args, &block)
       if method_name.start_with?(/[^A-Za-z0-9]/)
         handle_chain(method_name, args.first)
       else
@@ -23,16 +26,12 @@ module RubyShell
       end
     end
 
-    def respond_to_missing?(name, _include_private)
+    def respond_to_missing?(_name, _include_private)
       false
     end
 
     def exec_commands
-      %x{#{to_shell}}.chomp
-    end
-
-    def parts
-      @parts
+      `#{to_shell}`.chomp
     end
 
     def to_shell

data/lib/rubyshell/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyShell
   class Command
     def initialize(command_name, *args, &block)
@@ -22,21 +24,27 @@ module RubyShell
       @args.map do |arg|
         case arg
         when Hash
-          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(" ")
-          end.compact
+          map_hash_arg(arg)
         else
           arg.to_s
         end
       end.flatten
     end
+
+    private
+
+    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(" ")
+      end.compact
+    end
   end
 end

data/lib/rubyshell/executor.rb

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

data/lib/rubyshell/version.rb

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

data/lib/rubyshell.rb

@@ -8,30 +8,10 @@ require_relative "rubyshell/executor"
 
 module Kernel
   def sh(&block)
-    if !block.nil?
-      RubyShell::Executor.class_eval(&block)
-    else
+    if block.nil?
       RubyShell::Executor
-    end
-  end
-
-  def sh_unsafe_mode(value)
-    @sh_unsafe_mode = value
-  end
-
-  def cd(path, &)
-    Dir.chdir(path, &)
-  end
-
-  def method_missing(method_name, *args, &)
-    if @sh_unsafe_mode
-      RubyShell::Executor.send(method_name.to_s.gsub('!', ''), *args, &)
     else
-      super
+      RubyShell::Executor.class_eval(&block)
     end
   end
-
-  def chain(&)
-    RubyShell::ChainContext.class_eval(&).exec_commands
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyshell
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - albertalef
@@ -33,6 +33,7 @@ metadata:
   homepage_uri: https://github.com/albertalef/rubyshell
   source_code_uri: https://github.com/albertalef/rubyshell
   changelog_uri: https://github.com/albertalef/rubyshell
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib