coverband 1.5.4 → 2.0.0.alpha

data/lib/coverband/reporters/simple_cov_report.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 module Coverband
   module Reporters
     class SimpleCovReport < Base
-
       def self.report(store, options = {})
         begin
           require 'simplecov'
-        rescue
-          Coverband.configuration.logger.error "coverband requires simplecov in order to generate a report, when configured for the scov report style."
+        rescue StandardError
+          Coverband.configuration.logger.error 'coverband requires simplecov in order to generate a report, when configured for the scov report style.'
           return
         end
 
@@ -25,7 +26,7 @@ module Coverband
         report_files = SimpleCov.add_not_loaded_files(scov_style_report)
         filtered_report_files = {}
         report_files.each_pair do |file, data|
-          next if Coverband.configuration.ignore.any?{ |i| file.match(i) }
+          next if Coverband.configuration.ignore.any? { |i| file.match(i) }
           filtered_report_files[file] = data
         end
 
@@ -39,8 +40,6 @@ module Coverband
 
         S3ReportWriter.new(Coverband.configuration.s3_bucket).persist! if Coverband.configuration.s3_bucket
       end
-
     end
   end
 end
-

data/lib/coverband/s3_report_writer.rb

@@ -1,10 +1,11 @@
-class S3ReportWriter
+# frozen_string_literal: true
 
+class S3ReportWriter
   def initialize(bucket_name)
     @bucket_name = bucket_name
     begin
       require 'aws-sdk'
-    rescue
+    rescue StandardError
       Coverband.configuration.logger.error "coverband requires 'aws-sdk' in order use S3ReportWriter."
       return
     end
@@ -17,11 +18,10 @@ class S3ReportWriter
   private
 
   def coverage_content
-    begin
-      File.read("#{SimpleCov.coverage_dir}/index.html").gsub("./assets/#{Gem::Specification.find_by_name('simplecov-html').version.version}/", '')
-    rescue
-      File.read("#{SimpleCov.coverage_dir}/index.html").to_s.gsub("./assets/0.10.1/", '')
-    end
+    version = Gem::Specification.find_by_name('simplecov-html').version.version
+    File.read("#{SimpleCov.coverage_dir}/index.html").gsub("./assets/#{version}/", '')
+  rescue StandardError
+    File.read("#{SimpleCov.coverage_dir}/index.html").to_s.gsub('./assets/0.10.1/', '')
   end
 
   def object
@@ -35,5 +35,4 @@ class S3ReportWriter
   def bucket
     s3.bucket(@bucket_name)
   end
-
 end

data/lib/coverband/s3_web.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 
 module Coverband
-
   class S3Web < Sinatra::Base
-
     set :public_folder, proc { File.expand_path('public', Gem::Specification.find_by_name('simplecov-html').full_gem_path) }
 
     get '/' do
-      s3.get_object(bucket: Coverband.configuration.s3_bucket, key:'coverband/index.html').body.read
+      s3.get_object(bucket: Coverband.configuration.s3_bucket, key: 'coverband/index.html').body.read
     end
 
     private
@@ -15,7 +15,5 @@ module Coverband
     def s3
       @s3 ||= Aws::S3::Client.new
     end
-
   end
-
 end

data/lib/coverband/tasks.rb

@@ -1,5 +1,6 @@
-namespace :coverband do
+# frozen_string_literal: true
 
+namespace :coverband do
   def safely_import_files(files_to_cover)
     if files_to_cover.any?
       files = Coverband::Baseline.exclude_files(files_to_cover)
@@ -16,32 +17,30 @@ namespace :coverband do
     end
   end
 
-  desc "record coverband coverage baseline"
+  desc 'record coverband coverage baseline'
   task :baseline do
     Coverband::Baseline.record do
-      if Rake::Task.tasks.any?{ |key| key.to_s.match(/environment$/) }
-        Coverband.configuration.logger.info "invoking rake environment"
+      if Rake::Task.tasks.any? { |key| key.to_s.match(/environment$/) }
+        Coverband.configuration.logger.info 'invoking rake environment'
         Rake::Task['environment'].invoke
-      elsif Rake::Task.tasks.any?{ |key| key.to_s.match(/env$/) }
-        Coverband.configuration.logger.info "invoking rake env"
-        Rake::Task["env"].invoke
+      elsif Rake::Task.tasks.any? { |key| key.to_s.match(/env$/) }
+        Coverband.configuration.logger.info 'invoking rake env'
+        Rake::Task['env'].invoke
       end
 
-      baseline_files = [File.expand_path('./config/boot.rb',  Dir.pwd),
-        File.expand_path('./config/application.rb', Dir.pwd),
-        File.expand_path('./config/environment.rb', Dir.pwd)]
+      baseline_files = [File.expand_path('./config/boot.rb', Dir.pwd),
+                        File.expand_path('./config/application.rb', Dir.pwd),
+                        File.expand_path('./config/environment.rb', Dir.pwd)]
 
       baseline_files.each do |baseline_file|
-        if File.exists?(baseline_file)
-          require baseline_file
-        end
+        require baseline_file if File.exist?(baseline_file)
       end
 
       safely_import_files(Coverband.configuration.additional_files.flatten)
 
       if defined? Rails
         safely_import_files(Dir.glob("#{Rails.root}/app/**/*.rb"))
-        if File.exists?("#{Rails.root}/lib")
+        if File.exist?("#{Rails.root}/lib")
           safely_import_files(Dir.glob("#{Rails.root}/lib/**/*.rb"))
         end
       end
@@ -53,9 +52,9 @@ namespace :coverband do
   # You might want to override them and clear the filters.
   # Or run the task `coverage_no_filters` below.
   ###
-  desc "report runtime coverband code coverage"
-  task :coverage => :environment do
-    if Coverband.configuration.reporter=='scov'
+  desc 'report runtime coverband code coverage'
+  task coverage: :environment do
+    if Coverband.configuration.reporter == 'scov'
       Coverband::Reporters::SimpleCovReport.report(Coverband.configuration.store)
     else
       Coverband::Reporters::ConsoleReport.report(Coverband.configuration.store)
@@ -63,18 +62,16 @@ namespace :coverband do
   end
 
   def clear_simplecov_filters
-    if defined? SimpleCov
-      SimpleCov.filters.clear
-    end
+    SimpleCov.filters.clear if defined? SimpleCov
   end
 
-  desc "report runtime coverband code coverage after disabling simplecov filters"
-  task :coverage_no_filters => :environment do
-    if Coverband.configuration.reporter=='scov'
+  desc 'report runtime coverband code coverage after disabling simplecov filters'
+  task coverage_no_filters: :environment do
+    if Coverband.configuration.reporter == 'scov'
       clear_simplecov_filters
       Coverband::Reporters::SimpleCovReport.report(Coverband.configuration.store)
     else
-      puts "coverage without filters only makes sense for SimpleCov reports"
+      puts 'coverage without filters only makes sense for SimpleCov reports'
     end
   end
 
@@ -83,8 +80,8 @@ namespace :coverband do
   # You may want to have a hook that saves current coverband data on deploy
   # and then resets the coverband store data.
   ###
-  desc "reset coverband coverage data"
-  task :clear  => :environment do
+  desc 'reset coverband coverage data'
+  task clear: :environment do
     Coverband.configuration.store.clear!
   end
 end

data/lib/coverband/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coverband
-  VERSION = "1.5.4"
+  VERSION = '2.0.0.alpha'
 end

data/test/benchmarks/benchmark.rake

@@ -1,17 +1,20 @@
+# frozen_string_literal: true
+
 require 'coverband'
 require 'redis'
 require File.join(File.dirname(__FILE__), 'dog')
 
 namespace :benchmarks do
-
   def classifier_dir
-    classifier_dir = File.join(File.dirname(__FILE__), 'classifier-reborn')
+    File.join(File.dirname(__FILE__), 'classifier-reborn')
   end
 
   def clone_classifier
+    # rubocop:disable Style/IfUnlessModifier
     unless Dir.exist? classifier_dir
       system "git clone git@github.com:jekyll/classifier-reborn.git #{classifier_dir}"
     end
+    # rubocop:enable Style/IfUnlessModifier
   end
 
   desc 'set up coverband default redis'
@@ -28,14 +31,13 @@ namespace :benchmarks do
       config.percentage         = 100.0
       config.logger             = $stdout
       config.verbose            = false
-      #config.memory_caching     = true
-      #config.trace_point_events = [:call]
+      # config.memory_caching     = true
+      # config.trace_point_events = [:call]
     end
-
   end
 
