excellent 2.0.1 → 2.1.0

data/README.md

@@ -104,6 +104,17 @@ You can get a list of the enabled checks and their configurations by running:
 excellent --checks
 ```
 
+You can also place a `.excellent.yml` file in your home directory that contains default settings you always
+want to apply. Settings in project-specific configuration files will override these default settings.
+
+Excellent now also supports ignore paths. Simple place a `.excellentignore` file in the root directory of
+your project and these directories will be ignored, e.g.:
+
+```
+vendor
+some/specific/file.rb
+```
+
 Static analysis
 ---------------
 

data/bin/excellent

@@ -39,12 +39,23 @@ else
   formatter = Simplabs::Excellent::Formatters::Text.new
 end
 
-custom_config = {}
-config_file   = File.join(Dir.pwd, '.excellent.yml')
-if File.exists?(config_file)
+custom_config       = {}
+custom_config_file  = File.join(Dir.pwd, '.excellent.yml')
+default_config_file = File.join(File.expand_path('~'), '.excellent.yml')
+if File.exists?(default_config_file) || File.exists?(custom_config_file)
   require 'yaml'
   begin
-    custom_config = YAML.load(File.open(config_file)) || {}
+    default_config = if File.exists?(default_config_file)
+      YAML.load(File.open(default_config_file)) || {}
+    else
+      {}
+    end
+    custom_config = if File.exists?(custom_config_file)
+      YAML.load(File.open(custom_config_file)) || {}
+    else
+      {}
+    end
+    custom_config = default_config.merge(custom_config)
     config_valid  = custom_config.is_a?(Hash) && custom_config.all? do |key, value|
       key.is_a?(String) || key.is_a?(Symbol)
     end
@@ -52,7 +63,7 @@ if File.exists?(config_file)
     config_valid = false
   end
   unless config_valid
-    puts "\n  ** The configuration in #{config_file} is not valid!\n\n"
+    puts "\n  ** The configuration is not valid!\n\n"
     puts "     Please make sure you specify a hash with check names as keys and hashes or truthy/falsy values as hash values, e.g.:\n\n"
     puts "       AbcMetricMethodCheck:"
     puts "         false"
@@ -63,6 +74,12 @@ if File.exists?(config_file)
   end
 end
 
+ignore_paths = []
+ignore_file  = File.join(Dir.pwd, '.excellentignore')
+if File.exists?(ignore_file)
+  ignore_paths = File.readlines(ignore_file).map(&:strip).select { |line| !line.empty? }
+end
+
 excellent = Simplabs::Excellent::Runner.new(custom_config)
 
 if options[:print_checks]
@@ -76,7 +93,7 @@ if options[:print_checks]
   exit 0
 end
 
-paths  = ARGV.dup
+paths = ARGV.dup
 if paths.empty?
   puts "\n  **You must specify one or more directories to analyse, e.g.:\n"
   puts "\n    excellent lib/\n\n"
@@ -84,8 +101,9 @@ if paths.empty?
 end
 
 begin
-  excellent.check_paths(paths, formatter)
-rescue ArgumentError
+  excellent.check_paths(paths, formatter, ignore_paths)
+rescue ArgumentError => e
+  puts e.inspect
   puts "\n** Excellent cannot find the paths specified!\n\n"
   exit 1
 end

data/lib/simplabs/excellent.rb

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

data/lib/simplabs/excellent/runner.rb

@@ -94,9 +94,10 @@ module Simplabs
       #
       # * <tt>paths</tt> - The paths to process (specify file names or directories; will recursively process all ruby files if a directory is given).
       # * <tt>formatter</tt> - The formatter to use. If a formatter is specified, its +start+, +file+, +warning+ and +end+ methods will be called
-      def check_paths(paths, formatter = nil)
+      # * <tt>ignore_paths</tt> - The paths to ignore
+      def check_paths(paths, formatter = nil, ignore_paths = [])
         formatter.start if formatter
-        collect_files(paths).each do |path|
+        collect_files(paths, ignore_paths).each do |path|
           check_file(path)
           format_file_and_warnings(formatter, path) if formatter
         end
@@ -130,8 +131,9 @@ module Simplabs
           check_objects
         end
 
-        def collect_files(paths)
-          files = []
+        def collect_files(paths, ignore_paths)
+          files         = []
+          ignored_files = []
           paths.each do |path|
             if File.file?(path)
               files << path
@@ -141,7 +143,16 @@ module Simplabs
               raise ArgumentError.new("#{path} is neither a File nor a directory!")
             end
           end
-          files
+          ignore_paths.each do |path|
+            if File.file?(path)
+              ignored_files << path
+            elsif File.directory?(path)
+              ignored_files += Dir.glob(File.join(path, '**/*.{rb,erb}'))
+            else
+              raise ArgumentError.new("#{path} is neither a File nor a directory!")
+            end
+          end
+          files - ignored_files
         end
 
         def format_file_and_warnings(formatter, filename)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excellent
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors: