arq 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef806f025ee0a8964b1b8afeb31aff51e98f459bebb7985ca2c70ffb765de02a
-  data.tar.gz: 06ce9066144c4e5796791054a37f4f1e5850e5b99d30aa0802f3322c178a299d
+  metadata.gz: 83941043c326bd9f80903aa4755c49ae3affe39584f12d3757ab8a05e0878987
+  data.tar.gz: d94724fe95ba5dfe444c3d2587357ec60c825a61c5a0a5743a55b8c44c2b3b05
 SHA512:
-  metadata.gz: 5b6c103b2de9f4534f8f77659b3a50aaabb57c4dcac1f11fc229cd912cb6611821aa586bdc1b0c0a3f6e3f48c325e037200079a20bad9256004685c03670b355
-  data.tar.gz: 46e5ece77eb839e06b6c39ec14fe6f74571f7505e60e83350bcb580038d4bdf8b17839a748d4ccf091f0b252a826fbbb8e4c032a9be9f5d39f1da6487d5919ec
+  metadata.gz: 418c2ba2e7f9373056b1eb52503c9af47749921c8c696bdf4dce98bcf0649684eab3f2a48742f3943aed00839c1e776178e0fc4b0932409203d7c04891fa52bf
+  data.tar.gz: 543ada56b97ebef9d58fd01e614583aca4a123707917bd3d11607e2645c6ae4688db1b942be279fd0fac86c0986d6d5f7d9c9c198d8ee5742efaffbcced27f88

data/lib/arq/action.rb

@@ -3,7 +3,7 @@
 module Arq
   # Module to extend to create an action. Exposes confing functions #call, #params, and #returns.
   module Action
-    def call(ctx)
+    def call(ctx = Arq::Context.new)
       ctx = transform_input_context(ctx)
 
       generate_runnable(ctx).call

data/lib/arq/errors.rb

@@ -22,7 +22,10 @@ module Arq
     end
   end
 
-  # Raised internally in [Arq::Runnable#hard_fail!] to escape the current action.
-  class FailureError < StandardError
+  # Raised internally in [Arq::Runnable#fail!] to escape the current action.
+  # FailureError extends from Exception to avoid being rescued as a StandardError.
+  # rubocop:disable Lint/InheritException
+  class FailureError < Exception
   end
+  # rubocop:enable Lint/InheritException
 end

data/lib/arq/runnable.rb

@@ -16,9 +16,7 @@ module Arq
 
       validate_required_params
 
-      import_context
       val = run_block
-      export_context
 
       # If the block returned an array, attempt to run
       run_sequence(val) if val.is_a?(Array)
@@ -33,20 +31,22 @@ module Arq
       Arq::Runnable.new(@ctx, [], [], &block)
     end
 
-    def fail!(message)
+    def fail!(message = nil)
       @ctx.fail!(message)
     end
 
-    def fail_now!(message)
+    def fail_now!(message = nil)
       @ctx.fail_now!(message)
     end
 
     private
 
     def run_block
-      instance_eval(&@block)
-    rescue Arq::FailureError
-      nil
+      with_context do
+        instance_eval(&@block)
+      rescue Arq::FailureError
+        nil
+      end
     end
 
     def run_sequence(sequence)
@@ -60,20 +60,39 @@ module Arq
       end
     end
 
-    def import_context
+    # Runs the block with context parameters set as instance variables, then
+    # imports all context parameters and any new instance vars into the context.
+    # Returns the return value of the block.
+    def with_context
+      # Grab all current variables to know what is being returned
+      before_vars = instance_variables
+
+      # Load all context parameters into runnable instance
+      import_context_to_vars
+
+      # Run block
+      val = yield
+
+      # Grab all ctx + new vars
+      ctx_vars = instance_variables - before_vars
+
+      # Import instance vars into ctx
+      import_vars_to_context(ctx_vars)
+
+      # Return block value
+      val
+    end
+
+    def import_context_to_vars
       @ctx.each do |key, val|
         instance_variable_set(:"@#{key}", val)
       end
     end
 
-    def export_context
-      keys = [*@ctx.keys, *@returns]
-
-      keys.each do |key|
-        instance_key = :"@#{key}"
-        # Must check for existence since getting non-existent
-        # instance variables will return nil.
-        @ctx[key] = instance_variable_get(instance_key) if instance_variables.include?(instance_key)
+    def import_vars_to_context(vars)
+      vars.each do |var|
+        key = var[1..].to_sym
+        @ctx[key] = instance_variable_get(var)
       end
     end
 

data/lib/arq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Arq
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 end

data/lib/arq.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "arq/version"
-require "arq/errors"
-require "arq/context"
-require "arq/runnable"
-require "arq/action"
+require_relative "arq/errors"
+require_relative "arq/context"
+require_relative "arq/runnable"
+require_relative "arq/action"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arq
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Kavin Phan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-09-09 00:00:00.000000000 Z
 dependencies: []
 description: A service skeleton framework heavily inspired by LightService with the
   primary goal of being less verbose.
@@ -30,7 +30,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/kphan32/arq
   source_code_uri: https://github.com/kphan32/arq
-  changelog_uri: https://github.com/kphan32/arq/blob/main/CODE_OF_CONDUCT.md
+  changelog_uri: https://github.com/kphan32/arq/blob/main/CHANGELOG.md
   documentation_uri: https://rubydoc.info/github/kphan32/arq/main
   rubygems_mfa_required: 'true'
 post_install_message: