burstflow 0.1.1 → 0.2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burstflow
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Samoilenko Yuri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -80,7 +80,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Burst is a parallel workflow runner using ActiveRecord and ActiveJob.
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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'
+description: Burstflow is a parallel workflow runner using ActiveRecord and ActiveJob.
   It has dependency, result pipelining and suspend/resume ability
 email:
 - kinnalru@gmail.com
@@ -93,30 +107,40 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - burstflow.gemspec
 - config/database.yml
 - db/migrate/20180101000001_create_workflow.rb
 - db/schema.rb
-- db/seeds.rb
-- lib/burst.rb
-- lib/burst/builder.rb
-- lib/burst/configuration.rb
-- lib/burst/job.rb
-- lib/burst/manager.rb
-- lib/burst/model.rb
-- lib/burst/worker.rb
-- lib/burst/workflow.rb
-- lib/burst/workflow_helper.rb
-- spec/burst_spec.rb
-- spec/cases_spec.rb
+- lib/burstflow.rb
+- lib/burstflow/job.rb
+- lib/burstflow/job/callbacks.rb
+- lib/burstflow/job/exception.rb
+- lib/burstflow/job/initialization.rb
+- lib/burstflow/job/model.rb
+- lib/burstflow/job/state.rb
+- lib/burstflow/manager.rb
+- lib/burstflow/railtie.rb
+- lib/burstflow/version.rb
+- lib/burstflow/worker.rb
+- lib/burstflow/workflow.rb
+- lib/burstflow/workflow/builder.rb
+- lib/burstflow/workflow/callbacks.rb
+- lib/burstflow/workflow/configuration.rb
+- lib/burstflow/workflow/exception.rb
+- lib/generators/burstflow/install/install_generator.rb
+- lib/generators/burstflow/install/templates/create_workflow.rb
+- spec/builder_spec.rb
+- spec/burstflow_spec.rb
+- spec/generators/install_generator_spec.rb
 - spec/job_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_clean.rb
 - spec/support/runner.rb
 - spec/workflow_spec.rb
-homepage: https://github.com/RnD-Soft/burst
+homepage: https://github.com/RnD-Soft/burstflow
 licenses:
 - MIT
 metadata: {}
@@ -135,14 +159,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
-summary: Burst is a parallel workflow runner using ActiveRecord and ActiveJob
+summary: Burstflow is a parallel workflow runner using ActiveRecord and ActiveJob
 test_files:
-- spec/burst_spec.rb
-- spec/cases_spec.rb
+- spec/builder_spec.rb
+- spec/burstflow_spec.rb
+- spec/generators/install_generator_spec.rb
 - spec/job_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_clean.rb

data/db/migrate/20180101000001_create_workflow.rb

@@ -1,13 +0,0 @@
-class CreateWorkflow < ActiveRecord::Migration[5.1]
-
-  def change
-    enable_extension 'pgcrypto'
-
-    create_table :burst_workflows, id: :uuid do |t|
-      t.jsonb :flow, null: false, default: {}
-
-      t.timestamps
-    end
-  end
-
-end

data/db/seeds.rb

@@ -1 +0,0 @@
-# require_relative "../_import.rb"

data/lib/burst.rb

@@ -1,37 +0,0 @@
-require 'rubygems'
-require 'bundler'
-require 'bundler/setup'
-Bundler.require(:default)
-
-require 'active_support/all'
-require 'active_support/dependencies'
-require 'active_record'
-require 'active_job'
-
-require 'pathname'
-require 'securerandom'
-
-require 'burst/configuration'
-require 'burst/model'
-require 'burst/builder'
-require 'burst/manager'
-require 'burst/job'
-require 'burst/workflow_helper'
-require 'burst/workflow'
-require 'burst/worker'
-
-module Burst
-
-  def self.root
-    Pathname.new(__FILE__).parent.parent
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield configuration
-  end
-
-end

data/lib/burst/builder.rb