-  desc 'set up coverband redis array'
-  task :setup_array do
+  desc 'set up coverband with coverage redis'
+  task :setup_coverage do
     clone_classifier
     $LOAD_PATH.unshift(File.join(classifier_dir, 'lib'))
     require 'benchmark'
@@ -48,7 +50,7 @@ namespace :benchmarks do
       config.percentage         = 100.0
       config.logger             = $stdout
       config.verbose            = false
-      config.store              = Coverband::Adapters::RedisStore.new(Redis.new, array: true)
+      config.collector          = 'coverage'
     end
   end
 
@@ -67,28 +69,28 @@ namespace :benchmarks do
       config.percentage         = 100.0
       config.logger             = $stdout
       config.verbose            = false
-      config.coverage_file     = '/tmp/benchmark_store.json'
+      config.coverage_file = '/tmp/benchmark_store.json'
     end
   end
 
   def bayes_classification
     b = ClassifierReborn::Bayes.new 'Interesting', 'Uninteresting'
-    b.train_interesting "here are some good words. I hope you love them"
-    b.train_uninteresting "here are some bad words, I hate you"
-    b.classify "I hate bad words and you" # returns 'Uninteresting'
+    b.train_interesting 'here are some good words. I hope you love them'
+    b.train_uninteresting 'here are some bad words, I hate you'
+    b.classify 'I hate bad words and you' # returns 'Uninteresting'
   end
 
   def lsi_classification
     lsi = ClassifierReborn::LSI.new
-    strings = [ ["This text deals with dogs. Dogs.", :dog],
-                ["This text involves dogs too. Dogs! ", :dog],
-                ["This text revolves around cats. Cats.", :cat],
-                ["This text also involves cats. Cats!", :cat],
-                ["This text involves birds. Birds.",:bird ]]
-    strings.each {|x| lsi.add_item x.first, x.last}
-    lsi.search("dog", 3)
+    strings = [['This text deals with dogs. Dogs.', :dog],
+               ['This text involves dogs too. Dogs! ', :dog],
+               ['This text revolves around cats. Cats.', :cat],
+               ['This text also involves cats. Cats!', :cat],
+               ['This text involves birds. Birds.', :bird]]
+    strings.each { |x| lsi.add_item x.first, x.last }
+    lsi.search('dog', 3)
     lsi.find_related(strings[2], 2)
-    lsi.classify "This text is also about dogs!"
+    lsi.classify 'This text is also about dogs!'
   end
 
   def work
@@ -97,49 +99,53 @@ namespace :benchmarks do
       lsi_classification
     end
 
-    #simulate many calls to the same line
+    # simulate many calls to the same line
     10_000.times { Dog.new.bark }
   end
 
   def run_work
     puts "benchmark for: #{Coverband.configuration.inspect}"
     puts "store: #{Coverband.configuration.store.inspect}"
-    bm = Benchmark.bm(15) do |x|
-
+    Benchmark.bm(15) do |x|
       x.report 'coverband' do
         SAMPLINGS.times do
-          Coverband::Base.instance.sample do
+          Coverband::Collectors::Base.instance.sample do
             work
           end
         end
       end
 
-      x.report "no coverband" do
+      x.report 'no coverband' do
         SAMPLINGS.times do
           work
         end
       end
     end
+    Coverband::Collectors::Base.instance.stop
+    Coverband::Collectors::Base.instance.reset_instance
   end
 
   desc 'runs benchmarks on default redis setup'
-  task :run => :setup do
+  task run: :setup do
+    puts 'Coverband tracepoint configured with default redis store'
     SAMPLINGS = 5
     run_work
   end
 
-  desc 'runs benchmarks redis array'
-  task :run_array => :setup_array do
+  desc 'runs benchmarks file store'
+  task run_file: :setup_file do
+    puts 'Coverband tracepoint configured with file store'
     SAMPLINGS = 5
     run_work
   end
 
-  desc 'runs benchmarks file store'
-  task :run_file => :setup_file do
+  desc 'runs benchmarks coverage'
+  task run_coverage: :setup_coverage do
+    puts 'Coverband Coverage configured with to use default redis store'
     SAMPLINGS = 5
     run_work
   end
 end
 
-desc "runs benchmarks"
-task benchmarks: [ "benchmarks:run" ]
+desc 'runs benchmarks'
+task benchmarks: ['benchmarks:run_file', 'benchmarks:run', 'benchmarks:run_coverage']

data/test/benchmarks/dog.rb

@@ -1,7 +1,7 @@
-class Dog
+# frozen_string_literal: true
 
