libis-workflow 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91b0c182d5d2f5214287dc2cd50eb0a7b9f4fbd3
-  data.tar.gz: 6c51f5afcd524d2314e05b5cf14f66aeb30e050b
+  metadata.gz: 4b3ce4d596ca40c95f30e64d6f739020bf19994b
+  data.tar.gz: 639124a5d3ba1474a390ddc8d396571c15d81e91
 SHA512:
-  metadata.gz: c9c2b825f8ce8b5d6007975770e45694a8c6710ebc4a6f13cc37eb51810424c31867bfe8057195680893d68c8adf1e34a007c08257fbba198e5574423994a63f
-  data.tar.gz: 9f248db1a5e6ceb17560ed91534535783abf295e0b27130688721d7746496e91b0a77996bfcac3ec503495839f1f21a25e163d7ada667dfc5957b8e7510cf1df
+  metadata.gz: 0d09e49198e9b416278ac074fb2e9a1cfa9eb19aaa9bc28348697b9c8cc2373bc059d12e743012519053fc6b102f0f74c3f4a364abbf6e14d033f11c2100f717
+  data.tar.gz: 7b71eeb726ba6b7aabf4faf7667b1770b1f35c7ca379fbc6197ebbc8c47cada61620639278ef108769792247244b44968707e8aeed5ab70a388999ebe7cd3c3e

data/lib/libis/workflow/base/logging.rb

@@ -3,25 +3,6 @@ module Libis
     module Base
       module Logging
 
-        # Helper function for the WorkItems to add a log entry to the log_history.
-        #
-        # The supplied message structure is expected to contain the following fields:
-        # - :severity : ::Logger::Severity value
-        # - :id : optional message id
-        # - :text : message text
-        # - :task : list of tasks names (task hierarchy) that submits the message
-        #
-        # @param [Hash] message
-        def add_log(message = {})
-          msg = message_struct(message)
-          add_log_entry(msg)
-          self.save
-        end
-
-        def <=(message = {})
-          self.add_log(message)
-        end
-
         # Add a structured message to the log history. The message text can be submitted as an integer or text. If an
         # integer is submitted, it will be used to look up the text in the MessageRegistry. The message text will be
         # passed to the % operator with the args parameter. If that failes (e.g. because the format string is not correct)
@@ -45,31 +26,35 @@ module Libis
           run_id = self.get_run.id rescue nil
 
           self.add_log severity: severity, id: message_id.to_i, text: message_text, task: task, run_id: run_id
+        end
 
-          task = "[#{run_id}] #{task}" if run_id
-          name = ''
-          begin
-            name = self.to_s
-            name = self.name
-            name = self.namepath
-          rescue
-            # do nothing
-          end
+        # Helper function for the WorkItems to add a log entry to the log_history.
+        #
+        # The supplied message structure is expected to contain the following fields:
+        # - :severity : ::Logger::Severity value
+        # - :id : optional message id
+        # - :text : message text
+        # - :task : list of tasks names (task hierarchy) that submits the message
+        #
+        # @param [Hash] message
+        def add_log(message = {})
+          msg = message_struct(message)
+          add_log_entry(msg)
+          self.save
+        end
 
-          logger = self.get_run.logger rescue Config.logger
-          logger.add(severity, message_text, ('%s - %s ' % [task, name]))
+        def <=(message = {})
+          self.add_log(message)
         end
 
         protected
 
-        SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL ANY) unless const_defined? :SEV_LABEL
-
         # create and return a proper message structure
         # @param [Hash] opts
         def message_struct(opts = {})
