burstflow 0.1.1 → 0.2.0

data/lib/burstflow/workflow/builder.rb

@@ -0,0 +1,91 @@
+module Burstflow
+  
+class Workflow::Builder
+  def initialize workflow, *args, &block
+    @workflow = workflow
+    @deps = []
+    @jobs_by_class = {}
+    @jobs_by_id = {}
+
+    @workflow.jobs_config.each_pair do |id, job_hash|
+      job = Burstflow::Job.from_hash(@workflow, job_hash)
+
+      @jobs_by_class[job.klass.to_s] ||= []
+      @jobs_by_class[job.klass.to_s] << job
+      @jobs_by_id[id] = job
+      job.incoming.each do |from|
+        @deps << { from: from, to: id }
+      end
+
+      job.outgoing.each do |to|
+        @deps << { from: id, to: to }
+      end
+
+      @deps.uniq!
+    end
+
+    instance_exec *args, &block
+    resolve_dependencies
+  end
+
+  def run(klass, opts = {})
+    opts = opts.with_indifferent_access
+
+    before_deps = opts.delete(:before) || []
+    after_deps = opts.delete(:after) || []
+
+    job = klass.new(@workflow, opts)
+
+    [*before_deps].each do |dep|
+      @deps << { from: job.id, to: dep.to_s }
+    end
+
+    [*after_deps].each do |dep|
+      @deps << { from: dep.to_s, to: job.id }
+    end
+
+    @jobs_by_class[klass.to_s] ||= []
+    @jobs_by_class[klass.to_s] << job
+
+    raise "Job id duplication" if @jobs_by_id.key?(job.id)
+    @jobs_by_id[job.id] = job
+
+    job.id
+  end
+
+  def find_job id_or_klass
+    id = if @jobs_by_id.key?(id_or_klass)
+      id_or_klass
+    else
+      jobs = @jobs_by_class[id_or_klass.to_s]
+
+      raise "No job with #{id_or_klass.to_s} klass or id found" if jobs.count == 0
+      raise "Duplicated jobs with #{id_or_klass.to_s} klass or id detected" if jobs.count > 1
+
+      jobs.first.id
+    end
+
+    @jobs_by_id[id]
+  end
+
+  def resolve_dependencies
+    @deps.each do |dependency|
+      from = find_job(dependency[:from].to_s)
+      to   = find_job(dependency[:to].to_s)
+
+      to.incoming << from.id
+      from.outgoing << to.id
+
+      to.incoming.uniq!
+      from.outgoing.uniq!
+    end
+  end
+
+  def as_json
+    @jobs_by_id.each_with_object({}) do |(id, job), json|
+      json[job.id] = job.as_json
+    end
+  end
+
+end
+end

data/lib/burstflow/workflow/callbacks.rb

@@ -0,0 +1,66 @@
+module Burstflow::Workflow::Callbacks
+  extend  ActiveSupport::Concern
+  include ActiveSupport::Callbacks
+
+  included do
+
+    define_callbacks :failure, :finish, :suspend, :resume
+
+  end
+
+  class_methods do
+
+    def before_failure(*filters, &blk)
+      set_callback(:failure, :before, *filters, &blk)
+    end
+  
+    def after_failure(*filters, &blk)
+      set_callback(:failure, :after, *filters, &blk)
+    end
+    
+    def around_failure(*filters, &blk)
+      set_callback(:failure, :around, *filters, &blk)
+    end
+
+
+    def before_finish(*filters, &blk)
+      set_callback(:finish, :before, *filters, &blk)
+    end
+  
+    def after_finish(*filters, &blk)
+      set_callback(:finish, :after, *filters, &blk)
+    end
+    
+    def around_finish(*filters, &blk)
+      set_callback(:finish, :around, *filters, &blk)
+    end
+
+
+    def before_suspend(*filters, &blk)
+      set_callback(:suspend, :before, *filters, &blk)
+    end
+  
+    def after_suspend(*filters, &blk)
+      set_callback(:suspend, :after, *filters, &blk)
+    end
+    
+    def around_suspend(*filters, &blk)
+      set_callback(:suspend, :around, *filters, &blk)
+    end
+
+
+    def before_resume(*filters, &blk)
+      set_callback(:resume, :before, *filters, &blk)
+    end
+  
+    def after_resume(*filters, &blk)
+      set_callback(:resume, :after, *filters, &blk)
+    end
+    
+    def around_resume(*filters, &blk)
+      set_callback(:resume, :around, *filters, &blk)
+    end
+
+  end
+
+end

