libis-workflow 2.0.24 → 2.0.25

data/Rakefile

@@ -1,7 +1,7 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new('spec')
-
-desc 'run tests'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+desc 'run tests'
 task :default => :spec

data/lib/libis/exceptions.rb

@@ -1,6 +1,6 @@
-module Libis
-  class WorkflowError < ::RuntimeError
-  end
-  class WorkflowAbort < ::RuntimeError
-  end
-end
+module Libis
+  class WorkflowError < ::RuntimeError
+  end
+  class WorkflowAbort < ::RuntimeError
+  end
+end

data/lib/libis/workflow.rb

@@ -1,41 +1,41 @@
-require 'libis/exceptions'
-
-require_relative 'workflow/version'
-
-module Libis
-  module Workflow
-
-    autoload :MessageRegistry, 'libis/workflow/message_registry'
-    autoload :Config, 'libis/workflow/config'
-
-    module Base
-      autoload :WorkItem, 'libis/workflow/base/work_item'
-      autoload :FileItem, 'libis/workflow/base/file_item'
-      autoload :DirItem, 'libis/workflow/base/dir_item'
-      autoload :Logging, 'libis/workflow/base/logging'
-      autoload :Job, 'libis/workflow/base/job'
-      autoload :Run, 'libis/workflow/base/run'
-      autoload :Workflow, 'libis/workflow/base/workflow'
-    end
-
-    autoload :Status, 'libis/workflow/status'
-
-    autoload :WorkItem, 'libis/workflow/work_item'
-    autoload :FileItem, 'libis/workflow/file_item'
-    autoload :DirItem, 'libis/workflow/dir_item'
-
-    autoload :Workflow, 'libis/workflow/workflow'
-    autoload :Job, 'libis/workflow/job'
-    autoload :Run, 'libis/workflow/run'
-    autoload :Task, 'libis/workflow/task'
-    autoload :TaskGroup, 'libis/workflow/task_group'
-    autoload :TaskRunner, 'libis/workflow/task_runner'
-
-    autoload :Worker, 'libis/workflow/worker'
-
-    def self.configure
-      yield Config.instance
-    end
-
-  end
-end
+require 'libis/exceptions'
+
+require_relative 'workflow/version'
+
+module Libis
+  module Workflow
+
+    autoload :MessageRegistry, 'libis/workflow/message_registry'
+    autoload :Config, 'libis/workflow/config'
+
+    module Base
+      autoload :WorkItem, 'libis/workflow/base/work_item'
+      autoload :FileItem, 'libis/workflow/base/file_item'
+      autoload :DirItem, 'libis/workflow/base/dir_item'
+      autoload :Logging, 'libis/workflow/base/logging'
+      autoload :Job, 'libis/workflow/base/job'
+      autoload :Run, 'libis/workflow/base/run'
+      autoload :Workflow, 'libis/workflow/base/workflow'
+    end
+
+    autoload :Status, 'libis/workflow/status'
+
+    autoload :WorkItem, 'libis/workflow/work_item'
+    autoload :FileItem, 'libis/workflow/file_item'
+    autoload :DirItem, 'libis/workflow/dir_item'
+
+    autoload :Workflow, 'libis/workflow/workflow'
+    autoload :Job, 'libis/workflow/job'
+    autoload :Run, 'libis/workflow/run'
+    autoload :Task, 'libis/workflow/task'
+    autoload :TaskGroup, 'libis/workflow/task_group'
+    autoload :TaskRunner, 'libis/workflow/task_runner'
+
+    autoload :Worker, 'libis/workflow/worker'
+
+    def self.configure
+      yield Config.instance
+    end
+
+  end
+end

data/lib/libis/workflow/action.rb

@@ -1,24 +1,24 @@
-module Libis
-  module Workflow
-    module Action
-
-      RUN = 0
-      CONTINUE = 1
-      RETRY = 2
-      ALWAYS_RUN = 3
-      FAILED = 4
-
-      def next_success_action(action)
-        case action
-          when :run, :continue, :retry, :always_run
-            :always_run
-          when :failed
-            :failed
-          else
-            :failed
-        end
-      end
-
-    end
-  end
-end
+module Libis
+  module Workflow
+    module Action
+
+      RUN = 0
+      CONTINUE = 1
+      RETRY = 2
+      ALWAYS_RUN = 3
+      FAILED = 4
+
+      def next_success_action(action)
+        case action
+          when :run, :continue, :retry, :always_run
+            :always_run
+          when :failed
+            :failed
+          else
+            :failed
+        end
+      end
+
+    end
+  end
+end

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

@@ -1,13 +1,13 @@
-require 'libis/workflow/base/file_item'
-
-module Libis
-  module Workflow
-    module Base
-
-      module DirItem
-        include ::Libis::Workflow::Base::FileItem
-      end
-
-    end
-  end
-end
+require 'libis/workflow/base/file_item'
+
+module Libis
+  module Workflow
+    module Base
+
+      module DirItem
+        include ::Libis::Workflow::Base::FileItem
+      end
+
+    end
+  end
+end

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

