workflow_rb-db 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a8dcf80c3de7c40b7ea88d0c6f8990cab652620
+  data.tar.gz: fd2f68273b331129c87e9e68ba7e0ce047eafa82
+SHA512:
+  metadata.gz: e9d355c503f6b51bddd1f9e34cde9e1b19ddaba14bca1a414a3b80941f5ea62c86693320a694f3821edbbabe6658a08fb547ce6a256d9d21b7b176a3ccefd1f6
+  data.tar.gz: abf764c16a0755f86d18a9a8768b31e73a9739dbbb508399d0e5b4248be7e072009a1b81bc312ec6195057c0977d70901a55ef9ee3e231a30874342677153daf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in workflow_rb-db.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+# WorkflowRb::Db
+
+Provides support to persist workflows running on WorkflowRb to a database supported by Active Record.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'workflow_rb-db'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workflow_rb-db
+
+## Usage
+
+Setup a database.yml config file with a "workflow" section
+
+```yaml
+workflow:
+  adapter: postgresql
+  encoding: unicode
+  database: workflow_rb
+  pool: 12
+  username: postgres
+  password: password
+  host: localhost
+  port: 5432
+```
+
+Add the tables to your database
+
+```ruby
+db_config = YAML.load_file('database.yml')
+ActiveRecord::Base.establish_connection(db_config['workflow'])
+schema = WorkflowRb::Db::Schema.new
+schema.up
+```
+
+Use the *.use_persistence* method on the *WorkflowHost* to configure it to use the ActiveRecord provider
+
+```ruby
+require 'workflow_rb/db'
+require 'yaml'
+
+db_config = YAML.load_file('database.yml')
+WorkflowRb::Db::WorkflowRecord.establish_connection(db_config['workflow'])
+
+# create host
+host = WorkflowRb::WorkflowHost.new
+host.use_persistence(WorkflowRb::Db::ActiveRecordPersistenceProvider.new)
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "workflow_rb/db"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/workflow_rb/db.rb

@@ -0,0 +1,9 @@
+require "workflow_rb/db/version"
+require "workflow_rb/db/active_record_persistence_provider"
+require "workflow_rb/db/migrate/001_schema"
+
+module WorkflowRb
+  module Db
+    # Your code goes here...
+  end
+end

data/lib/workflow_rb/db/active_record_persistence_provider.rb

@@ -0,0 +1,74 @@
+require 'workflow_rb'
+require 'workflow_rb/db/entities'
+
+module WorkflowRb
+  module Db
+    class ActiveRecordPersistenceProvider
+
+      def initialize
+      end
+
+      def create_new_workflow(workflow)
+        rec = WorkflowRb::Db::WorkflowInstance.new
+        rec.pack(workflow)
+        rec.save!
+        rec.id
+      end
+
+      def persist_workflow(workflow)
+        existing = WorkflowRb::Db::WorkflowInstance.find(workflow.id)
+        existing.pack(workflow)
+        existing.save!
+      end
+
+      def get_workflow_instance(id)
+        rec = WorkflowRb::Db::WorkflowInstance.find(id)
+        rec.unpack
+      end
+
+      def get_runnable_instances
+        result = []
+        next_execution = WorkflowRb::Db::WorkflowInstance.arel_table[:next_execution]
+        WorkflowRb::Db::WorkflowInstance
+            .where(status: WorkflowStatus::RUNNABLE)
+            .where(next_execution.lteq(Time.now))
+            .find_each do |wf|
+              result << wf.unpack.id
+            end
+        result
+      end
+
+      def create_subscription(subscription)
+        rec = WorkflowRb::Db::EventSubscription.new
+        rec.pack(subscription)
+        rec.save!
+        rec.id
+      end
+
+      def get_subscriptions(event_name, event_key)
+        WorkflowRb::Db::EventSubscription
+            .where(event_name: event_name)
+            .where(event_key: event_key)
+      end
+
+      def terminate_subscription(id)
+        WorkflowRb::Db::EventSubscription.delete(id)
+      end
+
+      def create_unpublished_event(pub)
+        rec = WorkflowRb::Db::EventPublication.new
+        rec.pack(pub)
+        rec.save!
+      end
+
+      def remove_unpublished_event(id)
+        WorkflowRb::Db::EventPublication.delete(id)
+      end
+
+      def get_unpublished_events
+        WorkflowRb::Db::EventPublication.all
+      end
+
+    end
+  end
+end

data/lib/workflow_rb/db/entities.rb

@@ -0,0 +1,102 @@
+require "active_record"
+require "yaml"
+require "workflow_rb"
+
+module WorkflowRb
+  module Db
+    class WorkflowRecord < ActiveRecord::Base
+      def self.abstract_class?
+        true
+      end
+    end
+
+    class WorkflowInstance < WorkflowRecord
+      def self.abstract_class?
+        false
+      end
+
+      def pack(workflow)
+        # self.id = workflow.id
+        self.definition_id = workflow.definition_id
+        self.version = workflow.version
+        self.description = workflow.description
+        self.next_execution = workflow.next_execution
+        self.status = workflow.status
+        self.create_time = workflow.create_time
+        self.complete_time = workflow.complete_time
+        self.data = YAML.dump(workflow.data)
+        self.execution_pointers = YAML.dump(workflow.execution_pointers)
+      end
+
+      def unpack
+        result = WorkflowRb::WorkflowInstance.new
+        result.id = self.id
+        result.definition_id = self.definition_id
+        result.version = self.version
+        result.description = self.description
+        result.next_execution = self.next_execution
+        result.status = self.status
+        result.create_time = self.create_time
+        result.complete_time = self.complete_time
+        result.data = YAML.load(self.data)
+        result.execution_pointers = YAML.load(self.execution_pointers)
+
+        result
+      end
+
+    end
+
+    class EventSubscription < WorkflowRecord
+      def self.abstract_class?
+        false
+      end
+
+      def pack(sub)
+        self.workflow_id = sub.workflow_id
+        self.step_id = sub.step_id
+        self.event_name = sub.event_name
+        self.event_key = sub.event_key
+      end
+
+      def unpack
+        result = WorkflowRb::EventSubscription.new
+        result.id = self.id
+        result.workflow_id = self.workflow_id
+        result.step_id = self.step_id
+        result.event_name = self.event_name
+        result.event_key = self.event_key
+        result
+      end
+
+    end
+
+    class EventPublication < WorkflowRecord
+      def self.abstract_class?
+        false
+      end
+
+      def pack(pub)
+        self.workflow_id = pub.workflow_id
+        self.step_id = pub.step_id
+        self.event_name = pub.event_name
+        self.event_key = pub.event_key
+        self.event_data = YAML.dump(pub.event_data)
+      end
+
+      def unpack
+        result = WorkflowRb::EventPublication.new
+        result.id = self.id
+        result.workflow_id = self.workflow_id
+        result.step_id = self.step_id
+        result.event_name = self.event_name
+        result.event_key = self.event_key
+        result.event_data = YAML.load(self.event_data)
+        result
+      end
+
+    end
+
+  end
+end
+
+

data/lib/workflow_rb/db/migrate/001_schema.rb

@@ -0,0 +1,50 @@
+require "active_record"
+
+module WorkflowRb
+  module Db
+    class Schema < ActiveRecord::Migration
+      def up
+        create_table :workflow_instances, force: true do |t|
+          t.string :definition_id, :limit => 100
+          t.integer :version
+          t.string :description
+          t.string :execution_pointers
+          t.datetime :next_execution
+          t.integer :status
+          t.string :data
+          t.datetime :create_time
+          t.datetime :complete_time
+          t.integer :lock_version
+
+          t.index :next_execution
+          t.index :status
+        end
+
+
+        create_table :event_subscriptions, force: true do |t|
+          t.integer :workflow_id
+          t.integer :step_id
+          t.string :event_name, :limit => 100
+          t.string :event_key, :limit => 100
+
+          t.index :event_name
+          t.index :event_key
+        end
+
+        create_table :event_publications, force: true do |t|
+          t.integer :workflow_id
+          t.integer :step_id
+          t.string :event_name, :limit => 100
+          t.string :event_key, :limit => 100
+          t.string :event_data
+
+          t.index :event_name
+          t.index :event_key
+        end
+
+      end
+    end
+
+  end
+end
+

data/lib/workflow_rb/db/version.rb

@@ -0,0 +1,5 @@
+module WorkflowRb
+  module Db
+    VERSION = "0.1.0"
+  end
+end

data/workflow_rb-db.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workflow_rb/db/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "workflow_rb-db"
+  spec.version       = WorkflowRb::Db::VERSION
+  spec.authors       = ["Daniel gerlag"]
+  spec.email         = ["daniel@gerlag.ca"]
+
+  spec.summary       = %q{Active Record persistence provider for WorkflowRb}
+  spec.homepage      = "https://github.com/danielgerlag/workflow_rb"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "workflow_rb", "~> 0.1.0"
+  spec.add_dependency "activerecord", "~> 5.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: workflow_rb-db
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel gerlag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: workflow_rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- daniel@gerlag.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/workflow_rb/db.rb
+- lib/workflow_rb/db/active_record_persistence_provider.rb
+- lib/workflow_rb/db/entities.rb
+- lib/workflow_rb/db/migrate/001_schema.rb
+- lib/workflow_rb/db/version.rb
+- workflow_rb-db.gemspec
+homepage: https://github.com/danielgerlag/workflow_rb
+licenses: []
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Active Record persistence provider for WorkflowRb
+test_files: []