rails-middleware_timer 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5af4d028bef60af2702af615d8e7e5e550fe6fed
+  data.tar.gz: 6641db589fab98a770374e4e67badd3a477c720e
+SHA512:
+  metadata.gz: 928b3fd7b0352794facb6aef6369e66a3333081d85c6990ffa5481e079cd1e64655bf1059406a37e108fa512916f3bbf856916647d46306457353f46ab8a6f10
+  data.tar.gz: 7f452b990c10dbba9ec1f043aacd167378c705be0122b4a62ee4a93a1541fb1e94a3524a02d5738c879b889f7a07ef0579326457786359c6dc4a3be6b485576f

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.2.3
+env:
+  RACK_ENV: test
+script:
+  - 'bundle exec rake'
+notifications:
+  email:
+    recipients:
+      - humzashah+travis@gmail.com
+    on_success: never
+    on_failure: always

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+ruby File.read('.ruby-version')
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Syed Humza Shah
+
+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

@@ -0,0 +1,57 @@
+# MiddlewareTimer :clock1:
+
+[![Build Status](https://travis-ci.org/humzashah/rails-middleware_timer.svg?branch=master)](https://travis-ci.org/humzashah/rails-middleware_timer)
+
+A Rack middleware timer for Rails 4 and 5. Outputs results in miliseconds like so:
+
+```
+Started GET "/health" for 127.0.0.1 at 2016-12-15 23:39:19 +0000
+  ActiveRecord::SchemaMigration Load (0.4ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Processing by HealthController#show as HTML
+Completed 200 OK in 0ms (ActiveRecord: 0.0ms)
+
+Sample message for Rack::Runtime ==> 22 ms
+Sample message for ActionDispatch::Executor ==> 21 ms
+Sample message for ActionDispatch::Static ==> 70 ms
+Sample message for Rack::Sendfile ==> 70 ms
+```
+
+## Installation
+
+Put the following in your Gemfile:
+
+```ruby
+gem 'rails-middleware_timer',
+    git: 'git://github.com/humzashah/rails-middleware_timer.git'
+```
+
+and `bundle install`.
+
+Then add the following to your `environment.rb` file:
+
+```ruby
+# config/environment.rb
+
+# after: Rails.application.initialize!
+Rails::MiddlewareTimer.time!
+```
+
+You can use a custom message format / method like so:
+
+```ruby
+# config/initializers/rails-middleware_timer.rb
+
+require 'rails/middleware_timer'
+
+module Rails
+  module MiddlewareTimer
+    module Timer
+      module_function
+
+      def custom_output(class_name, time_taken)
+        puts "Sample message for #{class_name} ==> #{time_taken}"
+      end
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end
+
+task default: :test

data/lib/rails/middleware_timer.rb

@@ -0,0 +1,18 @@
+require 'rails'
+require_relative 'middleware_timer/version'
+require_relative 'middleware_timer/timer'
+
+module ::Rails
+  module MiddlewareTimer
+    module_function
+
+    def time!
+      ::Rails.configuration.middleware.middlewares.each do |klass|
+        klass = klass.name.constantize
+        if klass.respond_to?(:prepend)
+          klass.prepend(Rails::MiddlewareTimer::Timer)
+        end
+      end
+    end
+  end
+end

data/lib/rails/middleware_timer/timer.rb

@@ -0,0 +1,25 @@
+module Rails
+  module MiddlewareTimer
+    module Timer
+      def call(env)
+        start_time = Time.now
+        response = super(env)
+        end_time = Time.now
+        time_taken = (1_000 * (end_time - start_time)).round
+        class_name = self.class.name
+        Rails::MiddlewareTimer::Timer.output(class_name, time_taken)
+        response
+      end
+
+      module_function
+
+      def output(class_name, time_taken)
+        if respond_to?(:custom_output)
+          custom_output(class_name, time_taken)
+        else
+          puts "#{class_name}#call took #{time_taken} ms"
+        end
+      end
+    end
+  end
+end

data/lib/rails/middleware_timer/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module MiddlewareTimer
+    VERSION = '0.1'
+  end
+end

data/middleware_timer.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/rails/middleware_timer/version'
+
+Gem::Specification.new do |s|
+  s.name = 'rails-middleware_timer'
+  s.version = Rails::MiddlewareTimer::VERSION
+  s.date = '2016-12-15'
+  s.summary = 'Simple Rails middleware benchmarking'
+  s.description = "Time the 'call' method of the middleware classes used by Rails."
+  s.authors = ['Syed Humza Shah']
+  s.email = 'humzashah+github@gmail.com'
+  s.homepage = 'https://github.com/humzashah/rails-middleware_timer'
+  s.license = 'MIT'
+
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.2'
+
+  s.add_runtime_dependency 'rails', '>= 4.0'
+  s.add_development_dependency 'bundler', '>= 1.8'
+  s.add_development_dependency 'rake', '>= 12.0'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rails-middleware_timer
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Syed Humza Shah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Time the 'call' method of the middleware classes used by Rails.
+email: humzashah+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/rails/middleware_timer.rb
+- lib/rails/middleware_timer/timer.rb
+- lib/rails/middleware_timer/version.rb
+- middleware_timer.gemspec
+homepage: https://github.com/humzashah/rails-middleware_timer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Simple Rails middleware benchmarking
+test_files: []