duty 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b04eb166b84df79f038e4cd1f03181ff7294049
-  data.tar.gz: 8cec611a0d0fcbf8ae02de1ea3ed798633fed7e7
+  metadata.gz: 8859b7cf5b79a37d5fcb1fa2f23b05905b287b15
+  data.tar.gz: e338d56cb5912651b49f34217eed860b189820b8
 SHA512:
-  metadata.gz: 1fd3ce618dcc3c2e631715efcb138558345e7b7b6481e9655443f14c668b4de115f66983239e3cb769cd2ff73c9cec63f543c68e0c2c326a10505af9bf6ecff4
-  data.tar.gz: 4b7e91969a5d696d976c3d7ea0739fdbec15e16fef9c89a74f62f7e215a4a468e466419c7f58943406ccd9ba06a280f9fe7139420afc1cb1d392851af52be0d5
+  metadata.gz: c6923f6199cf0001806a1f3259feb89fd2fecdb9128319a92c299966528adc2393705eecb41101764936e6bd817e73366cc473fdd8183900a3d14d5ed392266e
+  data.tar.gz: afda6ff19cdca9f23cbfc7b2ea044163b9f6d7fd9931f3134e1c9af9fa386edf194a76348c5f3273936de8fdf40a6cc0593b003e750cf34da68f87afa6da974d

data/README.md

@@ -17,7 +17,6 @@ $ gem install duty
 ```
 $ export PATH="$PATH:$HOME/path/to/duty/bin"
 ```
-```
 
 ## Add shell completion
 

data/lib/duty/cli.rb

@@ -1,6 +1,8 @@
+require 'duty/io'
 require 'duty/registry'
 require 'duty/plugins'
-require 'duty/meta'
+require 'duty/task_runner'
+require 'duty/views'
 
 module Duty
   class CLI
@@ -8,208 +10,61 @@ module Duty
     attr_reader :registry
 
     def initialize(args)
-      @input = Input.new(args)
-      @output = Output.new
-      @registry = Duty::Registry.load(plugins)
+      @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))
     end
 
     def exec
-      stdout usage if help?
-      stdout completion if completion?
-      run_task
+      explain_duty if needs_help?
+      complete_task if needs_completion?
+      execute_task
     end
 
     private
 
     attr_reader :input, :output
 
-    def plugins
-      Duty::Plugins.load(DUTY_CONFIG_FILENAME)
-    end
-
-    def stdout(string)
-      $stdout.puts string
+    def explain_duty
+      view.duty_explain
       exit 0
     end
 
-    def help?
-      input.help?
+    def needs_help?
+      input.needs_help?
     end
 
-    def usage
-      Duty::Meta::Help.new(self).to_s
-    end
-
-    def completion?
-      input.completion?
+    def complete_task
+      view.task_complete
+      exit 0
     end
 
-    def completion
-      Duty::Meta::Completion.new(self, input.drop(1)).to_s
+    def needs_completion?
+      input.needs_completion?
     end
 
-    def run_task
+    def execute_task
       begin
-        task.run
-      rescue NameError => e
-        stdout invalid_task(e.message)
+        try_to_run_task
+      rescue NameError => error
+        view.task_invalid(error)
       end
     end
 
-    def task
-      input.task_class.new(input.task_input, view)
-    end
-
-    def invalid_task(error_message)
-      "duty: `#{input.join(' ')}` is not a duty task. Failed with: #{error_message}"
+    def try_to_run_task
+      Duty::TaskRunner.run(view, input, registry)
     end
 
     def view
       if verbose?
-        VerboseView.new(output)
+        Duty::Views::CLI::Verbose.new(self, input, output)
       else
-        View.new(output)
+        Duty::Views::CLI::Normal.new(self, input, output)
       end
     end
 
     def verbose?
       input.verbose?
     end
