polishgeeks-dev-tools 1.2.1 → 1.3.0

data/polishgeeks_dev_tools.gemspec

@@ -1,7 +1,6 @@
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
-require 'rake'
-require 'polishgeeks/dev-tools/version'
+require 'polish_geeks/dev_tools/version'
 
 Gem::Specification.new do |s|
   s.name        = 'polishgeeks-dev-tools'
@@ -10,12 +9,13 @@ Gem::Specification.new do |s|
   s.authors     = ['Maciej Mensfeld']
   s.email       = ['maciej@mensfeld.pl']
   s.homepage    = ''
-  s.summary     = %q(Set of tools used when developing Ruby based apps)
-  s.description = %q(Set of tools used when developing Ruby based apps)
+  s.summary     = 'Set of tools used when developing Ruby based apps'
+  s.description = 'Set of tools used when developing Ruby based apps'
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
 
+  s.add_dependency 'bundler-audit'
   s.add_dependency 'simplecov'
   s.add_dependency 'rubycritic'
   s.add_dependency 'pry'
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'shoulda'
   s.add_dependency 'rspec'
   s.add_dependency 'rubocop'
+  s.add_dependency 'rubocop-rspec'
   s.add_dependency 'timecop'
   s.add_dependency 'brakeman'
   s.add_dependency 'haml-lint'

data/spec/lib/{polishgeeks/dev-tools → polish_geeks/dev_tools}/commands/allowed_extensions_spec.rb

@@ -6,31 +6,24 @@ RSpec.describe PolishGeeks::DevTools::Commands::AllowedExtensions do
   describe '#execute' do
     let(:file_name) { 'file.rb' }
     let(:files) { [PolishGeeks::DevTools.app_root + '/config/' + file_name] }
-    before do
-      expect(Dir)
-        .to receive(:[])
-        .and_return(files)
-      expect(described_class::ALLOWED_EXTENSIONS)
-        .to receive(:any?)
-        .and_return(allow_extension)
 
+    before do
+      expect(Dir).to receive(:[]) { files }
       subject.execute
     end
 
     context 'when we dont have invalid files' do
-      let(:allow_extension) { true }
       it { expect(subject.output).to eq [] }
     end
 
     context 'when we have invalid files' do
-      let(:allow_extension) { false }
+      let(:file_name) { 'file.py' }
       it { expect(subject.output).to eq [file_name] }
     end
   end
 
   describe '#label' do
     let(:expected) { 'Allowed Extensions' }
-
     it { expect(subject.label).to eq expected }
   end
 
@@ -41,17 +34,12 @@ RSpec.describe PolishGeeks::DevTools::Commands::AllowedExtensions do
       "\n\n#{output.join("\n")}\n"
     end
 
-    before do
-      subject.instance_variable_set('@output', output)
-    end
-
+    before { subject.instance_variable_set('@output', output) }
     it { expect(subject.error_message).to eq expected }
   end
 
   describe do
-    before do
-      subject.instance_variable_set('@output', output)
-    end
+    before { subject.instance_variable_set('@output', output) }
 
     context 'when output is empty' do
       let(:output) { '' }

data/spec/lib/polish_geeks/dev_tools/commands/base_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+RSpec.describe PolishGeeks::DevTools::Commands::Base do
+  subject { described_class.new }
+
+  describe '#execute' do
+    let(:error) { PolishGeeks::DevTools::Errors::NotImplementedError }
+    it { expect { subject.execute }. to raise_error(error) }
+  end
+
+  describe '#valid?' do
+    let(:error) { PolishGeeks::DevTools::Errors::NotImplementedError }
+    it { expect { subject.valid? }. to raise_error(error) }
+  end
+
+  describe '#error_message' do
+    let(:output) { rand.to_s }
+
+    before do
+      subject.instance_variable_set('@output', output)
+    end
+
+    it 'by default should equal raw output' do
+      expect(subject.error_message).to eq output
+    end
+  end
+
+  describe '#ensure_executable!' do
+    context 'when there are validators' do
+      let(:validator_class) { PolishGeeks::DevTools::Validators::Base }
+      let(:instance) { instance_double(PolishGeeks::DevTools::Validators::Base) }
+
+      before do
+        expect(described_class).to receive(:validators) { [validator_class] }
+        allow(validator_class).to receive(:new) { instance }
+        expect(instance).to receive(:validate!) { true }
+      end
+
+      it { expect { subject.ensure_executable! }.not_to raise_error }
+    end
+
+    context 'when we dont require any validators' do
+      before { expect(described_class).to receive(:validators) { [] } }
+      it { expect { subject.ensure_executable! }.not_to raise_error }
+    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
+end

