ruby-limiter 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2f455d4d68023ae8d22bffc74ea4b6ad7abff350d6eb907e64c8e7db7c46caf
-  data.tar.gz: 18b08614e86f69ae5f3d1cb8209b2f9a3c70364567366fd27464d3a27cad37ee
+  metadata.gz: 3fa5f9a22fef901283796de71c5f8f9f2e3c15a0ec53437df63a8fd68ab6d68d
+  data.tar.gz: 0fb719626ac5314d31d195d0f5058bdb9830355a25648fcb45bed3317e6c2c39
 SHA512:
-  metadata.gz: 6a2e10e3516975acd55786d335431a51f85946000d35fcc4c7bc18b22dcd59d9d651d09f8c4b0af597452b8a737e797cff7d1ca141e6d8ebbc0e2e5f05b96466
-  data.tar.gz: '08c8276f451020a58782ac27d030be523cab952a22db219c01ee1fde303a2d3df1eb7a76a6013a5418d0986a41bfc24794a5fb2a31c1cff9e90bc4c416227b00'
+  metadata.gz: da3c41e851f8d076dbbae9cfdc6679c9c439091f83b84a15488c1a62d77e0f683a337acfb31b5dad4bc458cbe967d1929a1a50c3b7cd177ccdb1b12b80281335
+  data.tar.gz: 867e83f64c51472488d584b7eb751b2c8b9836ff8b771f29718d0a55023b95166dde55fe08de217f456030059e279551340c870eceb4ffef0cd5b5f033e7e2f8

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+registries:
+  github-com:
+    type: git
+    url: https://github.com
+    username: ${{secrets.DEPENDENCIES_GITHUB_USER}}
+    password: ${{secrets.DEPENDENCIES_GITHUB_TOKEN}}
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 100
+    insecure-external-code-execution: allow
+    registries: "*"

data/.github/workflows/ci.yml

@@ -30,7 +30,6 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.2
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Rubocop run
       run: |
@@ -48,7 +47,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2']
+        ruby-version: ['3.2', '3.3', '3.4']
 
     steps:
     - uses: actions/checkout@v3

data/.github/workflows/cla.yml

@@ -0,0 +1,23 @@
+# .github/workflows/cla.yml
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      )
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    if: github.repository == 'Shopify/limiter'
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    environment: release
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@e81a8fa391b11a595c1b7ed84177cc0fe02faf83 # v1.328.0
+        with:
+          bundler-cache: true
+
+      - name: Release gem on RubyGems.org
+        uses: rubygems/release-gem@7f9650160c1a4e7989fdc9855807bdbd421d8b6b # v1.4.1

data/.gitignore

@@ -7,4 +7,3 @@
 /spec/reports/
 /tmp/
 .rubocop-https*
-Gemfile.lock

data/.rubocop.yml

@@ -7,7 +7,6 @@ require:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.2
 
 Naming/FileName:
   Exclude:

data/.ruby-version

