reek 4.7.0 → 4.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ec8e3f40eb231654c58d4025080c703268e7322
-  data.tar.gz: a018b00cdba03a5da356e1c05e32bd0bc04ba569
+  metadata.gz: baf611107a9ba063fb9882a312ae27c556f4a4f6
+  data.tar.gz: f56386a2775e1a178a1df9af568055c5ac63c80f
 SHA512:
-  metadata.gz: 78c20b5e99a3c4f804c530da98b020d634b289ea575f15339e3978088f207112a022345695b7ba45fcaa5edfbac74bcba38409e99ffc6e42d0e46f2add060fdf
-  data.tar.gz: 1bd64f7d805994fb356887cb638e900669c2308d2bc86fed37ad36709df4314dbe4dcfc616240c8790bf1d61ce5e3c1b58fd7b07e5bed385d0ced79cfad19cdf
+  metadata.gz: d108db6dd4064eced4dfe277238771246120f73874f89ae3800e7bbef91b101d946861cb1793b7a138ce761bf4b26e854ee05b13ca5d39287c46b7c64027436a
+  data.tar.gz: 2005c56063bdc5a62f3ec3fe53b73d99158b8b124bdbbb45a3d8ff5ab64ab35e2863afdace05d05b5538855fdc80ed4ca138e073b415ac38f7d9dab95ccbc382

data/.rubocop.yml

@@ -113,6 +113,10 @@ Style/AccessorMethodName:
   Exclude:
     - 'lib/reek/context/visibility_tracker.rb'
 
+# Allow and/or for control flow only
+Style/AndOr:
+  EnforcedStyle: conditionals
+
 Style/Documentation:
   Exclude:
     - 'lib/reek/ast/sexp_extensions/send.rb'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.7.1 (2017-06-12)
+
+* (mvz) Improve IrresponsibleModule and fix some bugs along
+
 ## 4.7.0 (2017-05-31)
 
 * (pocke) Introduce Syntax smell detector

data/README.md

@@ -53,7 +53,7 @@ Reek is a tool that examines Ruby classes, modules and methods and reports any
 
 For an excellent introduction to
 [Code Smells](docs/Code-Smells.md) and Reek check out [this blog post](https://blog.codeship.com/how-to-find-ruby-code-smells-with-reek/)
-or [that one](https://troessner.svbtle.com/the-latest-and-greatest-additions-to-reek). There is also [this talk](https://www.youtube.com/watch?v=ZzqOuHI5MkA) from the [RubyConf Portugal](http://rubyconf.pt/).
+or [that one](https://troessner.svbtle.com/the-latest-and-greatest-additions-to-reek). There is also [this talk](https://www.youtube.com/watch?v=pazYe7WRWRU) from [RubyConfBY](http://rubyconference.by/) (there is also a [slide deck](http://talks.chastell.net/rubyconf-by-lt-2016/) if you prefer that).
 
 Install it via rubygems:
 

data/features/reports/codeclimate.feature

@@ -0,0 +1,59 @@
+Feature: Report smells using Code Climate format
+  In order to run as an Engine on Code Climate, output format following their
+  spec.
+
+  Scenario: output is empty when there are no smells
+    Given a directory called 'clean' containing two clean files
+    When I run reek --format code_climate clean
+    Then it succeeds
+    And it reports this Code Climate output:
+    """
+    """
+
+  Scenario: Indicate smells and print them as JSON when using files
+    Given the smelly file 'smelly.rb'
+    When I run reek --format code_climate smelly.rb
+    Then it reports this Code Climate output:
+      """
+      {
+        "type": "issue",
+        "check_name": "UncommunicativeMethodName",
+        "description": "Smelly#x has the name 'x'",
+        "categories": [
+          "Complexity"
+        ],
+        "location": {
+          "path": "smelly.rb",
+          "lines": {
+            "begin": 4,
+            "end": 4
+          }
+        },
+        "remediation_points": 150000,
+        "content": {
+          "body": "An `Uncommunicative Method Name` is a method name that doesn't communicate its intent well enough.\n\nPoor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.\n"
+        },
+        "fingerprint": "2b41a3a4bb7de31ac4f5944bf68b7f5f"
+      }
+      NULL_BYTE_CHARACTER
+      {
+        "type": "issue",
+        "check_name": "UncommunicativeVariableName",
+        "description": "Smelly#x has the variable name 'y'",
+        "categories": [
+          "Complexity"
+        ],
+        "location": {
+          "path": "smelly.rb",
+          "lines": {
+            "begin": 5,
+            "end": 5
+          }
+        },
+        "remediation_points": 150000,
+        "content": {
+          "body": "An `Uncommunicative Variable Name` is a variable name that doesn't communicate its intent well enough.\n\nPoor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.\n"
+        },
+        "fingerprint": "72f0dc8f8da5f9d7b8b29318636e5609"
+      }
+      """

data/features/step_definitions/reek_steps.rb

@@ -84,3 +84,15 @@ end
 Then /^it reports the current version$/ do
   expect(last_command_started).to have_output("reek #{Reek::Version::STRING}")
 end
+
+Then /^it reports this Code Climate output:$/ do |expected_output|
+  expected_issues = expected_output.split('NULL_BYTE_CHARACTER').map do |issue|
+    JSON.parse(issue)
+  end
+
+  actual_issues = last_command_started.stdout.split("\0").map do |issue|
+    JSON.parse(issue)
+  end
+
+  expect(actual_issues).to eq(expected_issues)
+end

data/lib/reek/ast/node.rb

@@ -107,6 +107,15 @@ module Reek
         1
       end
 
+      # Most nodes represent only one statement (although they can have nested
+      # statements). The special type :begin exists primarily to contain more
+      # statements.
+      #
+      # @return Array of unique outer-level statements contained in this node
+      def statements
+        [self]
+      end
+
       def source
         loc.expression.source_buffer.name
       end

data/lib/reek/ast/sexp_extensions.rb

@@ -4,6 +4,7 @@ require_relative 'reference_collector'
 
 require_relative 'sexp_extensions/arguments'
 require_relative 'sexp_extensions/attribute_assignments'
+require_relative 'sexp_extensions/begin'
 require_relative 'sexp_extensions/block'
 require_relative 'sexp_extensions/case'
 require_relative 'sexp_extensions/constant'

data/lib/reek/ast/sexp_extensions/begin.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Reek
+  module AST
+    module SexpExtensions
+      # Utility methods for :begin nodes.
+      module BeginNode
+        # The special type :begin exists primarily to contain more statements.
+        # Therefore, this method overrides the default implementation to return
+        # this node's children.
+        def statements
+          children
+        end
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/module.rb

@@ -3,9 +3,10 @@
 module Reek
   module AST
     module SexpExtensions
-      # Base module for utility methods for module nodes.
-      module ModuleNodeBase
-        # The full name of the module or class, including the name of any
+      # Base module for utility methods for nodes that define constants: module
+      # definition, class definition and constant assignment.
+      module ConstantDefiningNodeBase
+        # The full name of the constant, including the name of any
         # module or class it is nested inside of.
         #
         # For example, given code like this:
@@ -16,7 +17,8 @@ module Reek
         #   end
         #
         # The full name for the inner class will be 'Foo::Bar::Baz'. To return
-        # the correct name, the name of the outer context has to be passed into this method.
+        # the correct name, the name of the outer context has to be passed into
+        # this method.
         #
         # @param outer [String] full name of the wrapping module or class
         # @return the module's full name
@@ -32,27 +34,71 @@ module Reek
         def simple_name
           name.split('::').last
         end
+      end
+
+      # Base module for utility methods for module nodes.
+      module ModuleNodeBase
+        include ConstantDefiningNodeBase
 
         def name
           children.first.format_to_ruby
         end
+
+        # In the AST, the set of children of a module that a human might identify
+        # is coded in three different ways.
+        #
+        # If there are no children, the last element of the module node is nil,
+        # like so:
+        #
+        #   s(:class,
+        #     s(:const, nil, :C),
+        #     nil,
+        #     nil)
+        #
+        # If there is one child, the last element of the module node is that
+        # child, like so:
+        #
+        #   s(:class,
+        #     s(:const, nil, :C),
+        #     nil,
+        #     s(:def, :f, s(:args), nil))
+        #
+        # If there is more than one child, those are wrapped as children in a
+        # node of type :begin, like so:
+        #
+        #   s(:class,
+        #     s(:const, nil, :Alfa),
+        #     nil,
+        #     s(:begin,
+        #       s(:def, :bravo, s(:args), nil),
+        #       s(:class, s(:const, nil, :Charlie), nil, nil)))
+        #
+        # This method unifies those three ways to avoid having to handle them
+        # differently.
+        #
+        # @return an array of directly visible children of the module
+        #
+        def direct_children
+          contents = children.last or return []
+          contents.statements
+        end
       end
 
-      # Utility methods for :module nodes.
+      # Utility methods for module definition (:module) nodes.
       module ModuleNode
         include ModuleNodeBase
       end
 
-      # Utility methods for :class nodes.
+      # Utility methods for class definition (:class) nodes.
       module ClassNode
         include ModuleNodeBase
 
         def superclass() children[1] end
       end
 
-      # Utility methods for :casgn nodes.
+      # Utility methods for constant assignment (:casgn) nodes.
       module CasgnNode
-        include ModuleNodeBase
+        include ConstantDefiningNodeBase
 
         def defines_module?
           call = constant_definition

data/lib/reek/context/module_context.rb

@@ -10,7 +10,6 @@ module Reek
     #
     # A context wrapper for any module found in a syntax tree.
     #
-    # :reek:FeatureEnvy
     class ModuleContext < CodeContext
       attr_reader :visibility_tracker
 
@@ -74,10 +73,12 @@ module Reek
       # However, if the module is empty, it is not considered a namespace module.
       #
       # @return true if the module is a namespace module
+      #
+      # :reek:FeatureEnvy
       def namespace_module?
         return false if exp.type == :casgn
-        contents = exp.children.last
-        contents && contents.find_nodes([:def, :defs], [:casgn, :class, :module]).empty?
+        children = exp.direct_children
+        children.any? && children.all? { |child| [:casgn, :class, :module].include? child.type }
       end
 
       def track_visibility(visibility, names)
@@ -92,6 +93,8 @@ module Reek
                                                       names: names
       end
 
+      private
+
       def instance_method_children
         children.select(&:instance_method?)
       end

data/lib/reek/smell_detectors/syntax.rb

@@ -7,9 +7,10 @@ module Reek
     # Check syntax errors.
     # Note: this detector is called by examiner directly unlike other detectors.
     class Syntax < BaseDetector
-      DummyContext = Struct.new(:exp, :full_name).new(
-        Struct.new('Exp', :source).new(nil),
-        'This file')
+      # Context duck type for this atypical smell detector
+      DummyContext = Struct.new(:exp, :full_name)
+      # Exp duck type for this atypical smell detector
+      DummyExp = Struct.new(:source)
 
       def self.contexts
         []
@@ -21,9 +22,12 @@ module Reek
 
       # :reek:FeatureEnvy
       def smells_from_source(source)
+        context = DummyContext.new(
+          DummyExp.new(source.origin),
+          'This file')
         source.diagnostics.map do |diagnostic|
           smell_warning(
-            context: DummyContext,
+            context: context,
             lines: [diagnostic.location.line],
             message: "has #{diagnostic.message}")
         end

data/lib/reek/spec/should_reek_of.rb

@@ -12,13 +12,6 @@ module Reek
     class ShouldReekOf
       include RSpec::Matchers::Composable
 
-      # Variant of Examiner that doesn't swallow exceptions
-      class UnsafeExaminer < Examiner
-        def run
-          examine_tree
-        end
-      end
-
       attr_reader :failure_message, :failure_message_when_negated
 
       def initialize(smell_type_or_class,
@@ -32,9 +25,9 @@ module Reek
 
       def matches?(source)
         @matching_smell_types = nil
-        self.examiner = UnsafeExaminer.new(source,
-                                           filter_by_smells: [smell_type],
-                                           configuration: configuration)
+        self.examiner = Examiner.new(source,
+                                     filter_by_smells: [smell_type],
+                                     configuration: configuration)
         set_failure_messages
         matching_smell_details?
       end

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.7.0'.freeze
+    STRING = '4.7.1'.freeze
   end
 end

data/spec/reek/smell_detectors/irresponsible_module_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe Reek::SmellDetectors::IrresponsibleModule do
   it 'does count all occurences' do
     src = <<-EOS
       class Alfa
-        # Method is necessary because we don't count empty classes.
+        # Method is necessary because we don't count namespace classes.
         def bravo; end
         class Charlie
         end
@@ -40,21 +40,21 @@ RSpec.describe Reek::SmellDetectors::IrresponsibleModule do
       expect(src).to reek_of(:IrresponsibleModule)
     end
 
-    it "does not report re-opened #{scope}" do
+    it "does not report a #{scope} having a comment" do
       src = <<-EOS
-        # Abstract base
+        # Do not report me, I'm responsible!
         #{scope} Alfa; end
-
-        #{scope} Alfa; def bravo; end; end
       EOS
 
       expect(src).not_to reek_of(:IrresponsibleModule)
     end
 
-    it "does not report a #{scope} having a comment" do
+    it "does not report re-opened #{scope} in the same file" do
       src = <<-EOS
-        # Do not report me
+        # This comment describes Alfa
         #{scope} Alfa; end
+
+        #{scope} Alfa; def bravo; end; end
       EOS
 
       expect(src).not_to reek_of(:IrresponsibleModule)
@@ -73,7 +73,7 @@ RSpec.describe Reek::SmellDetectors::IrresponsibleModule do
 
     it "reports a #{scope} with a preceding comment with intermittent material" do
       src = <<-EOS
-        # This is a valid comment
+        # This is a comment that should not be related to Bravo
 
         require 'alfa'
 
@@ -87,13 +87,13 @@ RSpec.describe Reek::SmellDetectors::IrresponsibleModule do
     it "reports a #{scope} with only a trailing comment" do
       src = <<-EOS
         #{scope} Alfa
-        end # end scope
+        end # This belongs to Alfa but doesn't count
       EOS
 
       expect(src).to reek_of(:IrresponsibleModule)
     end
 
-    it "does not report #{scope} used only as namespaces" do
+    it "does not report #{scope} used only as a namespace" do
       src = <<-EOS
         #{scope} Alfa
           # Describes Bravo
@@ -104,10 +104,28 @@ RSpec.describe Reek::SmellDetectors::IrresponsibleModule do
         end
       EOS
 
-      expect(src).not_to reek_of(:IrresponsibleModule)
+      expect(src).not_to reek_of(:IrresponsibleModule, context: 'Alfa')
     end
 
-    it "reports #{scope} that have both a nested #{scope} and methods" do
+    it "does not report #{scope} used only as a namespace for several nested moduless" do
+      src = <<-EOS
+        #{scope} Alfa
+          # Describes Bravo
+          class Bravo
+            def charlie
+            end
+          end
+
+          # Describes Delta
+          module Delta
+          end
+        end
+      EOS
+
+      expect(src).not_to reek_of(:IrresponsibleModule, context: 'Alfa')
+    end
+
+    it "reports #{scope} that is used as a namespace but also has methods" do
       src = <<-EOS
         #{scope} Alfa
           def bravo
@@ -122,7 +140,7 @@ RSpec.describe Reek::SmellDetectors::IrresponsibleModule do
       expect(src).to reek_of(:IrresponsibleModule, context: 'Alfa')
     end
 
-    it "reports #{scope} that has both a nested #{scope} and singleton methods" do
+    it "reports #{scope} that is used as a namespace but also has singleton methods" do
       src = <<-EOS
         #{scope} Alfa
           def self.bravo
@@ -147,10 +165,40 @@ RSpec.describe Reek::SmellDetectors::IrresponsibleModule do
         end
       EOS
 
-      expect(src).not_to reek_of(:IrresponsibleModule)
+      expect(src).not_to reek_of(:IrresponsibleModule, context: 'Alfa')
+    end
+
+    it "does not report #{scope} only containing constants" do
+      src = <<-EOS
+        #{scope} Alfa
+          Bravo = 23
+        end
+      EOS
+
+      expect(src).not_to reek_of(:IrresponsibleModule, context: 'Alfa')
+    end
+
+    it "reports #{scope} that contains method calls" do
+      src = <<-EOS
+        #{scope} Alfa
+          bravo :charlie
+        end
+      EOS
+
+      expect(src).to reek_of(:IrresponsibleModule, context: 'Alfa')
+    end
+
+    it "reports #{scope} that contains non-constant assignments" do
+      src = <<-EOS
+        #{scope} Alfa
+          bravo = charlie
+        end
+      EOS
+
+      expect(src).to reek_of(:IrresponsibleModule, context: 'Alfa')
     end
 
-    it "reports a #{scope} defined through assignment" do
+    it "reports an irresponsible #{scope} defined through assignment" do
       src = <<-EOS
         # Alfa is responsible, but Bravo is not
         #{scope} Alfa
@@ -174,6 +222,7 @@ RSpec.describe Reek::SmellDetectors::IrresponsibleModule do
 
     it 'does not report constants that are not classes' do
       src = <<-EOS
+        # Alfa is responsible
         #{scope} Alfa
           Bravo = 23
           Charlie = Hash.new

data/spec/reek/smell_detectors/syntax_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../../spec_helper'
+require_lib 'reek/smell_detectors/syntax'
+
+RSpec.describe Reek::SmellDetectors::Syntax do
+  it 'reports the right values' do
+    src = <<-EOS
+      class Alfa
+      edn
+    EOS
+
+    expect(src).to reek_of(:Syntax,
+                           lines: [3],
+                           context: 'This file',
+                           message: 'has unexpected token $end',
+                           source: 'string')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.7.1
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -162,6 +162,7 @@ files:
 - features/configuration_via_source_comments/well_formed_source_comments.feature
 - features/programmatic_access.feature
 - features/rake_task/rake_task.feature
+- features/reports/codeclimate.feature
 - features/reports/json.feature
 - features/reports/reports.feature
 - features/reports/yaml.feature
@@ -180,6 +181,7 @@ files:
 - lib/reek/ast/sexp_extensions.rb
 - lib/reek/ast/sexp_extensions/arguments.rb
 - lib/reek/ast/sexp_extensions/attribute_assignments.rb
+- lib/reek/ast/sexp_extensions/begin.rb
 - lib/reek/ast/sexp_extensions/block.rb
 - lib/reek/ast/sexp_extensions/case.rb
 - lib/reek/ast/sexp_extensions/constant.rb
@@ -390,6 +392,7 @@ files:
 - spec/reek/smell_detectors/prima_donna_method_spec.rb
 - spec/reek/smell_detectors/repeated_conditional_spec.rb
 - spec/reek/smell_detectors/subclassed_from_core_class_spec.rb
+- spec/reek/smell_detectors/syntax_spec.rb
 - spec/reek/smell_detectors/too_many_constants_spec.rb
 - spec/reek/smell_detectors/too_many_instance_variables_spec.rb
 - spec/reek/smell_detectors/too_many_methods_spec.rb