tlopo-retry 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 77ef23b75122a02c372f335adf6277b8b17bb7ed
-  data.tar.gz: a7c1846fc1d8981a2c9e224d033936337644e67a
+SHA256:
+  metadata.gz: d1961dc0719a0297e1278860e12db653b0fe5aa716c2bd15d84980527936f336
+  data.tar.gz: 702278c529f45dc6603adc85595d26c6e78ba0063410b29fcf29cb19d06f4e98
 SHA512:
-  metadata.gz: d3789283628c94ebb4697d5e38e85f68486886cde318072298c17e69a054d87209b453679f7ca368c4dd788472e6fb60d85c0f215a83557579188161446988af
-  data.tar.gz: 85ed915f99ad0a494b9b1f7901c29f02b39f6143ae4008f0e62963601d30ae2abe0fb3819fb1f5590ce08fd3b4c830ecc4db5c5ce4cf8f89ff0a2d1c5ad8c78d
+  metadata.gz: 95dc121f19785b8b447f173181761c028506e755f7b823c38b8f40e9e0e1b37b33dd49ba5a778dc5b06f9ac3f47928191ef6a37d1c93fd75c2df5e5971c4d28c
+  data.tar.gz: e2c482b9f7fc3d6f636dcb2e1e79e5d193d833419597ff2b92b71ea6298535ba09fc507a58ea7803f136e2452df6ff4819c9aa84701d0298c7adf74c192dad11

data/.rubocop.yml

@@ -1,30 +1,46 @@
-
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.2 # Oldest version kubeclient supports
+  TargetRubyVersion: 2.6 
+  NewCops: enable
+  SuggestExtensions: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
 MethodLength:
   Enabled: false
 ClassLength:
   Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/LineLength:
-  Max: 100
 Metrics/ParameterLists:
   Max: 5
   CountKeywordArgs: false
 Metrics/CyclomaticComplexity:
-  Max: 8
-  Exclude: 
-    - lib/tlopo/retry.rb
+  Max: 15
+Metrics/PerceivedComplexity:
+  Max: 15
 Metrics/ModuleLength:
   Enabled: false
-Style/MethodCallWithArgsParentheses:
-  Enabled: true
-  IgnoredMethods: [require, raise, include, attr_reader, refute, assert]
-  Exclude: [Gemfile, Rakefile, kubeclient.gemspec]
-Security/MarshalLoad:
-  Exclude: 
-    - test/**/*
-    - lib/tlopo/retry.rb
-
+Metrics/AbcSize:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/LineLength:
+  Max: 120
+Lint/OrAssignmentToConstant:
+  Enabled: false
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+Gemspec/RequireMFA:
+  Enabled: false

data/Gemfile

@@ -1,15 +1,12 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in tlopo-retry.gemspec
+# Specify your gem's dependencies in tlopo-cmd.gemspec
 gemspec
 
-group :test do
-  gem 'coveralls', '~> 0.8.17'
-  gem 'simplecov', '~> 0.12.0'
-end
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
 
-if RUBY_VERSION > '2.1.0'
-  group :perf do
-    gem 'memory_profiler', '~> 0.9.8'
-  end
-end
+gem 'rubocop', '~> 1.21'

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'

data/lib/tlopo/retry/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Tlopo
-  module Retry
-    VERSION = '0.1.1'.freeze
+  class Retry
+    VERSION = '0.2.0'
   end
 end

data/lib/tlopo/retry.rb

@@ -1,81 +1,50 @@
+# frozen_string_literal: true
+
 require 'tlopo/retry/version'
 require 'logger'
 require 'timeout'
 
 # Simple module so we have a namespace
 module Tlopo
