polishgeeks-dev-tools 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2cfc9419ae8508626d77a5455eb886d1a89c20a
-  data.tar.gz: 413ff1e0091e908259ec11fcbda3856dff8f6c32
+  metadata.gz: 5834fe9ee7e13366bca4384980932e6953e31b63
+  data.tar.gz: d75fc73b8bfca128506f6770bec0f22cf9e465fc
 SHA512:
-  metadata.gz: 5fe73b0e2f5e6cdd1312a020a10f4ee6d420cd42c5ef41fd32c0a325afda7ed2a89140a7720dbe1ad0d2eb3c3a836528923c4f967c4767612340eb55fddfb747
-  data.tar.gz: ae87dbbaa7e11a683a519702b8c6082aec66fa8f240ab11fb3cf40a8fa6627d4f219c4f4e27b017d86d1a945ed1614e62f18b0990ded21dddf6cb0264a2bfe73
+  metadata.gz: 7c13b0baae9e0177a17bb35d5e0965a8936e2c2a865635fd2242375816686d873ce879b0b890842c346573ed24d107bd10ed2781a9bb53703298fef79f07659d
+  data.tar.gz: b6631dbe2d166773049bd2821f46d900df4d41ce6ba7164e566a2f876e4a39d0d7b64e119a46e7d3a107c862be0a6cc5f76fb55d95c982ebf6afa28ee63b7545

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.2
+ruby-2.2.3

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.6
-  - 2.2.2
+  - 2.1.7
+  - 2.2.3
 script:
   - bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# PolishGeeks Dev Tools Changelog
+
+## 1.1.0
+
+- Added FinalBlankLine command which check if all files have new line at the end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polishgeeks-dev-tools (1.0.0)
+    polishgeeks-dev-tools (1.1.0)
       brakeman
       faker
       haml-lint
@@ -63,7 +63,7 @@ GEM
     docile (1.1.5)
     equalizer (0.0.11)
     erubis (2.7.0)
-    faker (1.4.3)
+    faker (1.5.0)
       i18n (~> 0.5)
     fastercsv (1.5.5)
     flay (2.4.0)
@@ -95,7 +95,7 @@ GEM
       mongoid (~> 4.0.0)
       rake
       rspec (~> 3.1)
-    moped (2.0.6)
+    moped (2.0.7)
       bson (~> 3.0)
       connection_pool (~> 2.0)
       optionable (~> 0.2.0)
@@ -191,3 +191,6 @@ DEPENDENCIES
   bundler
   polishgeeks-dev-tools!
   rake
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -50,6 +50,7 @@ determine, which you can use in your project:
 |-----------------------|-----------|---------------------------------------------------------------------------------------|
 | brakeman              | Rails     | A static analysis security vulnerability scanner for Ruby on Rails                    |
 | rubocop               | -         | Used to check Ruby syntax according to our styling                                    |
+| final_blank_line      | -         | Check if all files have final blank line                                              |
 | expires_in            | -         | Checks if there are typos like expire_in, etc that might brake app caching            |
 | haml_lint             | -         | User to check HAML syntax in the app views                                            |
 | yard                  | -         | YARD documentation standards checking                                                 |
@@ -69,9 +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 |
+| 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 |
 
 ## Usage in any Rails/Ruby application
 

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

@@ -0,0 +1,116 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Validator used to check if all files have final blank line
+      class FinalBlankLine < Base
+        self.type = :validator
+
+        attr_reader :counter
+
+        # Default paths which we want to exclude from analyse
+        DEFAULT_PATHS_TO_EXCLUDE = %w(
+          coverage
+          tmp
+          log
+          vendor
+          public
+          app/assets/images
+          app/assets/fonts
+        )
+
+        # Executes this command and set output and counter variables
+        def execute
+          @output = []
+          @counter = 0
+
+          files_to_analyze.each do |file|
+            @counter += 1
+            @output << sanitize(file) unless file_valid?(file)
+          end
+        end
+
+        # @return [Boolean] true if all files have final blank line
+        def valid?
+          output.empty?
+        end
+
+        # @return [String] default label for this command
+        def label
+          "Final blank line: #{counter} files checked"
+        end
+
+        # @return [String] message that should be printed when some files don't have
+        # final blank line
+        def error_message
+          "Following files don't have final blank line: \n#{output.join("\n")}\n"
+        end
+
+        private
+
+        # @return [Array<String>] array with files to analyze
+        def files_to_analyze
+          # expression {*,.*} is needed because glob method don't take unix-like hidden files
+          files_from_path('**/{*,.*}') - excludes
+        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}/**/{*,.*}")
+          end
+
+          excluded_files
+        end
+
+        # @return [Array<String>] list of excluded files 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
+        end
+
+        # @param [String] path from which we want take files
+        # @return [Array<String>] list of files in path with app prefix path
+        # @note if path is a file return array with file path with app prefix path
+        def files_from_path(path)
+          full_path = "#{::PolishGeeks::DevTools.app_root}/#{path}"
+          return [full_path] if File.file?(full_path)
+
+          Dir.glob(full_path).select { |f| File.file? f }
+        end
+
+        # @param [String] file name that we want to sanitize
+        # @return [String] sanitized file name
+        # @example
+        #   file = /home/something/app/lib/lib.rb,
+        #   where /home/something/app/ is a app root path, then
+        #   sanitize(file) #=> lib/lib.rb
+        def sanitize(file)
+          file.gsub("#{PolishGeeks::DevTools.app_root}/", '')
+        end
+
+        # @param [String] file name which we want validate
+        # @return [Boolean] true if file is empty or has final blank line.
+        #   Otherwise return false.
+        def file_valid?(file)
+          File.size(file) == 0 || IO.readlines(file).last[-1] == "\n"
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/config.rb

@@ -21,8 +21,14 @@ module PolishGeeks
       end
 
       attr_accessor :simplecov_threshold
-      attr_accessor :rspec_files_structure_ignored
-      attr_accessor :expires_in_files_ignored
+
+      %i(
+        rspec_files_structure
+        expires_in_files
+        final_blank_line
+      ).each do |attr|
+        attr_accessor "#{attr}_ignored"
+      end
 
       # Available commands
       # All commands will be executed in this order (first rubocop, then rspec, etc)
@@ -31,6 +37,7 @@ module PolishGeeks
         expires_in
         brakeman
         rubocop
+        final_blank_line
         haml_lint
         allowed_extensions
         yml_parser

data/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.0.0'
+    VERSION = '1.1.0'
   end
 end

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

@@ -0,0 +1,269 @@
+require 'spec_helper'
+
+RSpec.describe PolishGeeks::DevTools::Command::FinalBlankLine do
+  subject { described_class.new }
+
+  describe '#execute' do
+    let(:files) { [rand.to_s, rand.to_s] }
+
+    before do
+      expect(subject)
+        .to receive(:files_to_analyze)
+        .and_return(files)
+    end
+
+    context 'when all files are valid' do
+      before do
+        expect(subject)
+          .to receive(:file_valid?)
+          .exactly(files.count).times
+          .and_return true
+        subject.execute
+      end
+
+      it 'should set appropriate variables' do
+        expect(subject.output).to eq []
+        expect(subject.counter).to eq(files.count)
+      end
+    end
+
+    context 'when exist not valid file' do
+      before do
+        expect(subject)
+          .to receive(:file_valid?)
+          .exactly(files.count).times
+          .and_return false
+
+        files.each do |file|
+          expect(subject)
+            .to receive(:sanitize)
+            .with(file)
+            .and_return(file)
+        end
+        subject.execute
+      end
+
+      it 'should set appropriate variables' do
+        expect(subject.output).to eq files
+        expect(subject.counter).to eq(files.count)
+      end
+    end
+  end
+
+  describe '#valid?' do
+    before do
+      subject.instance_variable_set('@output', output)
+    end
+
+    context 'when output is empty' do
+      let(:output) { [] }
+      it { expect(subject.valid?).to eq true }
+    end
+
+    context 'when output have some files' do
+      let(:output) { ['file_name'] }
+      it { expect(subject.valid?).to eq false }
+    end
+  end
+
+  describe '#label' do
+    let(:counter) { rand(10) }
+    let(:expected) { "Final blank line: #{counter} files checked" }
+
+    before do
+      subject.instance_variable_set('@counter', counter)
+    end
+
+    it { expect(subject.label).to eq expected }
+  end
+
+  describe '#error_message' do
+    let(:output) { [rand.to_s, rand.to_s] }
+    let(:expected) { "Following files don't have final blank line: \n#{output.join("\n")}\n" }
+
+    before do
+      subject.instance_variable_set('@output', output)
+    end
+
+    it { expect(subject.error_message).to eq expected }
+  end
+
+  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(:excludes)
+        .and_return(excludes)
+    end
+
+    it { expect(subject.send(:files_to_analyze)).to eq expected }
+  end
+
+  describe '#excludes' do
+    let(:defaults) { [rand.to_s, rand.to_s] }
+    let(:configs) { [rand.to_s] }
+    let(:expected) { (defaults + configs).flatten }
+
+    before do
+      expect(subject)
+        .to receive(:default_excludes)
+        .and_return(defaults)
+
+      expect(subject)
+        .to receive(:config_excludes)
+        .and_return(configs)
+    end
+
+    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] }
+      let(:config) { double(final_blank_line_ignored: paths) }
+
+      before do
+        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 }
+    end
+
+    context 'final_blank_line_ignored is not set' do
+      let(:config) { double(final_blank_line_ignored: nil) }
+      before do
+        expect(PolishGeeks::DevTools)
+          .to receive(:config)
+          .and_return config
+      end
+      it { expect(subject.send(:config_excludes)).to eq [] }
+    end
+  end
+
+  describe '#files_from_path' do
+    let(:app_root) { PolishGeeks::DevTools.app_root }
+
+    context 'path is a directory' do
+      let(:path) { rand.to_s }
+      let(:file_in_path) { "#{app_root}/#{rand}" }
+      let(:dir_in_path) { "#{app_root}/#{rand}" }
+      before do
+        expect(File)
+          .to receive(:file?)
+          .with("#{app_root}/#{path}")
+          .and_return(false)
+
+        expect(Dir)
+          .to receive(:glob)
+          .with("#{app_root}/#{path}")
+          .and_return([file_in_path, dir_in_path])
+
+        expect(File)
+          .to receive(:file?)
+          .with(file_in_path)
+          .and_return(true)
+
+        expect(File)
+          .to receive(:file?)
+          .with(dir_in_path)
+          .and_return(false)
+      end
+      it { expect(subject.send(:files_from_path, path)).to eq [file_in_path] }
+    end
+
+    context 'path is a file' do
+      let(:path) { rand.to_s }
+      before do
+        expect(File)
+          .to receive(:file?)
+          .with("#{app_root}/#{path}")
+          .and_return(true)
+      end
+      it { expect(subject.send(:files_from_path, path)).to eq ["#{app_root}/#{path}"] }
+    end
+  end
+
+  describe '#sanitize' do
+    let(:file) { rand.to_s }
+    let(:app_root) { PolishGeeks::DevTools.app_root }
+    let(:path) { "#{app_root}/#{file}" }
+
+    it { expect(subject.send(:sanitize, "#{app_root}/#{path}")).to eq file }
+  end
+
+  describe '#file_valid?' do
+    let(:file) { rand.to_s }
+
+    context 'file is not empty' do
+      before do
+        expect(File)
+          .to receive(:size)
+          .with(file)
+          .and_return(1)
+      end
+
+      context 'file has final blank line' do
+        before do
+          expect(IO)
+            .to receive(:readlines)
+            .with(file)
+            .and_return([rand.to_s + "\n"])
+        end
+
+        it { expect(subject.send(:file_valid?, file)).to eq true }
+      end
+
+      context 'file does not have final blank line' do
+        before do
+          expect(IO)
+            .to receive(:readlines)
+            .with(file)
+            .and_return([rand.to_s + 'end'])
+        end
+
+        it { expect(subject.send(:file_valid?, file)).to eq false }
+      end
+    end
+
+    context 'file is empty' do
+      before do
+        expect(File)
+          .to receive(:size?)
+          .with(file)
+          .and_return(0)
+
+        it { expect(subject.send(:file_valid?, file)).to eq true }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polishgeeks-dev-tools
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Maciej Mensfeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -217,6 +217,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -231,6 +232,7 @@ files:
 - lib/polishgeeks/dev-tools/command/coverage.rb
 - lib/polishgeeks/dev-tools/command/examples_comparator.rb
 - lib/polishgeeks/dev-tools/command/expires_in.rb
+- lib/polishgeeks/dev-tools/command/final_blank_line.rb
 - lib/polishgeeks/dev-tools/command/haml_lint.rb
 - lib/polishgeeks/dev-tools/command/readme.rb
 - lib/polishgeeks/dev-tools/command/rspec.rb
@@ -258,6 +260,7 @@ files:
 - spec/lib/polishgeeks/dev-tools/command/coverage_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/examples_comparator_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/expires_in_spec.rb
+- spec/lib/polishgeeks/dev-tools/command/final_blank_line_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/haml_lint_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/readme_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/rspec_files_names_spec.rb
@@ -308,6 +311,7 @@ test_files:
 - spec/lib/polishgeeks/dev-tools/command/coverage_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/examples_comparator_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/expires_in_spec.rb
+- spec/lib/polishgeeks/dev-tools/command/final_blank_line_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/haml_lint_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/readme_spec.rb
 - spec/lib/polishgeeks/dev-tools/command/rspec_files_names_spec.rb