reek-checkstyle-formatter 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem "rspec"
+end

data/README.md

@@ -0,0 +1,36 @@
+# description
+
+Checkstyle formatter for [reek](https://github.com/troessner/reek)
+
+
+# usage
+
+Load the rake task into your `Rakefile`.
+
+```ruby
+require 'reek-checkstyle-formatter/rake_task'
+```
+
+`rake -T`
+
+```
+[...]
+rake reek             # Check for code smells
+rake reek:checkstyle  # Generate checkstyle XML for code smells analyzed by reek
+[...]
+```
+
+# customize
+
+Overwrite the formatter options in your `Rakefile`.
+E.g Map a smell to a different severity (default *warning*):
+
+```ruby
+Reek::CheckstyleFormatter.rake_task_options = {
+  :smell_severities => {
+        'IrresponsibleModule' => 'error'
+  }
+}
+```
+
+Please look at [Reek::CheckstyleFormatter#initialize](lib/reek-checkstyle-formatter.rb) for available options.

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'reek-checkstyle-formatter/rake_task'
+require 'fileutils'
+
+RSpec::Core::RakeTask.new(:spec)
+
+# make test task the gem task
+task :default => :spec
+task :spec => :clean
+
+desc 'Remove generated files.'
+task :clean do
+  ['spec/reports', 'spec/coverage'].each do |path|
+    FileUtils.rm_rf(path) if File.exists?(path)
+  end
+end

data/lib/reek-checkstyle-formatter.rb

@@ -0,0 +1,96 @@
+require 'reek/source/source_locator'
+require 'reek/examiner'
+require 'rexml/document'
+require 'pathname'
+
+class Reek::CheckstyleFormatter
+  REXML_PRETTY_PRINT_INDENT = 0
+
+  class << self
+    attr_accessor :rake_task_options
+  end
+
+  # options that are used by the rake task to overwrite the default formatter options
+  @rake_task_options = {}
+
+  attr_accessor :glob_pattern, :output, :smell_doc_url, :smell_severities
+
+  # @param [Hash] opts
+  # @option opts [String] :glob_pattern Glob pattern (absolute path) for files to analyse
+  # @option opts [String] :output File path for checkstyle xml output
+  # @option opts [String] :smell_doc_url URL to code smell documentation (reek wiki)
+  # @option opts [Hash] :smell_severities Mapping of smell subclasses to [checkstyle severity](http://checkstyle.sourceforge.net/property_types.html#severity)
+  def initialize(opts = {})
+    @glob_pattern = opts[:glob_pattern]
+    @output = opts[:output]
+    @smell_doc_url = opts[:smell_doc_url]
+    @smell_severities = opts[:smell_severities] || {}
+  end
+
+  def run
+    puts "Generating Reek Checkstyle XML #{self.inspect}"
+    files = Dir.glob(@glob_pattern)
+    sources = Reek::Source::SourceLocator.new(files).all_sources
+    examined_files = sources.map {|src| Reek::Examiner.new(src, []) }
+    document = to_checkstyle(examined_files)
+    Pathname.new(@output).dirname.mkpath
+    File.open(@output, 'w+') do |file|
+      document.write(file, REXML_PRETTY_PRINT_INDENT)
+    end
+    puts "Reek Checkstyle XML written to #{self.output}"
+  end
+
+  def to_checkstyle(examined_files)
+    REXML::Document.new.tap do |document_node|
+      document_node << REXML::XMLDecl.new
+      REXML::Element.new('checkstyle', document_node).tap do |checkstyle_node|
+        examined_files.each do |examined_file|
+          add_file(checkstyle_node, examined_file)
+        end
+      end
+    end
+  end
+
+  def add_file(checkstyle_node, examined_file)
+    if examined_file.smells.length > 0
+      REXML::Element.new('file', checkstyle_node).tap do |file_node|
+        file_node.attributes['name'] = File.join(examined_file.description)
+        examined_file.smells.each do |smell|
+          if smell.status['is_active']
+            [*smell.location['lines']].each do |line|
+              add_smell(file_node, smell, line)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def add_smell(file_node, smell, line)
+    REXML::Element.new('error', file_node).tap do |error|
+      error.attributes['line'] = line
+      error.attributes['column'] = 0
+      error.attributes['severity'] = smell_severity(smell)
+      error.attributes['message'] = smell_message(smell)
+      #error.attributes['source'] = File.join(@project_dir, smell.source)
+    end
+  end
+
+  def smell_message(smell)
+    "<em>#{smell_anchor(smell)}</em> - #{smell.message}"
+  end
+
+  def smell_anchor(smell)
+    url = smell_url(smell)
+    "<a href='#{url}'>#{smell.smell['subclass']}</a>"
+  end
+
+  def smell_url(smell)
+    smell_page_name = (smell.smell['subclass']).scan(/[A-Z][^A-Z]*/).join('-')
+    [@smell_doc_url, smell_page_name].join("/")
+  end
+
+  def smell_severity(smell)
+    @smell_severities[smell.smell['subclass']] || 'warning'
+  end
+end

data/lib/reek-checkstyle-formatter/rake_task.rb

@@ -0,0 +1,18 @@
+require 'reek/rake/task'
+require 'reek-checkstyle-formatter'
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+  t.reek_opts = '-y -n'
+end
+
+namespace :reek do
+  desc 'Generate checkstyle XML for code smells analyzed by reek.'
+  task :checkstyle do
+    Reek::CheckstyleFormatter.new({
+      :glob_pattern => "#{Dir.pwd}/lib/**/*.rb",
+      :output => "#{Dir.pwd}/reek_checkstyle.xml",
+      :smell_doc_url => 'https://github.com/troessner/reek/wiki',
+    }.merge(Reek::CheckstyleFormatter.rake_task_options)).run
+  end
+end

data/lib/reek-checkstyle-formatter/version.rb

@@ -0,0 +1,6 @@
+module Reek
+  class CheckstyleFormatter
+    VERSION = "0.0.1"
+  end
+end
+

data/reek-checkstyle-formatter.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reek-checkstyle-formatter/version'
+
+s = Gem::Specification.new
+
+s.name          = "reek-checkstyle-formatter"
+s.version       = Reek::CheckstyleFormatter::VERSION
+s.authors       = ["Ruben Jenster"]
+s.email         = ["r.jenster@drachenfels.de"]
+s.description   = %q{Checkstyle formatter for reek}
+s.summary       = %q{Checkstyle formatter for reek}
+s.homepage      = "http://github.com/Drachenfels-GmbH/reek-checkstyle-formatter"
+
+s.files         = `git ls-files`.split($/)
+s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+s.require_paths = ["lib"]
+
+s.add_development_dependency "rake"
+s.add_development_dependency "simplecov"
+s.add_development_dependency "simplecov-rcov"
+
+s.add_dependency 'reek'
+
+s
+

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'simplecov'
+require 'simplecov-rcov'
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+                SimpleCov::Formatter::HTMLFormatter,
+                SimpleCov::Formatter::RcovFormatter,
+            ]
+  add_filter "/spec/"
+end
+
+require 'timeout'
+require "rspec"
+require_relative "../lib/reek-checkstyle-formatter"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
+require 'stringio'
+# TODO if an error happens during capture everything is lost
+def capture(stream_name)
+  result = nil
+  begin
+    eval("$#{stream_name} = StringIO.new")
+    yield
+    result = eval("$#{stream_name}").string
+  ensure
+    eval("$#{stream_name} = #{stream_name.upcase}")
+  end
+  result
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: reek-checkstyle-formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ruben Jenster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !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: simplecov
+  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-rcov
+  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: reek
+  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: Checkstyle formatter for reek
+email:
+- r.jenster@drachenfels.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/reek-checkstyle-formatter.rb
+- lib/reek-checkstyle-formatter/rake_task.rb
+- lib/reek-checkstyle-formatter/version.rb
+- reek-checkstyle-formatter.gemspec
+- spec/spec_helper.rb
+homepage: http://github.com/Drachenfels-GmbH/reek-checkstyle-formatter
+licenses: []
+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: 3108404625103376616
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3108404625103376616
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Checkstyle formatter for reek
+test_files:
+- spec/spec_helper.rb