speedflow 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27374a1174d79f26fffb0eb47bbf2c59b89e315e
-  data.tar.gz: 07e584e9c840f44764c33b92ee57302718aa42a0
+  metadata.gz: 0917a8d9f55cf6d722cbf1819dca1acf62d41262
+  data.tar.gz: d48c35ef4a5970b059a9d7b042100ce1bac65921
 SHA512:
-  metadata.gz: e5bda2467bf65a6b4078a86e52cafcca8655cb991b23402557559f1ed228929b3f6768d7b965cd76f6fd0ebb6ca4f5eabd589bd66bc67a34933788711dbd6bf7
-  data.tar.gz: 2691daaa4db69e66ffd1cc4e1f7f422a7a48dfb84ce2fab5e832c3d29912d6b96461fcab82d2627f1eee9fa816a43abd60d0bab61bd51fb2e43742fcd848c196
+  metadata.gz: 2797aaa19a525241bf15896d817f4a5c0f3f5b9fc275069590b866f35750e92e67e1906268485d88393be70e9bad117d0fb274f3364c5ed3995c852f058f87e2
+  data.tar.gz: a24938e6ed76a465575956ac154f2f73acef4714b9e64f95c8559943f5edda878baa2a845c2a1beddbb0e2837b80777aed15cf121f2edcd6e9b462203e3839b9

data/bin/speedflow

@@ -4,6 +4,9 @@ STDOUT.sync = true
 require 'mercenary'
 require 'speedflow'
 
+# Kill exiting error
+Signal.trap('SIGINT') { exit 130 }
+
 # Speedflow program
 Mercenary.program(:speedflow) do |program|
   program.version Speedflow::VERSION

data/lib/speedflow/commands/flow.rb

@@ -58,7 +58,7 @@ module Speedflow
             success "Trigger '#{trigger}' successful"
           rescue FlowTriggerNotFound => exception
             error "Trigger '#{trigger}' error: #{exception.message}"
-          rescue PluginNotFound => exception
+          rescue Plugin::PluginNotFound => exception
             error "Plugin error: #{exception.message}"
           end
         end

data/lib/speedflow/flow.rb

@@ -12,33 +12,57 @@ module Speedflow
     #
     # Returns a Hash of config.
     def initialize(config)
+      # TODO: v0.4: Reinforce the SOI.
       @config = config
     end
 
     # Public: Trigger.
     #
     # trigger - Trigger name.
-    # inputs  - Inputs.
+    # input   - Input Hash.
     #
     # Returns nothing.
-    def trigger(trigger, inputs)
+    def trigger(trigger, input)
+      # TODO: v0.4: Change by: Configuration.not_empty_key?
+      # TODO: v0.4: Move to this class: Flow.trigger?
       unless @config.flow_trigger?(trigger)
         raise FlowTriggerNotFound, "Unable to trigger: #{trigger}"
       end
 
+      # TODO: v0.4: Move in a normal object tree: Flow > Trigger > Action
+      output_by_tag = {}
       output = {}
       @config['flow'][trigger.to_s].each do |step|
-        arguments = step['arguments'] || {}
+        output = trigger_step(step, input, output, output_by_tag)
+      end
+    end
 
-        step['arguments'] = transform_arguments(arguments, output, inputs)
-        step['arguments'] = add_config_argument(arguments)
+    # Public: Trigger step
+    #
+    # step          - Step Hash.
+    # input         - Input Hash.
+    # output        - Output Hash.
+    # output_by_tag - Output by tag Hash.
+    #
+    # Returns output Hash.
+    def trigger_step(step, input, output, output_by_tag)
+      arguments = step['arguments'] || {}
 
-        output = plugin_manager.call_action_from_step(step)
-      end
+      # TODO: v0.4: Move to a normal object: TriggerArgument
+      step['arguments'] = transform_arguments(arguments, output, input)
+      step['arguments'] = add_config_argument(arguments)
+
+      # TODO: v0.4: Move to a normal object: TriggerArgument
+      output = plugin_manager.action_from_step(step)
+      output_by_tag[step['tag']] = output if step.key? 'tag'
+
+      output.merge(output_by_tag)
     end
 
     # Public: Add config arguement
     #
+    # TODO: v0.4: Move to a normal object: TriggerArgument
+    #
     # arguments   - Hash of arguments.
     #
     # Returns Hash of arguments.
@@ -53,6 +77,8 @@ module Speedflow
 
     # Public: Transform arguments (to add value)
     #
