speed_gun 0.0.4 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c07e8960feed86caf19a06706d295b3418a8ce2e
-  data.tar.gz: aef33393a26ad7f812960adf25e225eb0216195f
+  metadata.gz: a38f7425f4a2a540896f5b7a966cc5585c28de8c
+  data.tar.gz: 5475d18a057f641dd22f573bded80f1f5ffde58d
 SHA512:
-  metadata.gz: bbf60d69bed4567f0e323a3018ed9f36212f37c0a7bb9d9f7b9f279fc59df400b0c0fb55b3e50c0bba8d1bf055c114d6b75594c4e175b73368edf8a6b2446cfa
-  data.tar.gz: 1fdc3c2b9e5edadafb1a0b0eee4738d73e5aeb9d10bd4e9ac882eb1ed5e7b0e763653924b5f96e7d746f425ffd6c9ec537b31cd72309f72d2d6f7f902ffb6a5d
+  metadata.gz: 520937f45fcee60a4f24d187d85ccfc204b0c059dd3604ac0196db7880e5b46cf8fc011da5e26b513560ac62a252543af734e27862c8c64871253e805db72382
+  data.tar.gz: 24f430cd3d83e1eb25d31db0de0004ae359b1745e8f548cd46ac9d724af9d571ccf26e007dfef870007520c71a173dd0458a499fcba07d7864a97b01f2285a83

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/speed_gun/app/views/meter.html.slim

@@ -1,9 +1,4 @@
-#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")
+div.speed-gun(style="position: fixed; bottom: -1px; right: -1px; border: 1px solid #999; border-radius: 3px 0 0 0; background-color: white; font-size: 9px;")
+  a(href="#" style="display: block; padding: 5px 10px")
+    = "%0.2f" % (duration * 1000)
+    | ms

data/lib/speed_gun/config.rb

@@ -1,59 +1,50 @@
+require 'hashie'
 require 'speed_gun'
+require 'speed_gun/store/memory_store'
 
-class SpeedGun::Config < Hash
-  def enable?
-    enable && enable_if.call
-  end
-
-  def enable
-    fetch(:enable, true)
-  end
+class SpeedGun::Config < Hashie::Dash
+  # @!attribute [rw]
+  # @return [Boolean] true if enabled speed gun
+  property :enable, default: true
 
-  def enable_if
-    self[:enable_if] ||= -> { true }
-  end
+  # @!attribute [rw]
+  # @return [Object, nil] logger of the speed gun
+  property :logger, default: nil
 
-  def prefix
-    self[:prefix] ||= '/speed_gun'
-  end
+  # @!attribute [rw]
+  # @return [Array<Regexp>] paths of skip the speed gun
+  property :skip_paths, default: []
 
-  def prefix_regexp
-    self[:prefix_regexp] ||= /^#{Regexp.escape(prefix)}/x
-  end
+  # @!attribute [rw]
+  # @return [SpeedGun::Store] store of events and profiles
+  property :store, default: SpeedGun::Store::MemoryStore.new
 
-  def store
-    self[:store] ||= SpeedGun::Store::Memory.new
-  end
+  # @!attribute [rw]
+  # @return [Boolean] true if enable auto injection
+  property :auto_inject, default: true
 
-  def auto_inject?
-    fetch(:auto_inject, true)
+  # @return [true]
+  def enable!
+    self[:enable] = true
   end
 
-  def backtrace_remove
-    self[:backtrace_remove] ||= ''
+  # @return [false]
+  def disable!
+    self[:enable] = false
   end
 
-  def backtrace_includes
-    self[:backtrace_includes] ||= []
+  # @return [Boolean] true if enabled speed gun
+  def enabled?
+    !!enable
   end
 
-  def show_button?
-    fetch(:show_button, true)
+  # @return [Boolean] true if disabled speed gun
+  def disabled?
+    !enabled?
   end
 
-  def no_include_jquery?
-    fetch(:no_include_jquery, false)
-  end
-
-  def skip_paths
-    self[:skip_paths] ||= [/favicon/]
-  end
-
-  def force_profile?
-    fetch(:force_profile, true)
-  end
-
-  def authorize_proc
-    self[:authorize_proc] ||= ->(request) { true }
+  # @return [Boolean] true if enable auto injection
+  def auto_inject?
+    auto_inject
   end
 end

data/lib/speed_gun/event.rb

