request-log-analyzer 1.3.7 → 1.4.0

data/spec/unit/tracker/tracker_api_spec.rb

@@ -3,14 +3,14 @@ require File.dirname(__FILE__) + '/../../spec_helper'
 describe RequestLogAnalyzer::Tracker::Base do
 
   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
@@ -33,8 +33,8 @@ describe RequestLogAnalyzer::Tracker::Base do
     end
 
     it "should receive :report when the summary report is being built" do
-      @tracker.should_receive(:report).with(anything).once   
-      @summarizer.report(mock_output) 
+      @tracker.should_receive(:report).with(anything).once
+      @summarizer.report(mock_output)
     end
 
     it "should receieve :finalize when the summarizer is finalizing" do
@@ -42,27 +42,27 @@ describe RequestLogAnalyzer::Tracker::Base do
       @summarizer.finalize
     end
   end
-  
+
   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
@@ -103,18 +103,18 @@ describe RequestLogAnalyzer::Tracker::Base do
       tracker.should_update?(request(:line_type => :present, :field => 'anything')).should be_true
     end
 
-  
+
   end
-  
+
   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

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

data/tasks/github-gem.rake

@@ -5,26 +5,30 @@ require 'date'
 require 'git'
 
 module GithubGem
-  
+
+  # Detects the gemspc file of this project using heuristics.
   def self.detect_gemspec_file
     FileList['*.gemspec'].first
   end
-  
+
+  # Detects the main include file of this project using heuristics
   def self.detect_main_include
     if detect_gemspec_file =~ /^(\.*)\.gemspec$/ && File.exist?("lib/#{$1}.rb")
       "lib/#{$1}.rb"
     elsif FileList['lib/*.rb'].length == 1
       FileList['lib/*.rb'].first
     else
-      raise "Could not detect main include file!"
+      nil
     end
   end
-  
+
   class RakeTasks
-    
+
     attr_reader   :gemspec, :modified_files, :git
     attr_accessor :gemspec_file, :task_namespace, :main_include, :root_dir, :spec_pattern, :test_pattern, :remote, :remote_branch, :local_branch
-    
+
+    # Initializes the settings, yields itself for configuration
+    # and defines the rake tasks based on the gemspec file.
     def initialize(task_namespace = :gem)
       @gemspec_file   = GithubGem.detect_gemspec_file
       @task_namespace = task_namespace
@@ -36,17 +40,17 @@ module GithubGem
       @local_branch   = 'master'
       @remote         = 'origin'
       @remote_branch  = 'master'
-      
-      
+
       yield(self) if block_given?
 
-      @git = Git.open(@root_dir)      
-      load_gemspec!      
+      @git = Git.open(@root_dir)
+      load_gemspec!
       define_tasks!
     end
-    
+
     protected
-    
+
+    # Define Unit test tasks
     def define_test_tasks!
       require 'rake/testtask'
 
@@ -57,11 +61,12 @@ module GithubGem
           t.libs << 'test'
         end
       end
-      
+
       desc "Run all unit tests for #{gemspec.name}"
       task(:test => ['test:basic'])
     end
-    
+
+    # Defines RSpec tasks
     def define_rspec_tasks!
       require 'spec/rake/spectask'
 
@@ -70,204 +75,249 @@ module GithubGem
         Spec::Rake::SpecTask.new(:basic) do |t|
           t.spec_files = FileList[spec_pattern]
         end
-        
+
         desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
         Spec::Rake::SpecTask.new(:specdoc) do |t|
           t.spec_files = FileList[spec_pattern]
           t.spec_opts << '--format' << 'specdoc' << '--color'
         end
-        
+
         desc "Run RCov on specs for #{gemspec.name}"
         Spec::Rake::SpecTask.new(:rcov) do |t|
           t.spec_files = FileList[spec_pattern]
           t.rcov = true
-          t.rcov_opts = ['--exclude', '"spec/*,gems/*"', '--rails']          
-        end          
+          t.rcov_opts = ['--exclude', '"spec/*,gems/*"', '--rails']
+        end
       end
-      
+
       desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
-      task(:spec => ['spec:specdoc'])      
+      task(:spec => ['spec:specdoc'])
     end
-    
+
     # Defines the rake tasks
     def define_tasks!
-      
+
       define_test_tasks!  if has_tests?
       define_rspec_tasks! if has_specs?
-      
+
       namespace(@task_namespace) do
         desc "Updates the filelist in the gemspec file"
-        task(:manifest) { manifest_task } 
-        
+        task(:manifest) { manifest_task }
+
         desc "Builds the .gem package"
         task(:build => :manifest) { build_task }
 
         desc "Sets the version of the gem in the gemspec"
         task(:set_version => [:check_version, :check_current_branch]) { version_task }
-        task(:check_version => :fetch_origin) { check_version_task }      
-        
+        task(:check_version => :fetch_origin) { check_version_task }
+
         task(:fetch_origin) { fetch_origin_task }