data/lib/{burst/workflow_helper.rb → burstflow/workflow/configuration.rb}

@@ -1,5 +1,6 @@
-module Burst::WorkflowHelper
+module Burstflow
 
+module Workflow::Configuration
   extend ActiveSupport::Concern
 
   class JSONBWithIndifferentAccess
@@ -18,25 +19,12 @@ module Burst::WorkflowHelper
 
   included do |_klass|
     serialize :flow, JSONBWithIndifferentAccess
-
-    def first_job
-      all_jobs.min_by{|n| n.started_at || Time.now.to_i }
-    end
-
-    def last_job
-      all_jobs.max_by{|n| n.finished_at || 0 } if finished?
-    end
-
-    def started_at
-      first_job&.started_at
-    end
-
-    def finished_at
-      last_job&.finished_at
-    end
-
+    
     def configure(*args)
-      instance_exec *args, &self.class.configuration
+      builder = Builder.new()
+      builder.instance_exec *args, &self.class.configuration
+      builder.resolve_dependencies
+      builder.as_json
     end
   end
 
@@ -64,23 +52,4 @@ module Burst::WorkflowHelper
 
 end
 
-
-# class Test
-#   def self.configure &block
-#     @c = block
-#   end
-
-#   def self.c
-#     @c
-#   end
-
-#   def go
-#     puts "111111"
-#   end
-
-#   def run
-#     instance_eval &Test.c
-#   end
-
-
-# end
+end

data/lib/burstflow/workflow/exception.rb

@@ -0,0 +1,8 @@
+class Burstflow::Workflow::InternalError < ::RuntimeError
+  attr_accessor :workflow
+
+  def initialize(workflow, message)
+    @workflow = workflow
+    super(message)
+  end
+end

data/lib/generators/burstflow/install/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Burstflow
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Add the migrations for Burstflow"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migrations
+        migration_template "create_workflow.rb",
+          "db/migrate/create_workflow.rb"
+      end
+    end
+  end
+end

data/lib/generators/burstflow/install/templates/create_workflow.rb

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

data/spec/builder_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Burstflow::Workflow::Builder do
+  context 'initializing' do
+    BuilderJob1 = Class.new(Burstflow::Job)
+    BuilderJob2 = Class.new(Burstflow::Job)
+    BuilderJob3 = Class.new(Burstflow::Job)
+
+    let(:workflow){double(:workflow, id: 'id1', jobs_config: {})}
+
+    it 'without dependencies' do
+      builder = Burstflow::Workflow::Builder.new workflow do 
+        $jobid1 = run BuilderJob1, params: { param1: true }
+      end
+
+      flow = builder.as_json
+      expect(flow.count).to eq 1
+
+      expect(flow[$jobid1]).to include(:id, :incoming, :outgoing, workflow_id: 'id1', params: {'param1' => true})
+    end
+
+    it 'with dependencies' do
+      builder = Burstflow::Workflow::Builder.new workflow, :arg1, :arg2 do |arg1, arg2|
+        $jobid1 = run BuilderJob1, params: { param1: true, arg: arg1}
+        $jobid2 = run BuilderJob2, params: { param2: true, arg: arg2}, after: BuilderJob1
+        $jobid3 = run BuilderJob3, before: BuilderJob2, after: $jobid1
+        $jobid4 = run BuilderJob3, after: $jobid3
+      end
+
+      flow = builder.as_json
+      expect(flow.count).to eq 4
+
+      expect(flow[$jobid1]).to include(:id, 
+        klass: BuilderJob1.to_s,
+        incoming: [],
+        outgoing: [$jobid2, $jobid3],
+        workflow_id: 'id1',
+        params: {'param1' => true, 'arg' => :arg1})
+
+      expect(flow[$jobid2]).to include(:id,
+        klass: BuilderJob2.to_s,
+        incoming: [$jobid1, $jobid3],
+        outgoing: [],
+        workflow_id: 'id1',
+        params: {'param2' => true, 'arg' => :arg2})
+
+      expect(flow[$jobid3]).to include(:id,
+        klass: BuilderJob3.to_s,
+        incoming: [$jobid1],
+        outgoing: [$jobid2, $jobid4],
+        workflow_id: 'id1',
+        params: nil)
+
+      expect(flow[$jobid4]).to include(:id,
+        klass: BuilderJob3.to_s,
+        incoming: [$jobid3],
+        outgoing: [],
+        workflow_id: 'id1',
+        params: nil)
+    end
+
+  end
+end

