swarm 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4410067eb9ac5847b4add5e8a31f9c78f3a6f18
-  data.tar.gz: fdf564f1018be4d4ffdd837777c4fd25d1a1664d
+SHA256:
+  metadata.gz: 2710e2cf0320ab75ec855436418e709f58f8fae599e252c34e1f67627486d957
+  data.tar.gz: cc6875174915cf2d6cda654330cbf928fb232cccbb539e49cc6906f54fb7ffc5
 SHA512:
-  metadata.gz: 02303d2b8f04002bad616eddbd69ecec4e49f33cd44b4b3785802147c4815ad4f52e318c267a4f7f2de5be8451de48567b01a0ccdb277cfac7b88c140b716a94
-  data.tar.gz: ab727019332409f4e5954f8c23c34b62c1b445497b107b60f58d1c12d6fb76e5bc35c1195c0241983dabe9002ef2db007862ebbf24420a87f45dd3cc90fb4b01
+  metadata.gz: fb07523f65ce4342d8da7f64589f32f04ef003256e7f4f528a14922ffc39857cdffd4a998f97e250381251bf384b9a202a76e89abb5737dc62c6c8f4afe60cec
+  data.tar.gz: f8fc5e6f34d260e383a3591305b9d779ff9b74ca16f8eda29458c49cf14c4d43cf27afc8c36429c1f7b1f04ab02f88986d82425bcbb068b8ee6421da9918865d

data/.ruby-version

@@ -1 +1 @@
-2.1.
+3.3.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in swarm.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 require 'rspec/core/rake_task'
@@ -8,6 +10,6 @@ RSpec::Core::RakeTask.new(:spec, :tag) do |t, task_args|
   end
 end
 
-task :default => [:spec]
+task default: [:spec]
 
 Rake::TaskManager.record_task_metadata = true

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "swarm"

