reek 0.3.1 → 1.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-17 00:00:00 +00:00
+date: 2009-04-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,17 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "3.0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
-    version: 
-description: detects smells in Ruby code
+description: Code smell detector for Ruby
 email: 
 - kevin@rutherford-software.com
 executables: 
@@ -52,22 +42,29 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - README.txt
-- website/index.txt
 files: 
 - History.txt
 - README.txt
 - Rakefile
 - bin/reek
+- config/defaults.reek
 - lib/reek.rb
-- lib/reek/checker.rb
-- lib/reek/class_checker.rb
-- lib/reek/file_checker.rb
-- lib/reek/method_checker.rb
+- lib/reek/block_context.rb
+- lib/reek/class_context.rb
+- lib/reek/code_context.rb
+- lib/reek/code_parser.rb
+- lib/reek/exceptions.reek
+- lib/reek/if_context.rb
+- lib/reek/method_context.rb
+- lib/reek/module_context.rb
+- lib/reek/name.rb
 - lib/reek/object_refs.rb
 - lib/reek/options.rb
-- lib/reek/printer.rb
 - lib/reek/rake_task.rb
 - lib/reek/report.rb
+- lib/reek/sexp_formatter.rb
+- lib/reek/singleton_method_context.rb
+- lib/reek/smell_warning.rb
 - lib/reek/smells/control_couple.rb
 - lib/reek/smells/duplication.rb
 - lib/reek/smells/feature_envy.rb
@@ -76,19 +73,29 @@ files:
 - lib/reek/smells/long_parameter_list.rb
 - lib/reek/smells/long_yield_list.rb
 - lib/reek/smells/nested_iterators.rb
-- lib/reek/smells/smell.rb
+- lib/reek/smells/smell_detector.rb
 - lib/reek/smells/smells.rb
 - lib/reek/smells/uncommunicative_name.rb
 - lib/reek/smells/utility_function.rb
-- lib/reek/version.rb
-- setup.rb
-- spec/integration_spec.rb
-- spec/reek/class_checker_spec.rb
-- spec/reek/method_checker_spec.rb
+- lib/reek/source.rb
+- lib/reek/spec.rb
+- lib/reek/stop_context.rb
+- lib/reek/yield_call_context.rb
+- reek.gemspec
+- spec/integration/reek_source_spec.rb
+- spec/integration/script_spec.rb
+- spec/reek/class_context_spec.rb
+- spec/reek/code_context_spec.rb
+- spec/reek/code_parser_spec.rb
+- spec/reek/config_spec.rb
+- spec/reek/if_context_spec.rb
+- spec/reek/method_context_spec.rb
+- spec/reek/module_context_spec.rb
 - spec/reek/object_refs_spec.rb
 - spec/reek/options_spec.rb
-- spec/reek/printer_spec.rb
 - spec/reek/report_spec.rb
+- spec/reek/sexp_formatter_spec.rb
+- spec/reek/singleton_method_context_spec.rb
 - spec/reek/smells/control_couple_spec.rb
 - spec/reek/smells/duplication_spec.rb
 - spec/reek/smells/feature_envy_spec.rb
@@ -99,32 +106,22 @@ files:
 - spec/reek/smells/smell_spec.rb
 - spec/reek/smells/uncommunicative_name_spec.rb
 - spec/reek/smells/utility_function_spec.rb
-- spec/reek_source_spec.rb
 - spec/samples/inline.rb
-- spec/samples/inline.reek
+- spec/samples/inline_spec.rb
 - spec/samples/optparse.rb
-- spec/samples/optparse.reek
-- spec/samples/optparse/date.rb
-- spec/samples/optparse/shellwords.rb
-- spec/samples/optparse/time.rb
-- spec/samples/optparse/uri.rb
-- spec/samples/optparse/version.rb
+- spec/samples/optparse_spec.rb
 - spec/samples/redcloth.rb
-- spec/samples/redcloth.reek
-- spec/script_spec.rb
+- spec/samples/redcloth_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/reek.rake
 - tasks/rspec.rake
-- tasks/samples.rake
-- website/index.html
-- website/index.txt
-- website/javascripts/rounded_corners_lite.inc.js
-- website/stylesheets/screen.css
-- website/template.rhtml
 has_rdoc: true
