reek 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1877ecb6f7f04aa89c30beda81afb570a22b0edf
-  data.tar.gz: 9bb692ec4755c9402ce8bfa596e7333be0755573
+  metadata.gz: a6f9a08539415ceecd74495e36b1a11235bfccf2
+  data.tar.gz: aa9edb39c1cae7f4c66e2ac41e7173b39f337b4f
 SHA512:
-  metadata.gz: 16cd877bea8569bb5e55e30f825d076d62fa7a0a5f026fbf50f86150672f93517a881d71cd048670a3d2f029cacd88c27ceab2f21fe6aa65de2a0ce7995cb27f
-  data.tar.gz: cfd0ba532e2870abc0794fa173274b811a6a19de8ecf5adfd3f741c55cfec7aa70dc1263f4d183f584fc4c4f682ec9eed5b4d323bc996f5c1e2c5e654e7a5e14
+  metadata.gz: 5b7743dfb2ca76846caae26697fe43ad25d0721e8a135286abd4918e2a541cfed814f81a4ef128e4c9547023091332d8b8c406a3ce247e1a58b0fe181cbf09d3
+  data.tar.gz: 41f70992cd0209073947a48151b2a2da3bc83017576bf1b25f53b849100f6b1e2d2458fa18ed6b65929c8e0b3d69ab5a37d48d1ed9a51259d9f458d53e88df4c

data/CHANGELOG

@@ -1,3 +1,10 @@
+== 2.0.3
+
+* (mvz) Make NestedIterators handle super with arguments
+* (mvz) Handle shadow block arguments
+* (CoralineAda) Allow all formatters to support -U (wiki links)
+* (tuexss) Make defaults transparent in help message
+
 == 2.0.2
 
 * (troessner) Fix version command

data/README.md

@@ -3,10 +3,10 @@
 ## Overview
 
 
