duty 0.3 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44ef3b279562acfd0f5516c02382a38a70778f0b
-  data.tar.gz: fa24abb31a74a7baabcb08921377a3a1a77d3e6b
+  metadata.gz: 7a2fc971faafc1fa92c346f4deff2239c4ee96e9
+  data.tar.gz: be458adb95ddb3267909e23acba8af683c095ed7
 SHA512:
-  metadata.gz: 07ab67f28397f6bb2457bbb0d2d665d1718800b3a4ad31a0ff302500a4c6c9511ec190d96c4c64cfc2febb557c0be3f7dc41038cc8425d8ed816cbcc40e5d310
-  data.tar.gz: 86fe0d1b98c855524b1a962dd54f07607c70412aaf406be9fa0d4fd928ec3ded01690ec99ad21b39ed945be123d2329f0b14f1f15268f17dca2c38c03ed68e26
+  metadata.gz: 84c72963c7be12155cf302e81f69f3421d0eb2adbcfbac510e70ba6744a05ee06a2f1980a14f5bcbc9fbd162196be0393d8ca2b45f796406e276568b220128ac
+  data.tar.gz: 9383bef581a7f9630947b8788b991ba18d1a885ed3e8b1521094eb06a68fc37f96b92956c7dea046f534676a77769509a1278b3fdc7a2381b314cabb45601407

data/.duty.yml.sample

@@ -1,4 +1,4 @@
 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
+  - /path/to/duty-git/lib/duty/git.rb
+  - /path/to/projectA/tasks.rb
+  - /path/to/projectB/i_dont_care_about_naming.rb

data/README.md

@@ -34,16 +34,37 @@ $ source duty.completion
 $ duty <task> [<args>]
 ```
 
-## List of official duty plugins
+## Plugins
 
-* [duty-git](https://github.com/JanOwiesniak/duty-git)
+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
+```
 
-## Extend duty with your own plugins
+or add it to your `Gemfile` e.g.
 
-* Create a new file that implements the plugin behaviour
-* Create a .duty file e.g. in your project dir
+```
+gem 'duty-git'
+```
 
-### How does a duty plugin looks like?
+Add it to your `.duty` file. e.g.
+
+```
+tasks:
+  - duty/git
+```
+
+### List of existing duty plugins
+
+* [duty-git](https://github.com/JanOwiesniak/duty-git)
+
+## Extend duty with your own plugin
 
 Example: `/path/to/your/duty-plugins/my_duty_plugin.rb`
 
@@ -51,6 +72,10 @@ 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,
@@ -102,9 +127,7 @@ module MyDutyTasks
   end
 end
 
-# Return your duty module
-
-MyDutyPlugin
+Duty::Registry.register(MyDutyPlugin)
 ```
 
 ## Task naming conventions
@@ -118,13 +141,11 @@ $ duty start-feature
 
 ### How to use my own tasks?
 
-Create a duty plugin and add it to your `.duty` file.
+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:
-  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
+  - /path/to/your/duty-plugins/my_duty_plugin
 ```
 
 Your new tasks will be immediately available from the CLI.

data/lib/duty/cli.rb

@@ -12,7 +12,8 @@ module Duty
     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(load_config))
+      @registry = Duty::Registry.instance
+      load_plugins
     end
 
     def exec
@@ -67,7 +68,11 @@ module Duty
       input.verbose?
     end
 
-    def load_config
+    def load_plugins
+      Duty::Plugins.load(config)
+    end
+
+    def config
       Duty::ConfigLoader.new.load(Dir.pwd)
     end
   end

data/lib/duty/plugins.rb

@@ -4,61 +4,10 @@ require 'yaml'
 module Duty
   module Plugins
     def self.load(config)
-      Duty::Plugins::List.new.tap do |list|
-        config["tasks"].each do |namespace, plugin_entry_point|
-          list << Plugin.new(namespace, plugin_entry_point)
-        end
-      end
-    end
-
-    class List
-      require 'forwardable'
-      include Enumerable
-      extend Forwardable
-      def_delegators :@plugins, :each, :<<
-      def initialize
-        @plugins = []
-      end
-    end
-
-    class Plugin
-      def initialize(namespace, entry)
-        @namespace = namespace
-        @entry = entry
-        @tasks = []
-      end
-
-      def namespace
-        @namespace
-      end
-
-      def tasks
-        @task_classes.select do |task_class|
-          valid?(task_class)
-        end
-      end
-
-      def load_tasks
-        require_tasks
-        expose_tasks
-      end
-
-      private
-
-      def require_tasks
-        path = @entry.gsub(/\.rb/,'')
+      config["tasks"].each do |plugin_entry_point|
+        path = plugin_entry_point.gsub(/\.rb/,'')
         require path
       end
-
-      def expose_tasks
-        @task_classes = eval(File.read(@entry)).tasks
-      end
-
-      private
-
-      def valid?(task_class)
-        task_class.ancestors.include? ::Duty::Tasks::Base
-      end
     end
   end
 end

data/lib/duty/registry.rb

@@ -1,16 +1,30 @@
 module Duty
   class Registry
-    def self.register(plugins = [])
-      new(plugins).tap {|registry| registry.load_tasks }
+    def self.instance
+      return @instance if @instance
+      @instance = new
     end
 
-    attr_reader :plugins
-    def initialize(plugins)
-      @plugins = plugins
+    def self.register(plugin_class)
+      instance.send(:plugins) << Plugin.new(plugin_class)
     end
 
-    def load_tasks
-      plugins.each {|plugin| plugin.load_tasks }
+    def plugins
+      @plugins
+    end
+
+    private
+
+    class Plugin
+      attr_reader :namespace, :tasks
+      def initialize(plugin_class)
+        @namespace = plugin_class.namespace
+        @tasks = plugin_class.tasks
+      end
+    end
+
+    def initialize
+      @plugins = []
     end
   end
 end

data/lib/duty/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duty
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.4.2
 platform: ruby
 authors:
 - Jan Owiesniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake