reek 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1ca3caed81210da21611c9fb1de45c3aca7ddea
-  data.tar.gz: 669b33cc75cb7ec917dfab1ea1f132507bbf31d7
+  metadata.gz: 654a7a3741c1426d2a2e40b05fe4f07515f7fe2e
+  data.tar.gz: c6b97971092b5645f2ae4ee55e5a82859371e360
 SHA512:
-  metadata.gz: aaccd35e8f1a2c0e4593c5a0e859dd2beb4b631566773816e0ba906de0ba939be9fc1794e76ef3b53abc29b4a8b953250344ac9dd55f5bc6b71c56377312aa37
-  data.tar.gz: 089641f2903a7594330f596d642b2d8f1dcc883ed5f4b999be64a3933949d5738aef3878b76a7a8e80b25fae8074c6c9dd64da6e16e0143d9892fdedcdf6a1da
+  metadata.gz: 7272b0e52da60a43de15c0dc72d794554fb01652c054c07be603de16ab52c156fa857e71330b2087528a9fe049bb13366b09e55c60883037e2df199bbdfcf0e5
+  data.tar.gz: 717834c506b575606000461375091233f5d90b5cbd8bc3ccf6bb9b7fc93d4035ad4944d5b4ba570f16a7249cb1b72681d377f44f5e44ae487f4c0627dad97d39

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 1.6.2
+
+* (mvz) Fix rake task bug when no config file was given explicitly.
+* (troessner) Run on working directory when no source is given.
+
 == 1.6.1
 
 * (mvz) Fix regression in rake task: Provide alias for backward compatibility

data/README.md

@@ -54,6 +54,43 @@ spec/samples/demo/demo.rb -- 6 warnings:
   Dirty#awful has unused parameter 'y' (UnusedParameters)
 ```
 
+## Sources
+
+There are multiple ways you can have `reek` work on sources, the most common one just being
+
+```Bash
+reek lib/
+```
+
+If you don't pass any source arguments to `reek` it just takes the current working directory as source.
+
+So
+
+```Bash
+reek
+```
+
+is the exact same thing like being explicit:
+
+```Bash
+reek .
+```
+
+Additionally can you pipe code to reek like this:
+
+```Bash
+echo "class C; def m; end; end" | reek
+```
+
+This would print out:
+
+```Bash
+$stdin -- 3 warnings:
+  [1]:C has no descriptive comment (IrresponsibleModule)
+  [1]:C has the name 'C' (UncommunicativeModuleName)
+  [1]:C#m has the name 'm' (UncommunicativeMethodName)
+```
+
 ## Code smells
 
 `reek` currently includes checks for some aspects of [Control Couple](https://github.com/troessner/reek/wiki/Control-Couple), [Data Clump](https://github.com/troessner/reek/wiki/Data-Clump), [Feature Envy](https://github.com/troessner/reek/wiki/Feature-Envy), [Large Class](https://github.com/troessner/reek/wiki/Large-Class), [Long Parameter List](https://github.com/troessner/reek/wiki/Long-Parameter-List), [Simulated Polymorphism](https://github.com/troessner/reek/wiki/Simulated-Polymorphism), [Too Many Statements](https://github.com/troessner/reek/wiki/Too-Many-Statements), [Uncommunicative Name](https://github.com/troessner/reek/wiki/Uncommunicative-Name), [Unused Parameters](https://github.com/troessner/reek/wiki/Unused-Parameters) and more. See the [Code Smells](https://github.com/troessner/reek/wiki/Code-Smells) for up to date details of exactly what `reek` will check in your code.

data/features/configuration_loading.feature

@@ -0,0 +1,62 @@
+Feature: Offer different ways how to load configuration
+
+  There are 3 ways of passing reek a configuration file:
+  - Using the cli "-c" switch
+  - Having a file ending with .reek either in your current working directory or in a parent directory
+  - Having a file ending with .reek in your HOME directory
+  The order in which reek tries to find such a configuration file should exactly be like above:
+  First reek should check if we have given it a configuration file explicitly via CLI.
+  Then it should check the current working directory for a file and if it can't find one,
+  it should traverse up the directories until it hits the root directory.
+  And finally, it should check your HOME directory.
+
+  Scenario: No configuration
+    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/configuration_loading/minimal_dirty.rb -- 3 warnings:
+        [1]:C has no descriptive comment (IrresponsibleModule)
+        [1]:C has the name 'C' (UncommunicativeModuleName)
+        [2]:C#m has the name 'm' (UncommunicativeMethodName)
+      """
+
+  Scenario: Configuration via CLI
+    When I run reek -c spec/samples/minimal_smelly_and_masked/config.reek spec/samples/minimal_smelly_and_masked/minimal_dirty.rb
+    Then it reports no errors
+    And it succeeds
+
+  @remove-disable-smell-config-from-current-dir
+  Scenario: Configuration file in working directory
+    Given "spec/samples/configuration_loading/reek-test-run-disable_smells.reek" exists in the working directory
+    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Then it reports no errors
+    And it succeeds
+
+  @remove-disable-smell-config-from-parent-dir
+  Scenario: Configuration file in the parent directory of the working directory
+    Given "spec/samples/configuration_loading/reek-test-run-disable_smells.reek" exists in the parent directory of the working directory
+    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Then it reports no errors
+    And it succeeds
+
+  @remove-disable-smell-config-from-home-dir
+  Scenario: Configuration file in the HOME directory
+    Given "spec/samples/configuration_loading/reek-test-run-disable_smells.reek" exists in the HOME directory
+    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Then it reports no errors
+    And it succeeds
+
+  @remove-enable-smell-config-from-current-dir @remove-disable-smell-config-from-parent-dir
+  Scenario: Two opposing configuration files and we stop after the first one
+    Given "spec/samples/configuration_loading/reek-test-run-enable_smells.reek" exists in the working directory
+    And "spec/samples/configuration_loading/reek-test-run-disable_smells.reek" exists in the parent directory of the working directory
+    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/configuration_loading/minimal_dirty.rb -- 3 warnings:
+        [1]:C has no descriptive comment (IrresponsibleModule)
+        [1]:C has the name 'C' (UncommunicativeModuleName)
+        [2]:C#m has the name 'm' (UncommunicativeMethodName)
+      """

data/features/step_definitions/reek_steps.rb

@@ -67,3 +67,15 @@ end
 Then /^it reports the current version$/ do
   expect(@last_stdout).to eq "reek #{Reek::VERSION}\n"
 end
+
+Given(/^"(.*?)" exists in the working directory$/) do |path|
+  FileUtils.cp path, Pathname.pwd
+end
+
+Given(/^"(.*?)" exists in the parent directory of the working directory$/) do |path|
+  FileUtils.cp path, Pathname.pwd.parent
+end
+
+Given(/^"(.*?)" exists in the HOME directory$/) do |path|
+  FileUtils.cp path, Pathname.new(Dir.home)
+end

data/features/support/env.rb

@@ -5,8 +5,7 @@ require 'open3'
 require 'reek/cli/application'
 
 begin
-  require 'pry'
-  require 'byebug'
+  require 'pry-byebug'
 rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
 

data/features/support/hooks.rb

@@ -0,0 +1,15 @@
+After('@remove-disable-smell-config-from-current-dir') do
+  Pathname.pwd.join('reek-test-run-disable_smells.reek').delete
+end
+
+After('@remove-disable-smell-config-from-parent-dir') do
+  Pathname.pwd.parent.join('reek-test-run-disable_smells.reek').delete
+end
+
+After('@remove-disable-smell-config-from-home-dir') do
+  Pathname.new(Dir.home).join('reek-test-run-disable_smells.reek').delete
+end
+
+After('@remove-enable-smell-config-from-current-dir') do
+  Pathname.pwd.join('reek-test-run-enable_smells.reek').delete
+end

data/lib/reek/cli/input.rb

@@ -0,0 +1,46 @@
+require 'reek/source'
+
+module Reek
+  module CLI
+    #
+    # CLI Input utility
+    #
+    module Input
+      def sources
+        if input_was_piped?
+          source_from_pipe
+        else
+          if no_source_files_given?
+            working_directory_as_source
+          else
+            sources_from_argv
+          end
+        end
+      end
+
+      private
+
+      def input_was_piped?
+        !$stdin.tty?
+      end
+
+      def no_source_files_given?
+        # At this point we have deleted all options from @argv. The only remaining entries
+        # are paths to the source files. If @argv is empty, this means that no files were given.
+        @argv.empty?
+      end
+
+      def working_directory_as_source
+        Source::SourceLocator.new(['.']).all_sources
+      end
+
+      def sources_from_argv
+        Source::SourceLocator.new(@argv).all_sources
+      end
+
+      def source_from_pipe
+        [$stdin.to_reek_source('$stdin')]
+      end
+    end
+  end
+end

data/lib/reek/cli/options.rb

@@ -6,7 +6,7 @@ require 'reek/cli/report/strategy'
 require 'reek/cli/reek_command'
 require 'reek/cli/help_command'
 require 'reek/cli/version_command'
-require 'reek/source'
+require 'reek/cli/input'
 
 module Reek
   module Cli
@@ -14,50 +14,38 @@ module Reek
     # Parses the command line
     #
     class Options
+      include CLI::Input
+
+      attr_reader :config_file, :smells_to_detect
+
       def initialize(argv)
-        @argv = argv
-        @parser = OptionParser.new
-        @colored = true
-        @report_class = Report::TextReport
-        @strategy = Report::Strategy::Quiet
-        @warning_formatter = Report::WarningFormatterWithLineNumbers
-        @command_class = ReekCommand
-        @config_file = nil
+        @argv                = argv
+        @parser              = OptionParser.new
+        @colored             = true
+        @report_class        = Report::TextReport
+        @strategy            = Report::Strategy::Quiet
+        @warning_formatter   = Report::WarningFormatterWithLineNumbers
+        @command_class       = ReekCommand
+        @config_file         = nil
         @sort_by_issue_count = false
-        @smells_to_detect = []
+        @smells_to_detect    = []
         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
-        #      -c|--config file    Specify file(s) with config options
-        #      -n|--line-number    Prefix smelly lines with line numbers
-        #      -q|-[no-]quiet      Only list files that have smells
-        #      files               Names of files or dirs to be checked
-        #
-        <<EOB
-Usage: #{progname} [options] [files]
+        <<-EOB.gsub(/^[ ]+/, '')
+          Usage: #{progname} [options] [files]
 
-Examples:
+          Examples:
 
-#{progname} lib/*.rb
-#{progname} -q lib
-cat my_class.rb | #{progname}
+          #{progname} lib/*.rb
+          #{progname} -q lib
+          cat my_class.rb | #{progname}
 
-See http://wiki.github.com/troessner/reek for detailed help.
+          See http://wiki.github.com/troessner/reek for detailed help.
 
-EOB
+        EOB
       end
 
       def set_options
@@ -117,9 +105,6 @@ EOB
         @command_class.new(self)
       end
 
-      attr_reader :config_file
-      attr_reader :smells_to_detect
-
       def reporter
         @reporter ||= @report_class.new(warning_formatter: @warning_formatter,
                                         report_formatter: Report::Formatter,
@@ -127,14 +112,6 @@ EOB
                                         strategy: @strategy)
       end
 
-      def sources
-        if @argv.empty?
-          return [$stdin.to_reek_source('$stdin')]
-        else
-          return Source::SourceLocator.new(@argv).all_sources
-        end
-      end
-
       def program_name
         @parser.program_name
       end

data/lib/reek/rake/task.rb

@@ -115,10 +115,18 @@ module Reek
           ruby_options +
           [%(reek)] +
           [sort_option] +
-          ['-c', config_file] +
+          config_option +
           source_file_list.map { |fn| %("#{fn}") }
       end
 
+      def config_option
+        if config_file
+          ['-c', config_file]
+        else
+          []
+        end
+      end
+
       def config_file
         ENV['REEK_CFG'] || @config_file
       end

data/lib/reek/version.rb

@@ -1,3 +1,3 @@
 module Reek
-  VERSION = '1.6.1'
+  VERSION = '1.6.2'
 end

data/reek.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency('parser', ['~> 2.2.0.pre.7'])
-  s.add_runtime_dependency('unparser', ['~> 0.1.16'])
+  s.add_runtime_dependency('unparser', ['= 0.1.16'])
   s.add_runtime_dependency('rainbow', ['>= 1.99', '< 3.0'])
 
   s.add_development_dependency('bundler', ['~> 1.1'])

data/spec/samples/configuration_loading/minimal_dirty.rb

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

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

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

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

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

data/spec/spec_helper.rb

@@ -5,8 +5,7 @@ require 'matchers/smell_of_matcher'
 require 'factory_girl'
 
 begin
-  require 'pry'
-  require 'byebug'
+  require 'pry-byebug'
 rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-30 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -30,14 +30,14 @@ dependencies:
   name: unparser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.1.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.1.16
 - !ruby/object:Gem::Dependency
@@ -190,6 +190,7 @@ files:
 - features/command_line_interface/stdin.feature
 - features/configuration_files/masking_smells.feature
 - features/configuration_files/overrides_defaults.feature
+- features/configuration_loading.feature
 - features/rake_task/rake_task.feature
 - features/reports/reports.feature
 - features/reports/yaml.feature
@@ -197,10 +198,12 @@ files:
 - features/samples.feature
 - features/step_definitions/reek_steps.rb
 - features/support/env.rb
+- features/support/hooks.rb
 - lib/reek.rb
 - lib/reek/cli/application.rb
 - lib/reek/cli/command.rb
 - lib/reek/cli/help_command.rb
+- lib/reek/cli/input.rb
 - lib/reek/cli/options.rb
 - lib/reek/cli/reek_command.rb
 - lib/reek/cli/report/formatter.rb
@@ -338,6 +341,9 @@ files:
 - spec/samples/clean_due_to_masking/masked.reek
 - spec/samples/config/allow_duplication.reek
 - spec/samples/config/deeper_nested_iterators.reek
+- spec/samples/configuration_loading/minimal_dirty.rb
+- spec/samples/configuration_loading/reek-test-run-disable_smells.reek
+- spec/samples/configuration_loading/reek-test-run-enable_smells.reek
 - spec/samples/corrupt_config_file/corrupt.reek
 - spec/samples/corrupt_config_file/dirty.rb
 - spec/samples/demo/demo.rb
@@ -413,7 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: reek
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby