reek 2.0.4 → 3.0.0

data/lib/reek/source/sexp_formatter.rb

@@ -1,22 +0,0 @@
-old_verbose, $VERBOSE = $VERBOSE, nil
-require 'unparser'
-$VERBOSE = old_verbose
-
-module Reek
-  module Source
-    #
-    # Formats snippets of syntax tree back into Ruby source code.
-    #
-    class SexpFormatter
-      def self.format(sexp)
-        return sexp.to_s unless sexp.is_a? AST::Node
-        lines = Unparser.unparse(sexp).split "\n"
-        if lines.length > 1
-          "#{lines.first} ... #{lines.last}"
-        else
-          lines.first
-        end
-      end
-    end
-  end
-end

data/lib/reek/source/sexp_node.rb

@@ -1,79 +0,0 @@
-module Reek
-  module Source
-    #
-    # Extensions to +Sexp+ to allow +TreeWalker+ to navigate the abstract
-    # syntax tree more easily.
-    #
-    module SexpNode
-      def self.format(expr)
-        case expr
-        when AST::Node then expr.format_ruby
-        else expr.to_s
-        end
-      end
-
-      def hash
-        inspect.hash
-      end
-
-      def each_node(type, ignoring = [], &blk)
-        if block_given?
-          look_for(type, ignoring, &blk)
-        else
-          result = []
-          look_for(type, ignoring) { |exp| result << exp }
-          result
-        end
-      end
-
-      def find_nodes(types, ignoring = [])
-        result = []
-        look_for_alt(types, ignoring) { |exp| result << exp }
-        result
-      end
-
-      def each_sexp
-        children.each { |elem| yield elem if elem.is_a? AST::Node }
-      end
-
-      #
-      # Carries out a depth-first traversal of this syntax tree, yielding
-      # every Sexp of type +target_type+. The traversal ignores any node
-      # whose type is listed in the Array +ignoring+.
-      #
-      def look_for(target_type, ignoring = [], &blk)
-        each_sexp do |elem|
-          elem.look_for(target_type, ignoring, &blk) unless ignoring.include?(elem.type)
-        end
-        blk.call(self) if type == target_type
-      end
-
-      #
-      # Carries out a depth-first traversal of this syntax tree, yielding
-      # every Sexp of type +target_type+. The traversal ignores any node
-      # whose type is listed in the Array +ignoring+, includeing the top node.
-      #
-      # Also, doesn't nest
-      #
-      def look_for_alt(target_types, ignoring = [], &blk)
-        return if ignoring.include?(type)
-        if target_types.include? type
-          blk.call(self)
-        else
-          each_sexp do |elem|
-            elem.look_for_alt(target_types, ignoring, &blk)
-          end
-        end
-      end
-
-      def contains_nested_node?(target_type)
-        look_for(target_type) { |_elem| return true }
-        false
-      end
-
-      def format_ruby
-        SexpFormatter.format(self)
-      end
-    end
-  end
-end

data/lib/reek/source/source_file.rb

@@ -1,16 +0,0 @@
-require 'reek/source/source_code'
-
-module Reek
-  module Source
-    #
-    # Represents a file of Ruby source, whose contents will be examined
-    # for code smells.
-    #
-    class SourceFile < SourceCode
-      def initialize(path)
-        @path = path
-        super(IO.readlines(@path).join, @path)
-      end
-    end
-  end
-end

data/lib/reek/source/source_repository.rb

@@ -1,45 +0,0 @@
-require 'reek/source/core_extras'
-require 'reek/source/source_code'
-require 'reek/source/source_locator'
-
-module Reek
-  module Source
-    #
-    # A collection of source code. If the collection is initialized with an array
-    # it is assumed to be a list of file paths. Otherwise it is assumed to be a
-    # single unit of Ruby source code.
-    #
-    class SourceRepository
-      # TODO: This method is a least partially broken.
-      # Regardless of how you call reek, be it:
-      #   reek lib/
-      #   reek lib/file_one.rb lib/file_two.rb
-      #   echo "def m; end" | reek
-      # we *always* end up in the "when Source::SourceCode" branch.
-      # So it seems like 80% of this method is never used.
-      def self.parse(source)
-        case source
-        when Array
-          new 'dir', Source::SourceLocator.new(source).all_sources
-        when Source::SourceCode
-          new source.desc, [source]
-        else
-          src = source.to_reek_source
-          new src.desc, [src]
-        end
-      end
-
-      include Enumerable
-      attr_reader :description
-
-      def initialize(description, sources)
-        @description = description
-        @sources = sources
-      end
-
-      def each(&block)
-        @sources.each(&block)
-      end
-    end
-  end
-end