-homepage: http://reek.rubyforge.org
-post_install_message: 
+homepage: http://wiki.github.com/kevinrutherford/reek
+post_install_message: |
+  
+  For more information on reek, see http://wiki.github.com/kevinrutherford/reek
+
 rdoc_options: 
 - --main
 - README.txt
@@ -145,9 +142,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: reek
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: detects smells in Ruby code
+summary: Code smell detector for Ruby
 test_files: []
 

data/lib/reek/checker.rb

@@ -1,66 +0,0 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'rubygems'
-require 'parse_tree'
-require 'sexp_processor'
-
-module Reek
-
-  class Checker < SexpProcessor
-
-    def self.parse_tree_for(code)   # :nodoc:
-      ParseTree.new.parse_tree_for_string(code)
-    end
-
-    # Creates a new Ruby code checker. Any smells discovered by
-    # +check_source+ or +check_object+ will be stored in +report+.
-    def initialize(report)
-      super()
-      @smells = report
-      @unsupported -= [:cfunc]
-      @default_method = :process_default
-      @require_empty = @warn_on_default = false
-    end
-
-    def process_default(exp)
-      exp[1..-1].each { |e| process(e) if Array === e}
-      s(exp)
-    end
-
-    def process_defn(exp)  # :nodoc:
-      Reek::MethodChecker.new(@smells, @description).process(exp)
-      s(exp)
-    end  
-
-    def report(smell)  # :nodoc:
-      @smells << smell
-    end
-
-    # Analyses the given Ruby source +code+ looking for smells.
-    # Any smells found are saved in the +Report+ object that
-    # was passed to this object's constructor.
-    def check_source(code)
-      check_parse_tree(Checker.parse_tree_for(code))
-    end
-
-    # Analyses the given Ruby object +obj+ looking for smells.
-    # Any smells found are saved in the +Report+ object that
-    # was passed to this object's constructor.
-    def check_object(obj)
-      check_parse_tree ParseTree.new.parse_tree(obj)
-    end
-    
-    def to_s  # :nodoc:
-      description
-    end
-
-    def check_parse_tree(sexp)  # :nodoc:
-      sexp.each { |exp| process(exp) }
-    end
-  end
-end
-
-# SMELL:
-# This is here to resolve a circular dependency -- MethodChecker inherits
-# Checker, which calls MethodChecker. Yuk!
-require 'reek/method_checker'

data/lib/reek/class_checker.rb

@@ -1,25 +0,0 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'reek/checker'
-require 'reek/smells/large_class'
-
-module Reek
-
-  class ClassChecker < Checker
-    
-    attr_accessor :description
-
-    def initialize(report)
-      super(report)
-      @description = ''
-    end
-
-    def process_class(exp)  # :nodoc:
-      @description = exp[1].to_s
-      superclass = exp[2]
-      Smells::LargeClass.check(@description, self)
-      exp[3..-1].each { |defn| process(defn) } unless superclass == [:const, :Struct]
-      s(exp)
-    end
-  end
-end

data/lib/reek/file_checker.rb

@@ -1,20 +0,0 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'reek/checker'
-require 'reek/class_checker'
-
-module Reek
-
-  class FileChecker < Checker
-
-    def initialize(report)
-      super(report)
-      @description = ''
-    end
-
-    def process_class(exp)  # :nodoc:
-      Reek::ClassChecker.new(@smells).process(exp)
-      s(exp)
-    end
-  end
-end

data/lib/reek/method_checker.rb

