time_bandits 0.12.0 → 0.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ac35c38f3393a0ff15bd629eaa862ab6f80b8c23dd199bd7ab0a21081ed7adc
-  data.tar.gz: 640caa883d9975cd47a662c0995b97fba05de0795e374ab4719f4c50cc3e773a
+  metadata.gz: 9824d9fcd5eef40eebbf628d042f34604f310e563570c62e488bb8084533f24a
+  data.tar.gz: c7bc40bcbce473400e9216268bf2abc10f7c1d6fbfc0ac90305bfaba444e8706
 SHA512:
-  metadata.gz: 14059e1e2903f23e6b61340688a1d6942a00c062d6088bb23c1f04b89e355860aa34b66d5e4a7926986e4f947e37a8bad72cf9ff0f149d9f86d8a68fa9fd05fd
-  data.tar.gz: cad90ceabc0220576aae6c8ffe83a3ec2c06f346e980e0c20d962267090dac1b03e36fcc8517e757104d9baf849b5cedc9bab5c7ffbabab2a064ffc7775eabc3
+  metadata.gz: 3d78ca08b9d112fd2e4365b7df522badce8e57965d469dac2cf65c5ea51753078021729e066d798781e040140e306af4f274fed6da4b9246a7866c44bff6fb92
+  data.tar.gz: 1ac34b522398bdf6419a53e28fd068e434cc538c669160cc423a8a9590443724e1d7acfe4ecb40fe50f2268c1c30f8882e137e5907c6e66ac960e64d8023ae97

data/.github/workflows/run-tests.yml

@@ -0,0 +1,46 @@
+name: build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [3.0.3, 2.7.5, 2.6.9]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Start containers
+        run: docker-compose -f docker-compose.yml up -d
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: sudo apt-get install libsasl2-dev
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake test
+
+      - name: Install appraisals
+        run: bundle exec appraisal install
+
+      - name: Run appraisals
+        run: bundle exec appraisal rake test
+
+      - name: Stop containers
+        if: always()
+        run: docker-compose -f "docker-compose.yml" down

data/.gitignore

