respawn 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cde24c2f311c9468a6b9811fcc531c029b1d8addfee5e7a9b5c6283ca86e9cf3
-  data.tar.gz: dab8ea8a99e90ef941cdce690fa2dad567351c289ad6d50a1bd7b65c325651b3
+  metadata.gz: 907c5b6836d134a5d5aad923a8a3998e471e853175f38eb03d8102f5ded7f75f
+  data.tar.gz: a36a96ac08c14eb76be898aaa47f9d45c05d7010acb787d9c02a37cb2fa2981e
 SHA512:
-  metadata.gz: cee1d10a076206759a165f991bd1c8fec776e453a3525f55c44118b3939190da1acb87e949b7f6e6d4d36846281b5e6d1cbf6cb0194796adf58dd7e22d65bc06
-  data.tar.gz: 54226cd2b318a05554bb1f7c8e9707894f50f5bf9587c19ef29389a4406864c68a786f85761ca0ba2436cc1938503a8d3eb9c5b23f044cacbdd705a99b2fb6b1
+  metadata.gz: bb18883bbbeb24d44c61d8a33b3e9d57141f668ca0fe9ec5c8f5ac718d920e65786579ecdf163f5ade8883a1f44f1b4b065c8e0e80068cbc2b49726e670a5b40
+  data.tar.gz: 449b7fc2bd2530194bf7c515df721186df79420121de956f37c9fad5f47bd4b91419899a6ee62fb7f1ff6347ab1f2eec80f54bdd4780e7be100bb39240ff5348

