pecorino 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a2879a7549a5e41367824a5abccc4fa6cf54b8d78dd1b042f97e8a7bb5f401
-  data.tar.gz: 870bac3b9a9cb8e6dfca8b738022deb25db8d8ce33b027a9f3dd2268e3000971
+  metadata.gz: df8db59f2303035498ca51c54787f664fbc000148965e3782e188e26b90fea31
+  data.tar.gz: 7e67b40c92846045b0e38c8e706622d6114e307b49a8efaaec287db144734fdf
 SHA512:
-  metadata.gz: 83f230bf892dd891ef913238c1bc403cc5d9734afaea5b66698109e8792b93197af0de10fc6a9a7716dcbc64ead32acf75c64f13e60708bcd9855e9840e5e203
-  data.tar.gz: b6d4bcbb64558f08082f2603d3c791c6b951ef993fb0090e8e2b5998edeae4346dec618e667f365f0f9042453a29b148327a78e5c789f5bea602d6aadd9d5e62
+  metadata.gz: 6906f549004f30b57bbf9c0ca9d2a36ba1183acf0aec863563786d9118d8f0a1094d0dc2b6eddcdeb7929be7af1f017df0063a5073a798c74cd2337888a4a3e0
+  data.tar.gz: d16cc4946a3205488afe0ab00cabc6f8a482e59751468513bec02fa0685ec77676db58b5bcb9d92d7d2fb7631e0a39fe823cfe2ecade824a0e241e45a37510fd

data/.github/workflows/ci.yml

@@ -1,21 +1,46 @@
 name: CI
 
 on:
-  - push
+  pull_request:
+  push:
+    branches: [ main ]
 
 env:
+  PGHOST: localhost
+  PGUSER: postgres
+  PGPASSWORD: postgres
   BUNDLE_PATH: vendor/bundle
 
 jobs:
+  lint:
+    name: "Lint"
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/Gemfile_ruby27_rails7 # Linting should always align with the minimum Ruby version
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.7
+          bundler-cache: true
+
+      - name: Lint code for consistent style
+        run: bundle exec standardrb
+
   test:
-    name: Tests
-    runs-on: ubuntu-22.04
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    name: "Tests"
+    runs-on: ubuntu-latest
     strategy:
+      fail-fast: false # We want both to run to completion
       matrix:
-        ruby:
-          - '2.7'
-          - '3.2'
+        gemfile_and_ruby:
+          - ["/gemfiles/Gemfile_ruby27_rails7", "2.7.7"]
+          - ["/gemfiles/Gemfile_ruby30_rails8", "3.2.2"]
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile_and_ruby[0] }}
     services:
       postgres:
         image: postgres
@@ -30,19 +55,17 @@ jobs:
         ports:
           - 6379:6379
     steps:
-      - name: Checkout
+      - name: Install packages
+        run: sudo apt-get update && sudo apt-get install --no-install-recommends -y curl libjemalloc2 sqlite3
+
+      - name: Checkout code
         uses: actions/checkout@v4
-      - name: Setup Ruby
+
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby }}
+          ruby-version:  ${{ matrix.gemfile_and_ruby[1] }}
           bundler-cache: true