@@ -1,48 +0,0 @@
-module Burst::Builder
-
-  extend ActiveSupport::Concern
-
-  included do |_klass|
-    attr_accessor :build_deps
-
-    def initialize_builder
-      @build_deps = []
-    end
-
-    def run(klass, opts = {})
-      opts = opts.with_indifferent_access
-
-      before_deps = opts.delete(:before) || []
-      after_deps = opts.delete(:after) || []
-
-      job = klass.new(self, opts)
-
-      [*before_deps].each do |dep|
-        build_deps << { from: job.id, to: dep.to_s }
-      end
-
-      [*after_deps].each do |dep|
-        build_deps << { from: dep.to_s, to: job.id }
-      end
-
-      job_cache[job.id] = job
-      jobs[job.id] = job.model
-
-      job.id
-    end
-
-    def resolve_dependencies
-      build_deps.each do |dependency|
-        from = find_job(dependency[:from])
-        to   = find_job(dependency[:to])
-
-        to.incoming << from.id
-        from.outgoing << to.id
-
-        to.incoming.uniq!
-        from.outgoing.uniq!
-      end
-    end
-  end
-
-end

data/lib/burst/configuration.rb

@@ -1,27 +0,0 @@
-module Burst
-
-  class Configuration
-
-    attr_accessor :concurrency
-
-    def self.from_json(json)
-      new(Burst::JSON.decode(json, symbolize_keys: true))
-    end
-
-    def initialize(hash = {})
-      self.concurrency = hash.fetch(:concurrency, 5)
-    end
-
-    def to_hash
-      {
-        concurrency: concurrency
-      }
-    end
-
-    def to_json
-      Burst::JSON.encode(to_hash)
-    end
-
-  end
-
-end

data/lib/burst/job.rb

@@ -1,187 +0,0 @@
-class Burst::Job
-
-  include Burst::Model
-
-  define_stored_attributes :id, :workflow_id, :klass, :params, :incoming, :outgoing, :payloads, :output
-  define_stored_attributes :enqueued_at, :started_at, :finished_at, :failed_at, :suspended_at, :resumed_at
-
-  SUSPEND = 'suspend'.freeze
-
-  class Error < ::RuntimeError; end
-
-  def initialize(workflow, hash_store = {})
-    @workflow = workflow
-    assign_default_values(hash_store)
-  end
-
-  def assign_default_values(hash_store)
-    set_model(hash_store.deep_dup)
-
-    self.id ||= SecureRandom.uuid
-    self.workflow_id ||= @workflow.id
-    self.klass ||= self.class.to_s
-    self.incoming ||= []
-    self.outgoing ||= []
-  end
-
-  def reload
-    assign_default_values(@workflow.get_job_hash(self.id))
-  end
-
-  def save!
-    @workflow.with_lock do
-      @workflow.set_job(self)
-      @workflow.save!
-      yield if block_given?
-    end
-  end
-
-  def self.from_hash(workflow, hash_store)
-    hash_store[:klass].constantize.new(workflow, hash_store)
-  end
-
-  # execute this code by ActiveJob. You may return Burst::Job::SUSPEND to suspend job, or call suspend method
-  def perform; end
-
-  # execute this code when resumes after suspending
-  def resume(data)
-    set_output(data)
-  end
-
-  # store data to be available for next jobs
-  def set_output(data)
-    self.output = data
-  end
-
-  # mark execution as suspended
-  def suspend
-    set_output(SUSPEND)
-  end
-
-  def configure
-    @workflow.with_lock do
-      yield
-      @workflow.resolve_dependencies
-      @workflow.save!
-      @workflow.all_jobs.to_a.each(&:save!)
-      reload
-    end
-  end
-
-  def run(klass, opts = {})
-    opts[:after] = [*opts[:after], self.id].uniq
-    opts[:before] = [*opts[:before], *self.outgoing].uniq
-    @workflow.run(klass, opts)
-  end
-
-  def attributes
-    {
-      workflow_id: self.workflow_id,
-      id: self.id,
-      klass: self.klass,
-      params: params,
-      incoming: self.incoming,
-      outgoing: self.outgoing,
-      output: output,
-      started_at: started_at,
-      enqueued_at: enqueued_at,
-      finished_at: finished_at,
-      failed_at: failed_at,
-      suspended_at: suspended_at,
-      resumed_at: resumed_at
-    }
-  end
-
-  # mark job as enqueued when it is scheduled to queue
-  def enqueue!
-    raise Error.new('Already enqueued') if enqueued?
-    self.enqueued_at = current_timestamp
-    self.started_at = nil
-    self.finished_at = nil
-    self.failed_at = nil
-    self.suspended_at = nil
-    self.resumed_at = nil
-  end
-
-  # mark job as started when it is start performing
-  def start!
-    raise Error.new('Already started') if started?
-    self.started_at = current_timestamp
-  end
-
-  # mark job as finished when it is finish performing
-  def finish!
-    raise Error.new('Already finished') if finished?
-    self.finished_at = current_timestamp
-  end
-
-  # mark job as failed when it is failed
-  def fail!
-    raise Error.new('Already failed') if failed?
-    self.finished_at = self.failed_at = current_timestamp
-  end
-
-  # mark job as suspended
-  def suspend!
-    self.suspended_at = current_timestamp
-  end
-
-  # mark job as resumed
-  def resume!
-    raise Error.new('Not suspended ') unless suspended?
-    raise Error.new('Already resumed ') if resumed?
-    self.resumed_at = current_timestamp
-  end
-
-  def enqueued?
-    !enqueued_at.nil?
-  end
-
-  def started?
-    !started_at.nil?
-  end
-
-  def finished?
-    !finished_at.nil?
-  end
-
-  def running?
-    started? && !finished? && !suspended?
-  end
-
-  def failed?
-    !failed_at.nil?
-  end
-
-  def suspended?
-    !suspended_at.nil? && !resumed?
-  end
-
-  def resumed?
-    !resumed_at.nil?
-  end
-
-  def succeeded?
-    finished? && !failed?
-  end
-
-  def ready_to_start?
-    !running? && !enqueued? && !finished? && !failed? && parents_succeeded?
-  end
-
-  def initial?
-    incoming.empty?
-  end
-
-  def current_timestamp
-    Time.now.to_i
-  end
-
-  def parents_succeeded?
-    incoming.all? do |id|
-      @workflow.get_job(id).succeeded?
-    end
-  end
-
-
-end

