dor-workflow-service 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4abc8faa2adf7c8c9f51ed741e5c7347468d1a86c15e7f6d9302500a8985e820
-  data.tar.gz: 9be7245887a6b93ac5461b69f6bea3d72a29e0d906ae14a1ea73b73396145008
+  metadata.gz: 394cba37203c6683aa63f395f51d95167593b54051a83371bb36dd258ec96c2c
+  data.tar.gz: 6161481760df3525936c53fff102f502e23667224f645d0afa60ff92b5b0dc1d
 SHA512:
-  metadata.gz: d6e52377d0c17001f5e98f301b7d4d21c2572f23fd5c6871e9d03f3d1f9678aa4aa53df1893e7301bde5617d94c41b08552716c51565daf427bca2bfad441956
-  data.tar.gz: 7a4f03c9a5bdc93a289256094690d81f40cea5327343eaab1f9def9b556c239bc2c4d2a6a40556ce097ed2f9df71a3b564f24f1305223d4fb987b5dadda578d9
+  metadata.gz: 2c06e4de8b093c5a40018637562abd74269a27c645210a072b9a3512e6411aa28ea70558f35e30ad2084b3a25baad1405dec47c6abff0d4cf4751498e8a75762
+  data.tar.gz: d35f946bf8c3904f08b094e6e5fe784121c4042c17691a7b0dc2825e79491b45a613b4397d9990c7e26591bc5ed7adf8219133f901cebfd99e777417282f5879

data/lib/dor/models/response/process.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Dor
+  module Workflow
+    module Response
+      # Represents the status of an object doing a workflow process
+      class Process
+        # @params [Workflow] parent
+        # @params [Hash] attributes
+        def initialize(parent:, **attributes)
+          @parent = parent
+          @attributes = attributes
+        end
+
+        def name
+          @attributes[:name].presence
+        end
+
+        def status
+          @attributes[:status].presence
+        end
+
+        def datetime
+          @attributes[:datetime].presence
+        end
+
+        def elapsed
+          @attributes[:elapsed].presence
+        end
+
+        def attempts
+          @attributes[:attempts].presence
+        end
+
+        def lifecycle
+          @attributes[:lifecycle].presence
+        end
+
+        def note
+          @attributes[:note].presence
+        end
+
+        delegate :pid, :workflow_name, to: :parent
+
+        private
+
+        attr_reader :parent
+      end
+    end
+  end
+end

data/lib/dor/models/response/workflow.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'dor/models/response/process'
+
 module Dor
   module Workflow
     module Response
@@ -15,8 +17,26 @@ module Dor
           result ? true : false
         end
 
+        # Returns the process, for the most recent version that matches the given name:
+        def process_for_recent_version(name:)
+          nodes = process_nodes_for(name: name)
+          node = nodes.max { |a, b| a.attr('version').to_i <=> b.attr('version').to_i }
+          attributes = node ? Hash[node.attributes.collect { |k, v| [k.to_sym, v.value] }] : {}
+          Process.new(parent: self, **attributes)
+        end
+
+        def empty?
+          ng_xml.xpath('/workflow/process').empty?
+        end
+
+        attr_reader :xml
+
         private
 
+        def process_nodes_for(name:)
+          ng_xml.xpath("/workflow/process[@name = '#{name}']")
+        end
+
         def ng_xml
           @ng_xml ||= Nokogiri::XML(@xml)
         end

data/lib/dor/workflow_version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     module Service
-      VERSION = '2.5.0'
+      VERSION = '2.6.0'
     end
   end
 end

data/spec/models/response/workflow_spec.rb

@@ -33,4 +33,85 @@ RSpec.describe Dor::Workflow::Response::Workflow do
       it { is_expected.to be true }
     end
   end
+
+  describe '#empty?' do
+    subject { instance.empty? }
+
+    context 'when there is xml' do
+      let(:xml) do
+        '<?xml version="1.0" encoding="UTF-8"?>
+          <workflow repository="dor" objectId="druid:oo201oo0001" id="accessionWF">
+            <process version="2" lifecycle="submitted" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:18:24-0800" status="completed" name="start-accession"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:18:58-0800" status="completed" name="technical-metadata"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:02-0800" status="completed" name="provenance-metadata"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:05-0800" status="completed" name="remediate-object"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:06-0800" status="completed" name="shelve"/>
+            <process version="2" lifecycle="published" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:07-0800" status="completed" name="publish"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:09-0800" status="completed" name="sdr-ingest-transfer"/>
+            <process version="2" lifecycle="accessioned" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:10-0800" status="completed" name="cleanup"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:13-0800" status="completed" name="rights-metadata"/>
+            <process version="2" lifecycle="described" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:15-0800" status="completed" name="descriptive-metadata"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="2"
+              datetime="2012-11-06T16:19:16-0800" status="completed" name="content-metadata"/>
+          </workflow>'
+      end
+
+      it { is_expected.to be false }
+    end
+
+    context 'when the xml is empty' do
+      let(:xml) { '' }
+
+      it { is_expected.to be true }
+    end
+  end
+
+  describe '#process_for_recent_version' do
+    subject(:process) { instance.process_for_recent_version(name: 'jp2-create') }
+
+    context 'when the workflow has not been instantiated for the given version' do
+      let(:xml) do
+        <<~XML
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+            <process version="1" laneId="default" elapsed="0.0" attempts="1" datetime="2013-02-18T14:40:25-0800" status="completed" name="start-assembly"/>
+            <process version="1" laneId="default" elapsed="0.509" attempts="1" datetime="2013-02-18T14:42:24-0800" status="completed" name="jp2-create"/>
+          </workflow>
+        XML
+      end
+
+      it 'returns a process' do
+        expect(process).to be_kind_of Dor::Workflow::Response::Process
+        expect(process.status).to eq 'completed'
+        expect(process.name).to eq 'jp2-create'
+      end
+    end
+
+    context 'when the workflow has been instantiated for the given version' do
+      let(:xml) do
+        <<~XML
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+            <process version="1" laneId="default" elapsed="0.0" attempts="1" datetime="2013-02-18T14:40:25-0800" status="completed" name="start-assembly"/>
+            <process version="1" laneId="default" elapsed="0.509" attempts="1" datetime="2013-02-18T14:42:24-0800" status="completed" name="jp2-create"/>
+            <process version="2" laneId="default" elapsed="0.509" attempts="1" datetime="2013-02-18T14:42:24-0800" status="waiting" name="jp2-create"/>
+          </workflow>
+        XML
+      end
+
+      it 'returns a process' do
+        expect(process).to be_kind_of Dor::Workflow::Response::Process
+        expect(process.status).to eq 'waiting'
+        expect(process.name).to eq 'jp2-create'
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-service
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-01 00:00:00.000000000 Z
+date: 2019-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -258,6 +258,7 @@ files:
 - bin/console
 - dor-workflow-service.gemspec
 - lib/dor-workflow-service.rb
+- lib/dor/models/response/process.rb
 - lib/dor/models/response/workflow.rb
 - lib/dor/services/workflow_service.rb
 - lib/dor/workflow_exception.rb