Module: Libis::Workflow::Base::WorkItem

Includes:
Enumerable, Logging, Status
Included in:
FileItem, Run, WorkItem
Defined in:
lib/libis/workflow/base/work_item.rb

Overview

Base module for all work items.

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:

  • parent: [Object|nil] a link to a parent work item. Work items can be organized in any hierarchy you think is

    relevant for your workflow (e.g. directory[/directory...]/file/line or library/section/book/page). Of course
hierarchies are not mandatory.

  • items: [Array] a list of child work items. see above.

  • options: [Hash] a set of options for the task chain on how to deal with this work item. This attribute can be

    used to fine-tune the behaviour of tasks for a particular work item.

  • properties: [Hash] a set of properties, typically collected during the workflow processing and used to store

    final or intermediate resulst of tasks. The ::Lias::Ingester::FileItem module uses this attribute to store the
properties (e.g. size, checksum, ...) of the file it represents.

  • status_log: [Array] a list of all status changes the work item went through.

  • summary: [Hash] collected statistics about the ingest for the work item and its children. This structure will

    be filled in by the included task ::Lias::Ingester::Tasks::Analyzer wich is appended to the workflow by default.

The module is created so that it is possible to implement an ActiveRecord/Datamapper/… implementation easily. A simple in-memory implementation would require:

attr_accessor :parent attr_accessor :items attr_accessor :options, :properties attr_accessor :status_log attr_accessor :summary

def initialize

self.parent = nil
self.items = []
self.options = {}
self.properties = {}
self.status_log = []
self.summary = {}

end

protected

## Method below should be adapted to match the implementation of the status array

def add_status_log(info)

self.status_log << info

end

Instance Method Summary collapse

Methods included from Logging

#<=, #add_log, #log_message

Methods included from Status

#check_status, #compare_status, #set_status, #status, #status_label, #status_progress, #status_text

Instance Method Details

#add_item(item) ⇒ Object Also known as: <<

Add a child work item

Parameters:

  • item (WorkItem) —

    to be added to the child list :items



132
133
134
135
136
137
138
139
 
# File 'lib/libis/workflow/base/work_item.rb', line 132

def add_item(item)
  return self unless item and item.is_a?(Libis::Workflow::Base::WorkItem)
  self.items << item
  item.parent = self
  self.save!
  item.save!
  self
end

#each(&block) ⇒ Object

Iterates over the work item clients and invokes code on each of them.



119
120
121
 
# File 'lib/libis/workflow/base/work_item.rb', line 119

def each(&block)
  self.items.each(&block)
end

#get_item_list ⇒ Object

Get list of items.

This method should return a list of items that is safe to iterate over while it is being altered.



153
154
155
 
# File 'lib/libis/workflow/base/work_item.rb', line 153

def get_item_list
  self.items.dup
end

#get_items ⇒ Object

Get list of items.

This method should return a list of items that can be accessed during long processing times.



146
147
148
 
# File 'lib/libis/workflow/base/work_item.rb', line 146

def get_items
  self.items
end

#get_parent ⇒ Libis::Workflow::Base::WorkItem

Return item’s parent

Returns:



159
160
161
 
# File 'lib/libis/workflow/base/work_item.rb', line 159

def get_parent
  self.parent
end

#get_root ⇒ Libis::Workflow::Base::WorkItem

go up the hierarchy and return the topmost work item

Returns:



166
167
168
 
# File 'lib/libis/workflow/base/work_item.rb', line 166

def get_root
  self.get_parent && self.get_parent.is_a?(Libis::Workflow::Base::WorkItem) && self.get_parent.get_root || self
end

#get_run ⇒ Libis::Workflow::Base::Run

Get the top

Returns:



173
174
175
176
 
# File 'lib/libis/workflow/base/work_item.rb', line 173

def get_run
  return self if self.is_a?(Libis::Workflow::Base::Run)
  self.get_parent && self.get_parent.get_run || nil
end

#label ⇒ Object

Label is a more descriptive name



91
92
93
 
# File 'lib/libis/workflow/base/work_item.rb', line 91

def label
  self.properties['label'] || self.name
end

#label=(value) ⇒ Object 



95
96
97
 
# File 'lib/libis/workflow/base/work_item.rb', line 95

def label=(value)
  self.properties['label'] = value
end

#labelpath ⇒ Object 



103
104
105
 
# File 'lib/libis/workflow/base/work_item.rb', line 103

def labelpath;
  self.labels.join('/');
end

#labels ⇒ Object 



99
100
101
 
# File 'lib/libis/workflow/base/work_item.rb', line 99

def labels
  (self.parent.labels rescue Array.new).push(label).compact
end

#name ⇒ String

String representation of the identity of the work item.

You may want to overwrite this method as it tries the :name property or whatever #inspect returns if that failes. Typically this should return the key value, file name or id number. If that’s what your :name property contains, you’re fine.

Returns:

  • (String) —

    string identification for this work item.



69
70
71
72
 
# File 'lib/libis/workflow/base/work_item.rb', line 69

def name
  # noinspection RubyResolve
  self.properties['name'] || self.inspect
end

#name=(n) ⇒ Object 



74
75
76
 
# File 'lib/libis/workflow/base/work_item.rb', line 74

def name=(n)
  self.properties['name'] = n
end

#namepath ⇒ Object 



86
87
88
 
# File 'lib/libis/workflow/base/work_item.rb', line 86

def namepath;
  self.names.join('/');
end

#names ⇒ Object 



82
83
84
 
# File 'lib/libis/workflow/base/work_item.rb', line 82

def names
  (self.parent.names rescue Array.new).push(name).compact
end

#save ⇒ Object

Dummy method. It is a placeholder for DB backed implementations. Wherever appropriate WorkItem#save will be called to save the current item’s state. If state needs to persisted, you should override this method or make sure your persistence layer implements it in your class.



181
182
 
# File 'lib/libis/workflow/base/work_item.rb', line 181

def save
end

#save! ⇒ Object

Dummy method. It is a placeholder for DB backed implementations. Wherever appropriate WorkItem#save will be called to save the current item’s state. If state needs to persisted, you should override this method or make sure your persistence layer implements it in your class.



187
188
 
# File 'lib/libis/workflow/base/work_item.rb', line 187

def save!
end

#size ⇒ Object Also known as: count 



123
124
125
 
# File 'lib/libis/workflow/base/work_item.rb', line 123

def size
  self.items.size
end

#to_filename ⇒ String

File name safe version of the to_s output.

The output should be safe to use as a file name to store work item data. Typical use is when extra file items are created by a task and need to be stored on disk. The default implementation URL-encodes (%xx) all characters except alphanumeric, ‘.’ and ‘-’.

Returns:

  • (String) —

    file name



114
115
116
 
# File 'lib/libis/workflow/base/work_item.rb', line 114

def to_filename
  self.to_s.gsub(/[^\w.-]/) { |s| '%%%02x' % s.ord }
end

#to_s ⇒ Object 



78
79
80
 
# File 'lib/libis/workflow/base/work_item.rb', line 78

def to_s;
  self.name;
end