@@ -0,0 +1 @@
+3.4.4

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v2.3.1
+
+- balanced mode now keeps calls `interval / size` apart after the queue has been idle; previously an idle interval let `size` calls through at once and the queue kept bursting until reset (#61)
+- balanced ring is built from a single clock read (#62)
+
 ## v2.3.0
 
 - add support for resetting RateQueue

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    ruby-limiter (2.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    code-scanning-rubocop (0.6.1)
+      rubocop (~> 1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.25.5)
+    minitest-focus (1.4.0)
+      minitest (>= 4, < 6)
+    mocha (2.1.0)
+      ruby2_keywords (>= 0.0.5)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-minitest (0.33.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-shopify (2.15.1)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  bundler
+  code-scanning-rubocop (~> 0.6.1)
+  minitest (~> 5.20)
+  minitest-focus (~> 1.4)
+  mocha (~> 2.1)
+  rake (~> 13.0)
+  rubocop (~> 1.57)
+  rubocop-minitest (~> 0.33.0)
+  rubocop-rake (~> 0.6.0)
+  rubocop-shopify (~> 2.14)
+  ruby-limiter!
+
+BUNDLED WITH
+   2.6.9

data/README.md

@@ -57,8 +57,8 @@ end
 
 #### Load balancing
 
-By default all calls to the `limit_method` will be bursted, e.g. as quick as possible, until the rate is exceeded.
-Then we wait for the remainder of the interval to continue. To even out the burst, an optional `balanced` parameter can be
+By default all calls to the `limit_method` will be bursted, e.g. as quick as possible, until the rate is exceeded. Then
+we wait for the remainder of the interval to continue. To even out the burst, an optional `balanced` parameter can be
 provided to enable interleaving between the method calls, e.g: `interleave = interval / size`.
 
 ``` ruby
@@ -79,7 +79,8 @@ For example: with an interval of 60 seconds and a rate of 60:
 
 There are times when it may be necessary to reset the rate limiter for a method, for example during testing.
 
-This can be done by calling `reset_method_limit!` on the class, where "method" is replaced with the name of the method being limited.
+This can be done by calling `reset_method_limit!` on the class, where "method" is replaced with the name of the method
+being limited.
 
 Given the example above, the following would reset the rate limit for the `tick` method during test setup:
 
@@ -96,8 +97,8 @@ end
 ### Advanced Usage
 
 In cases where the mixin is not appropriate the `RateQueue` class can be used directly. As in the mixin examples above,
-the `interval` parameter is optional (and defaults to 1 minute). It is also possible
-to provide the block to `RateQueue`, which will be executed on each limit hit (useful for metrics).
+the `interval` parameter is optional (and defaults to 1 minute). It is also possible to provide the block to
+`RateQueue`, which will be executed on each limit hit (useful for metrics).
 
 ``` ruby
 class Widget
@@ -118,7 +119,8 @@ end
 
 #### Resetting a RateQueue
 
-In some circumstances it may be desirable to reset a rate queue, for example after invoking an API that resets an external rate limit.
+In some circumstances it may be desirable to reset a rate queue, for example after invoking an API that resets an
+external rate limit.
 
 This can be done by calling `reset` on the queue.
 
@@ -130,9 +132,12 @@ This can be done by calling `reset` on the queue.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/dev.yml

@@ -3,7 +3,7 @@
 name: limiter
 
 up:
-  - ruby: 3.2.2
+  - ruby
   - bundler
 
 commands:

data/lib/limiter/rate_queue.rb

@@ -20,6 +20,7 @@ module Limiter
       @mutex.synchronize do
         @ring = @balanced ? balanced_ring : unbalanced_ring
         @head = 0
+        @last = nil
       end
     end
 
@@ -29,9 +30,9 @@ module Limiter
       @mutex.synchronize do
         time = @ring[@head]
 
-        sleep_until(time + @interval)
+        sleep_until(next_time(time))
 
-        @ring[@head] = clock.time
+        @last = @ring[@head] = clock.time
         @head = (@head + 1) % @size
       end
 
@@ -40,6 +41,13 @@ module Limiter
 
     private
 
+    def next_time(time)
+      deadline = time + @interval
+      return deadline unless @balanced && @last
+
+      [deadline, @last + gap].max
+    end
+
     def sleep_until(time)
       interval = time - clock.time
       return unless interval.positive?
@@ -57,7 +65,10 @@ module Limiter
     end
 
     def balanced_ring
-      (0...@size).map { |i| base_time + (gap * i) }
+      start = base_time
+      step = gap
+
+      Array.new(@size) { |i| start + (step * i) }
     end
 
     def gap

data/lib/limiter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Limiter
-  VERSION = "2.3.0"
+  VERSION = "2.3.1"
 end

data/limiter.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Simple Ruby rate limiting mechanism."
   spec.homepage      = "https://github.com/Shopify/limiter"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   if spec.respond_to?(:metadata)
     spec.metadata["allowed_push_host"] = "https://rubygems.org"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-limiter
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - S. Brent Faulkner
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,19 +149,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
-description: 
 email:
 - brent.faulkner@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
-- ".github/workflows/gem-push.yml"
+- ".github/workflows/cla.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -183,7 +185,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -191,15 +192,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Simple Ruby rate limiting mechanism.
 test_files: []

data/.github/workflows/gem-push.yml

@@ -1,31 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    tags: [ "v*" ]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.2
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        RUBYGEMS_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"