coverband 0.0.24 → 0.0.26

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9024d421423749a38d48b51ffb2e649e4ef7b12
+  data.tar.gz: f2d9072445beb98a2399e82b282b321edbad21c1
+SHA512:
+  metadata.gz: bc67df5a997a1a11baed1f28641e19dfd72d7430fd64f64acb79d2ad67baa3e09a29a9112f5049b4221ccc2a7c805777a9af7bed85744e9a8d82d9f86517562c
+  data.tar.gz: ef6211e1506103bf8f7cce7efbad5580f9a58eeeb8c355bfc4a6f32e3f27b46dc9069a17fdb5ab51c1e877d3bc14af1845165fcc6ec8f11f46f061e91a8c285c

data/README.md

@@ -72,11 +72,7 @@ You need to configure cover band you can either do that passing in all configura
 ```ruby
 require 'json'
 
-baseline = if File.exist?('./tmp/coverband_baseline.json')
-  JSON.parse(File.read('./tmp/coverband_baseline.json'))
-else
-  {}
-end
+baseline = Coverband.parse_baseline
 
 Coverband.configure do |config|
   config.root              = Dir.pwd
@@ -86,15 +82,18 @@ Coverband.configure do |config|
   config.coverage_baseline = baseline
   config.root_paths        = ['/app/']
   config.ignore            = ['vendor']
+  # Since rails and other frameworks lazy load code. I have found it is bad to allow
+  # initial requests to record with coverband. This ignores first 15 requests
+  config.startup_delay     = 15
   config.percentage        = 60.0
   if defined? Statsd
     config.stats             = Statsd.new('statsd.host.com', 8125)
   end
-  config.verbose           = true
+  config.verbose           = Rails.env.production? ? false : true
 end
 ```
 
-Here is a alternative configuration example:
+Here is a alternative configuration example, allowing for production and development settings:
 
 ```ruby
 Coverband.configure do |config|
@@ -103,11 +102,8 @@ Coverband.configure do |config|
   config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
   config.root_paths        = ['/app/']
   config.ignore            = ['vendor']
-  # Since rails and other frameworks lazy load code. I have found it is bad to allow
-  # initial requests to record with coverband.
-  # This allows 10 requests prior to trying to record any activitly.
-  config.startup_delay     = 10
-  config.percentage        = 15.0
+  config.startup_delay     = Rails.env.production? ? 10 : 1
+  config.percentage        = Rails.env.production? ? 15.0 : 100.0
 end
 ```
 
