slow_down 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0c7264bef730a08dfe8c85d3b11190db7887ae2ec49cd15d3779fc7ada04b73
-  data.tar.gz: b5a99d310faf2cc9e54d739c2af4a52d126ce346e0e7ec3219f19a9e357ba4a3
+  metadata.gz: ef031b47cde11badd5fac8ef0ad545783e0a19610cf6dfbad21d1c0f8e7a6041
+  data.tar.gz: c00f3956a6750c6ff18920518ee657b3f489dbd4a3b6618bf6b95ee4585b5286
 SHA512:
-  metadata.gz: ed30fae233b0c0d48b48d36b60f7fa0e639391a87915712e13ac3a54f4aca7c59abbcdda31698783467be72ddcfd5054b222aa47670bef2d559ecd0a2f304908
-  data.tar.gz: 234adb889bd5267b86f02fe913e0962f3cdeb2b8ca121f260f18a3f0401fd5f7151721dfd23c2056000a3bbb76aa81259ca5035943c6d4e24d8d4bf0b21b2bdd
+  metadata.gz: c026782c62882f375a51143c5bc5e85476a7c352770612e8ac304c02a807b60c781fe8d3eda7459d76ff47fd2359866adf1f061fa4b8ccdbfdd24414cc7a86bf
+  data.tar.gz: 8812582579e822c3c6a01d6e859682bacafd710d9f45ee0306a043a948e5e67702b7a46ccc62d1e9a45c37e8cd9bf5644ed7eb39311692880e9fd3052c62e4bd

data/.rubocop.yml

@@ -0,0 +1,168 @@
+# See https://github.com/bbatsov/rubocop/blob/master/manual/cops.md
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+  - ".git/**/*"
+  - "bin/*"
+  - "db/schema.rb"
+  - "node_modules/**/*"
+  - "vendor/**/*"
+Bundler/OrderedGems:
+  Enabled: false
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/CaseIndentation:
+  EnforcedStyle: end
+Layout/ElseAlignment:
+  Enabled: false
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Layout/LineLength:
+  Max: 120
+Lint/AmbiguousOperator:
+  Enabled: false
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: true
+Lint/SuppressedException:
+  Enabled: false
+Lint/UriEscapeUnescape:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+Style/Alias:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based # Explicitly, even if this is the default setting
+  Exclude:
+  - "**/spec/**/*.rb"
+  - "**/test/**/*.rb"
+Style/ClassAndModuleChildren:
+  Exclude:
+  - "**/spec/**/*.rb"
+  - "**/test/**/*.rb"
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/EmptyCaseCondition:
+  Enabled: false
+Style/FormatStringToken:
+  EnforcedStyle: template
+Style/IfUnlessModifier:
+  Enabled: false
+Style/ImplicitRuntimeError:
+  Enabled: true
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  Exclude:
+  - "**/config/routes.rb"
+  - "**/config/routes/*.rb"
+  - "**/factories/**/*_factory.rb"
+  - "**/**/Gemfile"
+  - "**/**/Rakefile"
+  - "**/migrate/*"
+  - "*.gemspec"
+  - config.ru
+  IgnoreMacros: true
+  IgnoredMethods:
+  - alias
+  - alias_method
+  - and
+  - And
+  - attr_accessor
+  - attr_reader
+  - attr_writer
+  - attribute
+  - attributes
+  - context
+  - desc
+  - describe
+  - example
+  - fail
+  - feature
+  - Given
+  - halt
+  - include
+  - include_context
+  - include_examples
+  - it
+  - it_behaves_like
+  - it_should_behave_like
+  - not_to
+  - or
+  - puts
+  - raise
+  - redirect_back
+  - redirect_to
+  - render
+  - require
+  - require_relative
+  - shared_examples
+  - shared_context
+  - should
+  - should_not
+  - specify
+  - task
+  - Then
+  - throw
+  - to
+  - to_not
+  - use
+  - visit
+  - When
+  - xit
+Style/MutableConstant:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: "()"
+    "%i": "()"
+    "%I": "()"
+    "%r": "{}"
+    "%w": "()"
+    "%W": "()"
+Style/RedundantException:
+  Enabled: false
+Style/RegexpLiteral:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/SymbolArray:
+  Enabled: false
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -1,20 +1,16 @@
 language: ruby
 rvm:
