miniprofiler 0.1.7.1

data/spec/components/client_timer_struct_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+require 'rack-mini-profiler'
+require 'yaml'
+
+describe Rack::MiniProfiler::ClientTimerStruct do
+
+  def new_page
+    Rack::MiniProfiler::PageTimerStruct.new({})
+  end
+
+  def fixture(name)
+    YAML.load(File.open(File.dirname(__FILE__) + "/../fixtures/#{name}.yml"))
+  end
+
+  before do
+    @client = Rack::MiniProfiler::ClientTimerStruct.new
+  end
+
+  it 'defaults to no attributes' do
+    ::JSON.parse(@client.to_json).should be_empty
+  end
+
+  describe 'init_from_form_data' do
+
+    describe 'without a form' do
+      before do
+        @client.init_from_form_data({}, new_page)
+      end
+      
+      it 'has no Timings' do
+        @client['Timings'].should be_nil
+      end
+
+      it 'has no RedirectCount' do
+        @client['RedirectCount'].should be_nil
+      end
+    end
+
+    describe 'with a simple request' do
+      before do
+        @client.init_from_form_data(fixture(:simple_client_request), new_page)
+      end
+
+      it 'has the correct RedirectCount' do
+        @client['RedirectCount'].should == 1
+      end
+
+      it 'has Timings' do
+        @client['Timings'].should_not be_empty
+      end
+      
+      describe "bob.js" do
+        before do
+          @bob = @client['Timings'].find {|t| t["Name"] == "bob.js"}
+        end
+
+        it 'has it in the timings' do 
+          @bob.should_not be_nil
+        end
+
+        it 'has the correct duration' do 
+          @bob["Duration"].should == 6
+        end
+        
+      end
+
+      describe "Navigation" do
+        before do
+          @nav = @client['Timings'].find {|t| t["Name"] == "Navigation"}
+        end
+
+        it 'has a Timing for the Navigation' do          
+          @nav.should_not be_nil
+        end
+
+        it 'has the correct start' do
+          @nav['Start'].should == 0
+        end
+
+        it 'has the correct duration' do     
+          @nav['Duration'].should == 16
+        end
+      end
+
+      describe "Simple" do
+        before do
+          @simple = @client['Timings'].find {|t| t["Name"] == "Simple"}
+        end
+
+        it 'has a Timing for the Simple' do          
+          @simple.should_not be_nil
+        end
+
+        it 'has the correct start' do          
+          @simple['Start'].should == 1
+        end
+
+        it 'has the correct duration' do          
+          @simple['Duration'].should == 10
+        end
+      end      
+
+    end
+
+    describe 'with some odd values' do
+      before do
+        @client.init_from_form_data(fixture(:weird_client_request), new_page)        
+      end
+
+      it 'has the correct RedirectCount' do
+        @client['RedirectCount'].should == 99
+      end
+
+      it 'has Timings' do
+        @client['Timings'].should_not be_empty
+      end
+
+      it 'has no timing when the start is before Navigation' do          
+        @client['Timings'].find {|t| t["Name"] == "Previous"}.should be_nil
+      end
+  
+      describe "weird" do
+        before do
+          @weird = @client['Timings'].find {|t| t["Name"] == "Weird"}
+        end
+
+        it 'has a Timing for the Weird' do          
+          @weird.should_not be_nil
+        end
+
+        it 'has the correct start' do          
+          @weird['Start'].should == 11
+        end
+
+        it 'has a 0 duration because start time is greater than end time' do          
+          @weird['Duration'].should == 0
+        end
+      end      
+
+      describe "differentFormat" do
+        before do
+          @diff = @client['Timings'].find {|t| t["Name"] == "differentFormat"}
+        end
+
+        it 'has a Timing for the differentFormat' do          
+          @diff.should_not be_nil
+        end
+
+        it 'has the correct start' do          
+          @diff['Start'].should == 1
+        end
+
+        it 'has a -1 duration because the format was different' do          
+          @diff['Duration'].should == -1
+        end
+      end
+
+    end
+
+
+
+  end
+
+
+end

data/spec/components/file_store_spec.rb

