reek 3.11 → 4.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67870a4dc44b9996f80e3daddb3614cbc9a1ee6d
-  data.tar.gz: 8eedb66acfa7d1b874a2806ffd7b6aab69769794
+  metadata.gz: 8309582de93065645810663cbed12c501ffe0b68
+  data.tar.gz: 73712e80702d432edc320bb5531846d3eefcf266
 SHA512:
-  metadata.gz: ad6862ed6352640db4ff88fbe718c6116579d257a6c83337dd1603e1a8580686da6895be5b478db0d5ebd4fd3e288c3e29a9e56ae25cc5115053eef8a18540f9
-  data.tar.gz: 8e1cc3bd8e0d9f6c00dfa21e2cd2ba6c9706b817c0a6c895d75be07f58f28f2ce9159f20edbceb1d1e9d676869f65b7771119ac339af04cc2ade6c01854ae8b9
+  metadata.gz: bce9a189c55a37b998dbe35a353fd3ab0ec8379a7c8e058712be3d8d3d5a2c0e111375ccb1b12f2146deea7225272a4cfcfe06c2e199d3d0aa75d8450a179cc7
+  data.tar.gz: dc7cca14a3c083bd41ce51f6cfbbd1da3339bd70c53282fa1f1d3d73102a3f06fa5718af8c61a339bab10210e558bf626d50e315a822ae3f3168dfefb4b2ddd5

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
     - 'spec/samples/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
+  TargetRubyVersion: 2.1
 
 # FIXME: Make the class shorter
 Metrics/ClassLength:
@@ -40,6 +41,13 @@ Style/DotPosition:
 Style/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 
+# Require comment for files in lib and bin
+Style/FrozenStringLiteralComment:
+  Include:
+    - 'bin/*'
+    - 'lib/**/*'
+  EnforcedStyle: always
+
 # Allow multiline block chains
 Style/MultilineBlockChain:
   Enabled: false

data/.travis.yml

@@ -6,7 +6,6 @@ script:
 - bundle exec rake
 - bundle exec ataru check
 rvm:
-  - 2.0.0
   - 2.1
   - 2.2
   - 2.3.0

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Change log
 
-## Unreleased
+## 4.0.0.pre1 (2016-03-01)
+
+* First pre-release for Reek 4.
+* (troessner) Make all optional arguments to Examiner's constructor keyword
+  arguments.
+* (troessner) Use keyword arguments without defaults as allowed by Ruby 2.1.
+* (mvz) Remove smell category concept:
+  - The smell category is removed from the YAML and JSON outputs.
+  - The smell category can no longer be used to select smells in the reek_of
+    matcher.
+* (chastell) Make HTML report print to stdout like the other reports
+* (troessner) Drop support for CRuby 2.0
+* (mvz) Speed up reek_of matcher by only running the given smell
 
 ## 3.11 (2016-02-18)
 

data/README.md

@@ -65,7 +65,6 @@ demo.rb -- 8 warnings:
 
 Reek is officially running on the following MRI rubies:
 
-  - 2.0
   - 2.1
   - 2.2
   - 2.3

data/bin/code_climate_reek

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # Wrapper for the CodeClimate integration.
 

data/bin/reek

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # Reek examines Ruby source code for smells.
 # Visit https://wiki.github.com/troessner/reek for docs etc.

data/docs/API.md

@@ -32,7 +32,7 @@ source = <<-EOS
 EOS
 
 reporter = Reek::Report::TextReport.new
