simplecov-lcov 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b37eaf4c08dce2a3b79b07aca977fcd7fd71ea2d
-  data.tar.gz: 647af1efeba8bd64d285ce52592cff6842c48874
+  metadata.gz: cc8a6e79e2c447469190f8627959b7cc705e7261
+  data.tar.gz: 7b2d488756eaf1f269b16f91301ad93e343c08a3
 SHA512:
-  metadata.gz: 00fd5066d8c2ea23950ba2d74ded0c8126dbe7fdd045b3f806712a67cd46b2aaa096e6d25900d74b9d5dc6415f68ba65d17ef49d8b2c0ad5764fc9c6e0e1a4a5
-  data.tar.gz: a55252a2373073f150a5d9dd0be54f2b4a80a9eec06162e8ef69b298c52435012dd6fd014a61fb5dae6f4f2dd99d5a64754df38387bf202adde33e3f743f7ef2
+  metadata.gz: 2752794178b5b410f587f5db080fff262dd0fb5d85233518e4bf0f58d9baaaefd1f814f356b7ea8d8db9f00810572b1311c55a32310e463f0d5887372c89a148
+  data.tar.gz: 0e41a7b80310684bf577d31e2c6ea0685001c5b62de7d60e175c62305b1e533183d4725e7478624316c43dea06af56baf772de988b309fdc0b4680791a9c6639

data/README.markdown

@@ -27,11 +27,21 @@ Custom SimpleCov formatter to generate a lcov style coverage.
 ```Ruby
   require 'simplecov'
   require 'simplecov-lcov'
-  SimpleCov::Formatter::LcovFormatter.report_with_single_file = true
+  SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
   SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
   SimpleCov.start
 ```
 
+Other available configuration options for single file report:
+
+```Ruby
+  SimpleCov::Formatter::LcovFormatter.config do |c|
+    c.output_directory = 'your/path' # default: "coverage/lcov"
+    c.lcov_file_name = 'lcov.info' # default: "YOUR_PROJECT_NAME.lcov"
+    c.single_report_path = 'your/path/lcov.info'
+  end
+```
+
 ## Contributing to simplecov-lcov
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/simple_cov_lcov/configuration.rb

@@ -0,0 +1,28 @@
+module SimpleCovLcov
+  class Configuration
+    attr_writer :report_with_single_file
+    attr_writer :output_directory
+    attr_writer :lcov_file_name
+
+    def report_with_single_file?
+      !!@report_with_single_file
+    end
+
+    def output_directory
+      @output_directory || File.join(SimpleCov.coverage_path, 'lcov')
+    end
+
+    def single_report_path=(new_path)
+      self.output_directory = File.dirname(new_path)
+      @single_report_path = new_path
+    end
+
+    def single_report_path
+      @single_report_path || File.join(output_directory, lcov_file_name)
+    end
+
+    def lcov_file_name
+      @lcov_file_name || "#{Pathname.new(SimpleCov.root).basename}.lcov"
+    end
+  end
+end

data/lib/simplecov-lcov.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'pathname'
+require_relative 'simple_cov_lcov/configuration'
 
 fail 'simplecov-lcov requires simplecov' unless defined?(SimpleCov)
 
@@ -12,53 +13,65 @@ module SimpleCov
       # _result_ :: [SimpleCov::Result] abcoverage result instance.
       def format(result)
         create_output_directory!
-        if self.class.report_with_single_file?
+
+        if report_with_single_file?
           write_lcov_to_single_file!(result.files)
         else
           result.files.each { |file| write_lcov!(file) }
         end
 
-        puts "Lcov style coverage report generated for #{result.command_name} to #{SimpleCov::Formatter::LcovFormatter.output_directory}."
+        puts "Lcov style coverage report generated for #{result.command_name} to #{lcov_results_path}"
       end
 
       class << self
-        attr_writer :report_with_single_file
-
-        def report_with_single_file?
-          !!@report_with_single_file
+        def config
+          @config ||= SimpleCovLcov::Configuration.new
+          yield @config if block_given?
+          @config
         end
 
-        # Output directory for generated files.
-        # ==== Return
-        # Path for output directory.
-        def output_directory
-          File.join(SimpleCov.coverage_path, 'lcov')
-        end
+        def report_with_single_file=(value)
+          deprecation_message = \
+            "#{caller(1..1).first} " \
+            "`#{LcovFormatter}.report_with_single_file=` is deprecated. " \
+            "Use `#{LcovFormatter}.config.report_with_single_file=` instead"
 
-        # Output path for single file report.
-        # ==== Return
-        # Path for output path of single file report.
-        def single_report_path
-          basename = Pathname.new(SimpleCov.root).basename.to_s
-          File.join(output_directory, "#{basename}.lcov")
+          warn deprecation_message
+          config.report_with_single_file = value
         end
       end
 
       private
 
+      def output_directory
+        self.class.config.output_directory
+      end
+
+      def lcov_results_path
+        report_with_single_file? ? single_report_path : output_directory
+      end
+
+      def report_with_single_file?
+        self.class.config.report_with_single_file?
+      end
+
+      def single_report_path
+        self.class.config.single_report_path
+      end
+
       def create_output_directory!
-        return if Dir.exist?(self.class.output_directory)
-        FileUtils.mkdir_p(self.class.output_directory)
+        return if Dir.exist?(output_directory)
+        FileUtils.mkdir_p(output_directory)
       end
 
       def write_lcov!(file)
-        File.open(File.join(self.class.output_directory, output_filename(file.filename)), 'w') do |f|
+        File.open(File.join(output_directory, output_filename(file.filename)), 'w') do |f|
           f.write format_file(file)
         end
       end
 
       def write_lcov_to_single_file!(files)
-        File.open(self.class.single_report_path, 'w') do |f|
+        File.open(single_report_path, 'w') do |f|
           files.each { |file| f.write format_file(file) }
         end
       end

data/simplecov-lcov.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: simplecov-lcov 0.6.0 ruby lib
+# stub: simplecov-lcov 0.7.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "simplecov-lcov".freeze
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["fortissimo1997".freeze]
-  s.date = "2018-02-07"
+  s.date = "2018-02-10"
   s.description = "Custom SimpleCov formatter to generate a lcov style coverage.".freeze
   s.email = "fortissimo1997@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -29,8 +29,10 @@ Gem::Specification.new do |s|
     "README.markdown",
     "Rakefile",
     "VERSION",
+    "lib/simple_cov_lcov/configuration.rb",
     "lib/simplecov-lcov.rb",
     "simplecov-lcov.gemspec",
+    "spec/configuration_spec.rb",
     "spec/fixtures/app/models/user.rb",
     "spec/fixtures/hoge.rb",
     "spec/fixtures/lcov/spec-fixtures-app-models-user.rb.lcov",

data/spec/configuration_spec.rb

@@ -0,0 +1,99 @@
+require_relative 'spec_helper'
+
+describe SimpleCovLcov::Configuration do
+  subject(:configuration) { described_class.new }
+
+  describe '#output_directory' do
+    context 'when directory is not customized' do
+      it 'returns default directory path' do
+        expect(configuration.output_directory).to eq File.join(SimpleCov.coverage_path, 'lcov')
+      end
+    end
+
+    context 'when directory is customized' do
+      let(:custom_directory_path) { 'some/custom/path' }
+
+      before do
+        configuration.output_directory = custom_directory_path
+      end
+
+      it 'returns customized directory path' do
+        expect(configuration.output_directory).to eq custom_directory_path
+      end
+    end
+
+    context 'when single_report_path is customized' do
+      before do
+        configuration.single_report_path = 'some/custom/path/lcov.info'
+      end
+
+      it 'sets correct path' do
+        expect(configuration.output_directory).to eq 'some/custom/path'
+      end
+    end
+  end
+
+  describe '#report_with_single_file?' do
+    context 'when no customisations are made' do
+      it { is_expected.not_to be_report_with_single_file }
+    end
+
+    context 'when report_with_single_file set to true' do
+      before do
+        configuration.report_with_single_file = true
+      end
+
+      it { is_expected.to be_report_with_single_file }
+    end
+  end
+
+  describe '#single_report_path' do
+    let(:default_single_report_dir) { File.join(SimpleCov.coverage_path, 'lcov') }
+    let(:default_file_name) { 'simplecov-lcov.lcov' }
+
+    context 'when no path customisations where made' do
+      it 'returns default path' do
+        default_path = File.join(default_single_report_dir, default_file_name)
+        expect(configuration.single_report_path).to eq default_path
+      end
+    end
+
+    context 'when file name is customised' do
+      let(:custom_file_name) { 'my-custom-file.info' }
+
+      before do
+        configuration.lcov_file_name = custom_file_name
+      end
+
+      it 'returns path with custom file name' do
+        path_with_custom_file_name = File.join(default_single_report_dir, custom_file_name)
+        expect(configuration.single_report_path).to eq path_with_custom_file_name
+      end
+    end
+
+    context 'when output directory is customised' do
+      let(:custom_file_directory) { 'path/to/my/custom/dir' }
+
+      before do
+        configuration.output_directory = custom_file_directory
+      end
+
+      it 'returns path with custom file name' do
+        customized_path = File.join(custom_file_directory, default_file_name)
+        expect(configuration.single_report_path).to eq customized_path
+      end
+    end
+
+    context 'when single_report_path is customised' do
+      let(:custom_path) { 'my/path/with/file.lcov' }
+
+      before do
+        configuration.single_report_path = custom_path
+      end
+
+      it 'returns customised path' do
+        expect(configuration.single_report_path).to eq custom_path
+      end
+    end
+  end
+end

