tlopo-retry 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f301e35e2ab51e5baf34a2d6e94ead7f697996d
-  data.tar.gz: 8643e0a47e62da8fc53f07fb8929116e916a398d
+  metadata.gz: 77ef23b75122a02c372f335adf6277b8b17bb7ed
+  data.tar.gz: a7c1846fc1d8981a2c9e224d033936337644e67a
 SHA512:
-  metadata.gz: fd9cd0de673f05b9690eb74b2b1a4ff68c9aae24221a5149be81fe5d324e47e5cee5e2fa7ec38ebdecb516facac82361fa49a431e75d124405612f43286cf31b
-  data.tar.gz: 913da92c875082ba0e74746e26347c06e7e8b9ad2205e8879888a330961a41c8dc4d42f985f9f8bf26f444cfbb9c353f310b50d55f77cf99ef170a3380bf0391
+  metadata.gz: d3789283628c94ebb4697d5e38e85f68486886cde318072298c17e69a054d87209b453679f7ca368c4dd788472e6fb60d85c0f215a83557579188161446988af
+  data.tar.gz: 85ed915f99ad0a494b9b1f7901c29f02b39f6143ae4008f0e62963601d30ae2abe0fb3819fb1f5590ce08fd3b4c830ecc4db5c5ce4cf8f89ff0a2d1c5ad8c78d

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea/

data/.rubocop.yml

@@ -0,0 +1,30 @@
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.2 # Oldest version kubeclient supports
+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
+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
+

data/.travis.yml

@@ -1,5 +1,12 @@
-sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.13.2
+  - "2.2"
+  - "2.3.0"
+  - "2.4.0"
+sudo: false
+cache: bundler
+script: bundle exec rake $TASK
+env:
+ - TASK=test
+ - TASK=rubocop
+ - TASK=test_with_coveralls

data/Gemfile

@@ -2,3 +2,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in tlopo-retry.gemspec
 gemspec
+
+group :test do
+  gem 'coveralls', '~> 0.8.17'
+  gem 'simplecov', '~> 0.12.0'
+end
+
+if RUBY_VERSION > '2.1.0'
+  group :perf do
+    gem 'memory_profiler', '~> 0.9.8'
+  end
+end

data/README.md

@@ -1,2 +1,80 @@
 # tlopo-retry
