zenaton 0.4.2 → 0.5.0

data/lib/zenaton/contexts.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Zenaton
+  # Represents the current runtime context of a Workflow or Task.
+  module Contexts
+  end
+end

data/lib/zenaton/contexts/task.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Zenaton
+  module Contexts
+    # Represents the current runtime context of a Task.
+    #
+    # The information provided by the context can be useful to alter the
+    # behaviour of the task.
+    #
+    # For example, you can use the attempt index to know if a task has been
+    # automatically retried or not and how many times, and decide to do
+    # something when you did not expect the task to be retried more than X
+    # times.
+    #
+    # You can also use the attempt number in the `on_error_retry_delay` method
+    # of a task in order to implement complex retry strategies.
+    class Task
+      # @return [String] The UUID identifying the current task
+      attr_reader :id
+
+      # @return [Integer] The number of times this task has been automatically
+      #   retried. This counter is reset if you issue a manual retry from your
+      #   dashboard
+      attr_reader :retry_index
+
+      # @return [Zenaton::Contexts::Task] a new execution context for a task
+      def initialize(**kwargs)
+        @id = kwargs[:id]
+        @retry_index = kwargs[:retry_index]
+      end
+    end
+  end
+end

data/lib/zenaton/contexts/workflow.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zenaton
+  module Contexts
+    # Represents the current runtime context of a Workflow.
+    class Workflow
+      # @return [String] The UUID identifying the current workflow
+      attr_reader :id
+
+      # @return [Zenaton::Contexts::Workflow] a new execution context for a
+      #   workflow
+      def initialize(**kwargs)
+        @id = kwargs[:id]
+      end
+    end
+  end
+end

data/lib/zenaton/engine.rb

@@ -24,6 +24,22 @@ module Zenaton
       @processor = nil
     end
 
+    # Executes scheduling jobs synchronously
+    # @param jobs [Array<Zenaton::Interfaces::Job>]
+    # @param cron String
+    # @return [Array<String>, nil] the results if executed locally, or nil
+    def schedule(jobs, cron)
+      jobs.map(&method(:check_argument))
+      jobs.map do |job|
+        if job.is_a? Interfaces::Workflow
+          @client.start_scheduled_workflow(job, cron)
+        else
+          @client.start_scheduled_task(job, cron)
+        end
+      end
+      nil
+    end
+
     # Executes jobs synchronously
     # @param jobs [Array<Zenaton::Interfaces::Job>]
     # @return [Array<String>, nil] the results if executed locally, or nil

data/lib/zenaton/interfaces/task.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'zenaton/interfaces/job'
+require 'zenaton/contexts/task'
 
 module Zenaton
   module Interfaces
@@ -9,7 +10,35 @@ module Zenaton
       # Child classes should implement the handle method
       def handle
         raise NotImplemented,
-              "Your workflow does not implement the `handle' method"
+              "Your workflow does not implement the `#handle' method"
+      end
+
+      # (Optional) Implement this method for automatic retrial of task in
+      # case of failures.
+      # @param _exception [Exception] the reason for the task failure.
+      # @return [Integer, FalseClass, NilClass] the non-negative amount of
+      #   seconds to wait before automatically retrying this task. Falsy values
+      #   will avoid retrial. Other values will cause the retrial to fail.
+      def on_error_retry_delay(_exception)
+        nil
+      end
+
+      # @return [Zenaton::Contexts::Task] the task execution context
+      def context
+        @context || Contexts::Task.new
+      end
+
+      # @private
+      # Sets a new context if none has been set yet.
+      # This is called from the zenaton agent and will raise if called twice.
+      # @raise [ArgumentError] when the context was already set.
+      def add_context(**attributes)
+        message = <<~ERROR
+          Context has already been set and cannot be mutated.
+        ERROR
+        raise ArgumentError, message if @context
+
+        @context = Contexts::Task.new(attributes)
       end
     end
   end

data/lib/zenaton/interfaces/workflow.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'zenaton/interfaces/job'
+require 'zenaton/contexts/workflow'
 
 module Zenaton
   module Interfaces
@@ -18,6 +19,20 @@ module Zenaton
       def id
         nil
       end
+
+      # @return [Zenaton::Contexts::Workflow] the workflow execution context
+      def context
+        @context || Contexts::Workflow.new
+      end
+
+      # @private
+      # Sets a new context if none has been set yet.
+      # This is called from the zenaton agent and will raise if called twice.
+      # @raise [ArgumentError] when the context was already set.
+      def add_context(**attributes)
+        raise ArgumentError if @context
+        @context = Contexts::Workflow.new(attributes)
+      end
     end
   end
 end

data/lib/zenaton/refinements.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'zenaton/refinements/big_decimal'
+require 'zenaton/refinements/class'
+require 'zenaton/refinements/complex'
+require 'zenaton/refinements/date'
+require 'zenaton/refinements/date_time'
+require 'zenaton/refinements/exception'
+require 'zenaton/refinements/object'
+require 'zenaton/refinements/open_struct'
+require 'zenaton/refinements/range'
+require 'zenaton/refinements/rational'
+require 'zenaton/refinements/regexp'
+require 'zenaton/refinements/struct'
+require 'zenaton/refinements/symbol'
+require 'zenaton/refinements/time'