+class Dog
   def bark
-    "bark"
+    'bark'
   end
-
 end

data/test/fake_app/basic_rack.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'rack'
 
 class HelloWorld
-  def call(env)
-      [200, {"Content-Type" => "text/html"}, "Hello Rack!"]
+  def call(_env)
+    [200, { 'Content-Type' => 'text/html' }, 'Hello Rack!']
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'simplecov'
 require 'test/unit'
@@ -16,8 +18,12 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 Mocha::Configuration.prevent(:stubbing_non_existent_method)
 
 def test(name, &block)
-  test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
-  defined = instance_method(test_name) rescue false
+  test_name = "test_#{name.gsub(/\s+/, '_')}".to_sym
+  defined = begin
+              instance_method(test_name)
+            rescue StandardError
+              false
+            end
   raise "#{test_name} is already defined in #{self}" if defined
   if block_given?
     define_method(test_name, &block)
@@ -30,22 +36,22 @@ end
 
 def fake_redis
   @redis ||= begin
-    redis = OpenStruct.new()
-    def redis.smembers(key)
-    end
+    redis = OpenStruct.new
+    # mocha requires method to exist to mock it 
+    def redis.smembers(key); end
+    def redis.hgetall(key); end
     redis
   end
 end
 
 def fake_coverband_members
-  ["/Users/danmayer/projects/hearno/script/tester.rb",
-   "/Users/danmayer/projects/hearno/app/controllers/application_controller.rb",
-   "/Users/danmayer/projects/hearno/app/models/account.rb"
-  ]
+  ['/Users/danmayer/projects/hearno/script/tester.rb',
+   '/Users/danmayer/projects/hearno/app/controllers/application_controller.rb',
+   '/Users/danmayer/projects/hearno/app/models/account.rb']
 end
 
 def fake_coverage_report
-  {"/Users/danmayer/projects/hearno/script/tester.rb"=>[1, nil, 1, 1, nil, nil, nil]}
+  { '/Users/danmayer/projects/hearno/script/tester.rb' => [1, nil, 1, 1, nil, nil, nil] }
 end
 
 require 'coverband'
@@ -58,7 +64,7 @@ end
 Coverband.configure do |config|
   config.root              = Dir.pwd
   config.redis             = Redis.new
-  #config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
+  # config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
   config.root_paths        = ['/app/']
   config.ignore            = ['vendor']
   config.percentage        = 100.0

data/test/unit/adapters_file_store_test.rb

@@ -1,41 +1,42 @@
+# frozen_string_literal: true
+
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class AdaptersFileStoreTest < Test::Unit::TestCase
-
   def setup
-    @test_file_path = "/tmp/coverband_filestore_test_path.json"
+    @test_file_path = '/tmp/coverband_filestore_test_path.json'
     File.open(@test_file_path, 'w') { |f| f.write(test_data.to_json) }
     @store = Coverband::Adapters::FileStore.new(@test_file_path)
   end
 
   def test_covered_lines_for_file
-    assert_equal @store.covered_lines_for_file('dog.rb')["1"],  1
-    assert_equal @store.covered_lines_for_file('dog.rb')["2"],  2
+    assert_equal @store.covered_lines_for_file('dog.rb')['1'],  1
+    assert_equal @store.covered_lines_for_file('dog.rb')['2'],  2
   end
 
   def test_covered_lines_when_null
-    assert_equal @store.covered_lines_for_file('none.rb'),  []
+    assert_equal @store.covered_lines_for_file('none.rb'), []
   end
 
   def test_covered_files
-    assert_equal @store.covered_files(),  ['dog.rb']
+    assert_equal @store.covered_files, ['dog.rb']
   end
 
   def test_clear
     @store.clear!
-    assert_equal false,  File.exist?(@test_file_path)
+    assert_equal false, File.exist?(@test_file_path)
   end
 
   def test_save_report
-    @store.save_report({"cat.rb" => {1 => 1}})
-    assert_equal @store.covered_lines_for_file('cat.rb')["1"],  1
+    @store.save_report('cat.rb' => { 1 => 1 })
+    assert_equal @store.covered_lines_for_file('cat.rb')['1'], 1
   end
 
   private
 
   def test_data
     {
-      "dog.rb" => { 1 => 1, 2 => 2 },
+      'dog.rb' => { 1 => 1, 2 => 2 }
     }
   end
-end
+end