rack-mini-profiler 1.0.0 → 1.0.1

data/lib/mini_profiler/profiler.rb

@@ -41,7 +41,7 @@ module Rack
         self.current.discard = true if current
       end
 
-      def create_current(env={}, options={})
+      def create_current(env = {}, options = {})
         # profiling the request
         context               = Context.new
         context.inject_js     = config.auto_inject && (!env['HTTP_X_REQUESTED_WITH'].eql? 'XMLHttpRequest')
@@ -102,11 +102,11 @@ module Rack
       # If we're an XMLHttpRequest, serve up the contents as JSON
       if request.xhr?
         result_json = page_struct.to_json
-        [200, { 'Content-Type' => 'application/json'}, [result_json]]
+        [200, { 'Content-Type' => 'application/json' }, [result_json]]
       else
         # Otherwise give the HTML back
         html = generate_html(page_struct, env)
-        [200, {'Content-Type' => 'text/html'}, [html]]
+        [200, { 'Content-Type' => 'text/html' }, [html]]
       end
     end
 
@@ -131,11 +131,10 @@ module Rack
       resources_env = env.dup
       resources_env['PATH_INFO'] = file_name
 
-      rack_file = Rack::File.new(MiniProfiler.resources_root, {'Cache-Control' => 'max-age:86400'})
+      rack_file = Rack::File.new(MiniProfiler.resources_root, 'Cache-Control' => 'max-age:86400')
       rack_file.call(resources_env)
     end
 
-
     def current
       MiniProfiler.current
     end
@@ -144,12 +143,10 @@ module Rack
       MiniProfiler.current = c
     end
 
-
     def config
       @config
     end
 
-
     def call(env)
 
       start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
@@ -164,7 +161,7 @@ module Rack
       env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME'] = ENV['PASSENGER_BASE_URI'] || env['SCRIPT_NAME']
 
       skip_it = (@config.pre_authorize_cb && !@config.pre_authorize_cb.call(env)) ||