data/spec/simplecov-lcov_spec.rb

@@ -1,84 +1,98 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'active_support/core_ext/kernel/reporting'
 
-describe SimpleCov::Formatter::LcovFormatter do
-  describe '#format' do
-    let(:expand_path) {
-      lambda do |filename|
-        File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', filename))
-      end
-    }
-
-    let(:simplecov_result_hash) {
-      {
-       expand_path.call('hoge.rb') => [nil, nil, nil, 1, 2, 2, 1, nil, 0, 0, 0, 1],
-       expand_path.call('app/models/user.rb') => [nil, nil, nil, 2, 2, 2, 2, nil, 0, 0, 0, nil, 1, 0, 0, 1]
+module SimpleCov::Formatter
+  describe LcovFormatter do
+    describe '#format' do
+      let(:expand_path) {
+        lambda do |filename|
+          File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', filename))
+        end
       }
-    }
-
-    let(:simplecov_result) {
-      SimpleCov::Result.new(simplecov_result_hash)
-    }
 
-    context 'generating report per file' do
-      before {
-        SimpleCov::Formatter::LcovFormatter.new.format(simplecov_result)
+      let(:simplecov_result_hash) {
+        {
+        expand_path.call('hoge.rb') => [nil, nil, nil, 1, 2, 2, 1, nil, 0, 0, 0, 1],
+        expand_path.call('app/models/user.rb') => [nil, nil, nil, 2, 2, 2, 2, nil, 0, 0, 0, nil, 1, 0, 0, 1]
+        }
       }
 
-      describe File do
-        it { expect(File).to exist(File.join(SimpleCov::Formatter::LcovFormatter.output_directory, 'spec-fixtures-hoge.rb.lcov')) }
-        it { expect(File).to exist(File.join(SimpleCov::Formatter::LcovFormatter.output_directory, 'spec-fixtures-app-models-user.rb.lcov')) }
-      end
+      let(:simplecov_result) {
+        SimpleCov::Result.new(simplecov_result_hash)
+      }
 
-      describe 'spec-fixtures-hoge.rb.lcov' do
-        let(:output_path) {
-          File.join(SimpleCov::Formatter::LcovFormatter.output_directory, 'spec-fixtures-hoge.rb.lcov')
+      context 'generating report per file' do
+        before {
+          LcovFormatter.new.format(simplecov_result)
         }
-        let(:fixture) {
-          File.read("#{File.dirname(__FILE__)}/fixtures/lcov/spec-fixtures-hoge.rb.lcov")
-        }
-        it { expect(File.read(output_path)).to eq(fixture) }
-      end
 
-      describe 'spec-fixtures-app-models-user.rb.lcov' do
-        let(:output_path) {
-          File.join(SimpleCov::Formatter::LcovFormatter.output_directory, 'spec-fixtures-app-models-user.rb.lcov')
-        }
-        let(:fixture) {
-          File.read("#{File.dirname(__FILE__)}/fixtures/lcov/spec-fixtures-app-models-user.rb.lcov")
-        }
-        it { expect(File.read(output_path)).to eq(fixture) }
-      end
-    end
+        describe File do
+          it { expect(File).to exist(File.join(LcovFormatter.config.output_directory, 'spec-fixtures-hoge.rb.lcov')) }
+          it { expect(File).to exist(File.join(LcovFormatter.config.output_directory, 'spec-fixtures-app-models-user.rb.lcov')) }
+        end
 
-    context 'generating single file report' do
-      before {
-        SimpleCov::Formatter::LcovFormatter.report_with_single_file = true
-        SimpleCov::Formatter::LcovFormatter.new.format(simplecov_result)
-      }
+        describe 'spec-fixtures-hoge.rb.lcov' do
+          let(:output_path) {
+            File.join(LcovFormatter.config.output_directory, 'spec-fixtures-hoge.rb.lcov')
+          }
+          let(:fixture) {
+            File.read("#{File.dirname(__FILE__)}/fixtures/lcov/spec-fixtures-hoge.rb.lcov")
+          }
+          it { expect(File.read(output_path)).to eq(fixture) }
+        end
 
-      describe File do
-        it { expect(File).to exist(SimpleCov::Formatter::LcovFormatter.single_report_path) }
+        describe 'spec-fixtures-app-models-user.rb.lcov' do
+          let(:output_path) {
+            File.join(LcovFormatter.config.output_directory, 'spec-fixtures-app-models-user.rb.lcov')
+          }
+          let(:fixture) {
+            File.read("#{File.dirname(__FILE__)}/fixtures/lcov/spec-fixtures-app-models-user.rb.lcov")
+          }
+          it { expect(File.read(output_path)).to eq(fixture) }
+        end
       end
 
-      describe 'single_report_path' do
-        let(:output_path) {
-          SimpleCov::Formatter::LcovFormatter.single_report_path
-        }
-        let(:fixture_of_hoge) {
-          File.read("#{File.dirname(__FILE__)}/fixtures/lcov/spec-fixtures-hoge.rb.lcov")
+      context 'generating single file report' do
+        before {
+          LcovFormatter.config.report_with_single_file = true
+          LcovFormatter.new.format(simplecov_result)
         }
-        let(:fixture_of_user) {
-          File.read("#{File.dirname(__FILE__)}/fixtures/lcov/spec-fixtures-app-models-user.rb.lcov")
-        }
-        it { expect(File.read(output_path)).to match(fixture_of_hoge) }
-        it { expect(File.read(output_path)).to match(fixture_of_user) }
+
+        describe File do
+          it { expect(File).to exist(LcovFormatter.config.single_report_path) }
+        end
+
+        describe 'single_report_path' do
+          let(:output_path) {
+            LcovFormatter.config.single_report_path
+          }
+          let(:fixture_of_hoge) {
+            File.read("#{File.dirname(__FILE__)}/fixtures/lcov/spec-fixtures-hoge.rb.lcov")
+          }
+          let(:fixture_of_user) {
+            File.read("#{File.dirname(__FILE__)}/fixtures/lcov/spec-fixtures-app-models-user.rb.lcov")
+          }
+          it { expect(File.read(output_path)).to match(fixture_of_hoge) }
+          it { expect(File.read(output_path)).to match(fixture_of_user) }
+        end
       end
     end
   end
 
-  describe '.output_directory' do
-    subject { SimpleCov::Formatter::LcovFormatter.output_directory }
-    it { expect(subject).to eq(File.join(SimpleCov.coverage_path, 'lcov')) }
+  describe '.report_with_single_file=' do
+    before do
+      allow(LcovFormatter).to receive(:warn)
+      allow(LcovFormatter.config).to receive(:report_with_single_file=)
+    end
+
+    it 'sets configuration options correctly' do
+      LcovFormatter.report_with_single_file = true
+      expect(LcovFormatter.config).to have_received(:report_with_single_file=).with(true)
+    end
+
+    it 'shows deprecation warning' do
+      LcovFormatter.report_with_single_file = true
+      expect(LcovFormatter).to have_received(:warn).with(/LcovFormatter\.report_with_single_file=` is deprecated/)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -12,10 +12,10 @@ SimpleCov.configure do
   clean_filters
 end
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
-]
+])
 
 ENV['COVERAGE'] && SimpleCov.start do
   add_filter '/.rvm/'
@@ -33,10 +33,10 @@ require 'simplecov-lcov'
 
 RSpec.configure do |config|
   config.before(:each) do
-    if Dir.exist?(SimpleCov::Formatter::LcovFormatter.output_directory)
+    if Dir.exist?(SimpleCov::Formatter::LcovFormatter.config.output_directory)
       FileUtils
         .remove_dir(
-                    SimpleCov::Formatter::LcovFormatter.output_directory,
+                    SimpleCov::Formatter::LcovFormatter.config.output_directory,
                     true
                    )
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-lcov
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - fortissimo1997
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -126,8 +126,10 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- lib/simple_cov_lcov/configuration.rb
 - lib/simplecov-lcov.rb
 - simplecov-lcov.gemspec
+- spec/configuration_spec.rb
 - spec/fixtures/app/models/user.rb
 - spec/fixtures/hoge.rb
 - spec/fixtures/lcov/spec-fixtures-app-models-user.rb.lcov