time_bandits 0.10.11 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8447b013b4ab90d594ca245cb69c3c2bbda8e8222bccddcd8780f8c1434893ad
-  data.tar.gz: a29d3e3afd51d36d464f503211551af24be3f239dacc4e5dcb8fc2752aed0939
+  metadata.gz: b13f621d06b0868cde0ad832603e9a924f4d40ad03a63ded4d98f13e6d5feccd
+  data.tar.gz: 674bfa4c6564f06ee6946d54290e38e0bfe05c2af4acced51f0aac1f8fc182ac
 SHA512:
-  metadata.gz: afa8037541dc31446f75fc89c437c8a70b785126c1162d38b865fbe94ecebf399c00eaaafa73802c88e612b0b164dc5af3e15ffd8582342f1d523bd8ecd6f92d
-  data.tar.gz: 139d9563ca52d1f45cf00f582a5c25d7778e6da98fc9dce93fbcf99b6355915fe76ef96805935081d613af747464ac4262e3228099a88c6a8226f60a39d188c4
+  metadata.gz: a86246746fc6a6465e8b4a4ac1a87001ec815b4bfaa2dae2107edc7e21dc8440a22a5a33625b5dd908ecf408d7c060bc02828b00080f4f209de8b962ad39ae0d
+  data.tar.gz: 046dab1c28efe9c237a87eb7bfc25c1867cd1632c8f2c9b27ff06191845a46f90cea496289466ce5e36e45da195238fe5e3348025b3cf511200d20479267a8d8

data/.travis.yml

@@ -1,11 +1,23 @@
+dist: bionic
 language: ruby
 rvm:
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+before_install:
+  - gem install bundler
 script: "bundle exec rake appraisal:test"
-sudo: false
 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/Appraisals

@@ -1,15 +1,7 @@
 [
-  "4.1.16",
-  "4.2.8",
-  "4.2.9",
-  "5.0.3",
-  "5.0.4",
-  "5.1.1",
-  "5.1.2",
-  "5.1.5",
-  "5.2.0",
+  "5.2.4.3",
+  "6.0.3.2"
 ].each do |rails_version|
-  next if RUBY_VERSION >= "2.4.0" && rails_version < "4.2.8"
   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,8 @@
 
 Time Bandits is a gem plugin for Rails which enhances Rails' controller/view/db benchmark logging.
 