-
-    class Input
-      def initialize(args)
-        @args = [args].flatten
-      end
-
-      def[](index)
-        @args[index]
-      end
-
-      def drop(index)
-        @args.drop(1)
-      end
-
-      def task_name
-        task, *rest = @args
-        task
-      end
-
-      def task_class
-        name = task_name.split('-').collect(&:capitalize).join
-        Object.const_get("Duty::Tasks::#{name}")
-      end
-
-      def task_input
-        task, *rest = @args
-        rest
-      end
-
-      def join(seperator='')
-        @args.join(seperator)
-      end
-
-      def verbose?
-        @args.include?('-v') || @args.include?('--verbose')
-      end
-
-      def completion?
-        @args.first == '--cmplt'
-      end
-
-      def help?
-        @args.empty? || @args == %w(-h) || @args == %w(--help)
-      end
-    end
-
-    class Output
-      def print(*args)
-        $stdout.puts(*args)
-      end
-
-      def error(*args)
-        $stderr.puts(*args)
-      end
-    end
-
-    class View
-      def initialize(output)
-        @output = output
-      end
-
-      def task_explain(task)
-        task_class = task.class
-        description = task_class.description
-        usage = task_class.usage
-
-        @output.print(description)
-        @output.print(usage)
-      end
-
-      def task_success(task)
-        task_name = task.class.name
-        success("#{task_name} task executed")
-      end
-
-      def task_failure(task)
-        task_name = task.class.name
-        failure("#{task_name} task aborted")
-      end
-
-      def command_success(command)
-        description = command.description
-        success(description)
-      end
-
-      def command_failure(command)
-        description = command.description
-        failure(description)
-      end
-
-      private
-
-      def success(msg)
-        @output.print([check_mark, msg].join(' '))
-      end
-
-      def failure(msg)
-        @output.error([cross_mark, msg].join(' '))
-      end
-
-      def cross_mark
-        unicode("2715")
-      end
-
-      def check_mark
-        unicode("2713")
-      end
-
-      def unicode(code)
-        ["0x#{code}".hex].pack('U')
-      end
-    end
-
-    class VerboseView < View
-      def command_success(command)
-        success(command_msg(command))
-      end
-
-      def command_failure(command)
-        failure(command_msg(command))
-      end
-
-      private
-
-      def command_msg(command)
-        [command.description, command_logs(command)].join(' ')
-      end
-
-      def command_logs(command)
-        elements = command.logger.flatten
-
-        if elements.any?
-          ["|>", elements.join(' | ')].join(' ')
-        end
-      end
-    end
   end
 end

data/lib/duty/io/cli.rb

@@ -0,0 +1,68 @@
+module Duty
+  module IO
+    module CLI
+      class Input
+        def initialize(args)
+          @args = [args].flatten
+        end
+
+        def[](index)
+          args[index]
+        end
+
+        def task_name
+          task, *rest = args
+          task
+        end
+
+        def task_input
+          task, *rest = args
+          rest
+        end
+
+        def drop(index)
+          args.drop(1)
+        end
+
+        def join(seperator='')
+          args.join(seperator)
+        end
+
+        def verbose?
+          args.include?('-v') || args.include?('--verbose')
+        end
+
+        def needs_completion?
+          args.first == '--cmplt'
+        end
+
+        def needs_help?
+          args.empty? || args == %w(-h) || args == %w(--help)
+        end
+
+        private
+
+        attr_reader :args
+      end
+
+      class Output
+        def initialize(stdout, stderr)
+          @stdout = stdout
+          @stderr = stderr
+        end
+
+        def print(*args)
+          stdout.puts(*args)
+        end
+
+        def error(*args)
+          stderr.puts(*args)
+        end
+
+        private
+
+        attr_reader :stdout, :stderr
+      end
+    end
+  end
+end

data/lib/duty/io.rb

@@ -0,0 +1,6 @@
+require 'duty/io/cli'
+
+module Duty
+  module IO
+  end
+end

data/lib/duty/plugins.rb

@@ -4,46 +4,64 @@ require 'yaml'
 module Duty
   module Plugins
     def self.load(filename)
-      if File.exists?(filename)
-        duty_config = YAML.load(File.read(filename))
-        tasks = duty_config["tasks"]
-        tasks.map do |namespace, task_dir|
-          Plugin.new(namespace, task_dir) if Dir.exists?(task_dir)
+      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
         end
       end
     end
 
+    class List
+      require 'forwardable'
+      include Enumerable
+      extend Forwardable
+      def_delegators :@plugins, :each, :<<
+      def initialize
+        @plugins = []
+      end
+    end
+
     class Plugin
-      TASK_NAMESPACE = Duty::Tasks
-      def initialize(namespace, task_dir)
+      def initialize(namespace, entry)
         @namespace = namespace
-        @task_dir = task_dir
+        @entry = entry
+        @tasks = []
       end
 
       def namespace
         @namespace
       end
 
-      def require_tasks
-        task_files = File.expand_path(File.join(@task_dir, "*.rb"))
-        Dir[task_files].each do |path|
-          require path.gsub(/(\.rb)$/, '')
+      def tasks
+        @task_classes.select do |task_class|
+          valid?(task_class)
         end
       end
 
-      def tasks
-        task_names = TASK_NAMESPACE.constants - [:Base]
-        task_names.reduce([]) do |task_classes, task_name|
-          task_class = TASK_NAMESPACE.const_get(task_name)
-          task_classes << task_class if valid?(task_class)
-          task_classes
-        end
+      def load_tasks
+        require_tasks
+        expose_tasks
+      end
+
+      private
+
+      def require_tasks
+        path = @entry.gsub(/\.rb/,'')
+        require path
+      end
+
+      def expose_tasks
+        @task_classes = eval(File.read(@entry)).tasks
       end
 
       private
 
       def valid?(task_class)
-        task_class.superclass == TASK_NAMESPACE::Base
+        task_class.ancestors.include? ::Duty::Tasks::Base
       end
     end
   end

data/lib/duty/registry.rb

@@ -1,7 +1,7 @@
 module Duty
   class Registry
-    def self.load(plugins = [])
-      new(plugins).tap {|registry| registry.require_tasks }
+    def self.register(plugins = [])
+      new(plugins).tap {|registry| registry.load_tasks }
     end
 
     attr_reader :plugins
@@ -9,8 +9,8 @@ module Duty
       @plugins = plugins
     end
 
-    def require_tasks
-      plugins.each {|plugin| plugin.require_tasks }
+    def load_tasks
+      plugins.each {|plugin| plugin.load_tasks }
     end
   end
 end

data/lib/duty/task_runner.rb

@@ -0,0 +1,41 @@
+module Duty
+  class TaskRunner
+    def initialize(view, input, registry)
+      @view = view
+      @input = input
+      @plugins = registry.plugins
+    end
+
+    def self.run(view, input, plugins)
+      self.new(view, input, plugins).run
+    end
+
+    def run
+      task_class.new(task_input, view).run
+    end
+
+    private
+
+    attr_reader :view
+
+    def task_class
+      name = task_name.split('-').collect(&:capitalize).join
+      @plugins.each do |plugin|
+        plugin.tasks.each do |task_class|
+          if task_class.to_s.split("::").last == name
+            @task_class = task_class
+          end
+        end
+      end
+      @task_class
+    end
+
+    def task_input
+      @input.task_input
+    end
+
+    def task_name
+      @input.task_name
+    end
+  end
+end

data/lib/duty/tasks.rb

@@ -35,9 +35,9 @@ module Duty
       end
 
       def execute
-        ruby(Proc.new{},'Describe your task')
-        ruby(Proc.new{},'Explain your task')
-        ruby(Proc.new{ raise ExecutionError.new },'TODO: Implement your task by overwriting `execute`')
+        ruby('Describe your task') {}
+        ruby('Explain your task') {}
+        ruby('TODO: Implement your task by overwriting `execute`') { raise ExecutionError.new }
       end
 
       private

data/lib/duty/version.rb

@@ -1,3 +1,3 @@
 module Duty
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/duty/views/cli.rb

@@ -0,0 +1,113 @@
+require 'duty/meta'
+
+module Duty
+  module Views
+    module CLI
+      class Normal
+        def initialize(cli, input, output)
+          @cli = cli
+          @input = input
+          @output = output
+        end
+
+        def duty_explain
+          output.print meta_help_message 
+        end
+
+        def task_complete
+          output.print meta_completion_message 
+        end
+
+        def task_explain(task)
+          task_class = task.class
+          description = task_class.description
+          usage = task_class.usage
+
+          output.print(description)
+          output.print(usage)
+        end
+
+        def task_success(task)
+          task_name = task.class.name
+          success("#{task_name} task executed")
+        end
+
+        def task_failure(task)
+          task_name = task.class.name
+          failure("#{task_name} task aborted")
+        end
+
+        def task_invalid(error)
+          error_message = "duty: `#{input.join(' ')}` is not a duty task. Failed with: #{error.message}"
+          output.print error_message
+        end
+
+        def command_success(command)
+          description = command.description
+          success(description)
+        end
+
+        def command_failure(command)
+          description = command.description
+          failure(description)
+        end
+
+        private
+
+        attr_reader :cli, :input, :output
+
+        def success(msg)
+          output.print([check_mark, msg].join(' '))
+        end
+
+        def failure(msg)
+          output.error([cross_mark, msg].join(' '))
+        end
+
+        def cross_mark
+          unicode("2715")
+        end
+
+        def check_mark
+          unicode("2713")
+        end
+
+        def unicode(code)
+          ["0x#{code}".hex].pack('U')
+        end
+
+        def meta_help_message
+          Duty::Meta::Help.new(cli).to_s
+        end
+
+        def meta_completion_message
+          Duty::Meta::Completion.new(cli, input.drop(1)).to_s
+        end
+      end
+
+      class Verbose < Normal
+        def command_success(command)
+          success(command_msg(command))
+        end
+
+        def command_failure(command)
+          failure(command_msg(command))
+        end
+
+        private
+
+        def command_msg(command)
+          [command.description, command_logs(command)].join(' ')
+        end
+
+        def command_logs(command)
+          elements = command.logger.flatten
+
+          if elements.any?
+            ["|>", elements.join(' | ')].join(' ')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/duty/views.rb

@@ -0,0 +1,6 @@
+require 'duty/views/cli'
+
+module Duty
+  module Views
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duty
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jan Owiesniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -62,14 +62,19 @@ files:
 - duty.gemspec
 - lib/duty.rb
 - lib/duty/cli.rb
+- lib/duty/io.rb
+- lib/duty/io/cli.rb
 - lib/duty/meta.rb
 - lib/duty/meta/completion.rb
 - lib/duty/meta/help.rb
 - lib/duty/meta/humanizer.rb
 - lib/duty/plugins.rb
 - lib/duty/registry.rb
+- lib/duty/task_runner.rb
 - lib/duty/tasks.rb
 - lib/duty/version.rb
+- lib/duty/views.rb
+- lib/duty/views/cli.rb
 homepage: https://github.com/JanOwiesniak/duty
 licenses:
 - MIT