libis-workflow-activerecord 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e5ca19333207c2454878483bec80747d8af6717
+  data.tar.gz: 4006386a833854575803812cb7f379f43baafb21
+SHA512:
+  metadata.gz: f90d6c9a59ccbaec455a9ece2bf6759d60ba2bddafbecf3f37470117eb2b2ec7738c2f942c80fdf81825a57abd641343ac4acb75817a7d0861f5de26495ba69e
+  data.tar.gz: 4fc925d21262f45aa265658ac39cbc558401dd40057bdfc7be801429a8b5522309ec299d978ed9f624360b6c3483b01352e340570159a692fc552614760a4fba

data/.gitignore

@@ -0,0 +1,57 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+*.db
+
+# Rubymine project files
+*.iml
+.idea

data/.travis.yml

@@ -0,0 +1,50 @@
+language: ruby
+sudo: false
+bundler_args: --without development
+cache: bundler
+
+rvm:
+  - 2.3.0
+  - 2.4.1
+  - 2.5.0
+  - ruby-head
+  - jruby-9.1.9.0
+  - jruby-head
+jdk:
+  - openjdk8
+  - oraclejdk8
+  - oraclejdk9
+matrix:
+  exclude:
+    - rvm: 2.3.0
+      jdk: oraclejdk8
+    - rvm: 2.3.0
+      jdk: oraclejdk9
+    - rvm: 2.4.1
+      jdk: oraclejdk8
+    - rvm: 2.4.1
+      jdk: oraclejdk9
+    - rvm: 2.5.0
+      jdk: oraclejdk8
+    - rvm: 2.5.0
+      jdk: oraclejdk9
+    - rvm: ruby-head
+      jdk: oraclejdk8
+    - rvm: ruby-head
+      jdk: oraclejdk9
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+branches:
+  only:
+      - master
+env:
+  global:
+    - JRUBY_OPTS="-Xcli.debug=true --debug"
+addons:
+  postgresql: "9.6"
+services:
+  - postgresql
+before_script:
+  - psql -c 'create database upload;' -U postgres
+  - cp db/travis.config.yml db/config.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec name: 'libis-workflow-activerecord', development_group: :test

data/README.md

