This repository was archived by the owner on Jul 19, 2025. It is now read-only.

Commit fdc5757

committed

Merge pull request #109 from codeclimate/devon/add-debug-logging

Add debug logging option

2 parents 72c3a8b + 8883adc commit fdc5757Copy full SHA for fdc5757

File tree

3 files changed

+23

-1

lines changed

lib/cc/engine/analyzers
- engine_config.rb
- reporter.rb
spec/support/helpers
- analyzer_spec_helpers.rb

3 files changed

+23

-1

lines changed

`‎lib/cc/engine/analyzers/engine_config.rb‎`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,10 @@ def initialize(hash)`
`6`	`6`	`@config = normalize(hash)`
`7`	`7`	`end`
`8`	`8`
	`9`	`+ def debug?`
	`10`	`+ config.fetch("config", {}).fetch("debug", false)`
	`11`	`+ end`
	`12`	`+`
`9`	`13`	`def include_paths`
`10`	`14`	`config.fetch("include_paths", ["./"])`
`11`	`15`	`end`

`‎lib/cc/engine/analyzers/reporter.rb‎`

Lines changed: 18 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,12 @@ def initialize(engine_config, language_strategy, io)`
`16`	`16`	`end`
`17`	`17`
`18`	`18`	`def run`
	`19`	`+ debug("Processing #{language_strategy.files.count} files concurrency=#{engine_config.concurrency}")`
	`20`	`+`
`19`	`21`	`process_files`
`20`	`22`	`report`
	`23`	`+`
	`24`	`+ debug("Reported #{reports.size} violations...")`
`21`	`25`	`end`
`22`	`26`
`23`	`27`	`def process_files`
`@@ -26,19 +30,29 @@ def process_files`
`26`	`30`	`concurrency: engine_config.concurrency`
`27`	`31`	`)`
`28`	`32`
	`33`	`+ processed_files_count = Concurrent::AtomicFixnum.new`
	`34`	`+`
`29`	`35`	`pool.run do \|file\|`
	`36`	`+ debug("Processing file: #{file}")`
	`37`	`+`
`30`	`38`	`sexp = language_strategy.run(file)`
`31`	`39`	`process_sexp(sexp)`
	`40`	`+`
	`41`	`+ processed_files_count.increment`
`32`	`42`	`end`
`33`	`43`
`34`	`44`	`pool.join`
	`45`	`+`
	`46`	`+ debug("Processed #{processed_files_count.value} files")`
`35`	`47`	`end`
`36`	`48`
`37`	`49`	`def report`
`38`	`50`	`flay.report(StringIO.new).each do \|issue\|`
`39`	`51`	`violations = new_violations(issue)`
`40`	`52`
`41`	`53`	`violations.each do \|violation\|`
	`54`	`+ debug("Violation name=#{violation.report_name} mass=#{violation.mass}")`
	`55`	`+`
`42`	`56`	`unless reports.include?(violation.report_name)`
`43`	`57`	`reports.add(violation.report_name)`
`44`	`58`	`io.puts "#{violation.format.to_json}0円"`
`@@ -80,6 +94,10 @@ def flay_options`
`80`	`94`	`only: nil`
`81`	`95`	`}`
`82`	`96`	`end`
	`97`	`+`
	`98`	`+ def debug(message)`
	`99`	`+ $stderr.puts(message) if engine_config.debug?`
	`100`	`+ end`
`83`	`101`	`end`
`84`	`102`	`end`
`85`	`103`	`end`

`‎spec/support/helpers/analyzer_spec_helpers.rb‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ def run_engine(config = nil)`
`11`	`11`	`io = StringIO.new`
`12`	`12`
`13`	`13`	`engine = described_class.new(engine_config: config)`
`14`		`- reporter = ::CC::Engine::Analyzers::Reporter.new(double(concurrency: 2), engine, io)`
	`14`	`+ reporter = ::CC::Engine::Analyzers::Reporter.new(config, engine, io)`
`15`	`15`
`16`	`16`	`reporter.run`
`17`	`17`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit fdc5757

File tree

3 files changed

3 files changed

`‎lib/cc/engine/analyzers/engine_config.rb‎`

`‎lib/cc/engine/analyzers/reporter.rb‎`

`‎spec/support/helpers/analyzer_spec_helpers.rb‎`

0 commit comments