-  LOGGER ||= proc do
-    logger = Logger.new(ENV['TLOPO_LOG_LEVEL'] ? STDERR : '/dev/null')
-    logger.level = ENV['TLOPO_LOG_LEVEL'] ? ENV['TLOPO_LOG_LEVEL'].upcase.to_s : Logger::ERROR
-    logger
-  end.call
-
-  # A reusable retry mechanism which supports timeout, cleanup and fork
-  module Retry
-    LOGGER = Tlopo::LOGGER
-    LOGGER.debug("#{self} loaded")
-    VALID_OPTS = %i[tries timeout interval fork cleanup].freeze
-
-    def self.validate_opts(opts)
-      opts.each_key do |k|
-        msg = "Option #{k} is invalid. Valid options: #{VALID_OPTS}"
-        raise msg unless VALID_OPTS.include?(k)
+  LOGGER ||= Logger.new $stderr
+
+  module Setters
+    def make_setter(*names)
+      names.each do |name|
+        define_method(name) do |val|
+          instance_variable_set("@#{name}", val)
+          self
+        end
       end
     end
+  end
 
-    def self.retry(opts = {}, &block)
-      validate_opts(opts)
-      is_fork = opts[:fork]
-      return local(opts, &block) unless is_fork
-      return child(opts, &block) if is_fork
+  class Retry
+    extend Setters
+    make_setter :tries, :interval, :exponential_backoff, :error_types
+    def initialize(**args)
+      @tries = args[:tries] || 3
+      @interval = args[:interval] || 1
+      @exponential_backoff = args[:exponential_backoff] || false
+      @error_types = args[:error_types] || [StandardError]
     end
 
-    def self.child(opts = {}, &block)
-      read, write = IO.pipe
+    def run(&block)
+      count = 1
+      while count <= @tries
+        next unless block_given?
 
-      pid = fork do
-        read.close
         begin
-          result = local(opts, &block)
-          Marshal.dump({ result: result, error: nil }, write)
-        rescue StandardError => e
-          Marshal.dump({ result: nil, error: e }, write)
+          return instance_eval(&block)
+        rescue *@error_types => e
+          count += 1
+          time = @exponential_backoff ? @interval**count : @interval
+          sleep time
+          e
         end
       end
-
-      write.close
-      result = Marshal.load(read.read)
-      Process.wait(pid)
-      raise result[:error] if result[:error]
-      result[:result]
-    end
-
-    def self.local(opts = {})
-      tries = get_opt_value(opts, :tries, 3)
-      timeout = get_opt_value(opts, :timeout, 0)
-      interval = get_opt_value(opts, :interval, 1)
-      desc = opts[:desc]
-      cleanup = opts[:cleanup]
-      LOGGER.debug("opts: #{opts}")
-      LOGGER.debug("tries: #{tries}")
-      count = 0
-      begin
-        count += 1
-        Timeout.timeout(timeout) { yield }
-      rescue StandardError => e
-        raise e if count > tries
-        msg = "#{self} Retrying to #{desc} #{count} out of #{tries}"
-        LOGGER.info(msg) if desc
-        LOGGER.debug("#{self} Calling cleanup") if cleanup
-        cleanup.call if cleanup
-        sleep(interval)
-        retry
-      end
-    end
-
-    def self.get_opt_value(opts, key, default)
-      return opts[key] unless opts[key].nil?
-      default
+      LOGGER.error e
+      raise "Retries exhausted, error: #{e.message}"
     end
   end
 end

data/tlopo-retry.gemspec

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tlopo/retry/version'
 
@@ -15,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/tlopo-ruby/tlopo-retry'
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -22,7 +24,7 @@ Gem::Specification.new do |spec|
     # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -32,8 +34,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency('bundler', '~> 1.13')
+  spec.add_development_dependency('bundler', '~> 2.4')
   spec.add_development_dependency('minitest', '~> 5.0')
-  spec.add_development_dependency('rake', '~> 10.0')
-  spec.add_development_dependency('rubocop', '~> 0.52.1')
+  spec.add_development_dependency('rake', '~> 13.1')
+  spec.add_development_dependency('rubocop', '~> 1.6')
+  spec.add_development_dependency('simplecov', '~> 0.2')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tlopo-retry
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - tlopo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-10 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: A reusable retry mechanism which supports timeout, cleanup, and fork
 email:
 - tiagolopo@yahoo.com.br
@@ -88,7 +102,7 @@ homepage: https://github.com/tlopo-ruby/tlopo-retry
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,16 +110,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A reusable retry mechanism which supports timeout, cleanup, and fork
 test_files: []