libis-workflow-mongoid 2.0.beta.7.1 → 2.0.beta.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6466278365e2209ba251617066ae6985e5f270e9
-  data.tar.gz: 063440949f5164cbe98581f4a9d6c2e0864ec6ee
+  metadata.gz: cfa94b307591f08d69fad83f79bf8807c56037fd
+  data.tar.gz: d484aa41a3da41c6d6c282b073231b17faa6948d
 SHA512:
-  metadata.gz: 9388dc7fb05308b629830cbf14431fc3489bed4f889124f045033b836bad926881225f4dd3785d373f29e1378ae595c4ad1b0e251f8f008f04efa7a1b506c442
-  data.tar.gz: 85a40bff7f1b10f2ee7f6b2708a8c90cada57083d8e160ca9b5fd6f7042a39123faaa272a3a737c5a3ecdcaecced5d66f15dd591b180dfb859b762ee40004aa8
+  metadata.gz: 70bf6048529e08dc5cf543788af85d9a8fcea6d36c90ad16d5a6b41c11644abbd38de87557a8d7ae3ae4aa8826de16298d6197811a92a065e7fb302cf2ac506f
+  data.tar.gz: 8cde72beefe397820d0eed41c70218469f93523712ab12c8beff27b89c685105279229ae2f71af635a7023b8589f59a34954314b2c0b707f0dd82f7411633d2e

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

@@ -2,6 +2,7 @@
 require 'mongoid'
 require 'mongoid/document'
 require 'mongoid_indifferent_access'
+require_relative 'sequence'
 
 module Libis
   module Workflow
@@ -12,8 +13,10 @@ module Libis
         def self.included(klass)
           klass.class_eval do
             include ::Mongoid::Document
-            include ::Mongoid::Timestamps
             include ::Mongoid::Extensions::Hash::IndifferentAccess
+            include ::Libis::Workflow::Mongoid::Sequence
+            field :_id, type: Integer
+            sequence :_id
             index created_at: 1
           end
         end

data/lib/libis/workflow/mongoid/sequence.rb

@@ -0,0 +1,74 @@
+#require 'mongoid/fields/validators/macro'
+
+module Libis
+  module Workflow
+    module Mongoid
+
+      # Include this module to add automatic sequence feature (also works for _id field, so SQL-Like autoincrement primary key can easily be simulated)
+      # usage:
+      # class KlassName
+      #   include Mongoid::Document
+      #   include LIBIS::Mongoid::Sequence
+      # ...
+      #   field :number, :type=>Integer
+      #   sequence :number
+      # ...
+      # Note: only tested on Mongoid 3.x and 4.x
+      module Sequence
+        extend ActiveSupport::Concern
+
+        #noinspection ALL
+        module ClassMethods
+
+          def sequence(_field, prefix = nil)
+            # REPLACE FIELD DEFAULT VALUE
+            _field = _field.to_s
+            options = fields[_field].options.merge(
+                default: lambda {
+                  self.class.set_from_sequence(_field, prefix)
+                },
+                pre_processed: false
+            )
+            (options.keys - ::Mongoid::Fields::Validators::Macro::OPTIONS).each { |key| options.delete key }
+            field(_field, options)
+          end
+
+          def set_from_sequence(_field, prefix)
+            # Increase the sequence value and also avoids conflicts
+            catch(:value) do
+              value = nil
+              begin
+                value = seq_upsert(counter_id(_field), {'$inc' => {'value' => 1}}).send('[]', 'value')
+                value = "#{prefix.is_a?(Proc) ? instance_eval(prefix.call) : prefix}_#{value}" if prefix
+              end until self.where(_field => value).count == 0
+              throw :value, value
+            end
+          end
+
+          def reset_sequence(_field, value = 0)
+            seq_upsert(counter_id(_field), {'$set' => {'value' => value}})
+          end
+
+          protected
+
+          def counter_id(_field)
+            #"#{self.name.underscore}##{_field}"
+            "#{collection_name.to_s}##{_field}"
+          end
+
+          def sequences
+            # mongo_session["#{self.collection_name.to_s}__seq"]
+            mongo_session["__sequences__"]
+          end
+
+          def seq_upsert(counter_id, change)
+            sequences.where(_id: counter_id).modify(change, upsert: true, new: true)
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/libis/workflow/mongoid/version.rb

@@ -3,7 +3,7 @@
 module Libis
   module Workflow
     module Mongoid
-      VERSION = '2.0.beta.7.1' unless const_defined? :VERSION # the guard is against a redefinition warning that happens on Travis
+      VERSION = '2.0.beta.8' unless const_defined? :VERSION # the guard is against a redefinition warning that happens on Travis
     end
   end
-end
+end

data/lib/libis/workflow/mongoid/workflow.rb

@@ -14,7 +14,7 @@ module Libis
             include ::Libis::Workflow::Base::Workflow
             include ::Libis::Workflow::Mongoid::Base
 
-            store_in collection: 'workflow_defintions'
+            store_in collection: 'workflow_definitions'
 
             field :name, type: String
             field :description, type: String

data/lib/libis/workflow/mongoid.rb

@@ -2,6 +2,8 @@
 
 require 'libis-workflow'
 
+require_relative 'mongoid/version'
+
 module Libis
   module Workflow
     module Mongoid

data/spec/tasks/checksum_tester.rb

@@ -14,7 +14,7 @@ class ChecksumTester < ::Libis::Workflow::Task
   def process(item)
     return unless item.is_a? TestFileItem
 
-    checksum_type = options[:checksum_type]
+    checksum_type = parameter(:checksum_type)
 
     if checksum_type.nil?
       ::Libis::Tools::Checksum::CHECKSUM_TYPES.each do |x|

data/spec/tasks/collect_files.rb

@@ -14,7 +14,7 @@ class CollectFiles < ::Libis::Workflow::Task
 
   def process(item)
     if item.is_a? TestRun
-      add_item(item, options[:location])
+      add_item(item, parameter(:location))
     elsif item.is_a? TestDirItem
       collect_files(item, item.fullpath)
     end
@@ -22,11 +22,11 @@ class CollectFiles < ::Libis::Workflow::Task
 
   def collect_files(item, dir)
     glob_string = dir
-    glob_string = File.join(glob_string, '**') if options[:subdirs]
+    glob_string = File.join(glob_string, '**') if parameter(:subdirs)
     glob_string = File.join(glob_string, '*')
 
     Dir.glob(glob_string).select do |x|
-      options[:selection] && !options[:selection].empty? ? x =~ Regexp.new(options[:selection]) : true
+      parameter(:selection) && !parameter(:selection).empty? ? x =~ Regexp.new(parameter(:selection)) : true
     end.sort.each do |file|
       next if %w'. ..'.include? file
       add_item(item, file)
@@ -39,8 +39,10 @@ class CollectFiles < ::Libis::Workflow::Task
             elsif File.directory?(file)
               TestDirItem.new
             else
-              Item.new
+              error 'Bad file type encountered: %s', file
+              nil
             end
+    return unless child
     child.filename = file
     item << child
   end

data/spec/workflow_spec.rb

@@ -9,21 +9,21 @@ require_relative 'spec_helper'
 require_relative 'test_workflow'
 require_relative 'items'
 
-DIRNAME = 'spec/items'
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 describe 'TestWorkflow' do
 
-  before :all do
-    $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+  let(:dirname) { File.absolute_path(File.join(File.dirname(__FILE__), 'items')) }
 
+  let(:logoutput) { StringIO.new }
 
