polishgeeks-dev-tools 1.2.0 → 1.2.1

data/lib/polishgeeks/dev-tools/{command/coverage.rb → commands/simplecov.rb}

@@ -1,13 +1,14 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Command wrapper for Simple code coverage analysing
       # It informs us if we didn't reach a proper code coverage level
-      class Coverage < Base
+      class Simplecov < Base
         self.type = :validator
+        self.validators = [
+          Validators::Simplecov
+        ]
 
-        # Regexp used to match code coverage level
-        MATCH_REGEXP = /\(\d+.\d+\%\) covered/
         # Regexp used to match float number from coverage
         NUMBER_REGEXP = /(\d+[.]\d+)/
 
@@ -19,23 +20,35 @@ module PolishGeeks
         # Executes this command
         # @return [String] command output
         def execute
-          @output = stored_output.rspec[*MATCH_REGEXP]
+          @output = stored_output.rspec[*Validators::Simplecov::MATCH_REGEXP]
         end
 
         # @return [Boolean] true if code coverage level is higher or equal to expected
         def valid?
-          to_f >= DevTools.config.simplecov_threshold
+          to_f >= threshold
         end
 
         # @return [String] default label for this command
         def label
-          "Coverage #{to_f}% covered - #{DevTools.config.simplecov_threshold}% required"
+          "SimpleCov covered #{to_f}%, required #{threshold}%"
         end
 
         # @return [String] message that should be printed when code coverage level is not met
         def error_message
-          threshold = DevTools.config.simplecov_threshold
-          "Coverage level should more or equal to #{threshold}%. was: #{to_f}"
+          'SimpleCov coverage level needs to be ' \
+            "#{threshold}%#{threshold == limit ? '' : ' or more'}, was #{to_f}%"
+        end
+
+        private
+
+        # @return [Float] desired threshold
+        def threshold
+          DevTools.config.simplecov_threshold.to_f
+        end
+
+        # @return [Float] maximum threshold value
+        def limit
+          100.0
         end
       end
     end

data/lib/polishgeeks/dev-tools/{command → commands}/tasks_files_names.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Checks if tasks files (rake and capistrano) have proper extensions
       class TasksFilesNames < Base
         self.type = :validator

data/lib/polishgeeks/dev-tools/{command → commands}/yard.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Command wrapper for Yard statistics
       # @note It validates if everything is well documented
       class Yard < Base

data/lib/polishgeeks/dev-tools/{command → commands}/yml_parser.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Verifying parameters in example YAML config files
       class YmlParser < Base
         self.type = :validator

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

@@ -48,7 +48,6 @@ module PolishGeeks
         tasks_files_names
         rspec
         simplecov
-        coverage
         yard
         examples_comparator
         rubycritic
@@ -77,24 +76,9 @@ module PolishGeeks
       def self.setup(&block)
         self.config = new
 
-        config.detect_framework
-
         block.call(config)
         config.freeze
       end
-
-      # Detects if we use Rails, Sinatra or nothing
-      # We need to set it because some of the commands might work only for Rails
-      # or Sinatra (like brakeman for example - only Rails)
-      def detect_framework
-        define_singleton_method :rails? do
-          !defined?(Rails).nil?
-        end
-
-        define_singleton_method :sinatra? do
-          !defined?(App).nil?
-        end
-      end
     end
   end
 end

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

@@ -0,0 +1,25 @@
+module PolishGeeks
+  module DevTools
+    # Module that encapsulates all the DevTools errrors
+    module Errors
+      # Base class for all DevTools errors
+      class BaseError < StandardError; end
+
+      # Raised when we want to run method that was not implemented and we have just a stub
+      # from parent class
+      class NotImplementedError < BaseError; end
+
+      # Raised when we want to run an command for which pre validation does not pass
+      class PreCommandValidationError < BaseError; end
+
+      # Raised when validators are defined with an unsupported type
+      class InvalidValidatorsTypeError < BaseError; end
+
+      # Raised when it is a type of task that we don't recognize
+      class UnknownTaskType < BaseError; end
+
+      # Raised when any of tasks fail
+      class RequirementsError < BaseError; end
+    end
+  end
+end

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

@@ -5,13 +5,8 @@ module PolishGeeks
       # Regexp used to get only the class name without module names
       CLASS_NAME_REGEXP = /^.*::/
 
-      # Raised when it is a type of task that we don't recognize
-      class UnknownTaskType < StandardError; end
-      # Raised when any of tasks fail
-      class RequirementsError < StandardError; end
-
       # Method will print appropriate output with colors and comments
-      # @param [PolishGeeks::DevTools::Command::Base] task that was executed
+      # @param [PolishGeeks::DevTools::Commands::Base] task that was executed
       # @raise [PolishGeeks::DevTools::Logger::RequirementsError] raised when task
       #   has failed
       # @example Log output of a current_task
@@ -21,7 +16,7 @@ module PolishGeeks
           info(task)
         else
           fatal(task)
-          fail RequirementsError
+          fail Errors::RequirementsError
         end
       end
 
@@ -29,20 +24,20 @@ module PolishGeeks
 
       # Will print message when task didn't fail while running
       # @note Handles also generators that never fail
-      # @param [PolishGeeks::DevTools::Command::Base] task that was executed
-      # @raise [PolishGeeks::DevTools::Logger::UnknownTaskType] raised when task type is
+      # @param [PolishGeeks::DevTools::Commands::Base] task that was executed
+      # @raise [PolishGeeks::DevTools::Errors::UnknownTaskType] raised when task type is
       #   not supported (we don't know how to handle it)
       def info(task)
         msg = 'GENERATED' if task.class.generator?
         msg = 'OK' if task.class.validator?
 
-        fail UnknownTaskType unless msg
+        fail Errors::UnknownTaskType unless msg
 
         printf('%-40s %2s', "#{label(task)} ", "\e[32m#{msg}\e[0m\n")
       end
 
       # Will print message when task did fail while running
-      # @param [PolishGeeks::DevTools::Command::Base] task that was executed
+      # @param [PolishGeeks::DevTools::Commands::Base] task that was executed
       def fatal(task)
         printf('%-30s %20s', "#{label(task)} ", "\e[31mFAILURE\e[0m\n\n")
         puts task.error_message + "\n"
@@ -50,7 +45,7 @@ module PolishGeeks
 
       # Generates a label describing a given task
       # @note Will use a task class name if task doesn't respond to label method
-      # @param [PolishGeeks::DevTools::Command::Base] task that was executed
+      # @param [PolishGeeks::DevTools::Commands::Base] task that was executed
       # @return [String] label describing task
       # @example Get label for a current_task task
       #   label(current_task) #=> 'Rubocop'

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

@@ -15,8 +15,9 @@ module PolishGeeks
           next unless DevTools.config.public_send(:"#{command}?")
 
           klass = command.to_s.gsub(/(?<=_|^)(\w)/, &:upcase).gsub(/(?:_)(\w)/, '\1')
-          cmd = Object.const_get("PolishGeeks::DevTools::Command::#{klass}").new
+          cmd = Object.const_get("PolishGeeks::DevTools::Commands::#{klass}").new
           cmd.stored_output = output
+          cmd.ensure_executable!
           cmd.execute
           output.public_send(:"#{command}=", cmd.output)
           logger.log(cmd)

data/lib/polishgeeks/dev-tools/validators/base.rb

@@ -0,0 +1,26 @@
+module PolishGeeks
+  module DevTools
+    # Module encapsulating all the validators that we use to check/verify code
+    module Validators
+      # Base class for all the validators
+      # @abstract Subclass and use
+      class Base
+        def initialize(stored_output)
+          @stored_output = stored_output
+        end
+
+        # This should be implemented in a subclass
+        # @return [Boolean] if validation check is valid or not
+        def valid?
+          fail Errors::NotImplementedError
+        end
+
+        # @raise [PreCommandValidationError] when valid? return false
+        # @return [Boolean] if validation check is valid or not
+        def validate!
+          fail Errors::PreCommandValidationError unless valid?
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/validators/rails.rb

@@ -0,0 +1,12 @@
+module PolishGeeks
+  module DevTools
+    module Validators
+      # It verifies if Rails is available
+      class Rails < Base
+        def valid?
+          Object.const_defined?('Rails')
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/validators/simplecov.rb

