Class: Dor::Workflow::Document

Inherits:
Object
  • Object
show all
Extended by:
Deprecation
Includes:
OM::XML::Document, SolrDocHelper
Defined in:
lib/dor/workflow/document.rb

Constant Summary collapse

@@definitions = 
{}

Instance Method Summary collapse

Methods included from SolrDocHelper

#add_solr_value

Constructor Details

#initialize(node) ⇒ Document

Returns a new instance of Document.



39
40
41
 
# File 'lib/dor/workflow/document.rb', line 39

def initialize(node)
  self.ng_xml = Nokogiri::XML(node)
end

Instance Method Details

#[](value) ⇒ Object 



73
74
75
 
# File 'lib/dor/workflow/document.rb', line 73

def [](value)
  processes.find { |p| p.name == value }
end

#active? ⇒ Boolean

Returns if any process node does not have version, returns true, false otherwise (all processes have version).

Returns:

  • (Boolean) —

    if any process node does not have version, returns true, false otherwise (all processes have version)



54
55
56
 
# File 'lib/dor/workflow/document.rb', line 54

def active?
  ng_xml.at_xpath('/workflow/process[not(@version)]') ? true : false
end

#definition ⇒ Dor::WorkflowDefinitionDs

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/dor/workflow/document.rb', line 60

def definition
  @definition ||= begin
    if @@definitions.key? workflowId.first
      @@definitions[workflowId.first]
    else
      wfo = Dor::WorkflowObject.find_by_name(workflowId.first)
      wf_def = wfo ? wfo.definition : nil
      @@definitions[workflowId.first] = wf_def
      wf_def
    end
  end
end

#expedited? ⇒ Boolean

is this an incomplete workflow with steps that have a priority > 0

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/dor/workflow/document.rb', line 44

def expedited?
  processes.any? { |proc| !proc.completed? && proc.priority.to_i > 0 }
end

#inspect ⇒ Object 



145
146
147
 
# File 'lib/dor/workflow/document.rb', line 145

def inspect
  "#<#{self.class.name}:#{object_id}>"
end

#priority ⇒ Integer

Returns value of the first > 0 priority. Defaults to 0.

Returns:

  • (Integer) —

    value of the first > 0 priority. Defaults to 0



49
50
51
 
# File 'lib/dor/workflow/document.rb', line 49

def priority
  processes.map { |proc| proc.priority.to_i }.detect(0) { |p| p > 0 }
end

#processes ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/dor/workflow/document.rb', line 77

def processes
  # if the workflow service didnt return any processes, dont return any processes from the reified wf
  return [] if ng_xml.search('/workflow/process').length == 0

  @processes ||=
    if definition
      definition.processes.collect do |process|
        nodes = ng_xml.xpath("/workflow/process[@name = '#{process.name}']")
        node = nodes.max { |a, b| a.attr('version').to_i <=> b.attr('version').to_i }
        process.update!(node, self)
      end
    else
      find_by_terms(:workflow, :process).collect do |x|
        pnode = Dor::Workflow::Process.new(repository, workflowId, {})
        pnode.update!(x, self)
      end.sort_by(&:datetime)
    end
end

#to_solr(solr_doc = {}, *_args) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/dor/workflow/document.rb', line 100

def to_solr(solr_doc = {}, *_args)
  wf_name = workflowId.first
  repo = repository.first

  add_solr_value(solr_doc, 'wf',     wf_name, WF_SOLR_TYPE, WF_SOLR_ATTRS)
  add_solr_value(solr_doc, 'wf_wps', wf_name, WF_SOLR_TYPE, WF_SOLR_ATTRS)
  add_solr_value(solr_doc, 'wf_wsp', wf_name, WF_SOLR_TYPE, WF_SOLR_ATTRS)
  status = processes.empty? ? 'empty' : (workflow_should_show_completed?(processes) ? 'completed' : 'active')
  errors = processes.count(&:error?)
  add_solr_value(solr_doc, 'workflow_status', [wf_name, status, errors, repo].join('|'), WF_SOLR_TYPE, WF_SOLR_ATTRS)

  processes.each do |process|
    next unless process.status.present?

    # add a record of the robot having operated on this item, so we can track robot activity
    if !process.date_time.blank? && process.status && (process.status == 'completed' || process.status == 'error')
      solr_doc["wf_#{wf_name}_#{process.name}_dttsi"] = Time.parse(process.date_time).utc.iso8601
    end

    index_error_message(solr_doc, wf_name, process)

    add_solr_value(solr_doc, 'wf_wsp', "#{wf_name}:#{process.status}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_wsp', "#{wf_name}:#{process.status}:#{process.name}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_wps', "#{wf_name}:#{process.name}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_wps', "#{wf_name}:#{process.name}:#{process.status}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_swp', process.status.to_s, WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_swp', "#{process.status}:#{wf_name}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_swp', "#{process.status}:#{wf_name}:#{process.name}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
    next unless process.state != process.status

    add_solr_value(solr_doc, 'wf_wsp', "#{wf_name}:#{process.state}:#{process.name}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_wps', "#{wf_name}:#{process.name}:#{process.state}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_swp', process.state.to_s, WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_swp', "#{process.state}:#{wf_name}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
    add_solr_value(solr_doc, 'wf_swp', "#{process.state}:#{wf_name}:#{process.name}", WF_SOLR_TYPE, WF_SOLR_ATTRS)
  end

  solr_doc[Solrizer.solr_name('wf_wps', :symbol)]&.uniq!
  solr_doc[Solrizer.solr_name('wf_wsp', :symbol)]&.uniq!
  solr_doc[Solrizer.solr_name('wf_swp', :symbol)]&.uniq!
  solr_doc['workflow_status']&.uniq!

  solr_doc
end

#workflow_should_show_completed?(processes) ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/dor/workflow/document.rb', line 96

def workflow_should_show_completed?(processes)
  processes.all? { |p| ['skipped', 'completed', '', nil].include?(p.status) }
end