-          opts.reverse_merge!(severity: ::Logger::INFO, code: nil, text: '')
+          opts.reverse_merge!(severity: :info, code: nil, text: '')
           {
-              severity: SEV_LABEL[opts[:severity]],
+              severity: ::Logging::levelify(opts[:severity]).upcase,
               task: opts[:task],
               code: opts[:code],
               message: opts[:text]

data/lib/libis/workflow/base/run.rb

@@ -49,6 +49,10 @@ module Libis
           self.job.workflow
         end
 
+        def logger
+          self.properties['logger'] || self.job.logger rescue ::Libis::Workflow::Config.logger
+        end
+
         # Execute the workflow.
         #
         # The action parameter defines how the execution of the tasks will behave:
@@ -65,10 +69,9 @@ module Libis
 
           self.options = workflow.prepare_input(self.options)
 
-          self.tasks = workflow.tasks(self)
+          self.tasks = workflow.tasks
           configure_tasks self.options
 
-
           self.tasks.each do |task|
             task.run self
           end

data/lib/libis/workflow/base/workflow.rb

@@ -132,7 +132,7 @@ module Libis
 
         def tasks(parent = nil)
           self.config[:tasks].map do |cfg|
-            instantize_task(parent || self, cfg)
+            instantize_task(parent || nil, cfg)
           end
         end
 

data/lib/libis/workflow/task.rb

@@ -4,6 +4,7 @@ require 'backports/rails/string'
 
 require 'libis/tools/parameter'
 require 'libis/tools/extend/hash'
+require 'libis/tools/logger'
 
 require 'libis/workflow'
 
@@ -12,7 +13,7 @@ module Libis
 
     # noinspection RubyTooManyMethodsInspection
     class Task
-      include ::Libis::Workflow::Base::Logger
+      include ::Libis::Tools::Logger
       include ::Libis::Tools::ParameterContainer
 
       attr_accessor :parent, :name, :workitem
@@ -116,9 +117,33 @@ module Libis
             self.parameter(name.to_sym, value)
           end
         end
+      end
 
+      def message(severity, msg, *args)
+        taskname = self.namepath rescue nil
+        self.set_application(taskname)
+        item = self.workitem
+        item = args.shift if args.size > 0 and args[0].is_a?(::Libis::Workflow::Base::WorkItem)
+        if item
+          subject = nil
+          begin
+            subject = item.to_s
+            subject = item.name
+            subject = item.namepath
+          rescue
+            # do nothing
+          end
+          self.set_subject(subject)
+          item.log_message(
+              severity, msg.is_a?(Integer) ? {id: msg} : {text: (msg.to_s rescue '')}.merge(task: taskname), *args
+          )
+        end
+        super severity, msg, *args
       end
 
+      def logger
+        (self.parent || self.get_run).logger
+      end
       protected
 
       def configure(cfg)
@@ -204,11 +229,15 @@ module Libis
       end
 
       def action=(action)
-        self.workitem.get_run.action = action
+        self.get_run.action = action
       end
 
       def action
-        self.workitem.get_run.action
+        self.get_run.action
+      end
+
+      def get_run(item = nil)
+        get_root_item(item).get_run
       end
 
       def get_root_item(item = nil)

data/lib/libis/workflow/version.rb

@@ -2,6 +2,6 @@
 
 module Libis
   module Workflow
-    VERSION = '2.0.0' unless const_defined? :VERSION # the guard is against a redefinition warning that happens on Travis
+    VERSION = '2.0.1' unless const_defined? :VERSION # the guard is against a redefinition warning that happens on Travis
   end
 end

data/lib/libis/workflow.rb

@@ -13,7 +13,6 @@ module Libis
       autoload :WorkItem, 'libis/workflow/base/work_item'
       autoload :FileItem, 'libis/workflow/base/file_item'
       autoload :DirItem, 'libis/workflow/base/dir_item'
-      autoload :Logger, 'libis/workflow/base/logger'
       autoload :Logging, 'libis/workflow/base/logging'
       autoload :Job, 'libis/workflow/base/job'
       autoload :Run, 'libis/workflow/base/run'

data/spec/workflow_spec.rb

@@ -4,21 +4,24 @@ require 'stringio'
 
 describe 'TestWorkflow' do
 
-  let(:basedir) { File.absolute_path File.join(File.dirname(__FILE__)) }
-  let(:dirname) { File.join(basedir, 'items') }
+  basedir = File.absolute_path File.join(File.dirname(__FILE__))
+  dirname = File.join(basedir, 'items')
 
-  let(:logoutput) { StringIO.new }
+  before :each do
 
-  let(:workflow) {
     # noinspection RubyResolve
     ::Libis::Workflow.configure do |cfg|
       cfg.itemdir = dirname
       cfg.taskdir = File.join(basedir, 'tasks')
       cfg.workdir = File.join(basedir, 'work')
-      cfg.logger = Logger.new logoutput
-      cfg.logger.level = Logger::DEBUG
+      cfg.logger.appenders =
+          ::Logging::Appenders.string_io('StringIO', layout: ::Libis::Tools::Config.get_log_formatter)
     end
+  end
+
+  let(:logoutput) { ::Libis::Workflow::Config.logger.appenders.first.sio }
 
+  let(:workflow) {
     workflow = ::Libis::Workflow::Workflow.new
     workflow.configure(
         name: 'TestWorkflow',
@@ -106,6 +109,8 @@ STR
     run = job.execute
     output = logoutput.string.lines.to_a
 
+    # puts output
+
     expect(output.size).to eq sample_out.size
     output.each_with_index do |o, i|
       expect(o[/(?<=\] ).*/]).to eq sample_out[i].strip

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-workflow
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,11 +125,9 @@ files:
 - lib/libis/exceptions.rb
 - lib/libis/workflow.rb
 - lib/libis/workflow/action.rb
-- lib/libis/workflow/base.rb
 - lib/libis/workflow/base/dir_item.rb
 - lib/libis/workflow/base/file_item.rb
 - lib/libis/workflow/base/job.rb
-- lib/libis/workflow/base/logger.rb
 - lib/libis/workflow/base/logging.rb
 - lib/libis/workflow/base/run.rb
 - lib/libis/workflow/base/work_item.rb
@@ -194,3 +192,4 @@ test_files:
 - spec/tasks/checksum_tester.rb
 - spec/tasks/collect_files.rb
 - spec/workflow_spec.rb
+has_rdoc: 

data/lib/libis/workflow/base/logger.rb

@@ -1,30 +0,0 @@
-require 'libis/tools/logger'
-
-module Libis
-  module Workflow
-    module Base
-      module Logger
-        include ::Libis::Tools::Logger
-
-        def message(severity, msg, *args)
-          item = self.workitem
-          item = args.shift if args.size > 0 and args[0].is_a?(WorkItem)
-
-          item.log_message(severity, to_msg(msg), *args) if item
-        end
-
-        def to_msg(msg)
-          case msg
-            when String
-              {text: msg}
-            when Integer
-              {id: msg}
-            else
-              {text: (msg.to_s rescue '')}
-          end.merge task: self.namepath
-        end
-
-      end
-    end
-  end
-end

data/lib/libis/workflow/base.rb

@@ -1,7 +0,0 @@
-require_relative 'base/logger'
-require_relative 'base/logging'
-require_relative 'base/work_item'
-require_relative 'base/file_item'
-require_relative 'base/dir_item'
-require_relative 'base/run'
-require_relative 'base/workflow'