-        task(:check_current_branch) { check_current_branch_task }        
+        task(:check_current_branch) { check_current_branch_task }
         task(:check_clean_status) { check_clean_status_task }
         task(:check_not_diverged => :fetch_origin) { check_not_diverged_task }
-        
+
         checks = [:check_current_branch, :check_clean_status, :check_not_diverged, :check_version]
         checks.unshift('spec:basic') if has_specs?
         checks.unshift('test:basic') if has_tests?
         checks.push << [:check_rubyforge] if gemspec.rubyforge_project
-                
+
         desc "Perform all checks that would occur before a release"
-        task(:release_checks => checks) 
+        task(:release_checks => checks)
 
         release_tasks = [:release_checks, :set_version, :build, :github_release]
         release_tasks << [:rubyforge_release] if gemspec.rubyforge_project
-        
+
         desc "Release a new verison of the gem"
         task(:release => release_tasks) { release_task }
-        
+
         task(:check_rubyforge)   { check_rubyforge_task }
         task(:rubyforge_release) { rubyforge_release_task }
         task(:github_release => [:commit_modified_files, :tag_version]) { github_release_task }
         task(:tag_version) { tag_version_task }
         task(:commit_modified_files) { commit_modified_files_task }
+
+        desc "Updates the gem release tasks with the latest version on Github"
+        task(:update_tasks) { update_tasks_task }
       end
     end
-    
+
+    # Updates the files list and test_files list in the gemspec file using the list of files
+    # in the repository and the spec/test file pattern.
     def manifest_task
       # Load all the gem's files using "git ls-files"
       repository_files = git.ls_files.keys
       test_files       = Dir[test_pattern] + Dir[spec_pattern]
-      
+
       update_gemspec(:files, repository_files)
       update_gemspec(:test_files, repository_files & test_files)
     end
-    
+
+    # Builds the gem
     def build_task
       sh "gem build -q #{gemspec_file}"
       Dir.mkdir('pkg') unless File.exist?('pkg')
-      sh "mv #{gemspec.name}-#{gemspec.version}.gem pkg/#{gemspec.name}-#{gemspec.version}.gem" 
+      sh "mv #{gemspec.name}-#{gemspec.version}.gem pkg/#{gemspec.name}-#{gemspec.version}.gem"
     end
-    
+
+    # Updates the version number in the gemspec file, the VERSION constant in the main
+    # include file and the contents of the VERSION file.
     def version_task
       update_gemspec(:version, ENV['VERSION']) if ENV['VERSION']
       update_gemspec(:date, Date.today)
-      
+
       update_version_file(gemspec.version)
       update_version_constant(gemspec.version)
     end
-    
+
     def check_version_task
       raise "#{ENV['VERSION']} is not a valid version number!" if ENV['VERSION'] && !Gem::Version.correct?(ENV['VERSION'])
       proposed_version = Gem::Version.new(ENV['VERSION'] || gemspec.version)
       # Loads the latest version number using the created tags
-      newest_version   = git.tags.map { |tag| tag.name.split('-').last }.compact.map { |v| Gem::Version.new(v) }.max      
+      newest_version   = git.tags.map { |tag| tag.name.split('-').last }.compact.map { |v| Gem::Version.new(v) }.max
       raise "This version (#{proposed_version}) is not higher than the highest tagged version (#{newest_version})" if newest_version && newest_version >= proposed_version
     end
-    
+
+    # Checks whether the current branch is not diverged from the remote branch
     def check_not_diverged_task
-      raise "The current branch is diverged from the remote branch!" if git.log.between('HEAD', git.branches["#{remote}/#{remote_branch}"].gcommit).any?
+      raise "The current branch is diverged from the remote branch!" if git.log.between('HEAD', git.remote(remote).branch(remote_branch).gcommit).any?
     end
-    
+
+    # Checks whether the repository status ic clean
     def check_clean_status_task
-      #raise "The current working copy contains modifications" if git.status.changed.any?
+      raise "The current working copy contains modifications" if git.status.changed.any?
     end
-    
+
+    # Checks whether the current branch is correct
     def check_current_branch_task
       raise "Currently not on #{local_branch} branch!" unless git.branch.name == local_branch.to_s
     end
-    
+
+    # Fetches the latest updates from Github
     def fetch_origin_task
       git.fetch('origin')
     end
-    
+
+    # Commits every file that has been changed by the release task.
     def commit_modified_files_task
       if modified_files.any?
         modified_files.each { |file| git.add(file) }
         git.commit("Released #{gemspec.name} gem version #{gemspec.version}")
       end
     end
-    
+
+    # Adds a tag for the released version
     def tag_version_task
       git.add_tag("#{gemspec.name}-#{gemspec.version}")
     end
-    
+
+    # Pushes the changes and tag to github
     def github_release_task
       git.push(remote, remote_branch, true)
     end
