kevinrutherford-reek 0.3.1.6 → 1.0.0

data/History.txt

@@ -1,8 +1,8 @@
-== 0.3.x 2009-??-??
+== 1.0.0 2009-04-05
 
 === Major enhancements:
 
-* Place *.reek files in source folder to configure smell detection behaviour
+* Use *.reek files in source tree to configure Reek's behaviour
 * Added -f option to configure report format
 * --sort_order replaced by -f, -c and -s
 * Matchers provided for rspec; eg. foo.should_not reek
@@ -17,7 +17,6 @@
 
 * Corrected false reports of long arg lists to yield
 * A method can now be a UtilityFunction only when it includes a call
-* Removed the website from the gem [#12]
 
 == 0.3.1 2008-11-17
 

data/Rakefile

@@ -1,7 +1,17 @@
 require 'rake'
 require 'rake/clean'
-require 'fileutils'
 
 $:.unshift File.dirname(__FILE__) + '/lib'
 
+PROJECT_NAME = 'reek'
+
+BUILD_DIR = 'build'; directory BUILD_DIR
+PKG_DIR = "#{BUILD_DIR}/pkg"; directory PKG_DIR
+RDOC_DIR = "#{BUILD_DIR}/rdoc"; directory RDOC_DIR
+
+GEM_MANIFEST = "Manifest.txt"
+VERSION_FILE = 'lib/reek.rb'
+
+CLOBBER.include("#{BUILD_DIR}/*")
+
 Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/reek.rb

@@ -1,8 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
-require 'reek/report'
-require 'reek/smells/smells'
-
 module Reek # :doc:
-  VERSION = '0.3.1.6'
+  VERSION = '1.0.0'
 end

data/reek.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{reek}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Rutherford"]
+  s.date = %q{2009-04-05}
+  s.default_executable = %q{reek}
+  s.description = %q{Code smell detector for Ruby}
+  s.email = ["kevin@rutherford-software.com"]
+  s.executables = ["reek"]
+  s.extra_rdoc_files = ["History.txt", "README.txt"]
+  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "lib/reek.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/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", "lib/reek/smells/large_class.rb", "lib/reek/smells/long_method.rb", "lib/reek/smells/long_parameter_list.rb", "lib/reek/smells/long_yield_list.rb", "lib/reek/smells/nested_iterators.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/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/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", "spec/reek/smells/large_class_spec.rb", "spec/reek/smells/long_method_spec.rb", "spec/reek/smells/long_parameter_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/smell_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/samples/inline.rb", "spec/samples/inline_spec.rb", "spec/samples/optparse.rb", "spec/samples/optparse_spec.rb", "spec/samples/redcloth.rb", "spec/samples/redcloth_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.rake"]
+  s.has_rdoc = true
+  s.homepage = %q{http://wiki.github.com/kevinrutherford/reek}
+  s.post_install_message = %q{
+For more information on reek, see http://wiki.github.com/kevinrutherford/reek
+}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{reek}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Code smell detector for Ruby}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ParseTree>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<sexp_processor>, ["~> 3.0"])
+    else
+      s.add_dependency(%q<ParseTree>, ["~> 3.0"])
+      s.add_dependency(%q<sexp_processor>, ["~> 3.0"])
+    end
+  else
+    s.add_dependency(%q<ParseTree>, ["~> 3.0"])
+    s.add_dependency(%q<sexp_processor>, ["~> 3.0"])
+  end
+end

data/spec/reek/if_context_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/if_context'
+
+include Reek
+
+describe IfContext do
+  it 'should find a class within top-level code' do
+    'unless jim; class Array; end; end'.should_not reek
+  end
+
+  it 'should find class within top-level code' do
+    stopctx = StopContext.new
+    ifctx = IfContext.new(stopctx, [:if, [:vcall, :jim]])
+    ifctx.find_module(Name.new(:Array)).should_not be_nil
+  end
+end