data/lib/reek/source/tree_dresser.rb

@@ -1,24 +0,0 @@
-require 'reek/source/ast_node_class_map'
-
-module Reek
-  module Source
-    #
-    # Adorns an abstract syntax tree with mix-in modules to make accessing
-    # the tree more understandable and less implementation-dependent.
-    #
-    class TreeDresser
-      def initialize(klass_map = AstNodeClassMap.new)
-        @klass_map = klass_map
-      end
-
-      def dress(sexp, comment_map)
-        return sexp unless sexp.is_a? AST::Node
-        type = sexp.type
-        children = sexp.children.map { |child| dress(child, comment_map) }
-        comments = comment_map[sexp]
-        @klass_map.klass_for(type).new(type, children,
-                                       location: sexp.loc, comments: comments)
-      end
-    end
-  end
-end

data/lib/reek/source.rb

@@ -1,16 +0,0 @@
-require 'reek/source/code_comment'
-require 'reek/source/core_extras'
-require 'reek/source/sexp_formatter'
-require 'reek/source/source_code'
-require 'reek/source/source_file'
-require 'reek/source/source_locator'
-require 'reek/source/tree_dresser'
-
-module Reek
-  #
-  # This module contains a set of classes for interacting with Ruby
-  # source code and abstract syntax trees.
-  #
-  module Source    # :nodoc: all
-  end
-end

data/spec/reek/cli/json_report_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-require 'reek/examiner'
-require 'reek/cli/report/report'
-require 'reek/cli/report/formatter'
-
-describe Reek::Cli::Report::JsonReport do
-  let(:instance) { Reek::Cli::Report::JsonReport.new }
-
-  context 'empty source' do
-    let(:examiner) { Reek::Examiner.new('') }
-
-    before do
-      instance.add_examiner examiner
-    end
-
-    it 'prints empty json' do
-      expect { instance.show }.to output(/^\[\]$/).to_stdout
-    end
-  end
-end

data/spec/reek/cli/option_interperter_spec.rb

@@ -1,14 +0,0 @@
-require 'spec_helper'
-
-require 'reek/cli/options'
-
-describe Reek::Cli::OptionInterpreter do
-  let(:options) { OpenStruct.new }
-  let(:instance) { Reek::Cli::OptionInterpreter.new(options) }
-
-  describe '#reporter' do
-    it 'returns a Report::TextReport instance by default' do
-      expect(instance.reporter).to be_instance_of Reek::Cli::Report::TextReport
-    end
-  end
-end

data/spec/reek/cli/yaml_report_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-require 'reek/examiner'
-require 'reek/cli/report/report'
-require 'reek/cli/report/formatter'
-
-include Reek
-include Reek::Cli
-
-describe Report::YamlReport do
-  let(:instance) { Report::YamlReport.new }
-
-  context 'empty source' do
-    let(:examiner) { Examiner.new('') }
-
-    before do
-      instance.add_examiner examiner
-    end
-
-    it 'prints empty yaml' do
-      expect { instance.show }.to output(/^--- \[\]\n.*$/).to_stdout
-    end
-  end
-end

data/spec/reek/core/singleton_method_context_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-require 'reek/core/module_context'
-require 'reek/core/singleton_method_context'
-require 'reek/core/stop_context'
-
-include Reek::Core
-
-describe SingletonMethodContext do
-end

data/spec/reek/core/smell_repository_spec.rb

@@ -1,17 +0,0 @@
-require 'spec_helper'
-require 'reek/core/smell_repository'
-
-include Reek::Core
-
-describe SmellRepository do
-  describe '.smell_types' do
-    it 'should include existing smell_types' do
-      expect(SmellRepository.smell_types).to include(Reek::Smells::IrresponsibleModule)
-      expect(SmellRepository.smell_types).to include(Reek::Smells::TooManyStatements)
-    end
-
-    it 'should exclude certain smell_types' do
-      expect(SmellRepository.smell_types).to_not include(Reek::Smells::SmellDetector)
-    end
-  end
-end

