coverband 1.3.1 → 1.5.0

data/test/unit/reports_console_test.rb

@@ -0,0 +1,37 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class SimpleCovReportTest < Test::Unit::TestCase
+  BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
+
+  def setup
+    @fake_redis = fake_redis
+    @store = Coverband::Adapters::RedisStore.new(@fake_redis, array: true)
+  end
+
+  test "report data" do
+    Coverband.configure do |config|
+      config.redis             = @fake_redis
+      config.reporter          = 'std_out'
+    end
+
+    Coverband::Reporters::ConsoleReport.expects(:current_root).returns('/tmp/root_dir')
+    @fake_redis.expects(:smembers).with(BASE_KEY).returns(fake_coverband_members)
+    
+    fake_coverband_members.each do |key|
+      File.expects(:exists?).with(key).returns(true)
+      File.expects(:foreach).with(key).returns(Array.new(4){'LOC'})
+      @fake_redis.expects(:smembers).with("#{BASE_KEY}.#{key}").returns(["1", "3"])
+    end
+    
+    Coverband.configuration.logger.stubs('info')
+
+    report = Coverband::Reporters::ConsoleReport.report(@store)
+    expected = {"/Users/danmayer/projects/hearno/app/controllers/application_controller.rb"=>
+                  [1, nil, 1, nil],
+                "/Users/danmayer/projects/hearno/app/models/account.rb"=>[1, nil, 1, nil],
+                "/Users/danmayer/projects/hearno/script/tester.rb"=>[1, nil, 1, nil]}
+
+    assert_equal(expected, report)
+  end
+
+end

data/test/unit/reports_simple_cov_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class ReportsSimpleCovTest < Test::Unit::TestCase
+  BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
+
+  def setup
+    @fake_redis = fake_redis
+    @store = Coverband::Adapters::RedisStore.new(@fake_redis, array: true)
+  end
+
+  test "generate scov report" do
+    Coverband.configure do |config|
+      config.redis             = @fake_redis
+      config.reporter          = 'scov'
+      config.s3_bucket         = nil
+      config.ignore            = ["notsomething.rb"]
+    end
+
+    Coverband::Reporters::SimpleCovReport.expects(:current_root).at_least_once.returns('/tmp/root_dir')
+    @fake_redis.expects(:smembers).with(BASE_KEY).returns(fake_coverband_members)
+
+    SimpleCov.expects(:track_files)
+    SimpleCov.expects(:add_not_loaded_files).returns({})
+    SimpleCov::Result.any_instance.expects(:format!)
+    SimpleCov.stubs(:root)
+
+    fake_coverband_members.each do |key|
+      File.expects(:exists?).with(key).returns(true)
+      File.expects(:foreach).with(key).returns(Array.new(60){'LOC'})
+      @fake_redis.expects(:smembers).with("#{BASE_KEY}.#{key}").returns(["54", "55"])
+    end
+    
+    Coverband.configuration.logger.stubs('info')
+
+    Coverband::Reporters::SimpleCovReport.report(@store, open_report: false)
+  end
+
+  test "generate scov report with additional data" do
+    Coverband.configure do |config|
+      config.redis             = @fake_redis
+      config.reporter          = 'scov'
+      config.s3_bucket         = nil
+      config.ignore            = ["notsomething.rb"]
+    end
+
+    Coverband::Reporters::SimpleCovReport.expects(:current_root).at_least_once.returns('/tmp/root_dir')
+    @fake_redis.expects(:smembers).with(BASE_KEY).returns(fake_coverband_members)
+
+    SimpleCov.expects(:track_files)
+    SimpleCov.expects(:add_not_loaded_files).returns({"fake_file.rb" => [1]})
+    SimpleCov::Result.any_instance.expects(:format!)
+    SimpleCov.stubs(:root)
+
+    fake_coverband_members.each do |key|
+      File.expects(:exists?).with(key).returns(true)
+      File.expects(:foreach).with(key).returns(['a','b','c'])
+      @fake_redis.expects(:smembers).with("#{BASE_KEY}.#{key}").returns(["54", "55"])
+    end
+
+    Coverband.configuration.logger.stubs('info')
+    additional_data = [
+      fake_coverage_report
+    ]
+
+    Coverband::Reporters::SimpleCovReport.report(@store, open_report: false, additional_scov_data: additional_data)
+  end
+
+end

data/test/unit/s3_report_writer_test.rb

@@ -1,4 +1,5 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
+require 'aws-sdk'
 
 module Coverband
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2017-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,21 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,19 +165,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 description: Rack middleware to help measure production code usage (LOC runtime usage)
 email:
 - dan@mayerdan.com
