RubyGems - simplabs-excellent - Versions diffs - 1.5.0 → 1.5.1 - Mend

simplabs-excellent 1.5.0 → 1.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

data/History.txt +5 -0
data/VERSION.yml +1 -1
data/lib/simplabs/excellent.rb +1 -1
data/lib/simplabs/excellent/checks.rb +0 -2
data/lib/simplabs/excellent/runner.rb +2 -3
metadata +1 -5
data/lib/simplabs/excellent/checks/block_duplication_check.rb +0 -49
data/lib/simplabs/excellent/checks/method_duplication_check.rb +0 -49
data/spec/checks/block_duplication_check_spec.rb +0 -95
data/spec/checks/method_duplication_check_spec.rb +0 -127

data/History.txt CHANGED

@@ -1,3 +1,8 @@
+= 1.5.1
+* removed duplication checks (they are just too coarse for dynamic languages like Ruby and especially Rails apps where you would call e.g. params all over the place)
+* added Rails::ValidationsCheck to the default checks
 = 1.5.0
 * new check Rails::ValidationsCheck that reports ActiveRecord models that do not validate anything

data/VERSION.yml CHANGED

@@ -1,4 +1,4 @@
 ---
 :major: 1
 :minor: 5
-:patch: 0
+:patch: 1

data/lib/simplabs/excellent.rb CHANGED

@@ -9,7 +9,7 @@ module Simplabs #:nodoc:
   module Excellent #:nodoc:
-    VERSION = '1.5.0'
+    VERSION = '1.5.1'
   end

data/lib/simplabs/excellent/checks.rb CHANGED

@@ -25,8 +25,6 @@ require 'simplabs/excellent/checks/method_name_check'
 require 'simplabs/excellent/checks/module_line_count_check'
 require 'simplabs/excellent/checks/module_name_check'
 require 'simplabs/excellent/checks/parameter_number_check'
-require 'simplabs/excellent/checks/method_duplication_check'
-require 'simplabs/excellent/checks/block_duplication_check'
 require 'simplabs/excellent/checks/nested_iterators_check'
 require 'simplabs/excellent/checks/flog_method_check'
 require 'simplabs/excellent/checks/flog_block_check'

data/lib/simplabs/excellent/runner.rb CHANGED

@@ -29,11 +29,10 @@ module Simplabs
         :FlogMethodCheck                    => { },
         :FlogBlockCheck                     => { },
         :FlogClassCheck                     => { },
-        :BlockDuplicationCheck              => { },
-        :MethodDuplicationCheck             => { },
         :'Rails::AttrProtectedCheck'        => { },
         :'Rails::AttrAccessibleCheck'       => { },
-        :'Rails::InstanceVarInPartialCheck' => { }
+        :'Rails::InstanceVarInPartialCheck' => { },
+        :'Rails::ValidationsCheck'          => { }
       }
       attr_accessor :config #:nodoc:

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplabs-excellent
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Marco Otte-Witte
@@ -48,7 +48,6 @@ files:
 - lib/simplabs/excellent/checks/abc_metric_method_check.rb
 - lib/simplabs/excellent/checks/assignment_in_conditional_check.rb
 - lib/simplabs/excellent/checks/base.rb
-- lib/simplabs/excellent/checks/block_duplication_check.rb
 - lib/simplabs/excellent/checks/case_missing_else_check.rb
 - lib/simplabs/excellent/checks/class_line_count_check.rb
 - lib/simplabs/excellent/checks/class_name_check.rb
@@ -63,7 +62,6 @@ files:
 - lib/simplabs/excellent/checks/flog_method_check.rb
 - lib/simplabs/excellent/checks/for_loop_check.rb
 - lib/simplabs/excellent/checks/line_count_check.rb
-- lib/simplabs/excellent/checks/method_duplication_check.rb
 - lib/simplabs/excellent/checks/method_line_count_check.rb
 - lib/simplabs/excellent/checks/method_name_check.rb
 - lib/simplabs/excellent/checks/module_line_count_check.rb