-                (@config.skip_paths && @config.skip_paths.any?{ |p| path.start_with?(p) }) ||
+                (@config.skip_paths && @config.skip_paths.any? { |p| path.start_with?(p) }) ||
                 query_string =~ /pp=skip/
 
       if skip_it || (
@@ -189,9 +186,9 @@ module Rack
       end
 
       if skip_it || !config.enabled
-        status,headers,body = @app.call(env)
+        status, headers, body = @app.call(env)
         client_settings.disable_profiling = true
-        return client_settings.handle_cookie([status,headers,body])
+        return client_settings.handle_cookie([status, headers, body])
       else
         client_settings.disable_profiling = false
       end
@@ -206,13 +203,13 @@ module Rack
       if query_string =~ /pp=profile-memory/
         query_params = Rack::Utils.parse_nested_query(query_string)
         options = {
-          :ignore_files => query_params['memory_profiler_ignore_files'],
-          :allow_files => query_params['memory_profiler_allow_files'],
+          ignore_files: query_params['memory_profiler_ignore_files'],
+          allow_files: query_params['memory_profiler_allow_files'],
         }
-        options[:top]= Integer(query_params['memory_profiler_top']) if query_params.key?('memory_profiler_top')
+        options[:top] = Integer(query_params['memory_profiler_top']) if query_params.key?('memory_profiler_top')
         result = StringIO.new
         report = MemoryProfiler.report(options) do
-          _,_,body = @app.call(env)
+          _, _, body = @app.call(env)
           body.close if body.respond_to? :close
         end
         report.pretty_print(result)
@@ -236,8 +233,7 @@ module Rack
       flamegraph = nil
 
       trace_exceptions = query_string =~ /pp=trace-exceptions/ && defined? TracePoint
-      status, headers, body, exceptions,trace = nil
-
+      status, headers, body, exceptions, trace = nil
 
       if trace_exceptions
         exceptions = []
@@ -264,7 +260,7 @@ module Rack
           unless defined?(Flamegraph) && Flamegraph.respond_to?(:generate)
 
             flamegraph = "Please install the flamegraph gem and require it: add gem 'flamegraph' to your Gemfile"
-            status,headers,body = @app.call(env)
+            status, headers, body = @app.call(env)
           else
             # do not sully our profile with mini profiler timings
             current.measure = false
@@ -277,12 +273,12 @@ module Rack
             else
               sample_rate = config.flamegraph_sample_rate
             end
-            flamegraph = Flamegraph.generate(nil, :fidelity => sample_rate, :embed_resources => query_string =~ /embed/, :mode => mode) do
-              status,headers,body = @app.call(env)
+            flamegraph = Flamegraph.generate(nil, fidelity: sample_rate, embed_resources: query_string =~ /embed/, mode: mode) do
+              status, headers, body = @app.call(env)
             end
           end
         else
-          status,headers,body = @app.call(env)
+          status, headers, body = @app.call(env)
         end
       ensure
         trace.disable if trace
@@ -295,7 +291,7 @@ module Rack
         skip_it = true
       end
 
-      return client_settings.handle_cookie([status,headers,body]) if skip_it
+      return client_settings.handle_cookie([status, headers, body]) if skip_it
 
       # we must do this here, otherwise current[:discard] is not being properly treated
       if trace_exceptions
@@ -335,7 +331,6 @@ module Rack
         return client_settings.handle_cookie(self.flamegraph(flamegraph))
       end
 
-
       begin
         @storage.save(page_struct)
         # no matter what it is, it should be unviewed, otherwise we will miss POST
@@ -343,7 +338,7 @@ module Rack
 
         # inject headers, script
         if status >= 200 && status < 300
-          result = inject_profiler(env,status,headers,body)
+          result = inject_profiler(env, status, headers, body)
           return client_settings.handle_cookie(result) if result
         end
       rescue Exception => e
@@ -359,7 +354,7 @@ module Rack
       self.current = nil
     end
 
-    def inject_profiler(env,status,headers,body)
+    def inject_profiler(env, status, headers, body)
       # mini profiler is meddling with stuff, we can not cache cause we will get incorrect data
       # Rack::ETag has already inserted some nonesense in the chain
       content_type = headers['Content-Type']
@@ -382,7 +377,7 @@ module Rack
         script   = self.get_profile_script(env)
 
         if String === body
-          response.write inject(body,script)
+          response.write inject(body, script)
         else
           body.each { |fragment| response.write inject(fragment, script) }
         end
@@ -420,7 +415,7 @@ module Rack
 
         body << "\nBacktraces\n"
         exceptions.each_with_index do |e, i|
-          body << "##{i+1}: #{e.class} - \"#{e.message}\"\n  #{e.backtrace.join("\n  ")}\n\n"
+          body << "##{i + 1}: #{e.class} - \"#{e.message}\"\n  #{e.backtrace.join("\n  ")}\n\n"
         end
       end
       text_result(body)
@@ -428,12 +423,12 @@ module Rack
 
     def dump_env(env)
       body = "Rack Environment\n---------------\n".dup
-      env.each do |k,v|
+      env.each do |k, v|
         body << "#{k}: #{v}\n"
       end
 
       body << "\n\nEnvironment\n---------------\n"
-      ENV.each do |k,v|
+      ENV.each do |k, v|
         body << "#{k}: #{v}\n"
       end
 
@@ -449,9 +444,9 @@ module Rack
     end
 
     def trim_strings(strings, max_size)
-      strings.sort!{|a,b| b[1] <=> a[1]}
+      strings.sort! { |a, b| b[1] <=> a[1] }
       i = 0
-      strings.delete_if{|_| (i+=1) > max_size}
+      strings.delete_if { |_| (i += 1) > max_size }
     end
 
     def analyze_memory
@@ -470,8 +465,8 @@ module Rack
 
           unless str.valid_encoding?
             # work around bust string with a double conversion
-            str.encode!("utf-16","utf-8",:invalid => :replace)
-            str.encode!("utf-8","utf-16")
+            str.encode!("utf-16", "utf-8", invalid: :replace)
+            str.encode!("utf-8", "utf-16")
           end
         end
 
@@ -484,8 +479,8 @@ module Rack
       total_strings = counts[:T_STRING]
 
       body << counts
-        .sort{|a,b| b[1] <=> a[1]}
-        .map{|k,v| "#{k}: #{v}"}
+        .sort { |a, b| b[1] <=> a[1] }
+        .map { |k, v| "#{k}: #{v}" }
         .join("\n")
 
       strings = []
@@ -509,19 +504,19 @@ module Rack
       trim_strings(strings, max_size)
 
       body << "\n\n\n1000 Largest strings:\n\n"
-      body << strings.map{|s,len| "#{s[0..1000]}\n(len: #{len})\n\n"}.join("\n")
+      body << strings.map { |s, len| "#{s[0..1000]}\n(len: #{len})\n\n" }.join("\n")
 
       body << "\n\n\n1000 Sample strings:\n\n"
-      body << sample_strings.map{|s,len| "#{s[0..1000]}\n(len: #{len})\n\n"}.join("\n")
+      body << sample_strings.map { |s, len| "#{s[0..1000]}\n(len: #{len})\n\n" }.join("\n")
 
       body << "\n\n\n1000 Most common strings:\n\n"
-      body << string_counts.sort{|a,b| b[1] <=> a[1]}[0..max_size].map{|s,len| "#{trunc.call(s)}\n(x #{len})\n\n"}.join("\n")
+      body << string_counts.sort { |a, b| b[1] <=> a[1] }[0..max_size].map { |s, len| "#{trunc.call(s)}\n(x #{len})\n\n" }.join("\n")
 
       text_result(body)
     end
 
     def text_result(body)
-      headers = {'Content-Type' => 'text/plain'}
+      headers = { 'Content-Type' => 'text/plain' }
       [200, headers, [body]]
     end
 
@@ -531,7 +526,7 @@ module Rack
     end
 
     def help(client_settings, env)
-      headers = {'Content-Type' => 'text/html'}
+      headers = { 'Content-Type' => 'text/html' }
       body = "<html><body>
 <pre style='line-height: 30px; font-size: 16px;'>
 Append the following to your query string:
@@ -560,7 +555,7 @@ Append the following to your query string:
     end
 
     def flamegraph(graph)
-      headers = {'Content-Type' => 'text/html'}
+      headers = { 'Content-Type' => 'text/html' }
       [200, headers, [graph]]
     end
 
@@ -591,19 +586,20 @@ Append the following to your query string:
       path = "#{env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME']}#{@config.base_url_path}"
 
       settings = {
-       :path               => path,
-       :version            => MiniProfiler::ASSET_VERSION,
-       :verticalPosition   => @config.vertical_position,
-       :horizontalPosition => @config.horizontal_position,
-       :showTrivial        => @config.show_trivial,
-       :showChildren       => @config.show_children,
-       :maxTracesToShow    => @config.max_traces_to_show,
-       :showControls       => @config.show_controls,
-       :authorized         => true,
-       :toggleShortcut     => @config.toggle_shortcut,
-       :startHidden        => @config.start_hidden,
-       :collapseResults    => @config.collapse_results,
-       :htmlContainer      => @config.html_container
+       path: path,
+       version: MiniProfiler::ASSET_VERSION,
+       verticalPosition: @config.vertical_position,
+       horizontalPosition: @config.horizontal_position,
+       showTrivial: @config.show_trivial,
+       showChildren: @config.show_children,
+       maxTracesToShow: @config.max_traces_to_show,
+       showControls: @config.show_controls,
+       showTotalSqlCount: @config.show_total_sql_count,
+       authorized: true,
+       toggleShortcut: @config.toggle_shortcut,
+       startHidden: @config.start_hidden,
+       collapseResults: @config.collapse_results,
+       htmlContainer: @config.html_container
       }
 
       if current && current.page_struct
@@ -617,7 +613,7 @@ Append the following to your query string:
       # TODO : cache this snippet
       script = IO.read(::File.expand_path('../html/profile_handler.js', ::File.dirname(__FILE__)))
       # replace the variables
-      settings.each do |k,v|
+      settings.each do |k, v|
         regex = Regexp.new("\\{#{k.to_s}\\}")
         script.gsub!(regex, v.to_s)
       end

data/lib/mini_profiler/profiling_methods.rb

@@ -14,7 +14,7 @@ module Rack
         return unless current
         parent_timer          = current.current_timer
         current.current_timer = current_timer = current.current_timer.add_child(name)
-        [current_timer,parent_timer]
+        [current_timer, parent_timer]
       end
 
       def finish_step(obj)
@@ -63,7 +63,7 @@ module Rack
       end
 
       def profile_method(klass, method, type = :profile, &blk)
-        default_name = type==:counter ? method.to_s  : klass.to_s + " " + method.to_s
+        default_name = type == :counter ? method.to_s : klass.to_s + " " + method.to_s
         clean        = clean_method_name(method)
 
         with_profiling    = ("#{clean}_with_mini_profiler").intern
@@ -96,7 +96,7 @@ module Rack
               self.send without_profiling, *args, &orig
             ensure
               duration_ms = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start).to_f * 1000