@@ -192,16 +192,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- changes.md
 - coverband.gemspec
 - docs/coverband_details.png
 - docs/coverband_index.png
 - lib/coverband.rb
+- lib/coverband/adapters/file_store.rb
+- lib/coverband/adapters/memory_cache_store.rb
+- lib/coverband/adapters/redis_store.rb
 - lib/coverband/base.rb
+- lib/coverband/baseline.rb
 - lib/coverband/configuration.rb
-- lib/coverband/memory_cache_store.rb
 - lib/coverband/middleware.rb
-- lib/coverband/redis_store.rb
-- lib/coverband/reporter.rb
+- lib/coverband/reporters/base.rb
+- lib/coverband/reporters/console_report.rb
+- lib/coverband/reporters/simple_cov_report.rb
 - lib/coverband/s3_report_writer.rb
 - lib/coverband/s3_web.rb
 - lib/coverband/tasks.rb
@@ -211,13 +216,17 @@ files:
 - test/benchmarks/dog.rb
 - test/fake_app/basic_rack.rb
 - test/test_helper.rb
+- test/unit/adapters_file_store_test.rb
+- test/unit/adapters_memory_cache_store_test.rb
+- test/unit/adapters_redis_store_test.rb
 - test/unit/base_test.rb
+- test/unit/baseline_test.rb
 - test/unit/configuration_test.rb
 - test/unit/dog.rb
-- test/unit/memory_cache_store_test.rb
 - test/unit/middleware_test.rb
-- test/unit/redis_store_test.rb
-- test/unit/reporter_test.rb
+- test/unit/reports_base_test.rb
+- test/unit/reports_console_test.rb
+- test/unit/reports_simple_cov_test.rb
 - test/unit/s3_report_writer_test.rb
 - test/unit/s3_web_test.rb
 homepage: https://github.com/danmayer/coverband
@@ -250,12 +259,16 @@ test_files:
 - test/benchmarks/dog.rb
 - test/fake_app/basic_rack.rb
 - test/test_helper.rb
+- test/unit/adapters_file_store_test.rb
+- test/unit/adapters_memory_cache_store_test.rb
+- test/unit/adapters_redis_store_test.rb
 - test/unit/base_test.rb
+- test/unit/baseline_test.rb
 - test/unit/configuration_test.rb
 - test/unit/dog.rb
-- test/unit/memory_cache_store_test.rb
 - test/unit/middleware_test.rb
-- test/unit/redis_store_test.rb
-- test/unit/reporter_test.rb
+- test/unit/reports_base_test.rb
+- test/unit/reports_console_test.rb
+- test/unit/reports_simple_cov_test.rb
 - test/unit/s3_report_writer_test.rb
 - test/unit/s3_web_test.rb

data/lib/coverband/memory_cache_store.rb

@@ -1,42 +0,0 @@
-module Coverband
-  class MemoryCacheStore
-
-    attr_accessor :store
-
-
-    def self.files_cache
-      @files_cache ||= Hash.new
-    end
-
-    def self.reset!
-      files_cache.clear
-    end
-
-    def initialize(store)
-      @store = store
-    end
-
-    def store_report files
-      filtered_files = filter(files)
-      store.store_report(filtered_files) if filtered_files.any?
-    end
-
-    private
-
-    def files_cache
-      self.class.files_cache
-    end
-
-    def filter(files)
-      files.each_with_object(Hash.new) do |(file, lines), filtered_file_hash|
-        #first time we see a file, we pre-init the in memory cache to whatever is in store(redis)
-        line_cache = files_cache[file] ||= Set.new(store.covered_lines_for_file(file))
-        lines.reject! do |line|
-          line_cache.include?(line) ? true : (line_cache << line and false)
-        end
-        filtered_file_hash[file] = lines if lines.any?
-      end
-    end
-
-  end
-end

data/lib/coverband/redis_store.rb