+    # TODO: v0.4: Move to a normal object: TriggerArgument
+    #
     # arguments   - Hash of arguments.
     # prev_values - Hash of previous values.
     # inputs      - Hash of inputs.
@@ -73,6 +99,8 @@ module Speedflow
 
     # Public: Get flat arguments from flow.
     #
+    # TODO: v0.4: Move to a normal object: TriggerArgument
+    #
     # Returns flat Array of arguments.
     def flat_arguments
       args = []
@@ -88,7 +116,7 @@ module Speedflow
     #
     # Returns an instance of plugin manager.
     def plugin_manager
-      @plugin_manager ||= PluginManager.new(@config['plugins'])
+      @plugin_manager ||= Plugin::Manager.new(@config['plugins'])
     end
   end
 

data/lib/speedflow/message.rb

@@ -1,5 +1,6 @@
 # Speedflow core
 module Speedflow
+  # TODO: v0.4: Remove, use TTY::Prompt.
   require 'colorize'
   # Used to manage the output message
   module Message

data/lib/speedflow/plugin/abstract.rb

@@ -0,0 +1,30 @@
+module Speedflow
+  module Plugin
+    # Plugin abstraction
+    class Abstract
+      # @return [Speedflow::Plugin::Configuration] Plugin configuration.
+      attr_reader :config
+
+      # @return [Speedflow::Plugin::Prompt] Plugin prompt.
+      attr_reader :prompt
+
+      # Public: Constructor
+      #
+      # config - Speedflow::Plugin::Configuration object.
+      # prompt - Speedflow::Plugin::Prompt object.
+      #
+      # Examples
+      #
+      #    Manager.new(
+      #      <Speedflow::Plugin::Configuration.new({})>,
+      #      <Speedflow::Plugin::Prompt.new>)
+      #    # => <Speedflow::Plugin::Abstract>
+      #
+      # Returns nothing.
+      def initialize(config, prompt)
+        @config = config
+        @prompt = prompt
+      end
+    end
+  end
+end

data/lib/speedflow/plugin/configuration.rb

@@ -0,0 +1,97 @@
+module Speedflow
+  module Plugin
+    # Plugin configuration
+    class Configuration
+      CONFIG_KEY = '_config'.freeze
+
+      # Initialize.
+      #
+      # arguments   - Hash of arguments.
+      # plugin_name - Name of plugin.
+      #
+      # Examples
+      #
+      #    Configuration.new({}, 'plugin')
+      #    # => <Speedflow::Plugin::Configuration>
+      #
+      # Returns nothing.
+      def initialize(arguments, plugin_name)
+        @arguments   = arguments
+        @plugin_name = plugin_name
+      end
+
+      # Public: All config.
+      #
+      # Returns Hash of all config.
+      def all_config
+        @arguments.key?(CONFIG_KEY) ? @arguments[CONFIG_KEY] : {}
+      end
+
+      # Public: All input.
+      #
+      # Returns Hash of all input.
+      def all_input
+        @arguments.select { |k, _| k != CONFIG_KEY }
+      end
+
+      # Public: Get a specific config.
+      #
+      # key           - Key of config.
+      # default_value - Default value.
+      #
+      # Returns value of config key.
+      def by_config(key, default_value = '')
+        config = {}
+        if @arguments.key?(CONFIG_KEY)
+          if @arguments[CONFIG_KEY].key?(@plugin_name)
+            config = @arguments[CONFIG_KEY][@plugin_name]
+          end
+        end
+        config.key?(key) ? config[key].to_s : default_value.to_s
+      end
+
+      # Public: Get multiple config.
+      #
+      # keys_and_defaults - Hash of keys and defaults. { 'key' => 'default' }
+      #
+      # Returns Hash with values or defaults.
+      def by_multiple_config(keys_and_defaults)
+        keys_and_defaults.each { |k, v| keys_and_defaults[k] = by_config(k, v) }
+      end
+
+      # Public: Get an input config by key.
+      #
+      # key           - Key of config.
+      # default_value - Default value.
+      #
+      # Returns value of input config key.
+      def by_input(key, default_value = '')
+        if @arguments.key?(key)
+          @arguments[key]['value'].to_s
+        else
+          default_value.to_s
+        end
+      end
+
+      # Public: Get an input config by key but required.
+      #
+      # key           - Key of config.
+      # default_value - Default value.
+      #
+      # Returns value of input config key or Exception.
+      def by_required_input(key, default_value = '')
+        value = by_input(key, default_value)
+
+        if by_input(key).empty?
+          raise ConfigurationInputRequire, "Required value for '#{key}'."
+        end
+
+        value
+      end
+    end
+
+    # Input exception
+    class ConfigurationInputRequire < Exception
+    end
+  end
+end