data/spec/reek/method_context_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/method_context'
+require 'reek/stop_context'
+
+include Reek
+
+describe MethodContext, 'matching' do
+  before :each do
+    @element = MethodContext.new(StopContext.new, [0, :mod])
+  end
+
+  it 'should recognise itself in a collection of names' do
+    @element.matches?(['banana', 'mod']).should == true
+    @element.matches?(['banana']).should == false
+  end
+
+  it 'should recognise itself in a collection of REs' do
+    @element.matches?([/banana/, /mod/]).should == true
+    @element.matches?([/banana/]).should == false
+  end
+end
+
+describe MethodContext, 'matching fq names' do
+  before :each do
+    element = StopContext.new
+    element = ModuleContext.new(element, [0, :mod])
+    element = ClassContext.new(element, [0, :klass])
+    @element = MethodContext.new(element, [0, :meth])
+  end
+
+  it 'should recognise itself in a collection of names' do
+    @element.matches?(['banana', 'meth']).should == true
+    @element.matches?(['banana', 'klass#meth']).should == true
+    @element.matches?(['banana']).should == false
+  end
+
+  it 'should recognise itself in a collection of names' do
+    @element.matches?([/banana/, /meth/]).should == true
+    @element.matches?([/banana/, /klass#meth/]).should == true
+    @element.matches?([/banana/]).should == false
+  end
+end
+
+describe MethodContext do
+  it 'should record ivars as refs to self' do
+    mctx = MethodContext.new(StopContext.new, [:defn, :feed])
+    mctx.envious_receivers.should == []
+    mctx.record_call_to([:call, [:ivar, :@cow], :feed_to])
+    mctx.envious_receivers.should == []
+  end
+end

data/spec/samples/inline_spec.rb

@@ -35,6 +35,6 @@ describe 'sample gem source code' do
     ruby.should reek_of(:UncommunicativeName, /Inline::C#module_name/, /'x'/)
     ruby.should reek_of(:UncommunicativeName, /Inline::C#parse_signature/, /'x'/)
     ruby.should reek_of(:UtilityFunction, /Inline::C#strip_comments/)
-    ruby.report.length.should == 32
+    ruby.report.should have_at_most(32).smells
   end
 end

data/spec/samples/optparse_spec.rb

@@ -95,6 +95,6 @@ describe 'sample gem source code' do
     ruby.should reek_of(:UncommunicativeName, /OptionParser#summarize/, /'l'/)
     ruby.should reek_of(:UncommunicativeName, /OptionParser#ver/, /'v'/)
     ruby.should reek_of(:UncommunicativeName, /block/, /'q'/)
-    ruby.report.length.should == 92
+    ruby.report.should have_at_most(92).smells
   end
 end

data/spec/samples/redcloth_spec.rb

@@ -88,6 +88,6 @@ describe 'sample gem source code' do
     ruby.should reek_of(:UtilityFunction, /RedCloth#incoming_entities/)
     ruby.should reek_of(:UtilityFunction, /RedCloth#no_textile/)
     ruby.should reek_of(:UtilityFunction, /RedCloth#v_align/)
-    ruby.report.length.should == 85
+    ruby.report.should have_at_most(85).smells
   end
 end

data/tasks/reek.rake

@@ -5,16 +5,3 @@ Reek::RakeTask.new do |t|
   t.verbose = false
 #  t.reek_opts = '-f "Smell: %s: %c %w"'
 end
-
-begin
-  require 'flay'
-
-  desc 'Check for code duplication'
-  task 'flay' do
-    files = FileList['lib/**/*.rb']
-    flayer = Flay.new(16)
-    flayer.process(*files)
-    flayer.report
-  end
-rescue LoadError
-end

data/tasks/rspec.rake

@@ -1,10 +1,9 @@
-require 'rake/clean'
 require 'spec'
 require 'spec/rake/spectask'
 
 namespace 'rspec' do
   FAST = FileList['spec/reek/**/*_spec.rb']
-  SLOW = FileList['spec/integration/**/*_spec.rb'] + FileList['spec/samples/**/*_spec.rb']
+  SLOW = FileList['spec/integration/**/*_spec.rb', 'spec/samples/**/*_spec.rb']
 
   Spec::Rake::SpecTask.new('fast') do |t|
     t.spec_files = FAST

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 0.3.1.6
+  version: 1.0.0
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-31 00:00:00 -07:00
+date: 2009-04-05 00:00:00 -07:00
 default_executable: reek
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,27 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "3.0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.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.0
-    version: 
-description: ""
+description: Code smell detector for Ruby
 email: 
 - kevin@rutherford-software.com
 executables: 
@@ -82,11 +62,9 @@ files:
 - lib/reek/options.rb
 - lib/reek/rake_task.rb
 - lib/reek/report.rb
-- lib/reek/smell_warning.rb
-- lib/reek/source.rb
-- lib/reek/spec.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
@@ -99,14 +77,19 @@ files:
 - lib/reek/smells/smells.rb
 - lib/reek/smells/uncommunicative_name.rb
 - lib/reek/smells/utility_function.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