@@ -1,57 +0,0 @@
-module Coverband
-  class RedisStore
-    def initialize(redis)
-      @redis = redis
-      @_sadd_supports_array = recent_gem_version? && recent_server_version?
-    end
-
-    def store_report(report)
-      redis.pipelined do
-        store_array('coverband', report.keys)
-
-        report.each do |file, lines|
-          store_array("coverband.#{file}", lines.keys)
-        end
-      end
-    end
-
-
-    def covered_lines_for_file(file)
-      @redis.smembers("coverband.#{file}").map(&:to_i)
-    end
-
-
-    def sadd_supports_array?
-      @_sadd_supports_array
-    end
-
-    private
-
-    attr_reader :redis
-
-    def store_array(key, values)
-      if sadd_supports_array?
-        redis.sadd(key, values) if (values.length > 0)
-      else
-        values.each do |value|
-          redis.sadd(key, value)
-        end
-      end
-      values
-    end
-
-    def recent_server_version?
-      info_data = redis.info
-      if info_data.is_a?(Hash)
-        Gem::Version.new(info_data['redis_version']) >= Gem::Version.new('2.4')
-      else
-        #guess supported
-        true
-      end
-    end
-
-    def recent_gem_version?
-      Gem::Version.new(Redis::VERSION) >= Gem::Version.new('3.0')
-    end
-  end
-end

data/lib/coverband/reporter.rb