data/spec/lib/polish_geeks/dev_tools/commands/brakeman_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+RSpec.describe PolishGeeks::DevTools::Commands::Brakeman do
+  context 'class' do
+    subject { described_class }
+
+    describe '#validators' do
+      it 'works only when we have Rails framework' do
+        expect(subject.validators).to eq [PolishGeeks::DevTools::Validators::Rails]
+      end
+    end
+  end
+
+  context 'instance' do
+    subject { described_class.new }
+
+    describe '#execute' do
+      context 'when we run brakeman' do
+        let(:instance) { instance_double(PolishGeeks::DevTools::Shell) }
+
+        before do
+          allow(PolishGeeks::DevTools::Shell).to receive(:new) { instance }
+          expect(instance).to receive(:execute).with('bundle exec brakeman -q')
+        end
+
+        it 'executes the command' do
+          subject.execute
+        end
+      end
+    end
+
+    describe '#valid?' do
+      context 'when warnings are equal 0' do
+        before do
+          expect(subject)
+            .to receive(:warnings)
+            .and_return(0)
+        end
+
+        context 'and errors are equal 0' do
+          before do
+            expect(subject)
+              .to receive(:errors)
+              .and_return(0)
+          end
+
+          it 'returns true' do
+            expect(subject.valid?).to eq true
+          end
+        end
+
+        context 'and errors are not equal 0' do
+          before do
+            expect(subject)
+              .to receive(:errors)
+              .and_return(1)
+          end
+
+          it 'returns true' do
+            expect(subject.valid?).to eq false
+          end
+        end
+      end
+    end
+
+    describe 'label' do
+      let(:models) { rand(1000) }
+      let(:controllers) { rand(1000) }
+      let(:templates) { rand(1000) }
+
+      before do
+        expect(subject).to receive(:models).and_return(models)
+        expect(subject).to receive(:controllers).and_return(controllers)
+        expect(subject).to receive(:templates).and_return(templates)
+      end
+
+      it 'uses details' do
+        label = "Brakeman (#{controllers} con, #{models} mod, #{templates} temp)"
+        expect(subject.label).to eq label
+      end
+    end
+
+    describe 'counter' do
+      described_class::REGEXPS.each do |name, _regexp|
+        describe "##{name}" do
+          let(:amount) { rand(1000) }
+
+          before do
+            subject.instance_variable_set(:@output, "#{name.to_s.capitalize} #{amount}")
+          end
+
+          it 'returns a proper value' do
+            expect(subject.send(name)).to eq amount
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/polish_geeks/dev_tools/commands/bundler_audit_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+RSpec.describe PolishGeeks::DevTools::Commands::BundlerAudit do
+  subject { described_class.new }
+
+  describe '#execute' do
+    let(:instance) { instance_double(PolishGeeks::DevTools::Shell) }
+
+    before do
+      allow(PolishGeeks::DevTools::Shell).to receive(:new) { instance }
+      expect(instance).to receive(:execute)
+        .with('bundle-audit update 2>&1 > /dev/null; bundle-audit check')
+    end
+
+    it { subject.execute }
+  end
+
+  describe '#valid?' do
+    context 'when there are vulnerabilities' do
+      before do
+        output = <<-EOS
+          Name: activesupport
+          Version: 3.2.10
+          Advisory: OSVDB-91451
+          Criticality: High
+          URL: http://www.osvdb.org/show/osvdb/91451
+          Title: XML Parsing Vulnerability affecting JRuby users
+          Solution: upgrade to ~> 3.1.12, >= 3.2.13
+
+          Unpatched versions found!
+        EOS
+        subject.instance_variable_set('@output', output)
+      end
+
+      it { expect(subject.valid?).to eq false }
+    end
+
+    context 'when there are no vulnerabilities' do
+      before { subject.instance_variable_set('@output', 'No vulnerabilities found') }
+
+      it { expect(subject.valid?).to eq true }
+    end
+  end
+
+  describe '.generator?' do
+    it { expect(described_class.generator?).to eq false }
+  end
+
+  describe '.validator?' do
+    it { expect(described_class.validator?).to eq true }
+  end
+end

data/spec/lib/{polishgeeks/dev-tools/commands/empty_method → polish_geeks/dev_tools/commands/empty_methods}/file_parser_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethod::FileParser do
+RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethods::FileParser do
   let(:file) { Tempfile.new('foo') }
   subject { described_class.new(file) }
 

data/spec/lib/{polishgeeks/dev-tools/commands/empty_method → polish_geeks/dev_tools/commands/empty_methods}/string_refinements_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethod::StringRefinements do
+RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethods::StringRefinements do
   using described_class
 
   describe '#defines_method?' do

data/spec/lib/{polishgeeks/dev-tools/commands/empty_method_spec.rb → polish_geeks/dev_tools/commands/empty_methods_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'tempfile'
 
-RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethod do
+RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethods do
   subject { described_class.new }
   describe '#execute' do
     let(:file) { [rand.to_s] }
@@ -21,7 +21,7 @@ RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethod do
         subject.execute
       end
 
-      it 'should set appropriate variables' do
+      it 'sets appropriate variables' do
         expect(subject.output).to eq []
         expect(subject.counter).to eq(file.count)
       end
@@ -37,7 +37,7 @@ RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethod do
         subject.execute
       end
 
-      it 'should set appropriate variables' do
+      it 'sets appropriate variables' do
         expect(subject.output.first).to eq "#{file.first} lines #{empty_methods}"
         expect(subject.counter).to eq(file.count)
       end
@@ -129,9 +129,9 @@ RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethod do
   end
 
   describe '#config_excludes' do
-    context 'empty_method_ignored is set' do
+    context 'empty_methods_ignored is set' do
       let(:paths) { ["#{rand}.rb", "#{rand}.rb"] }
-      let(:config) { double(empty_method_ignored: paths) }
+      let(:config) { double(empty_methods_ignored: paths) }
 
       before do
         expect(PolishGeeks::DevTools)
@@ -142,8 +142,8 @@ RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethod do
       it { expect(subject.send(:config_excludes)).to eq paths }
     end
 
-    context 'empty_method_ignored is not set' do
-      let(:config) { double(empty_method_ignored: nil) }
+    context 'empty_methods_ignored is not set' do
+      let(:config) { double(empty_methods_ignored: nil) }
 
       before do
         expect(PolishGeeks::DevTools)
@@ -155,53 +155,6 @@ RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethod do
     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 }