+[![Travis](https://travis-ci.org/skaes/time_bandits.svg?branch=master)](https://travis-ci.org/github/skaes/time_bandits)
+
 ## Usage
 
 Without configuration, the standard Rails 'Completed line' will change
@@ -53,16 +55,16 @@ With these two new time consumers, the log line changes to
    b: number of bytes allocated by the ruby x_malloc call (#bytes)
    l: live data set size after last GC (#slots)
 
-Sidenote for Germans: you can use the word "Gesabbel" (eng: drivel) as a mnemonic here ;-)
+Side note for speakers of German: you can use the word "Gesabbel" (eng: drivel) as a mnemonic here ;-)
 
-It's realtively straightforward to write additional time consumers; the more difficult part of this is
+It's relatively straightforward to write additional time consumers; the more difficult part of this is
 monkey patching the code which you want to instrument. Have a look at consumers under
-lib/time_bandits/time_consumers and the corresponding patches under lib/time_bandits/monkey_patches.
+`lib/time_bandits/time_consumers` and the corresponding patches under `lib/time_bandits/monkey_patches`.
 
 
 ## Prerequisites
 
-Rails >= 3.x is required. The gem will raise an error if you try to use it with an incompatible
+ActiveSupport/Rails >= 5.2 is required. The gem will raise an error if you try to use it with an incompatible
 version.
 
 You'll need a ruby with the railsexpress GC patches applied, if you want to include GC and heap size
@@ -80,10 +82,28 @@ changed so much of the code that is is practically a full rewrite, hence we chan
 
 ## Running Tests
 
-In order for the test to run you need a running memcached, redis-server and mysql
+Run `docker-compose up` to start Redis, MySQL, RabbitMQ and Memached containers, then run `rake`.
+
 
 ## Release Notes
 
+## 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)
+
+## Version 0.11.0
+  - supports rails 6.0.0
+
+## Version 0.10.12
+  - supports rails 5.0.7
+
 ## Version 0.10.11
   - support rails 5.2.0
 
@@ -170,26 +190,4 @@ In order for the test to run you need a running memcached, redis-server and mysq
    - times are all measured in milliseconds internally
    - added class TimeBandits::TimeConsumers::BaseConsumer to simplify writing custom consumers
 
-## License
-
-Copyright (c) 2009-2014 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/Rakefile

@@ -13,6 +13,7 @@ Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
+  t.ruby_opts = %w(-W0)
 end
 
 namespace :appraisal do

data/docker-compose.yml

@@ -3,7 +3,7 @@ version: '2'
 services:
   mysql:
     container_name: mysql
-    image: mysql:5.5
+    image: mysql:5.7
     ports:
       - "3601:3306"
     environment:
@@ -11,18 +11,18 @@ services:
 
   memcached:
     container_name: memcached
-    image: memcached:1.4.27
+    image: memcached:1.6.6
     ports:
       - "11211:11211"
 
   redis:
     container_name: redis
-    image: redis:3.2.0
+    image: redis:5.0.9
     ports:
       - "6379:6379"
 
   rabbitmq:
     container_name: rabbitmq
-    image: rabbitmq:3.6.2
+    image: rabbitmq:3.8.5
     ports:
       - "5672:5672"

data/gemfiles/activesupport_5.2.4.3.gemfile

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,81 @@
+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

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,81 @@
+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

data/lib/time_bandits.rb

@@ -5,11 +5,7 @@ require 'thread_variables'
 module TimeBandits
 
   module TimeConsumers
-    if defined?(Rails) && Rails::VERSION::STRING < "3.0"
-      autoload :Database,          'time_bandits/time_consumers/database_rails2'
-    else
-      autoload :Database,          'time_bandits/time_consumers/database'
-    end
+    autoload :Database,          'time_bandits/time_consumers/database'
     autoload :GarbageCollection, 'time_bandits/time_consumers/garbage_collection'
     autoload :JMX,               'time_bandits/time_consumers/jmx'
     autoload :MemCache,          'time_bandits/time_consumers/mem_cache'
@@ -20,7 +16,7 @@ module TimeBandits
     autoload :Beetle,            'time_bandits/time_consumers/beetle'
   end
 
-  require 'time_bandits/railtie' if defined?(Rails) && Rails::VERSION::STRING >= "3.0"
+  require 'time_bandits/railtie' if defined?(Rails::Railtie)
   require 'time_bandits/time_consumers/base_consumer'
 
   mattr_accessor :time_bandits

data/lib/time_bandits/monkey_patches/action_controller.rb

@@ -4,45 +4,6 @@ module ActionController #:nodoc:
 
   module Instrumentation
 
-    # patch to ensure that the completed line is always written to the log.
-    # this is not necessary anymore with Rails 4 and higher.
-    def process_action(action, *args)
-      raw_payload = get_raw_payload
-      ActiveSupport::Notifications.instrument("start_processing.action_controller", raw_payload.dup)
-
-      exception = nil
-      result = ActiveSupport::Notifications.instrument("process_action.action_controller", raw_payload) do |payload|
-        begin
-          super
-        rescue Exception => exception
-          response.status = 500
-          nil
-        ensure
-          payload[:status] = response.status
-          append_info_to_payload(payload)
-        end
-      end
-      raise exception if exception
-      result
-    end unless Rails::VERSION::STRING >= "4.0"
-
-    # patch to ensure that render times are always recorded in the log.
-    # this is not necessary anymore with Rails 3 and up.
-    def render(*args)
-      render_output = nil
-      exception = nil
-      self.view_runtime = cleanup_view_runtime do
-        Benchmark.ms do
-          begin
-            render_output = super
-          rescue Exception => exception
-          end
-        end
-      end
-      raise exception if exception
-      render_output
-    end unless Rails::VERSION::STRING >= "3.0"
-
     def cleanup_view_runtime #:nodoc:
       consumed_before_rendering = TimeBandits.consumed
       runtime = yield
@@ -52,32 +13,6 @@ module ActionController #:nodoc:
 
     private
 
-    if Rails::VERSION::STRING =~ /\A3\.[01]/
-      def get_raw_payload
-        {
-          :controller => self.class.name,
-          :action     => self.action_name,
-          :params     => request.filtered_parameters,
-          :formats    => request.formats.map(&:to_sym),
-          :method     => request.method,
-          :path       => (request.fullpath rescue "unknown")
-        }
-      end
-    elsif Rails::VERSION::STRING =~ /\A3\.2/
-      def get_raw_payload
-        {
-          :controller => self.class.name,
-          :action     => self.action_name,
-          :params     => request.filtered_parameters,
-          :format     => request.format.try(:ref),
-          :method     => request.method,
-          :path       => (request.fullpath rescue "unknown")
-        }
-      end
-    elsif Rails::VERSION::STRING < "3"
-      raise "time_bandits ActionController monkey patch is not compatible with your Rails version"
-    end
-
     module ClassMethods
       # patch to log rendering time with more precision
       def log_process_action(payload) #:nodoc:
@@ -101,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? && Rails::VERSION::STRING >= "3.2"
-
-      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