reek 1.1.3 → 1.2.0

data/README.txt

@@ -1,6 +0,0 @@
-= Reek
-
-Code smell detection for Ruby.
-
-The documentation is at http://wiki.github.com/kevinrutherford/reek
-The code lives at http://github.com/kevinrutherford/reek/tree

data/lib/reek/options.rb

@@ -1,92 +0,0 @@
-require 'optparse'
-require 'reek/source'
-
-module Reek
-    
-  class Options
-
-    CTX_SORT = '%c %w (%s)'
-    SMELL_SORT = '[%s] %c %w'
-
-    def self.default_options
-      {
-        :format => CTX_SORT
-      }
-    end
-    
-    @@opts = default_options
-
-    def self.[](key)
-      @@opts[key]
-    end
-
-    def self.parse_args(args)
-      result = default_options
-      parser = OptionParser.new { |opts| set_options(opts, result) }
-      parser.parse!(args)
-      result
-    end
-    
-    def self.set_options(opts, config)
-      opts.banner = <<EOB
-Usage: #{opts.program_name} [options] files...
-
-If no files are given, Reek reads source code from standard input.
-See http://wiki.github.com/kevinrutherford/reek for detailed help.
-EOB
-      
-      opts.separator "\nOptions:"
-      set_help_option(opts)
-      set_sort_option(config, opts)
-      set_version_option(opts)
-    end
-
-    def self.parse(args)
-      begin
-        @@opts = parse_args(args)
-        if ARGV.length > 0
-          return Source.from_pathlist(ARGV)
-        else
-          return Source.from_io($stdin, 'stdin')
-        end
-      rescue OptionParser::ParseError, SystemCallError => err
-        fatal_error(err)
-      end
-    end
-
-  private
-    
-    def self.set_version_option(opts)
-      opts.on("-v", "--version", "Show version") do
-        puts "#{opts.program_name} #{Reek::VERSION}"
-        exit(0)
-      end
-    end
-
-    def self.set_help_option(opts)
-      opts.on("-h", "--help", "Show this message") do
-        puts opts
-        exit(0)
-      end
-    end
-
-    def self.set_sort_option(config, opts)
-      opts.on('-f', "--format FORMAT", 'Specify the format of smell warnings') do |arg|
-        config[:format] = arg unless arg.nil?
-      end
-      opts.on('-c', '--context-first', "Sort by context; sets the format string to \"#{CTX_SORT}\"") do
-        config[:format] = CTX_SORT
-      end
-      opts.on('-s', '--smell-first', "Sort by smell; sets the format string to \"#{SMELL_SORT}\"") do
-        config[:format] = SMELL_SORT
-      end
-    end
-    
-    def self.fatal_error(err) # :nodoc:
-      puts "Error: #{err}"
-      puts "Use '-h' for help."
-      exit(1)
-    end
-    
-  end
-end

data/lib/reek/report.rb

@@ -1,81 +0,0 @@
-require 'set'
-require 'reek/smells/smell_detector'
-
-module Reek
-  class Report
-    include Enumerable
-
-    def initialize  # :nodoc:
-      @report = SortedSet.new
-    end
-
-    #
-    # Yields, in turn, each SmellWarning in this report.
-    #
-    def each
-      @report.each { |smell| yield smell }
-    end
-
-    def <<(smell)  # :nodoc:
-      @report << smell
-      true
-    end
-    
-    def empty?
-      @report.empty?
-    end
-
-    def length
-      @report.length
-    end
-    
-    alias size length
-
-    def [](index)  # :nodoc:
-      @report.to_a[index]
-    end
-
-    # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
-    # this report, with a heading.
-    def full_report(desc)
-      "\"#{desc}\" -- #{length} warnings:\n#{to_s}\n"
-    end
-
-    # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
-    # this report.
-    def to_s
-      @report.map {|smell| smell.report}.join("\n")
-    end
-  end
-
-  class ReportList
-    include Enumerable
-
-    def initialize(sources)
-      @sources = sources
-    end
-
-    #
-    # Yields, in turn, each SmellWarning in every report in this report.
-    #
-    def each(&blk)
-      @sources.each {|src| src.report.each(&blk) }
-    end
-
-    def empty?
-      length == 0
-    end
-
-    def length
-      @sources.inject(0) {|sum, src| sum + src.report.length }
-    end
-
-    def smelly_sources
-      @sources.select {|src| src.smelly? }
-    end
-
-    def to_s
-      smelly_sources.map { |src| src.full_report }.join("\n")
-    end
-  end
-end

