request-log-analyzer 1.3.5 → 1.4.0

data/spec/unit/tracker/tracker_api_spec.rb

@@ -1,49 +1,124 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 
-describe RequestLogAnalyzer::Tracker::Base, "API test" do
+describe RequestLogAnalyzer::Tracker::Base do
 
-  before(:each) do
-    @tracker    = Class.new(RequestLogAnalyzer::Tracker::Base).new
-    
-    @summarizer = RequestLogAnalyzer::Aggregator::Summarizer.new(mock_source)
-    @summarizer.trackers << @tracker
-  end
-    
-  it "should receive :prepare when the summarizer is preparing" do
-    @tracker.should_receive(:prepare).once    
-    @summarizer.prepare
-  end
-  
-  it "should receieve :finalize when the summarizer is finalizing" do
-    @tracker.should_receive(:finalize).once    
-    @summarizer.finalize    
-  end
-  
-  it "should receive :update for every request for which should_update? returns true" do
-    @tracker.should_receive(:should_update?).twice.and_return(true)
-    @tracker.should_receive(:update).twice
-    
-    @summarizer.aggregate(testing_format.request(:field => 'value1'))
-    @summarizer.aggregate(testing_format.request(:field => 'value2'))    
-  end
-  
-  it "should not :update for every request for which should_update? returns false" do
-    @tracker.should_receive(:should_update?).twice.and_return(false)
-    @tracker.should_not_receive(:update)
-    
-    @summarizer.aggregate(testing_format.request(:field => 'value1'))
-    @summarizer.aggregate(testing_format.request(:field => 'value2'))    
+  describe 'API' do
+
+    before(:each) do
+      @tracker    = Class.new(RequestLogAnalyzer::Tracker::Base).new
+
+      @summarizer = RequestLogAnalyzer::Aggregator::Summarizer.new(mock_source)
+      @summarizer.trackers << @tracker
+    end
+
+    it "should receive :prepare when the summarizer is preparing" do
+      @tracker.should_receive(:prepare).once
+      @summarizer.prepare
+    end
+
+    it "should receive :update for every request for which should_update? returns true" do
+      @tracker.should_receive(:should_update?).twice.and_return(true)
+      @tracker.should_receive(:update).twice
+
+      @summarizer.aggregate(testing_format.request(:field => 'value1'))
+      @summarizer.aggregate(testing_format.request(:field => 'value2'))
+    end
+
+    it "should not :update for every request for which should_update? returns false" do
+      @tracker.should_receive(:should_update?).twice.and_return(false)
+      @tracker.should_not_receive(:update)
+
+      @summarizer.aggregate(testing_format.request(:field => 'value1'))
+      @summarizer.aggregate(testing_format.request(:field => 'value2'))
+    end
+
+    it "should receive :report when the summary report is being built" do
+      @tracker.should_receive(:report).with(anything).once
+      @summarizer.report(mock_output)
+    end
+
+    it "should receieve :finalize when the summarizer is finalizing" do
+      @tracker.should_receive(:finalize).once
+      @summarizer.finalize
+    end
   end
