reek 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad832e1c2e46ca1fd1789a92f7b8b30854ff2215
-  data.tar.gz: 800911908bdc3111d76ff930e161a7d6f87fecf1
+  metadata.gz: cd6196b99429388642049ac970d159ca81066a08
+  data.tar.gz: 45ec008b56f8a42ca8edeaa9951ecc8b03fd5d7c
 SHA512:
-  metadata.gz: c4588f0c10b1bb8bb3e8ac9afab01f1209588919b8939a3dbec5276eb5b8383c9f55f52e68e5f111a21c77d72cc57fd9acc4755797383a6c72bc4ed86e04c42a
-  data.tar.gz: 22d3b703a28c5b561ac4f53d2e846333d2cda22b27e8e4931fe7ea64033d4436486e40b7f5d02838f06a4e76d88d7a7d44b98492b040794c57c23ec499baf935
+  metadata.gz: a09c19c44892cd6d2b8cc82b0fa82c8563fbed0c8734b8f12dfbb5906c223b664ab15e95cdeea8d2270004e06a182968d161bd644a044b157236e69141b8be80
+  data.tar.gz: a6ff074ebe7abd1a2029ffd6a3f04571ee75beb5709cef297a221bc37b3427fa84c5d53de767ccecf2f248e70a0cdf75fb8e363eb776ddec0b0aa9f1d2018c93

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 1.3.6
+
+* (troessner) Add `Prima Donna Method` smell
+
 == 1.3.5
 
 * (troessner) Allow sorting by issue count

data/config/defaults.reek

@@ -46,6 +46,9 @@ NestedIterators:
 NilCheck:
   enabled: true
   exclude: []
+PrimaDonnaMethod:
+  enabled: true
+  exclude: []
 RepeatedConditional:
   enabled: true
   exclude: []

data/lib/reek/core/code_context.rb

@@ -22,6 +22,10 @@ module Reek
         @exp.name
       end
 
+      def node_instance_methods
+        local_nodes(:defn)
+      end
+
       def local_nodes(type, &blk)
         each_node(type, [:class, :module], &blk)
       end

data/lib/reek/core/smell_repository.rb

@@ -19,6 +19,7 @@ module Reek
           Smells::LongYieldList,
           Smells::NestedIterators,
           Smells::NilCheck,
+          Smells::PrimaDonnaMethod,
           Smells::RepeatedConditional,
           Smells::TooManyInstanceVariables,
           Smells::TooManyMethods,

data/lib/reek/smells.rb

@@ -10,6 +10,7 @@ require 'reek/smells/long_parameter_list'
 require 'reek/smells/long_yield_list'
 require 'reek/smells/nested_iterators'
 require 'reek/smells/nil_check'
+require 'reek/smells/prima_donna_method'
 require 'reek/smells/repeated_conditional'
 require 'reek/smells/too_many_instance_variables'
 require 'reek/smells/too_many_methods'

data/lib/reek/smells/prima_donna_method.rb

@@ -0,0 +1,41 @@
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
+
+module Reek
+  module Smells
+    # Excerpt from:
+    # http://dablog.rubypal.com/2007/8/15/bang-methods-or-danger-will-rubyist
+    # since this sums it up really well:
+    # ------------------------------
+    # The ! in method names that end with ! means, “This method is dangerous”
+    # or, more precisely, this method is the “dangerous” version of an
+    # equivalent method, with the same name minus the !.  “Danger” is relative;
+    # the ! doesn’t mean anything at all unless the method name it’s in
+    # corresponds to a similar but bang-less method name.  Don’t add ! to your
+    # destructive (receiver-changing) methods’ names, unless you consider the
+    # changing to be “dangerous” and you have a “non-dangerous” equivalent
+    # method without the !.  If some arbitrary subset of destructive methods end
+    # with !, then the whole point of ! gets distorted and diluted, and ! ceases
+    # to convey any information whatsoever
+    # ------------------------------
+    # Such a method is called PrimaDonnaMethod and is reported as a smell.
+    class PrimaDonnaMethod < SmellDetector
+      SMELL_CLASS    = smell_class_name
+      SMELL_SUBCLASS = smell_class_name
+
+      def self.contexts
+        [:class]
+      end
+
+      def examine_context(ctx)
+        ctx.node_instance_methods.map do |method_sexp|
+          if method_sexp.ends_with_bang?
+            SmellWarning.new(SMELL_CLASS, ctx.full_name, [ctx.exp.line],
+                             %Q!has prima donna method `#{method_sexp.name}`!,
+                             @source, SMELL_SUBCLASS) unless ctx.node_instance_methods.detect {|sexp_item| sexp_item.name.to_s == method_sexp.name_without_bang }
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/reek/smells/smell_detector.rb

@@ -36,6 +36,10 @@ module Reek
             EXCLUDE_KEY => DEFAULT_EXCLUDE_SET.dup
           }
         end
+
+        def smell_class_name
+          name.split(/::/)[-1]
+        end
       end
 
       attr_reader :smells_found   # SMELL: only published for tests

data/lib/reek/source/sexp_extensions.rb

@@ -46,6 +46,14 @@ module Reek
         def parameter_names
           @param_names ||= argslist[1..-1].map { |param| Sexp === param ?  param[1] : param }
         end
+
+        def name_without_bang
+          name.to_s.chop
+        end
+
+        def ends_with_bang?
+          name[-1] == '!'
+        end
       end
 
       module DefnNode

data/lib/reek/version.rb

@@ -1,3 +1,3 @@
 module Reek
-  VERSION = '1.3.5'
+  VERSION = '1.3.6'
 end

data/spec/reek/smells/feature_envy_spec.rb

@@ -122,7 +122,7 @@ EOS
 
   it 'counts self references correctly' do
     src = <<EOS
-def adopt!(other)
+def adopt(other)
   other.keys.each do |key|
     self[key] += 3
     self[key] = o4

data/spec/reek/smells/prima_donna_method_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+require 'reek/smells/smell_detector_shared'
+
+include Reek
+include Reek::Smells
+
+describe PrimaDonnaMethod do
+  it 'should report nothing when method and bang counterpart exist' do
+    'class C; def m; end; def m!; end; end'.should_not smell_of(PrimaDonnaMethod)
+  end
+
+  it 'should report PrimaDonnaMethod when only bang method exists' do
+    'class C; def m!; end; end'.should smell_of(PrimaDonnaMethod)
+  end
+
+  describe 'the right smell' do
+    let(:detector) { PrimaDonnaMethod.new('dummy_source') }
+    let(:src)      { 'class C; def m!; end; end' }
+    let(:ctx)      { CodeContext.new(nil, src.to_reek_source.syntax_tree) }
+
+    it 'should be reported' do
+      smells = detector.examine_context(ctx)
+      warning = smells[0]
+
+      warning.smell['class'].should    == 'PrimaDonnaMethod'
+      warning.smell['subclass'].should == 'PrimaDonnaMethod'
+      warning.lines.should             == [1]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-23 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
@@ -187,6 +187,7 @@ files:
 - lib/reek/version.rb
 - lib/reek/smells/boolean_parameter.rb
 - lib/reek/smells/uncommunicative_parameter_name.rb
+- lib/reek/smells/prima_donna_method.rb
 - lib/reek/smells/unused_parameters.rb
 - lib/reek/smells/long_yield_list.rb
 - lib/reek/smells/attribute.rb
@@ -245,6 +246,7 @@ files:
 - spec/reek/cli/yaml_command_spec.rb
 - spec/reek/cli/report_spec.rb
 - spec/reek/cli/version_command_spec.rb
+- spec/reek/smells/prima_donna_method_spec.rb
 - spec/reek/smells/boolean_parameter_spec.rb
 - spec/reek/smells/uncommunicative_method_name_spec.rb
 - spec/reek/smells/uncommunicative_module_name_spec.rb