-examiner = Reek::Examiner.new(source)
+examiner = Reek::Examiner.new source
 reporter.add_examiner examiner
 reporter.show
 ```
@@ -175,7 +175,7 @@ source = <<-END
   end
 END
 
-examiner = Reek::Examiner.new(source)
+examiner = Reek::Examiner.new source
 examiner.smells.each do |smell|
   puts smell.message
 end

data/docs/RSpec-matchers.md

@@ -71,21 +71,18 @@ See the "Quickstart" example from above.
 
 ### `reek_of`
 
-Checks the target source code for instances of "smell category"
+Checks the target source code for instances of "smell type"
 and returns true only if it can find one of them that matches.
 
 Remember that this includes our "smell types" as well. So it could be the
 "smell type" UtilityFunction, which is represented as a concrete class
 in Reek but it could also be "Duplication" which is a "smell categgory".
 
-In theory you could pass many different types of input here:
+You could pass many different types of input here:
 - `:UtilityFunction`
 - `"UtilityFunction"`
-- `UtilityFunction` (this works in our specs because we tend to do "include
-  Reek:Smells")
 - `Reek::Smells::UtilityFunction` (the right way if you really want to pass a
   class)
-- `"Duplication"` or `:Duplication` which is an abstract "smell category"
 
 It is recommended to pass this as a symbol like `:UtilityFunction`. However we
 don't enforce this.
@@ -100,7 +97,7 @@ something that doesn't make much sense.
 
 So in a nutshell `reek_of` takes the following two arguments:
 
-- `smell_category` - The "smell category" or "smell_type" we check for.
+- `smell_type` - The "smell type" we check for.
 - `smells_details` - A hash containing "smell warning" parameters
 
 **Examples**
@@ -131,7 +128,7 @@ See the documentaton for `reek_of`.
 
 **Notable differences to `reek_of`:**
 
-1. `reek_of` doesn't mind if there are other smells of a different category.
+1. `reek_of` doesn't mind if there are other smells of a different type.
    "reek_only_of" will fail in that case.
 
 2. `reek_only_of` doesn't support the additional smell_details hash.

data/features/reports/json.feature

@@ -19,7 +19,6 @@ Feature: Report smells using simple JSON layout
       """
       [
           {
-              "smell_category": "Duplication",
               "smell_type": "DuplicateMethodCall",
               "source": "smelly.rb",
               "context": "Smelly#m",
@@ -30,7 +29,6 @@ Feature: Report smells using simple JSON layout
               "count": 2
           },
           {
-              "smell_category": "Duplication",
               "smell_type": "DuplicateMethodCall",
               "source": "smelly.rb",
               "context": "Smelly#m",
@@ -41,7 +39,6 @@ Feature: Report smells using simple JSON layout
               "count": 2
           },
           {
-              "smell_category": "UncommunicativeName",
               "smell_type": "UncommunicativeMethodName",
               "source": "smelly.rb",
               "context": "Smelly#m",
@@ -60,7 +57,6 @@ Feature: Report smells using simple JSON layout
       """
       [
           {
-              "smell_category": "IrresponsibleModule",
               "smell_type": "IrresponsibleModule",
               "source": "STDIN",
               "context": "Turn",

data/features/reports/yaml.feature

@@ -18,8 +18,7 @@ Feature: Report smells using simple YAML layout
     And it reports this yaml:
       """
       ---
-      - smell_category: Duplication
-        smell_type: DuplicateMethodCall
+      - smell_type: DuplicateMethodCall
         source: smelly.rb
         context: Smelly#m
         lines:
@@ -29,8 +28,7 @@ Feature: Report smells using simple YAML layout
         name: "@foo.bar"
         count: 2
         wiki_link: https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md
-      - smell_category: Duplication
-        smell_type: DuplicateMethodCall
+      - smell_type: DuplicateMethodCall
         source: smelly.rb
         context: Smelly#m
         lines:
@@ -40,8 +38,7 @@ Feature: Report smells using simple YAML layout
         name: puts @foo.bar
         count: 2
         wiki_link: https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md
-      - smell_category: UncommunicativeName
-        smell_type: UncommunicativeMethodName
+      - smell_type: UncommunicativeMethodName
         source: smelly.rb
         context: Smelly#m
         lines:
@@ -57,8 +54,7 @@ Feature: Report smells using simple YAML layout
     And it reports this yaml:
       """
       ---
-      - smell_category: IrresponsibleModule
-        smell_type: IrresponsibleModule
+      - smell_type: IrresponsibleModule
         source: "STDIN"
         context: Turn
         lines:

data/lib/reek.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Reek's core functionality
 #

data/lib/reek/ast/ast_node_class_map.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'node'
 require_relative 'sexp_extensions'
 

data/lib/reek/ast/node.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../cli/silencer'
 
 Reek::CLI::Silencer.silently do

data/lib/reek/ast/object_refs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   # Represents functionality related to an Abstract Syntax Tree.
   module AST
@@ -29,7 +30,7 @@ module Reek
       # @param line [Int] The line number where this reference occurs.
       #
       # @return [Int|nil] The line number that was added (which might be nil).
-      def record_reference(name: raise, line: nil)
+      def record_reference(name:, line: nil)
         refs[name] << line
       end
 

data/lib/reek/ast/reference_collector.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     #

data/lib/reek/ast/sexp_extensions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'reference_collector'
 
 require_relative 'sexp_extensions/arguments'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module AST
     module SexpExtensions

data/lib/reek/cli/application.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'options'
 require_relative 'option_interpreter'
 require_relative '../configuration/app_configuration'

data/lib/reek/cli/command/base_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module CLI
     module Command

data/lib/reek/cli/command/report_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'base_command'
 require_relative '../../examiner'
 
@@ -20,7 +21,7 @@ module Reek
         def populate_reporter_with_smells(app)
           sources.each do |source|
             reporter.add_examiner Examiner.new(source,
-                                               smell_names,
+                                               filter_by_smells: smell_names,
                                                configuration: app.configuration)
           end
         end

data/lib/reek/cli/command/todo_list_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'base_command'
 require_relative '../../examiner'
 
@@ -29,7 +30,7 @@ module Reek
         def scan_for_smells(app)
           sources.map do |source|
             Examiner.new(source,
-                         smell_names,
+                         filter_by_smells: smell_names,
                          configuration: app.configuration)
           end.map(&:smells).flatten
         end

data/lib/reek/cli/input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../source/source_locator'
 
 module Reek

data/lib/reek/cli/option_interpreter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'forwardable'
 require_relative 'input'
 require_relative '../report'

data/lib/reek/cli/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 require 'rainbow'
 require_relative '../version'

data/lib/reek/cli/silencer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'stringio'
 
 module Reek