simplabs-excellent 1.3.1 → 1.4.0

data/History.txt

@@ -1,3 +1,8 @@
+= 1.4.0
+
+* Excellent not parses *.erb files
+* added new check InstanceVarInPartialCheck
+
 = 1.3.1
 
 * FIX (forgot files in gemspec on 1.3.0)

data/VERSION.yml

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

data/lib/simplabs/excellent.rb

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

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

@@ -23,6 +23,7 @@ module Simplabs
         def initialize(options = {}) #:nodoc:
           super()
           @interesting_nodes = [:if, :while, :until]
+          @interesting_files = [/\.rb$/, /\.erb$/]
         end
 
         def evaluate(context) #:nodoc:

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

@@ -16,8 +16,15 @@ module Simplabs
         # e.g. <tt>:if</tt> or <tt>:defn</tt>
         attr_reader :interesting_nodes
 
+        # An array of regular expressions for file names that are interesting for the check. These will usually be path extensions rather than longer
+        # patterns (e.g. *.rb as well as *.erb files or *.rb files only).
+        #
+        # Defaults to /\.rb$/. If you do not specify anything else in custom checks, only *.rb files will be processed
+        attr_reader :interesting_files
+
         def initialize #:nodoc:
-          @warnings = []
+          @warnings          = []
+          @interesting_files = [/\.rb$/]
         end
 
         # This method is called whenever Excellent processes a node that the check specified as one of the nodes it is interested in (see interesting_nodes).

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

@@ -18,6 +18,7 @@ module Simplabs
         def initialize #:nodoc:
           super
           @interesting_nodes = [:case]
+          @interesting_files = [/\.rb$/, /\.erb$/]
         end
 
         def evaluate(context) #:nodoc:

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

@@ -26,6 +26,7 @@ module Simplabs
         def initialize #:nodoc:
           super
           @interesting_nodes = [:for]
+          @interesting_files = [/\.rb$/, /\.erb$/]
         end
 
         def evaluate(context) #:nodoc:

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

@@ -16,6 +16,7 @@ module Simplabs
         def initialize #:nodoc:
           super
           @interesting_nodes = [:iter]
+          @interesting_files = [/\.rb$/, /\.erb$/]
         end
 
         def evaluate(context) #:nodoc:

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

@@ -15,3 +15,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'

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

@@ -0,0 +1,37 @@
+require 'simplabs/excellent/checks/base'
+
+module Simplabs
+
+  module Excellent
+
+    module Checks
+
+      module Rails
+
+        # This check reports partials that use instance variables. Using instance variables in partials couples the partial to the controller action or
+        # template that includes the partial and that has to define the instance variable.
+        #
+        # ==== Applies to
+        #
+        # * instance variables
+        class InstanceVarInPartialCheck < Base
+
+          def initialize #:nodoc:
+            super
+            @interesting_nodes = [:ivar]
+            @interesting_files = [/^_.*\.erb$/]
+          end
+
+          def evaluate(context) #:nodoc:
+            add_warning(context, 'Instance variable {{variable}} used in partial.', { :variable => context.full_name })
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -17,6 +17,7 @@ module Simplabs
         def initialize #:nodoc:
           super
           @interesting_nodes = [:cvar]
+          @interesting_files = [/\.rb$/, /\.erb$/]
         end
 
         def evaluate(context) #:nodoc:

data/lib/simplabs/excellent/formatters/html.rb

@@ -91,6 +91,24 @@ module Simplabs
           				text-align: right;
           				display: inline-block;
           			}
+
+                #footer {
+                  margin: 20px 0 20px 0;
+                  padding: 5px;
+                  text-align: center;
+                }
+
+                #footer a {
+                  color: #000;
+                  background-color: #ddd;
+                  text-decoration: none;
+                  padding: 0 2px 0 2px;
+                }
+
+                #footer a:active, #footer a:hover {
+                  color: #fff;
+                  background-color: #222;
+                }
             	</style>
           	</head>
           	<body>
@@ -119,6 +137,9 @@ module Simplabs
 
         FOOTER_TEMPLATE = <<-END
               </div>
+              <div id="footer">
+                <a href="http://github.com/simplabs/excellent" title="Excellent at github">Excellent</a> by <a href="http://simplabs.com" title="simplabs">simplabs</a>
+              </div>
       	    </body>
           </html>
         END

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

@@ -11,6 +11,7 @@ require 'simplabs/excellent/parsing/for_loop_context'
 require 'simplabs/excellent/parsing/while_context'
 require 'simplabs/excellent/parsing/until_context'
 require 'simplabs/excellent/parsing/cvar_context'
+require 'simplabs/excellent/parsing/ivar_context'
 require 'simplabs/excellent/parsing/resbody_context'
 require 'simplabs/excellent/parsing/call_context'
 
@@ -53,6 +54,10 @@ module Simplabs
           process_default(exp, SingletonMethodContext.new(exp, @contexts.last))
         end
 
+        def process_ivar(exp)
+          process_default(exp, IvarContext.new(exp, @contexts.last))
+        end
+
         def process_cvar(exp)
           process_default(exp, CvarContext.new(exp, @contexts.last))
         end
@@ -118,8 +123,8 @@ module Simplabs
 
           def apply_checks(exp)
             if exp.is_a?(Sexp)
-              checks = @checks[exp.node_type]
-              checks.each { |check| check.evaluate_node(@contexts.last) } unless checks.nil?
+              checks = @checks[exp.node_type] || []
+              checks.each { |check| check.evaluate_node(@contexts.last) if check.interesting_files.any? { |pattern| File.basename(exp.file) =~ pattern } }
             end
           end
 

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