data/lib/speedflow/plugin/manager.rb

@@ -0,0 +1,130 @@
+module Speedflow
+  # Plugin
+  module Plugin
+    # Used to manage the plugins
+    class Manager
+      include ActiveSupport::Inflector
+      # TODO: V2: Remove underground prompt.
+      include Message
+
+      PLUGIN_BASE = 'speedflow-plugin-'.freeze
+
+      # @return [Speedflow::Plugin::Configuration] Plugin configuration object.
+      attr_writer :config
+
+      # @return [Speedflow::Plugin::Prompt] Plugin prompt object.
+      attr_writer :prompt
+
+      # Public: Constructor
+      #
+      # plugins - Array of plugins
+      #
+      # Examples
+      #
+      #    Manager.new([])
+      #    # => <Speedflow::Plugin::Manager>
+      #
+      # Returns an Arrays of plugins.
+      def initialize(plugins = [])
+        @plugins = plugins || []
+        load_plugins
+      end
+
+      # Public: Load plugins
+      #
+      # Returns nothing.
+      def load_plugins
+        @plugins.each { |plugin| require_plugin(plugin) }
+      end
+
+      # Public: Require a plugins (from Gem)
+      #
+      # Returns nothing.
+      def require_plugin(plugin)
+        require plugin.downcase.prepend(PLUGIN_BASE)
+      rescue LoadError
+        message = "Unable to load plugin '#{plugin}'.\n"
+        message << "Help: `gem install #{PLUGIN_BASE}#{plugin}`"
+        raise PluginNotFound, message
+      end
+
+      # Call action from flow step.
+      #
+      # step - Hash from flow. {plugin: '', action: '', arguments: ''}.
+      #
+      # Returns nothing.
+      def action_from_step(step)
+        plugin = plugin(step['plugin'], step['arguments'])
+        action(plugin, step['action'])
+      end
+
+      # Call plugin.
+      #
+      # plugin_name - Plugin name.
+      # arguments   - List of arguments.
+      #
+      # Returns <Speedflow::Plugin::Abstract>.
+      def plugin(plugin_name, arguments)
+        configuration = config.new(arguments, plugin_name)
+        plugin_object(plugin_name).new(configuration, prompt.new)
+      end
+
+      # Call action.
+      #
+      # plugin_name - Plugin name.
+      # action_name - Action name.
+      # arguments   - List of arguments.
+      #
+      # Returns Hash of action output.
+      def action(plugin, action_name)
+        plugin_name = plugin.class.name.split('::')[-2].downcase
+        action_name = action_name.prepend('action_').underscore
+
+        unless plugin.respond_to?(action_name) && plugin_name == 'test'
+          message = "Unable to call action: #{plugin_name}.#{action_name}"
+          raise PluginActionNotFound, message
+        end
+
+        # TODO: v0.4: Remove underground prompt.
+        success "Run action '#{action_name}' of '#{plugin_name}' plugin."
+
+        plugin.send action_name
+      end
+
+      # Public: Get plugin object from plugin name
+      #
+      # plugin_name - Plugin name.
+      #
+      # TODO: v0.4: Create Utils::name_to_object method.
+      #
+      # Returns Object.
+      def plugin_object(plugin_name)
+        plugin_name = plugin_name.downcase.capitalize
+
+        "Speedflow::Plugin::#{plugin_name}::Plugin".constantize
+      end
+
+      # Public: Plugin configuration object.
+      #
+      # Returns Speedflow::Plugin::Configuration.
+      def config
+        @config ||= Configuration
+      end
+
+      # Public: Plugin prompt object.
+      #
+      # Returns Speedflow::Plugin::Prompt.
+      def prompt
+        @prompt ||= ::TTY::Prompt
+      end
+    end
+
+    # Plugin exception
+    class PluginNotFound < Exception
+    end
+
+    # Plugin action exception
+    class PluginActionNotFound < Exception
+    end
+  end
+end

data/lib/speedflow/plugin/prompt.rb