data/lib/burst/manager.rb

@@ -1,79 +0,0 @@
-class Burst::Manager
-
-  attr_accessor :workflow
-
-  def initialize(workflow)
-    @workflow = workflow
-  end
-
-  def start
-    workflow.with_lock do
-      raise 'Already started' unless workflow.initial?
-
-      workflow.initial_jobs.each do |job|
-        enqueue_job!(job)
-      end
-    end
-  end
-
-  def enqueue_job!(job)
-    job.enqueue!
-    job.save! do
-      Burst::Worker.perform_later(workflow.id, job.id)
-    end
-  end
-
-  def resume!(job, data)
-    job.resume!
-    job.save! do
-      Burst::Worker.perform_later(workflow.id, job.id, data)
-    end
-  end
-
-  def start_job!(job)
-    job.start!
-    job.save!
-
-    job.perform
-  end
-
-  def resume_job!(job, data)
-    job.resume(data)
-  end
-
-  def suspend_job!(job)
-    job.suspend!
-    job.save!
-  end
-
-  def finish_job!(job)
-    job.finish!
-    job.save!
-
-    workflow.with_lock do
-      enqueue_outgoing_jobs(job)
-    end
-  end
-
-  def job_performed!(job, result)
-    if result == Burst::Job::SUSPEND || job.output == Burst::Job::SUSPEND
-      suspend_job!(job)
-    else
-      finish_job!(job)
-    end
-  end
-
-  def fail_job!(job)
-    job.fail!
-    job.save!
-  end
-
-  def enqueue_outgoing_jobs(job)
-    job.outgoing.each do |job_id|
-      out = workflow.get_job(job_id)
-
-      enqueue_job!(out) if out.ready_to_start?
-    end
-  end
-
-end