@@ -6,3 +6,4 @@ pkg/*
 .DS_Store
 .rvmrc
 dump.rdb
+gemfiles/*

data/Appraisals

@@ -1,7 +1,12 @@
-[
-  "5.2.4.3",
-  "6.0.3.2"
-].each do |rails_version|
+appraisals = [
+  "6.0.4.4",
+  "6.1.4.4",
+]
+
+appraisals.insert(0, "5.2.6") if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0.0")
+appraisals << "7.0.0" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7.0")
+
+appraisals.each do |rails_version|
   appraise "activesupport-#{rails_version}" do
     gem "activesupport", rails_version
     gem "activerecord", rails_version

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2020 Stefan Kaes <skaes@railsexpress.de>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -4,6 +4,9 @@
 
 Time Bandits is a gem plugin for Rails which enhances Rails' controller/view/db benchmark logging.
 
+![Build](https://github.com/skaes/time_bandits/actions/workflows/run-tests.yml/badge.svg)
+
+
 ## Usage
 
 Without configuration, the standard Rails 'Completed line' will change
@@ -85,6 +88,16 @@ Run `docker-compose up` to start Redis, MySQL, RabbitMQ and Memached containers,
 
 ## Release Notes
 
+## Version 0.12.3
+  -  suppress Ruby 2.7 warnings about keyword parameters in controller tests
+
+## Version 0.12.2
+  -  fixed that completed line was logged twice in Rails test environment
+
+## Version 0.12.1
+  - support having the rails gem in a bundle without activating the time bandits railtie
+  - automatically install the garbage collection time bandit in rails applications
+
 ## Version 0.12.0
   - drops support for Rails versions before 5.2.0 and Ruby versions before 2.2.0
   - makes it possible to use individual time bandits without Rails (e.g. in a Sinatra app)
@@ -181,26 +194,4 @@ Run `docker-compose up` to start Redis, MySQL, RabbitMQ and Memached containers,
    - times are all measured in milliseconds internally
    - added class TimeBandits::TimeConsumers::BaseConsumer to simplify writing custom consumers
 
-## License
-
-Copyright (c) 2009-2020 Stefan Kaes <skaes@railsexpress.de>
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 

data/docker-compose.yml

@@ -11,18 +11,18 @@ services:
 
   memcached:
     container_name: memcached
-    image: memcached:1.6.6
+    image: memcached:1.6.8
     ports:
       - "11211:11211"
 
   redis:
     container_name: redis
-    image: redis:5.0.9
+    image: redis:5.0
     ports:
       - "6379:6379"
 
   rabbitmq:
     container_name: rabbitmq
-    image: rabbitmq:3.8.5
+    image: rabbitmq:3.8
     ports:
       - "5672:5672"

data/lib/time_bandits/monkey_patches/action_controller.rb

@@ -36,20 +36,6 @@ module ActionController #:nodoc:
         :time_bandits_completed_info,
         [ event.duration, additions, payload[:view_runtime], "#{payload[:controller]}##{payload[:action]}" ]
       )
-
-      # this is an ugly hack to ensure completed lines show up in the test logs
-      # TODO: move this code to some other place
-      return unless Rails.env.test?
-
-      status = payload[:status]
-      if status.nil? && payload[:exception].present?
-        exception_class_name = payload[:exception].first
-        status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
-      end
-      message = "Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % event.duration
-      message << " (#{additions.join(" | ")})" unless additions.blank?
-
-      info(message)
     end
   end
 

data/lib/time_bandits/railtie.rb

@@ -7,7 +7,8 @@ module TimeBandits
   class Railtie < Rails::Railtie
 
     initializer "time_bandits" do |app|
-      app.config.middleware.swap(Rails::Rack::Logger, TimeBandits::Rack::Logger)
+      app.config.middleware.insert_after(Rails::Rack::Logger, TimeBandits::Rack::Logger)
+      app.config.middleware.delete(Rails::Rack::Logger)
 
       ActiveSupport.on_load(:action_controller) do
         require 'time_bandits/monkey_patches/action_controller'
@@ -25,9 +26,9 @@ module TimeBandits
           # Rails 5 fires on_load events multiple times, so we need to protect against endless recursion here
           next if ActionController::TestCase::Behavior.instance_methods.include?(:process_without_time_bandits)
           module ActionController::TestCase::Behavior
-            def process_with_time_bandits(*args)
+            def process_with_time_bandits(action, **opts)
               TimeBandits.reset
-              process_without_time_bandits(*args)
+              process_without_time_bandits(action, **opts)
             end
             alias_method :process_without_time_bandits, :process
             alias_method :process, :process_with_time_bandits
@@ -41,9 +42,11 @@ module TimeBandits
         TimeBandits.add TimeBandits::TimeConsumers::Database
       end
 
-      # reset statistics info, so that for example the time for the first request handled
-      # by the dispatcher is correct.
+      # Reset statistics info, so that for example the time for the first request handled
+      # by the dispatcher is correct. Also: install GC time bandit here, as we want it to
+      # be the last one in the log line.
       app.config.after_initialize do
+        TimeBandits.add TimeBandits::TimeConsumers::GarbageCollection.instance if GC.respond_to? :enable_stats
         TimeBandits.reset
       end
 

data/lib/time_bandits/version.rb

@@ -1,3 +1,3 @@
 module TimeBandits
-  VERSION = "0.12.0"
+  VERSION = "0.12.4"
 end

data/lib/time_bandits.rb

@@ -16,7 +16,7 @@ module TimeBandits
     autoload :Beetle,            'time_bandits/time_consumers/beetle'
   end
 
-  require 'time_bandits/railtie' if defined?(Rails)
+  require 'time_bandits/railtie' if defined?(Rails::Railtie)
   require 'time_bandits/time_consumers/base_consumer'
 
   mattr_accessor :time_bandits

data/test/unit/sequel_test.rb

@@ -32,11 +32,11 @@ class SequelTest < Test::Unit::TestCase
   end
 
   def mysql_port
-    ENV['TRAVIS'] == "true" ? 3306 : 3601
+    3601
   end
 
   def sequel
-    @sequel ||= Sequel.mysql2(host: "localhost", port: mysql_port, user: "root")
+    @sequel ||= Sequel.mysql2(host: "127.0.0.1", port: mysql_port, user: "root")
   end
 
   def metrics

data/time_bandits.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("byebug")
   s.add_development_dependency("dalli")
   s.add_development_dependency("memcached", "~> 1.8.0")
-  s.add_development_dependency("minitest", "~> 5.5")
+  s.add_development_dependency("minitest")
   s.add_development_dependency("mocha")
   s.add_development_dependency("mysql2")
   s.add_development_dependency("rake")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_bandits
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.4
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2022-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_variables
@@ -112,16 +112,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -227,18 +227,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/run-tests.yml"
 - ".gitignore"
-- ".travis.yml"
 - Appraisals
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - TODO
 - docker-compose.yml
-- gemfiles/activesupport_5.2.4.3.gemfile
-- gemfiles/activesupport_5.2.4.3.gemfile.lock
-- gemfiles/activesupport_6.0.3.2.gemfile
-- gemfiles/activesupport_6.0.3.2.gemfile.lock
 - lib/time_bandits.rb
 - lib/time_bandits/monkey_patches/action_controller.rb
 - lib/time_bandits/monkey_patches/active_record.rb
@@ -291,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Custom performance logging for Rails

data/.travis.yml

@@ -1,23 +0,0 @@
-dist: bionic
-language: ruby
-rvm:
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-before_install:
-  - gem install bundler
-script: "bundle exec rake appraisal:test"
-services:
-  - redis-server
-  - memcached
-  - rabbitmq
-  - mysql
-addons:
-  apt:
-    sources:
-      - sourceline: "deb https://packages.erlang-solutions.com/ubuntu bionic contrib"
-        key_url: "https://packages.erlang-solutions.com/ubuntu/erlang_solutions.asc"
-      - sourceline: "deb https://dl.bintray.com/rabbitmq/debian bionic main"
-        key_url: "https://dl.bintray.com/rabbitmq/Keys/rabbitmq-release-signing-key.asc"
-    packages:
-      - rabbitmq-server

data/gemfiles/activesupport_5.2.4.3.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "activesupport", "5.2.4.3"
-gem "activerecord", "5.2.4.3"
-
-gemspec path: "../"

data/gemfiles/activesupport_5.2.4.3.gemfile.lock

@@ -1,81 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    time_bandits (0.11.0)
-      activesupport (>= 5.2.4.3)
-      thread_variables
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (5.2.4.3)
-      activesupport (= 5.2.4.3)
-    activerecord (5.2.4.3)
-      activemodel (= 5.2.4.3)
-      activesupport (= 5.2.4.3)
-      arel (>= 9.0)
-    activesupport (5.2.4.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    amq-protocol (2.3.1)
-    amqp (1.8.0)
-      amq-protocol (>= 2.2.0)
-      eventmachine
-    ansi (1.5.0)
-    appraisal (2.3.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (9.0.0)
-    beetle (3.4.1)
-      activesupport (>= 2.3.4)
-      amq-protocol (= 2.3.1)
-      amqp (= 1.8.0)
-      bunny (~> 0.7.12)
-      hiredis (>= 0.4.5)
-      redis (>= 4.2.1)
-    bunny (0.7.12)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.6)
-    dalli (2.7.10)
-    eventmachine (1.2.7)
-    hiredis (0.6.3)
-    i18n (1.8.3)
-      concurrent-ruby (~> 1.0)
-    memcached (1.8.0)
-    minitest (5.14.1)
-    mocha (1.11.2)
-    mysql2 (0.5.3)
-    rake (13.0.1)
-    redis (4.2.1)
-    sequel (5.33.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    thread_variables (0.2.0)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (= 5.2.4.3)
-  activesupport (= 5.2.4.3)
-  ansi
-  appraisal
-  beetle (>= 3.4.1)
-  byebug
-  dalli
-  memcached (~> 1.8.0)
-  minitest (~> 5.5)
-  mocha
-  mysql2
-  rake
-  redis
-  sequel
-  time_bandits!
-
-BUNDLED WITH
-   2.1.4

data/gemfiles/activesupport_6.0.3.2.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "activesupport", "6.0.3.2"
-gem "activerecord", "6.0.3.2"
-
-gemspec path: "../"

data/gemfiles/activesupport_6.0.3.2.gemfile.lock

@@ -1,81 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    time_bandits (0.11.0)
-      activesupport (>= 5.2.4.3)
-      thread_variables
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    amq-protocol (2.3.1)
-    amqp (1.8.0)
-      amq-protocol (>= 2.2.0)
-      eventmachine
-    ansi (1.5.0)
-    appraisal (2.3.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    beetle (3.4.1)
-      activesupport (>= 2.3.4)
-      amq-protocol (= 2.3.1)
-      amqp (= 1.8.0)
-      bunny (~> 0.7.12)
-      hiredis (>= 0.4.5)
-      redis (>= 4.2.1)
-    bunny (0.7.12)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.6)
-    dalli (2.7.10)
-    eventmachine (1.2.7)
-    hiredis (0.6.3)
-    i18n (1.8.3)
-      concurrent-ruby (~> 1.0)
-    memcached (1.8.0)
-    minitest (5.14.1)
-    mocha (1.11.2)
-    mysql2 (0.5.3)
-    rake (13.0.1)
-    redis (4.2.1)
-    sequel (5.33.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    thread_variables (0.2.0)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (= 6.0.3.2)
-  activesupport (= 6.0.3.2)
-  ansi
-  appraisal
-  beetle (>= 3.4.1)
-  byebug
-  dalli
-  memcached (~> 1.8.0)
-  minitest (~> 5.5)
-  mocha
-  mysql2
-  rake
-  redis
-  sequel
-  time_bandits!
-
-BUNDLED WITH
-   2.1.4