speed_gun 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b40c0f702aa3870e1ebe8d74a1f3a9eb2a1ca466
+  data.tar.gz: 738743cbdf2c13d04392d9e994327e7d5ec8adb6
+SHA512:
+  metadata.gz: edf1b6096de4f1af119d765f674d4776b79c5646f0039dc17dc0e01cf486797a75eb7b08a6549246e897a0476aec656933f44395bda159069366ffe97a8b41b2
+  data.tar.gz: 1b6f3b24ea288632ab2d89101f1d9ee3e69b002051c8bff29a96cef42e90a4b64624643a018a4db8ae158f10986a39d0e6729a1d5b47b8473e83c668926f486a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in speed_gun.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sho Kusano
+
+MIT License
+
+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,161 @@
+# SpeedGun
+
+First, profile. Second, profile.
+
+SpeedGun is a better web app profiler on Rails and Rack apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'speed_gun'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install speed_gun
+
+## Usage
+
+### Rails
+
+You don't require settings in development.
+
+In production. You should set `enable_if` and `authorize_proc` configs.
+
+### Sinatra
+
+```ruby
+require 'speed_gun'
+
+class MyApplication < Sinatra::Base
+  use SpeedGun::Middleware
+end
+```
+
+## Profiling
+
+### Built-in Profilers
+
+SpeedGun has built-in profilers.
+
+- `SpeedGun::Profiler::ActionController`
+- `SpeedGun::Profiler::ActionView`
+- `SpeedGun::Profiler::ActiveRecord`
+- `SpeedGun::Profiler::Rack`
+
+these profilers don't need configuration.
+
+### Manual Profiling
+
+If you want take profile manually. You can use `SpeedGun.profile` method.
+
+```ruby
+SpeedGun.profile("MyProfile#method") do
+  my_profile.method()
+end
+```
+
+### Javascript Profiling
+
+SpeedGun is supporting profiling on javascript. You can use `speedGun.profile` or `speedGun.profileMethod`.
+
+```javascript
+speedGun.profile("any title", function() { ... codes ...});
+
+var object = { func: function() { ... codes ... } };
+speedGun.profileMethod(object, "func", "any title");
+```
+
+And SpeedGun collect browser informations.
+
+- User Agent
+- Perfomance API(if implemented)
+
+### Custom Profiler
+
+You can create your custom profilers. a custom profiler require `title` method.
+
+Some examples:
+
+#### SimpleCustomProfiler
+
+```ruby
+class SimpleCustomProfiler < SpeedGun::Profiler::Base
+  def title
+    'simple'
+  end
+end
+
+SpeedGun.profile(:simple_custom_profiler) { ... }
+```
+
+#### BeforeFilterProfiler
+
+```ruby
+class BeforeFilerProfiler < SpeedGun::Profiler::Base
+  # `hook_method` is a helper of method profiling.
+  hook_method ApplicationControler, :some_filter
+end
+
+class ApplicationControler
+  def some_filer
+    ...
+  end
+end
+```
+
+#### ForceGCProfiler
+
+```ruby
+class ForceGCProfiler < SpeedGun::Profiler::Base
+  # You can define profiler type name.
+  def self.type
+    :force_gc_profiler
+  end
+
+  # `#before_profile` is called on before profiling.
+  def before_profile
+    @before_gc_disable = GC.enable
+    GC.start
+  end
+
+  # `#after_profile` is called on after profiling.
+  def after_profile
+    GC.disable if @before_gc_disable
+  end
+end
+
+SpeedGun.profile(:force_gc_profiler) { ... }
+```
+
+## Store
+
+SpeedGun store request informations(profiling, environments and browser infos). You can select store engines.
+
+### Built-in Stores
+
+- `SpeedGun::Store::Memory` (default store engine on rack)
+  - `max_entries` option: Set number of max profile entries(default: 100)
+- `SpeedGun::Store::File` (default store engine on rails)
+  - `path` option: Set stored path(default: `/tmp/speed_gun` or `Rails.root/tmp/speed_gun`)
+  - `expires` option: Set expires in seconds(default: 1 day)
+- `SpeedGun::Store::Memcache` (before `require 'speed_gun/store/memcache'`)
+  - `client` option: Set memcache client instance(default: `Dalli::Clinet.new`)
+  - `prefix` option: Set prefix of your profile key(default: `'speed-gun-'`)
+  - `expires` option: Set expires in seconds(default: 1 day)
+- `SpeedGun::Store::Redis` (before `require 'speed_gun/store/redis'`)
+  - `client` option: Set redis client instance(default: `Redis.new`)
+  - `prefix` option: Set prefix of your profile key(default: `'speed-gun-'`)
+  - `expires` option: Set expires in seconds(default: 1 day)
+
+### Custom Store
+
+SpeedGun's store engines requires `[]` and `[]=` methods.
+
+## Contributing
+
+Please pull-requests :octocat: <http://github.com/rosylilly/speed_gun>

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/javascripts/browser.js

@@ -0,0 +1,65 @@
+if(!window['speedGun']) { window.speedGun = {}; };
+
+(function($) {
+  if(!$) { return }
+
+  speedGun.sendBrowserInfo = function() {
+    var data = {};
+    var p = window['performance'];
+
+    data.user_agent = navigator.userAgent;
+
+    if(p['navigation']) {
+      data.navigation = {
+        type: p.navigation.type,
+        redirect_count: p.navigation.redirectCount
+      };
+    }
+
+    if(p['timing']) {
+      var t = p.timing;
+      data.timing = {
+        navigationStart: t.navigationStart,
+        redirectStart: t.redirectStart,
+        unloadEventStart: t.unloadEventStart,
+        unloadEventEnd: t.unloadEventEnd,
+        redirectEnd: t.redirectEnd,
+        fetchStart: t.fetchStart,
+        domainLookupStart: t.domainLookupStart,
+        domainLookupEnd: t.domainLookupEnd,
+        connectStart: t.connectStart,
+        secureConnectionStart: t.secureConnectionStart,
+        connectEnd: t.connectEnd,
+        requestStart: t.requestStart,
+        responseStart: t.responseStart,
+        responseEnd: t.responseEnd,
+        domLoading: t.domLoading,
+        domInteractive: t.domInteractive,
+        domContentLoadedEventStart: t.domContentLoadedEventStart,
+        domContentLoadedEventEnd: t.domContentLoadedEventEnd,
+        domComplete: t.domComplete,
+        loadEventStart: t.loadEventStart,
+        loadEventEnd: t.loadEventEnd,
+      };
+    }
+
+    speedGun.send({ browser: data });
+    $('#speed_gun_total').text(
+      (t.domContentLoadedEventEnd - t.navigationStart).toString() + 'ms'
+    );
+  };
+
+  speedGun.send = function(data) {
+    $.post(speedGun.endpoint, data, function() {});
+  };
+
+  var loadedInterval = setInterval(function() {
+    if (performance.timing.loadEventEnd != 0) {
+      clearInterval(loadedInterval);
+
+      speedGun.id = $('#speed_gun').data('speed-gun-id');
+      speedGun.endpoint = $('#speed_gun').data('speed-gun-endpoint') + "/" + speedGun.id;
+      speedGun.sendBrowserInfo()
+    }
+  }, 100);
+})(window['jQuery'] || window['Zepto']);

data/app/assets/javascripts/profiler.js

@@ -0,0 +1,45 @@
+if(!window['speedGun']) { window.speedGun = {}; };
+speedGun.enableConsoleProfile = !!(window['console'] && console['profile']);
+speedGun.profileCount = 0;
+
+speedGun.profile = function(title, func) {
+  speedGun.profileCount++;
+  if(!func) {
+    func = title;
+    title = undefined;
+  };
+  if(!title) {
+    title = "Speed Gun Profile #" + speedGun.profileCount;
+  };
+  var callstack = [];
+  var caller = arguments['callee'];
+  if(caller) {
+    while(caller) {
+      caller = caller['caller'];
+      if(caller) { callstack.push(caller.toString()); };
+    }
+  }
+  var before = +(new Date);
+  if(speedGun.enableConsoleProfile) { console.profile(title); };
+  ret = func();
+  if(speedGun.enableConsoleProfile) { console.profileEnd(title); };
+  var elapsedTime = (+(new Date)) - before;
+  if(speedGun['send']) {
+    speedGun.send(
+      { js: { title: title, elapsed_time: elapsedTime, backtrace: callstack } }
+    );
+  };
+  return ret;
+};
+
+speedGun.profileMethod = function(object, methodName, title) {
+  if(!title) { title = "#" + methodName; };
+  var method = object[methodName];
+  var func = function() {
+    var args = arguments;
+    return speedGun.profile(title, function() {
+      return method.apply(object, args);
+    });
+  };
+  object[methodName] = func;
+}

data/app/views/speed_gun/_meter.html.slim

@@ -0,0 +1,9 @@
+#speed_gun(data-speed-gun-endpoint="#{SpeedGun.config.prefix}/profile" data-speed-gun-id="#{SpeedGun.current.id}" data-rack-ms="#{SpeedGun.current.profiles.first.elapsed_time * 1000}")
+  - if SpeedGun.config.show_button?
+    #speed_gun_button(style="position: fixed; bottom: 10px; right: 10px;")
+      a#toggle_speed_gun(href="#{File.join(SpeedGun.config.prefix, 'profile', SpeedGun.current.id)}" target="_blank" style="display: block; padding: 2px 5px; font-size: 9px; line-height: 2;  box-shadow: 0 0 2px #333; background-color: #fff; color: #333; text-decoration: none; border-radius: 3px;")
+        span#speed_gun_total(style="vertical-align: middle;")
+  - unless SpeedGun.config.no_include_jquery?
+    script(type="text/javascript" src="#{SpeedGun.config.prefix}/jquery-1.10.2.min.js")
+  script(type="text/javascript" src="#{SpeedGun.config.prefix}/browser.js")
+  script(type="text/javascript" src="#{SpeedGun.config.prefix}/profiler.js")

data/lib/speed_gun/app/public/browser.js

@@ -0,0 +1,65 @@
+if(!window['speedGun']) { window.speedGun = {}; };
+
+(function($) {
+  if(!$) { return }
+
+  speedGun.sendBrowserInfo = function() {
+    var data = {};
+    var p = window['performance'];
+
+    data.user_agent = navigator.userAgent;
+
+    if(p['navigation']) {
+      data.navigation = {
+        type: p.navigation.type,
+        redirect_count: p.navigation.redirectCount
+      };
+    }
+
+    if(p['timing']) {
+      var t = p.timing;
+      data.timing = {
+        navigationStart: t.navigationStart,
+        redirectStart: t.redirectStart,
+        unloadEventStart: t.unloadEventStart,
+        unloadEventEnd: t.unloadEventEnd,
+        redirectEnd: t.redirectEnd,
+        fetchStart: t.fetchStart,
+        domainLookupStart: t.domainLookupStart,
+        domainLookupEnd: t.domainLookupEnd,
+        connectStart: t.connectStart,
+        secureConnectionStart: t.secureConnectionStart,
+        connectEnd: t.connectEnd,
+        requestStart: t.requestStart,
+        responseStart: t.responseStart,
+        responseEnd: t.responseEnd,
+        domLoading: t.domLoading,
+        domInteractive: t.domInteractive,
+        domContentLoadedEventStart: t.domContentLoadedEventStart,
+        domContentLoadedEventEnd: t.domContentLoadedEventEnd,
+        domComplete: t.domComplete,
+        loadEventStart: t.loadEventStart,
+        loadEventEnd: t.loadEventEnd,
+      };
+    }
+
+    speedGun.send({ browser: data });
+    $('#speed_gun_total').text(
+      (t.domContentLoadedEventEnd - t.navigationStart).toString() + 'ms'
+    );
+  };
+
+  speedGun.send = function(data) {
+    $.post(speedGun.endpoint, data, function() {});
+  };
+
+  var loadedInterval = setInterval(function() {
+    if (performance.timing.loadEventEnd != 0) {
+      clearInterval(loadedInterval);
+
+      speedGun.id = $('#speed_gun').data('speed-gun-id');
+      speedGun.endpoint = $('#speed_gun').data('speed-gun-endpoint') + "/" + speedGun.id;
+      speedGun.sendBrowserInfo()
+    }
+  }, 100);
+})(window['jQuery'] || window['Zepto']);