@@ -0,0 +1,32 @@
+module Simplabs
+
+  module Excellent
+
+    module Parsing
+
+      class IvarContext < SexpContext #:nodoc:
+
+        def initialize(exp, parent)
+          super
+          @name = exp[1].to_s.sub(/^@+/, '')
+        end
+
+        def full_name
+          return @name if @parent.nil?
+          full_name = @name
+          parent = @parent
+          parent = parent.parent until parent.is_a?(ClassContext) || parent.is_a?(ModuleContext) || parent.nil?
+          if parent
+            full_name = "#{parent.full_name}.#{full_name}"
+          else
+            @name
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'ruby_parser'
 require 'facets'
+require 'erb'
 
 module Simplabs
 
@@ -22,6 +23,7 @@ module Simplabs
 
           def silent_parse(content, filename)
             @parser ||= RubyParser.new
+            content = ::ERB.new(content, nil, '-').src if filename =~ /\.erb$/
             sexp = @parser.parse(content, filename)
             sexp
           end

data/lib/simplabs/excellent/runner.rb

@@ -12,25 +12,26 @@ module Simplabs
     class Runner
 
       DEFAULT_CONFIG = {
-        :AssignmentInConditionalCheck    => { },
-        :CaseMissingElseCheck            => { },
-        :ClassLineCountCheck             => { :threshold      => 300 },
-        :ClassNameCheck                  => { :pattern         => /^[A-Z][a-zA-Z0-9]*$/ },
-        :SingletonVariableCheck          => { },
-        :CyclomaticComplexityBlockCheck  => { :complexity      => 4 },
-        :CyclomaticComplexityMethodCheck => { :complexity      => 8 },
-        :EmptyRescueBodyCheck            => { },
-        :ForLoopCheck                    => { },
-        :MethodLineCountCheck            => { :line_count      => 20 },
-        :MethodNameCheck                 => { :pattern         => /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ },
-        :ModuleLineCountCheck            => { :line_count      => 300 },
-        :ModuleNameCheck                 => { :pattern         => /^[A-Z][a-zA-Z0-9]*$/ },
-        :ParameterNumberCheck            => { :parameter_count => 3 },
-        :FlogMethodCheck                 => { },
-        :FlogBlockCheck                  => { },
-        :FlogClassCheck                  => { },
-        :'Rails::AttrProtectedCheck'     => { },
-        :'Rails::AttrAccessibleCheck'    => { }
+        :AssignmentInConditionalCheck       => { },
+        :CaseMissingElseCheck               => { },
+        :ClassLineCountCheck                => { :threshold      => 300 },
+        :ClassNameCheck                     => { :pattern         => /^[A-Z][a-zA-Z0-9]*$/ },
+        :SingletonVariableCheck             => { },
+        :CyclomaticComplexityBlockCheck     => { :complexity      => 4 },
+        :CyclomaticComplexityMethodCheck    => { :complexity      => 8 },
+        :EmptyRescueBodyCheck               => { },
+        :ForLoopCheck                       => { },
+        :MethodLineCountCheck               => { :line_count      => 20 },
+        :MethodNameCheck                    => { :pattern         => /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ },
+        :ModuleLineCountCheck               => { :line_count      => 300 },
+        :ModuleNameCheck                    => { :pattern         => /^[A-Z][a-zA-Z0-9]*$/ },
+        :ParameterNumberCheck               => { :parameter_count => 3 },
+        :FlogMethodCheck                    => { },
+        :FlogBlockCheck                     => { },
+        :FlogClassCheck                     => { },
+        :'Rails::AttrProtectedCheck'        => { },
+        :'Rails::AttrAccessibleCheck'       => { },
+        :'Rails::InstanceVarInPartialCheck' => { }
       }
 
       attr_accessor :config #:nodoc:
@@ -119,7 +120,7 @@ module Simplabs
             if File.file?(path)
               files << path
             elsif File.directory?(path)
-              files += Dir.glob(File.join(path, '**/*.rb'))
+              files += Dir.glob(File.join(path, '**/*.{rb,erb}'))
             else
               raise ArgumentError.new("#{path} is neither a File nor a directory!")
             end

data/spec/checks/rails/instance_var_in_partial_check_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Simplabs::Excellent::Checks::Rails::InstanceVarInPartialCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::Rails::InstanceVarInPartialCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept partials that do not use instance variables' do
+      code = <<-END
+        <div>
+          <%= 'some text' %>
+        </div>
+      END
+      @excellent.check('_dummy-file.html.erb', code)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should reject partials that use instance variables' do
+      code = <<-END
+        <div>
+          <%= @ivar %>
+        </div>
+      END
+      @excellent.check('_dummy-file.html.erb', code)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :variable => 'ivar' }
+      warnings[0].line_number.should == 2
+      warnings[0].message.should     == 'Instance variable ivar used in partial.'
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplabs-excellent
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors: 
 - Marco Otte-Witte
@@ -72,6 +72,7 @@ files:
 - lib/simplabs/excellent/checks/parameter_number_check.rb
 - 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.rb
 - lib/simplabs/excellent/checks/singleton_variable_check.rb
 - lib/simplabs/excellent/checks.rb
@@ -94,6 +95,7 @@ files:
 - lib/simplabs/excellent/parsing/flog_measure.rb
 - lib/simplabs/excellent/parsing/for_loop_context.rb
 - lib/simplabs/excellent/parsing/if_context.rb
+- lib/simplabs/excellent/parsing/ivar_context.rb
 - lib/simplabs/excellent/parsing/method_context.rb
 - lib/simplabs/excellent/parsing/module_context.rb
 - lib/simplabs/excellent/parsing/parser.rb
@@ -129,6 +131,7 @@ files:
 - spec/checks/parameter_number_check_spec.rb
 - 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/singleton_variable_check_spec.rb
 - spec/extensions/string_spec.rb
 - spec/spec_helper.rb