taskinator 0.5.0 → 0.5.2

data/spec/taskinator/task_spec.rb

@@ -93,6 +93,16 @@ describe Taskinator::Task do
         }
       end
 
+      describe "#cancel!" do
+        it { expect(subject).to respond_to(:cancel!) }
+        it {
+          expect(subject).to receive(:cancel)
+          subject.start!
+          subject.cancel!
+          expect(subject.current_state).to eq(:cancelled)
+        }
+      end
+
       describe "#fail!" do
         it { expect(subject).to respond_to(:fail!) }
         it {
@@ -144,6 +154,7 @@ describe Taskinator::Task do
         visitor = double('visitor')
         expect(visitor).to receive(:visit_attribute).with(:uuid)
         expect(visitor).to receive(:visit_process_reference).with(:process)
+        expect(visitor).to receive(:visit_type).with(:definition)
         expect(visitor).to receive(:visit_task_reference).with(:next)
         expect(visitor).to receive(:visit_args).with(:options)
         expect(visitor).to receive(:visit_attribute).with(:queue)
@@ -250,6 +261,18 @@ describe Taskinator::Task do
         expect(exec_context.options).to eq(subject.options)
       end
 
+      it "throws an exception for unknown definition type" do
+        executor = Taskinator::Executor.new(Taskinator::Persistence::UnknownType.new("Foo"), subject)
+
+        # replace the internal executor instance for the task
+        # with this one, so we can hook into the methods
+        subject.instance_eval { @executor = executor }
+
+        expect {
+          subject.start!
+        }.to raise_error(Taskinator::Persistence::UnknownTypeError)
+      end
+
       it "is instrumented" do
         instrumentation_block = SpecSupport::Block.new
 
@@ -314,36 +337,12 @@ describe Taskinator::Task do
 
     describe "#inspect" do
       it { expect(subject.inspect).to_not be_nil }
+      it { expect(subject.inspect).to include(definition.name) }
     end
   end
 
   describe Taskinator::Task::Job do
 
-    module TestJob
-      def self.perform(*args)
-      end
-    end
-
-    class TestJobClass
-      def perform(*args)
-      end
-    end
-
-    module TestJobModule
-      def self.perform(*args)
-      end
-    end
-
-    class TestJobClassNoArgs
-      def perform
-      end
-    end
-
-    module TestJobModuleNoArgs
-      def self.perform
-      end
-    end
-
     subject { Taskinator::Task.define_job_task(process, TestJob, [1, {:a => 1, :b => 2}]) }
 
     it_should_behave_like "a task", Taskinator::Task::Job
@@ -404,6 +403,22 @@ describe Taskinator::Task do
         task.start!
       }
 
+      it "throws an exception when unknown job type" do
+        task = Taskinator::Task.define_job_task(process, Taskinator::Persistence::UnknownType.new("Foo"), nil)
+
+        expect {
+          task.start!
+        }.to raise_error(Taskinator::Persistence::UnknownTypeError)
+      end
+
+      it "handles failure" do
+        task = Taskinator::Task.define_job_task(process, TestJobError, nil)
+
+        expect {
+          task.start!
+        }.to raise_error(ArgumentError)
+      end
+
       it "is instrumented" do
         allow(process).to receive(:task_completed).with(subject)
 
@@ -473,6 +488,7 @@ describe Taskinator::Task do
 
     describe "#inspect" do
       it { expect(subject.inspect).to_not be_nil }
+      it { expect(subject.inspect).to include(definition.name) }
     end
   end
 
@@ -582,6 +598,7 @@ describe Taskinator::Task do
         visitor = double('visitor')
         expect(visitor).to receive(:visit_attribute).with(:uuid)
         expect(visitor).to receive(:visit_process_reference).with(:process)
+        expect(visitor).to receive(:visit_type).with(:definition)
         expect(visitor).to receive(:visit_task_reference).with(:next)
         expect(visitor).to receive(:visit_args).with(:options)
         expect(visitor).to receive(:visit_process).with(:sub_process)
@@ -595,6 +612,7 @@ describe Taskinator::Task do
 
     describe "#inspect" do
       it { expect(subject.inspect).to_not be_nil }
+      it { expect(subject.inspect).to include(definition.name) }
     end
   end
 

data/spec/taskinator/taskinator_spec.rb

