reek 1.2.6 → 1.2.7

data/spec/samples/two_smelly_files/dirty_two.rb

@@ -1,7 +1,8 @@
+# smelly class for testing purposes
 class Dirty
   def a
     puts @s.title
-    @s.map {|x| x.each {|key| key += 3}}
+    @s = p.map {|x| x.each {|key| key += 3}}
     puts @s.title
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-$:.unshift File.dirname(__FILE__) + '/../lib'
 
 require 'rubygems'
 begin
@@ -10,6 +9,6 @@ end
 
 require 'spec/autorun'
 
-require 'reek/adapters/spec'
+require File.join((File.dirname(File.dirname(File.expand_path(__FILE__)))), 'lib', 'reek', 'spec')
 
 SAMPLES_DIR = 'spec/samples' unless Object.const_defined?('SAMPLES_DIR')

data/tasks/reek.rake

@@ -1,7 +1,7 @@
 begin
-  require 'reek/adapters/rake_task'
+  require 'reek/rake/task'
 
-  Reek::RakeTask.new do |t|
+  Reek::Rake::Task.new do |t|
     t.fail_on_error = true
     t.verbose = false
     t.reek_opts = '--quiet'

data/tasks/test.rake

@@ -14,6 +14,13 @@ namespace 'test' do
     t.rcov = false
   end
 
+  desc 'Tests various release attributes of the gem'
+  Spec::Rake::SpecTask.new('gem') do |t|
+    t.spec_files = FileList['spec/gem/**/*_spec.rb']
+    t.rcov = false
+  end
+
+  desc 'Tests code quality'
   Spec::Rake::SpecTask.new('quality') do |t|
     t.spec_files = FileList['quality/**/*_spec.rb']
     t.spec_opts = ['--color']
@@ -37,14 +44,16 @@ namespace 'test' do
     t.cucumber_opts = "features --format progress --color"
   end
 
-  desc 'Runs all unit tests, acceptance tests and quality checks'
+  desc 'Runs all unit tests and acceptance tests'
   task 'all' => ['test:spec', 'test:features', 'test:multiruby']
+
+  task 'release' => ['test:gem', 'test:all']
 end
 
 task 'clobber_rcov' => 'test:clobber_rcov'
 
-desc 'synonym for test:spec'
+desc 'Synonym for test:spec'
 task 'spec' => 'test:spec'
 
-desc 'synonym for test:all'
+desc 'Synonym for test:all'
 task 'test' => 'test:all'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-28 00:00:00 +00:00
+date: 2010-02-01 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,11 +55,11 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - License.txt
-- README.rdoc
 files: 
+- .yardopts
 - History.txt
 - License.txt
-- README.rdoc
+- README.md
 - Rakefile
 - bin/reek
 - config/defaults.reek
@@ -72,38 +72,40 @@ files:
 - features/stdin.feature
 - features/step_definitions/reek_steps.rb
 - features/support/env.rb
+- features/yaml.feature
 - lib/reek.rb
-- lib/reek/adapters/application.rb
-- lib/reek/adapters/command_line.rb
-- lib/reek/adapters/config_file.rb
-- lib/reek/adapters/core_extras.rb
-- lib/reek/adapters/rake_task.rb
-- lib/reek/adapters/report.rb
-- lib/reek/adapters/source.rb
-- lib/reek/adapters/spec.rb
-- lib/reek/block_context.rb
-- lib/reek/class_context.rb
-- lib/reek/code_context.rb
-- lib/reek/code_parser.rb
-- lib/reek/configuration.rb
-- lib/reek/detector_stack.rb
-- lib/reek/help_command.rb
-- lib/reek/if_context.rb
-- lib/reek/masking_collection.rb
-- lib/reek/method_context.rb
-- lib/reek/module_context.rb
-- lib/reek/name.rb
-- lib/reek/object_refs.rb
-- lib/reek/reek_command.rb
-- lib/reek/sexp_formatter.rb
-- lib/reek/singleton_method_context.rb
+- lib/reek/cli/application.rb
+- lib/reek/cli/command_line.rb
+- lib/reek/cli/help_command.rb
+- lib/reek/cli/reek_command.rb
+- lib/reek/cli/report.rb
+- lib/reek/cli/version_command.rb
+- lib/reek/cli/yaml_command.rb
+- lib/reek/core/block_context.rb
+- lib/reek/core/class_context.rb
+- lib/reek/core/code_context.rb
+- lib/reek/core/code_parser.rb
+- lib/reek/core/detector_stack.rb
+- lib/reek/core/masking_collection.rb
+- lib/reek/core/method_context.rb
+- lib/reek/core/module_context.rb
+- lib/reek/core/object_refs.rb
+- lib/reek/core/singleton_method_context.rb
+- lib/reek/core/smell_configuration.rb
+- lib/reek/core/sniffer.rb
+- lib/reek/core/stop_context.rb
+- lib/reek/examiner.rb
+- lib/reek/rake/task.rb
 - lib/reek/smell_warning.rb
+- lib/reek/smells.rb
 - lib/reek/smells/attribute.rb
+- lib/reek/smells/boolean_parameter.rb
 - lib/reek/smells/class_variable.rb
 - lib/reek/smells/control_couple.rb
 - lib/reek/smells/data_clump.rb
 - lib/reek/smells/duplication.rb
 - lib/reek/smells/feature_envy.rb