data/lib/zenaton/refinements/big_decimal.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/AndOr
+defined?(::BigDecimal) or require 'bigdecimal'
+# rubocop:enable Style/AndOr
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine BigDecimal do
+      def to_zenaton
+        {
+          'b' => _dump
+        }
+      end
+    end
+  end
+end
+
+# Reimplements `json/add/bigdecimal`
+class BigDecimal
+  def self.from_zenaton(props)
+    BigDecimal._load props['b']
+  end
+end

data/lib/zenaton/refinements/class.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine Class do
+      def to_zenaton
+        {
+          'n' => name
+        }
+      end
+    end
+  end
+end
+
+# Load an instance of class from zenaton properties
+class Class
+  def self.from_zenaton(props)
+    Object.const_get(props['n'])
+  end
+end

data/lib/zenaton/refinements/complex.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine Complex do
+      def to_zenaton
+        {
+          'r' => real,
+          'i' => imag
+        }
+      end
+    end
+  end
+end
+
+# Reimplements `json/add/complex`
+class Complex
+  def self.from_zenaton(props)
+    Complex(props['r'], props['i'])
+  end
+end

data/lib/zenaton/refinements/date.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine Date do
+      def to_zenaton
+        {
+          'y' => year,
+          'm' => month,
+          'd' => day,
+          'sg' => start
+        }
+      end
+    end
+  end
+end
+
+# Reimplements `json/add/date`
+class Date
+  def self.from_zenaton(props)
+    civil(*props.values_at('y', 'm', 'd', 'sg'))
+  end
+end

data/lib/zenaton/refinements/date_time.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine DateTime do
+      def to_zenaton
+        {
+          'y' => year,
+          'm' => month,
+          'd' => day,
+          'H' => hour,
+          'M' => min,
+          'S' => sec,
+          'of' => offset.to_s,
+          'sg' => start
+        }
+      end
+    end
+  end
+end
+
+# Reimplements `json/add/date_time`
+class DateTime
+  def self.from_zenaton(props)
+    args = props.values_at('y', 'm', 'd', 'H', 'M', 'S')
+    of_a, of_b = props['of'].split('/')
+    # rubocop:disable Style/ConditionalAssignment
+    if of_b && of_b != '0'
+      args << Rational(of_a.to_i, of_b.to_i)
+    else
+      args << of_a
+    end
+    # rubocop:enable Style/ConditionalAssignment
+    args << props['sg']
+    civil(*args)
+  end
+end

data/lib/zenaton/refinements/exception.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine Exception do
+      def to_zenaton
+        {
+          'm' => message,
+          'b' => backtrace
+        }
+      end
+    end
+  end
+end
+
+# Reimplements `json/add/exception`
+class Exception
+  def self.from_zenaton(props)
+    result = new(props['m'])
+    result.set_backtrace props['b']
+    result
+  end
+end

data/lib/zenaton/refinements/object.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine Object do
+      def to_zenaton
+        instance_variables.map do |ivar|
+          value = instance_variable_get(ivar)
+          [ivar, value]
+        end.to_h
+      end
+    end
+  end
+end

data/lib/zenaton/refinements/open_struct.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine OpenStruct do
+      def to_zenaton
+        class_name = self.class.name.to_s
+        error_message = 'Only named structs are supported'
+        raise ArgumentError, error_message if class_name.empty?
+        {
+          't' => table
+        }
+      end
+    end
+  end
+end
+
+# Reimplements `json/add/ostruct`
+class OpenStruct
+  def self.from_zenaton(props)
+    new(props['t'] || props[:t])
+  end
+end

data/lib/zenaton/refinements/range.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine Range do
+      def to_zenaton
+        {
+          'a' => [first, last, exclude_end?]
+        }
+      end
+    end
+  end
+end
+
+# Reimplements `json/add/range`
+class Range
+  def self.from_zenaton(props)
+    new(*props['a'])
+  end
+end

data/lib/zenaton/refinements/rational.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine Rational do
+      def to_zenaton
+        {
+          'n' => numerator,
+          'd' => denominator
+        }
+      end
+    end
+  end
+end
+
+# Reimplements `json/add/rational`
+class Rational
+  def self.from_zenaton(props)
+    Rational(props['n'], props['d'])
+  end
+end

data/lib/zenaton/refinements/regexp.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zenaton
+  # :nodoc
+  module Refinements
+    refine Regexp do
+      def to_zenaton
+        {
+          'o' => options,
+          's' => source
+        }
+      end
+    end
+  end
+end
+
+# Reimplements `json/add/regexp`
+class Regexp
+  def self.from_zenaton(props)
+    new(props['s'], props['o'])
+  end
+end