Duty

Craft. Don't battle. Do your duty, let me handle the rest.

Installation

$ gem install duty

Add executable to your $PATH

$ export PATH="$PATH:$HOME/path/to/duty/bin"

Add shell completion

This gem supports a simple shell completion for Bash and ZSH. To enable this feature load the completion functions:

$ source duty.completion

Usage

$ duty <task> [<args>]

Plugins

Duty ships with a plugin mechanism. You can define tasks by using existing duty plugins or writing your own.

Install a plugin

Install a plugin you want to use globally e.g.

gem install duty-git

or add it to your Gemfile e.g.

gem 'duty-git'

Add it to your .duty file. e.g.

tasks:
  - duty/git

List of existing duty plugins

duty-git

Extend duty with your own plugin

Example: /path/to/your/duty-plugins/my_duty_plugin.rb

require 'duty'

module MyDutyPlugin
  def self.namespace
    'i am special'
  end

  def self.tasks
    [
      MyDutyTasks::MyFirstTask,
      MyDutyTasks::ContinueFeature
    ]
  end
end

module MyDutyTasks
  class MyFirstTask < ::Duty::Tasks::Base
  end

  class ContinueFeature < ::Duty::Tasks::Base
    def self.description
      "Continue on an already existing feature"
    end

    def self.usage
      "duty continue-feature <feature-name>"
    end

    def valid?
      !!feature_name
    end

    # Everthing in here will be executed sequential
    def execute

      # Execute ruby code
      ruby("Do something useful in ruby") { Object.new }

      # Execute something on the shell
      sh("Checkout `feature/#{feature_name}` branch") { "git checkout feature/#{feature_name}" }

      # Wrap things up in a parallel block if you want to run commands in isolation
      # A failing command inside a parallel does not stop the sequential execution of outer commands
      parallel { ruby("Run ruby in isolation") { raise RuntimeError.new } }

      # This will be executed even if the ruby above raises an RuntimeError
      parallel { sh("Run shell in isolation") { 'pwd' } }

    end

    private

    def feature_name
      @feature_name =|| @arguments.first
    end
  end
end

Duty::Registry.register(MyDutyPlugin)

Task naming conventions

A task class named StartFeature would be accessible through the CLI via. Task names should be a combination of one verb joined with one or more nouns.

$ duty start-feature

How to use my own tasks?

Deploy it as a gem and install it as described in the Install a plugin section above or link it against the absolute path in your .duty file.

tasks:
  - /path/to/your/duty-plugins/my_duty_plugin

Your new tasks will be immediately available from the CLI.

$ duty

Fire up the CLI and execute your new task. Duty will tell you what you have to do next.

$ duty <your-task>

Contributing

Fork
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request