@@ -0,0 +1,13 @@
+[![Gem Version](https://badge.fury.io/rb/libis-workflow-activerecord.svg)](http://badge.fury.io/rb/libis-workflow-activerecord)
+[![Build Status](https://travis-ci.org/Kris-LIBIS/workflow-activerecord.svg?branch=master)](https://travis-ci.org/Kris-LIBIS/workflow-activerecord)
+[![Coverage Status](https://coveralls.io/repos/Kris-LIBIS/workflow-activerecord/badge.png)](https://coveralls.io/r/Kris-LIBIS/workflow-activerecord)
+[![Dependency Status](https://gemnasium.com/Kris-LIBIS/workflow-activerecord.svg)](https://gemnasium.com/Kris-LIBIS/workflow-activerecord)
+
+workflow-activerecord
+=====================
+
+ActiveRecord persistence for the workflow framework.
+
+Note: This gem only supports Postgres and MySql as it needs support for json data type in the DB.
+When - and if - the sqlite3 adapter adds support for the sqlite JSON1 extension, this gem
+is expected to support sqlite as well.

data/Rakefile

@@ -0,0 +1,85 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+desc 'run tests'
+task :default => :spec
+
+require 'yaml'
+require 'logger'
+require 'active_record'
+
+namespace :db do
+  def create_database(config)
+    options = {:charset => 'utf8', :collation => 'utf8_unicode_ci'}
+
+    create_db = lambda do |cfg|
+      ActiveRecord::Base.establish_connection cfg.merge('database' => nil)
+      ActiveRecord::Base.connection.create_database cfg['database'], options
+      ActiveRecord::Base.establish_connection cfg
+    end
+
+    begin
+      create_db.call config
+      # rescue Mysql::Error => sqlerr
+      #   if sqlerr.errno == 1405
+      #     print "#{sqlerr.error}. \nPlease provide the root password for your mysql installation\n>"
+      #     root_password = $stdin.gets.strip
+      #
+      #     grant_statement = <<-SQL
+      #       GRANT ALL PRIVILEGES ON #{config['database']}.*
+      #         TO '#{config['username']}'@'localhost'
+      #         IDENTIFIED BY '#{config['password']}' WITH GRANT OPTION;
+      #     SQL
+      #
+      #     create_db.call config.merge('database' => nil, 'username' => 'root', 'password' => root_password)
+      #   else
+      #     $stderr.puts sqlerr.error
+      #     $stderr.puts "Couldn't create database for #{config.inspect}, charset: utf8, collation: utf8_unicode_ci"
+      #     $stderr.puts "(if you set the charset manually, make sure you have a matching collation)" if config['charset']
+      #   end
+    end
+  end
+
+  task :environment do
+    DATABASE_ENV = ENV['DATABASE_ENV'] || 'development'
+    MIGRATIONS_DIR = ENV['MIGRATIONS_DIR'] || 'db/migrate'
+  end
+
+  task :configuration => :environment do
+    @config = YAML.load_file('db/config.yml')[DATABASE_ENV]
+  end
+
+  task :configure_connection => :configuration do
+    ActiveRecord::Base.establish_connection @config
+    ActiveRecord::Base.logger = Logger.new STDOUT if @config['logger']
+  end
+
+  desc 'Create the database from db/config.yml for the current DATABASE_ENV'
+  task :create => :configure_connection do
+    create_database @config
+  end
+
+  desc 'Drops the database for the current DATABASE_ENV'
+  task :drop => :configure_connection do
+    ActiveRecord::Base.connection.drop_database @config['database']
+  end
+
+  desc 'Migrate the database (options: VERSION=x, VERBOSE=false).'
+  task :migrate => :configure_connection do
+    ActiveRecord::Migration.verbose = true
+    ActiveRecord::Migrator.migrate MIGRATIONS_DIR, ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+  end
+
+  desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n).'
+  task :rollback => :configure_connection do
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+    ActiveRecord::Migrator.rollback MIGRATIONS_DIR, step
+  end
+
+  desc 'Retrieves the current schema version number'
+  task :version => :configure_connection do
+    puts "Current version: #{ActiveRecord::Migrator.current_version}"
+  end
+end

data/db/config.yml

@@ -0,0 +1,71 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  database: upload
+  host: localhost
+  port: 5432
+  username: upload
+  password: upload
+  # For details on connection pooling, see Rails configuration guide
+  # http://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: 20
+
+development:
+  <<: *default
+
+  # The specified database role being used to connect to postgres.
+  # To create additional roles in postgres see `$ createuser --help`.
+  # When left blank, postgres will use the default role. This is
+  # the same name as the operating system user that initialized the database.
+  #username: Uploader
+
+  # The password associated with the postgres role (username).
+  #password:
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  #host: localhost
+
+  # The TCP port the server listens on. Defaults to 5432.
+  # If your server runs on a different port number, change accordingly.
+  #port: 5432
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # Defaults to warning.
+  min_messages: debug5
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  min_messages: warning
+
+# As with config/secrets.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password as a unix environment variable when you boot
+# the app. Read http://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full rundown on how to provide these environment variables in a
+# production deployment.
+#
+# On Heroku and other platform providers, you may have a full connection URL
+# available as an environment variable. For example:
+#
+#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
+#
+# You can use this database configuration with:
+#
+#   production:
+#     url: <%= ENV['DATABASE_URL'] %>
+#
+production:
+  <<: *default
+  min_messages: warning

data/db/migrate/001_create_work_items_table.rb

@@ -0,0 +1,18 @@
+require 'libis/workflow/activerecord'
+
+class CreateWorkflowItemsTable < ActiveRecord::Migration[5.0]
+
+  def change
+    create_table :work_items do |t|
+      t.string :type
+      t.jsonb :properties
+      t.jsonb :options
+      t.jsonb :status_log
+      t.references :parent, foreign_key: {to_table: :work_items, on_delete: :cascade}
+
+      t.timestamps
+    end
+
+    add_index :work_items, :status_log, using: :gin
+  end
+end

data/db/migrate/002_create_jobs_table.rb

@@ -0,0 +1,27 @@
+require 'libis/workflow/activerecord'
+
+class CreateWorkflowItemsTable < ActiveRecord::Migration[5.0]
+
+  def change
+    create_table :jobs do |t|
+      t.string :type
+      t.string :name
+      t.string :description
+      t.jsonb :input
+      t.string :run_object
+      t.boolean :log_to_file, default: true
+      t.boolean :log_each_run, default: true
+      t.string :log_level, default: 'INFO'
+      t.string :log_age, default: 'daily'
+      # noinspection RubyResolve
+      t.integer :log_keep, default: 5
+
+      t.timestamps
+
+      t.integer :run_id
+      t.integer :workflow_id
+    end
+
+    add_index :jobs, :workflow_id
+  end
+end

data/db/schema.rb

@@ -0,0 +1,72 @@
+ActiveRecord::Schema.define do
+  self.verbose = true
+
+  enable_extension 'plpgsql'
+
+  # enable_extension 'pgcrypto'
+
+  create_table :workflows, force: :cascade do |t|
+    t.string :type
+    t.string :name
+    t.text :description
+    if ActiveRecord::Base.connection.instance_values["config"][:adapter] == "postgresql"
+      t.jsonb :config, default: {}
+    else
+      t.json :config, default: {}
+    end
+
+    t.timestamps
+  end
+
+  if ActiveRecord::Base.connection.instance_values["config"][:adapter] == "postgresql"
+    add_index :workflows, :config, using: :gin
+  end
+
+  create_table :jobs, force: :cascade do |t|
+    t.string :type
+    t.string :name
+    t.text :description
+    if ActiveRecord::Base.connection.instance_values["config"][:adapter] == "postgresql"
+      t.jsonb :input, default: {}
+    else
+      t.json :input, default: {}
+    end
+    t.string :run_object
+    t.boolean :log_to_file, default: true
+    t.boolean :log_each_run, default: true
+    t.string :log_level, default: 'INFO'
+    t.string :log_age, default: 'daily'
+    # noinspection RubyResolve
+    t.integer :log_keep, default: 5
+
+    t.timestamps
+
+    t.references :workflow, foreign_key: {to_table: :workflows, on_delete: :cascade}
+    t.integer :workflow_id
+  end
+
+  if ActiveRecord::Base.connection.instance_values["config"][:adapter] == "postgresql"
+    add_index :jobs, :input, using: :gin
+  end
+
+  create_table :work_items, force: :cascade do |t|
+    t.string :type
+    if ActiveRecord::Base.connection.instance_values["config"][:adapter] == "postgresql"
+      t.jsonb :properties
+      t.jsonb :options
+      t.jsonb :status_log
+    else
+      t.json :properties
+      t.json :options
+      t.json :status_log
+    end
+    t.references :parent, foreign_key: {to_table: :work_items, on_delete: :cascade}
+    t.references :job, foreign_key: {to_table: :jobs, on_delete: :cascade}
+    t.timestamps
+  end
+
+  if ActiveRecord::Base.connection.instance_values["config"][:adapter] == "postgresql"
+    add_index :work_items, :status_log, using: :gin
+  end
+
+end

data/db/setup_db.rb

@@ -0,0 +1,14 @@
+root_dir = File.join(File.dirname(__FILE__), '..')
+Dir.chdir root_dir
+$:.unshift File.join(root_dir, 'lib')
+
+require 'libis-workflow-activerecord'
+
+::Libis::Workflow::ActiveRecord.configure do |cfg|
+  # noinspection RubyResolve
+  cfg.database_connect 'db/config.yml', :test
+end
+
+require 'database_cleaner'
+
+load 'db/schema.rb'

data/db/travis.config.yml

@@ -0,0 +1,4 @@
+test:
+  adapter: postgresql
+  encoding: unicode
+  database: travis_ci_test

data/lib/libis-workflow-activerecord.rb

@@ -0,0 +1 @@
+require 'libis/workflow/activerecord'

data/lib/libis/workflow/activerecord.rb

@@ -0,0 +1,25 @@
+require 'libis-workflow'
+
+require_relative 'activerecord/version'
+require 'active_record'
+
+module Libis
+  module Workflow
+    module ActiveRecord
+
+      autoload :Base, 'libis/workflow/activerecord/base'
+      autoload :Config, 'libis/workflow/activerecord/config'
+      autoload :WorkItem, 'libis/workflow/activerecord/work_item'
+      autoload :Run, 'libis/workflow/activerecord/run'
+      autoload :Job, 'libis/workflow/activerecord/job'
+      autoload :Worker, 'libis/workflow/activerecord/worker'
+      autoload :Workflow, 'libis/workflow/activerecord/workflow'
+
+      def self.configure
+        yield ::Libis::Workflow::ActiveRecord::Config.instance
+      end
+
+    end
+
+  end
+end