-              parent_timer.add_custom(name, duration_ms, Rack::MiniProfiler.current.page_struct )
+              parent_timer.add_custom(name, duration_ms, Rack::MiniProfiler.current.page_struct)
             end
           else
             Rack::MiniProfiler.current.current_timer = current_timer = parent_timer.add_child(name)
@@ -130,7 +130,7 @@ module Rack
       # and keeping a record of its run time.
       #
       # Returns the result of the block, or nil when no block is given.
-      def counter(type, duration_ms=nil)
+      def counter(type, duration_ms = nil)
         result = nil
         if block_given?
           start       = Process.clock_gettime(Process::CLOCK_MONOTONIC)

data/lib/mini_profiler/storage/file_store.rb

@@ -16,25 +16,28 @@ module Rack
 
         def [](key)
           begin
-            data = ::File.open(path(key),"rb") {|f| f.read}
+            data = ::File.open(path(key), "rb") { |f| f.read }
             return Marshal.load data
           rescue
             return nil
           end
         end
 
-        def []=(key,val)
-          ::File.open(path(key), "wb+") {|f| f.write Marshal.dump(val)}
+        def []=(key, val)
+          ::File.open(path(key), "wb+") do |f|
+            f.sync = true
+            f.write Marshal.dump(val)
+          end
         end
 
         private
         if RUBY_PLATFORM =~ /mswin(?!ce)|mingw|cygwin|bccwin/
           def path(key)
-            @path + "/" + @prefix  + "_" + key.gsub(/:/, '_')
+            @path.dup << "/" << @prefix << "_" << key.gsub(/:/, '_')
           end
         else
           def path(key)
-            @path + "/" + @prefix  + "_" + key
+            @path.dup << "/" << @prefix << "_" << key
           end
         end
       end
@@ -158,13 +161,13 @@ module Rack
         @timer_struct_lock.synchronize {
           files.each do |f|
             f = @path + '/' + f
-            ::File.delete f if ::File.basename(f) =~ /^mp_timers/ and (Time.now - ::File.mtime(f)) > @expires_in_seconds
+            ::File.delete f if ::File.basename(f) =~ (/^mp_timers/) && ((Time.now - ::File.mtime(f)) > @expires_in_seconds)
           end
         }
         @user_view_lock.synchronize {
           files.each do |f|
             f = @path + '/' + f
-            ::File.delete f if ::File.basename(f) =~ /^mp_views/ and (Time.now - ::File.mtime(f)) > @expires_in_seconds
+            ::File.delete f if ::File.basename(f) =~ (/^mp_views/) && ((Time.now - ::File.mtime(f)) > @expires_in_seconds)
           end
         }
       end

data/lib/mini_profiler/storage/memcache_store.rb

@@ -10,8 +10,8 @@ module Rack
       def initialize(args = nil)
         require 'dalli' unless defined? Dalli
         args ||= {}
-        @prefix             = args[:prefix]     || "MPMemcacheStore"
-        @prefix             += "-#{Rack::MiniProfiler::VERSION}"
+        @prefix = args[:prefix] || "MPMemcacheStore"
+        @prefix += "-#{Rack::MiniProfiler::VERSION}"
         @client             = args[:client]     || Dalli::Client.new
         @expires_in_seconds = args[:expires_in] || EXPIRES_IN_SECONDS
       end
@@ -62,15 +62,14 @@ module Rack
         token_info = @client.get("#{@prefix}-tokens")
         key1, key2, cycle_at = nil
 
-
         if token_info
-           key1, key2, cycle_at = Marshal::load(token_info)
+          key1, key2, cycle_at = Marshal::load(token_info)
 
            key1 = nil unless key1 && key1.length == 32
            key2 = nil unless key2 && key2.length == 32
 
            if key1 && cycle_at && (cycle_at > Process.clock_gettime(Process::CLOCK_MONOTONIC))
-              return [key1,key2].compact
+             return [key1, key2].compact
            end
         end
 

data/lib/mini_profiler/storage/memory_store.rb

@@ -19,7 +19,6 @@ module Rack
           @cycle_count * @interval >= @cycle
         end
 
-
         # We don't want to hit the filesystem every 10s to clean up the cache so we need to do a bit of
         # accounting to avoid sleeping that entire time.  We don't want to sleep for the entire period because
         # it means the thread will stay live in hot deployment scenarios, keeping a potentially large memory
@@ -67,12 +66,12 @@ module Rack
       end
 
       #FIXME: use weak ref, trouble it may be broken in 1.9 so need to use the 'ref' gem
-      def initialize_cleanup_thread(args={})
+      def initialize_cleanup_thread(args = {})
         cleanup_interval = args.fetch(:cleanup_interval) { CLEANUP_INTERVAL }
         cleanup_cycle    = args.fetch(:cleanup_cycle)    { CLEANUP_CYCLE }
         t = CacheCleanupThread.new(cleanup_interval, cleanup_cycle, self) do
           until Thread.current[:should_exit] do
-            CacheCleanupThread.current.sleepy_run
+            t.sleepy_run
           end
         end
         at_exit { t[:should_exit] = true }

data/lib/mini_profiler/storage/redis_store.rb

@@ -10,7 +10,7 @@ module Rack
 
       def initialize(args = nil)
         @args               = args || {}
-        @prefix             = @args.delete(:prefix)     || 'MPRedisStore'
+        @prefix             = @args.delete(:prefix) || 'MPRedisStore'
         @redis_connection   = @args.delete(:connection)
         @expires_in_seconds = @args.delete(:expires_in) || EXPIRES_IN_SECONDS
       end
@@ -103,7 +103,7 @@ unviewed_ids: #{get_unviewed_ids(user)}
         end
 
         redis.setex "#{@prefix}-key1", timeout, key1
-        redis.setex "#{@prefix}-key1_old", timeout*2, key1
+        redis.setex "#{@prefix}-key1_old", timeout * 2, key1
 
         [key1, key2].compact
       end