libis-workflow-activerecord 0.9.0

data/spec/workitem_spec.rb

@@ -0,0 +1,366 @@
+require 'rspec'
+require_relative 'spec_helper'
+
+require 'libis-workflow-activerecord'
+require 'test_workitem'
+require 'awesome_print'
+
+describe 'TestWorkItem' do
+
+  let :root do
+    f = Libis::Workflow::ActiveRecord::WorkItem.where('properties @> ?', {name: 'root'}.to_json)
+    return f.first if f.length > 0
+    f = TestWorkItem.new
+    f.properties[:name] = 'root'
+    f.save
+    f
+  end
+
+  context 'creation' do
+
+    it 'new item' do
+      item = TestWorkItem.new
+      expect(item.class).to be TestWorkItem
+      expect(item.id).to be_nil
+      item.save
+      expect(item.id).not_to be_nil
+    end
+
+    it 'create item' do
+      item = TestWorkItem.create
+      expect(item.class).to be TestWorkItem
+      expect(item.id).not_to be_nil
+    end
+
+  end
+
+  context 'properties' do
+
+    before :context do
+      @item = TestWorkItem.create
+    end
+
+    after :context do
+      # @item.delete
+    end
+
+    let(:item) { @item }
+
+    # noinspection RubyResolve
+    it 'empty on creation' do
+      expect(item.properties).to be_a Hash
+      expect(item.properties).to be_empty
+    end
+
+    it 'can add property fields with indifferent access' do
+      item.properties['name'] = 'Foo'
+      expect(item.properties['name']).to eql 'Foo'
+      expect(item.properties[:name]).to eql 'Foo'
+
+      item.properties[:label] = 'Bar'
+      expect(item.properties[:label]).to eql 'Bar'
+      expect(item.properties['label']).to eql 'Bar'
+
+      # name and label are special properties
+      expect(item.name).to eql 'Foo'
+      expect(item.label).to eql 'Bar'
+
+      item.name = 'Baz'
+      expect(item.properties['name']).to eql 'Baz'
+
+      item.label = 'Quux'
+      expect(item.properties[:label]).to eql 'Quux'
+
+      item.save
+    end
+
+    # noinspection RubyResolve
+    it 'property_field' do
+      expect(item.properties[:abc]).to be_nil
+      expect(item.abc).to be :xyz
+      item.abc = 'def'
+      item.save
+      expect(item.abc).to be :def
+      expect(item.properties[:abc]).to eql 'def'
+      item.abc = :xyz
+      item.save
+      expect(item.properties[:abc]).to eql 'xyz'
+      expect(item.abc).to be :xyz
+      item.abc = nil
+      item.save
+      expect(item.properties[:abc]).to be_nil
+      expect(item.abc).to be :xyz
+    end
+
+    # noinspection RubyResolve
+    it 'clear all property_fields' do
+      new_item = TestWorkItem.create
+      new_item.abc = 'foo'
+      expect(new_item.abc).to be :foo
+      expect(new_item.properties.size)
+    end
+
+  end
+
+  context 'options' do
+
+    before :context do
+      @item = TestWorkItem.create
+    end
+
+    after :context do
+      # @item.delete
+    end
+
+    let(:item) { @item }
+
+    it 'add with indifferent access' do
+      item.options['foo'] = 'bar'
+      expect(item.options['foo']).to eql 'bar'
+      expect(item.options[:foo]).to eql 'bar'
+
+      item.options[:baz] = 'quux'
+      expect(item.options[:baz]).to eql 'quux'
+      expect(item.options['baz']).to eql 'quux'
+
+      item.save
+    end
+
+    it 'multilevel with indifferent access' do
+      item.options[:quux] = {}
+      item.options[:quux]['foo'] = 'bar'
+      expect(item.options['quux']['foo']).to eql 'bar'
+      expect(item.options[:quux][:foo]).to eql 'bar'
+
+      item.options['quux'][:baz] = 'quux'
+      expect(item.options['quux'][:baz]).to eql 'quux'
+      expect(item.options[:quux]['baz']).to eql 'quux'
+
+      item.save
+    end
+
+  end
+
+  context 'status' do
+
+    before :context do
+      @item = TestWorkItem.create
+    end
+
+    after :context do
+      # @item.delete
+    end
+
+    let(:item) { @item }
+
+    it 'added' do
+      item.set_status('abc', :STARTED)
+      expect(item.status_log.size).to be 1
+      status_entry = item.status_log[0]
+      expect(status_entry[:task]).to eql 'abc'
+      expect(status_entry[:status]).to be :STARTED
+      expect(item.check_status(:STARTED, 'abc')).to be_truthy
+    end
+
+    it 'updated' do
+      item.set_status('abc', :DONE)
+      expect(item.status_log.size).to be 1
+      status_entry = item.status_log[0]
+      expect(status_entry[:task]).to eql 'abc'
+      expect(status_entry[:status]).to be :DONE
+      expect(item.check_status(:DONE, 'abc')).to be_truthy
+    end
+
+    context 'with progress' do
+
+      it 'created' do
+        item.set_status('def', :STARTED)
+        expect(item.status_log.size).to be 2
+        status_entry = item.status_log[1]
+        expect(status_entry[:task]).to eql 'def'
+        expect(status_entry[:status]).to be :STARTED
+        expect(item.check_status(:STARTED, 'def')).to be_truthy
+      end
+
+      it 'updated' do
+        item.status_progress('def', 3, 10)
+        expect(item.status_log.size).to be 2
+        status_entry = item.status_log[1]
+        expect(status_entry[:task]).to eql 'def'
+        expect(status_entry[:status]).to be :STARTED
+        expect(status_entry[:progress]).to be 3
+        expect(status_entry[:max]).to be 10
+      end
+    end
+
+  end
+
+  context 'copy' do
+
+    # noinspection RubyResolve
+    it 'simple' do
+      item = TestWorkItem.create
+      new_item = item.duplicate
+      expect(new_item.id).to be_nil
+      expect(new_item.properties).to be_empty
+      expect(new_item.options).to be_empty
+      expect(new_item.status_log).to be_empty
+      new_item.save!
+      expect(new_item.id).not_to be_nil
+      expect(new_item.id).not_to eql item.id
+    end
+
+    # noinspection RubyResolve
+    it 'with properties' do
+      item = TestWorkItem.create
+      item.properties['foo'] = 'bar'
+      item.properties['baz'] = 'quux'
+      new_item = item.duplicate
+      expect(new_item.id).to be_nil
+      expect(new_item.properties).not_to be_empty
+      expect(new_item.properties.size).to be 2
+      expect(new_item.properties['foo']).to eql 'bar'
+      expect(new_item.properties[:foo]).not_to be 'bar'
+      expect(new_item.properties[:baz]).to eql 'quux'
+      expect(new_item.properties['baz']).not_to be 'quux'
+      expect(new_item.properties.size).to be 2
+      expect(new_item.options).to be_empty
+      expect(new_item.status_log).to be_empty
+      new_item.save!
+      expect(new_item.id).not_to be_nil
+      expect(new_item.id).not_to eql item.id
+    end
+
+    # noinspection RubyResolve
+    it 'with options' do
+      item = TestWorkItem.create
+      item.options['foo'] = {}
+      item.options[:foo]['bar'] = {}
+      item.options['foo'][:bar]['baz'] = 'quux'
+      new_item = item.duplicate
+      expect(new_item.id).to be_nil
+      expect(new_item.options).not_to be_empty
+      expect(new_item.options.size).to be 1
+      expect(new_item.options['foo'].size).to be 1
+      expect(new_item.options[:foo]['bar'].size).to be 1
+      expect(new_item.options[:foo][:bar][:baz]).to eql 'quux'
+      expect(new_item.properties).to be_empty
+      expect(new_item.status_log).to be_empty
+      new_item.save!
+      expect(new_item.id).not_to be_nil
+      expect(new_item.id).not_to eql item.id
+    end
+
+  end
+
+  context 'hierarchy' do
+
+    before :context do
+      @item = TestWorkItem.create
+      @item.name = 'root'
+    end
+
+    after :context do
+      # @item.delete
+    end
+
+    let(:root) { @item }
+
+    it 'child via set parent' do
+      item = TestWorkItem.new
+      item.properties[:name] = 'child 1'
+      item.parent = root
+      expect(item.id).to be_nil
+      item.save
+      expect(item.id).not_to be_nil
+      # noinspection RubyResolve
+      expect(item.parent_id).to be root.id
+      expect(item.parent).to be root
+      expect(root.items.size).to be 1
+      expect(root.items.first).to eql item
+    end
+
+    it 'child via <<' do
+      item = TestWorkItem.new
+      item.properties[:name] = 'child 2'
+      root << item
+      expect(item.id).not_to be_nil
+      # noinspection RubyResolve
+      expect(item.parent_id).to be root.id
+      expect(item.parent).to be root
+      expect(root.items.size).to be 2
+      expect(root.items.last).to eql item
+    end
+
+    it 'child via add_item' do
+      item = TestWorkItem.new
+      item.properties[:name] = 'child 3'
+      root.add_item item
+      expect(item.id).not_to be_nil
+      # noinspection RubyResolve
+      expect(item.parent_id).to be root.id
+      expect(item.parent).to eql root
+      expect(root.items.size).to be 3
+      expect(root.items[2]).to eql item
+    end
+
+    it 'grandchild via set parent' do
+      item = TestWorkItem.new
+      item.properties[:name] = 'grandchild 1 of 1'
+      parent = TestWorkItem.where('properties @> ? ', {name: 'child 1'}.to_json).first
+      item.parent = parent
+      expect(item.id).to be_nil
+      item.save
+      expect(item.id).not_to be_nil
+      # noinspection RubyResolve
+      expect(item.parent_id).to be parent.id
+      expect(item.parent).to be parent
+      expect(parent.items.size).to be 1
+      expect(parent.items.first).to eql item
+      expect(item.parent.parent).to eql root
+    end
+
+    it 'deep copy' do
+      item = TestWorkItem.where('properties @> ? ', {name: 'child 1'}.to_json).first
+      expect(item).not_to be_nil
+      new_item = root.copy_item(item)
+      expect(new_item.id).not_to be item.id
+      expect(new_item.parent).to eql item.parent
+      expect(new_item.items.size).to be 1
+      expect(new_item.items[0]).not_to eql item.items[0]
+      expect(new_item.items[0].name).to eql item.items[0].name
+      new_item.name = 'Copy of ' + item.name
+      new_item.items.first.name = 'Copy of ' + item.items.first.name
+      new_item.save!
+    end
+
+    it 'move' do
+      item = TestWorkItem.where('properties @> ? ', {name: 'Copy of grandchild 1 of 1'}.to_json).first
+      item.name = 'Traveling grandchild'
+      parent = item.parent
+      expect(parent.items.size).to be 1
+      new_parent = TestWorkItem.where('properties @> ? ', {name: 'child 2'}.to_json).first
+      new_parent.move_item item
+      expect(parent.items.size).to be 0
+      expect(new_parent.items.size).to be 1
+      expect(new_parent.items.first.id).to be item.id
+    end
+
+    it 'cascade delete' do
+      expect(root.items.count).to be 4
+      child = TestWorkItem.where('properties @> ? ', {name: 'child 1'}.to_json).first
+      child.destroy
+      expect(root.items.count).to be 3
+
+      grandchild = TestWorkItem.where('properties @> ? ', {name: 'grandchild 1 of 1'}.to_json).first
+      expect(grandchild).to be_nil
+    end
+
+    it 'get items' do
+      expect(root.get_items).to be_a(ActiveRecord::Relation)
+      expect(root.get_item_list).to  be_a(Array)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: libis-workflow-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Kris Dekeyser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libis-workflow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Class implementations that use ActiveRecord storage for the LIBIS Workflow
+  framework.
+email: kris.dekeyser@libis.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- db/config.yml
+- db/migrate/001_create_work_items_table.rb
+- db/migrate/002_create_jobs_table.rb
+- db/schema.rb
+- db/setup_db.rb
+- db/travis.config.yml
+- lib/libis-workflow-activerecord.rb
+- lib/libis/workflow/activerecord.rb
+- lib/libis/workflow/activerecord/base.rb
+- lib/libis/workflow/activerecord/config.rb
+- lib/libis/workflow/activerecord/helpers/hash_serializer.rb
+- lib/libis/workflow/activerecord/helpers/property_helper.rb
+- lib/libis/workflow/activerecord/helpers/status_serializer.rb
+- lib/libis/workflow/activerecord/job.rb
+- lib/libis/workflow/activerecord/run.rb
+- lib/libis/workflow/activerecord/version.rb
+- lib/libis/workflow/activerecord/work_item.rb
+- lib/libis/workflow/activerecord/worker.rb
+- lib/libis/workflow/activerecord/workflow.rb
+- libis-workflow-activerecord.gemspec
+- spec/db_env.sh
+- spec/db_start.sh
+- spec/items.rb
+- spec/items/test_dir_item.rb
+- spec/items/test_file_item.rb
+- spec/items/test_item.rb
+- spec/items/test_run.rb
+- spec/job_spec.rb
+- spec/run_spec.rb
+- spec/spec_helper.rb
+- spec/tasks/camelize_name.rb
+- spec/tasks/checksum_tester.rb
+- spec/tasks/collect_files.rb
+- spec/test_job.rb
+- spec/test_workflow.rb
+- spec/test_workitem.rb
+- spec/workflow_spec.rb
+- spec/workitem_spec.rb
+homepage: https://github.com/libis/workflow-activerecord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveRecord persistence for the LIBIS Workflow framework.
+test_files:
+- spec/db_env.sh
+- spec/db_start.sh
+- spec/items.rb
+- spec/items/test_dir_item.rb
+- spec/items/test_file_item.rb
+- spec/items/test_item.rb
+- spec/items/test_run.rb
+- spec/job_spec.rb
+- spec/run_spec.rb
+- spec/spec_helper.rb
+- spec/tasks/camelize_name.rb
+- spec/tasks/checksum_tester.rb
+- spec/tasks/collect_files.rb
+- spec/test_job.rb
+- spec/test_workflow.rb
+- spec/test_workitem.rb
+- spec/workflow_spec.rb
+- spec/workitem_spec.rb