simplabs-excellent 1.4.2 → 1.5.0

data/History.txt

@@ -1,3 +1,9 @@
+= 1.5.0
+
+* new check Rails::ValidationsCheck that reports ActiveRecord models that do not validate anything
+* added DuplicationCheck to default checks
+* split DuplicationCheck up into MethodDuplicationCheck and BlockDuplicationCheck
+
 = 1.4.1
 
 * added Rake Task (see Rakefile for example)

data/README.rdoc

@@ -22,6 +22,15 @@ get a formatted HTML report, just specify <tt>html:<filename></tt>:
 
   excellent html:out.html app/models
 
+You can also use Excellent in a Rake task:
+
+  require 'simplabs/excellent/rake'
+
+  Simplabs::Excellent::Rake::ExcellentTask.new(:excellent) do |t|
+    t.html  = 'doc/excellent.html' # optional, if you don't specify html, output will be written to $stdout
+    t.paths = %w(app lib)
+  end
+
 == Static analysis
 
 A few words regarding static code analysis: Static code analysis tools like Excellent can never really understand the code. They just search for patterns that *might* inidicate problematic code. The word *might* really has to be stressed here since static analysis will usually return a reasonable number of false positives. For example, there might be pretty good reasons for empty +rescue+ blocks that suppress all errors (Excellent itself does it). So, don't try and code with the aim of passing Excellent with zero warnings. That will most likely make your code a mess. Instead use Excellent as a helper to find *possibly* problematic code early.

data/VERSION.yml

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

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

@@ -0,0 +1,49 @@
+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/{duplication_check.rb → method_duplication_check.rb}

@@ -15,15 +15,14 @@ module Simplabs
       # ==== Applies to
       #
       # * methods
-      # * blocks
-      class DuplicationCheck < Base
+      class MethodDuplicationCheck < Base
 
         DEFAULT_THRESHOLD = 1
 
         def initialize(options = {}) #:nodoc:
           super()
           @threshold         = options[:threshold] || DEFAULT_THRESHOLD
-          @interesting_nodes = [:defn, :defs, :iter]
+          @interesting_nodes = [:defn, :defs]
         end
 
         def evaluate(context) #:nodoc:

data/lib/simplabs/excellent/checks/rails/attr_accessible_check.rb

@@ -24,7 +24,7 @@ module Simplabs
           end
 
           def evaluate(context) #:nodoc:
-            add_warning(context, '{{class}} does not specify attr_accessible.', { :class => context.full_name }) if context.activerecord_model? && !context.specifies_attr_accessible?
+            add_warning(context, '{{class}} does not specify attr_accessible.', { :class => context.full_name }) if context.active_record_model? && !context.specifies_attr_accessible?
           end
 
         end

data/lib/simplabs/excellent/checks/rails/attr_protected_check.rb

@@ -25,7 +25,7 @@ module Simplabs
           end
 
           def evaluate(context) #:nodoc:
-            add_warning(context, '{{class}} specifies attr_protected.', { :class => context.full_name }) if context.activerecord_model? && context.specifies_attr_protected?
+            add_warning(context, '{{class}} specifies attr_protected.', { :class => context.full_name }) if context.active_record_model? && context.specifies_attr_protected?
           end
 
         end

data/lib/simplabs/excellent/checks/rails/validations_check.rb

@@ -0,0 +1,36 @@
+require 'simplabs/excellent/checks/base'
+
+module Simplabs
+
+  module Excellent
+
+    module Checks
+
+      module Rails
+
+        # This check reports +ActiveRecord+ models that do not validate anything. Not validating anything in the model is usually not intended and has
+        # most likely just been forgotten. For more information on validations and why to use them, see http://guides.rubyonrails.org/activerecord_validations_callbacks.html#why-use-validations.
+        #
+        # ==== Applies to
+        #
+        # * +ActiveRecord+ models
+        class ValidationsCheck < Base
+
+          def initialize #:nodoc:
+            super
+            @interesting_nodes = [:class]
+          end
+
+          def evaluate(context) #:nodoc:
+            add_warning(context, '{{class}} does not validate any attributes.', { :class => context.full_name }) if context.active_record_model? && !context.validating?
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -16,3 +16,4 @@ end
 require 'simplabs/excellent/checks/rails/attr_accessible_check'
 require 'simplabs/excellent/checks/rails/attr_protected_check'
 require 'simplabs/excellent/checks/rails/instance_var_in_partial_check'
+require 'simplabs/excellent/checks/rails/validations_check'

data/lib/simplabs/excellent/checks.rb

@@ -25,7 +25,8 @@ 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/duplication_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/parsing/call_context.rb

@@ -16,6 +16,8 @@ module Simplabs
           @receiver  = exp[1].is_a?(Sexp) ? (exp[1][1].nil? ? exp[1][2].to_s : exp[1][1].to_s) : nil
           @method    = exp[2].to_s
           @full_name = [@receiver, @method].compact.join('.')