+- lib/reek/smells/irresponsible_module.rb
 - lib/reek/smells/large_class.rb
 - lib/reek/smells/long_method.rb
 - lib/reek/smells/long_parameter_list.rb
@@ -111,55 +113,72 @@ files:
 - lib/reek/smells/nested_iterators.rb
 - lib/reek/smells/simulated_polymorphism.rb
 - lib/reek/smells/smell_detector.rb
-- lib/reek/smells/uncommunicative_name.rb
+- lib/reek/smells/uncommunicative_method_name.rb
+- lib/reek/smells/uncommunicative_module_name.rb
+- lib/reek/smells/uncommunicative_parameter_name.rb
+- lib/reek/smells/uncommunicative_variable_name.rb
 - lib/reek/smells/utility_function.rb
-- lib/reek/sniffer.rb
-- lib/reek/stop_context.rb
-- lib/reek/tree_dresser.rb
-- lib/reek/version_command.rb
-- lib/reek/yield_call_context.rb
+- lib/reek/source.rb
+- lib/reek/source/code_comment.rb
+- lib/reek/source/config_file.rb
+- lib/reek/source/core_extras.rb
+- lib/reek/source/sexp_formatter.rb
+- lib/reek/source/source_code.rb
+- lib/reek/source/source_file.rb
+- lib/reek/source/source_locator.rb
+- lib/reek/source/tree_dresser.rb
+- lib/reek/spec.rb
+- lib/reek/spec/should_reek.rb
+- lib/reek/spec/should_reek_of.rb
+- lib/reek/spec/should_reek_only_of.rb
 - reek.gemspec
-- spec/reek/adapters/report_spec.rb
-- spec/reek/adapters/should_reek_of_spec.rb
-- spec/reek/adapters/should_reek_only_of_spec.rb
-- spec/reek/adapters/should_reek_spec.rb
-- spec/reek/adapters/source_spec.rb
-- spec/reek/block_context_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/configuration_spec.rb
-- spec/reek/help_command_spec.rb
-- spec/reek/if_context_spec.rb
-- spec/reek/masking_collection_spec.rb
-- spec/reek/method_context_spec.rb
-- spec/reek/module_context_spec.rb
-- spec/reek/name_spec.rb
-- spec/reek/object_refs_spec.rb
-- spec/reek/object_source_spec.rb
-- spec/reek/reek_command_spec.rb
-- spec/reek/singleton_method_context_spec.rb
+- spec/reek/cli/help_command_spec.rb
+- spec/reek/cli/reek_command_spec.rb
+- spec/reek/cli/report_spec.rb
+- spec/reek/cli/version_command_spec.rb
+- spec/reek/cli/yaml_command_spec.rb
+- spec/reek/core/block_context_spec.rb
+- spec/reek/core/class_context_spec.rb
+- spec/reek/core/code_context_spec.rb
+- spec/reek/core/code_parser_spec.rb
+- spec/reek/core/config_spec.rb
+- spec/reek/core/masking_collection_spec.rb
+- spec/reek/core/method_context_spec.rb
+- spec/reek/core/module_context_spec.rb
+- spec/reek/core/object_refs_spec.rb
+- spec/reek/core/singleton_method_context_spec.rb
+- spec/reek/core/smell_configuration_spec.rb
+- spec/reek/core/stop_context_spec.rb
+- spec/reek/examiner_spec.rb
 - spec/reek/smell_warning_spec.rb
 - spec/reek/smells/attribute_spec.rb
 - spec/reek/smells/behaves_like_variable_detector.rb
+- spec/reek/smells/boolean_parameter_spec.rb
 - spec/reek/smells/class_variable_spec.rb
 - spec/reek/smells/control_couple_spec.rb
 - spec/reek/smells/data_clump_spec.rb
 - spec/reek/smells/duplication_spec.rb
 - spec/reek/smells/feature_envy_spec.rb
+- spec/reek/smells/irresponsible_module_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/long_yield_list_spec.rb
 - spec/reek/smells/nested_iterators_spec.rb
 - spec/reek/smells/simulated_polymorphism_spec.rb
-- spec/reek/smells/smell_detector_spec.rb
-- spec/reek/smells/uncommunicative_name_spec.rb
+- spec/reek/smells/smell_detector_shared.rb
+- spec/reek/smells/uncommunicative_method_name_spec.rb
+- spec/reek/smells/uncommunicative_module_name_spec.rb
+- spec/reek/smells/uncommunicative_parameter_name_spec.rb
+- spec/reek/smells/uncommunicative_variable_name_spec.rb
 - spec/reek/smells/utility_function_spec.rb
-- spec/reek/sniffer_spec.rb
-- spec/reek/stop_context_spec.rb
-- spec/reek/tree_dresser_spec.rb
-- spec/reek/version_command_spec.rb
+- spec/reek/source/code_comment_spec.rb
+- spec/reek/source/object_source_spec.rb
+- spec/reek/source/source_code_spec.rb
+- spec/reek/source/tree_dresser_spec.rb
+- spec/reek/spec/should_reek_of_spec.rb
+- spec/reek/spec/should_reek_only_of_spec.rb
+- spec/reek/spec/should_reek_spec.rb
 - spec/samples/all_but_one_masked/clean_one.rb
 - spec/samples/all_but_one_masked/dirty.rb
 - spec/samples/all_but_one_masked/masked.reek
@@ -208,7 +227,7 @@ post_install_message: |
 
 rdoc_options: 
 - --main
-- README.rdoc
+- README.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

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/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