@@ -1,223 +0,0 @@
-module Coverband
-  class Reporter
-
-    def self.baseline
-      require 'coverage'
-      Coverage.start
-      yield
-      @project_directory = File.expand_path(Coverband.configuration.root)
-      results = Coverage.result
-      results = results.reject { |key, val| !key.match(@project_directory) || Coverband.configuration.ignore.any? { |pattern| key.match(/#{pattern}/) } }
-
-      if Coverband.configuration.verbose
-        Coverband.configuration.logger.info results.inspect
-      end
-
-      config_dir = File.dirname(Coverband.configuration.baseline_file)
-      Dir.mkdir config_dir unless File.exists?(config_dir)
-      File.open(Coverband.configuration.baseline_file, 'w') { |f| f.write(results.to_json) }
-    end
-
-    def self.report(options = {})
-      begin
-        require 'simplecov' if Coverband.configuration.reporter=='scov'
-      rescue
-        Coverband.configuration.logger.error "coverband requires simplecov in order to generate a report, when configured for the scov report style."
-        return
-      end
-      redis = Coverband.configuration.redis
-      roots = get_roots
-      existing_coverage = Coverband.configuration.coverage_baseline
-      open_report = options.fetch(:open_report) { true }
-
-      if Coverband.configuration.verbose
-        Coverband.configuration.logger.info "fixing root: #{roots.join(', ')}"
-      end
-
-      if Coverband.configuration.reporter == 'scov'
-        additional_scov_data = options.fetch(:additional_scov_data) { [] }
-        if Coverband.configuration.verbose
-          print additional_scov_data
-        end
-        report_scov(redis, existing_coverage, additional_scov_data, roots, open_report)
-      else
-        lines = redis.smembers('coverband').map{ |key| report_line(redis, key) }
-        Coverband.configuration.logger.info lines.join("\n")
-      end
-    end
-
-    def self.clear_coverage(redis = nil)
-      redis ||= Coverband.configuration.redis
-      redis.smembers('coverband').each { |key| redis.del("coverband.#{key}") }
-      redis.del("coverband")
-    end
-
-    def self.get_roots
-      roots = Coverband.configuration.root_paths
-      roots << "#{current_root}/"
-      roots
-    end
-
-    def self.current_root
-      File.expand_path(Coverband.configuration.root)
-    end
-
-    private
-
-    def self.fix_file_names(report_hash, roots)
-      fixed_report = {} #normalize names across servers
-      report_hash.each_pair do |key, values|
-        filename = filename_from_key(key, roots)
-        fixed_report[filename] = values
-      end
-      fixed_report
-    end
-
-    # [0,0,1,0,1]
-    # [nil,0,1,0,0]
-    # merge to
-    # [0,0,1,0,1]
-    def self.merge_arrays(first, second)
-      merged = []
-      longest = first.length > second.length ? first : second
-
-      longest.each_with_index do |line, index|
-        if first[index] || second[index]
-          merged[index] = (first[index].to_i + second[index].to_i >= 1 ? 1 : 0)
-        else
-          merged[index] = nil
-        end
-      end
-
-      merged
-    end
-
-
-    def self.get_current_scov_data(options = {})
-      additional_scov_data = options.fetch(:additional_scov_data) { [] }
-
-      if (additional_scov_data)
-        report_scov_with_additional_data(Coverband.configuration.redis, Coverband.configuration.coverage_baseline, additional_scov_data, get_roots)
-      else
-        get_current_scov_data_imp(Coverband.configuration.redis, get_roots)
-      end
-    end
-
-    def self.get_current_scov_data_imp(redis, roots)
-      scov_style_report = {}
-
-      redis.smembers('coverband').each do |key|
-        next if Coverband.configuration.ignore.any?{ |i| key.match(i) }
-        line_data = line_hash(redis, key, roots)
-
-        if line_data
-          line_key = line_data.keys.first
-          previous_line_hash = scov_style_report[line_key]
-
-          if previous_line_hash
-            line_data[line_key] = merge_arrays(line_data[line_key], previous_line_hash)
-          end
-
-          scov_style_report.merge!(line_data)
-        end
-      end
-
-      scov_style_report = fix_file_names(scov_style_report, roots)
-      scov_style_report
-    end
-
-    def self.report_scov_with_additional_data(redis, existing_coverage, additional_scov_data, roots)
-      scov_style_report = get_current_scov_data_imp redis, roots
-      existing_coverage = fix_file_names(existing_coverage, roots)
-      scov_style_report = merge_existing_coverage(scov_style_report, existing_coverage)
-
-      additional_scov_data.each do |data|
-        scov_style_report = merge_existing_coverage(scov_style_report, data)
-      end
-
-      scov_style_report
-    end
-
-    def self.report_scov(redis, existing_coverage, additional_scov_data, roots, open_report)
-      scov_style_report = report_scov_with_additional_data(redis, existing_coverage, additional_scov_data, roots)
-
-      if Coverband.configuration.verbose
-        Coverband.configuration.logger.info "report: "
-        Coverband.configuration.logger.info scov_style_report.inspect
-      end
-
-      # add in files never hit in coverband
-      SimpleCov.track_files "#{current_root}/{app,lib,config}/**/*.{rb,haml,erb,slim}"
-      SimpleCov::Result.new(SimpleCov.add_not_loaded_files(scov_style_report)).format!
-      if open_report
-        `open #{SimpleCov.coverage_dir}/index.html`
-      else
-        Coverband.configuration.logger.info "report is ready and viewable: open #{SimpleCov.coverage_dir}/index.html"
-      end
-      S3ReportWriter.new(Coverband.configuration.s3_bucket).persist! if Coverband.configuration.s3_bucket
-    end
-
-
-    def self.merge_existing_coverage(scov_style_report, existing_coverage)
-      existing_coverage.each_pair do |key, lines|
-        if current_lines = scov_style_report[key]
-          lines.each_with_index do |line, index|
-            if line.nil? && current_lines[index].to_i == 0
-              current_lines[index] = nil
-            else
-              current_lines[index] = current_lines[index] ? (current_lines[index].to_i + line.to_i) : nil
-            end
-          end
-          scov_style_report[key] = current_lines
-        else
-          scov_style_report[key] = lines
-        end
-      end
-      scov_style_report
-    end
-
-    # /Users/danmayer/projects/cover_band_server/views/index/erb: ["0", "2", "3", "6", "65532", "65533"]
-    # /Users/danmayer/projects/cover_band_server/app/rb: ["54", "55"]
-    # /Users/danmayer/projects/cover_band_server/views/layout/erb: ["0", "33", "36", "37", "38", "39", "40", "62", "63", "66", "65532", "65533"]
-    def self.report_line(redis, key)
-      "#{key}: #{line_members(redis, key)}"
-    end
-
-    def self.line_members(redis, key)
-      redis.smembers("coverband.#{key}").inspect
-    end
-
-    def self.filename_from_key(key, roots)
-      filename = key
-      roots.each do |root|
-        filename = filename.gsub(/^#{root}/, './')
-      end
-      # the filename for  SimpleCov is expected to be a full path.
-      # roots.last should be roots << current_root}/
-      # a fully expanded path of config.root
-      filename = filename.gsub('./', roots.last)
-      filename
-    end
-
-    # >> puts  Coverage.result.inspect
-    # {"/Users/danmayer/projects/hearno/script/tester.rb"=>[1, nil, 1, 1, nil, nil, nil]}
-    def self.line_hash(redis, key, roots)
-      filename = filename_from_key(key, roots)
-      if File.exists?(filename)
-        lines_hit = redis.smembers("coverband.#{key}")
-        count = File.foreach(filename).inject(0) { |c, line| c + 1 }
-        if filename.match(/\.erb/)
-          line_array = Array.new(count, nil)
-        else
-          line_array = Array.new(count, 0)
-        end
-        line_array.each_with_index{|line,index| line_array[index] = 1 if lines_hit.include?((index + 1).to_s) }
-        {filename => line_array}
-      else
-        Coverband.configuration.logger.info "file #{filename} not found in project"
-        nil
-      end
-    end
-
-  end
-end