-  
-  it "should receive :report when the summary report is being built" do
-    @tracker.should_receive(:report).with(anything).once   
-    @summarizer.report(mock_output) 
+
+  describe '#should_update?' do
+    before(:each) do
+      @tracker_class = Class.new(RequestLogAnalyzer::Tracker::Base)
+    end
+
+    it "should return true by default, when no checks are installed" do
+      tracker = @tracker_class.new
+      tracker.should_update?(testing_format.request).should be_true
+    end
+
+    it "should return false if the line type is not in the request" do
+      tracker = @tracker_class.new(:line_type => :not_there)
+      tracker.should_update?(request(:line_type => :different)).should be_false
+    end
+
+    it "should return true if the line type is in the request" do
+      tracker = @tracker_class.new(:line_type => :there)
+      tracker.should_update?(request(:line_type => :there)).should be_true
+    end
+
+    it "should return true if a field name is given to :if and it is in the request" do
+      tracker = @tracker_class.new(:if => :field)
+      tracker.should_update?(request(:field => 'anything')).should be_true
+    end
+
+    it "should return false if a field name is given to :if and it is not the request" do
+      tracker = @tracker_class.new(:if => :field)
+      tracker.should_update?(request(:other_field => 'anything')).should be_false
+    end
+
+    it "should return false if a field name is given to :unless and it is in the request" do
+      tracker = @tracker_class.new(:unless => :field)
+      tracker.should_update?(request(:field => 'anything')).should be_false
+    end
+
+    it "should return true if a field name is given to :unless and it is not the request" do
+      tracker = @tracker_class.new(:unless => :field)
+      tracker.should_update?(request(:other_field => 'anything')).should be_true
+    end
+
+    it "should return the value of the block if one is given to the :if option" do
+      tracker = @tracker_class.new(:if => lambda { false } )
+      tracker.should_update?(request(:field => 'anything')).should be_false
+    end
+
+    it "should return the inverse value of the block if one is given to the :if option" do
+      tracker = @tracker_class.new(:unless => lambda { false } )
+      tracker.should_update?(request(:field => 'anything')).should be_true
+    end
+
+    it "should return false if any of the checks fail" do
+      tracker = @tracker_class.new(:if => :field, :unless => lambda { false }, :line_type => :not_present )
+      tracker.should_update?(request(:line_type => :present, :field => 'anything')).should be_false
+    end
+
+    it "should return true if all of the checks succeed" do
+      tracker = @tracker_class.new(:if => :field, :unless => lambda { false }, :line_type => :present )
+      tracker.should_update?(request(:line_type => :present, :field => 'anything')).should be_true
+    end
+
+
   end
-  
-  it "should receive :to_yaml object when finalizing" do
-    @summarizer.options[:dump] = temp_output_file(:dump)
-    @tracker.should_receive(:to_yaml_object).once
-    @summarizer.to_yaml
+
+  describe '#to_yaml_object' do
+
+    before(:each) do
+      @tracker    = Class.new(RequestLogAnalyzer::Tracker::Base).new
+
+      @summarizer = RequestLogAnalyzer::Aggregator::Summarizer.new(mock_source)
+      @summarizer.trackers << @tracker
+    end
+
+    it "should receive :to_yaml object when finalizing" do
+      @summarizer.options[:dump] = temp_output_file(:dump)
+      @tracker.should_receive(:to_yaml_object).once
+      @summarizer.to_yaml
+    end
   end
-  
 end

data/spec/unit/tracker/traffic_tracker_spec.rb

@@ -1,105 +1,107 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe RequestLogAnalyzer::Tracker::Traffic do
-  
+
+  context 'using a field-based category' do
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::Traffic.new(:traffic => :traffic, :category => :category)
+      @tracker.prepare
+
+      @tracker.update(request(:category => 'a', :traffic => 1))
+      @tracker.update(request(:category => 'b', :traffic => 2))
+      @tracker.update(request(:category => 'b', :traffic => 3))
+    end
+
+    it "should register a request in the right category using the category field" do
+      @tracker.categories.should include('a', 'b')
+    end
+
+    it "should register requests under the correct category" do
+      @tracker.hits('a').should == 1
+      @tracker.hits('b').should == 2
+    end
+  end
+
+  context 'using a dynamic category' do
+
+    before(:each) do
+      @categorizer = lambda { |request| request[:traffic] < 2 ? 'few' : 'lots' }
+      @tracker = RequestLogAnalyzer::Tracker::Traffic.new(:traffic => :traffic, :category => @categorizer)
+      @tracker.prepare
+
+      @tracker.update(request(:category => 'a', :traffic => 1))
+      @tracker.update(request(:category => 'b', :traffic => 2))
+      @tracker.update(request(:category => 'b', :traffic => 3))
+    end
+
+    it "should use the categorizer to determine the category" do
+      @tracker.categories.should include('few', 'lots')
+    end
+
+    it "should register requests under the correct category using the categorizer" do
+      @tracker.hits('few').should  == 1
+      @tracker.hits('lots').should == 2
+    end
+  end
+
   describe '#update' do
