DevOops

This is a gem to help you manage all the scripts and repetitive commands you have written and scatered over the years

Installation

There's 2 main ways to install and use this gem.

Global install

$ gem install dev_oops

Bundler way

Add this gem to your Gemfile

gem 'dev_oops'

Then bundle install

Usage

This gem will install a new command named dev_oops. You can use it from anywhere.

TL;DR example

Config (dev_oops edit hello):

{
  "desc": "Say hello.",
  "usage": "[--firstname name]",
  "args": [
    {
      "name": "firstname",
      "desc": "Firstname of the person",
      "aliases": ["f"],
      "required": false,
      "default": "Pierre"
    }
  ]
}

Script (dev_oops edit_sh hello):

echo "Hello $firstname !"

Shell:

dev_oops hello --firstname Emy # => Hello Emy !
dev_oops hello -f Chris # => Hello Chris !
dev_oops hello # => Hello Pierre !
dev_oops help hello # =>
# Usage:
#   hello [--firstname name]
#
# Options:
#   f, [--firstname=FIRSTNAME]  # Firstname of the person
#                               # Default: Pierre

Script locations

By default this gem will use the $HOME/.dev_oops directory to install configs and scripts.

This gem will also try to find every dev_oops directory between the current directory and home and look for scripts in them.

If there's a name collision, the closest to current_dir will be chosen.

This search will also be done while editing or removing a script. It will use:

The existing script with the same name
Or, the ./dev_oops directory if exists
Or, the $HOME/.dev_oops directory otherwise

All edit, edit_sh and rm commands (see lower) have a --global or -g option to bypass the search and use the $HOME/.dev_oops directory.

Creating a local directory

bundle exec dev_oops local_install.

This will create a ./dev_oops directory.

Commands

Which editor will be opened by the gem is dictated by the $EDITOR environment variable.

edit

dev_oops edit name_of_script Will open in $EDITOR your script configuration.

edit_sh

dev_oops edit_sh name_of_script Will open in $EDITOR your script body. Note that the script will be run in $SHELL

rm

dev_oops rm name_of_script Will remove the config file and the body file from your disk.

help

dev_oops help [COMMAND] Will show help.

[your command]

dev_oops [your_command] Will launch the command.

Config format

Most of the fields are optionals. I would advise filling "desc" and "usage".

{
    "desc": "A description for what the command do. Will be shown in help.",
    "usage": "A short usage description. This will be shown in help. The name of the command will be automatically present at the beggining of the usage",
    "args": [
        {
            "name": "name_of_the_arg",
            "desc": "Description of what the arg does. Will be shown in help.",
            "aliases": ["a"],
            "required": false,
            "default": "aaaaa"
        },
        …
    ]
}

Arg format

The name will be used to pass the value in the script as an env variable. You can then access the value with $name in the shell script.

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 tags, and push the .gem file to rubygems.org.

Be carefull, in dev your directory will be detected as a local directory (because of its name). Do not remove the "package" script.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/zaratan/dev_oops. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the DevOops project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.