@@ -0,0 +1,39 @@
+require 'tty-prompt'
+
+module Speedflow
+  module Plugin
+    # Plugin prompt
+    class Prompt
+      # @return [TTY::Prompt] TTY::Prompt.
+      attr_writer :prompt
+
+      # Public: Errors.
+      #
+      # exception - StandardError.
+      #
+      # Returns nothing.
+      def errors(plugin_name, exception)
+        prompt.error "#{plugin_name.downcase.capitalize} errors"
+        prompt.warn exception.message
+      end
+
+      # Delegate.
+      #
+      # method - Method.
+      # args   - Arguments.
+      # block  - Block.
+      #
+      # Returns wathever.
+      def method_missing(method, *args, &block)
+        prompt.send(method, *args, &block)
+      end
+
+      # Public: TTY prompt.
+      #
+      # Returns ::TTY::Prompt instance.
+      def prompt
+        @prompt ||= ::TTY::Prompt.new
+      end
+    end
+  end
+end

data/lib/speedflow/version.rb

@@ -1,3 +1,3 @@
 module Speedflow
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/speedflow.rb

@@ -6,6 +6,7 @@ require 'safe_yaml/load'
 require_rel 'speedflow/*.rb'
 require_rel 'speedflow/core_ext/*.rb'
 require_rel 'speedflow/commands/*.rb'
+require_rel 'speedflow/plugin/*.rb'
 
 # Speedflow core
 module Speedflow

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speedflow
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Julien Breux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -42,16 +42,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,30 @@ dependencies:
   name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: speedflow-plugin-test
   requirement: !ruby/object:Gem::Requirement
@@ -242,7 +256,10 @@ files:
 - lib/speedflow/core_ext/hash.rb
 - lib/speedflow/flow.rb
 - lib/speedflow/message.rb
-- lib/speedflow/plugin_manager.rb
+- lib/speedflow/plugin/abstract.rb
+- lib/speedflow/plugin/configuration.rb
+- lib/speedflow/plugin/manager.rb
+- lib/speedflow/plugin/prompt.rb
 - lib/speedflow/version.rb
 homepage: https://github.com/speedflow/speedflow
 licenses:

data/lib/speedflow/plugin_manager.rb

@@ -1,80 +0,0 @@
-module Speedflow
-  # Used to manage the plugins
-  class PluginManager
-    include ActiveSupport::Inflector
-    include Message
-
-    PLUGIN_BASE = 'speedflow-plugin-'.freeze
-
-    # Public: Constructor
-    #
-    # plugins - Array of plugins
-    #
-    # Examples
-    #
-    #    PluginManager.new({})
-    #    # => <Speedflow::PluginManager>
-    #
-    # Returns an Arrays of plugins.
-    def initialize(plugins = [])
-      @plugins = plugins || []
-      load_plugins
-    end
-
-    # Public: Load plugins
-    #
-    # Returns nothing.
-    def load_plugins
-      @plugins.each { |plugin| require_plugin(plugin) }
-    end
-
-    # Public: Require a plugins (from Gem)
-    #
-    # Returns nothing.
-    def require_plugin(plugin)
-      require plugin.downcase.prepend(PLUGIN_BASE)
-    rescue LoadError
-      message = "Unable to load plugin '#{plugin}'.\n"
-      message << "Help: `gem install #{PLUGIN_BASE}#{plugin}`"
-      raise PluginNotFound, message
-    end
-
-    # Call action from flow step.
-    #
-    # step - Hash from flow. {plugin: '', action: '', arguments: ''}.
-    #
-    # Returns nothing.
-    def call_action_from_step(step)
-      step['arguments'] ||= {}
-      success "Run action '#{step['action']}' of '#{step['plugin']}' plugin."
-      call_plugin_action(step['plugin'], step['action'], step['arguments'])
-    end
-
-    # Call plugin action.
-    #
-    # plugin    - Plugin name.
-    # action    - Action name.
-    # arguments - List of arguments
-    #
-    # Returns nothing.
-    def call_plugin_action(plugin, action, arguments)
-      action = underscore(action.prepend('action_'))
-      module_name = plugin.downcase.capitalize.prepend('Speedflow::Plugin::')
-      begin
-        Kernel.const_get(module_name).send(action.to_s, arguments)
-      rescue NoMethodError => exception
-        message = "Unable to call action: #{module_name}.#{action}\n"
-        message << exception.message
-        raise PluginActionNotFound, message
-      end
-    end
-  end
-
-  # Plugin exception
-  class PluginNotFound < Exception
-  end
-
-  # Plugin action exception
-  class PluginActionNotFound < Exception
-  end
-end