Class: Reek::RakeTask

A Rake task that runs reek on a set of source files.

Example:

  Reek::RakeTask.new do |t|
    t.fail_on_error = false
  end

This will create a task that can be run with:

  rake reek

Examples:

  rake reek                                # checks lib/**/*.rb
  rake reek REEK_SRC=just_one_file.rb      # checks a single source file
  rake reek REEK_OPTS=-s                   # sorts the report by smell

Methods

new

Attributes

fail_on_error	[RW]	Whether or not to fail Rake when an error occurs (typically when smells are found). Defaults to true.
libs	[RW]	Array of directories to be added to $LOAD_PATH before running reek. Defaults to [’<the absolute path to reek‘s lib directory>’]
name	[RW]	Name of reek task. Defaults to :reek.
reek_opts	[RW]	String containing commandline options to be passed to Reek. Setting the REEK_OPTS environment variable overrides this value. Defaults to ’’.
ruby_opts	[RW]	Array of commandline options to pass to ruby. Defaults to [].
source_files	[RW]	Glob pattern to match source files. Setting the REEK_SRC environment variable overrides this. Defaults to ‘lib/*/.rb’.
verbose	[RW]	Use verbose output. If this is set to true, the task will print the reek command to stdout. Defaults to false.

Public Class methods

new(name = :reek) {|self if block_given?| ...}

Defines a new task, using the name name.

[Source]

# File lib/reek/rake_task.rb, line 60
    def initialize(name = :reek)
      @name = name
      @libs = [File.expand_path(File.dirname(__FILE__) + '/../../lib')]
      @source_files = nil
      @ruby_opts = []
      @reek_opts = ''
      @fail_on_error = true
      @sort = nil

      yield self if block_given?
      @source_files ||= 'lib/**/*.rb'
      define
    end