shell_on_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28edd900a1181bc605bd995a730db3a6e851b4d394224ab3e6473c9f0cec5cba
+  data.tar.gz: 2060c870ed4a33afc888f070163d76458c24a9f22cc02709523b24aa81519734
+SHA512:
+  metadata.gz: b3e69f05645fcb98926e0054510ba92247f61be78c2255235511da58fe23a3e9ae6249acd21136e8f65b484b86cf7231a7d34dcffb6b72aade7349a40f56ee0a
+  data.tar.gz: '03898d3adeb5ea7306e62002ce610d0db59d397247093f7b7e237d1dacdfdadef5f666dd0827de9bb244a3c20ae5835816ae9520bd5ca959d0104210f23d1347'

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 3.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.0.0] - 2023-08-16
+
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at nnbnh@protonmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shell_on_ruby.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rubocop', '~> 1.21'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 NNB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+<img width="100%" src="https://capsule-render.vercel.app/api?type=waving&section=header&color=DC2626&fontColor=FEF2F2&height=256&text=Shell%20on%20Ruby&desc=Convenient%20subprocess%20interface&fontAlignY=40" />
+
+## 💡 About
+
+**Shell on Ruby** is a convenient subprocess interface that allows you to call any program as if it were a method.
+
+## 📥 Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```sh
+bundle add shell_on_ruby
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```sh
+gem install shell_on_ruby
+```
+
+<!--
+
+## ⌨️ Usage
+
+In Ruby do:
+
+```rb
+require 'shell_on_ruby'
+
+# Or
+require 'shell_on_ruby/sh' # To just require ShellOnRuby::Command and ShellOnRuby::Sh
+require 'shell_on_ruby/pipe' # To just require ShellOnRuby::Command and ShellOnRuby::Pipe
+
+# Kernel and string extensions
+require 'shell_on_ruby/extensions'
+
+# Or
+require 'shell_on_ruby/sh/extensions' # To just require extensions using ShellOnRuby::Sh
+require 'shell_on_ruby/pipe/extensions' # To just require extensions using ShellOnRuby::Pipe
+```
+
+### `Command`
+
+TODO
+
+### `Sh`
+
+TODO
+
+```rb
+ShellOnRuby::Sh.echo('Hello, World!')
+```
+
+### `Pipe`
+
+TODO
+
+```rb
+ShellOnRuby::Pipe.echo('Hello, World!').figlet(f: 'slant').>
+
+ShellOnRuby::Pipe.echo('fii').tr('i', 'o').figlet > $stderr
+
+ShellOnRuby::Pipe.echo('bar').tr('r', 'z').figlet > "a/b/c/baz.txt"
+```
+
+### ➕ Ruby extensions
+
+TODO
+
+```rb
+require 'ruby_on_shell/extensions'
+
+# TODO
+figlet('Hello, World!', f: 'slant')
+
+# TODO
+Sh.ls(Dir.home)
+
+# TODO
+'foo'.sh.figlet(f: 'slant')
+
+# TODO
+'bar'.sh.tr('r', 'z').sh.figlet
+
+# TODO
+Pipe.yes.tr('y', 'n').>
+
+# TODO
+'bor'.pipe.tr('o', 'a').figlet > $stderr
+```
+
+-->
+
+## 💌 Credits
+
+- [**Python Sh**](https://sh.readthedocs.io) by [Andrew](https://github.com/amoffat)
+
+<a href="https://codeberg.org/NNB">
+  <img
+    width="100%"
+    src="https://capsule-render.vercel.app/api?type=waving&section=footer&color=0284C7&fontColor=F0F9FF&height=128&desc=Made%20with%20%26lt;3%20by%20NNB&descAlignY=80"
+    alt="Made with <3 by NNB"
+  />
+</a>

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/ruby_on_shell/command.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ShellOnRuby
+  # A command construction, contains the command name and it's arguments / options.
+  class Command
+    attr_reader :name, :arguments, :options
+
+    def initialize(name, *args, **kargs)
+      @name = name.to_s
+      @arguments = []
+      @options = {}
+      command_args = args.flatten.map { |arg| argument_symbol_parse(arg) }
+      kargs.map do |key, value|
+        if [IO, Array].include?(key.class)
+          @options[key] = value
+          next
+        end
+
+        [argument_symbol_parse(key), value.to_s]
+      end.compact.flatten => command_kargs
+
+      @arguments = [*command_args, *command_kargs]
+    end
+
+    def self.method_missing(name, *args, **kargs)
+      new(name, *args, **kargs)
+    end
+
+    private
+
+    def argument_symbol_parse(symbol)
+      symbol.is_a?(Symbol) ? "-#{'-' if symbol.size > 1}#{symbol}" : symbol.to_s
+    end
+  end
+end

data/lib/ruby_on_shell/extensions.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'sh/extensions'
+require_relative 'pipe/extensions'
+
+include ShellOnRuby

data/lib/ruby_on_shell/pipe/extensions.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative '../pipe' unless defined? ShellOnRuby::Pipe
+
+class String
+  # Returns a standard input of `self` for a pipeline.
+  def pipe
+    ShellOnRuby::Pipe::Input.new self
+  end
+end

data/lib/ruby_on_shell/pipe.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+require_relative 'command' unless defined? ShellOnRuby::Command
+
+module ShellOnRuby
+  # A shell pipeline.
+  class Pipe
+    # A standard input for a pipeline.
+    class Input
+      attr_reader :string
+
+      alias to_s string
+
+      def initialize(string)
+        @string = string.to_s
+      end
+
+      def method_missing(name, *args, **kargs)
+        pipe = ShellOnRuby::Pipe.new(ShellOnRuby::Command.new(name, *args, **kargs))
+        pipe.stdin = @string
+        pipe
+      end
+    end
+
+    attr_reader :commands
+    attr_accessor :stdin
+
+    def initialize(*commands)
+      commands.each do |command|
+        next if command.is_a?(ShellOnRuby::Command)
+
+        raise TypeError, "no implicit conversion of #{command.class} into ShellOnRuby::Command"
+      end
+
+      @commands = commands
+    end
+
+    def self.method_missing(name, *args, **kargs)
+      new(ShellOnRuby::Command.new(name, *args, **kargs))
+    end
+
+    def method_missing(name, *args, **kargs)
+      @commands.append(ShellOnRuby::Command.new(name, *args, **kargs))
+      self
+    end
+
+    # Execute the pipeline and redirect its output.
+    def >(io = nil, append: false, **options)
+      case io
+      in IO|Array|String
+        { out: io }
+      in Hash|NilClass
+        io || options
+      else
+        raise TypeError, "no implicit conversion of #{io.class} into IO"
+      end.then do |spawn_options|
+        spawn_pipeline(@commands, @stdin, spawn_options_parse(spawn_options, append:))
+      end
+    end
+
+    # Execute the pipeline and redirect its output (append).
+    def >>(io = nil, **options)
+      self.>(io, append: true, **options)
+    end
+
+    private
+
+    def spawn_options_parse(options, append: false)
+      options.map do |key, value|
+        next [key, value] unless %i[in out err].include?(key) || [Integer, IO, Array].include?(key.class)
+
+        file = [value].flatten(1)
+        next [key, value] unless file.first.is_a? String
+
+        file[0] = file.first.sub(/\A~\//, "#{Dir.home}/")
+        FileUtils.mkpath(File.dirname(file.first))
+        FileUtils.touch(file.first)
+
+        file[1] = append ? 'a' : 'w' unless file[1]
+
+        [key, file]
+      end.to_h
+    end
+
+    def spawn_pipeline(commands, stdin, options)
+      if stdin
+        input_read, input_write = IO.pipe
+        input_write.puts stdin
+        options[:in] = input_read
+      end
+
+      wait_threads = []
+      last_command_read = nil
+      commands.each.with_index do |command, index|
+        command_options = options.dup
+        command_options[:in] = last_command_read if last_command_read
+
+        if index < commands.size - 1
+          command_read, command_write = IO.pipe
+          command_options[:out] = command_write
+        end
+
+        pid = spawn(command.name, *command.arguments, command.options.merge(command_options))
+        wait_threads.append Process.detach(pid)
+
+        [last_command_read, command_write].each { |pipe| pipe&.close }
+        last_command_read = command_read
+      end
+
+      begin
+        wait_threads
+      ensure
+        input_write&.close
+        wait_threads.each(&:join)
+      end
+    rescue Interrupt => e
+      e
+    end
+  end
+
+  class Command
+    def to_pipe
+      ShellOnRuby::Pipe.new(self)
+    end
+  end
+end

data/lib/ruby_on_shell/sh/extensions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../sh' unless defined? ShellOnRuby::Sh
+
+def self.method_missing(name, *args, **kargs)
+  ShellOnRuby::Sh.new(ShellOnRuby::Command.new(name, *args, **kargs)).stdout
+end
+
+class String
+  # Returns a standard input of `self` for a shell command.
+  def sh
+    ShellOnRuby::Sh::Input.new self
+  end
+end

data/lib/ruby_on_shell/sh.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'command' unless defined? ShellOnRuby::Command
+
+module ShellOnRuby
+  # A command shell.
+  class Sh
+    # A standard input for a shell command.
+    class Input
+      attr_reader :string
+
+      alias to_s string
+
+      def initialize(string)
+        @string = string.to_s
+      end
+
+      def method_missing(name, *args, **kargs)
+        Sh.new(ShellOnRuby::Command.new(name, *args, **kargs), stdin: @string).stdout
+      end
+    end
+
+    attr_reader :command, :stdin, :stdout
+
+    alias to_s stdout
+
+    def initialize(command, stdin: nil)
+      raise TypeError, "no implicit conversion of #{command.class} into ShellOnRuby::Command" unless command.is_a?(ShellOnRuby::Command)
+
+      @command = command
+      @stdin = stdin
+
+      IO.popen([@command.name, *@command.arguments, @command.options], 'r+') do |pipe|
+        pipe.write @stdin.to_s if @stdin
+        pipe.close_write
+
+        @stdout = pipe.read
+      end
+    end
+
+    def self.method_missing(name, *args, **kargs)
+      new(ShellOnRuby::Command.new(name, *args, **kargs)).stdout
+    end
+  end
+
+  class Command
+    def stdout
+      ShellOnRuby::Sh.new(self).stdout
+    end
+  end
+end

data/lib/ruby_on_shell/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ShellOnRuby
+  VERSION = '1.0.0'
+end

data/lib/ruby_on_shell.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'ruby_on_shell/version'
+require_relative 'ruby_on_shell/sh'
+require_relative 'ruby_on_shell/pipe'
+
+# Convenient subprocess interface.
+module ShellOnRuby
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: shell_on_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- NNB
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-16 00:00:00.000000000 Z
+dependencies: []
+description: Shell on Ruby is a convenient subprocess interface that allows you to
+  call any program as if it were a method.
+email:
+- nnbnh@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_on_shell.rb
+- lib/ruby_on_shell/command.rb
+- lib/ruby_on_shell/extensions.rb
+- lib/ruby_on_shell/pipe.rb
+- lib/ruby_on_shell/pipe/extensions.rb
+- lib/ruby_on_shell/sh.rb
+- lib/ruby_on_shell/sh/extensions.rb
+- lib/ruby_on_shell/version.rb
+homepage: https://codeberg.org/NNB/shell_on_ruby.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://codeberg.org/NNB/shell_on_ruby.rb
+  source_code_uri: https://codeberg.org/NNB/shell_on_ruby.rb
+  changelog_uri: https://codeberg.org/NNB/shell_on_ruby.rb/src/branch/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.15
+signing_key:
+specification_version: 4
+summary: Convenient subprocess interface.
+test_files: []