-[![Build Status](https://secure.travis-ci.org/troessner/reek.png?branch=master)](http://travis-ci.org/troessner/reek?branch=master)
-[![Gem Version](https://badge.fury.io/rb/reek.png)](http://badge.fury.io/rb/reek)
+[![Build Status](https://secure.travis-ci.org/troessner/reek.png?branch=master)](https://travis-ci.org/troessner/reek?branch=master)
+[![Gem Version](https://badge.fury.io/rb/reek.png)](https://badge.fury.io/rb/reek)
 [![Dependency Status](https://gemnasium.com/troessner/reek.png)](https://gemnasium.com/troessner/reek)
-[![Inline docs](http://inch-ci.org/github/troessner/reek.png)](http://inch-ci.org/github/troessner/reek)
+[![Inline docs](https://inch-ci.org/github/troessner/reek.png)](https://inch-ci.org/github/troessner/reek)
 
 ## Quickstart
 
@@ -228,7 +228,7 @@ Colorful output for `reek`: [Preek](https://github.com/joenas/preek) (also with
 
 ### Find out more:
 
-* [Stack Overflow](http://stackoverflow.com/questions/tagged/reek)
+* [Stack Overflow](https://stackoverflow.com/questions/tagged/reek)
 * [RDoc](http://rdoc.info/projects/troessner/reek)
 
 ## Contributors

data/bin/reek

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #
 # Reek examines Ruby source code for smells.
-# Visit http://wiki.github.com/troessner/reek for docs etc.
+# Visit https://wiki.github.com/troessner/reek for docs etc.
 #
 # Author: Kevin Rutherford
 #

data/features/command_line_interface/options.feature

@@ -27,11 +27,11 @@ Feature: Reek can be controlled using command-line options
       reek -s lib
       cat my_class.rb | reek
 
-      See http://wiki.github.com/troessner/reek for detailed help.
+      See https://wiki.github.com/troessner/reek for detailed help.
 
       Configuration:
           -c, --config FILE                Read configuration options from FILE
-              --smell SMELL                Detect smell SMELL (default is all enabled smells)
+              --smell SMELL                Detect smell SMELL (default: all enabled smells)
 
       Report format:
           -f, --format FORMAT              Report smells in the given format:
@@ -41,10 +41,10 @@ Feature: Reek can be controlled using command-line options
                                              json
 
       Text format options:
-              --[no-]color                 Use colors for the output (this is the default)
-          -V, --[no-]empty-headings        Show headings for smell-free source files
-          -U, --[no-]wiki-links            Show link to related Reek wiki page for each smell
-          -n, --[no-]line-numbers          Show line numbers in the output (this is the default)
+              --[no-]color                 Use colors for the output (default: true)
+          -V, --[no-]empty-headings        Show headings for smell-free source files (default: false)
+          -U, --[no-]wiki-links            Show link to related wiki page for each smell (default: false)
+          -n, --[no-]line-numbers          Show line numbers in the output (default: true)
           -s, --single-line                Show location in editor-compatible single-line-per-smell format
               --sort-by SORTING            Sort reported files by the given criterium:
                                              smelliness ("smelliest" files first)

data/lib/reek/cli/application.rb

@@ -15,7 +15,7 @@ module Reek
       STATUS_SMELLS  = 2
 
       def initialize(argv)
-        @status  = STATUS_SUCCESS
+        @status = STATUS_SUCCESS
         options_parser = Options.new(argv)
         begin
           @options = options_parser.parse

data/lib/reek/cli/options.rb

@@ -45,7 +45,7 @@ module Reek
           #{program_name} -s lib
           cat my_class.rb | #{program_name}
 
-          See http://wiki.github.com/troessner/reek for detailed help.
+          See https://wiki.github.com/troessner/reek for detailed help.
 
         EOB
       end
@@ -66,7 +66,7 @@ module Reek
         @parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
           @options.config_file = file
         end
-        @parser.on('--smell SMELL', 'Detect smell SMELL (default is all enabled smells)') do |smell|
+        @parser.on('--smell SMELL', 'Detect smell SMELL (default: all enabled smells)') do |smell|
           @options.smells_to_detect << smell
         end
       end
@@ -80,25 +80,25 @@ module Reek
       end
 
       def set_up_color_option
-        @parser.on('--[no-]color', 'Use colors for the output (this is the default)') do |opt|
+        @parser.on('--[no-]color', 'Use colors for the output (default: true)') do |opt|
           @options.colored = opt
         end
       end
 
       def set_up_verbosity_options
         @parser.on('-V', '--[no-]empty-headings',
-                   'Show headings for smell-free source files') do |show_empty|
+                   'Show headings for smell-free source files (default: false)') do |show_empty|
           @options.show_empty = show_empty
         end
         @parser.on('-U', '--[no-]wiki-links',
-                   'Show link to related Reek wiki page for each smell') do |show_links|
+                   'Show link to related wiki page for each smell (default: false)') do |show_links|
           @options.show_links = show_links
         end
       end
 
       def set_up_location_formatting_options
         @parser.on('-n', '--[no-]line-numbers',
-                   'Show line numbers in the output (this is the default)') do |show_numbers|
+                   'Show line numbers in the output (default: true)') do |show_numbers|
           @options.location_format = show_numbers ? :numbers : :plain
         end
         @parser.on('-s', '--single-line',

data/lib/reek/cli/report/formatter.rb

@@ -4,8 +4,9 @@ module Reek
   module Cli
     module Report
       #
-      # Formatter handling the formatting of the report at large. Formatting
-      # the individual warnings is handled by the warning formatter passed in.
+      # Formatter handling the formatting of the report at large.
+      # Formatting of the individual warnings is handled by the
+      # passed-in warning formatter.
       #
       module Formatter
         def self.format_list(warnings, formatter = SimpleWarningFormatter.new)
@@ -25,7 +26,7 @@ module Reek
 
       #
       # Basic formatter that just shows a simple message for each warning,
-      # pre-pended with the result of the passed-in location formatter.
+      # prepended with the result of the passed-in location formatter.
       #
       class SimpleWarningFormatter
         def initialize(location_formatter = BlankLocationFormatter)
@@ -44,7 +45,7 @@ module Reek
       end
 
       #
-      # Formatter that adds a link to the Wiki to the basic message from
+      # Formatter that adds a link to the wiki to the basic message from
       # SimpleWarningFormatter.
       #
       class WikiLinkWarningFormatter < SimpleWarningFormatter

data/lib/reek/cli/report/report.rb

@@ -12,9 +12,13 @@ module Reek
         NO_WARNINGS_COLOR = :green
         WARNINGS_COLOR = :red
 
-        def initialize(_options = {})
+        def initialize(options = {})
           @examiners           = []
           @total_smell_count   = 0
+          @options             = options
+          @warning_formatter   = options.fetch :warning_formatter, SimpleWarningFormatter.new
+          @report_formatter    = options.fetch :report_formatter, Formatter
+          @sort_by_issue_count = options.fetch :sort_by_issue_count, false
         end
 
         def add_examiner(examiner)
@@ -36,14 +40,6 @@ module Reek
       # Generates a sorted, text summary of smells in examiners
       #
       class TextReport < Base
-        def initialize(options = {})
-          super options
-          @options = options
-          @warning_formatter   = options.fetch :warning_formatter, SimpleWarningFormatter.new
-          @report_formatter    = options.fetch :report_formatter, Formatter
-          @sort_by_issue_count = options.fetch :sort_by_issue_count, false
-        end
-
         def show
           sort_examiners if smells?
           display_summary
@@ -107,7 +103,11 @@ module Reek
       # JSON with empty array for 0 smells
       class JsonReport < Base
         def show
-          print ::JSON.generate(smells.map(&:yaml_hash))
+          print ::JSON.generate(
+            smells.map do |smell|
+              smell.yaml_hash(@warning_formatter)
+            end
+          )
         end
       end
 

data/lib/reek/configuration/app_configuration.rb

@@ -4,7 +4,7 @@ module Reek
   module Configuration
     class ConfigFileException < StandardError; end
     #
-    # Reeks singleton configuration instance.
+    # Reek's singleton configuration instance.
     #
     module AppConfiguration
       @configuration = {}

data/lib/reek/configuration/configuration_file_finder.rb

@@ -3,7 +3,7 @@ require 'pathname'
 module Reek
   module Configuration
     #
-    # ConfigurationFileFinder is responsible for finding reeks configuration.
+    # ConfigurationFileFinder is responsible for finding reek's configuration.
     #
     # There are 3 ways of passing `reek` a configuration file:
     # 1. Using the cli "-c" switch

data/lib/reek/core/method_context.rb

@@ -41,9 +41,9 @@ module Reek
         receiver ||= [:self]
         case receiver[0]
         when :lvasgn
-          @refs.record_reference_to(receiver.updated(:lvar))
+          @refs.record_reference_to(receiver.name)
         when :lvar
-          @refs.record_reference_to(receiver) unless meth == :new
+          @refs.record_reference_to(receiver.name) unless meth == :new
         when :self
           @refs.record_reference_to(:self)
         end

data/lib/reek/rake/task.rb

@@ -36,7 +36,7 @@ module Reek
       # Name of reek task. Defaults to :reek.
       attr_writer :name
 
-      # Path to reeks config file.
+      # Path to reek's config file.
       # Setting the REEK_CFG environment variable overrides this.
       attr_writer :config_file
 

data/lib/reek/smell_warning.rb

@@ -42,7 +42,7 @@ module Reek
       listener.found_smell(self)
     end
 
-    def yaml_hash
+    def yaml_hash(warning_formatter = nil)
       result = {
         'smell_category' => smell_detector.smell_category,
         'smell_type'     => smell_detector.smell_type,
@@ -51,6 +51,9 @@ module Reek
         'lines'          => lines,
         'message'        => message
       }
+      if warning_formatter.respond_to?(:explanatory_link)
+        result.merge!('wiki_link' => warning_formatter.explanatory_link(smell_detector))
+      end
       parameters.each do |key, value|
         result[key.to_s] = value
       end

data/lib/reek/smells/feature_envy.rb

@@ -43,7 +43,7 @@ module Reek
       #
       def examine_context(method_ctx)
         method_ctx.envious_receivers.map do |ref, occurs|
-          target = ref.format_ruby
+          target = ref.to_s
           SmellWarning.new self,
                            context: method_ctx.full_name,
                            lines: [method_ctx.exp.line],

data/lib/reek/source/sexp_extensions.rb

@@ -91,6 +91,11 @@ module Reek
         end
       end
 
+      # Utility methods for :shadowarg nodes.
+      module ShadowargNode
+        include ArgNodeBase
+      end
+
       # Base module for utility methods for :and and :or nodes.
       module LogicOperatorBase
         def condition() self[1] end
@@ -179,9 +184,13 @@ module Reek
 
       # Utility methods for :lvar nodes.
       module LvarNode
+        include VariableBase
+        # TODO: Replace with name().
         def var_name() self[1] end
       end
 
+      LvasgnNode = LvarNode
+
       # Base module for utility methods for :def and :defs nodes.
       module MethodNodeBase
         def arguments
@@ -315,12 +324,14 @@ module Reek
         end
       end
 
-      # Utility methods for :zsuper nodes.
-      module ZsuperNode
+      # Utility methods for :super nodes.
+      module SuperNode
         def method_name
           :super
         end
       end
+
+      ZsuperNode = SuperNode
     end
   end
 end

data/lib/reek/version.rb

@@ -3,6 +3,6 @@ module Reek
   # This module holds the Reek version informations
   #
   module Version
-    STRING = '2.0.2'
+    STRING = '2.0.3'
   end
 end

data/reek.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
                 'Rakefile', 'assets/html_output.html.erb', 'bin/reek',
                 'config/defaults.reek', '{features,lib,spec,tasks}/**/*',
                 'reek.gemspec'] & `git ls-files -z`.split("\0")
-  s.homepage = 'http://wiki.github.com/troessner/reek'
+  s.homepage = 'https://wiki.github.com/troessner/reek'
   s.rdoc_options = ['--main', 'README.md',
                     '-x', 'assets/|bin/|config/|features/|spec/|tasks/']
   s.require_paths = ['lib']

data/spec/reek/smells/feature_envy_spec.rb

@@ -138,6 +138,7 @@ describe Reek::Smells::FeatureEnvy do
   it 'counts =~ as a call' do
     src = <<-EOS
     def foo arg
+      bar(arg.baz)
       arg =~ /bar/
     end
     EOS
@@ -147,6 +148,7 @@ describe Reek::Smells::FeatureEnvy do
   it 'counts += as a call' do
     src = <<-EOS
     def foo arg
+      bar(arg.baz)
       arg += 1
     end
     EOS

data/spec/reek/smells/nested_iterators_spec.rb

@@ -98,6 +98,30 @@ describe Reek::Smells::NestedIterators do
     expect(src).to reek_of(:NestedIterators, count: 3)
   end
 
+  it 'handles the case where super recieves a block' do
+    src = <<-EOS
+      def super_call_with_block
+        super do |k|
+          nothing.each { |thing| item }
+        end
+      end
+    EOS
+
+    expect(src).to reek_of(:NestedIterators)
+  end
+
+  it 'handles the case where super recieves a block and arguments' do
+    src = <<-EOS
+      def super_call_with_block
+        super(foo) do |k|
+          nothing.each { |thing| item }
+        end
+      end
+    EOS
+
+    expect(src).to reek_of(:NestedIterators)
+  end
+
   context 'when the allowed nesting depth is 3' do
     before :each do
       @config = { NestedIterators:
@@ -224,21 +248,4 @@ describe Reek::Smells::NestedIterators do
       expect(@warning.lines).to eq([3])
     end
   end
-
-  context 'super recieves a block' do
-    before :each do
-      src = <<-EOS
-        def super_call_with_block
-          super do |k|
-            nothing.each { |thing| item }
-          end
-        end
-      EOS
-
-      ctx = Reek::Core::CodeContext.new(nil, src.to_reek_source.syntax_tree)
-      @warning = @detector.examine_context(ctx)[0]
-    end
-
-    it_should_behave_like 'common fields set correctly'
-  end
 end

data/spec/reek/smells/uncommunicative_variable_name_spec.rb

@@ -140,6 +140,16 @@ describe Reek::Smells::UncommunicativeVariableName do
       expect(src).to reek_of(:UncommunicativeVariableName, name: 'y')
       expect(src).to reek_of(:UncommunicativeVariableName, name: 'z')
     end
+
+    it 'reports shadowed block parameters' do
+      src = <<-EOS
+        def bad
+          @foo.map { |x; y| y = x * 2 }
+        end
+      EOS
+      expect(src).to reek_of(:UncommunicativeVariableName, name: 'x')
+      expect(src).to reek_of(:UncommunicativeVariableName, name: 'y')
+    end
   end
 
   context 'when a smell is reported' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -411,7 +411,7 @@ files:
 - tasks/reek.rake
 - tasks/rubocop.rake
 - tasks/test.rake
-homepage: http://wiki.github.com/troessner/reek
+homepage: https://wiki.github.com/troessner/reek
 licenses:
 - MIT
 metadata: {}