+          record_validation
+          record_call
         end
 
         def <=>(other)
@@ -27,6 +29,20 @@ module Simplabs
           @full_name.hash
         end
 
+        private
+
+          def record_call
+            parent = @parent
+            parent = parent.parent until parent.nil? || parent.is_a?(MethodContext) || parent.is_a?(BlockContext) || parent.is_a?(SingletonMethodContext)
+            parent.record_call_to(self) if parent
+          end
+
+          def record_validation
+            if ClassContext::VALIDATIONS.include?(@method) && @parent && @parent.is_a?(ClassContext) && @parent.active_record_model?
+              @parent.validations << @method
+            end
+          end
+
       end
 
     end

data/lib/simplabs/excellent/parsing/class_context.rb

@@ -11,21 +11,38 @@ module Simplabs
         include FlogMeasure
         include Scopeable
 
+        VALIDATIONS = %w(
+          validates_acceptance_of
+          validates_associated
+          validates_confirmation_of
+          validates_each
+          validates_exclusion_of
+          validates_format_of
+          validates_inclusion_of
+          validates_length_of
+          validates_numericality_of
+          validates_presence_of
+          validates_size_of
+          validates_uniqueness_of
+        )
+
         attr_reader :methods
         attr_reader :line_count
         attr_reader :base_class_name
+        attr_reader :validations
 
         def initialize(exp, parent)
           super
           @name, @full_name = get_names
-          @base_class_name = get_base_class_name
-          @methods = []
-          @line_count = count_lines
-          @attr_accessible = false
-          @attr_protected = false
+          @base_class_name  = get_base_class_name
+          @methods          = []
+          @line_count       = count_lines
+          @attr_accessible  = false
+          @attr_protected   = false
+          @validations      = []
         end
 
-        def activerecord_model?
+        def active_record_model?
           @base_class_name == 'ActiveRecord::Base'
         end
 
@@ -37,6 +54,10 @@ module Simplabs
           @attr_protected
         end
 
+        def validating?
+          !@validations.empty? || @methods.any?{ |method| %(validate validate_on_create validate_on_update).include?(method.name) }
+        end
+
         def process_call(exp)
           @attr_accessible = true if exp[2] == :attr_accessible
           @attr_protected = true if exp[2] == :attr_protected

data/lib/simplabs/excellent/parsing/code_processor.rb

@@ -97,10 +97,7 @@ module Simplabs
         end
 
         def process_call(exp)
-          if @contexts.last.is_a?(MethodContext) || @contexts.last.is_a?(BlockContext) || @contexts.last.is_a?(SingletonMethodContext)
-            @contexts.last.record_call_to(CallContext.new(exp, @contexts.last))
-          end
-          process_default(exp)
+          process_default(exp, CallContext.new(exp, @contexts.last))
         end
 
         def process_resbody(exp)

data/lib/simplabs/excellent/parsing/cvar_context.rb

@@ -14,8 +14,8 @@ module Simplabs
         def full_name
           return @name if @parent.blank?
           full_name = @name
-          parent = @parent
-          parent = parent.parent until parent.is_a?(ClassContext) || parent.is_a?(ModuleContext)
+          parent    = @parent
+          parent    = parent.parent until parent.is_a?(ClassContext) || parent.is_a?(ModuleContext)
           full_name = "#{parent.full_name}.#{full_name}"
         end
 

data/lib/simplabs/excellent/parsing/if_context.rb

@@ -11,7 +11,7 @@ module Simplabs
         def initialize(exp, parent)
           super
           @contains_assignment = has_assignment?
-          @tests_parameter = contains_parameter?
+          @tests_parameter     = contains_parameter?
         end
 
         def tests_assignment?

data/lib/simplabs/excellent/parsing/method_context.rb

@@ -37,8 +37,8 @@ module Simplabs
           "#{parent.full_name}##{@name}"
         end
 
-        def record_call_to(exp)
-          @calls[exp] += 1
+        def record_call_to(context)
+          @calls[context] += 1
         end
 
       end

data/lib/simplabs/excellent/parsing/module_context.rb

@@ -16,8 +16,8 @@ module Simplabs
         def initialize(exp, parent)
           super
           @name, @full_name = get_names
-          @methods = []
-          @line_count = count_lines
+          @methods          = []
+          @line_count       = count_lines
         end
 
       end

data/lib/simplabs/excellent/rake/excellent_task.rb

@@ -1,4 +1,5 @@
 require 'rake'
+require 'simplabs/excellent'
 
 module Simplabs
 

data/lib/simplabs/excellent/runner.rb