@@ -0,0 +1,47 @@
+
+require 'spec_helper'
+require 'rack-mini-profiler'
+require 'mini_profiler/page_timer_struct'
+require 'mini_profiler/storage/abstract_store'
+require 'mini_profiler/storage/file_store'
+
+describe Rack::MiniProfiler::FileStore do
+
+  context 'page struct' do
+
+    before do
+      tmp = File.expand_path(__FILE__ + "/../../../tmp")
+      Dir::mkdir(tmp) unless File.exists?(tmp)
+      @store = Rack::MiniProfiler::FileStore.new(:path => tmp) 
+    end
+
+    describe 'storage' do
+
+      it 'can store a PageStruct and retrieve it' do
+        page_struct = Rack::MiniProfiler::PageTimerStruct.new({})
+        page_struct['Id'] = "XYZ"
+        page_struct['Random'] = "random"
+        @store.save(page_struct)
+        page_struct = @store.load("XYZ")
+        page_struct['Random'].should == "random"
+        page_struct['Id'].should == "XYZ"
+      end    
+
+      it 'can list unviewed items for a user' do 
+        @store.set_unviewed('a', 'XYZ')
+        @store.set_unviewed('a', 'ABC')
+        @store.get_unviewed_ids('a').sort.to_a.should == ['XYZ', 'ABC'].sort.to_a
+      end
+
+      it 'can set an item to viewed once it is unviewed' do 
+        @store.set_unviewed('a', 'XYZ')
+        @store.set_unviewed('a', 'ABC')
+        @store.set_viewed('a', 'XYZ')
+        @store.get_unviewed_ids('a').should == ['ABC']
+      end
+
+    end
+
+  end
+
+end

data/spec/components/memory_store_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'mini_profiler/storage/abstract_store'
+require 'mini_profiler/storage/memory_store'
+
+describe Rack::MiniProfiler::MemoryStore do
+
+  context 'page struct' do
+
+    before do
+      @store = Rack::MiniProfiler::MemoryStore.new nil
+    end
+
+    describe 'storage' do
+
+      it 'can store a PageStruct and retrieve it' do
+        page_struct = {'Id' => "XYZ", 'Random' => "random"}
+        @store.save(page_struct)
+        page_struct = @store.load("XYZ")
+        page_struct['Id'].should == "XYZ"
+        page_struct['Random'].should == "random"
+      end    
+
+      it 'can list unviewed items for a user' do 
+        @store.set_unviewed('a', 'XYZ')
+        @store.set_unviewed('a', 'ABC')
+        @store.get_unviewed_ids('a').should == ['XYZ', 'ABC']
+      end
+
+      it 'can set an item to viewed once it is unviewed' do 
+        @store.set_unviewed('a', 'XYZ')
+        @store.set_unviewed('a', 'ABC')
+        @store.set_viewed('a', 'XYZ')
+        @store.get_unviewed_ids('a').should == ['ABC']
+      end
+
+    end
+
+  end
+
+end

data/spec/components/page_timer_struct_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'rack-mini-profiler'
+
+describe Rack::MiniProfiler::PageTimerStruct do
+
+  before do
+    @page = Rack::MiniProfiler::PageTimerStruct.new({})
+  end
+
+  it 'has an Id' do
+    @page['Id'].should_not be_nil
+  end
+
+  it 'has a Root' do
+    @page['Root'].should_not be_nil
+  end
+
+  describe 'to_json' do
+    before do
+      @json = @page.to_json
+      @deserialized = ::JSON.parse(@json)
+    end
+
+    it 'has a Started element' do
+      @deserialized['Started'].should_not be_nil
+    end
+
+    it 'has a DurationMilliseconds element' do
+      @deserialized['DurationMilliseconds'].should_not be_nil
+    end
+  end
+  
+end

data/spec/components/profiler_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'rack-mini-profiler'
+
+describe Rack::MiniProfiler do
+
+  describe 'unique id' do
+
+    before do
+      @unique = Rack::MiniProfiler.generate_id
+    end
+
+    it 'is not nil' do
+      @unique.should_not be_nil
+    end
+
+    it 'is not empty' do
+      @unique.should_not be_empty
+    end
+
+    describe 'configuration' do
+
+      it 'allows us to set configuration settings' do
+        Rack::MiniProfiler.config.auto_inject = false
+        Rack::MiniProfiler.config.auto_inject.should == false
+      end
+
+      it 'can reset the settings' do
+        Rack::MiniProfiler.config.auto_inject = false
+        Rack::MiniProfiler.reset_config
+        Rack::MiniProfiler.config.auto_inject.should be_true
+      end
+
+      describe 'base_url_path' do
+        it 'adds a trailing slash onto the base_url_path' do
+          profiler = Rack::MiniProfiler.new(nil, :base_url_path => "/test-resource")
+          profiler.config.base_url_path.should == "/test-resource/"
+        end
+
+        it "doesn't add the trailing slash when it's already there" do
+          profiler = Rack::MiniProfiler.new(nil, :base_url_path => "/test-resource/")
+          profiler.config.base_url_path.should == "/test-resource/"
+        end
+
+      end      
+
+    end
+  end
+
+  describe 'profile method' do 
+    before do 
+      Rack::MiniProfiler.create_current
+      class TestClass
+        def foo(bar,baz)
+          return [bar, baz, yield]
+        end
+      end
+    end
+
+    it 'should not destroy a method' do 
+      Rack::MiniProfiler.profile_method TestClass, :foo
+      TestClass.new.foo("a","b"){"c"}.should == ["a","b","c"]
+      Rack::MiniProfiler.unprofile_method TestClass, :foo
+    end
+
+  end
+
+  describe 'step' do
+
+    describe 'basic usage' do 
+      it 'yields the block given' do 
+        Rack::MiniProfiler.create_current
+        Rack::MiniProfiler.step('test') { "mini profiler" }.should == "mini profiler"
+      end
+    end
+
+
+    describe 'typical usage' do
+      before(:all) do
+        Rack::MiniProfiler.create_current
+        Time.now = Time.new
+        Time.now += 1
+        Rack::MiniProfiler.step('outer') {
+          Time.now +=  2 
+          Rack::MiniProfiler.step('inner') { 
+            Time.now += 3 
+          }
+          Time.now += 4 
+        }
+        @page_struct = Rack::MiniProfiler.current.page_struct
+        @root = @page_struct.root
+        @root.record_time
+
+        @outer = @page_struct.root.children[0]
+        @inner = @outer.children[0]
+      end
+
+      after(:all) do
+        Time.back_to_normal
+      end
+
+      it 'measures total duration correctly' do 
+        @page_struct.duration_ms.to_i.should == 10 * 1000
+      end
+
+      it 'measures outer start time correctly' do
+        @outer.start_ms.to_i.should == 1 * 1000
+      end
+
+      it 'measures outer duration correctly' do
+        @outer.duration_ms.to_i.should == 9 * 1000
+      end
+      
+      it 'measures inner start time correctly' do 
+        @inner.start_ms.to_i.should == 3 * 1000
+      end
+
+      it 'measures inner duration correctly' do 
+        @inner.duration_ms.to_i.should == 3 * 1000
+      end
+
+    end
+
+  end
+
+end
+

data/spec/components/redis_store_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'rack-mini-profiler'
+require 'mini_profiler/page_timer_struct'
+require 'mini_profiler/storage/abstract_store'
+require 'mini_profiler/storage/redis_store'
+
+describe Rack::MiniProfiler::RedisStore do
+
+  context 'page struct' do
+
+    before do
+      @store = Rack::MiniProfiler::RedisStore.new(nil)
+    end
+
+    describe 'storage' do
+
+      it 'can store a PageStruct and retrieve it' do
+        page_struct = Rack::MiniProfiler::PageTimerStruct.new({})
+        page_struct['Id'] = "XYZ"
+        page_struct['Random'] = "random"
+        @store.save(page_struct)
+        page_struct = @store.load("XYZ")
+        page_struct['Random'].should == "random"
+        page_struct['Id'].should == "XYZ"
+      end    
+
+      it 'can list unviewed items for a user' do 
+        @store.set_unviewed('a', 'XYZ')
+        @store.set_unviewed('a', 'ABC')
+        @store.get_unviewed_ids('a').should == ['XYZ', 'ABC']
+      end
+
+      it 'can set an item to viewed once it is unviewed' do 
+        @store.set_unviewed('a', 'XYZ')
+        @store.set_unviewed('a', 'ABC')
+        @store.set_viewed('a', 'XYZ')
+        @store.get_unviewed_ids('a').should == ['ABC']
+      end
+
+    end
+
+  end
+
+end