data/spec/reek/core/stop_context_spec.rb

@@ -1,17 +0,0 @@
-require 'spec_helper'
-require 'reek/core/stop_context'
-
-include Reek
-include Reek::Core
-
-describe StopContext do
-  before :each do
-    @stop = StopContext.new
-  end
-
-  context 'full_name' do
-    it 'reports full context' do
-      expect(@stop.full_name).to eq('')
-    end
-  end
-end

data/spec/reek/core/warning_collector_spec.rb

@@ -1,30 +0,0 @@
-require 'spec_helper'
-require 'reek/core/warning_collector'
-require 'reek/smell_warning'
-
-include Reek::Core
-
-describe WarningCollector do
-  before(:each) do
-    @collector = WarningCollector.new
-  end
-
-  context 'when empty' do
-    it 'reports no warnings' do
-      expect(@collector.warnings).to eq([])
-    end
-  end
-
-  context 'with one warning' do
-    before :each do
-      @warning = Reek::SmellWarning.new(Reek::Smells::FeatureEnvy.new(''),
-                                        context: 'fred',
-                                        lines:   [1, 2, 3],
-                                        message: 'hello')
-      @collector.found_smell(@warning)
-    end
-    it 'reports that warning' do
-      expect(@collector.warnings).to eq([@warning])
-    end
-  end
-end

data/spec/reek/source/object_source_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-
-include Reek
-
-describe Dir do
-  it 'reports correct smells via the Dir matcher' do
-    files = Dir['spec/samples/two_smelly_files/*.rb']
-    expect(files).to reek
-    expect(files).to reek_of(:UncommunicativeVariableName)
-    expect(files).not_to reek_of(:LargeClass)
-  end
-
-  it 'copes with daft file specs' do
-    expect(Dir['spec/samples/two_smelly_files/*/.rb']).not_to reek
-  end
-
-  it 'copes with empty array' do
-    expect([]).not_to reek
-  end
-end

data/spec/reek/source/tree_dresser_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-require 'reek/source/tree_dresser'
-
-include Reek::Source
-
-describe TreeDresser do
-  let(:ifnode) { Parser::AST::Node.new(:if) }
-  let(:sendnode) { Parser::AST::Node.new(:send) }
-  let(:dresser) { TreeDresser.new }
-
-  it 'dresses :if sexp with IfNode' do
-    expect(dresser.dress(ifnode, {})).to be_a Reek::Source::SexpExtensions::IfNode
-  end
-
-  it 'dresses :send sexp with SendNode' do
-    expect(dresser.dress(sendnode, {})).to be_a Reek::Source::SexpExtensions::SendNode
-  end
-end

data/spec/samples/config/allow_duplication.reek

@@ -1,3 +0,0 @@
----
-DuplicateMethodCall:
-  enabled: false

data/spec/samples/config/deeper_nested_iterators.reek

@@ -1,3 +0,0 @@
----
-NestedIterators:
-  max_allowed_nesting: 3

data/spec/samples/configuration_loading/minimal_dirty.rb

@@ -1,4 +0,0 @@
-class C
-  def m
-  end
-end

data/spec/samples/configuration_loading/reek-test-run-disable_smells.reek

@@ -1,7 +0,0 @@
----
-IrresponsibleModule:
-  enabled: false
-UncommunicativeModuleName:
-  enabled: false
-UncommunicativeMethodName:
-  enabled: false

data/spec/samples/configuration_loading/reek-test-run-enable_smells.reek

@@ -1,7 +0,0 @@
----
-IrresponsibleModule:
-  enabled: true
-UncommunicativeModuleName:
-  enabled: true
-UncommunicativeMethodName:
-  enabled: true

data/spec/samples/corrupt_config_file/corrupt.reek

@@ -1 +0,0 @@
-This is not a config file

data/spec/samples/corrupt_config_file/dirty.rb

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

data/spec/samples/demo/demo.rb

@@ -1,8 +0,0 @@
-class Dirty
-  # This method smells of :reek:NestedIterators but ignores them
-  def awful(x, y, offset = 0, log = false)
-    puts @screen.title
-    @screen = widgets.map {|w| w.each {|key| key += 3}}
-    puts @screen.contents
-  end
-end

data/spec/samples/empty_config_file/dirty.rb

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