@@ -29,6 +29,8 @@ module Simplabs
         :FlogMethodCheck                    => { },
         :FlogBlockCheck                     => { },
         :FlogClassCheck                     => { },
+        :BlockDuplicationCheck              => { },
+        :MethodDuplicationCheck             => { },
         :'Rails::AttrProtectedCheck'        => { },
         :'Rails::AttrAccessibleCheck'       => { },
         :'Rails::InstanceVarInPartialCheck' => { }

data/lib/simplabs/excellent.rb

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

data/spec/checks/block_duplication_check_spec.rb

@@ -0,0 +1,95 @@
+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/{duplication_check_spec.rb → method_duplication_check_spec.rb}

@@ -1,9 +1,9 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe Simplabs::Excellent::Checks::DuplicationCheck do
+describe Simplabs::Excellent::Checks::MethodDuplicationCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::DuplicationCheck.new({ :threshold => 1 }))
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::MethodDuplicationCheck.new({ :threshold => 1 }))
   end
 
   describe '#evaluate' do
@@ -112,18 +112,6 @@ describe Simplabs::Excellent::Checks::DuplicationCheck do
       verify_warning_found(code, 'thing', 'Class.double_thing', 2)
     end
 
-    it 'should also work with blocks' do
-      code = <<-END
-        def method
-          double_thing do
-            thing(1) + thing(2)
-          end
-        end
-      END
-
-      verify_warning_found(code, 'thing', 'block', 2)
-    end
-
   end
 
   def verify_warning_found(code, statement, method = 'double_thing', line = 1)

data/spec/checks/rails/validations_check_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Simplabs::Excellent::Checks::Rails::ValidationsCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::Rails::ValidationsCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should ignore classes that are not active record models' do
+      code = <<-END
+        class Test
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should reject an active record model that does not validate anything' do
+      code = <<-END
+        class User < ActiveRecord::Base
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'User' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'User does not validate any attributes.'
+    end
+
+    it 'should accept an active record model that validates attributes using a macro method' do
+      code = <<-END
+        class User < ActiveRecord::Base
+          validates_presence_of :login
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    %(validate validate_on_create validate_on_update).each do |method|
+
+      it "should accept an active record model that validates attribute by overriding #{method}" do
+        code = <<-END
+          class User < ActiveRecord::Base
+            def #{method}
+            end
+          end
+        END
+        @excellent.check_code(code)
+        warnings = @excellent.warnings
+
+        warnings.should be_empty
+      end
+
+    end
+
+    it 'should also work with namespaced models' do
+      code = <<-END
+        class Backend::User < ActiveRecord::Base
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'Backend::User' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'Backend::User does not validate any attributes.'
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplabs-excellent
 version: !ruby/object:Gem::Version 
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors: 
 - Marco Otte-Witte
@@ -48,6 +48,7 @@ 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
@@ -55,7 +56,6 @@ files:
 - lib/simplabs/excellent/checks/cyclomatic_complexity_block_check.rb
 - lib/simplabs/excellent/checks/cyclomatic_complexity_check.rb
 - lib/simplabs/excellent/checks/cyclomatic_complexity_method_check.rb
-- lib/simplabs/excellent/checks/duplication_check.rb
 - lib/simplabs/excellent/checks/empty_rescue_body_check.rb
 - lib/simplabs/excellent/checks/flog_block_check.rb
 - lib/simplabs/excellent/checks/flog_check.rb
@@ -63,6 +63,7 @@ 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
@@ -73,6 +74,7 @@ files:
 - lib/simplabs/excellent/checks/rails/attr_accessible_check.rb
 - lib/simplabs/excellent/checks/rails/attr_protected_check.rb
 - lib/simplabs/excellent/checks/rails/instance_var_in_partial_check.rb
+- lib/simplabs/excellent/checks/rails/validations_check.rb
 - lib/simplabs/excellent/checks/rails.rb
 - lib/simplabs/excellent/checks/singleton_variable_check.rb
 - lib/simplabs/excellent/checks.rb
@@ -113,18 +115,19 @@ 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
 - spec/checks/control_coupling_check_spec.rb
 - spec/checks/cyclomatic_complexity_block_check_spec.rb
 - spec/checks/cyclomatic_complexity_method_check_spec.rb
-- spec/checks/duplication_check_spec.rb
 - spec/checks/empty_rescue_body_check_spec.rb
 - spec/checks/flog_block_check_spec.rb
 - 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
@@ -134,6 +137,7 @@ files:
 - spec/checks/rails/attr_accessible_check_spec.rb
 - spec/checks/rails/attr_protected_check_spec.rb
 - spec/checks/rails/instance_var_in_partial_check_spec.rb
+- spec/checks/rails/validations_check_spec.rb
 - spec/checks/singleton_variable_check_spec.rb
 - spec/extensions/string_spec.rb
 - spec/spec_helper.rb