data/lib/reek/smells/smells.rb

@@ -1,81 +0,0 @@
-require 'reek/smells/control_couple'
-require 'reek/smells/duplication'
-require 'reek/smells/feature_envy'
-require 'reek/smells/large_class'
-require 'reek/smells/long_method'
-require 'reek/smells/long_parameter_list'
-require 'reek/smells/long_yield_list'
-require 'reek/smells/nested_iterators'
-require 'reek/smells/uncommunicative_name'
-require 'reek/smells/utility_function'
-require 'yaml'
-
-class Hash
-  def push_keys(hash)
-    keys.each {|key| hash[key].adopt!(self[key]) }
-  end
-
-  def adopt!(other)
-    other.keys.each do |key|
-      ov = other[key]
-      if Array === ov and has_key?(key)
-        self[key] += ov
-      else
-        self[key] = ov
-      end
-    end
-    self
-  end
-  
-  def adopt(other)
-    self.deep_copy.adopt!(other)
-  end
-  
-  def deep_copy
-    YAML::load(YAML::dump(self))
-  end
-end
-
-module Reek
-  class SmellConfig
-
-    SMELL_CLASSES = [
-      Smells::ControlCouple,
-      Smells::Duplication,
-      Smells::FeatureEnvy,
-      Smells::LargeClass,
-      Smells::LongMethod,
-      Smells::LongParameterList,
-      Smells::LongYieldList,
-      Smells::NestedIterators,
-      Smells::UncommunicativeName,
-      Smells::UtilityFunction,
-    ]
-
-    def initialize
-      defaults_file = File.join(File.dirname(__FILE__), '..', '..', '..', 'config', 'defaults.reek')
-      @config = YAML.load_file(defaults_file)
-    end
-
-    def smell_listeners()
-      result = Hash.new {|hash,key| hash[key] = [] }
-      SMELL_CLASSES.each { |smell| smell.listen(result, @config) }
-      return result
-    end
-
-    def load_local(file)
-      path = File.expand_path(file)
-      all_reekfiles(path).each do |rfile|
-        YAML.load_file(rfile).push_keys(@config)
-      end
-      self
-    end
-
-    def all_reekfiles(path)
-      return [] unless File.exist?(path)
-      parent = File.dirname(path)
-      return [] if path == parent
-      all_reekfiles(parent) + Dir["#{path}/*.reek"]
-    end
-  end
-end

data/lib/reek/source.rb