-    
+
+    # Checks whether Rubyforge is configured properly
     def check_rubyforge_task
-      raise "Could not login on rubyforge!" unless `rubyforge login 2>&1`.strip.empty?
+      # Login no longer necessary when using rubyforge 2.0.0 gem
+      # raise "Could not login on rubyforge!" unless `rubyforge login 2>&1`.strip.empty?
       output = `rubyforge names`.split("\n")
       raise "Rubyforge group not found!"   unless output.any? { |line| %r[^groups\s*\:.*\b#{Regexp.quote(gemspec.rubyforge_project)}\b.*] =~ line }
-      raise "Rubyforge package not found!" unless output.any? { |line| %r[^packages\s*\:.*\b#{Regexp.quote(gemspec.name)}\b.*] =~ line }      
+      raise "Rubyforge package not found!" unless output.any? { |line| %r[^packages\s*\:.*\b#{Regexp.quote(gemspec.name)}\b.*] =~ line }
     end
-    
+
+    # Task to release the .gem file toRubyforge.
     def rubyforge_release_task
       sh 'rubyforge', 'add_release', gemspec.rubyforge_project, gemspec.name, gemspec.version.to_s, "pkg/#{gemspec.name}-#{gemspec.version}.gem"
     end
-    
+
+    # Gem release task.
+    # All work is done by the task's dependencies, so just display a release completed message.
     def release_task
       puts
       puts '------------------------------------------------------------'
       puts "Released #{gemspec.name} version #{gemspec.version}"
     end
-    
+
     private
-    
+
+    # Checks whether this project has any RSpec files
     def has_specs?
       FileList[spec_pattern].any?
     end
-    
+
+    # Checks whether this project has any unit test files
     def has_tests?
       FileList[test_pattern].any?
     end
-    
-    
+
     # Loads the gemspec file
     def load_gemspec!
       @gemspec = eval(File.read(@gemspec_file))
     end
-    
+
     # Updates the VERSION file with the new version
     def update_version_file(version)
       if File.exists?('VERSION')
-        File.open('VERSION', 'w') { |f| f << version.to_s } 
+        File.open('VERSION', 'w') { |f| f << version.to_s }
         modified_files << 'VERSION'
       end
     end
-    
+
     # Updates the VERSION constant in the main include file if it exists
     def update_version_constant(version)
-     file_contents = File.read(main_include)
-     if file_contents.sub!(/^(\s+VERSION\s*=\s*)[^\s].*$/) { $1 + version.to_s.inspect }
-       File.open(main_include, 'w') { |f| f << file_contents }      
-       modified_files << main_include
-     end
+      if main_include && File.exist?(main_include)
+        file_contents = File.read(main_include)
+        if file_contents.sub!(/^(\s+VERSION\s*=\s*)[^\s].*$/) { $1 + version.to_s.inspect }
+          File.open(main_include, 'w') { |f| f << file_contents }
+          modified_files << main_include
+        end
+      end
     end
-    
+
     # Updates an attribute of the gemspec file.
     # This function will open the file, and search/replace the attribute using a regular expression.
     def update_gemspec(attribute, new_value, literal = false)
-      
+
       unless literal
         new_value = case new_value
           when Array        then "%w(#{new_value.join(' ')})"
           when Hash, String then new_value.inspect
-          when Date         then new_value.strftime('%Y-%m-%d').inspect 
+          when Date         then new_value.strftime('%Y-%m-%d').inspect
           else              raise "Cannot write value #{new_value.inspect} to gemspec file!"
         end
       end
-      
+
       spec   = File.read(gemspec_file)
       regexp = Regexp.new('^(\s+\w+\.' + Regexp.quote(attribute.to_s) + '\s*=\s*)[^\s].*$')
       if spec.sub!(regexp) { $1 + new_value }
-        File.open(gemspec_file, 'w') { |f| f << spec }      
+        File.open(gemspec_file, 'w') { |f| f << spec }
         modified_files << gemspec_file
-            
+
         # Reload the gemspec so the changes are incorporated
         load_gemspec!
       end
     end
-    
+
+    # Updates the tasks file using the latest file found on Github
+    def update_tasks_task
+      require 'net/http'
+
+      server = 'github.com'
+      path   = '/wvanbergen/github-gem/raw/master/tasks/github-gem.rake'
+
+      Net::HTTP.start(server) do |http|
+        response = http.get(path)
+        open(__FILE__, "w") { |file| file.write(response.body) }
+      end
+
+      relative_file = File.expand_path(__FILE__).sub(%r[^#{git.dir.path}/], '')
+      if git.status[relative_file] && git.status[relative_file].type == 'M'
+        git.add(relative_file)
+        git.commit("Updated to latest gem release management tasks.")
+        puts "Updated to latest version of gem release management tasks."
+      else
+        puts "Release managament tasks already are at the latest version."
+      end
+    end
+
   end
 end