rubyshell 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f343a64aa8d805576bb86e5fd0f6694476805b7e7a4277ac51dbfc5b621a13a3
-  data.tar.gz: 15fbb627e2ef6e218a223d7c6d13a736539a4e9538e72ce1506b51df90b8cc30
+  metadata.gz: 3dc52bfe0cf67de6392904a19c61eecd1ba03d309ed0b71fe7c9f62c43a99389
+  data.tar.gz: 99ec7930b2fb5223efe6533fee5357ea1a18ee8501267479157d533e9be687e5
 SHA512:
-  metadata.gz: 926f688a76110e5eb0ab4ac491280ef84e00b58b9226d7b44d8d5c770690204a67b5f2248d71be0abdf2903ad922b2ce0b7b79065d2a30b0a894e8c668ddf327
-  data.tar.gz: 4a0ad4a8e3df9c889ad1bedc293a63760b1180129b2eeae8d3a71139a1c5041ab8321c4c5a4295852bccb90e5177563cd26e4313785dc722c7e8fa4c8b85f3dc
+  metadata.gz: f44145f622774e54812697bb03a16e06f5b1a5f4dedbe3832879af9f500144a1b81a67424a0567b0a738efa713c5d849321f58ba6281fe8c2d573e53d04343b3
+  data.tar.gz: 6b213e46dd112c32449cfab374cafefaa41265dfdc4b32152bfeac6757757266bdb56e81dc975f9c816c8818edc1d5533e28bebacdda510310f2fb43c7a2b83b

data/README.md

@@ -1,24 +1,172 @@
-# Rubysh
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubysh`. To experiment with that code, run `bin/console` for an interactive prompt.
+<h1 align="center">
+  <img alt="RubyShell" src="./docs/images/rubyshelllogo.png" width="60%">
+</h1>
+
+<h3 align="center">✨ Rubist way to create shell scripts ✨</h3>
+
+<p align="center">
+  <a href="https://rubygems.org/gems/rubyshell">
+    <img src="https://img.shields.io/gem/v/rubyshell?color=red&logo=ruby" alt="Gem Version">
+  </a>
+  <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/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="#installation">Installation</a>
+    ·
+    <a href="#usage">Usage</a>
+    ·
+    <a href="#complete-example">Examples</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)
+    end
+  end
+```
+
+Yes, that’s valid Ruby!
+`ls` and `cat` are just shell commands, but **RubyShell** makes them behave like Ruby methods.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add rubyshell
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install rubyshell
 
 ## Usage
 
-TODO: Write usage instructions here
+### 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
+
+- Support to Streams
 
 ## Development
 
@@ -28,7 +176,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/albertalef/rubysh. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rubysh/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/albertalef/rubyshell. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/albertalef/rubyshell/blob/master/CODE_OF_CONDUCT.md).
+
+## Sponsors
+
+<a href="https://avantsoft.com.br">
+  <img alt="Avantsoft" src="./docs/images/LogoAvantsoft.png" width="40%">
+</a>
 
 ## License
 
@@ -36,4 +190,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rubysh project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubysh/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rubysh project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/albertalef/rubyshell/blob/master/CODE_OF_CONDUCT.md).

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,17 +1,24 @@
+# frozen_string_literal: true
 
 module RubyShell
   class Chainer
+    attr_reader :parts
+
     def initialize(command)
       @parts = [command]
     end
 
     def handle_chain(operator, chainer)
-      @parts = [*@parts, operator.to_s, *chainer.parts]
+      @parts = [
+        *@parts,
+        operator.to_s,
+        *(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
@@ -19,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.0.1"
+  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.0.1
+  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