@@ -0,0 +1,72 @@
+require 'speed_gun'
+
+class SpeedGun::Event
+  def self.from_hash(id, hash)
+    event = new(
+      hash['name'],
+      hash['payload'],
+      Time.at(hash['started_at']),
+      hash['finished_at'] ? Time.at(hash['finished_at']) : nil
+    )
+    event.instance_variable_set(:@id, id)
+
+    event
+  end
+
+  # @return [String] event ID
+  attr_reader :id
+
+  # @return [String] event name
+  attr_reader :name
+
+  # @return [Hashie::Mash] payload
+  attr_reader :payload
+
+  # @return [Time] start time
+  attr_reader :started_at
+
+  # @return [Time, nil] finish time
+  attr_reader :finished_at
+
+  # @param name [String] event name
+  # @param payload [Hash] payload
+  # @param started_at [Time] start time
+  # @param finished_at [Time, nil] finish time
+  # @return [SpeedGun::Event] instance of SpeedGun::Event
+  def initialize(name, payload = {}, started_at = Time.now, finished_at = nil)
+    @id = SecureRandom.uuid
+    @name = name
+    @payload = Hashie::Mash.new(payload)
+    @started_at = started_at
+    @finished_at = finished_at
+  end
+
+  # Finish event
+  #
+  # @return [Time] finish time
+  def finish!
+    @finished_at = Time.now
+  end
+
+  # @return [true, false] true if the event is finished
+  def finished?
+    !@finished_at.nil?
+  end
+
+  # Time duration of the event
+  #
+  # @return [Float] a duration of the event
+  def duration
+    finished? ? finished_at.to_f - started_at.to_f : -1
+  end
+
+  def to_hash
+    {
+      'name' => name,
+      'payload' => payload,
+      'started_at' => started_at.to_f,
+      'finished_at' => finished? ? finished_at.to_f : nil,
+      'duration' => duration
+    }
+  end
+end

data/lib/speed_gun/middleware.rb

@@ -1,60 +1,70 @@
 require 'speed_gun'
-require 'speed_gun/app'
-require 'speed_gun/profiler'
-require 'speed_gun/profiler/rack'
 require 'speed_gun/template'
+require 'speed_gun/profiler/rack_profiler'
 
 class SpeedGun::Middleware
-  BODY_END_REGEXP = /<\/(?:body|html)>/
+  BODY_END_REGEXP = /<\/(?:body|html)>/i
 
+  # @param app [#call] Rack application
+  # @return [SpeedGun::Middleware] a instance of SpeedGun::Middleware
   def initialize(app)
     @app = app
   end
 
+  # Handle rack request
+  #
+  # @return [Rack::Response]
   def call(env)
-    return SpeedGun::App.call(env) if under_speed_gun?(env)
+    if with_speed_gun?(env)
+      call_with_speed_gun(env)
+    else
+      call_without_speed_gun(env)
+    end
+  end
 
-    SpeedGun.current = SpeedGun::Profiler.new(env) if SpeedGun.enable?
+  private
 
-    call_with_speed_gun(env)
-  ensure
-    SpeedGun.current = nil
+  def with_speed_gun?(env)
+    SpeedGun.enabled? && !skip?(env['PATH_INFO'])
   end
 
-  private
+  def skip?(path)
+    SpeedGun.config.skip_paths.any? { |regexp| regexp.match(path) }
+  end
 
-  def call_with_speed_gun(env)
-    remove_conditional_get_headers(env)
+  def call_without_speed_gun(env)
+    @app.call(env)
+  end
 
-    status, headers, body = *SpeedGun.current.profile(:rack) { @app.call(env) }
+  def call_with_speed_gun(env)
+    SpeedGun.current_profile = SpeedGun::Profile.new
+    SpeedGun.current_profile.request_method = env['REQUEST_METHOD'].to_s.upcase
+    SpeedGun.current_profile.path = env['PATH_INFO'].to_s
+    SpeedGun.current_profile.query = env['QUERY_STRING'].to_s
 
-    if SpeedGun.active?
-      inject_header(headers)
-      SpeedGun.current.dump
+    response = SpeedGun::Profiler::RackProfier.profile do
+      call_without_speed_gun(env)
     end
 
-    if SpeedGun.config.auto_inject? && SpeedGun.active?
-      inject_body(status, headers, body)
-    else
-      return [status, headers, body]
-    end
-  end
+    SpeedGun.current_profile.status = response[0]
 
-  def remove_conditional_get_headers(env)
-    return if !SpeedGun.config.force_profile? && SpeedGun.active?
+    if SpeedGun.current_profile.active?
+      inject_header(response[1])
+      if SpeedGun.current_profile.config.auto_inject?
+        response = inject_body(*response)
+      end
+    end
 
-    env['HTTP_IF_MODIFIED_SINCE'] = ''
-    env['HTTP_IF_NONE_MATCH'] = ''
+    response
+  ensure
+    if SpeedGun.current_profile.active?
+      SpeedGun.config.store.save(SpeedGun.current_profile)
+    end
+    SpeedGun.discard_profile!
   end
 
   def inject_header(headers)