+  - 2.7
+  - 2.6
   - 2.5
-  - 2.3
-  - jruby-head
+  - 2.4
 services:
   - redis-server
 branches:
   only:
     - master
-    - develop
 env:
   global:
     - REDIS_URL="redis://127.0.0.1:6379/0"
-    - JRUBY_OPTS="$JRUBY_OPTS -Xcext.enabled=false -Xcompile.invokedynamic=false"
-matrix:
-  allow_failures:
-    - rvm: jruby-head
 notifications:
   email: false

data/Gemfile

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

data/README.md

@@ -1,7 +1,7 @@
 # SlowDown
 
 [![Gem Version](https://badge.fury.io/rb/slow_down.svg)](http://badge.fury.io/rb/slow_down)
-[![Build Status](https://travis-ci.org/lipanski/slow-down.svg?branch=master)](https://travis-ci.org/lipanski/slow-down)
+[![Build Status](https://travis-ci.com/lipanski/slow-down.svg?branch=master)](https://travis-ci.com/lipanski/slow-down)
 
 ## Why would you want to slow down your requests?!
 
@@ -13,6 +13,16 @@ It relies on a Redis lock so it should be able to handle a cluster of servers al
 It's based on the `PX` and `NX` options of the Redis `SET` command, which should make it thread-safe.
 Note that these options were introduced with Redis version 2.6.12.
 
+## Installation
+
+Add it to your *Gemfile*:
+
+```ruby
+gem "slow_down"
+```
+
+...and call `bundle install`.
+
 ## Usage
 
 ### Basic
@@ -196,9 +206,11 @@ These polling strategies are just a proof of concept and their behaviour relies
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+Run tests:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
+bundle exec rake
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,9 +1,17 @@
+# frozen_string_literal: true
+
 require "rake"
 require "rake/testtask"
 require "bundler/gem_tasks"
 
+task(default: ["rubocop", "test"])
+
+desc "Run rubocop checks"
+task :rubocop do
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+end
+
 Rake::TestTask.new do |t|
   t.test_files = Dir.glob("test/**/test_*.rb")
 end
-
-task(default: :test)

data/lib/slow_down.rb

@@ -1,4 +1,5 @@
-require "slow_down/version"
+# frozen_string_literal: true
+
 require "slow_down/group"
 
 module SlowDown
@@ -28,9 +29,8 @@ module SlowDown
   end
 
   def reset(group_name = :default)
-    if group = Group.find(group_name)
-      group.reset
-    end
+    group = Group.find(group_name) || return
+    group.reset
   end
 
   def find_or_create_group(*args)

data/lib/slow_down/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "logger"
 require "redis"
 require "slow_down/strategy/linear"
@@ -19,7 +21,7 @@ module SlowDown
       redis_namespace: :slow_down,
       lock_namespace: :default,
       concurrency: nil,
-      log_path: STDOUT,
+      log_path: $stdout,
       log_level: Logger::UNKNOWN
     }
 
@@ -88,7 +90,7 @@ module SlowDown
           end
 
         unless klass.is_a?(Class) && klass < Strategy::Base
-          fail ConfigError, ":retry_strategy should be a class inheriting SlowDown::Strategy::Base"
+          raise ConfigError, ":retry_strategy should be a class inheriting SlowDown::Strategy::Base"
         end
 
         klass.new(retries, timeout).normalized_series

data/lib/slow_down/group.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require "slow_down/configuration"
 
 module SlowDown
   class Group
     def self.all
-      @groups || {}
+      @groups ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
     end
 
     def self.find(name)
@@ -18,15 +20,14 @@ module SlowDown
     def self.find_or_create(name, options = {})
       if all[name] && !options.empty?
         all[name].config.logger.error(name) { "Group #{name} has already been configured elsewhere" }
-        fail ConfigError, "Group #{name} has already been configured elsewhere - you may not override configurations"
+        raise ConfigError, "Group #{name} has already been configured elsewhere - you may not override configurations"
       end
 
       all[name] || create(name, options)
     end
 
     def self.remove(group_name)
-      return unless group = Group.find(group_name)
-
+      group = Group.find(group_name) || return
       group.reset
       @groups.delete(group_name)
     end
@@ -43,16 +44,19 @@ module SlowDown
     end
 
     def run
-      expires_at, iteration = Time.now + config.timeout, 0
+      expires_at = Time.now + config.timeout
+      iteration = 0
       config.logger.info(name) { "Run attempt initiatied, times out at #{expires_at}" }
 
-      begin
+      loop do
         return yield if free?
+
         wait(iteration += 1)
-      end until Time.now > expires_at
+        break if Time.now > expires_at
+      end
 
       config.logger.info(name) { "Run attempt timed out" }
-      if config.raise_on_timeout
+      if config.raise_on_timeout # rubocop:disable Style/GuardClause
         config.logger.error(name) { "Timeout error raised" }
         raise Timeout
       end

data/lib/slow_down/strategy/base.rb

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 module SlowDown
   module Strategy
     class Base
       attr_reader :n, :max
 
-      def initialize(n, max)
-        @n, @max = n, max
+      def initialize(n, max) # rubocop:disable Naming/MethodParameterName
+        @n = n
+        @max = max
       end
 
       def series
-        fail NotImplemented
+        raise NotImplemented
       end
 
       def normalized_series

data/lib/slow_down/strategy/fibonacci.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "slow_down/strategy/base"
 
 module SlowDown

data/lib/slow_down/strategy/inverse_exponential.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "slow_down/strategy/base"
 
 module SlowDown
@@ -5,7 +7,7 @@ module SlowDown
     class InverseExponential < Base
       def series
         n.times.map do |i|
-          1 - Math::E ** (i + 1)
+          1 - Math::E**(i + 1)
         end
       end
     end

data/lib/slow_down/strategy/linear.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "slow_down/strategy/base"
 
 module SlowDown

data/slow_down.gemspec

@@ -1,31 +1,31 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "slow_down/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "slow_down"
-  spec.version       = SlowDown::VERSION
+  spec.version       = "1.0.0"
   spec.authors       = ["Florin Lipan"]
   spec.email         = ["florinlipan@gmail.com"]
 
-  spec.summary       = %q{A centralized Redis-based lock to help you wait on throttled resources}
-  spec.description   = %q{A centralized Redis-based lock to help you wait on throttled resources}
+  spec.summary       = "A centralized Redis-based lock to help you wait on throttled resources"
+  spec.description   = "A centralized Redis-based lock to help you wait on throttled resources"
   spec.homepage      = "https://github.com/lipanski/slow-down"
   spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "redis"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "m"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "minitest-stub-const"
-  spec.add_development_dependency "m"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slow_down
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Florin Lipan
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2020-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: m
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -131,13 +145,12 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/slow_down.rb
 - lib/slow_down/configuration.rb
 - lib/slow_down/group.rb
@@ -145,7 +158,6 @@ files:
 - lib/slow_down/strategy/fibonacci.rb
 - lib/slow_down/strategy/inverse_exponential.rb
 - lib/slow_down/strategy/linear.rb
-- lib/slow_down/version.rb
 - slow_down.gemspec
 homepage: https://github.com/lipanski/slow-down
 licenses:
@@ -159,15 +171,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A centralized Redis-based lock to help you wait on throttled resources

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "slow_down"
-
-# 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,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/slow_down/version.rb

@@ -1,3 +0,0 @@
-module SlowDown
-  VERSION = "0.3.1"
-end