-    
-    context 'using a field-based category' do
-      before(:each) do
-        @tracker = RequestLogAnalyzer::Tracker::Traffic.new(:traffic => :traffic, :category => :category)
-        @tracker.prepare
-      end
-    
-      it "should register a request in the right category" do
-        @tracker.update(request(:category => 'a', :traffic => 200))
-        @tracker.categories.should include('a')
-      end
-    
-      it "should register a hit in the right category" do
-        @tracker.update(request(:category => 'a', :traffic => 1))
-        @tracker.update(request(:category => 'b', :traffic => 2))
-        @tracker.update(request(:category => 'b', :traffic => 3))
-      
-        @tracker.hits('a').should == 1
-        @tracker.hits('b').should == 2
-      end
-    
-      it "should sum the traffics of the same category as cumulative traffic" do
-        @tracker.update(request(:category => 'a', :traffic => 1))
-        @tracker.update(request(:category => 'b', :traffic => 2))
-        @tracker.update(request(:category => 'b', :traffic => 3))
-      
-        @tracker.cumulative_traffic('a').should == 1
-        @tracker.cumulative_traffic('b').should == 5
-      end
-    
-      it "should calculate the average traffic correctly" do
-        @tracker.update(request(:category => 'a', :traffic => 1))
-        @tracker.update(request(:category => 'b', :traffic => 2))
-        @tracker.update(request(:category => 'b', :traffic => 3))
-      
-        @tracker.average_traffic('a').should == 1.0
-        @tracker.average_traffic('b').should == 2.5
-      end
-    
-      it "should set min and max traffic correctly" do
-        @tracker.update(request(:category => 'a', :traffic => 1))
-        @tracker.update(request(:category => 'b', :traffic => 2))
-        @tracker.update(request(:category => 'b', :traffic => 3))
-      
-        @tracker.min_traffic('b').should == 2
-        @tracker.max_traffic('b').should == 3
-      end  
-    
-    end
-  
-    context 'using a dynamic category' do
-      before(:each) do
-        @categorizer = Proc.new { |request| request[:traffic] < 2 ? 'few' : 'lots' }
-        @tracker = RequestLogAnalyzer::Tracker::Traffic.new(:traffic => :traffic, :category => @categorizer)
-        @tracker.prepare
-      end
-    
-      it "should use the categorizer to determine the right category" do
-        @tracker.update(request(:category => 'a', :traffic => 1))
-        @tracker.update(request(:category => 'b', :traffic => 2))
-        @tracker.update(request(:category => 'b', :traffic => 3))
-      
-        @tracker.categories.should include('few', 'lots')
-      end
-    
-      it "should use the categorizer to aggregate the values correctly" do
-        @tracker.update(request(:category => 'a', :traffic => 1))
-        @tracker.update(request(:category => 'b', :traffic => 2))
-        @tracker.update(request(:category => 'b', :traffic => 3))
-      
-        @tracker.max_traffic('few').should == 1
-        @tracker.min_traffic('lots').should == 2
-      end
+
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::Traffic.new(:traffic => :traffic, :category => :category)
+      @tracker.prepare
+
+      @tracker.update(request(:category => 'a', :traffic => 2))
+      @tracker.update(request(:category => 'a', :traffic => 1))
+      @tracker.update(request(:category => 'a', :traffic => 3))
+    end
+
+    it "should calculate the total traffic correctly" do
+      @tracker.sum('a').should == 6
+    end
+
+    it "should calculate the traffic variance correctly" do
+      @tracker.variance('a').should == 1.0
+    end
+
+    it "should calculate the traffic standard deviation correctly" do
+      @tracker.stddev('a').should == 1.0
+    end
+
+    it "should calculate the average traffic correctly" do
+      @tracker.mean('a').should == 2.0
+    end
+
+    it "should calculate the overall mean traffic correctly" do
+      @tracker.mean_overall.should == 2.0
+    end
+
+    it "should set min and max traffic correctly" do
+      @tracker.min('a').should == 1
+      @tracker.max('a').should == 3
     end
   end
-  
+
   describe '#report' do
     before(:each) do
       @tracker = RequestLogAnalyzer::Tracker::Traffic.new(:category => :category, :traffic => :traffic)
       @tracker.prepare
     end
-    
+
     it "should generate a report without errors when one category is present" do
       @tracker.update(request(:category => 'a', :traffic => 2))
       @tracker.report(mock_output)
       lambda { @tracker.report(mock_output) }.should_not raise_error
     end
-  
+
     it "should generate a report without errors when no category is present" do
       lambda { @tracker.report(mock_output) }.should_not raise_error
     end
-  
+
     it "should generate a report without errors when multiple categories are present" do
       @tracker.update(request(:category => 'a', :traffic => 2))
       @tracker.update(request(:category => 'b', :traffic => 2))
       lambda { @tracker.report(mock_output) }.should_not raise_error
     end
-    
+
   end
 end