@@ -1,127 +0,0 @@
-require 'reek/code_parser'
-require 'reek/report'
-require 'reek/smells/smells'
-require 'ruby_parser'
-
-module Reek
-
-  #
-  # A +Source+ object represents a chunk of Ruby source code.
-  #
-  # The various class methods are factories that will create +Source+
-  # instances from various types of input.
-  #
-  class Source
-
-    #
-    # Factory method: creates a +Source+ object by reading Ruby code from
-    # the +IO+ stream. The stream is consumed upto end-of-file, but the
-    # source code is not parsed until +report+ is called. +desc+ provides
-    # a string description to be used in the header of formatted reports.
-    #
-    def self.from_io(ios, desc)
-      code = ios.readlines.join
-      return new(code, desc)
-    end
-
-    #
-    # Factory method: creates a +Source+ object by reading Ruby code from
-    # the +code+ string. The code is not parsed until +report+ is called.
-    #
-    def self.from_s(code)
-      return new(code, 'string')
-    end
-
-    #
-    # Factory method: creates a +Source+ object by reading Ruby code from
-    # File +file+. The source code is not parsed until +report+ is called.
-    #
-    def self.from_f(file)
-      from_path(file.path)
-    end
-
-    #
-    # Factory method: creates a +Source+ object by reading Ruby code from
-    # the named file. The source code is not parsed until +report+ is called.
-    #
-    def self.from_path(filename)
-      code = IO.readlines(filename).join
-      return new(code, filename, File.dirname(filename))
-    end
-
-    #
-    # Factory method: creates a +Source+ object from an array of file paths.
-    # No source code is actually parsed until the report is accessed.
-    #
-    def self.from_pathlist(paths)
-      sources = paths.map {|path| Source.from_path(path) }
-      SourceList.new(sources)
-    end
-
-    def initialize(code, desc, dir = nil)     # :nodoc:
-      @source = code
-      @desc = desc
-      @cf = SmellConfig.new
-      @cf = @cf.load_local(dir) if dir
-    end
-
-    def generate_syntax_tree
-      RubyParser.new.parse(@source, @desc) || s()
-    end
-
-    #
-    # Returns a +Report+ listing the smells found in this source. The first
-    # call to +report+ parses the source code and constructs a list of
-    # +SmellWarning+s found; subsequent calls simply return this same list.
-    #
-    def report
-      unless @report
-        @report = Report.new
-        parser = CodeParser.new(@report, @cf.smell_listeners)
-        parser.process(generate_syntax_tree)
-      end
-      @report
-    end
-
-    def smelly?
-      report.length > 0
-    end
-
-    #
-    # Checks this source for instances of +smell_class+, and returns +true+
-    # only if one of them has a report string matching all of the +patterns+.
-    #
-    def has_smell?(smell_class, patterns)
-      report.any? { |smell| smell.matches?(smell_class, patterns) }
-    end
-
-    # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
-    # this report, with a heading.
-    def full_report
-      report.full_report(@desc)
-    end
-
-    def to_s
-      @desc
-    end
-  end
-
-  #
-  # Represents a list of Sources as if they were a single source.
-  #
-  class SourceList
-    def initialize(sources)
-      @sources = sources
-    end
-
-    def smelly?
-      @sources.any? {|source| source.smelly? }
-    end
-
-    def report
-      ReportList.new(@sources)
-    end
-  end
-end
-
-require 'reek/object_source'

data/spec/reek/options_spec.rb

@@ -1,13 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
- 
-require 'reek/options'
-
-include Reek
-
-describe Options, ' when given no arguments' do
-  it "should retain the default sort order" do
-    default_order = Options[:format]
-    Options.parse ['nosuchfile.rb']
-    Options[:format].should == default_order
-  end
-end

data/spec/reek/report_spec.rb

@@ -1,48 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-require 'reek/smells/smell_detector'
-require 'reek/report'
-require 'reek/source'
-require 'reek/smells/feature_envy'
-
-include Reek
-
-describe Report, " when empty" do
-  before(:each) do
-    @rpt = Report.new
-  end
-
-  it 'should have zero length' do
-    @rpt.length.should == 0
-  end
-
-  it 'should claim to be empty' do
-    @rpt.should be_empty
-  end
-end
-
-describe Report, "to_s" do
-  before(:each) do
-    rpt = Source.from_s('def simple(a) a[3] end').report
-    @report = rpt.to_s.split("\n")
-  end
-
-  it 'should place each detailed report on a separate line' do
-    @report.should have_at_least(2).lines
-  end
-
-  it 'should mention every smell name' do
-    @report[0].should match(/[Utility Function]/)
-    @report[1].should match(/[Feature Envy]/)
-  end
-end
-
-describe Report, " as a SortedSet" do
-  it 'should only add a smell once' do
-    rpt = Report.new
-    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!')
-    rpt.length.should == 1
-    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!')
-    rpt.length.should == 1
-  end
-end