data/spec/{burst_spec.rb → burstflow_spec.rb}

@@ -1,4 +1,4 @@
 require 'spec_helper'
 
-describe Burst do
+describe Burstflow do
 end

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require "generator_spec"
+require 'tmpdir'
+
+require 'generators/burstflow/install/install_generator'
+
+module Burstflow
+  module Generators
+    describe InstallGenerator, type: :generator do
+      root_dir = File.expand_path(Dir.tmpdir(), __FILE__)
+      destination root_dir
+
+      before :all do
+        prepare_destination
+        run_generator
+      end
+
+      it "creates the installation db migration" do
+        migration_file = 
+          Dir.glob("#{root_dir}/db/migrate/*create_workflow.rb")
+
+        assert_file migration_file[0], 
+          /CreateWorkflow < ActiveRecord::Migration/
+      end
+    end
+  end
+end

data/spec/job_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
 
-describe Burst::Job do
-  let(:w) { Burst::Workflow.new }
+describe Burstflow::Job do
+  let(:w) { Burstflow::Workflow.new }
 
   context 'initializing' do
-    class TestJob1 < Burst::Job
+    class JobJob1 < Burstflow::Job
     end
 
-    subject{ TestJob1.new(w, {}.with_indifferent_access) }
+    subject{ JobJob1.new(w, {}.with_indifferent_access) }
 
     it 'empty' do
       expect(subject.workflow_id).to eq w.id
-      expect(subject.klass).to eq TestJob1.to_s
+      expect(subject.klass).to eq JobJob1.to_s
 
       expect(subject.incoming).to eq []
       expect(subject.outgoing).to eq []
@@ -36,6 +36,7 @@ describe Burst::Job do
     end
 
     it '#start!' do
+      subject.enqueue!
       subject.start!
 
       expect(subject.started?).to eq true
@@ -43,6 +44,8 @@ describe Burst::Job do
     end
 
     it '#finish!' do
+      subject.enqueue!
+      subject.start!
       subject.finish!
 
       expect(subject.finished?).to eq true
@@ -52,29 +55,36 @@ describe Burst::Job do
     end
 
     it '#fail!' do
-      subject.fail!
+      subject.enqueue!
+      subject.start!
+      subject.fail! "error"
 
       expect(subject.finished?).to eq true
       expect(subject.succeeded?).to eq false
       expect(subject.failed?).to eq true
       expect(subject.ready_to_start?).to eq false
+      expect(subject.failure).to include(message: 'error')
     end
 
     it '#suspend!' do
+      subject.enqueue!
+      subject.start!
       subject.suspend!
 
       expect(subject.finished?).to eq false
       expect(subject.suspended?).to eq true
-      expect(subject.ready_to_start?).to eq true
+      expect(subject.ready_to_start?).to eq false
     end
 
     it '#resume!' do
+      subject.enqueue!
+      subject.start!
       subject.suspend!
       subject.resume!
 
       expect(subject.finished?).to eq false
       expect(subject.resumed?).to eq true
-      expect(subject.ready_to_start?).to eq true
+      expect(subject.ready_to_start?).to eq false
     end
   end
 end