excellent 1.7.2 → 2.0.0

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

@@ -29,8 +29,8 @@ module Simplabs
         DEFAULT_THRESHOLD = 8
 
         def initialize(options = {}) #:nodoc:
-          threshold = options[:threshold] || DEFAULT_THRESHOLD
-          super([Parsing::MethodContext, Parsing::SingletonMethodContext], threshold)
+          options[:threshold] ||= DEFAULT_THRESHOLD
+          super([Parsing::MethodContext, Parsing::SingletonMethodContext], options)
         end
 
         def evaluate(context) #:nodoc:

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

@@ -13,7 +13,7 @@ module Simplabs
       # * +rescue+ blocks
       class EmptyRescueBodyCheck < Base
 
-        def initialize #:nodoc:
+        def initialize(options = {}) #:nodoc:
           super
           @interesting_contexts = [Parsing::ResbodyContext]
         end

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

@@ -21,8 +21,8 @@ module Simplabs
         DEFAULT_THRESHOLD = 15
 
         def initialize(options = {}) #:nodoc:
-          threshold = options[:threshold] || DEFAULT_THRESHOLD
-          super([Parsing::BlockContext], threshold)
+          options[:threshold] ||= DEFAULT_THRESHOLD
+          super([Parsing::BlockContext], options)
         end
 
         protected

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

@@ -8,10 +8,10 @@ module Simplabs
 
       class FlogCheck < Base #:nodoc:
 
-        def initialize(interesting_contexts, threshold)
-          super()
+        def initialize(interesting_contexts, options = {}) #:nodoc:
+          super(options)
           @interesting_contexts = interesting_contexts
-          @threshold            = threshold
+          @threshold            = options[:threshold].to_i
         end
 
         def evaluate(context)

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

@@ -21,8 +21,8 @@ module Simplabs
         DEFAULT_THRESHOLD = 300
 
         def initialize(options = {}) #:nodoc:
-          threshold = options[:threshold] || DEFAULT_THRESHOLD
-          super([Parsing::ClassContext], threshold)
+          options[:threshold] ||= DEFAULT_THRESHOLD
+          super([Parsing::ClassContext], options)
         end
 
         protected

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

@@ -21,8 +21,8 @@ module Simplabs
         DEFAULT_THRESHOLD = 30
 
         def initialize(options = {}) #:nodoc:
-          threshold = options[:threshold] || DEFAULT_THRESHOLD
-          super([Parsing::MethodContext, Parsing::SingletonMethodContext], threshold)
+          options[:threshold] ||= DEFAULT_THRESHOLD
+          super([Parsing::MethodContext, Parsing::SingletonMethodContext], options)
         end
 
         protected

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

@@ -23,7 +23,7 @@ module Simplabs
       # * +for+ loops
       class ForLoopCheck < Base
 
-        def initialize #:nodoc:
+        def initialize(options = {}) #:nodoc:(options => {}) #:nodoc:
           super
           @interesting_contexts = [Parsing::ForLoopContext]
           @interesting_files    = [/\.rb$/, /\.erb$/]

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

@@ -14,14 +14,17 @@ module Simplabs
       # * global variables
       class GlobalVariableCheck < Base
 
