Merge pull request #6 from polishgeeks/final_blank_excluded

Final blank excluded

CHANGELOG.md

@@ -1,5 +1,10 @@
 # PolishGeeks Dev Tools Changelog
 
+## 1.1.2
+
+- Ignore .DS_Store files in FinalBlankLine validator.
+- Changed FinalBlankLine excluded mechanism. You can define directories and files (ex. lib/command or lib/file.rb). Please don't use path with stars convention (ex. lib/**/*).
+
 ## 1.1.1
 
 - Ignore doc directory in FinalBlankLine validator

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polishgeeks-dev-tools (1.1.1)
+    polishgeeks-dev-tools (1.1.2)
       brakeman
       faker
       haml-lint
@@ -148,7 +148,7 @@ GEM
       reek (= 1.6.3)
       ruby2ruby (>= 2.1.1, < 3.0)
       virtus (~> 1.0)
-    sass (3.4.17)
+    sass (3.4.18)
     sexp_processor (4.6.0)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)

README.md

@@ -70,10 +70,10 @@ determine, which you can use in your project:
 
 Some validators might accept additional config settings - please refer to this table for a description on how to use them:
 
-| Option                        | Validator             | Description                                                                                         |
-|-------------------------------|-----------------------|-----------------------------------------------------------------------------------------------------|
-| rspec_files_structure_ignored | rspec_files_structure | You can provide an array of files that should be ignored                                            |
-| final_blank_line_ignored      | final_blank_line      | You can provide an array of files (ex. lib/file.rb) or paths (ex. lib/\*\*/\*) that should be ignored |
+| Option                        | Validator             | Description                                                                                                 |
+|-------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------|
+| rspec_files_structure_ignored | rspec_files_structure | You can provide an array of files that should be ignored                                                    |
+| final_blank_line_ignored      | final_blank_line      | You can provide an array of files (ex. lib/file.rb) or directories (ex. lib/command) that should be ignored |
 
 ## Usage in any Rails/Ruby application
 

lib/polishgeeks/dev-tools/command/final_blank_line.rb

@@ -17,6 +17,7 @@ class FinalBlankLine < Base
           public
           app/assets/images
           app/assets/fonts
+          .DS_Store
         )
 
         # Executes this command and set output and counter variables
@@ -49,40 +50,33 @@ def error_message
         private
 
         # @return [Array<String>] array with files to analyze
+        # @note method take all not excluded files, also with hidden files
         def files_to_analyze
           # expression {*,.*} is needed because glob method don't take unix-like hidden files
-          files_from_path('**/{*,.*}') - excludes
+          files = files_from_path('**/{*,.*}')
+          remove_excludes files
         end
 
-        # @return [Array<String>] list of files that
-        #   should be excluded from checking
-        def excludes
-          (default_excludes + config_excludes).flatten
-        end
-
-        # @return [Array<String>] list of default excluded files
-        #   defined in DEFAULT_PATHS_TO_EXCLUDE
-        def default_excludes
-          excluded_files = []
-
-          DEFAULT_PATHS_TO_EXCLUDE.each do |path|
-            excluded_files << files_from_path("#{path}/**/{*,.*}")
+        # @param [Array<String>] files list which we want analyse
+        # @return [Array<String>] array without excluded files
+        def remove_excludes(files)
+          excluded_paths = excludes
+          files.delete_if do |file|
+            excluded_paths.any? { |exclude| file =~ /#{exclude}/ }
           end
+        end
 
-          excluded_files
+        # @return [Array<String>] list of files/directories that
+        #   should be excluded from checking
+        # @note excluded files/directories are defined in DEFAULT_PATHS_TO_EXCLUDE
+        #   and in configuration file
+        def excludes
+          config_excludes + DEFAULT_PATHS_TO_EXCLUDE
         end
 
-        # @return [Array<String>] list of excluded files from config file
+        # @return [Array<String>] list of excluded files/directories from config file
         def config_excludes
-          excluded_files = []
-          config_paths = DevTools.config.final_blank_line_ignored
-          return [] unless config_paths
-
-          config_paths.each do |path|
-            excluded_files << files_from_path(path)
-          end
-
-          excluded_files
+          DevTools.config.final_blank_line_ignored || []
         end
 
         # @param [String] path from which we want take files

lib/polishgeeks/dev-tools/version.rb

@@ -3,6 +3,6 @@ module PolishGeeks
   # Dev Tools for PolishGeeks developers
   module DevTools
     # Current version of dev tools
-    VERSION = '1.1.1'
+    VERSION = '1.1.2'
   end
 end

spec/lib/polishgeeks/dev-tools/command/final_blank_line_spec.rb

@@ -90,33 +90,40 @@
 
   describe '#files_to_analyze' do
     let(:files) { [rand.to_s, rand.to_s] }
-    let(:excludes) { [files[0]] }
-    let(:expected) { [files[1]] }
 
     before do
       expect(subject)
         .to receive(:files_from_path)
         .with('**/{*,.*}')
         .and_return(files)
 
+      expect(subject)
+        .to receive(:remove_excludes)
+        .with(files)
+        .and_return(files)
+    end
+
+    it { expect(subject.send(:files_to_analyze)).to eq files }
+  end
+
+  describe '#remove_excludes' do
+    let(:files) { %w(lib/file.txt exclude.txt file.rb) }
+    let(:excludes) { %w(lib exclude.txt) }
+
+    before do
       expect(subject)
         .to receive(:excludes)
         .and_return(excludes)
     end
 
-    it { expect(subject.send(:files_to_analyze)).to eq expected }
+    it { expect(subject.send(:remove_excludes, files)).to eq ['file.rb'] }
   end
 
   describe '#excludes' do
-    let(:defaults) { [rand.to_s, rand.to_s] }
     let(:configs) { [rand.to_s] }
-    let(:expected) { (defaults + configs).flatten }
+    let(:expected) { configs + described_class::DEFAULT_PATHS_TO_EXCLUDE }
 
     before do
-      expect(subject)
-        .to receive(:default_excludes)
-        .and_return(defaults)
-
       expect(subject)
         .to receive(:config_excludes)
         .and_return(configs)
@@ -125,19 +132,6 @@
     it { expect(subject.send(:excludes)).to eq expected }
   end
 
-  describe '#default_excludes' do
-    before do
-      described_class::DEFAULT_PATHS_TO_EXCLUDE.each do |path|
-        expect(subject)
-          .to receive(:files_from_path)
-          .with("#{path}/**/{*,.*}")
-          .and_return(path)
-      end
-    end
-
-    it { expect(subject.send(:default_excludes)).to eq described_class::DEFAULT_PATHS_TO_EXCLUDE }
-  end
-
   describe '#config_excludes' do
     context 'final_blank_line_ignored is set' do
       let(:paths) { [rand.to_s, rand.to_s] }
@@ -147,13 +141,6 @@
         expect(PolishGeeks::DevTools)
           .to receive(:config)
           .and_return config
-
-        paths.each do |path|
-          expect(subject)
-            .to receive(:files_from_path)
-            .with("#{path}")
-            .and_return(path)
-        end
       end
 
       it { expect(subject.send(:config_excludes)).to eq paths }