@@ -115,7 +113,6 @@ files:
 - lib/simplabs/excellent.rb
 - spec/checks/abc_metric_method_check_spec.rb
 - spec/checks/assignment_in_conditional_check_spec.rb
-- spec/checks/block_duplication_check_spec.rb
 - spec/checks/case_missing_else_check_spec.rb
 - spec/checks/class_line_count_check_spec.rb
 - spec/checks/class_name_check_spec.rb
@@ -127,7 +124,6 @@ files:
 - spec/checks/flog_class_check_spec.rb
 - spec/checks/flog_method_check_spec.rb
 - spec/checks/for_loop_check_spec.rb
-- spec/checks/method_duplication_check_spec.rb
 - spec/checks/method_line_count_check_spec.rb
 - spec/checks/method_name_check_spec.rb
 - spec/checks/module_line_count_check_spec.rb

data/lib/simplabs/excellent/checks/block_duplication_check.rb DELETED

@@ -1,49 +0,0 @@
-require 'simplabs/excellent/checks/base'
-module Simplabs
-  module Excellent
-    module Checks
-      # This check reports duplicated code. It currently finds repeated identical method calls such as:
-      #
-      #  def method
-      #    other_method + other_method
-      #  end
-      #
-      # ==== Applies to
-      #
-      # * blocks
-      class BlockDuplicationCheck < Base
-        DEFAULT_THRESHOLD = 1
-        def initialize(options = {}) #:nodoc:
-          super()
-          @threshold         = options[:threshold] || DEFAULT_THRESHOLD
-          @interesting_nodes = [:iter]
-        end
-        def evaluate(context) #:nodoc:
-          context.calls.each do |call, number|
-            if number > @threshold && call.method != 'new'
-              add_warning(
-                context,
-                '{{block}} calls {{statement}} {{duplication_number}} times.', {
-                  :block              => context.full_name,
-                  :statement          => call.full_name,
-                  :duplication_number => number
-                }
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/simplabs/excellent/checks/method_duplication_check.rb DELETED

@@ -1,49 +0,0 @@
-require 'simplabs/excellent/checks/base'
-module Simplabs
-  module Excellent
-    module Checks
-      # This check reports duplicated code. It currently finds repeated identical method calls such as:
-      #
-      #  def method
-      #    other_method + other_method
-      #  end
-      #
-      # ==== Applies to
-      #
-      # * methods
-      class MethodDuplicationCheck < Base
-        DEFAULT_THRESHOLD = 1
-        def initialize(options = {}) #:nodoc:
-          super()
-          @threshold         = options[:threshold] || DEFAULT_THRESHOLD
-          @interesting_nodes = [:defn, :defs]
-        end
-        def evaluate(context) #:nodoc:
-          context.calls.each do |call, number|
-            if number > @threshold && call.method != 'new'
-              add_warning(
-                context,
-                '{{method}} calls {{statement}} {{duplication_number}} times.', {
-                  :method             => context.full_name,
-                  :statement          => call.full_name,
-                  :duplication_number => number
-                }
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/spec/checks/block_duplication_check_spec.rb DELETED

@@ -1,95 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-describe Simplabs::Excellent::Checks::BlockDuplicationCheck do
-  before do
-    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::BlockDuplicationCheck.new({ :threshold => 1 }))
-  end
-  describe '#evaluate' do
-    it 'should accept multiple calls to new' do
-      code = <<-END
-        double_thing do
-          @thing.new + @thing.new
-        end
-      END
-      @excellent.check_code(code)
-      warnings = @excellent.warnings
-      warnings.should be_empty
-    end
-    it 'should reject multiple calls to the same method and receiver' do
-      code = <<-END
-        double_thing do
-          @other.thing + @other.thing
-        end
-      END
-      verify_warning_found(code, '@other.thing')
-    end
-    it 'should reject multiple calls to the same lvar' do
-      code = <<-END
-        double_thing do
-          thing[1] + thing[2]
-        end
-      END
-      verify_warning_found(code, 'thing.[]')
-    end
-    it 'should reject multiple calls to the same singleton method' do
-      code = <<-END
-        double_thing do
-          Class.thing[1] + Class.thing[2]
-        end
-      END
-      verify_warning_found(code, 'Class.thing')
-    end
-    it 'should reject multiple calls to the same method without a receiver' do
-      code = <<-END
-        double_thing do
-          thing + thing
-        end
-      END
-      verify_warning_found(code, 'thing')
-    end
-    it 'should reject multiple calls to the same method with the same parameters' do
-      code = <<-END
-        double_thing do
-          thing(1) + thing(1)
-        end
-      END
-      verify_warning_found(code, 'thing')
-    end
-    it 'should reject multiple calls to the same method with different parameters' do
-      code = <<-END
-        double_thing do
-          thing(1) + thing(2)
-        end
-      END
-      verify_warning_found(code, 'thing')
-    end
-  end
-  def verify_warning_found(code, statement)
-    @excellent.check_code(code)
-    warnings = @excellent.warnings
-    warnings.should_not be_empty
-    warnings[0].info.should        == { :block => 'block', :statement => statement, :duplication_number => 2 }
-    warnings[0].line_number.should == 1
-    warnings[0].message.should     == "block calls #{statement} 2 times."
-  end
-end

data/spec/checks/method_duplication_check_spec.rb DELETED

@@ -1,127 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-describe Simplabs::Excellent::Checks::MethodDuplicationCheck do
-  before do
-    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::MethodDuplicationCheck.new({ :threshold => 1 }))
-  end
-  describe '#evaluate' do
-    it 'should accept multiple calls to new' do
-      code = <<-END
-        def double_thing
-          @thing.new + @thing.new
-        end
-      END
-      @excellent.check_code(code)
-      warnings = @excellent.warnings
-      warnings.should be_empty
-    end
-    it 'should reject multiple calls to the same method and receiver' do
-      code = <<-END
-        def double_thing
-          @other.thing + @other.thing
-        end
-      END
-      verify_warning_found(code, '@other.thing')
-    end
-    it 'should reject multiple calls to the same lvar' do
-      code = <<-END
-        def double_thing
-          thing[1] + thing[2]
-        end
-      END
-      verify_warning_found(code, 'thing.[]')
-    end
-    it 'should reject multiple calls to the same singleton method' do
-      code = <<-END
-        def double_thing
-          Class.thing[1] + Class.thing[2]
-        end
-      END
-      verify_warning_found(code, 'Class.thing')
-    end
-    it 'should reject multiple calls to the same method without a receiver' do
-      code = <<-END
-        def double_thing
-          thing + thing
-        end
-      END
-      verify_warning_found(code, 'thing')
-    end
-    it 'should reject multiple calls to the same method with the same parameters' do
-      code = <<-END
-        def double_thing
-          thing(1) + thing(1)
-        end
-      END
-      verify_warning_found(code, 'thing')
-    end
-    it 'should reject multiple calls to the same method with different parameters' do
-      code = <<-END
-        def double_thing
-          thing(1) + thing(2)
-        end
-      END
-      verify_warning_found(code, 'thing')
-    end
-    it 'should work with singleton methods on objects' do
-      code = <<-END
-        def object.double_thing
-          thing(1) + thing(2)
-        end
-      END
-      verify_warning_found(code, 'thing', 'object.double_thing')
-    end
-    it 'should work with singleton methods on classes' do
-      code = <<-END
-        def Class.double_thing
-          thing(1) + thing(2)
-        end
-      END
-      verify_warning_found(code, 'thing', 'Class.double_thing')
-    end
-    it 'should work with singleton methods on classes' do
-      code = <<-END
-        class Class
-          def self.double_thing
-            thing(1) + thing(2)
-          end
-        end
-      END
-      verify_warning_found(code, 'thing', 'Class.double_thing', 2)
-    end
-  end
-  def verify_warning_found(code, statement, method = 'double_thing', line = 1)
-    @excellent.check_code(code)
-    warnings = @excellent.warnings
-    warnings.should_not be_empty
-    warnings[0].info.should        == { :method => method, :statement => statement, :duplication_number => 2 }
-    warnings[0].line_number.should == line
-    warnings[0].message.should     == "#{method} calls #{statement} 2 times."
-  end
-end