reek 1.2.6 → 1.2.8

data/README.rdoc

@@ -1,84 +0,0 @@
-= Reek -- code smell detection for Ruby
-
-Reek is a tool that examines Ruby classes, modules and methods and
-reports any code smells it finds. Install it like this:
-
-  $ gem install reek
-
-and run it like this:
-
-  $ reek [options] [dir_or_source_file]*
-
-For a full list of command-line options see the Reek
-wiki[http://wiki.github.com/kevinrutherford/reek/command-line-options]
-or run
-
-  $ reek --help
-
-== Example
-
-Imagine a source file <tt>csv_writer.rb</tt> containing:
-
-  class CsvWriter
-    def write_line(fields)
-      if (fields.length == 0)
-        puts
-      else
-        write_field(fields[0])
-        1.upto(fields.length-1) do |i|
-          print ","
-          write_field(fields[i])
-        end
-        puts
-      end
-    end
-
-    #...
-  end
-
-Reek will report the following code smells in this file:
-
-  $ reek csv_writer.rb
-  CsvWriter#write_line calls fields.length multiple times (Duplication)
-  CsvWriter#write_line has approx 6 statements (Long Method)
-  CsvWriter#write_line/block has the variable name 'i' (Uncommunicative Name)
-
-== Features
-
-Reek currently includes checks for some aspects of the following smells:
-
-* {Control Couple}[http://wiki.github.com/kevinrutherford/reek/control-couple]
-* {Data Clump}[http://wiki.github.com/kevinrutherford/reek/data-clump]
-* {Feature Envy}[http://wiki.github.com/kevinrutherford/reek/feature-envy]
-* {Large Class}[http://wiki.github.com/kevinrutherford/reek/large-class]
-* {Long Method}[http://wiki.github.com/kevinrutherford/reek/long-method]
-* {Long Parameter List}[http://wiki.github.com/kevinrutherford/reek/long-parameter-list]
-* {Simulated Polymorphism}[http://wiki.github.com/kevinrutherford/reek/simulated-polymorphism]
-* {Uncommunicative Name}[http://wiki.github.com/kevinrutherford/reek/uncommunicative-name]
-
-...and more. See the Reek wiki[http://wiki.github.com/kevinrutherford/reek/code-smells]
-for up to date details of exactly what Reek will check in your code.
-
-=== Tool Integration
-
-Reek integrates with many of your favourite tools:
-
-* Use <tt>Reek::RakeTask</tt> to easily add Reek to your Rakefile
-* Use <tt>Reek::Spec</tt> to add the <tt>should_not reek</tt> custom matcher to your Rspec examples
-* Reek is fully compliant with Ruby 1.8.6, 1.8.7 and 1.9.1
-
-=== Dependencies
-
-Reek makes use of the following other gems:
-
-* ruby_parser
-* sexp_processor
-* ruby2ruby
-
-== Learn More
-
-Find out more about Reek from any of the following sources:
-
-* Browse the Reek documentation at http://wiki.github.com/kevinrutherford/reek
-* Browse the code or install the latest cutting-edge beta version from http://github.com/kevinrutherford/reek/tree
-* Read the code API at http://rdoc.info/projects/kevinrutherford/reek

data/features/profile.feature

@@ -1,34 +0,0 @@
-@profile
-Feature: Reek's configuration can be based on any number of canned profiles
-  The starting point for configuring the smell detectors can be
-  selected from a list of supplied config files.
-
-#  Scenario: XP profile reveals Attribute smells
-#    When I run reek --profile xp spec/samples/not_quite_masked/dirty.rb
-#    Then the exit status indicates smells
-#    And it reports:
-#      """
-#      spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+2 masked):
-#        Dirty declares the attribute property (Attribute)
-#        Dirty has the variable name '@s' (Uncommunicative Name)
-#        Dirty#a calls @s.title twice (Duplication)
-#        Dirty#a calls puts(@s.title) twice (Duplication)
-#        Dirty#a has the name 'a' (Uncommunicative Name)
-#
-#      """
-#
-#  Scenario: XP profile works with unmasked smells
-#    When I run reek --show-all --profile xp spec/samples/not_quite_masked/dirty.rb
-#    Then the exit status indicates smells
-#    And it reports:
-#      """
-#      spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+2 masked):
-#        Dirty declares the attribute property (Attribute)
-#        Dirty has the variable name '@s' (Uncommunicative Name)
-#        Dirty#a calls @s.title twice (Duplication)
-#        Dirty#a calls puts(@s.title) twice (Duplication)
-#        Dirty#a has the name 'a' (Uncommunicative Name)
-#        (masked) Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-#        (masked) Dirty#a/block/block is nested (Nested Iterators)
-#
-#      """

data/lib/reek/adapters/application.rb

@@ -1,46 +0,0 @@
-require 'reek/adapters/command_line'
-require 'reek/adapters/source'
-require 'reek/adapters/core_extras'
-
-module Reek
-
-  #
-  # Represents an instance of a Reek application.
-  # This is the entry point for all invocations of Reek from the
-  # command line.
-  #
-  class Application
-
-    STATUS_SUCCESS = 0
-    STATUS_ERROR   = 1
-    STATUS_SMELLS  = 2
-
-    def initialize(argv)
-      @options = Options.new(argv)
-      @status = STATUS_SUCCESS
-    end
-
-    def execute
-      begin
-        cmd = @options.parse
-        cmd.execute(self)
-      rescue Exception => error
-        $stderr.puts "Error: #{error}"
-        @status = STATUS_ERROR
-      end
-      return @status
-    end
-
-    def output(text)
-      puts text
-    end
-
-    def report_success
-      @status = STATUS_SUCCESS
-    end
-
-    def report_smells
-      @status = STATUS_SMELLS
-    end
-  end
-end

data/lib/reek/adapters/command_line.rb

@@ -1,77 +0,0 @@
-require 'optparse'
-require 'reek'
-require 'reek/adapters/report'
-require 'reek/help_command'
-require 'reek/reek_command'
-require 'reek/version_command'
-
-module Reek
-
-  class Options
-
-    def initialize(argv)
-      @argv = argv
-      @parser = OptionParser.new
-      @report_class = VerboseReport
-      @show_all = false
-      @command = nil
-      set_options
-    end
-
-    def banner
-      progname = @parser.program_name
-      # SMELL:
-      # The following banner isn't really correct. Help, Version and Reek
-      # are really sub-commands (in the git/svn sense) and so the usage
-      # banner should show three different command-lines. The other
-      # options are all flags for the Reek sub-command.
-      #
-      # reek -h|--help           Display a help message
-      #
-      # reek -v|--version        Output the tool's version number
-      #
-      # reek [options] files     List the smells in the given files
-      #      -a|--[no-]show-all  Report masked smells
-      #      -q|-[no-]quiet      Only list files that have smells
-      #      files               Names of files or dirs to be checked
-      #
-      return <<EOB
-Usage: #{progname} [options] [files]
-
-Examples:
-
-#{progname} lib/*.rb
-#{progname} -q -a lib
-cat my_class.rb | #{progname}
-
-See http://wiki.github.com/kevinrutherford/reek for detailed help.
-
-EOB
-    end
-
-    def parse
-      @parser.parse!(@argv)
-      @command ||= ReekCommand.new(@argv, @report_class, @show_all)
-    end
-
-    def set_options
-      @parser.banner = banner
-      @parser.separator "Common options:"
-      @parser.on("-h", "--help", "Show this message") do
-        @command = HelpCommand.new(@parser)
-      end
-      @parser.on("-v", "--version", "Show version") do
-        @command = VersionCommand.new(@parser.program_name)
-      end
-
-      @parser.separator "\nReport formatting:"
-      @parser.on("-a", "--[no-]show-all", "Show all smells, including those masked by config settings") do |opt|
-        @show_all = opt
-      end
-      @parser.on("-q", "--[no-]quiet", "Suppress headings for smell-free source files") do |opt|
-        @report_class = opt ? QuietReport : VerboseReport
-      end
-    end
-  end
-
-end

data/lib/reek/adapters/config_file.rb

@@ -1,31 +0,0 @@
-require 'yaml'
-
-module Reek
-  class ConfigFile
-
-    def initialize(file_path)
-      @file_path = file_path
-      @hash = YAML.load_file(@file_path) || {}
-      problem('not a Hash') unless Hash === @hash
-    end
-
-    #
-    # Configure the given sniffer using the contents of the config file.
-    #
-    def configure(sniffer)
-      @hash.each { |klass_name, config|
-        sniffer.configure(find_class(klass_name), config)
-      }
-    end
-
-    def find_class(name)
-      klass = Reek::Smells.const_get(name)
-      problem("#{name} is not a code smell") unless klass
-      klass
-    end
-
-    def problem(reason)
-      raise "Invalid configuration file \"#{File.basename(@file_path)}\" -- #{reason}"
-    end
-  end
-end

data/lib/reek/adapters/core_extras.rb

@@ -1,64 +0,0 @@
-require 'reek/adapters/source'
-require 'reek/sniffer'
-
-class Object
-  #
-  # Creates a new +Sniffer+ that assumes this object contains Ruby source
-  # code and examines that code for smells. Calls +to_reek_source+ on self
-  # to obtain the +Source+ object wrapper.
-  #
-  def sniff
-    Reek::Sniffer.new(self.to_reek_source)
-  end
-end
-
-class File
-  #
-  # Creates a new +Source+ that assumes this File contains Ruby source
-  # code and prepares it to be examined for code smells.
-  #
-  def to_reek_source
-    Reek::SourceFile.new(self)
-  end
-end
-
-class IO
-  #
-  # Creates a new +Source+ that assumes this IO stream contains Ruby source
-  # code and prepares it to be examined for code smells.
-  #
-  def to_reek_source(description = 'io')
-    Reek::Source.new(self.readlines.join, description)
-  end
-end
-
-class String
-  #
-  # Creates a new +Source+ that assumes this string contains Ruby source
-  # code and prepares it to be examined for code smells.
-  #
-  def to_reek_source
-    Reek::Source.new(self, 'string')
-  end
-end
-
-class Array
-  def paths
-    self.map do |path|
-      if test 'd', path
-        Dir["#{path}/**/*.rb"].paths
-      else
-        path
-      end
-    end.flatten.sort
-  end
-
-  #
-  # Creates a new +Sniffer+ that assumes this Array contains the names
-  # of Ruby source files and examines those files for smells.
-  #
-  def sniff
-    sniffers = paths.map {|path| File.new(path).sniff}
-    Reek::SnifferSet.new(sniffers, 'dir')
-  end
-end

data/lib/reek/adapters/rake_task.rb

@@ -1,121 +0,0 @@
-#!/usr/bin/env ruby
-
-# Define a task library for running reek.
-
-require 'rake'
-require 'rake/tasklib'
-
-module Reek
-
-  # 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
-  #
-  class RakeTask < ::Rake::TaskLib
-
-    # Name of reek task.
-    # Defaults to :reek.
-    attr_accessor :name
-
-    # Array of directories to be added to $LOAD_PATH before running reek.
-    # Defaults to ['<the absolute path to reek's lib directory>']
-    attr_accessor :libs
-
-    # Glob pattern to match source files.
-    # Setting the REEK_SRC environment variable overrides this.
-    # Defaults to 'lib/**/*.rb'.
-    attr_accessor :source_files
-
-    # String containing commandline options to be passed to Reek.
-    # Setting the REEK_OPTS environment variable overrides this value.
-    # Defaults to ''.
-    attr_accessor :reek_opts
-
-    # Array of commandline options to pass to ruby. Defaults to [].
-    attr_accessor :ruby_opts
-
-    # Whether or not to fail Rake when an error occurs (typically when smells are found).
-    # Defaults to true.
-    attr_accessor :fail_on_error
-
-    # Use verbose output. If this is set to true, the task will print
-    # the reek command to stdout. Defaults to false.
-    attr_accessor :verbose
-
-    # Defines a new task, using the name +name+.
-    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
-
-private
-    
-    def define # :nodoc:
-      desc 'Check for code smells' unless ::Rake.application.last_comment
-      task(name) { run_task }
-      self
-    end
-    
-    def run_task
-      return if source_file_list.empty?
-      cmd = cmd_words.join(' ')
-      puts cmd if @verbose
-      raise('Smells found!') if !system(cmd) and fail_on_error
-    end
-
-    def self.reek_script
-      File.expand_path(File.dirname(__FILE__) + '/../../../bin/reek')
-    end
-
-    def self.ruby_exe
-      File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
-    end
-
-    def cmd_words
-      [RakeTask.ruby_exe] +
-          ruby_options +
-          [ %Q|"#{RakeTask.reek_script}"| ] +
-          [sort_option] +
-          source_file_list.collect { |fn| %["#{fn}"] }
-    end
-
-    def ruby_options
-      lib_path = @libs.join(File::PATH_SEPARATOR)
-      @ruby_opts.clone << "-I\"#{lib_path}\""
-    end
-    
-    def sort_option
-      ENV['REEK_OPTS'] || @reek_opts
-    end
-
-    def source_file_list # :nodoc:
-      files = ENV['REEK_SRC'] || @source_files
-      return [] unless files
-      return FileList[files]
-    end
-
-  end
-end

data/lib/reek/adapters/report.rb

@@ -1,86 +0,0 @@
-require 'set'
-require 'reek/adapters/command_line'   # SMELL: Global Variable
-require 'reek/masking_collection'
-
-module Reek
-  class ReportSection
-
-    SMELL_FORMAT = '%m%c %w (%s)'
-
-    def initialize(sniffer, display_masked_warnings)
-      @cwarnings = MaskingCollection.new
-      @desc = sniffer.desc
-      @display_masked_warnings = display_masked_warnings  # SMELL: Control Couple
-      sniffer.report_on(@cwarnings)
-    end
-
-    # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
-    # this report, with a heading.
-    def verbose_report
-      result = header
-      result += ":\n#{smell_list}" if should_report
-      result += "\n"
-      result
-    end
-
-    def quiet_report
-      return '' unless should_report
-      # SMELL: duplicate knowledge of the header layout
-      "#{header}:\n#{smell_list}\n"
-    end
-
-    def header
-      "#{@desc} -- #{visible_header}#{masked_header}"
-    end
-
-    # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
-    # this report.
-    def smell_list
-      result = []
-      if @display_masked_warnings
-        @cwarnings.each_item {|smell| result << "  #{smell.report(SMELL_FORMAT)}"}
-      else
-        @cwarnings.each_visible_item {|smell| result << "  #{smell.report(SMELL_FORMAT)}"}
-      end
-      result.join("\n")
-    end
-
-  private
-
-    def should_report
-      @cwarnings.num_visible_items > 0 or (@display_masked_warnings and @cwarnings.num_masked_items > 0)
-    end
-
-    def visible_header
-      num_smells = @cwarnings.num_visible_items
-      result = "#{num_smells} warning"
-      result += 's' unless num_smells == 1
-      result
-    end
-
-    def masked_header
-      num_masked_warnings = @cwarnings.num_masked_items
-      num_masked_warnings == 0 ? '' : " (+#{num_masked_warnings} masked)"
-    end
-  end
-
-  class Report
-    def initialize(sniffers, display_masked_warnings = false)
-      @partials = Array(sniffers).map {|sn| ReportSection.new(sn, display_masked_warnings)}
-    end
-  end
-
-  class VerboseReport < Report
-    # SMELL: Implementation Inheritance
-    def report
-      @partials.map { |section| section.verbose_report }.join
-    end
-  end
-
-  class QuietReport < Report
-    # SMELL: Implementation Inheritance
-    def report
-      @partials.map { |section| section.quiet_report }.join
-    end
-  end
-end

data/lib/reek/adapters/source.rb

@@ -1,72 +0,0 @@
-require 'ruby_parser'
-require 'reek/adapters/config_file'
-require 'reek/tree_dresser'
-
-module Reek
-
-  #
-  # A +Source+ object represents a chunk of Ruby source code.
-  #
-  class Source
-
-    @@err_io = $stderr
-
-    class << self
-      def err_io=(io)
-        original = @@err_io
-        @@err_io = io
-        original
-      end
-    end
-
-    attr_reader :desc
-
-    def initialize(code, desc, parser = RubyParser.new)
-      @source = code
-      @desc = desc
-      @parser = parser
-    end
-
-    def configure(sniffer) end
-
-    def syntax_tree
-      begin
-        ast = @parser.parse(@source, @desc)
-      rescue Exception => error
-        @@err_io.puts "#{desc}: #{error.class.name}: #{error}"
-      end
-      ast ||= s()
-      TreeDresser.new.dress(ast)
-    end
-  end
-
-  #
-  # Represents a file of Ruby source, whose contents will be examined
-  # for code smells.
-  #
-  class SourceFile < Source
-
-    def self.lines(file)
-      IO.readlines(file.path)
-    end
-
-    def initialize(file)
-      @file = file
-      super(SourceFile.lines(@file).join, @file.path)
-    end
-
-    def configure(sniffer)
-      path = File.expand_path(File.dirname(@file.path))
-      all_config_files(path).each { |cf| ConfigFile.new(cf).configure(sniffer) }
-    end
-
-  private
-
-    def all_config_files(path)
-      return [] unless File.exist?(path)
-      parent = File.dirname(path)
-      return [] if path == parent
-      all_config_files(parent) + Dir["#{path}/*.reek"]
-    end
-  end
-end