-    if SpeedGun.config.force_profile?
-      headers.delete('ETag')
-      headers.delete('Date')
-      headers['Cache-Control'] = 'must-revalidate, private, max-age=0'
-    end
-
-    headers['X-SPEEDGUN-ID'] = SpeedGun.current.id
+    headers['X-SpeedGun-Profile-Id'] = SpeedGun.current_profile.id
   end
 
   def inject_body(status, headers, body)
@@ -78,14 +88,4 @@ class SpeedGun::Middleware
       SpeedGun::Template.render + matched
     end
   end
-
-  def under_speed_gun?(env)
-    if SpeedGun.config.prefix_regexp.match(env['PATH_INFO'])
-      env['PATH_INFO'] =
-        env['PATH_INFO'].sub(SpeedGun.config.prefix_regexp, '')
-      true
-    else
-      false
-    end
-  end
 end

data/lib/speed_gun/profile.rb

@@ -0,0 +1,102 @@
+require 'securerandom'
+require 'speed_gun'
+require 'speed_gun/event'
+
+class SpeedGun::Profile
+  def self.from_hash(id, hash)
+    profile = new
+
+    hash['events'].map! do |event_id|
+      SpeedGun.config.store.load(SpeedGun::Event, event_id)
+    end
+
+    hash['id'] = id
+    hash.delete('duration')
+    hash.each_pair do |key, val|
+      profile.instance_variable_set(:"@#{key}", val)
+    end
+
+    profile
+  end
+
+  # @return [String] profile ID
+  attr_reader :id
+
+  # @return [Array<SpeedGun::Event>] recorded events
+  attr_reader :events
+
+  # @return [SpeedGun::Config] the config of the profile
+  attr_reader :config
+
+  # @return [Integer] status code of the response
+  attr_accessor :status
+
+  # @return [String] method of the request
+  attr_accessor :request_method
+
+  # @return [String] path of the request
+  attr_accessor :path
+
+  # @return [String] query of the request
+  attr_accessor :query
+
+  # @return [SpeedGun::Profile] instance of SpeedGun::Profile
+  def initialize(config = SpeedGun.config.dup)
+    @id = SecureRandom.uuid
+    @events = []
+    @config = config
+    @active = true
+  end
+
+  # Record an event
+  #
+  # @param event [SpeedGun::Event] record event
+  # @return [Array<SpeedGun::Event>] recorded events
+  def record!(event)
+    config.logger.debug(
+      "[SpeedGun] Record Event: #{event.name}: #{'%0.2f' % (event.duration * 1000)}ms"
+    ) if config.logger
+    config.store.save(event) if active?
+    @events.push(event)
+  end
+
+  def active?
+    @active
+  end
+
+  def deactive?
+    !active?
+  end
+
+  def activate!
+    @active = true
+  end
+
+  def deactivate!
+    @active = false
+  end
+
+  def earliest_started_at
+    @events.sort_by(&:started_at).first.started_at
+  end
+
+  def latest_finished_at
+    @events.sort_by { |event| event.finished_at || 0 }.last.finished_at
+  end
+
+  def duration
+    finished_at = latest_finished_at
+    finished_at ? finished_at - earliest_started_at : 0
+  end
+
+  def to_hash
+    {
+      'events' => events.map(&:id),
+      'status' => status,
+      'request_method' => request_method,
+      'path' => path,
+      'query' => query,
+      'duration' => duration
+    }
+  end
+end

data/lib/speed_gun/profiler/action_controller_profiler.rb

@@ -0,0 +1,14 @@
+require 'speed_gun/profiler/active_support_notifications_profiler'
+
+class SpeedGun::Profiler::ActionControllerProfiler <
+  SpeedGun::Profiler::ActiveSupportNotificatiosProfiler
+
+  subscribe(
+    /^(process_action|send_file|send_data|redirect_to)\.action_controller$/,
+    [:request]
+  )
+
+  def self.name
+    'action_controller'
+  end
+end

data/lib/speed_gun/profiler/action_view_profiler.rb

@@ -0,0 +1,11 @@
+require 'speed_gun/profiler/active_support_notifications_profiler'
+
+class SpeedGun::Profiler::ActionViewProfiler <
+  SpeedGun::Profiler::ActiveSupportNotificatiosProfiler
+
+  subscribe /^!(render_template|render_partial)\.action_view$/
+
+  def self.name
+    'action_view'
+  end
+end

data/lib/speed_gun/profiler/active_record_profiler.rb

@@ -0,0 +1,11 @@
+require 'speed_gun/profiler/active_support_notifications_profiler'
+
+class SpeedGun::Profiler::ActiveRecordProfiler <
+  SpeedGun::Profiler::ActiveSupportNotificatiosProfiler
+
+  subscribe(/\.active_record$/, [:binds])
+
+  def self.name
+    'active_record'
+  end
+end

data/lib/speed_gun/profiler/active_support_notifications_profiler.rb

@@ -0,0 +1,29 @@
+require 'speed_gun/profiler'
+
+class SpeedGun::Profiler::ActiveSupportNotificatiosProfiler < SpeedGun::Profiler
+  def self.subscribe(event, ignore_payload = [])
+    klass = self
+    ActiveSupport::Notifications.subscribe(event) do |*args|
+      klass.record(event, *args, ignore_payload)
+    end
+  end
+
+  def self.record(event, name, started, ended, id, payload, ignore_payload)
+    name = "#{self.name}.#{name.sub(event, '\1')}"
+
+    payload.symbolize_keys!
+
+    ignore_payload.each do |key|
+      payload.delete(key)
+    end
+
+    payload[:backtrace] = backtrace
+
+    event = SpeedGun::Event.new(name, payload, started, ended)
+    SpeedGun.current_profile.record!(event)
+  end
+
+  def self.backtrace
+    Rails.backtrace_cleaner.clean(caller[2..-1])
+  end
+end

data/lib/speed_gun/profiler/rack_profiler.rb

@@ -0,0 +1,7 @@
+require 'speed_gun/profiler'
+
+class SpeedGun::Profiler::RackProfier < SpeedGun::Profiler
+  def self.name
+    'rack.total'
+  end
+end

data/lib/speed_gun/profiler.rb

@@ -1,128 +1,21 @@
 require 'speed_gun'
-require 'speed_gun/store'
-require 'speed_gun/browser'
-require 'speed_gun/hook'
-require 'securerandom'
-require 'msgpack'
-require 'multi_json'
 
+# @abstract
 class SpeedGun::Profiler
-  PROFILERS = {}
-
-  def self.load(id)
-    src = SpeedGun.store[id]
-
-    return nil unless src
-
-    restore(src)
-  end
-
-  def self.restore(src)
-    data = src.kind_of?(String) ? MessagePack.unpack(src) : src
-
-    profiler = new({})
-    profiler.restore_by_hash(data)
-
-    profiler
-  end
-
-  def initialize(env)
-    @id = SecureRandom.uuid
-    @path = env['PATH_INFO']
-    @query = env['QUERY_STRING']
-    @env = env
-    @requested_at = Time.now
-    @profiles = []
-    @browser = nil
-    @active = true
-    @now_profile = nil
-  end
-  attr_reader :id, :path, :query, :env, :requested_at, :profiles, :browser
-  attr_accessor :now_profile
-
-  def profile(type, *args, &block)
-    profiler = PROFILERS[type]
-
-    if profiler
-      profiler.profile(self, *args, &block)
-    else
-      yield
-    end
-  end
-
-  def skip?
-    SpeedGun.config.skip_paths.any? { |prefix| prefix.match(@path) }
-  end
-
-  def active?
-    @active && !skip?
-  end
-
-  def activate!
-    @active = true
+  def self.profile(*args, &block)
+    new.profile(*args, &block)
   end
 
-  def deactivate!
-    @active = false
-  end
+  def profile(name = self.class.name, payload = {}, &block)
+    starts_at = Time.now
 
-  def dump
-    SpeedGun.store[id] = to_msgpack
+    ret = yield
 
-    SpeedGun::Hook.invoke_all(self)
-  end
-
-  def browser=(hash)
-    @browser = SpeedGun::Browser.new(hash)
-  end
-
-  def as_msgpack(*args)
-    {
-      id: @id,
-      path: @path,
-      query: @query,
-      env: msgpackable_env,
-      requested_at: @requested_at.to_i,
-      profiles: @profiles.map { |profile| profile.as_msgpack(*args) },
-      browser: @browser ? @browser.as_msgpack(*args) : nil,
-    }
-  end
-
-  def to_msgpack(*args)
-    as_msgpack(*args).to_msgpack(*args)
-  end
+    event = SpeedGun::Event.new(
+      name, payload, starts_at, Time.now
+    )
+    SpeedGun.current_profile.record!(event)
 
-  def to_json(*args)
-    MultiJson.dump(as_msgpack(*args))
-  end
-
-  def restore_by_hash(hash)
-    hash.each_pair do |key, val|
-      instance_variable_set(:"@#{key}", restore_attribute(key, val))
-    end
-  end
-
-  def restore_attribute(key, val)
-    case key
-    when 'requested_at'
-      Time.at(val)
-    when 'profiles'
-      val.map { |profile| SpeedGun::Profiler::Base.load(profile) }
-    when 'browser'
-      val ? SpeedGun::Browser.new(val) : val
-    else
-      val
-    end
-  end
-
-  private
-
-  def msgpackable_env
-    env = {}
-    @env.each_pair { |key, val| env[key] = val if key[0] =~ /[A-Z]/ }
-    env
+    return ret
   end
 end
-
-require 'speed_gun/profiler/manual'
-require 'speed_gun/profiler/js'