ruby-sh 2.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91cf2506446079b3fe817363924b3c6449013525842e65458a29f4c0b7c35cb3
+  data.tar.gz: 4c7bf3f948195bfe2d64e9e368a3471dfa4b7eb43396c58775851b8c3b827516
+SHA512:
+  metadata.gz: b5e584c74dc57d72549c232120997eac68237afb27281e6172ba0377d337ce826b1056a4735737807a985865a89aa450abefc79044a8d3df0794e0e4f6476ce4
+  data.tar.gz: 44d52e9f7484e79fae0c1502fdfa67c3571b2e75fb9bb3b9c66200136586927c4378cb9f4c55ea6605498154cfc3d1be9c59caba8ad0f054acbd59de2d8e6466

data/.overcommit.yml

@@ -0,0 +1,26 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    command: 'bin/rubocop'
+
+PrePush:
+  RSpec:
+    enabled: true
+    command: 'bin/rspec'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/**/*'
+

data/.yardopts

@@ -0,0 +1,2 @@
+--markup=markdown
+--markup-provider=redcarpet

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 johndoe@example.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 rubsh.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.12"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    ruby-sh (2.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  ruby-sh!
+  standard (~> 1.12)
+
+BUNDLED WITH
+   2.3.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 John Doe
+
+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,383 @@
+# Rubsh
+
+Rubsh (a.k.a. ruby-sh) - Inspired by [python-sh], allows you to call any program as if it were a function:
+
+```ruby
+require 'rubsh'
+
+sh = Rubsh::Shell.new
+print(sh.cmd('ifconfig').call_with('wlan0').stdout_data)
+```
+
+Output:
+
+```text
+wlan0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
+        inet 192.168.1.13  netmask 255.255.255.0  broadcast 192.168.1.255
+        inet6 fe80::7fab:2715:9e90:2061  prefixlen 64  scopeid 0x20<link>
+        inet6 240e:3b7:3278:9fa0:e48:24:7958:9128  prefixlen 64  scopeid 0x0<global>
+        ether 14:85:7f:08:5b:2e  txqueuelen 1000  (Ethernet)
+        RX packets 6015867  bytes 7575465908 (7.0 GiB)
+        RX errors 0  dropped 0  overruns 0  frame 0
+        TX packets 2953567  bytes 391257693 (373.1 MiB)
+        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
+```
+
+Note that these aren't Ruby functions, these are running the binary commands on your system by dynamically resolving your $PATH, much like Bash does, and then wrapping the binary in a function. In this way, all the programs on your system are easily available to you from within Ruby.
+
+When using this library you can:
+
+* Call any program as if it were a function.
+* Get an exception when exit code is not 0.
+* Force terminate the process if it does not finish within the timeout.
+* Always split the shell command into tokens, reduce command injection risk.
+* etc.
+
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Basic Syntax](#basic-syntax)
+  * [Passing Arguments](#passing-arguments)
+  * [Exit Codes](#exit-codes)
+  * [Redirection](#redirection)
+  * [Incremental Iteration](#incremental-iteration)
+  * [Background Processes](#background-processes)
+  * [Baking](#baking)
+  * [Subcommands](#subcommands)
+  * [Piping](#piping)
+* [Reference](#reference)
+  * [Special Kwargs](#special-kwargs)
+* [FAQ](#faq)
+  * [Why doesn’t `*` work as a command argument?](#why-doesnt--work-as-a-command-argument)
+  * [How do I execute a bash builtin?](#how-do-i-execute-a-bash-builtin)
+  * [How do I call a program that isn’t in $PATH?](#how-do-i-call-a-program-that-isnt-in-path)
+  * [How do I run a command and connect it to stdout and stdin?](#how-do-i-run-a-command-and-connect-it-to-stdout-and-stdin)
+  * [How do I order keyword arguments?](#how-do-i-order-keyword-arguments)
+* [Development](#development)
+* [Contributing](#contributing)
+* [Acknowledgements](#acknowledgements)
+* [License](#license)
+* [Code Of Conduct](#code-of-conduct)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-sh', require: 'rubsh'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby-sh
+
+
+## Usage
+
+### Basic Syntax
+
+```ruby
+# Create a shell
+sh = Rubsh::Shell.new
+
+# Create a command, use `command`/`cmd`
+cmd = sh.cmd("ls")
+
+# Invoke a command, use `call`/`call_with`
+result = cmd.call_with("-la")
+
+# Print result
+print result.stdout_data
+```
+
+### Passing Arguments
+
+```ruby
+sh.cmd("ls").call_with("-l", "/tmp", color: "always", human_readable: true)
+  # => ["/usr/bin/ls", "-l", "/tmp", "--color=always", "--human-readable"]
+
+sh.cmd("curl").call_with("https://www.ruby-lang.org/", o: "page.html", silent: true)
+  # => ["/usr/bin/curl", "https://www.ruby-lang.org/", "-opage.html", "--silent"]
+
+sh.cmd("git").call(:status, { v: true })
+  # => ["/usr/bin/git", "status", "-v"]
+
+sh.cmd("git").call(:status, { v: true }, "--", ".")
+  # => ["/usr/bin/git", "status", "-v", "--", "."]
+
+sh.cmd("git").call(:status, { v: proc{ true }, short: true }, "--", ".")
+  # => ["/usr/bin/git", "status", "-v", "--short", "--", "."]
+
+sh.cmd("git").call(:status, { v: true }, v: false)
+  # => ["/usr/bin/git", "status"]
+```
+
+### Exit Codes
+
+```ruby
+# Successful
+r = sh.cmd("ls").call_with("/")
+r.exit_code # => 0
+
+# a `CommandReturnFailureError` raised when run failure
+begin
+  sh.cmd("ls").call_with("/some/non-existant/folder")
+rescue Rubsh::Exceptions::CommandReturnFailureError => e
+  e.exit_code # => 2
+end
+
+# Treats as success use `:_ok_code`
+r = sh.cmd("ls").call_with("/some/non-existant/folder", _ok_code: [0, 1, 2])
+r = sh.cmd("ls").call_with("/some/non-existant/folder", _ok_code: 0..2)
+r.exit_code # => 2
+```
+
+### Redirection
+
+```ruby
+# Filename
+sh.cmd("ls").call_with(_out: "/tmp/dir_content")
+sh.cmd("ls").call_with(_out: ["/tmp/dir_content", "w"])
+sh.cmd("ls").call_with(_out: ["/tmp/dir_content", "w", 0600])
+sh.cmd("ls").call_with(_out: ["/tmp/dir_content", File::WRONLY|File::EXCL|File::CREAT, 0600])
+
+# File object
+File.open("/tmp/dir_content", "w") { |f| sh.cmd("ls").call_with(_out: f) }
+
+# `stdout_data` & `stderr_data`
+r = sh.cmd("sh").call_with("-c", "echo out; echo err >&2")
+r.stdout_data # => "out\n"
+r.stderr_data # => "err\n"
+
+# Redirects stderr and stderr to the same place use `_err_to_out`
+r = sh.cmd("sh").call_with("-c", "echo out; echo err >&2", _err_to_out: true)
+r.stdout_data # => "out\nerr\n"
+r.stderr_data # => nil
+
+# Read input from data
+sh.cmd("cat").call_with(_in_data: "hello").stdout_data # => "hello"
+
+# Read input from file
+sh.cmd("cat").call_with(_in: "/some/existant/file")
+```
+
+### Incremental Iteration
+
+```ruby
+# By default, output is line-buffered, so the body of the loop will only run
+# when your process produces a newline. You can change this by changing the
+# buffer size of the command’s output with `_out_bufsize`/`_err_bufsize`.
+tail = sh.cmd("tail")
+tail.call_with("-f", "/var/log/some_log_file.log", _capture: ->(stdout, _stderr) {
+  print stdout
+})
+```
+
+### Background Processes
+
+```ruby
+# Blocks
+sh.cmd("sleep").call_with(3)
+p "...3 seconds later"
+
+# Doesn't block
+r = sh.cmd("sleep").call_with(3, _bg: true)
+p "prints immediately!"
+r.wait()
+p "...and 3 seconds later"
+
+# Timeout
+r = sh.cmd("sleep").call_with(30, _bg: true)
+p "prints immediately!"
+r.wait(timeout: 3)
+p "...and 3 seconds later"
+```
+
+### Baking
+
+```ruby
+ll = sh.cmd("ls").bake("-l")
+ll.call_with("/tmp") # => ["/usr/bin/ls", "-l", "/tmp"]
+
+# Equivalent
+sh.cmd("ls").call_with("-l", "/tmp")
+
+# Calling whoami on a server. this is a lot to type out, especially if you wanted
+# to call many commands (not just whoami) back to back on the same server resolves
+# to "/usr/bin/ssh myserver.com -p 1393 whoami"
+sh.cmd('ssh').call_with("myserver.com", "-p 1393", "whoami")
+
+# Wouldn't it be nice to bake the common parameters into the ssh command?
+myserver = sh.cmd('ssh').bake("myserver.com", p: 1393)
+myserver.call_with('whoami')
+myserver.call_with('pwd')
+```
+
+### Subcommands
+
+```ruby
+# Use `bake`
+gst = sh.cmd("git").bake("status")
+
+gst.call_with() # => ["/usr/bin/git", "status"]
+gst.call_with("-s") # => ["/usr/bin/git", "status", "-s"]
+```
+
+### Piping
+
+```ruby
+# Run a series of commands connected by `_pipeline`
+r = sh.pipeline(_in_data: "hello world") do |pipeline|
+  sh.cmd("cat").call_with(_pipeline: pipeline)
+  sh.cmd("wc").call_with("-c", _pipeline: pipeline)
+end
+r.stdout_data # => "11\n"
+```
+
+
+## Reference
+
+### Special Kwargs
+
+* `_in_data`:
+  * use: Specifies an argument for the process to use as its standard input data.
+  * default value: `nil`
+* `_in`:
+  * use: Specifies an argument for the process to use as its standard input.
+  * default value: `nil`
+* `_out`:
+  * use: Where to redirect STDOUT to.
+  * default value: `nil`
+* `_err`:
+  * use: Where to redirect STDERR to.
+  * default value: `nil`
+* `_err_to_out`:
+  * use: If true, duplicate the file descriptor bound to the process’s STDOUT also to STDERR.
+  * default value: `false`
+* `_capture`:
+  * use: Iterates over STDOUT/STDERR.
+  * default value: `nil`
+* `_bg`:
+  * use: Runs a command in the background. The command will return immediately, and you will have to run RunningCommand#wait on it to ensure it terminates.
+  * default value: `false`
+* `_timeout`:
+  * use: How much time, in seconds, we should give the process to complete. If the process does not finish within the timeout, it will be terminated.
+  * default value: `nil`
+* `_env`:
+  * use: A dictionary defining the only environment variables that will be made accessible to the process. If not specified, the calling process’s environment variables are used.
+  * default value: `nil`
+* `_cwd`:
+  * use: Current working directory of the process.
+  * default value: `nil`
+* `_ok_code`:
+  * use: Some misbehaved programs use exit codes other than 0 to indicate success. Set to treats as success.
+  * default value: `[0]`
+* `_no_out`:
+  * use: Disables STDOUT being internally stored. This is useful for commands that produce huge amounts of output that you don’t need, that would otherwise be hogging memory if stored internally by Rubsh.
+  * default value: `false`
+* `_no_err`:
+  * use: Disables STDERR being internally stored. This is useful for commands that produce huge amounts of output that you don’t need, that would otherwise be hogging memory if stored internally by Rubsh.
+  * default value: `false`
+* `_out_bufsize`:
+  * use: The STDOUT buffer size. nil for unbuffered, 0 for line buffered, anything else for a buffer of that amount.
+  * default value: `0`
+* `_err_bufsize`:
+  * use: The STDERR buffer size. nil for unbuffered, 0 for line buffered, anything else for a buffer of that amount.
+  * default value: `0`
+* `_long_sep`:
+  * use: This is the character(s) that separate a program’s long argument’s key from the value.
+  * default value: `"="`
+* `_long_prefix`:
+  * use: This is the character(s) that prefix a long argument for the program being run. Some programs use single dashes, for example, and do not understand double dashes.
+  * default value: `"--"`
+* `_pipeline`:
+  * use: Specifies the :pipeline.
+  * default value: `nil`
+
+
+## FAQ
+
+### Why doesn’t `*` work as a command argument?
+
+Glob expansion is a feature of a shell, like Bash, and is performed by the shell before passing the results to the program to be exec'd. Because Rubsh is not a shell, but rather tool to execute programs directly, we do not handle glob expansion like a shell would.
+
+### How do I execute a bash builtin?
+
+```ruby
+sh = Rubsh::Shell.new
+rawsh = sh.cmd('bash').bake('-c')
+print(rawsh.call_with('echo Hello').stdout_data) # => "Hello\n"
+```
+
+### How do I call a program that isn’t in $PATH?
+
+Use absolute binpath
+
+```ruby
+sh = Rubsh::Shell.new
+sh.cmd('/path/to/command').call()
+```
+
+OR Use `Rubsh::Shell::Env#path`
+
+```ruby
+sh = Rubsh::Shell.new
+sh.env.path << "/dir/to/command/"
+sh.cmd('command').call()
+```
+
+### How do I run a command and connect it to stdout and stdin?
+
+Use `_capture` special kwargs.
+
+### How do I order keyword arguments?
+
+Typically this question gets asked when a user is trying to execute something like the following commandline:
+
+```sh
+my-command --arg1=val1 arg2 --arg3=val3
+```
+
+Use:
+
+```ruby
+sh = Rubsh::Shell.new
+sh.cmd('my-command').call_with({ arg1: "val1" }, "args2", { arg3: "val3" })
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/souk4711/rubsh. 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/souk4711/rubsh/blob/main/CODE_OF_CONDUCT.md).
+
+
+## Acknowledgements
+
+* Special thanks to [python-sh].
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Code of Conduct
+
+Everyone interacting in the Rubsh project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/souk4711/rubsh/blob/main/CODE_OF_CONDUCT.md).
+
+
+[python-sh]:https://github.com/amoffat/sh

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rubsh/argument.rb

@@ -0,0 +1,47 @@
+module Rubsh
+  class Argument
+    # @overload initialize(name)
+    #   @param name [String, Symbol, #to_s]
+    #
+    # @overload initialize(name, value)
+    #   @param name [String, Symbol, #to_s]
+    #   @param value [nil, Boolean, Numeric, String, Symbol, Proc]
+    def initialize(*args)
+      @name, @value = args[0].to_s, args[1]
+      @is_positional = args.length < 2
+    end
+
+    # @return [void]
+    def value=(value)
+      raise ::ArgumentError, "cannot assign a new value for positional argument" if @is_positional
+      @value = value
+    end
+
+    # @return [nil, String, Array<String>]
+    def compile(long_sep: "=", long_prefix: "--")
+      return compile_positional_argument(@name) if @is_positional
+      compile_option_argument(@name, @value, long_sep: long_sep, long_prefix: long_prefix)
+    end
+
+    private
+
+    def compile_positional_argument(name)
+      name
+    end
+
+    def compile_option_argument(name, value, long_sep:, long_prefix:)
+      value = value.call if value.respond_to?(:call)
+      return if value.nil?
+      return if value.is_a?(::FalseClass)
+
+      if name.length == 1 # short option
+        return format("-%s", name) if value.is_a?(::TrueClass)
+        format("-%s%s", name, value)
+      else # long option
+        return format("%s%s", long_prefix, name) if value.is_a?(::TrueClass)
+        return [format("%s%s", long_prefix, name), value.to_s] if long_sep.nil?
+        format("%s%s%s%s", long_prefix, name, long_sep, value)
+      end
+    end
+  end
+end