excellent 1.7.2 → 2.0.0

data/lib/simplabs/excellent/warning.rb

@@ -1,5 +1,3 @@
-require 'simplabs/excellent/extensions/string'
-
 module Simplabs
 
   module Excellent
@@ -32,8 +30,7 @@ module Simplabs
       # The template used to produce the warning (see above)
       attr_reader :message_template
 
-      def initialize(check, message, filename, line_number, info) #:nodoc:
-        @check       = check.to_s.underscore.to_sym
+      def initialize(message, filename, line_number, info) #:nodoc:
         @info        = info
         @filename    = filename
         @line_number = line_number.to_i

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excellent
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2009-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70322483230640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
+  version_requirements: *70322483230640
 - !ruby/object:Gem::Dependency
   name: sexp_processor
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70322483229880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,22 +32,30 @@ dependencies:
         version: '4.0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *70322483229880
+- !ruby/object:Gem::Dependency
+  name: hashr
+  requirement: &70322483228960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '4.0'
-description: 
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *70322483228960
+description: Excellent finds the nasty lines in your code. It implements a comprehensive
+  set of checks for possibly buggy parts of your app that would otherwise make it
+  into your repo and eventually to the production server.
 email: marco.otte-witte@simplabs.com
 executables:
 - excellent
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
 - History.txt
-- README.rdoc
-- VERSION.yml
 - bin/excellent
 - lib/simplabs/excellent/checks/abc_metric_method_check.rb
 - lib/simplabs/excellent/checks/assignment_in_conditional_check.rb
@@ -60,6 +63,7 @@ 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
@@ -87,10 +91,8 @@ files:
 - lib/simplabs/excellent/checks/rails/session_hash_in_view_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
 - lib/simplabs/excellent/extensions/sexp.rb
-- lib/simplabs/excellent/extensions/string.rb
 - lib/simplabs/excellent/formatters/base.rb
 - lib/simplabs/excellent/formatters/html.rb
 - lib/simplabs/excellent/formatters/text.rb
@@ -107,10 +109,11 @@ files:
 - 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/gvar_context.rb
 - lib/simplabs/excellent/parsing/gasgn_context.rb
+- lib/simplabs/excellent/parsing/gvar_context.rb
 - lib/simplabs/excellent/parsing/if_context.rb
 - lib/simplabs/excellent/parsing/ivar_context.rb
+- lib/simplabs/excellent/parsing/loc_parser.rb
 - lib/simplabs/excellent/parsing/method_context.rb
 - lib/simplabs/excellent/parsing/module_context.rb
 - lib/simplabs/excellent/parsing/parser.rb
@@ -126,38 +129,9 @@ files:
 - 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/control_coupling_check_spec.rb
-- spec/checks/cyclomatic_complexity_block_check_spec.rb
-- spec/checks/cyclomatic_complexity_method_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/global_variable_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/checks/rails/attr_accessible_check_spec.rb
-- spec/checks/rails/attr_protected_check_spec.rb
-- spec/checks/rails/custom_initialize_method_check_spec.rb
-- spec/checks/rails/instance_var_in_partial_check_spec.rb
-- spec/checks/rails/params_hash_in_view_check_spec.rb
-- spec/checks/rails/session_hash_in_view_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
 homepage: http://github.com/simplabs/excellent
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options:
 - --inline-source
@@ -178,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 2
 summary: Source Code analysis gem for Ruby and Rails

data/README.rdoc

@@ -1,72 +0,0 @@
-= Excellent
-
-Excellent *finds the nasty lines in your code*. It implements a comprehensive set of checks for possibly buggy parts of your app that would *otherwise make it into your repo and eventually to the production server*.
-
-See the API documentation at http://docs.github.com/simplabs/excellent and the WIKI at http://wiki.github.com/simplabs/excellent.
-Join the Google Group and discuss about the future and possibilities of Excellent: http://groups.google.com/group/excellent-gem.
-
-Excellent also has a CI server set up at http://ci.simplabs.com/excellent.
-
-== Installation
-
-Simply install with Ruby Gems:
-
-  gem sources -a http://gems.github.com
-  sudo gem install simplabs-excellent
-
-== Example
-
-Assume you have the following class definition,
-
-  class ShoppingBasket < ActiveRecord::Base
-
-    def initialize(items = [])
-      self.items = items
-    end
-
-  end
-
-then Excellent will report the problems in this piece of code:
-
-  $ excellent shopping_basket.rb 
-
-    Excellent result:
-
-    test.rb
-      * Line   1: ShoppingBasket does not validate any attributes.
-      * Line   1: ShoppingBasket defines initialize method.
-      * Line   1: ShoppingBasket does not specify attr_accessible.
-
-    Found 3 warnings.
-
-To analyse all the models in your Rails application, just do
-
-  excellent app/models
-
-in your <tt>RAILS_ROOT</tt>. You can also invoke analysation through the Simplabs::Excellent::Runner class. Excellent can also produce HTML output. To
-get a formatted HTML report, just specify <tt>html:<filename></tt>:
-
-  excellent -o 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.
-
-== Contribute
-
-If you want to contribute, just fork the repo. Also I would appretiate suggestions for more checks (especially Rails specific checks) - simply open a new issue: http://github.com/simplabs/excellent/issues.
-
-== Author
-
-Copyright (c) 2008-2010 Marco Otte-Witte (http://simplabs.com), released under the MIT license.
-
-Excellent was inspired by roodi (http://github.com/martinjandrews/roodi), reek (http://github.com/kevinrutherford/reek) and flog (http://github.com/seattlerb/flog).

data/VERSION.yml

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

data/lib/simplabs/excellent/extensions/string.rb

@@ -1,28 +0,0 @@
-module Simplabs
-
-  module Excellent
-
-    module Extensions #:nodoc:
-
-      ::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
-
-        def lpad(to, with = ' ')
-          return self if self.length >= to
-          "#{with * (to - self.length)}#{self}"
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/spec/checks/abc_metric_method_check_spec.rb

@@ -1,122 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe Simplabs::Excellent::Checks::AbcMetricMethodCheck do
-
-  before do
-    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::AbcMetricMethodCheck.new({ :threshold => 0 }))
-  end
-
-  describe '#evaluate' do
-
-    describe 'when processing assignments' do
-
-      it "should find =" do
-        code = <<-END
-          def method_name
-            foo = 1
-          end
-        END
-
-        verify_code_score(code, 1, 0, 0)
-      end
-
-      ['*=', '/=', '%=', '+=', '<<=', '>>=', '&=', '|=', '^=', '-=', '**='].each do |assignment|
-
-        it "should find #{assignment}" do
-          code = <<-END
-            def method_name
-              foo #{assignment} 1
-            end
-          END
-
-          # these special assignments have score 2 since before the value is assigned, a method is called on the old value
-          verify_code_score(code, 1, 0, 1)
-        end
-
-      end
-
-    end
-
-    describe 'when processing branches' do
-
-      it 'should find a virtual method call' do
-        code = <<-END
-          def method_name
-            call_foo
-          end
-        END
-
-        verify_code_score(code, 0, 1, 0)
-      end
-
-      it 'should find an explicit method call' do
-        code = <<-END
-          def method_name
-            @object.call_foo
-          end
-        END
-
-        verify_code_score(code, 0, 1, 0)
-      end
-
-      it 'should exclude a condition' do
-        code = <<-END
-          def method_name
-            @object.call_foo < 10
-          end
-        END
-
-        verify_code_score(code, 0, 1, 1)
-      end
-
-    end
-
-    describe 'when processing conditions' do
-
-      ['==', '!=', '<=', '>=', '<', '>', '<=>', '=~'].each do |conditional|
-
-        it "should find #{conditional}" do
-          code = <<-END
-            def method_name
-              @foo #{conditional} @bar
-            end
-          END
-
-          verify_code_score(code, 0, 0, 1)
-        end
-
-      end 
-
-    end
-
-    it 'should also work on singleton methods' do
-      code = <<-END
-        class Class
-          def self.method_name
-            foo = 1
-          end
-        end
-      END
-      @excellent.check_code(code)
-      warnings = @excellent.warnings
-
-      warnings.should_not be_empty
-      warnings[0].info.should        == { :method => 'Class.method_name', :score => 1.0 }
-      warnings[0].line_number.should == 2
-      warnings[0].message.should     == 'Class.method_name has abc score of 1.0.'
-    end
-
-  end
-
-  def verify_code_score(code, a, b, c)
-    score = Math.sqrt(a*a + b*b + c*c)
-    @excellent.check_code(code)
-    warnings = @excellent.warnings
-
-    warnings.should_not be_empty
-    warnings[0].info.should        == { :method => 'method_name', :score => score }
-    warnings[0].line_number.should == 1
-    warnings[0].message.should     == "method_name has abc score of #{score}."
-  end
-
-end

data/spec/checks/assignment_in_conditional_check_spec.rb

@@ -1,90 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe Simplabs::Excellent::Checks::AssignmentInConditionalCheck do
-
-  before do
-    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::AssignmentInConditionalCheck.new)
-  end
-
-  describe '#evaluate' do
-
-    it 'should accept an assignment before an if clause' do
-      code = <<-END
-        count = count += 1 if @some_condition
-      END
-      @excellent.check_code(code)
-
-      @excellent.warnings.should be_empty
-    end
-
-    it 'should accept block parameters in an if clause' do
-      code = <<-END
-        return true if exp.children.any? { |child| contains_statements?(child) }
-      END
-      @excellent.check_code(code)
-
-      @excellent.warnings.should be_empty
-    end
-
-    it 'should reject assignments of results of blocks in an if clause' do
-      code = <<-END
-        return true if value = exp.children.find { |child| contains_statements?(child) }
-      END
-
-      verify_warning_found(code)
-    end
-
-    it 'should reject an assignment inside an if clause' do
-      code = <<-END
-        call_foo if bar = bam
-      END
-
-      verify_warning_found(code)
-    end
-
-    it 'should reject an assignment inside an unless clause' do
-      code = <<-END
-        call_foo unless bar = bam
-      END
-
-      verify_warning_found(code)
-    end
-
-    it 'should reject an assignment inside a while clause' do
-      code = <<-END
-        call_foo while bar = bam
-      END
-
-      verify_warning_found(code)
-    end
-
-    it 'should reject an assignment inside an until clause' do
-      code = <<-END
-        call_foo until bar = bam
-      END
-
-      verify_warning_found(code)
-    end
-
-    it 'should reject an assignment inside a ternary operator check clause' do
-      code = <<-END
-        call_foo (bar = bam) ? baz : bad
-      END
-
-      #RubyParser sets line number 2 here
-      verify_warning_found(code, 2)
-    end
-
-  end
-
-  def verify_warning_found(code, line_number = nil)
-    @excellent.check_code(code)
-    warnings = @excellent.warnings
-
-    warnings.should_not be_empty
-    warnings[0].info.should        == {}
-    warnings[0].line_number.should == (line_number || 1)
-    warnings[0].message.should     == 'Assignment in condition.'
-  end
-
-end