data/spec/components/request_timer_struct_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+require 'rack-mini-profiler'
+
+describe Rack::MiniProfiler::RequestTimerStruct do
+
+  def new_page
+    Rack::MiniProfiler::PageTimerStruct.new({})
+  end
+
+  before do
+    @name = 'cool request'
+    @request = Rack::MiniProfiler::RequestTimerStruct.createRoot(@name, new_page)
+  end
+
+  it 'sets IsRoot to true' do
+    @request['IsRoot'].should be_true
+  end
+
+  it 'has an Id' do
+    @request['Id'].should_not be_nil
+  end
+
+  it 'has a Root' do
+    @request['Name'].should == @name
+  end
+
+  it 'begins with a children duration of 0' do
+    @request.children_duration.should == 0
+  end
+
+  it 'has a false HasChildren attribute' do
+    @request['HasChildren'].should be_false
+  end
+
+  it 'has an empty Children attribute' do
+    @request['Children'].should be_empty
+  end
+
+  it 'has a depth of 0' do
+    @request['Depth'].should == 0
+  end
+
+  it 'has a false HasSqlTimings attribute' do
+    @request['HasSqlTimings'].should be_false
+  end
+
+  it 'has no sql timings at first' do
+    @request['SqlTimings'].should be_empty    
+  end
+
+  it 'has a 0 for SqlTimingsDurationMilliseconds' do
+    @request['SqlTimingsDurationMilliseconds'].should == 0
+  end
+
+  describe 'add SQL' do
+
+    before do
+      @page = new_page
+      @request.add_sql("SELECT 1 FROM users", 77, @page)
+    end
+
+    it 'has a true HasSqlTimings attribute' do
+      @request['HasSqlTimings'].should be_true
+    end
+
+    it 'has the SqlTiming object' do
+      @request['SqlTimings'].should_not be_empty  
+    end
+
+    it 'has a child with the ParentTimingId of the request' do
+      @request['SqlTimings'][0]['ParentTimingId'].should == @request['Id']
+    end
+
+    it 'increases SqlTimingsDurationMilliseconds' do
+      @request['SqlTimingsDurationMilliseconds'].should == 77
+    end
+
+    it "increases the page's " do
+      @page['DurationMillisecondsInSql'].should == 77
+    end
+
+  end
+
+  describe 'record time' do
+
+    describe 'add children' do
+
+      before do
+        @child = @request.add_child('child')
+        @child.record_time(1111)        
+      end
+
+      it 'has a IsRoot value of false' do
+        @child['IsRoot'].should be_false
+      end
+
+      it 'has a true HasChildren attribute' do
+        @request['HasChildren'].should be_true
+      end
+
+      it 'has the child in the Children attribute' do
+        @request['Children'].should == [@child]
+      end      
+
+      it 'assigns its Id to the child' do
+        @child['ParentTimingId'].should == @request['Id']
+      end
+
+      it 'assigns a depth of 1 to the child' do
+        @child['Depth'].should == 1
+      end
+
+      it 'increases the children duration' do
+        @request.children_duration.should == 1111
+      end
+
+      it 'marks short timings as trivial' do
+        @request.record_time(1)
+        @request['IsTrivial'].should be_true
+      end
+
+      
+      describe 'record time on parent' do
+        before do
+          @request.record_time(1234)
+        end
+
+        it "is not a trivial query" do
+          @request['IsTrivial'].should be_false
+        end
+
+        it 'has stores the recorded time in DurationMilliseconds' do
+          @request['DurationMilliseconds'].should == 1234
+        end
+        
+        it 'calculates DurationWithoutChildrenMilliseconds without the children timings' do
+          @request['DurationWithoutChildrenMilliseconds'].should == 123      
+        end
+
+      end
+
+    end
+
+
+  end
+
+
+end

data/spec/components/sql_timer_struct_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'rack-mini-profiler'
+
+describe Rack::MiniProfiler::SqlTimerStruct do
+
+  describe 'valid sql timer' do
+    before do
+      @sql = Rack::MiniProfiler::SqlTimerStruct.new("SELECT * FROM users", 200, Rack::MiniProfiler::PageTimerStruct.new({}), nil)
+    end
+
+    it 'has an ExecuteType' do
+      @sql['ExecuteType'].should_not be_nil
+    end
+
+    it 'has a FormattedCommandString' do
+      @sql['FormattedCommandString'].should_not be_nil
+    end
+
+    it 'has a StackTraceSnippet' do
+      @sql['StackTraceSnippet'].should_not be_nil
+    end  
+
+    it 'has a StartMilliseconds' do
+      @sql['StartMilliseconds'].should_not be_nil
+    end   
+
+    it 'has a DurationMilliseconds' do
+      @sql['DurationMilliseconds'].should_not be_nil
+    end 
+
+    it 'has a IsDuplicate' do
+      @sql['IsDuplicate'].should_not be_nil
+    end       
+  end
+
+
+  
+  describe 'backtrace' do
+    it 'has a snippet' do
+      sql = Rack::MiniProfiler::SqlTimerStruct.new("SELECT * FROM users", 200, Rack::MiniProfiler::PageTimerStruct.new({}), nil)
+      sql['StackTraceSnippet'].should_not be nil
+    end
+
+    it 'includes rspec in the trace (default is no filter)' do
+      sql = Rack::MiniProfiler::SqlTimerStruct.new("SELECT * FROM users", 200, Rack::MiniProfiler::PageTimerStruct.new({}), nil)
+      sql['StackTraceSnippet'].should match /rspec/
+    end
+
+    it "doesn't include rspec if we filter for only app" do
+      Rack::MiniProfiler.config.backtrace_filter = /\/app/
+      sql = Rack::MiniProfiler::SqlTimerStruct.new("SELECT * FROM users", 200, Rack::MiniProfiler::PageTimerStruct.new({}), nil)
+      sql['StackTraceSnippet'].should_not match /rspec/
+    end
+
+    it "includes rspec if we filter for it" do
+      Rack::MiniProfiler.config.backtrace_filter = /\/(app|rspec)/
+      sql = Rack::MiniProfiler::SqlTimerStruct.new("SELECT * FROM users", 200, Rack::MiniProfiler::PageTimerStruct.new({}), nil)
+      sql['StackTraceSnippet'].should match /rspec/
+    end
+
+  end
+
+end