duty 0.2.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e29580781a8605e4065b33ebe1635449dbd6aa3
-  data.tar.gz: 35f89aa36570bf3b131160a6a8ccfb6ee82e3248
+  metadata.gz: 44ef3b279562acfd0f5516c02382a38a70778f0b
+  data.tar.gz: fa24abb31a74a7baabcb08921377a3a1a77d3e6b
 SHA512:
-  metadata.gz: 51bbffb12a1135f370822409dc4cbcd3c827671d0b82a910370a5f68dc2449da97dc4f10ebd1028a29c7fe55ca042c70bf1cb0d8a5286fc2370d96c996dafccd
-  data.tar.gz: eac70d0bb708678d15d4604e6d37b392d96271029e514c6cc5d8fb39cef761b626783ea15c9021bda8159937c23650f0f270b22a9e10b868de50c6e88725fcd7
+  metadata.gz: 07ab67f28397f6bb2457bbb0d2d665d1718800b3a4ad31a0ff302500a4c6c9511ec190d96c4c64cfc2febb557c0be3f7dc41038cc8425d8ed816cbcc40e5d310
+  data.tar.gz: 86fe0d1b98c855524b1a962dd54f07607c70412aaf406be9fa0d4fd928ec3ded01690ec99ad21b39ed945be123d2329f0b14f1f15268f17dca2c38c03ed68e26

data/.duty.yml.sample

@@ -1 +1,4 @@
-tasks: /path/to/my/project/specific/tasks
+tasks:
+  git: /path/to/duty-git/lib/duty/git.rb
+  projectA: /path/to/projectA/tasks.rb
+  projectB: /path/to/projectB/i_dont_care_about_naming.rb

data/README.md

@@ -25,7 +25,7 @@ This gem supports a simple shell completion for
 To enable this feature load the completion functions:
 
 ```
-source duty.completion
+$ source duty.completion
 ```
 
 ## Usage
@@ -34,64 +34,110 @@ source duty.completion
 $ duty <task> [<args>]
 ```
 
-## Naming conventions
+## List of official duty plugins
 
-Task names should be a combination of one verb joined with one or more nouns.
+* [duty-git](https://github.com/JanOwiesniak/duty-git)
 
-Examples:
+## Extend duty with your own plugins
 
-* `start-feature`
-* `continue-feature`
+* Create a new file that implements the plugin behaviour
+* Create a .duty file e.g. in your project dir
 
-## List of official duty plugins
+### How does a duty plugin looks like?
 
-* [duty-git](https://github.com/JanOwiesniak/duty-git)
+Example: `/path/to/your/duty-plugins/my_duty_plugin.rb`
 
-## Extend duty with your own tasks
+```ruby
+require 'duty'
+
+module MyDutyPlugin
+  def self.tasks
+    [
+      MyDutyTasks::MyFirstTask,
+      MyDutyTasks::ContinueFeature
+    ]
+  end
+end
 
-* Create a new `tasks` dir
-* Create one or more duty task files in there
-* Create a .duty file e.g. in your home dir
+module MyDutyTasks
+  class MyFirstTask < ::Duty::Tasks::Base
+  end
 
-### How does a basic duty task looks like?
+  class ContinueFeature < ::Duty::Tasks::Base
+    def self.description
+      "Continue on an already existing feature"
+    end
 
-path/to/your/new/tasks/my_new_task.rb
+    def self.usage
+      "duty continue-feature <feature-name>"
+    end
 
-```ruby
-require 'duty/tasks/base'
+    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 }
 
-module Duty
-  module Tasks
-    class MyNewTask < Duty::Tasks::Base
+      # 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
+
+# Return your duty module
+
+MyDutyPlugin
 ```
 
-### How does a .duty file looks like?
+## Task naming conventions
 
-.duty
+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.
 
 ```
-tasks:
-  git: /path/to/my/git/specific/tasks
-  projectA: /path/to/my/projectA/specific/tasks
-  projectB: /path/to/my/projectB/specific/tasks
+$ duty start-feature
 ```
 
-### How to use my own task?
+### How to use my own tasks?
+
+Create a duty plugin and add it to your `.duty` file.
+
+```
+tasks:
+  git: /path/to/duty-git/lib/duty/git.rb
+  projectA: /path/to/projectA/my_duty_plugin.rb
+  projectB: /path/to/projectB/i_dont_care_about_naming.rb
+```
 
-Your new task will be immediately available from the CLI.
+Your new tasks will be immediately available from the CLI.
 
 ```
-duty
+$ duty
 ```
 
 Fire up the CLI and execute your new task.
 Duty will tell you what you have to do next.
 
 ```
-duty <your-task>
+$ duty <your-task>
 ```
 
 ## Contributing

data/lib/duty/cli.rb

@@ -1,3 +1,4 @@
+require 'duty/config_loader'
 require 'duty/io'
 require 'duty/registry'
 require 'duty/plugins'
@@ -6,13 +7,12 @@ require 'duty/views'
 
 module Duty
   class CLI
-    DUTY_CONFIG_FILENAME = '.duty.yml'
     attr_reader :registry
 
     def initialize(args)
       @input = Duty::IO::CLI::Input.new(args)
       @output = Duty::IO::CLI::Output.new($stdout, $stderr)
-      @registry = Duty::Registry.register(Duty::Plugins.load(DUTY_CONFIG_FILENAME))
+      @registry = Duty::Registry.register(Duty::Plugins.load(load_config))
     end
 
     def exec
@@ -66,5 +66,9 @@ module Duty
     def verbose?
       input.verbose?
     end
+
+    def load_config
+      Duty::ConfigLoader.new.load(Dir.pwd)
+    end
   end
 end

data/lib/duty/config_loader.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+require 'pathname'
+
+module Duty
+  class ConfigLoader
+    DUTY_CONFIG_FILENAME = '.duty.yml'
+
+    def initialize(root_directory = nil)
+      @root_directory = root_directory
+    end
+
+    def load(base_dir)
+      return default_config unless path = find_closest_config_file(base_dir)
+      load_config_file(path)
+    end
+
+    private
+
+    def default_config
+      { "tasks" => [] }
+    end
+
+    def find_closest_config_file(base_dir)
+      candidates = dirs_to_search(base_dir).map do |dir|
+        File.join(dir, DUTY_CONFIG_FILENAME)
+      end
+      candidates.find do |path|
+        File.exists?(path)
+      end
+    end
+
+    def dirs_to_search(base_dir)
+      starting_dir = File.expand_path(base_dir)
+      dirs_to_search = []
+      Pathname.new(starting_dir).ascend do |path|
+        break if path.to_s == @root_directory
+        dirs_to_search << path.to_s
+      end
+      dirs_to_search << Dir.home
+    end
+
+    def load_config_file(path)
+      YAML.load(File.read(path))
+    end
+  end
+end

data/lib/duty/plugins.rb

@@ -3,14 +3,10 @@ require 'yaml'
 
 module Duty
   module Plugins
-    def self.load(filename)
+    def self.load(config)
       Duty::Plugins::List.new.tap do |list|
-        if File.exists?(filename)
-          duty_config = YAML.load(File.read(filename))
-          tasks = duty_config["tasks"]
-          tasks.each do |namespace, plugin_entry_point|
-            list << Plugin.new(namespace, plugin_entry_point)
-          end
+        config["tasks"].each do |namespace, plugin_entry_point|
+          list << Plugin.new(namespace, plugin_entry_point)
         end
       end
     end

data/lib/duty/version.rb

@@ -1,3 +1,3 @@
 module Duty
-  VERSION = "0.2.1"
+  VERSION = "0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duty
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - Jan Owiesniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-28 00:00:00.000000000 Z
+date: 2015-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -62,6 +62,8 @@ files:
 - duty.gemspec
 - lib/duty.rb
 - lib/duty/cli.rb
+- lib/duty/config.rb
+- lib/duty/config_loader.rb
 - lib/duty/io.rb
 - lib/duty/io/cli.rb
 - lib/duty/meta.rb