data/spec/samples/inline_config/dirty.rb

@@ -1,16 +0,0 @@
-# :reek:DuplicateMethodCall: { allow_calls: [ puts ] }
-# smells of :reek:NestedIterators but ignores them
-class Dirty
-  def a
-    puts @s.title
-    @s = fred.map {|x| x.each {|key| key += 3}}
-    puts @s.title
-  end
-
-  # :reek:DuplicateMethodCall: { max_calls: 2 }
-  def b
-    puts @s.title
-    @s = fred.map {|x| x.each {|key| key += 3}}
-    puts @s.title
-  end
-end

data/spec/samples/inline_config/masked.reek

@@ -1,7 +0,0 @@
----
-IrresponsibleModule:
-  enabled: false
-UncommunicativeVariableName:
-  enabled: false
-UncommunicativeMethodName:
-  enabled: false

data/spec/samples/mask_some/dirty.rb

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

data/spec/samples/mask_some/some.reek

@@ -1,8 +0,0 @@
----
-DuplicateMethodCall:
-  allow_calls:
-    - puts\(@s.title\)
-UncommunicativeVariableName:
-  enabled: false
-UncommunicativeMethodName:
-  enabled: false

data/spec/samples/masked/dirty.rb

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

data/spec/samples/masked/masked.reek

@@ -1,5 +0,0 @@
----
-UncommunicativeVariableName:
-  enabled: false
-UncommunicativeMethodName:
-  enabled: false

data/spec/samples/minimal_smelly_and_masked/config.reek

@@ -1,7 +0,0 @@
----
-IrresponsibleModule:
-  enabled: false
-UncommunicativeModuleName:
-  enabled: false
-UncommunicativeMethodName:
-  enabled: false

data/spec/samples/minimal_smelly_and_masked/minimal_dirty.rb

@@ -1,4 +0,0 @@
-class C
-  def m
-  end
-end

data/spec/samples/mixed_results/clean_one.rb

@@ -1,7 +0,0 @@
-# clean class for testing purposes
-class Clean
-  def assign
-    puts @sub.title
-    @sub.map {|para| para.name }
-  end
-end

data/spec/samples/mixed_results/clean_three.rb

@@ -1,7 +0,0 @@
-# clean class for testing purposes
-class Clean
-  def assign
-    puts @sub.title
-    @sub.map {|para| para.name }
-  end
-end

data/spec/samples/mixed_results/clean_two.rb

@@ -1,7 +0,0 @@
-# clean class for testing purposes
-class Clean
-  def assign
-    puts @sub.title
-    @sub.map {|para| para.name }
-  end
-end

data/spec/samples/mixed_results/dirty_one.rb

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

data/spec/samples/mixed_results/dirty_two.rb

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

data/spec/samples/not_quite_masked/dirty.rb

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

data/spec/samples/not_quite_masked/masked.reek

@@ -1,5 +0,0 @@
----
-UncommunicativeVariableName:
-  accept:
-    - x
-

data/spec/samples/not_quite_masked/smelly.rb

@@ -1,3 +0,0 @@
-def f(x)
-  12.nil?
-end

data/spec/samples/one_smelly_file/dirty.rb

@@ -1,3 +0,0 @@
-class D
-  def a; end
-end

data/spec/samples/overrides/masked/dirty.rb

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

data/spec/samples/overrides/upper.reek

@@ -1,5 +0,0 @@
----
-DuplicateMethodCall:
-  enabled: false
-NestedIterators:
-  enabled: false

data/spec/samples/overrides_defaults/camel_case.rb

@@ -1,14 +0,0 @@
-# Class containing camelCase variable which would normally smell
-class CamelCase
-  def initialize
-    # These next two would normally smell if it weren't for overridden config values
-    camelCaseVariable = []
-    anotherOne = 1
-
-    # this next one should still smell
-    x1 = 0
-
-    # this next one should not smell
-    should_not_smell = true
-  end
-end

data/spec/samples/overrides_defaults/config.reek

@@ -1,6 +0,0 @@
----
-UncommunicativeVariableName:
-  enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/

data/spec/samples/ruby21_syntax.rb

@@ -1,5 +0,0 @@
-class SomeClass
-  def method_with_required_keyword_arguments(foo:)
-    puts foo
-  end
-end

data/spec/samples/standard_smelly/dirty.rb

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