+[![Gem Version](https://badge.fury.io/rb/tlopo-retry.svg)](http://badge.fury.io/rb/tlopo-retry)
+[![Build Status](https://travis-ci.org/tlopo-ruby/tlopo-retry.svg?branch=master)](https://travis-ci.org/tlopo-ruby/tlopo-retry)
+[![Code Climate](https://codeclimate.com/github/tlopo-ruby/tlopo-retry/badges/gpa.svg)](https://codeclimate.com/github/tlopo-ruby/tlopo-retry)
+[![Dependency Status](https://gemnasium.com/tlopo-ruby/tlopo-retry.svg)](https://gemnasium.com/tlopo-ruby/tlopo-retry)
+[![Coverage Status](https://coveralls.io/repos/github/tlopo-ruby/tlopo-retry/badge.svg?branch=master)](https://coveralls.io/github/tlopo-ruby/tlopo-retry?branch=master)
+
 A reusable retry mechanism which supports timeout, cleanup and fork
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tlopo-retry'
+```
+
+And then execute:
+
+```Bash
+bundle
+```
+
+Or install it yourself as:
+
+```Bash
+gem install tlopo-retry
+```
+
+## Usage
+
+Simple retry usage 
+
+```ruby
+# That will retry 3 times with no timeout and 1 second interval
+Tlopo::Retry.retry do 
+  TCPSocket.new('www.google.co.uk','8080').close
+end
+```
+Full options
+```ruby
+require 'logger'
+require 'socket'
+
+# Enable logging
+ENV['TLOPO_LOG_LEVEL'] = 'debug' 
+
+require 'tlopo/retry'
+
+Tlopo::Retry.retry({
+  desc: 'check if port 8080 is open on www.google.co.uk',
+  tries: 2,
+  interval: 5,
+  timeout: 1,
+  cleanup: proc { p 'Run your cleanup code here'}
+}) do 
+  TCPSocket.new('www.google.co.uk','8080').close
+end
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kubeclient/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Test your changes with `rake test rubocop`, add new tests if needed.
+4. If you added a new functionality, add it to README
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
+
+## Tests
+
+This library is tested with Minitest.
+Please run all tests before submitting a Pull Request, and add new tests for new functionality.
+
+Running tests:
+```ruby
+rake test
+```

data/Rakefile

@@ -1,10 +1,16 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'coveralls/rake/task'
+
+task default: %i[test rubocop]
+task test_with_coveralls: [:default, 'coveralls:push']
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+RuboCop::RakeTask.new
+Coveralls::RakeTask.new

data/lib/tlopo/retry.rb

@@ -1,70 +1,81 @@
-require "tlopo/retry/version"
+require 'tlopo/retry/version'
 require 'logger'
 require 'timeout'
 
+# Simple module so we have a namespace
 module Tlopo
-  LOGGER ||= proc do 
+  LOGGER ||= proc do
     logger = Logger.new(ENV['TLOPO_LOG_LEVEL'] ? STDERR : '/dev/null')
-    logger.level = ENV['TLOPO_LOG_LEVEL'] ? "#{ENV['TLOPO_LOG_LEVEL'].upcase}" :  Logger::ERROR
+    logger.level = ENV['TLOPO_LOG_LEVEL'] ? ENV['TLOPO_LOG_LEVEL'].upcase.to_s : Logger::ERROR
     logger
   end.call
-  
-end
 
-module Tlopo::Retry 
-  LOGGER = Tlopo::LOGGER
-  LOGGER.debug "#{self} loaded"
-  def self.retry(opts={},&block)
-    is_fork = opts[:fork]
-    return local(opts,&block) unless is_fork
-    return child(opts,&block) if is_fork
-  end
+  # 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
 
-  private 
-  def self.child(opts={},&block)
-    read, write = IO.pipe
-  
-    pid = fork do
-      read.close
-      begin 
-        result = local(opts,&block)
-        Marshal.dump({result: result, error: nil}, write)
-      rescue => e
-        Marshal.dump({result:nil, error: e},write)
+    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)
       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={},&block)
-    tries = opts[:tries] || 3
-    timeout = opts[:timeout] || 0
-    interval = 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 => e 
-      unless count > tries 
+    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
+    end
+
+    def self.child(opts = {}, &block)
+      read, write = IO.pipe
+
+      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)
+        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
+        LOGGER.info(msg) if desc
+        LOGGER.debug("#{self} Calling cleanup") if cleanup
         cleanup.call if cleanup
-        sleep interval
-        retry 
-      else
-        raise e
+        sleep(interval)
+        retry
       end
     end
+
+    def self.get_opt_value(opts, key, default)
+      return opts[key] unless opts[key].nil?
+      default
+    end
   end
 end
-

data/lib/tlopo/retry/version.rb

@@ -1,5 +1,5 @@
 module Tlopo
   module Retry
-    VERSION = "0.1.0"
+    VERSION = '0.1.1'.freeze
   end
 end

data/tlopo-retry.gemspec

@@ -1,38 +1,39 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tlopo/retry/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "tlopo-retry"
+  spec.name          = 'tlopo-retry'
   spec.version       = Tlopo::Retry::VERSION
-  spec.authors       = ["tlopo"]
-  spec.email         = ["tiago@aw20.co.uk"]
+  spec.authors       = ['tlopo']
+  spec.email         = ['tiagolopo@yahoo.com.br']
 
-  spec.summary       = %q{ 
+  spec.summary       = '
     A reusable retry mechanism which supports timeout, cleanup, and fork
-  }
+  '
   spec.description   = spec.summary
-  spec.homepage      = "https://github.com/tlopo-ruby/tlopo-retry"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/tlopo-ruby/tlopo-retry'
+  spec.license       = 'MIT'
 
   # 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.
   if spec.respond_to?(:metadata)
-    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+    # 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."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "bin"
+  spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency('bundler', '~> 1.13')
+  spec.add_development_dependency('minitest', '~> 5.0')
+  spec.add_development_dependency('rake', '~> 10.0')
+  spec.add_development_dependency('rubocop', '~> 0.52.1')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tlopo-retry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - tlopo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,35 +53,34 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.52.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.52.1
 description: A reusable retry mechanism which supports timeout, cleanup, and fork
 email:
-- tiago@aw20.co.uk
+- tiagolopo@yahoo.com.br
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/tlopo/retry.rb
 - lib/tlopo/retry/version.rb
 - tlopo-retry.gemspec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "tlopo/retry"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here