@@ -1,80 +1,80 @@
-require 'digest'
-
-require 'libis/workflow/base/work_item'
-
-module Libis
-  module Workflow
-    module Base
-
-      # noinspection RubyResolve
-      module FileItem
-        include Libis::Workflow::Base::WorkItem
-
-        def filename
-          File.basename(self.properties['filename']) || self.properties['link']
-        end
-
-        def name
-          self.properties['name'] || self.filename
-        end
-
-        def filelist
-          (self.parent.filelist rescue Array.new).push(filename).compact
-        end
-
-        def filepath
-          self.filelist.join('/')
-        end
-
-        def fullpath
-          self.properties['filename']
-        end
-
-        def filename=(name)
-          begin
-            stats = ::File.stat name
-            self.properties['size'] = stats.size
-            self.properties['access_time'] = stats.atime
-            self.properties['modification_time'] = stats.mtime
-            self.properties['creation_time'] = stats.ctime
-            self.properties['mode'] = stats.mode
-            self.properties['uid'] = stats.uid
-            self.properties['gid'] = stats.gid
-            set_checksum(:MD5, ::Digest::MD5.hexdigest(File.read(name))) if File.file?(name)
-          rescue
-            # ignored
-          end
-          self.properties['filename'] = name
-        end
-
-        def checksum(checksum_type)
-          self.properties[('checksum_' + checksum_type.to_s.downcase)]
-        end
-
-        def set_checksum(checksum_type, value)
-          self.properties[('checksum_' + checksum_type.to_s.downcase)] = value
-        end
-
-        def link
-          self.properties['link']
-        end
-
-        def link=(name)
-          self.properties['link'] = name
-        end
-
-        def set_info(info)
-          info.each do |k, v|
-            self.properties[k] = v
-          end
-        end
-
-        def safe_name
-          self.name.to_s.gsub(/[^\w.-]/) { |s| '%%%02x' % s.ord }
-        end
-
-      end
-
-    end
-  end
-end
+require 'digest'
+
+require 'libis/workflow/base/work_item'
+
+module Libis
+  module Workflow
+    module Base
+
+      # noinspection RubyResolve
+      module FileItem
+        include Libis::Workflow::Base::WorkItem
+
+        def filename
+          File.basename(self.properties['filename']) || self.properties['link']
+        end
+
+        def name
+          self.properties['name'] || self.filename
+        end
+
+        def filelist
+          (self.parent.filelist rescue Array.new).push(filename).compact
+        end
+
+        def filepath
+          self.filelist.join('/')
+        end
+
+        def fullpath
+          self.properties['filename']
+        end
+
+        def filename=(name)
+          begin
+            stats = ::File.stat name
+            self.properties['size'] = stats.size
+            self.properties['access_time'] = stats.atime
+            self.properties['modification_time'] = stats.mtime
+            self.properties['creation_time'] = stats.ctime
+            self.properties['mode'] = stats.mode
+            self.properties['uid'] = stats.uid
+            self.properties['gid'] = stats.gid
+            set_checksum(:MD5, ::Digest::MD5.hexdigest(File.read(name))) if File.file?(name)
+          rescue
+            # ignored
+          end
+          self.properties['filename'] = name
+        end
+
+        def checksum(checksum_type)
+          self.properties[('checksum_' + checksum_type.to_s.downcase)]
+        end
+
+        def set_checksum(checksum_type, value)
+          self.properties[('checksum_' + checksum_type.to_s.downcase)] = value
+        end
+
+        def link
+          self.properties['link']
+        end
+
+        def link=(name)
+          self.properties['link'] = name
+        end
+
+        def set_info(info)
+          info.each do |k, v|
+            self.properties[k] = v
+          end
+        end
+
+        def safe_name
+          self.name.to_s.gsub(/[^\w.-]/) { |s| '%%%02x' % s.ord }
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -1,83 +1,83 @@
-require 'libis/tools/parameter'
-
-module Libis
-  module Workflow
-    module Base
-
-      # This is the base module for Jobs.
-      #
-      # This module lacks the implementation for the data attributes. It functions as an interface that describes the
-      # common functionality regardless of the storage implementation. These attributes require some implementation:
-      #
-      # - name: [String] the name of the Job. The name will be used to identify the job. Each time a job is executed,
-      #     a Run will be created for the associated workflow. The Run will get a name that starts with the job name
-      #     and ends with the date and time the Run was first started. As such this name attribute serves as an
-      #     identifier and should be treated as such. If possible it should be unique.
-      # - description: [String] optional information about the job.
-      # - workflow: [Object] the workflow containing the tasks that need to run.
-      # - run_obj: [String] the full class name of the Run implementation object that should be created when the
-      #     Job is executed.
-      # - input: [Hash] workflow input parameter values. Each input parameter of the workflow can be set by the entries
-      #     in this Hash.
-      #
-      # A minimal in-memory implementation could be:
-      #
-      # class Job
-      #   include ::Libis::Workflow::Base::Job
-      #
-      #   attr_accessor :name, :description, :workflow, :run_object, :input
-      #
-      #   def initialize
-      #     @name = ''
-      #     @description = ''
-      #     @input = Hash.new
-      #     @workflow = ::Libis::Workflow::Workflow.new
-      #     @run_object = ::Libis::Workflow::Run.new
-      #   end
-      #
-      # end
-      #
-      module Job
-
-        def run_name(timestamp = Time.now)
-          "#{self.name}-#{timestamp.strftime('%Y%m%d%H%M%S')}"
-        end
-
-        def configure(cfg = {})
-          self.name ||= ''
-          self.description ||= ''
-          self.input ||= {}
-          self.name = cfg['name'] if cfg.has_key?('name')
-          self.description = cfg['description'] if cfg.has_key?('description')
-          self.workflow = cfg['workflow'] if cfg.has_key?('workflow')
-          self.run_object = cfg['run_object'] if cfg.has_key?('run_object')
-          self.input.merge!(cfg['input'] || {})
-        end
-
-        # noinspection RubyResolve
-        # @param [Hash] opts optional extra conguration values for this particular run
-        def execute(opts = {})
-          run = self.create_run_object
-          raise RuntimeError.new "Could not create instance of run object '#{self.run_object}'" unless run
-
-          run.job = self
-          (opts.delete('run_config') || {}).each { |key,value| run.send("#{key}=", value) }
-          run.options = self.input.merge(opts)
-          run.save!
-
-          run.run
-
-          run
-        end
-
-        protected
-
-        # noinspection RubyResolve
-        def create_run_object
-          self.run_object.constantize.new
-        end
-
-      end
-    end
-  end
-end
+require 'libis/tools/parameter'
+
+module Libis
+  module Workflow
+    module Base
+
+      # This is the base module for Jobs.
+      #
+      # This module lacks the implementation for the data attributes. It functions as an interface that describes the
+      # common functionality regardless of the storage implementation. These attributes require some implementation:
+      #
+      # - name: [String] the name of the Job. The name will be used to identify the job. Each time a job is executed,
+      #     a Run will be created for the associated workflow. The Run will get a name that starts with the job name
+      #     and ends with the date and time the Run was first started. As such this name attribute serves as an
+      #     identifier and should be treated as such. If possible it should be unique.
+      # - description: [String] optional information about the job.
+      # - workflow: [Object] the workflow containing the tasks that need to run.
+      # - run_obj: [String] the full class name of the Run implementation object that should be created when the
+      #     Job is executed.
+      # - input: [Hash] workflow input parameter values. Each input parameter of the workflow can be set by the entries
+      #     in this Hash.
+      #
+      # A minimal in-memory implementation could be:
+      #
+      # class Job
+      #   include ::Libis::Workflow::Base::Job
+      #
+      #   attr_accessor :name, :description, :workflow, :run_object, :input
+      #
+      #   def initialize
+      #     @name = ''
+      #     @description = ''
+      #     @input = Hash.new
+      #     @workflow = ::Libis::Workflow::Workflow.new
+      #     @run_object = ::Libis::Workflow::Run.new
+      #   end
+      #
+      # end
+      #
+      module Job
+
+        def run_name(timestamp = Time.now)
+          "#{self.name}-#{timestamp.strftime('%Y%m%d%H%M%S')}"
+        end
+
+        def configure(cfg = {})
+          self.name ||= ''
+          self.description ||= ''
+          self.input ||= {}
+          self.name = cfg['name'] if cfg.has_key?('name')
+          self.description = cfg['description'] if cfg.has_key?('description')
+          self.workflow = cfg['workflow'] if cfg.has_key?('workflow')
+          self.run_object = cfg['run_object'] if cfg.has_key?('run_object')
+          self.input.merge!(cfg['input'] || {})
+        end
+
+        # noinspection RubyResolve
+        # @param [Hash] opts optional extra conguration values for this particular run
+        def execute(opts = {})
+          run = self.create_run_object
+          raise RuntimeError.new "Could not create instance of run object '#{self.run_object}'" unless run
+
+          run.job = self
+          (opts.delete('run_config') || {}).each { |key,value| run.send("#{key}=", value) }
+          run.options = self.input.merge(opts)
+          run.save!
+
+          run.run
+
+          run
+        end
+
+        protected
+
+        # noinspection RubyResolve
+        def create_run_object
+          self.run_object.constantize.new
+        end
+
+      end
+    end
+  end
+end