@@ -0,0 +1,20 @@
+module PolishGeeks
+  module DevTools
+    module Validators
+      # It verifies if SimpleCov is available
+      class Simplecov < Base
+        # Regexp used to match code coverage from Simplecov generated output
+        MATCH_REGEXP = /\(\d+.\d+\%\) covered/
+
+        def valid?
+          Object.const_defined?('SimpleCov') || (!output.nil? && output.length > 0)
+        end
+
+        # Searches if we have SimpleCov hooked to rspec
+        def output
+          @output ||= @stored_output.rspec[*MATCH_REGEXP]
+        end
+      end
+    end
+  end
+end

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.2.0'
+    VERSION = '1.2.1'
   end
 end

data/polishgeeks_dev_tools.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
 
   s.add_dependency 'simplecov'
-  s.add_dependency 'rubycritic', '1.2.1'
+  s.add_dependency 'rubycritic'
   s.add_dependency 'pry'
   s.add_dependency 'yard'
   s.add_dependency 'faker'

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

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe PolishGeeks::DevTools::Command::AllowedExtensions do
+RSpec.describe PolishGeeks::DevTools::Commands::AllowedExtensions do
   subject { described_class.new }
 
   describe '#execute' do

data/spec/lib/polishgeeks/dev-tools/commands/base_spec.rb

@@ -0,0 +1,55 @@
+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 }
+
+      before do
+        expect(described_class)
+          .to receive(:validators)
+          .and_return([validator_class])
+
+        expect_any_instance_of(validator_class)
+          .to receive(:valid?)
+          .and_return(true)
+      end
+
+      it { expect { subject.ensure_executable! }.not_to raise_error }
+    end
+
+    context 'when we dont require any validators' do
+      before do
+        expect(described_class)
+          .to receive(:validators)
+          .and_return([])
+      end
+
+      it { expect { subject.ensure_executable! }.not_to raise_error }
+    end
+  end
+end

data/spec/lib/polishgeeks/dev-tools/{command → commands}/brakeman_spec.rb

@@ -1,16 +1,17 @@
 require 'spec_helper'
 
-RSpec.describe PolishGeeks::DevTools::Command::Brakeman do
-  subject { described_class.new }
-  let(:config) { double(rails?: true) }
-
-  before do
-    expect(PolishGeeks::DevTools)
-      .to receive(:config)
-      .and_return(config)
+RSpec.describe PolishGeeks::DevTools::Commands::Brakeman do
+  subject { described_class }
 
-    subject
+  describe '#validators' do
+    it 'should work only when we have Rails framework' do
+      expect(subject.validators).to eq [PolishGeeks::DevTools::Validators::Rails]
+    end
   end
+end
+
+RSpec.describe PolishGeeks::DevTools::Commands::Brakeman do
+  subject { described_class.new }
 
   describe '#execute' do
     context 'when we run brakeman' do

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

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

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

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

data/spec/lib/polishgeeks/dev-tools/{command → commands}/empty_method_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'tempfile'
 
-RSpec.describe PolishGeeks::DevTools::Command::EmptyMethod do
+RSpec.describe PolishGeeks::DevTools::Commands::EmptyMethod do
   subject { described_class.new }
   describe '#execute' do
     let(:file) { [rand.to_s] }

data/spec/lib/polishgeeks/dev-tools/{command → commands}/examples_comparator_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe PolishGeeks::DevTools::Command::ExamplesComparator do
+RSpec.describe PolishGeeks::DevTools::Commands::ExamplesComparator do
   subject { described_class.new }
 
   let(:example_file) { rand.to_s }

data/spec/lib/polishgeeks/dev-tools/{command → commands}/expires_in_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe PolishGeeks::DevTools::Command::ExpiresIn do
+RSpec.describe PolishGeeks::DevTools::Commands::ExpiresIn do
   subject { described_class.new }
 
   let(:config) { double }

data/spec/lib/polishgeeks/dev-tools/{command → commands}/final_blank_line_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe PolishGeeks::DevTools::Command::FinalBlankLine do
+RSpec.describe PolishGeeks::DevTools::Commands::FinalBlankLine do
   subject { described_class.new }
 
   describe '#execute' do

data/spec/lib/polishgeeks/dev-tools/{command → commands}/haml_lint_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe PolishGeeks::DevTools::Command::HamlLint do
+RSpec.describe PolishGeeks::DevTools::Commands::HamlLint do
   subject { described_class.new }
 
   describe '#execute' do