data/lib/swarm/engine/{base/job.rb → job.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Swarm
   module Engine
     class Job

data/lib/swarm/engine/{base/queue.rb → queue.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "job"
 
 module Swarm
@@ -12,15 +14,15 @@ module Swarm
         @name = name
       end
 
-      def prepare_for_work(worker)
+      def prepare_for_work(_worker)
         raise "Not implemented yet!"
       end
 
-      def add_job(data)
+      def add_job(_data)
         raise "Not implemented yet!"
       end
 
-      def reserve_job(worker)
+      def reserve_job(_worker)
         raise "Not implemented yet!"
       end
 
@@ -36,7 +38,7 @@ module Swarm
         job.bury if job.exists? && job.reserved?
       end
 
-      def remove_worker(worker, stop_job:)
+      def remove_worker(_worker, stop_job:)
         if worker_count <= 1
           stop_job.delete
         else
@@ -57,4 +59,4 @@ module Swarm
       end
     end
   end
-end
+end

data/lib/swarm/engine/volatile/job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Swarm
   module Engine
     module Volatile
@@ -5,6 +7,7 @@ module Swarm
         attr_reader :queue, :data, :id, :reserved_by, :buried
 
         def initialize(queue:, data:)
+          super()
           @queue = queue
           @data = data
           @id = SecureRandom.uuid
@@ -25,6 +28,7 @@ module Swarm
           if reserved_by && reserved_by != worker
             raise AlreadyReservedError
           end
+
           @reserved_by = worker
         end
 
@@ -49,9 +53,9 @@ module Swarm
         end
 
         def exists?
-          queue.has_job?(self)
+          queue.job_exists?(self)
         end
       end
     end
   end
-end
+end

data/lib/swarm/engine/volatile/queue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "job"
 
 module Swarm
@@ -22,7 +24,7 @@ module Swarm
         end
 
         def initialize(name:)
-          @name = name
+          super
           @tube = self.class.get_tube(name)
         end
 
@@ -47,8 +49,9 @@ module Swarm
 
         def reserve_job(worker)
           wait_for_job
-          index = jobs.index { |job| job.available? }
+          index = jobs.index(&:available?)
           raise JobNotFoundError unless index
+
           job = jobs[index]
           job.reserve!(worker)
           job
@@ -60,7 +63,7 @@ module Swarm
           jobs.delete_if { |job| job == job_to_delete }
         end
 
-        def has_job?(job_to_find)
+        def job_exists?(job_to_find)
           jobs.any? { |job| job == job_to_find }
         end
 
@@ -82,4 +85,4 @@ module Swarm
       end
     end
   end
-end
+end

data/lib/swarm/engine/worker/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Swarm
   module Engine
     class Worker
@@ -14,7 +16,7 @@ module Swarm
 
         attr_reader :action, :metadata, :hive
 
-        def initialize(hive: Hive.default, action:, metadata:)
+        def initialize(action:, metadata:, hive: Hive.default)
           @hive = hive
           @action = action
           @metadata = Swarm::Support.symbolize_keys(metadata || {})
@@ -22,6 +24,7 @@ module Swarm
 
         def run!
           raise MissingObjectError if object.nil?
+
           observers.each(&:before_action)
           object.send("_#{action}")
           observers.each(&:after_action)
@@ -36,6 +39,7 @@ module Swarm
         def object
           @object ||= begin
             return nil unless metadata[:type] && metadata[:id]
+
             hive.fetch(metadata[:type], metadata[:id])
           end
         end

data/lib/swarm/engine/worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "worker/command"
 
 module Swarm
@@ -22,27 +24,27 @@ module Swarm
       def run!
         setup
         @running = true
-        while running?
-          process_next_job
-        end
+        process_next_job while running?
         teardown
       end
 
       def process_next_job
-        begin
-          @current_job = queue.reserve_job(self)
-          @working = true
-          work_on(@current_job)
-          queue.delete_job(@current_job) if @current_job
-        rescue Queue::JobReservationFailed
-          retry
-        rescue StandardError
-          queue.bury_job(@current_job) if @current_job
-        ensure
-          queue.clean_up_job(@current_job) if @current_job
-          @working = false
-          @current_job = nil
-        end
+        @current_job = queue.reserve_job(self)
+        @working = true
+        work_on(@current_job)
+        queue.delete_job(@current_job) if @current_job
+      rescue Queue::JobReservationFailed
+        retry
+      rescue StandardError
+        queue.bury_job(@current_job) if @current_job
+      ensure
+        cleanup!
+      end
+
+      def cleanup!
+        queue.clean_up_job(@current_job) if @current_job
+        @working = false
+        @current_job = nil
       end
 
       def working?
@@ -60,9 +62,10 @@ module Swarm
 
       def work_on(queue_job)
         raise NotRunningError unless running?
+
         command = Command.from_job(queue_job, hive: hive)
         if command.stop?
-          queue.remove_worker(self, :stop_job => queue_job)
+          queue.remove_worker(self, stop_job: queue_job)
           stop!
         else
           command.run!
@@ -70,4 +73,4 @@ module Swarm
       end
     end
   end
-end
+end

data/lib/swarm/evaluation/expression_evaluator.rb

@@ -1,40 +1,47 @@
-require_relative "workitem_context"
+# frozen_string_literal: true
+
+require "dentaku"
 
 module Swarm
   class ExpressionEvaluator
+    class UndefinedExpressionVariableError < StandardError; end
+    class InvalidExpressionError < StandardError; end
+
     extend Forwardable
 
     attr_reader :expression
+
     def_delegators :expression, :workitem, :arguments
 
     def initialize(expression)
       @expression = expression
     end
 
-    def workitem_context
-      @workitem_context ||= WorkitemContext.new(workitem)
-    end
-
-    def eval(string)
-      workitem_context.instance_eval(string)
+    def evaluate_condition(string)
+      Dentaku.evaluate!(string, workitem)
+    rescue Dentaku::UnboundVariableError => e
+      raise UndefinedExpressionVariableError, e
+    rescue Dentaku::Error => e
+      raise InvalidExpressionError, e
     end
 
     def all_conditions_met?
-      conditions.all? { |type, exp|
-        check_condition(type, exp)
+      conditions.all? { |type, condition|
+        check_condition(type, condition)
       }
     end
 
-    def check_condition(type, exp)
-      unless ["if", "unless"].include?(type)
-        raise ArgumentError.new("Not a conditional")
+    def check_condition(type, condition)
+      unless %w[if unless].include?(type)
+        raise ArgumentError, "Not a conditional"
       end
-      result = eval(exp)
+
+      result = evaluate_condition(condition)
       type == "if" ? result : !result
     end
 
     def conditions
-      Swarm::Support.slice(arguments, "if", "unless")
+      arguments.slice("if", "unless")
     end
   end
 end

data/lib/swarm/expression.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "evaluation/expression_evaluator"
 
 module Swarm
@@ -9,14 +11,14 @@ module Swarm
 
       def inherited(subclass)
         super
-        subclass.set_columns *columns
+        subclass.set_columns(*columns)
       end
     end
 
     set_columns :parent_id, :position, :workitem, :children_ids, :milestones, :process_id
-    many_to_one :process, :class_name => "Swarm::Process"
-    many_to_one :parent, :class_name => "Swarm::Expression", :key => :parent_id
-    one_to_many :children, :class_name => "Swarm::Expression", :foreign_key => :parent_id
+    many_to_one :process, class_name: "Swarm::Process"
+    many_to_one :parent, class_name: "Swarm::Expression", key: :parent_id
+    one_to_many :children, class_name: "Swarm::Expression", foreign_key: :parent_id
 
     def branch_position
       @branch_position ||= position.last
@@ -96,7 +98,7 @@ module Swarm
       tree[position]
     end
 
-  private
+    private
 
     def set_milestone(name, at: Time.now.to_i)
       self.milestones = (milestones || {}).merge(name => at)
@@ -106,4 +108,4 @@ module Swarm
       (milestones || {})[name]
     end
   end
-end
+end

data/lib/swarm/expressions/activity_expression.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Swarm
   class ActivityExpression < Expression
     def work

data/lib/swarm/expressions/branch_expression.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative "../router"
 
 module Swarm
   class BranchExpression < Expression
-    class InvalidPositionError < StandardError; end;
+    class InvalidPositionError < StandardError; end
 
     def kick_off_children(at_positions)
       at_positions.each do |at_position|
@@ -19,20 +21,21 @@ module Swarm
     def add_child(at_position)
       node = tree[at_position]
       raise InvalidPositionError unless node
+
       expression = create_child_expression(node: node, at_position: at_position)
-      (self.children_ids ||= []) << expression.id
+      add_to_children(expression)
       expression
     end
 
     def create_child_expression(node:, at_position:)
       klass = Router.expression_class_for_node(node)
-      expression = klass.create(
-        :hive => hive,
-        :parent_id => id,
-        :position => position + [at_position],
-        :workitem => workitem,
-        :process_id => process_id
+      klass.create(
+        hive: hive,
+        parent_id: id,
+        position: position + [at_position],
+        workitem: workitem,
+        process_id: process_id
       )
     end
   end
-end
+end

data/lib/swarm/expressions/concurrence_expression.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "branch_expression"
 
 module Swarm
@@ -13,6 +15,7 @@ module Swarm
     def ready_to_proceed?
       required_replies = arguments.fetch("required_replies", nil)
       return all_children_replied? unless required_replies
+
       replied_children.count >= required_replies
     end
 
@@ -23,14 +26,14 @@ module Swarm
     def move_on_from(child)
       merge_child_workitem(child)
       save
-      if all_children_replied?
-        reply
-      end
+      return unless all_children_replied?
+
+      reply
     end
 
     def merge_child_workitem(child)
       self.workitem = Swarm::Support.deep_merge(
-        workitem, child.workitem, :combine_arrays => array_combination_method
+        workitem, child.workitem, combine_arrays: array_combination_method
       )
     end
 
@@ -38,4 +41,4 @@ module Swarm
       arguments.fetch("combine_arrays", "uniq")
     end
   end
-end
+end

data/lib/swarm/expressions/conditional_expression.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative "branch_expression"
 
 module Swarm
   class ConditionalExpression < BranchExpression
-    alias_method :original_tree, :tree
+    alias original_tree tree
 
     def work
       if tree.empty?
@@ -33,4 +35,4 @@ module Swarm
       evaluator.check_condition(command, arguments["condition"])
     end
   end
-end
+end

data/lib/swarm/expressions/sequence_expression.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "branch_expression"
 
 module Swarm
@@ -9,8 +11,8 @@ module Swarm
     def move_on_from(child)
       self.workitem = child.workitem
       kick_off_children([child.branch_position + 1])
-    rescue InvalidPositionError => e
+    rescue InvalidPositionError
       reply
     end
   end
-end
+end

data/lib/swarm/expressions/subprocess_expression.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Swarm
   class SubprocessExpression < Expression
     def work
       definition = ProcessDefinition.find_by_name(arguments.fetch("name", nil))
       raise Swarm::ProcessDefinition::RecordNotFoundError unless definition
-      process = definition.launch_process(workitem: workitem, parent_expression_id: id)
+
+      definition.launch_process(workitem: workitem, parent_expression_id: id)
     end
 
     def move_on_from(process)

data/lib/swarm/hive.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 module Swarm
   class Hive
-    class MissingTypeError < StandardError; end
     class IllegalDefaultError < StandardError; end
     class NoDefaultSetError < StandardError; end
 
     class << self
       def default=(default)
         unless default.is_a?(self)
-          raise IllegalDefaultError.new("Default must be a Swarm::Hive")
+          raise IllegalDefaultError, "Default must be a Swarm::Hive"
         end
+
         @default = default
       end
 
       def default
         unless @default
-          raise NoDefaultSetError.new("No default Hive defined yet")
+          raise NoDefaultSetError, "No default Hive defined yet"
         end
+
         @default
       end
     end
@@ -49,23 +52,13 @@ module Swarm
 
     def queue(action, object)
       @work_queue.add_job({
-        :action => action,
-        :metadata => object.to_hash
+        action: action,
+        metadata: object.to_hash
       })
     end
 
     def fetch(klass, id)
       Swarm::Support.constantize(klass).fetch(id, hive: self)
     end
-
-    def reify_from_hash(hsh)
-      Support.symbolize_keys!(hsh)
-      raise MissingTypeError.new(hsh.inspect) unless hsh[:type]
-      Swarm::Support.constantize(hsh.delete(:type)).new_from_storage(
-        hsh.merge(
-          :hive => self
-        )
-      )
-    end
   end
-end
+end