-        def initialize #:nodoc:
+        DEFAULT_WHITELIST = %w(! @ & ` ' + \d+ ~ = / \ , ; \. < > _ 0 * $ ? : " DEBUG FILENAME LOAD_PATH stdin stdout stderr VERBOSE -0 -a -d -F -i -I -l -p -v)
+
+        def initialize(options = {}) #:nodoc:
           super
+          @whitelist            = options[:whitelist] ||= DEFAULT_WHITELIST
           @interesting_contexts = [Parsing::GvarContext, Parsing::GasgnContext]
           @interesting_files    = [/\.rb$/, /\.erb$/]
         end
 
         def evaluate(context) #:nodoc:
-          if context.is_a?(Parsing::GasgnContext) || !context.reassigned_local_exception_var?
+          if context.is_a?(Parsing::GasgnContext) || !@whitelist.include?(context.full_name)
             add_warning(context, 'Global variable {{variable}} used.', { :variable => context.full_name })
           end
         end

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

@@ -8,10 +8,10 @@ module Simplabs
 
       class LineCountCheck < Base #:nodoc:
 
-        def initialize(interesting_contexts, threshold)
-          super()
+        def initialize(interesting_contexts, options = {}) #:nodoc:
+          super(options)
           @interesting_contexts = interesting_contexts
-          @threshold            = threshold
+          @threshold            = options[:threshold].to_i
         end
 
         def evaluate(context)

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

@@ -17,8 +17,8 @@ module Simplabs
         DEFAULT_THRESHOLD = 20
 
         def initialize(options = {}) #:nodoc:
-          threshold = options[:threshold] || DEFAULT_THRESHOLD
-          super([Parsing::MethodContext], threshold)
+          options[:threshold] ||= DEFAULT_THRESHOLD
+          super([Parsing::MethodContext], options)
         end
 
         protected

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

@@ -16,12 +16,13 @@ module Simplabs
       # * methods
       class MethodNameCheck < NameCheck
 
-        DEFAULT_PATTERN = /^[_a-z<>=\[|+-\/\*\~\%\&`\|\^]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
-        WHITELIST       = %w([] ! !=  !~ % & * ** + +@ - -@ / < << <= <=> == === =~ > >= >> ^ ` | ~)
+        DEFAULT_PATTERN   = '^[_a-z<>=\[|+-\/\*\~\%\&`\|\^]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$'
+        DEFAULT_WHITELIST = %w([] ! !=  !~ % & * ** + +@ - -@ / < << <= <=> == === =~ > >= >> ^ ` | ~)
 
         def initialize(options = {}) #:nodoc:
-          pattern = options['pattern'] || DEFAULT_PATTERN
-          super([Parsing::MethodContext, Parsing::SingletonMethodContext], pattern, WHITELIST)
+          options[:pattern]   ||= DEFAULT_PATTERN
+          options[:whitelist] ||= DEFAULT_WHITELIST
+          super([Parsing::MethodContext, Parsing::SingletonMethodContext], options)
         end
 
         protected

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

@@ -17,8 +17,8 @@ module Simplabs
         DEFAULT_THRESHOLD = 300
 
         def initialize(options = {}) #:nodoc:
-          threshold = options[:threshold] || DEFAULT_THRESHOLD
-          super([Parsing::ModuleContext], threshold)
+          options[:threshold] ||= DEFAULT_THRESHOLD
+          super([Parsing::ModuleContext], options)
         end
 
         protected

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

@@ -16,11 +16,11 @@ module Simplabs
       # * modules
       class ModuleNameCheck < NameCheck
 
-        DEFAULT_PATTERN = /^[A-Z][a-zA-Z0-9]*$/
+        DEFAULT_PATTERN = '^[A-Z][a-zA-Z0-9]*$'
 
         def initialize(options = {}) #:nodoc:
-          pattern = options['pattern'] || DEFAULT_PATTERN
-          super([Parsing::ModuleContext], pattern)
+          options[:pattern] ||= DEFAULT_PATTERN
+          super([Parsing::ModuleContext], options)
         end
 
         protected

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

@@ -8,11 +8,11 @@ module Simplabs
 
       class NameCheck < Base #:nodoc:
 
-        def initialize(interesting_contexts, pattern, whitelist = [])
-          super()
+        def initialize(interesting_contexts, options = {}) #:nodoc:
+          super(options)
           @interesting_contexts = interesting_contexts
-          @pattern              = pattern
-          @whitelist            = whitelist
+          @pattern              = Regexp.new(options[:pattern].to_s)
+          @whitelist            = Array(options[:whitelist])
         end
 
         def evaluate(context)

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

@@ -6,14 +6,14 @@ module Simplabs
 
     module Checks
 
-      # This check reports nested iterators. Nested iterators lead to introduce performance issues.
+      # This check reports nested iterators. Nested iterators may introduce performance issues.
       #
       # ==== Applies to
       #
       # * blocks
       class NestedIteratorsCheck < Base
 
-        def initialize #:nodoc:
+        def initialize(options = {}) #:nodoc:
           super
           @interesting_contexts = [Parsing::BlockContext]
           @interesting_files    = [/\.rb$/, /\.erb$/]

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

@@ -18,7 +18,7 @@ module Simplabs
         DEFAULT_THRESHOLD = 3
 
         def initialize(options = {}) #:nodoc:
-          super()
+          super
           @threshold            = options[:threshold] || DEFAULT_THRESHOLD
           @interesting_contexts = [Parsing::MethodContext, Parsing::SingletonMethodContext, Parsing::BlockContext]
         end

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

@@ -18,7 +18,7 @@ module Simplabs
         # * +ActiveRecord+ models
         class AttrAccessibleCheck < Base
 
-          def initialize #:nodoc:
+          def initialize(options = {}) #:nodoc:
             super
             @interesting_contexts = [Parsing::ClassContext]
           end

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

@@ -19,7 +19,7 @@ module Simplabs
         # * +ActiveRecord+ models
         class AttrProtectedCheck < Base
 
-          def initialize #:nodoc:
+          def initialize(options = {}) #:nodoc:
             super
             @interesting_contexts = [Parsing::ClassContext]
           end

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

@@ -17,7 +17,7 @@ module Simplabs
         # * +ActiveRecord+ models
         class CustomInitializeMethodCheck < Base
 
-          def initialize #:nodoc:
+          def initialize(options = {}) #:nodoc:
             super
             @interesting_contexts = [Parsing::ClassContext]
           end

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

@@ -16,7 +16,7 @@ module Simplabs
         # * partials
         class InstanceVarInPartialCheck < Base
 
-          def initialize #:nodoc:
+          def initialize(options = {}) #:nodoc:
             super
             @interesting_contexts = [Parsing::IvarContext]
             @interesting_files = [/^_.*\.erb$/]

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

@@ -17,7 +17,7 @@ module Simplabs
         # * partials and regular views
         class ParamsHashInViewCheck < Base
 
-          def initialize #:nodoc:
+          def initialize(options = {}) #:nodoc:
             super
             @interesting_contexts = [Parsing::CallContext]
             @interesting_files    = [/^.*\.(erb|rhtml)$/]

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

@@ -17,7 +17,7 @@ module Simplabs
         # * partials and regular views
         class SessionHashInViewCheck < Base
 
-          def initialize #:nodoc:
+          def initialize(options = {}) #:nodoc:
             super
             @interesting_contexts = [Parsing::CallContext]
             @interesting_files = [/^.*\.(erb|rhtml|haml)$/]

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

@@ -16,7 +16,7 @@ module Simplabs
         # * +ActiveRecord+ models
         class ValidationsCheck < Base
 
-          def initialize #:nodoc:
+          def initialize(options = {}) #:nodoc:
             super
             @interesting_contexts = [Parsing::ClassContext]
           end

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

@@ -23,7 +23,7 @@ module Simplabs
         end
 
         def warning(warning)
-          @stream.puts "    * Line #{warning.line_number.to_s.lpad(3)}: \e[33m#{warning.message}\e[0m"
+          @stream.puts "    * Line #{lpad(warning.line_number.to_s, 3)}: \e[33m#{warning.message}\e[0m"
           @total_warnings += 1
         end
 
@@ -31,6 +31,12 @@ module Simplabs
           @stream.puts "\n  Found #{@total_warnings} warnings.\n\n"
         end
 
+        private
+
+          def lpad(string, length, fill = ' ')
+            [fill * ([length - string.length, 0].max), string].join
+          end
+
       end
 
     end

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

@@ -12,14 +12,6 @@ module Simplabs
           @full_name = @name
         end
 
-        def reassigned_local_exception_var?
-          if self.parent.is_a?(Simplabs::Excellent::Parsing::ResbodyContext)
-            @name == '!' && self.parent.assigns_exception_to_local_variable?.inspect
-          else
-            false
-          end
-        end
-
       end
 
     end

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

@@ -0,0 +1,94 @@
+module Simplabs
+
+  module Excellent
+
+    module Parsing
+
+      # Parser that counts the different types of lines for the given set of files.
+      #
+      class LOCParser
+
+        # The files to count the lines for
+        #
+        attr_accessor :files
+
+        def initialize(files) #:nodoc:
+          @files  = collect_files(files)
+        end
+
+        # Returns a hash with file name as key and a hash of counts as value.
+        #
+        #  { file => { :total => 9, :code => 3, ... }, ... }
+        #
+        # ==== Parameters
+        #
+        # * <tt>force</tt> - The count is cached once it was calculated. Specify +force+ to force recalculation.
+        def count(force = false)
+          @count = recount if @count.nil? || force
+        end
+
+        private
+
+          def recount
+            count = {}
+            files.each do |file|
+              total, code, comment, blank = *line_count(file)
+              count[file] = {
+                :total   => total,
+                :code    => code,
+                :comment => comment,
+                :blank   => blank
+              }
+            end
+            count
+          end
+
+          def line_count(file)
+            total, code, comment = 0, 0, 0
+            in_block_comment = false
+            File.open(file) do |file|
+              while line = file.gets
+                total += 1
+                case line
+                when /^\s*$/
+                  comment += 1 if in_block_comment
+                  next
+                when /^=begin/
+                  in_block_comment = true
+                  comment += 1
+                when /^=end/
+                  comment += 1
+                  in_block_comment = false
+                when /^\s*#/
+                  comment += 1
+                else
+                  code += 1 if !in_block_comment
+                  comment += 1 if in_block_comment
+                end
+              end
+            end
+            blank = total - code - comment
+            return total, code, comment, blank
+          end
+
+          def collect_files(paths)
+            files = []
+            paths.each do |path|
+              if File.file?(path)
+                files << path
+              elsif File.directory?(path)
+                files += Dir.glob(File.join(path, '**/*.{rb}'))  # TODO: erb support ?
+              else
+                raise ArgumentError.new("#{path} is neither a file or a directory!")
+              end
+            end
+            files
+          end
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -17,12 +17,6 @@ module Simplabs
           @contains_statements
         end
 
-        def assigns_exception_to_local_variable?
-          @exp[1][2].node_type == :lasgn && @exp[1][2][2].to_a == [:gvar, :$!]
-        rescue
-          false
-        end
-
         private
 
           def contains_statements?(exp = @exp)

data/lib/simplabs/excellent/runner.rb

@@ -11,38 +11,50 @@ module Simplabs
     # name of a file to read the code to process from.
     class Runner
 
-      DEFAULT_CONFIG = {
-        :AssignmentInConditionalCheck         => { },
-        :CaseMissingElseCheck                 => { },
-        :ClassLineCountCheck                  => { :threshold      => 300 },
-        :ClassNameCheck                       => { :pattern         => /^[A-Z][a-zA-Z0-9]*$/ },
-        :SingletonVariableCheck               => { },
-        :GlobalVariableCheck                  => { },
-        :EmptyRescueBodyCheck                 => { },
-        :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 },
-        :'Rails::AttrProtectedCheck'          => { },
-        :'Rails::AttrAccessibleCheck'         => { },
-        :'Rails::InstanceVarInPartialCheck'   => { },
-        :'Rails::ValidationsCheck'            => { },
-        :'Rails::ParamsHashInViewCheck'       => { },
-        :'Rails::SessionHashInViewCheck'      => { },
-        :'Rails::CustomInitializeMethodCheck' => { }
+      DEFAULT_CHECKS_CONFIG = {
+        :AbcMetricMethodCheck                 => {},
+        :AssignmentInConditionalCheck         => {},
+        :CaseMissingElseCheck                 => {},
+        :ClassLineCountCheck                  => {},
+        :ClassNameCheck                       => {},
+        :ControlCouplingCheck                 => {},
+        :CyclomaticComplexityBlockCheck       => {},
+        :CyclomaticComplexityMethodCheck      => {},
+        :EmptyRescueBodyCheck                 => {},
+        :FlogBlockCheck                       => {},
+        :FlogClassCheck                       => {},
+        :FlogMethodCheck                      => {},
+        :ForLoopCheck                         => {},
+        :GlobalVariableCheck                  => {},
+        :MethodLineCountCheck                 => {},
+        :MethodNameCheck                      => {},
+        :ModuleLineCountCheck                 => {},
+        :ModuleNameCheck                      => {},
+        :ParameterNumberCheck                 => {},
+        :ClassVariableCheck                   => {},
+        :'Rails::AttrProtectedCheck'          => {},
+        :'Rails::AttrAccessibleCheck'         => {},
+        :'Rails::InstanceVarInPartialCheck'   => {},
+        :'Rails::ValidationsCheck'            => {},
+        :'Rails::ParamsHashInViewCheck'       => {},
+        :'Rails::SessionHashInViewCheck'      => {},
+        :'Rails::CustomInitializeMethodCheck' => {}
       }
 
-      attr_accessor :config #:nodoc:
+      attr_reader :checks
 
       # Initializes a Runner
       #
       # ==== Parameters
       #
-      # * <tt>checks</tt> - The checks to apply - pass instances of the various check classes. If no checks are specified, all checks will be applied.
-      def initialize(*checks)
-        @config = DEFAULT_CONFIG
-        @checks = checks unless checks.empty?
+      # * <tt>checks_config</tt> - The check configuration to use; You can either specify an array of specs to use like this
+      #                              [:ClassLineCountCheck => { :threshold => 10 }]
+      #                            or you can specify a hash that will then be merged with the default configuration:
+      #                              { :ClassNameCheck => { pattern: 'test' }, :ClassLineCountCheck => { :threshold => 10 } }
+      #                            You can enable/disable a check by setting the value of the hash to sth. truthy/falsy:
+      #                              { :ClassNameCheck => false, :AbcMetricMethodCheck => {} }
+      def initialize(checks_config = {})
+        @checks = load_checks(checks_config)
         @parser = Parsing::Parser.new
       end
 
@@ -53,7 +65,6 @@ module Simplabs
       # * <tt>filename</tt> - The name of the file the code was read from.
       # * <tt>code</tt> - The code to process (String).
       def check(filename, code)
-        @checks ||= load_checks
         @processor ||= Parsing::CodeProcessor.new(@checks)
         node = parse(filename, code)
         @processor.process(node)
@@ -67,7 +78,7 @@ module Simplabs
       def check_code(code)
         check('dummy-file.rb', code)
       end
-  
+
       # Processes the file +filename+. The code will be read from the file.
       #
       # ==== Parameters
@@ -94,7 +105,6 @@ module Simplabs
 
       # Gets the warnings that were produced by the checks.
       def warnings
-        @checks ||= []
         @checks.collect { |check| check.warnings }.flatten
       end
 
@@ -104,11 +114,18 @@ module Simplabs
           @parser.parse(code, filename)
         end
 
-        def load_checks
+        def load_checks(checks_config)
+          effective_checks = checks_config.is_a?(Array) ? checks_config : [DEFAULT_CHECKS_CONFIG.deep_merge(checks_config.deep_symbolize_keys)]
           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))
+          effective_checks.each do |check|
+            check.each do |name, check_config|
+              if !!check_config
+                klass = name.to_s.split('::').inject(::Simplabs::Excellent::Checks) do |mod, class_name|
+                  mod.const_get(class_name)
+                end
+                check_objects << klass.new(check_config.is_a?(Hash) ? check_config.deep_symbolize_keys : {})
+              end
+            end
           end
           check_objects
         end