-      - name: "Tests and Lint"
-        run: bundle exec rake
-        env:
-          PGHOST: localhost
-          PGUSER: postgres
-          PGPASSWORD: postgres
-          TESTOPTS: "--fail-fast"
-        #   MYSQL_HOST: 127.0.0.1
-        #   MYSQL_PORT: 3306
+
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -7,4 +7,5 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+gemfiles/*.lock
 .ruby-version

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.2
+
+- Set up a workable test harness for testing on both Rails 8 (Ruby 3.x) and Rails 7 (Ruby 2.x)
+
 ## 0.7.1
 
 - Release dependency constraint to permit Rails 8 (not thoroughly validated yet)

data/README.md

@@ -182,6 +182,20 @@ We recommend running the following bit of code every couple of hours (via cron o
 Pecorino.prune!
 ```
 
+## Testing your application
+
+The Pecorino buckets and blocks are stateful. If you are not running tests with a transaction rollback, the rate limiters that got hit in a test case may interfere with other test cases you are running. Normally you will not notice this (if you are using the same database as the rest of your models), but we recommend adding this section to your global test case setup:
+
+```ruby
+setup do
+  # Delete all transient records
+  ActiveRecord::Base.connection.execute("TRUNCATE TABLE pecorino_blocks")
+  ActiveRecord::Base.connection.execute("TRUNCATE TABLE pecorino_leaky_buckets")
+end
+```
+
+If you are using Redis, you may want to ensure it gets truncated/reset for every test case - or that parallel test case runners [each use a separate Redis database.](https://redis.io/docs/latest/commands/select/)
+
 ## Using cached throttles
 
 If a throttle is triggered, Pecorino sets a "block" record for that throttle key. Any request to that throttle will fail until the block is lifted. If you are getting hammered by requests which are getting throttled, it might be a good idea to install a caching layer which will respond with a "rate limit exceeded" error even before hitting your database - until the moment when the block would be lifted. You can use any [ActiveSupport::Cache::Store](https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html) to store your blocks. If you have a fast Rails cache configured, create a wrapped throttle:
@@ -216,9 +230,15 @@ ActiveRecord::Base.connection.execute("ALTER TABLE pecorino_blocks SET UNLOGGED"
 
 ## Development
 
-After checking out the repo, run `bundle`. Then, run `rake test` to run the tests.
+After checking out the repo, set the Gemfile appropriate to your Ruby version and run Rake for tests, lint etc.
+Note that it is important to use the appropriate Gemfile per Ruby version and Rails version you want to test with. Due to some dependency shenanigans it is currently not very easy to have a single Gemfile.
+
+```bash
+$ rbenv local 2.7.7 && export BUNDLE_GEMFILE=gemfiles/Gemfile_ruby27_rails7 && bundle install
+$ bundle exec rake
+```
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Then proceed to develop as normal. CI will run both the oldest supported dependencies and newest supported dependencies. 
 
 ## Contributing
 

data/Rakefile

@@ -3,6 +3,9 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 require "standard/rake"
+require "yard"
+
+YARD::Rake::YardocTask.new(:doc)
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -15,4 +18,12 @@ task :format do
   `bundle exec magic_frozen_string_literal .`
 end
 
-task default: [:test, :standard]
+task :generate_typedefs do
+  `bundle exec sord rbi/pecorino.rbi`
+end
+
+task default: [:test, :standard, :generate_typedefs]
+
+# When building the gem, generate typedefs beforehand,
+# so that they get included
+Rake::Task["build"].enhance(["generate_typedefs"])

data/gemfiles/Gemfile_ruby27_rails7

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby ">= 2.7", "< 3.0"
+
+gemspec path: ".."
+
+gem "pg"
+gem "sqlite3", "< 1.7"
+gem "activesupport", "< 8.0"
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "redis", "~> 5", "< 6"
+gem "yard"
+gem "standard"
+gem "rubocop", "< 1.65" # "`EnsureNode#body` is deprecated and will be changed"...
+gem "magic_frozen_string_literal"
+gem "sord"

data/gemfiles/Gemfile_ruby30_rails8

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby ">= 3.0"
+gemspec path: ".."
+
+gem "pg"
+gem "sqlite3"
+gem "activesupport", ">= 8"
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "redis", "~> 5", "< 6"
+gem "yard" # Not used under this Ruby version but the Rakefile includes it
+gem "standard" # Not used but the Rakefile includes it

data/lib/pecorino/adapters/base_adapter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # An adapter allows Pecorino throttles, leaky buckets and other
-# resources to interfact to a data storage backend - a database, usually.
+# resources to interface with a data storage backend - a database, usually.
 class Pecorino::Adapters::BaseAdapter
   # Returns the state of a leaky bucket. The state should be a tuple of two
   # values: the current level (Float) and whether the bucket is now at capacity (Boolean)

data/lib/pecorino/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pecorino
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

data/pecorino.gemspec

@@ -23,24 +23,11 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0")
   end
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
   spec.add_dependency "activerecord", ">= 7"
-  spec.add_development_dependency "pg"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "activesupport", ">= 7"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "standard"
-  spec.add_development_dependency "magic_frozen_string_literal"
-  spec.add_development_dependency "minitest-fail-fast"
-  spec.add_development_dependency "redis", "~> 5", "< 6"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
 end