data/lib/respawn/array_try.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Respawn
+  module ArrayTry
+    refine Array do
+      def try!(element)
+        include?(element) or
+          raise(
+            ArgumentError,
+            %(Element "#{element}" not found in array #{self}),
+          )
+
+        element
+      end
+    end
+  end
+end

data/lib/respawn/enum.rb

@@ -0,0 +1,7 @@
+module Respawn
+  class Enum
+    def initialize(values)
+      self.values = nvalues
+    end
+  end
+end

data/lib/respawn/environment.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Respawn
+  ENVIRONMENTS = %w[
+    development
+    production
+    test
+  ].freeze
+
+  Environment = Data.define(:env) do
+    using ArrayTry
+
+    def initialize(env:)
+      ENVIRONMENTS.try!(env)
+
+      super
+    end
+
+    ENVIRONMENTS.each do |name|
+      define_method("#{name}?") do
+        env == name
+      end
+    end
+
+    def self.default
+      new(
+        ENV.fetch("RUBY_ENV") do
+          ENV.fetch("RAILS_ENV", "production")
+        end,
+      )
+    end
+  end
+end

data/lib/respawn/exception_detector.rb

@@ -2,14 +2,11 @@
 
 module Respawn
   class ExceptionDetector
-    PREDEFINED_EXCEPTIONS = [
-      EOFError,
-      Errno::ECONNABORTED,
-      Errno::ECONNRESET,
-      Errno::EHOSTUNREACH,
-    ].freeze
-
-    DYNAMIC_EXCEPTIONS = [
+    EXCEPTIONS = [
+      "EOFError",
+      "Errno::ECONNABORTED",
+      "Errno::ECONNRESET",
+      "Errno::EHOSTUNREACH",
       "SocketError",
       "Faraday::ConnectionFailed",
       "Faraday::TimeoutError",
@@ -19,18 +16,19 @@ module Respawn
       "Net::ReadTimeout",
       "OpenSSL::SSL::SSLError",
       "OpenURI::HTTPError",
+      "TestException",
     ].freeze
 
-    def self.call(...)
-      new(...).call
+    def self.call(env: Environment.default)
+      if env.test?
+        new.call
+      else
+        @_call ||= new.call
+      end
     end
 
     def call
-      PREDEFINED_EXCEPTIONS + dynamic_exceptions
-    end
-
-    def dynamic_exceptions
-      DYNAMIC_EXCEPTIONS.filter_map do
+      EXCEPTIONS.filter_map do
         Object.const_get(it) if Object.const_defined?(it)
       end
     end

data/lib/respawn/handler.rb

@@ -14,7 +14,7 @@ module Respawn
       return if self.block
 
       if onfail != :handler
-        raise Try::Error, "Cannot define a block unless onfail is :handler"
+        raise Error, "Cannot define a block unless onfail is :handler"
       end
 
       self.block = block

data/lib/respawn/notifier_detector.rb

@@ -2,8 +2,17 @@
 
 module Respawn
   class NotifierDetector
-    def self.call(...)
-      new(...).call
+    # Postpone the actual setup until the first use of the method, to make
+    # sure that all the dependencies are loaded and all constants are already
+    # available. Memoize the result of first run, to avoid processing all the
+    # logic in subsequent invocations.
+
+    def self.call(env: Environment.default)
+      if env.test?
+        new.call
+      else
+        @_call ||= new.call
+      end
     end
 
     def call
@@ -12,8 +21,10 @@ module Respawn
 
     private
 
+    attr_accessor :notifier
+
     def detect_notifier
-      if defined?(TestNotifier)
+      if defined?(::TestNotifier)
         TestNotifier.method(:call)
       elsif defined?(::Sentry)
         Sentry.method(:capture_exception)
@@ -24,7 +35,12 @@ module Respawn
       elsif defined?(::Rollbar)
         :rollbar
       else
-        proc {}
+        proc do
+          raise(
+            Error,
+            "Notifier called, but no notifier detected!",
+          )
+        end
       end
     end
   end

data/lib/respawn/setup.rb

@@ -1,10 +1,42 @@
 # frozen_string_literal: true
 
 module Respawn
+  ONFAIL = [
+    :notify,
+    :nothing,
+    :raise,
+    :handler,
+  ].freeze
+
+  OPTIONS = {
+    notifier: NotifierDetector,
+    ex: ExceptionDetector,
+    onfail: :raise,
+    predicate: [],
+    tries: 5,
+    wait: 0.5,
+    env: -> { Environment.default },
+    setup: nil,
+  }.freeze
+
   Setup =
-    Data.define(
-      :notifier,
-      :cause,
-      :predicate,
-    )
+    Data.define(*OPTIONS.keys) do
+      def initialize(**options)
+        with_defaults =
+          OPTIONS.map.to_h do |key, value|
+            [
+              key,
+              options.fetch(key) do
+                if value.respond_to?(:call)
+                  value.call
+                else
+                  value
+                end
+              end
+            ]
+          end
+
+        super(with_defaults)
+      end
+    end
 end

data/lib/respawn/try.rb

@@ -1,43 +1,33 @@
 module Respawn
-  Environment = Data.define(:env) do
-    def test? = env == "test"
-  end
-
   class Try
-    class Error < StandardError; end
-
-    ONFAIL = [
-      :notify,
-      :nothing,
-      :raise,
-      :handler,
-    ].freeze
+    using ArrayTry
 
     def self.call(*, **, &)
       new(*, **).call(&)
     end
 
-    def initialize(*exceptions, predicate: [], tries: 5, onfail: :notify, wait: 0.5, env: nil)
-      self.predicate = predicate
+    def initialize(*exceptions, **options)
+      options.keys.each { OPTIONS.keys.try!(it) }
+
+      self.setup = options.fetch(:setup, Setup.new(**options))
+
+      self.notifier = options.fetch(:notifier, setup.notifier)
+      self.predicate = options.fetch(:predicate, setup.predicate)
+
+      exceptions = setup.ex if exceptions.empty?
+
       self.exceptions = parse_exceptions(exceptions) + [PredicateError]
-      self.tries = tries
-      self.onfail = ONFAIL.zip(ONFAIL).to_h.fetch(onfail)
-      self.wait = wait
+      self.tries = options.fetch(:tries, setup.tries)
+      self.onfail = ONFAIL.try! options.fetch(:onfail, setup.onfail)
+      self.wait = options.fetch(:wait, setup.wait)
+      self.env = options.fetch(:env, Environment.default)
+
       self.handler = Handler.new(onfail)
-      self.env = env || Environment.new(default_environment)
     end
 
     def call
-      yield(handler).tap do |result|
-        Array(predicate).each.with_index do |condition, index|
-          if condition.call(result)
-            raise(
-              PredicateError,
-              "Predicate ##{index} matched (#{condition.inspect})",
-            )
-          end
-        end
-      end
+      yield(handler)
+        .tap(&method(:check_predicates))
     rescue *exceptions => e
       self.tries = tries - 1
       handler.retry_number += 1
@@ -52,12 +42,25 @@ module Respawn
 
     private
 
-    attr_accessor :exceptions, :tries, :onfail, :wait, :handler, :env, :predicate
+    attr_accessor(
+      :exceptions,
+      :tries,
+      :onfail,
+      :wait,
+      :handler,
+      :env,
+      :predicate,
+      :setup,
+      :notifier,
+    )
 
-    def default_environment
-      ENV.fetch("RUBY_ENV") do
-        ENV.fetch("RAILS_ENV") do
-          "production"
+    def check_predicates(result)
+      Array(predicate).each.with_index do |condition, index|
+        if condition.call(result)
+          raise(
+            PredicateError,
+            "Predicate ##{index} matched (#{condition.inspect})",
+          )
         end
       end
     end
@@ -65,7 +68,7 @@ module Respawn
     def perform_fail(exception)
       case onfail
       in :notify
-        Respawn.default_setup.notifier.call(exception)
+        notifier.call(exception)
       in :nothing
         nil
       in :raise
@@ -76,16 +79,11 @@ module Respawn
     end
 
     def parse_exceptions(list)
-      list.flat_map do |exception|
-        if exception == :network_errors
-          Respawn.default_setup.cause
-
+      list.each do |exception|
         # This comparision will raise an error if the exception is not
         # a class, which is what we want.
 
-        elsif exception <= Exception
-          exception
-        end
+        raise Error, "Invalid exception passsed" unless exception <= Exception
       end
     end
   end

data/lib/respawn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Respawn
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/respawn.rb

@@ -2,10 +2,6 @@
 
 require "zeitwerk"
 
-loader = Zeitwerk::Loader.for_gem
-loader.setup
-loader.eager_load
-
 module Respawn
   class Error < StandardError; end
   class PredicateError < StandardError; end
@@ -13,17 +9,8 @@ module Respawn
   def self.try(...)
     Try.call(...)
   end
-
-  # Postpone the actuall setup until the first use of the method, to make
-  # sure that all the dependencies are loaded and all constants are already
-  # available.
-
-  def self.default_setup
-    @_default_setup ||=
-      Setup.new(
-        notifier: NotifierDetector.call,
-        cause: ExceptionDetector.call,
-        predicate: [],
-      )
-  end
 end
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+loader.eager_load

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: respawn
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Mariusz Drozdziel
@@ -58,6 +58,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/respawn.rb
+- lib/respawn/array_try.rb
+- lib/respawn/enum.rb
+- lib/respawn/environment.rb
 - lib/respawn/exception_detector.rb
 - lib/respawn/handler.rb
 - lib/respawn/notifier_detector.rb