-    @logoutput = StringIO.new
-
+  let(:workflow) {
+    # noinspection RubyResolve
     ::Libis::Workflow::Mongoid.configure do |cfg|
       cfg.itemdir = File.join(File.dirname(__FILE__), 'items')
       cfg.taskdir = File.join(File.dirname(__FILE__), 'tasks')
       cfg.workdir = File.join(File.dirname(__FILE__), 'work')
-      cfg.logger = Logger.new @logoutput
+      cfg.logger = Logger.new logoutput
       cfg.set_log_formatter
       cfg.logger.level = Logger::DEBUG
       cfg.database_connect 'mongoid.yml', :test
@@ -36,8 +36,8 @@ describe 'TestWorkflow' do
 
     TestWorkflow.each { |wf| wf.destroy }
 
-    @workflow = TestWorkflow.new
-    @workflow.configure(
+    workflow = TestWorkflow.new
+    workflow.configure(
         name: 'TestWorkflow',
         description: 'Workflow for testing',
         tasks: [
@@ -56,36 +56,44 @@ describe 'TestWorkflow' do
             checksum_type: {default: 'SHA1', propagate_to: 'ProcessFiles/ChecksumTester'}
         }
     )
-    @workflow.save
+    workflow.save
+    workflow
+  }
 
+  let(:run) {
     # noinspection RubyStringKeysInHashInspection
-    @run = @workflow.run(dirname: DIRNAME, checksum_type: 'SHA256')
-
-  end
+    workflow.run(dirname: dirname, checksum_type: 'SHA256')
+  }
 
   it 'should contain three tasks' do
 
-    expect(@workflow.config[:tasks].size).to eq 3
-    expect(@workflow.config[:tasks].first[:class]).to eq 'CollectFiles'
-    expect(@workflow.config[:tasks].last[:class]).to eq '::Libis::Workflow::Tasks::Analyzer'
+    expect(workflow.config[:tasks].size).to eq 3
+    expect(workflow.config[:tasks].first[:class]).to eq 'CollectFiles'
+    expect(workflow.config[:tasks].last[:class]).to eq '::Libis::Workflow::Tasks::Analyzer'
 
   end
 
   it 'should camelize the workitem name' do
 
-    expect(@run.options[:dirname]).to eq DIRNAME
-    expect(@run.items.count).to eq 1
-    expect(@run.items.first.class).to eq TestDirItem
-    expect(@run.items.first.count).to eq 4
-    expect(@run.items.first.first.class).to eq TestFileItem
+    expect(run.options[:dirname]).to eq dirname
+    expect(run.items.count).to eq 1
+    expect(run.items.first.class).to eq TestDirItem
+    expect(run.items.first.count).to eq 4
+    expect(run.items.first.first.class).to eq TestFileItem
 
-    @run.items.first.each_with_index do |x, i|
+    run.items.first.each_with_index do |x, i|
       expect(x.name).to eq %w'TestDirItem.rb TestFileItem.rb TestItem.rb TestRun.rb'[i]
     end
   end
 
   it 'should return expected debug output' do
 
+    expect(run.summary['DEBUG']).to eq 57
+    expect(run.log_history.count).to eq 8
+    expect(run.status_log.count).to eq 6
+    expect(run.items.first.log_history.count).to eq 25
+    expect(run.items.first.status_log.count).to eq 8
+
     sample_out = <<STR
 DEBUG -- CollectFiles - TestRun : Started
 DEBUG -- CollectFiles - TestRun : Processing subitem (1/1): items
@@ -146,60 +154,57 @@ DEBUG -- ProcessFiles - TestRun : 1 of 1 subitems passed
 DEBUG -- ProcessFiles - TestRun : Completed
 STR
     sample_out = sample_out.lines.to_a
-    output = @logoutput.string.lines
+    output = logoutput.string.lines
 
     expect(output.count).to eq sample_out.count
     output.each_with_index do |o, i|
       expect(o.strip).to match(/#{Regexp.escape sample_out[i].strip}$/)
     end
 
-    expect(@run.summary['DEBUG']).to eq 57
-    expect(@run.log_history.count).to eq 8
-    expect(@run.status_log.count).to eq 6
-    expect(@run.items.first.log_history.count).to eq 25
-    expect(@run.items.first.status_log.count).to eq 8
-
   end
 
   it 'find workflow' do
-    workflow = TestWorkflow.first
-    expect(workflow.nil?).to eq false
-    expect(workflow.name).to eq 'TestWorkflow'
-    expect(workflow.description).to eq 'Workflow for testing'
-    expect(workflow.input.count).to eq 2
-    expect(workflow.input[:dirname][:default]).to eq '.'
-    expect(workflow.config[:tasks].count).to eq 3
-    expect(workflow.config[:tasks][0][:class]).to eq 'CollectFiles'
-    expect(workflow.config[:tasks][0][:recursive]).to eq true
-    expect(workflow.config[:tasks][1][:name]).to eq 'ProcessFiles'
-    expect(workflow.config[:tasks][1][:subitems]).to eq true
-    expect(workflow.config[:tasks][1][:tasks].count).to eq 2
-    expect(workflow.config[:tasks][1][:tasks][0][:class]).to eq 'ChecksumTester'
-    expect(workflow.config[:tasks][1][:tasks][0][:recursive]).to eq true
-    expect(workflow.config[:tasks][1][:tasks][1][:class]).to eq 'CamelizeName'
-    expect(workflow.config[:tasks][1][:tasks][1][:recursive]).to eq true
-    expect(workflow.config[:tasks][2][:class]).to eq '::Libis::Workflow::Tasks::Analyzer'
+    workflow
+    wf = TestWorkflow.first
+    expect(wf.nil?).to eq false
+    expect(wf.name).to eq 'TestWorkflow'
+    expect(wf.description).to eq 'Workflow for testing'
+    expect(wf.input.count).to eq 2
+    expect(wf.input[:dirname][:default]).to eq '.'
+    expect(wf.config[:tasks].count).to eq 3
+    expect(wf.config[:tasks][0][:class]).to eq 'CollectFiles'
+    expect(wf.config[:tasks][0][:recursive]).to eq true
+    expect(wf.config[:tasks][1][:name]).to eq 'ProcessFiles'
+    expect(wf.config[:tasks][1][:subitems]).to eq true
+    expect(wf.config[:tasks][1][:tasks].count).to eq 2
+    expect(wf.config[:tasks][1][:tasks][0][:class]).to eq 'ChecksumTester'
+    expect(wf.config[:tasks][1][:tasks][0][:recursive]).to eq true
+    expect(wf.config[:tasks][1][:tasks][1][:class]).to eq 'CamelizeName'
+    expect(wf.config[:tasks][1][:tasks][1][:recursive]).to eq true
+    expect(wf.config[:tasks][2][:class]).to eq '::Libis::Workflow::Tasks::Analyzer'
   end
 
   # noinspection RubyResolve
   it 'find run' do
-    workflow = TestWorkflow.first
-    expect(workflow.workflow_runs.count).to be > 0
-    run = workflow.workflow_runs.first
-    expect(run.is_a? TestRun).to eq true
-    expect(run.nil?).to eq false
-    expect(run.options[:dirname]).to eq 'spec/items'
-    expect(run.properties[:ingest_failed]).to eq false
-    expect(run.log_history.count).to eq 8
-    expect(run.status_log.count).to eq 6
-    expect(run.summary[:DEBUG]).to eq 57
+    run
+    wf = TestWorkflow.first
+    expect(wf.workflow_runs.count).to be > 0
+    wf_run = wf.workflow_runs.first
+    expect(wf_run.is_a? TestRun).to eq true
+    expect(wf_run.nil?).to eq false
+    expect(wf_run.options[:dirname]).to eq dirname
+    expect(wf_run.properties[:ingest_failed]).to eq false
+    expect(wf_run.log_history.count).to eq 8
+    expect(wf_run.status_log.count).to eq 6
+    expect(wf_run.summary[:DEBUG]).to eq 57
   end
 
   # noinspection RubyResolve
   it 'find first item' do
-    workflow = TestWorkflow.first
-    expect(workflow.workflow_runs.first.items.count).to be > 0
-    item = workflow.workflow_runs.first.items.first
+    run
+    wf = TestWorkflow.first
+    expect(wf.workflow_runs.first.items.count).to be > 0
+    item = wf.workflow_runs.first.items.first
     expect(item.nil?).to eq false
     expect(item.is_a? TestDirItem).to eq true
     expect(item.properties[:name]).to eq 'Items'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-workflow-mongoid
 version: !ruby/object:Gem::Version
-  version: 2.0.beta.7.1
+  version: 2.0.beta.8
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libis-workflow
@@ -142,6 +142,7 @@ files:
 - lib/libis/workflow/mongoid/base.rb
 - lib/libis/workflow/mongoid/config.rb
 - lib/libis/workflow/mongoid/run.rb
+- lib/libis/workflow/mongoid/sequence.rb
 - lib/libis/workflow/mongoid/version.rb
 - lib/libis/workflow/mongoid/work_item.rb
 - lib/libis/workflow/mongoid/work_item_base.rb