simplabs-excellent 1.0.1 → 1.2.1

data/spec/checks/singleton_variable_check_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::SingletonVariableCheck do
+
+  before(:each) do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::SingletonVariableCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should reject singleton variables' do
+      content = <<-END
+        @@foo
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :variable => 'foo' }
+      warnings[0].line_number.should == 2
+      warnings[0].message.should     == 'Singleton variable foo used.'
+    end
+
+    it 'should also work for namespaced classes' do
+      content = <<-END
+        module Outer
+          module Inner
+            class Class
+              @@foo
+            end
+          end
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :variable => 'Outer::Inner::Class.foo' }
+      warnings[0].line_number.should == 5
+      warnings[0].message.should     == 'Singleton variable Outer::Inner::Class.foo used.'
+    end
+
+    it 'should also work for singleton variables that occur within methods' do
+      content = <<-END
+        module Outer
+          module Inner
+            class Class
+              def method
+                @@foo
+              end
+            end
+          end
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :variable => 'Outer::Inner::Class.foo' }
+      warnings[0].line_number.should == 6
+      warnings[0].message.should     == 'Singleton variable Outer::Inner::Class.foo used.'
+    end
+
+  end
+
+end

data/spec/{core/extensions/underscore_spec.rb → extensions/string_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe String do
 

metadata

@@ -1,10 +1,9 @@
 --- !ruby/object:Gem::Specification 
 name: simplabs-excellent
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.2.1
 platform: ruby
 authors: 
-- Marty Andrews
 - Marco Otte-Witte
 autorequire: 
 bindir: bin
@@ -23,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "2.0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: sexp_processor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+    version: 
 description: 
 email: marco.otte-witte@simplabs.com
 executables: 
@@ -33,7 +42,7 @@ extra_rdoc_files: []
 
 files: 
 - History.txt
-- README.markdown
+- README.rdoc
 - VERSION.yml
 - bin/excellent
 - lib/simplabs/excellent/checks/abc_metric_method_check.rb
@@ -42,12 +51,16 @@ files:
 - 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
-- lib/simplabs/excellent/checks/class_variable_check.rb
 - lib/simplabs/excellent/checks/control_coupling_check.rb
 - 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
+- lib/simplabs/excellent/checks/flog_class_check.rb
+- 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_line_count_check.rb
@@ -55,34 +68,64 @@ files:
 - lib/simplabs/excellent/checks/module_line_count_check.rb
 - lib/simplabs/excellent/checks/module_name_check.rb
 - lib/simplabs/excellent/checks/name_check.rb
+- lib/simplabs/excellent/checks/nested_iterators_check.rb
 - 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.rb
+- lib/simplabs/excellent/checks/singleton_variable_check.rb
 - lib/simplabs/excellent/checks.rb
-- lib/simplabs/excellent/core/checking_visitor.rb
-- lib/simplabs/excellent/core/error.rb
-- lib/simplabs/excellent/core/extensions/underscore.rb
-- lib/simplabs/excellent/core/iterator_visitor.rb
-- lib/simplabs/excellent/core/parse_tree_runner.rb
-- lib/simplabs/excellent/core/parser.rb
-- lib/simplabs/excellent/core/visitable_sexp.rb
-- lib/simplabs/excellent/core.rb
+- lib/simplabs/excellent/extensions/sexp.rb
+- lib/simplabs/excellent/extensions/string.rb
+- lib/simplabs/excellent/parsing/abc_measure.rb
+- lib/simplabs/excellent/parsing/block_context.rb
+- lib/simplabs/excellent/parsing/call_context.rb
+- lib/simplabs/excellent/parsing/case_context.rb
+- lib/simplabs/excellent/parsing/class_context.rb
+- lib/simplabs/excellent/parsing/code_processor.rb
+- lib/simplabs/excellent/parsing/conditional_context.rb
+- lib/simplabs/excellent/parsing/cvar_context.rb
+- lib/simplabs/excellent/parsing/cyclomatic_complexity_measure.rb
+- 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/method_context.rb
+- lib/simplabs/excellent/parsing/module_context.rb
+- lib/simplabs/excellent/parsing/parser.rb
+- lib/simplabs/excellent/parsing/resbody_context.rb
+- lib/simplabs/excellent/parsing/scopeable.rb
+- lib/simplabs/excellent/parsing/sexp_context.rb
+- lib/simplabs/excellent/parsing/singleton_method_context.rb
+- lib/simplabs/excellent/parsing/until_context.rb
+- lib/simplabs/excellent/parsing/while_context.rb
+- lib/simplabs/excellent/parsing.rb
+- lib/simplabs/excellent/runner.rb
+- lib/simplabs/excellent/warning.rb
 - lib/simplabs/excellent.rb
 - spec/checks/abc_metric_method_check_spec.rb
 - spec/checks/assignment_in_conditional_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/class_variable_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_line_count_check_spec.rb
 - spec/checks/method_name_check_spec.rb
 - spec/checks/module_line_count_check_spec.rb
 - spec/checks/module_name_check_spec.rb
+- spec/checks/nested_iterators_check_spec.rb
 - spec/checks/parameter_number_check_spec.rb
-- spec/core/extensions/underscore_spec.rb
+- spec/checks/rails/attr_accessible_check_spec.rb
+- spec/checks/rails/attr_protected_check_spec.rb
+- spec/checks/singleton_variable_check_spec.rb
+- spec/extensions/string_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/simplabs/excellent
@@ -110,6 +153,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Source code analysis gem
+summary: Source Code analysis gem for Ruby and Rails
 test_files: []
 

data/README.markdown

@@ -1,30 +0,0 @@
-simplabs-excellent
-==================
-
-Excellent is a source code analysis gem. It detects commonly regarded bad code snippets
-like empty rescue blocks etc.
-
-Installation
-------------
-
-    gem sources -a http://gems.github.com
-    sudo gem install simplabs-excellent
-
-Example
--------
-
-To analyse all the models in your Rails application, just do
-
-    excellent "app/models/**/*.rb"
-
-in your RAILS_ROOT.
-
-Acknowledgements
-----------------
-
-Excellent is based on roodi by Marty Andrews. However, it will get more functionaliy than roodi in the future.
-
-Author
-------
-
-Copyright (c) 2009 Marco Otte-Witte (http://simplabs.com), released under the MIT license

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

@@ -1,25 +0,0 @@
-require 'simplabs/excellent/checks/base'
-
-module Simplabs
-
-  module Excellent
-
-    module Checks
-
-      class ClassVariableCheck < Base
-
-        def interesting_nodes
-          [:cvar]
-        end
-
-        def evaluate(node)
-          add_error('Class variable {{variable}}.', { :variable => node.value }, -1)
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/simplabs/excellent/core.rb

@@ -1,2 +0,0 @@
-require 'simplabs/excellent/core/parse_tree_runner'
-require 'simplabs/excellent/core/extensions/underscore'

data/lib/simplabs/excellent/core/checking_visitor.rb

@@ -1,34 +0,0 @@
-module Simplabs
-
-  module Excellent
-
-    module Core
-
-      class CheckingVisitor
-
-        def initialize(*checks)
-          @checks ||= {}
-          checks.first.each do |check|
-            nodes = check.interesting_nodes
-            nodes.each do |node|
-              @checks[node] ||= []
-              @checks[node] << check
-              @checks[node].uniq!
-            end
-          end
-        end
-
-        def visit(node)
-          @last_newline = node if node.node_type == :newline
-          checks = @checks[node.node_type]
-          checks.each { |check| check.evaluate_node(node) } unless checks.nil?
-          nil
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/simplabs/excellent/core/error.rb

@@ -1,31 +0,0 @@
-module Simplabs
-
-  module Excellent
-
-    module Core
-
-      class Error
-
-        attr_reader :check, :info, :filename, :line_number, :message, :message_template
-
-        def initialize(check, message, filename, line_number, info)
-          @check       = check.to_s.underscore.to_sym
-          @info        = info
-          @filename    = filename
-          @line_number = line_number.to_i
-
-          @message = ''
-          if !message.nil?
-            @message_template = message
-            @info.each { |key, value| message.gsub!(/\{\{#{key}\}\}/, value.to_s) }
-            @message = message
-          end
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/simplabs/excellent/core/extensions/underscore.rb

@@ -1,27 +0,0 @@
-module Simplabs
-
-  module Excellent
-
-    module Core
-
-      module Extensions
-
-        ::String.class_eval do
-
-          def underscore
-            to_s.gsub(/::/, '/').
-              gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-              gsub(/([a-z\d])([A-Z])/,'\1_\2').
-              tr("-", "_").
-              downcase
-          end
-
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/simplabs/excellent/core/iterator_visitor.rb

@@ -1,29 +0,0 @@
-module Simplabs
-
-  module Excellent
-
-    module Core
-
-      class IteratorVisitor
-
-    	  def initialize(payload)
-      	  @payload = payload
-    	  end
-	
-    	  def visit(visited)
-    		  visited.accept(@payload)
-    		  visitable_nodes = visited.is_language_node? ? visited.sexp_body : visited
-    		  visitable_nodes.each do |child|
-    		    if child.is_a?(Sexp) then
-      		    child.accept(self)
-    		    end
-  		    end
-    	  end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/simplabs/excellent/core/parse_tree_runner.rb

@@ -1,88 +0,0 @@
-require 'pp'
-require 'yaml'
-
-require 'simplabs/excellent/core/checking_visitor'
-require 'simplabs/excellent/core/iterator_visitor'
-require 'simplabs/excellent/core/parser'
-require 'simplabs/excellent/core/visitable_sexp'
-
-module Simplabs
-
-  module Excellent
-
-    module Core
-
-      class ParseTreeRunner
-
-        DEFAULT_CONFIG = {
-          :AssignmentInConditionalCheck    => { },
-          :CaseMissingElseCheck            => { },
-          :ClassLineCountCheck             => { :threshold      => 300 },
-          :ClassNameCheck                  => { :pattern         => /^[A-Z][a-zA-Z0-9]*$/ },
-          :ClassVariableCheck              => { },
-          :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 }
-        }
-      
-        attr_writer :config
-      
-        def initialize(*checks)
-          @config = DEFAULT_CONFIG
-          @checks = checks unless checks.empty?
-          @parser = Parser.new
-        end
-      
-        def check(filename, content)
-          @checks ||= load_checks
-          node = parse(filename, content)
-          node.accept(IteratorVisitor.new(CheckingVisitor.new(@checks))) if node
-        end
-
-        def check_content(content)
-          check("dummy-file.rb", content)
-        end
-  
-        def check_file(filename)
-          check(filename, File.read(filename))
-        end
-  
-        def errors
-          @checks ||= []
-          all_errors = @checks.collect {|check| check.errors}
-          all_errors.flatten
-        end
-      
-        private
-      
-          def parse(filename, content)
-            begin
-              @parser.parse(content, filename)
-            rescue Exception => e
-              puts "#{filename} looks like it's not a valid Ruby file. Skipping..." if ENV["ROODI_DEBUG"]
-              nil
-            end
-          end
-        
-          def load_checks
-            check_objects = []
-            DEFAULT_CONFIG.each_pair do |key, value| 
-              klass = eval("Simplabs::Excellent::Checks::#{key.to_s}")
-              check_objects << (value.empty? ? klass.new : klass.new(value))
-            end
-            check_objects
-          end
-
-      end
-
-    end
-
-  end
-
-end