@@ -1,198 +0,0 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'reek/checker'
-require 'reek/smells/control_couple'
-require 'reek/smells/feature_envy'
-require 'reek/smells/long_parameter_list'
-require 'reek/smells/long_yield_list'
-require 'reek/smells/nested_iterators'
-require 'reek/smells/utility_function'
-require 'reek/smells/smells'
-require 'reek/object_refs'
-require 'set'
-
-module Reek
-
-  class MethodChecker < Checker
-
-    attr_reader :local_variables, :name, :parameters, :num_statements
-    attr_reader :instance_variables     # TODO: should be on the class
-    attr_reader :calls, :depends_on_self, :refs
-
-    def initialize(smells, klass_name)
-      super(smells)
-      @class_name = klass_name
-      @refs = ObjectRefs.new
-      @local_variables = Set.new
-      @instance_variables = Set.new
-      @parameters = []
-      @calls = Hash.new(0)
-      @num_statements = 0
-      @depends_on_self = false
-    end
-    
-    def description
-      "#{@class_name}##{@name}"
-    end
-
-    def process_defn(exp)
-      name, args = exp[1..2]
-      @name = name.to_s
-      process(args)
-      check_method_properties
-      s(exp)
-    end
-
-    def process_args(exp)
-      Smells::LongParameterList.check(exp, self)
-      @parameters = exp[1..-1]
-      s(exp)
-    end
-
-    def process_attrset(exp)
-      @depends_on_self = true if /^@/ === exp[1].to_s
-      s(exp)
-    end
-
-    def process_lit(exp)
-      val = exp[1]
-      @depends_on_self = true if val == :self
-      s(exp)
-    end
-
-    def process_lvar(exp)
-      s(exp)
-    end
-
-    def process_iter(exp)
-      Smells::NestedIterators.check(@inside_an_iter, self)
-      cascade_iter(exp)
-      s(exp)
-    end
-
-    def process_block(exp)
-      @num_statements += MethodChecker.count_statements(exp)
-      exp[1..-1].each { |s| process(s) }
-      s(exp)
-    end
-
-    def process_yield(exp)
-      args = exp[1]
-      if args
-        Smells::LongYieldList.check(args, self)
-        process(args)
-      end
-      s(exp)
-    end
-
-    def process_call(exp)
-      @calls[exp] += 1
-      receiver, meth, args = exp[1..3]
-      deal_with_receiver(receiver, meth)
-      process(args) if args
-      s(exp)
-    end
-
-    def process_fcall(exp)
-      @depends_on_self = true
-      @refs.record_reference_to_self
-      process(exp[2]) if exp.length >= 3
-      s(exp)
-    end
-
-    def process_cfunc(exp)
-      @depends_on_self = true
-      s(exp)
-    end
-
-    def process_vcall(exp)
-      @depends_on_self = true
-      s(exp)
-    end
-
-    def process_if(exp)
-      cond, then_part, else_part = exp[1..3]
-      deal_with_conditional(cond, then_part)
-      process(else_part) if else_part
-      Smells::ControlCouple.check(cond, self, @parameters)
-      s(exp)
-    end
-
-    def process_ivar(exp)
-      @instance_variables << exp[1]
-      @depends_on_self = true
-      s(exp)
-    end
-
-    def process_gvar(exp)
-      s(exp)
-    end
-
-    def process_lasgn(exp)
-      @local_variables << exp[1]
-      process(exp[2])
-      s(exp)
-    end
-
-    def process_iasgn(exp)
-      @instance_variables << exp[1]
-      @depends_on_self = true
-      process(exp[2])
-      s(exp)
-    end
-
-    def process_self(exp)
-      @depends_on_self = true
-      s(exp)
-    end
-
-  private
-
-    def self.count_statements(exp)
-      result = exp.length - 1
-      result -= 1 if Array === exp[1] and exp[1][0] == :args
-      result -= 1 if exp[2] == s(:nil)
-      result
-    end
-
-    def self.is_global_variable?(exp)
-      Array === exp and exp[0] == :gvar
-    end
-
-    def self.is_override?(class_name, method_name)
-      begin
-        klass = Object.const_get(class_name)
-      rescue
-        return false
-      end
-      return false unless klass.superclass
-      klass.superclass.instance_methods.include?(method_name)
-    end
-
-    def is_override?
-      MethodChecker.is_override?(@class_name, @name)
-    end
-
-    def check_method_properties
-      @depends_on_self = true if is_override?
-      SMELLS[:defn].each {|smell| smell.examine(self, @smells) }
-    end
-
-    def cascade_iter(exp)
-      process(exp[1])
-      @inside_an_iter = true
-      exp[2..-1].each { |s| process(s) }
-      @inside_an_iter = false
-    end
-
-    def deal_with_conditional(cond, then_part)
-      process(cond)
-      process(then_part)
-    end
-
-    def deal_with_receiver(receiver, meth)
-      @refs.record_ref(receiver) if (receiver[0] == :lvar and meth != :new)
-      process(receiver)
-    end
-  end
-end