@@ -167,7 +163,7 @@ For example if you had a base Resque class, you could use the `before_perform` a
 
 ```ruby
 def before_perform(*args)
-  if (rand * 100.0) > Coverband.configuration.percentage
+  if (rand * 100.0) <= Coverband.configuration.percentage
     @@coverband ||= Coverband::Base.new
     @recording_samples = true
     @@coverband.start
@@ -225,18 +221,38 @@ Coverband::Reporter.clear_coverage(Redis.new(:host => 'target.com', :port => 678
 You can also do this with the included rake tasks.
 
 
+## Verbose debug mode for development
+
+If you are trying to debug locally wondering what code is being run during a request. The verbose modes `config.verbose = true` and `config.verbose = 'debug'` can be useful. With true set it will output the number of lines executed per file, to the passed in log. The files are sorted from least used file to most active file. I have even run that mode in production without much of a problem. The debug verbose mode outputs both file usage and provides the number of calls per line of code. For example if you see something like below which indicates that the `application_helper` has 43150 lines executed. That might seem odd. Then looking at the breakdown of `application_helper` we can see that line `516` was executed 38,577 times. That seems bad, and is likely worth investigating perhaps memoizing or cacheing is required. 
+
+    config.verbose = 'debug'
+    
+    coverband file usage:
+      [["/Users/danmayer/projects/app_name/lib/facebook.rb", 6],
+      ["/Users/danmayer/projects/app_name/app/models/some_modules.rb", 9],
+      ...
+      ["/Users/danmayer/projects/app_name/app/models/user.rb", 2606],
+      ["/Users/danmayer/projects/app_name/app/helpers/application_helper.rb",
+      43150]]
+    
+    file:
+      /Users/danmayer/projects/app_name/app/helpers/application_helper.rb =>
+      [[448, 1], [202, 1],
+      ...
+     [517, 1617], [516, 38577]]
+
+
 ## TODO
 
-* Improve the baseline task, hard coded for rails, for Sinatra you need to override.
-  * perhaps allow in the config to pass in baseline_requires array? If not present do the rails thing?
-* Fix performance by logging to files that purge later
-* Add support for [zadd](http://redis.io/topics/data-types-intro) so one could determine single hits versus multiple hits on a line, letting us determine the most executed code in production.
-* Add stats optional support on the number of total requests recorded
+* Fix network performance by logging to files that purge later (far more time lost in set_trace_func than sending files, hence not a high priority)
+* Add support for [zadd](http://redis.io/topics/data-types-intro) so one could determine single call versus multiple calls on a line, letting us determine the most executed code in production.
 * Possibly add ability to record code run for a given route
 * Improve client code api, around manual usage of sampling (like event usage)
 * Provide a better lighter example app, to show how to use Coverband.
   * blank rails app
-  * blank Sinatra app 
+  * blank Sinatra app
+* report on Coverband files that haven't recorded any coverage (find things like events and crons that aren't recording, or dead files)
+* ability to change the cover band config at runtime by changing the config pushed to the Redis hash. In memory cache around the changes to only make that call periodically.
 
 ## Resources
 

data/lib/coverband/base.rb

@@ -6,7 +6,8 @@ module Coverband
       @enabled = false
       @tracer_set = false
       @files = {}
-      @file_usage = {}
+      @file_usage = Hash.new(0)
+      @file_line_usage = {}
       @startup_delay = Coverband.configuration.startup_delay
       @ignore_patterns = Coverband.configuration.ignore
       @sample_percentage = Coverband.configuration.percentage
@@ -83,11 +84,9 @@ module Coverband
     def add_file(file, line)
       if !file.match(/(\/gems\/|internal\:prelude)/) && file.match(@project_directory) && !@ignore_patterns.any?{|pattern| file.match(/#{pattern}/) } 
         if @verbose
-          if @file_usage.include?(file)
-            @file_usage[file] += 1
-          else
-            @file_usage[file] = 1
-          end
+          @file_usage[file] += 1
+          @file_line_usage[file] = Hash.new(0) unless @file_line_usage.include?(file)
+          @file_line_usage[file][line] += 1
         end
         if @files.include?(file)
           @files[file] << line unless @files.include?(line)
@@ -96,6 +95,15 @@ module Coverband
         end
       end
     end
+
+    def output_file_line_usage
+      @logger.info "coverband debug coverband file:line usage:"
+      @file_line_usage.sort_by {|_key, value| value.length}.each do |pair|
+                                                             file = pair.first
+                                                             lines = pair.last
+                                                             @logger.info "file: #{file} => #{lines.sort_by {|_key, value| value}}"
+                                                           end
+    end
     
     def report_coverage
       unless @enabled
@@ -105,7 +113,12 @@ module Coverband
 
       unset_tracer
 
-      @logger.info "coverband file usage: #{@file_usage.sort_by {|_key, value| value}.inspect}" if @verbose
+      if @verbose
+        @logger.info "coverband file usage: #{@file_usage.sort_by {|_key, value| value}.inspect}"
+        if @verbose=="debug"
+          output_file_line_usage
+        end
+      end
 
       if @reporter
         if @reporter.class.name.match(/redis/i)
@@ -115,7 +128,8 @@ module Coverband
           time_spent = Time.now - before_time
           @stats.timing "coverband.files.recorded_time", time_spent if @stats
           @files = {}
-          @@file_usage = {}
+          @file_usage = Hash.new(0)
+          @file_line_usage = {}
         end
       elsif @verbose
         @logger.info "coverage report: "

data/lib/coverband/redis_store.rb

@@ -25,7 +25,7 @@ module Coverband
 
     def store_array(key, values)
       if sadd_supports_array?
-        redis.sadd(key, values) && (values.length > 0)
+        redis.sadd(key, values) if (values.length > 0)
       else
         values.each do |value|
           redis.sadd(key, value)

data/lib/coverband/tasks.rb

@@ -24,8 +24,23 @@ namespace :coverband do
       }
   end
 
+  ###
+  # note: If have set a ton of simplecov filters you might want to override them and clear the filters or run the task below.
+  ###
   desc "report runtime coverband code coverage"
   task :coverage => :environment do
+                   Coverband::Reporter.report
+  end
+
+  def clear_simplecov_filters
+    if defined? SimpleCov
+      SimpleCov.filters.clear
+    end
+  end
+
+  desc "report runtime coverband code coverage"
+  task :coverage_no_filters => :environment do
+    clear_simplecov_filters
     Coverband::Reporter.report
   end
 

data/lib/coverband/version.rb

@@ -1,3 +1,3 @@
 module Coverband
-  VERSION = "0.0.24"
+  VERSION = "0.0.26"
 end

metadata

@@ -1,142 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 0.0.24
-  prerelease: 
+  version: 0.0.26
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Rack middleware to help measure production code coverage
@@ -146,7 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -172,33 +155,26 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2870225562195560051
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2870225562195560051
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rack middleware to help measure production code coverage
 test_files:
 - test/fake_app/basic_rack.rb