@@ -86,6 +86,22 @@ describe Taskinator do
         end
       end
     end
+  end
+
+  [
+    Taskinator::NoOpInstrumenter,
+    Taskinator::ConsoleInstrumenter
+  ].each do |instrumenter|
+    describe instrumenter do
+      it "yields to given block" do
+        instance = instrumenter.new
+
+        block = SpecSupport::Block.new
+        expect(block).to receive(:call)
 
+        instance.instrument(:foo, :bar => :baz, &block)
+      end
+    end
   end
+
 end

data/taskinator.gemspec

@@ -26,8 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'connection_pool'             , '>= 2.2.0'
   spec.add_dependency 'json'                        , '>= 1.8.2'
   spec.add_dependency 'builder'                     , '>= 3.2.2'
-  spec.add_dependency 'globalid'                    , '~> 0.3'
-  spec.add_dependency 'statsd-ruby'                 , '~> 1.4.0'
-  spec.add_dependency 'thwait'                      , '~> 0.2'
+  spec.add_dependency 'globalid'                    , '>= 0.3'
+  spec.add_dependency 'thwait'                      , '>= 0.2'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taskinator
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Chris Stefano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -84,42 +84,28 @@ dependencies:
   name: globalid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: statsd-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: thwait
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
 description: Simple process orchestration
@@ -134,7 +120,8 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/custom.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/workflows/taskinator.yml"
+- ".github/workflows/build.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -151,13 +138,12 @@ files:
 - bin/setup
 - lib/taskinator.rb
 - lib/taskinator/api.rb
+- lib/taskinator/builder.rb
 - lib/taskinator/complete_on.rb
 - lib/taskinator/create_process_worker.rb
 - lib/taskinator/definition.rb
-- lib/taskinator/definition/builder.rb
 - lib/taskinator/executor.rb
 - lib/taskinator/instrumentation.rb
-- lib/taskinator/log_stats.rb
 - lib/taskinator/logger.rb
 - lib/taskinator/persistence.rb
 - lib/taskinator/process.rb
@@ -173,7 +159,6 @@ files:
 - lib/taskinator/version.rb
 - lib/taskinator/visitor.rb
 - lib/taskinator/workflow.rb
-- lib/taskinator/xml_visitor.rb
 - processes_workflow.png
 - sequence.txt
 - spec/examples/process_examples.rb
@@ -191,13 +176,17 @@ files:
 - spec/support/test_flow.rb
 - spec/support/test_flows.rb
 - spec/support/test_instrumenter.rb
+- spec/support/test_job.rb
+- spec/support/test_job_task.rb
 - spec/support/test_process.rb
 - spec/support/test_queue.rb
+- spec/support/test_step_task.rb
+- spec/support/test_subprocess_task.rb
 - spec/support/test_task.rb
 - spec/taskinator/api_spec.rb
+- spec/taskinator/builder_spec.rb
 - spec/taskinator/complex_process_spec.rb
 - spec/taskinator/create_process_worker_spec.rb
-- spec/taskinator/definition/builder_spec.rb
 - spec/taskinator/definition_spec.rb
 - spec/taskinator/executor_spec.rb
 - spec/taskinator/instrumentation_spec.rb
@@ -215,7 +204,6 @@ files:
 - spec/taskinator/tasks_spec.rb
 - spec/taskinator/test_flows_spec.rb
 - spec/taskinator/visitor_spec.rb
-- spec/taskinator/xml_visitor_spec.rb
 - taskinator.gemspec
 - tasks_workflow.png
 homepage: https://github.com/virtualstaticvoid/taskinator
@@ -237,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A simple orchestration library for running complex processes or workflows
@@ -258,13 +246,17 @@ test_files:
 - spec/support/test_flow.rb
 - spec/support/test_flows.rb
 - spec/support/test_instrumenter.rb
+- spec/support/test_job.rb
+- spec/support/test_job_task.rb
 - spec/support/test_process.rb
 - spec/support/test_queue.rb
+- spec/support/test_step_task.rb
+- spec/support/test_subprocess_task.rb
 - spec/support/test_task.rb
 - spec/taskinator/api_spec.rb
+- spec/taskinator/builder_spec.rb
 - spec/taskinator/complex_process_spec.rb
 - spec/taskinator/create_process_worker_spec.rb
-- spec/taskinator/definition/builder_spec.rb
 - spec/taskinator/definition_spec.rb
 - spec/taskinator/executor_spec.rb
 - spec/taskinator/instrumentation_spec.rb
@@ -282,4 +274,3 @@ test_files:
 - spec/taskinator/tasks_spec.rb
 - spec/taskinator/test_flows_spec.rb
 - spec/taskinator/visitor_spec.rb
-- spec/taskinator/xml_visitor_spec.rb

data/lib/taskinator/definition/builder.rb

@@ -1,129 +0,0 @@
-module Taskinator
-  module Definition
-    class Builder
-
-      attr_reader :process
-      attr_reader :definition
-      attr_reader :args
-      attr_reader :builder_options
-
-      def initialize(process, definition, *args)
-        @process = process
-        @definition = definition
-        @builder_options = args.last.is_a?(Hash) ? args.pop : {}
-        @args = args
-        @executor = Taskinator::Executor.new(@definition)
-      end
-
-      def option?(key, &block)
-        yield if builder_options[key]
-      end
-
-      # defines a sub process of tasks which are executed sequentially
-      def sequential(options={}, &block)
-        raise ArgumentError, 'block' unless block_given?
-
-        sub_process = Process.define_sequential_process_for(@definition, options)
-        task = define_sub_process_task(@process, sub_process, options)
-        Builder.new(sub_process, @definition, *@args).instance_eval(&block)
-        @process.tasks << task if sub_process.tasks.any?
-        nil
-      end
-
-      # defines a sub process of tasks which are executed concurrently
-      def concurrent(complete_on=CompleteOn::Default, options={}, &block)
-        raise ArgumentError, 'block' unless block_given?
-
-        sub_process = Process.define_concurrent_process_for(@definition, complete_on, options)
-        task = define_sub_process_task(@process, sub_process, options)
-        Builder.new(sub_process, @definition, *@args).instance_eval(&block)
-        @process.tasks << task if sub_process.tasks.any?
-        nil
-      end
-
-      # dynamically defines tasks, using the given @iterator method
-      # the definition will be evaluated for each yielded item
-      def for_each(method, options={}, &block)
-        raise ArgumentError, 'method' if method.nil?
-        raise NoMethodError, method unless @executor.respond_to?(method)
-        raise ArgumentError, 'block' unless block_given?
-
-        #
-        # `for_each` is an exception, since it invokes the definition
-        # in order to yield elements to the builder, and any options passed
-        # are included with the builder options
-        #
-        method_args = options.any? ? [*@args, options] : @args
-        @executor.send(method, *method_args) do |*args|
-          Builder.new(@process, @definition, *args).instance_eval(&block)
-        end
-        nil
-      end
-
-      alias_method :transform, :for_each
-
-      # defines a task which executes the given @method
-      def task(method, options={})
-        raise ArgumentError, 'method' if method.nil?
-        raise NoMethodError, method unless @executor.respond_to?(method)
-
-        define_step_task(@process, method, @args, options)
-        nil
-      end
-
-      # defines a task which executes the given @job
-      # which is expected to implement a perform method either as a class or instance method
-      def job(job, options={})
-        raise ArgumentError, 'job' if job.nil?
-        raise ArgumentError, 'job' unless job.methods.include?(:perform) || job.instance_methods.include?(:perform)
-
-        define_job_task(@process, job, @args, options)
-        nil
-      end
-
-      # defines a sub process task, for the given @definition
-      # the definition specified must have input compatible arguments
-      # to the current definition
-      def sub_process(definition, options={})
-        raise ArgumentError, 'definition' if definition.nil?
-        raise ArgumentError, "#{definition.name} does not extend the #{Definition.name} module" unless definition.kind_of?(Definition)
-
-        # TODO: decide whether the sub process to dynamically receive arguments
-
-        sub_process = definition.create_sub_process(*@args, combine_options(options))
-        task = define_sub_process_task(@process, sub_process, options)
-        Builder.new(sub_process, definition, *@args)
-        @process.tasks << task if sub_process.tasks.any?
-        nil
-      end
-
-    private
-
-      def define_step_task(process, method, args, options={})
-        define_task(process) {
-          Task.define_step_task(process, method, args, combine_options(options))
-        }
-      end
-
-      def define_job_task(process, job, args, options={})
-        define_task(process) {
-          Task.define_job_task(process, job, args, combine_options(options))
-        }
-      end
-
-      def define_sub_process_task(process, sub_process, options={})
-        Task.define_sub_process_task(process, sub_process, combine_options(options))
-      end
-
-      def define_task(process)
-        process.tasks << task = yield
-        task
-      end
-
-      def combine_options(options={})
-        builder_options.merge(options)
-      end
-
-    end
-  end
-end

data/lib/taskinator/log_stats.rb

@@ -1,49 +0,0 @@
-require 'statsd'
-
-module Taskinator
-  module LogStats
-    class << self
-
-      def initialize_client
-        @client = Statsd.new()
-      end
-
-      def client
-        defined?(@client) ? @client : initialize_client
-      end
-
-      def client=(statsd_client)
-        @client = (statsd_client ? statsd_client : initialize_client)
-      end
-
-      def duration(stat, duration)
-        client.timing(stat, duration * 1000)
-      end
-
-      def timing(stat, &block)
-        result = nil
-        duration = Benchmark.realtime do
-          result = yield
-        end
-        duration(stat, duration)
-        result
-      end
-
-      def gauge(stat, count)
-        client.gauge(stat, count)
-      end
-
-      def count(stat, count)
-        client.count(stat, count)
-      end
-
-      def increment(stat)
-        client.increment(stat)
-      end
-
-      def decrement(stat)
-        client.decrement(stat)
-      end
-    end
-  end
-end

data/lib/taskinator/xml_visitor.rb

@@ -1,109 +0,0 @@
-require 'builder'
-
-module Taskinator
-  module Visitor
-    class XmlVisitor
-      class << self
-        def to_xml(process)
-          builder = ::Builder::XmlMarkup.new(:indent => 2)
-          builder.instruct!
-          builder.tag!('process') do
-            XmlVisitor.new(builder, process).visit
-          end
-        end
-      end
-
-      attr_reader :builder
-      attr_reader :instance
-
-      def initialize(builder, instance)
-        @builder = builder
-        @instance = instance
-      end
-
-      def visit
-        @instance.accept(self)
-      end
-
-      def write_error(error)
-        return unless error[0]
-        builder.tag!('error', :type => error[0]) do
-          builder.message(error[1])
-          builder.cdata!(error[2].join("\n"))
-        end
-      end
-
-      def visit_process(attribute)
-        process = @instance.send(attribute)
-        if process
-          p = process.__getobj__
-
-          attribs = {
-            :type => p.class.name,
-            :current_state => p.current_state
-          }
-
-          builder.tag!('process', attribs) do
-            XmlVisitor.new(builder, p).visit
-            write_error(p.error)
-          end
-        end
-      end
-
-      def visit_tasks(tasks)
-        tasks.each do |task|
-          t = task.__getobj__
-
-          attribs = {
-            :type => t.class.name,
-            :current_state => t.current_state
-          }
-
-          builder.tag!('task', attribs) do
-            XmlVisitor.new(builder, t).visit
-            write_error(t.error)
-          end
-        end
-      end
-
-      def visit_attribute(attribute)
-        value = @instance.send(attribute)
-        builder.tag!('attribute', :name => attribute, :value => value) if value
-      end
-
-      def visit_attribute_time(attribute)
-        visit_attribute(attribute)
-      end
-
-      def visit_attribute_enum(attribute, type)
-        visit_attribute(attribute)
-      end
-
-      def visit_process_reference(attribute)
-        process = @instance.send(attribute)
-        builder.tag!('attribute_ref', { :name => attribute, :type => process.__getobj__.class.name, :value => process.uuid }) if process
-      end
-
-      def visit_task_reference(attribute)
-        task = @instance.send(attribute)
-        builder.tag!('attribute_ref', { :name => attribute, :type => task.__getobj__.class.name, :value => task.uuid }) if task
-      end
-
-      def visit_type(attribute)
-        type = @instance.send(attribute)
-        builder.tag!('attribute', { :name => attribute, :value => type.name })
-      end
-
-      def visit_args(attribute)
-        values = @instance.send(attribute)
-
-        builder.tag!('attribute', :name => attribute) do
-          builder.cdata!(values.to_json)
-        end if values && !values.empty?
-      end
-
-      def task_count
-      end
-    end
-  end
-end

data/spec/taskinator/xml_visitor_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-describe Taskinator::Visitor::XmlVisitor do
-  pending
-end