polishgeeks-dev-tools 1.2.1 → 1.3.0

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

@@ -21,16 +21,35 @@ module PolishGeeks
 
         # @return [Boolean] true if there were no Rspec failures, false otherwise
         def valid?
-          output.include?('0 failures')
+          failures_count.zero? && disallow_pending_valid?
         end
 
         # @return [String] default label for this command
         def label
-          examples = output.scan(EXAMPLES_REGEXP).flatten.first.to_i
-          failures = output.scan(FAILURES_REGEXP).flatten.first.to_i
-          pending = output.scan(PENDING_REGEXP).flatten.first.to_i
+          "Rspec (#{examples_count} ex, #{failures_count} fa, #{pending_count} pe)"
+        end
+
+        private
+
+        # @return [Integer] how many examples
+        def examples_count
+          output.scan(EXAMPLES_REGEXP).flatten.first.to_i
+        end
+
+        # @return [Integer] how many failures
+        def failures_count
+          output.scan(FAILURES_REGEXP).flatten.first.to_i
+        end
+
+        # @return [Integer] how many pending
+        def pending_count
+          output.scan(PENDING_REGEXP).flatten.first.to_i
+        end
 
-          "Rspec (#{examples} ex, #{failures} fa, #{pending} pe)"
+        # @return [Boolean] true if pending specs count is zero or we allow
+        # pending tests, false otherwise
+        def disallow_pending_valid?
+          PolishGeeks::DevTools.config.rspec_disallow_pending? ? pending_count.zero? : true
         end
       end
     end

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

@@ -13,7 +13,7 @@ module PolishGeeks
         CHECKED_DIRS = %w(
           aggregators controllers helpers lib libs models decorators
           presenters services workers mailers requests polishgeeks*
-        )
+        ).freeze
 
         # Regexp used to check names in spec files
         CHECK_REGEXP = /(\_spec\.rb)$/

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

@@ -13,20 +13,20 @@ module PolishGeeks
         FILES_CHECKED = %w(
           app/**/*.rb
           lib/**/*.rb
-        )
+        ).freeze
 
         # From where should we take spec files
         RSPEC_FILES = %w(
           spec/**/*_spec.rb
-        )
+        ).freeze
 
         # Executes this command
         # @return [Array<String>] empty array if all the files have corresponding
         #   rspec files, otherwise array will contain files that doesn't
         def execute
           @output = {
-            app: analyzed_files - rspec_files,
-            rspec: rspec_files - analyzed_files
+            app: analyzed_files - analyzed_rspec_files,
+            rspec: analyzed_rspec_files - analyzed_files
           }
         end
 
@@ -53,9 +53,7 @@ module PolishGeeks
         # @return [Array<String>] array with list of files that we want to compare with
         #   those from Rspec that should exist
         def analyzed_files
-          files = FILES_CHECKED.map do |dir|
-            Dir[File.join(DevTools.app_root, dir)]
-          end
+          files = checked_files
 
           files.flatten!
           files.uniq!
@@ -70,8 +68,8 @@ module PolishGeeks
         end
 
         # @return [Array<String>] rspec files that should correspond with analyzed_files
-        def rspec_files
-          files = RSPEC_FILES.map { |dir| Dir[File.join(DevTools.app_root, dir)] }
+        def analyzed_rspec_files
+          files = rspec_files
 
           files.flatten!
 
@@ -128,6 +126,21 @@ module PolishGeeks
         def excludes
           DevTools.config.rspec_files_structure_ignored || []
         end
+
+        # @return [Array<String>] files that should be analyzed
+        def directory_files(dir)
+          Dir[File.join(DevTools.app_root, dir)]
+        end
+
+        # @return [Array<String>] array with list of files that we want to compare
+        def checked_files
+          FILES_CHECKED.map { |dir| directory_files(dir) }
+        end
+
+        # @return [Array<String>] array with list of files that we want to compare
+        def rspec_files
+          RSPEC_FILES.map { |dir| directory_files(dir) }
+        end
       end
     end
   end

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

@@ -4,6 +4,7 @@ module PolishGeeks
       # Command wrapper for Rubocop validation
       # It informs us if code is formatted in a proper way
       class Rubocop < Base
+        self.config_manager = ConfigManager.new('rubocop.yml')
         self.type = :validator
 
         # Regexp used to get number of inspected files
@@ -14,13 +15,10 @@ module PolishGeeks
         # Executes this command
         # @return [String] command output
         def execute
-          loc_config = File.join(DevTools.gem_root, 'config', 'rubocop.yml')
-          app_config = File.join(DevTools.app_root, '.rubocop.yml')
-
-          config = File.exist?(app_config) ? app_config : loc_config
-          cmd = "bundle exec rubocop -c #{config} #{PolishGeeks::DevTools.app_root}"
-
-          @output = Shell.new.execute(cmd)
+          cmd = ["bundle exec rubocop #{PolishGeeks::DevTools.app_root}"]
+          cmd << "-c #{self.class.config_manager.path}" if self.class.config_manager.present?
+          cmd << '--require rubocop-rspec' if Config.config.rubocop_rspec?
+          @output = Shell.new.execute(cmd.join(' '))
         end
 
         # @return [Boolean] true if there were no Rubocop offenses detected
@@ -30,7 +28,11 @@ module PolishGeeks
 
         # @return [String] default label for this command
         def label
-          "Rubocop (#{files_count} files, #{offenses_count} offenses)"
+          msg = []
+          msg << 'Rubocop'
+          msg << 'with RSpec' if Config.config.rubocop_rspec?
+          msg << "(#{files_count} files, #{offenses_count} offenses)"
+          msg.join(' ')
         end
 
         private

data/lib/{polishgeeks/dev-tools → polish_geeks/dev_tools}/config.rb

@@ -20,40 +20,48 @@ module PolishGeeks
         end
       end
 
-      attr_accessor :simplecov_threshold
-
       %i(
-        rspec_files_structure
-        expires_in_files
-        final_blank_line
-        empty_method
+        required_files_include
+        rspec_files_structure_ignored
+        expires_in_files_ignored
+        final_blank_line_ignored
+        empty_methods_ignored
+        simplecov_threshold
       ).each do |attr|
-        attr_accessor "#{attr}_ignored"
+        attr_accessor attr
       end
 
       # Available commands
       # All commands will be executed in this order (first rubocop, then rspec, etc)
       COMMANDS = %i(
-        readme
+        required_files
+        gemfile
         expires_in
+        examples_comparator
+        allowed_extensions
+        yml_parser
+        final_blank_line
         brakeman
         rubocop
-        final_blank_line
-        empty_method
+        bundler_audit
+        empty_methods
         haml_lint
-        allowed_extensions
-        yml_parser
         rspec_files_names
         rspec_files_structure
         tasks_files_names
         rspec
         simplecov
         yard
-        examples_comparator
         rubycritic
-      )
+      ).freeze
+
+      # Additional options for commands
+      COMMANDS_OPTIONS = %i(
+        rubocop_rspec
+        rspec_disallow_pending
+      ).freeze
 
-      COMMANDS.each do |attr_name|
+      (COMMANDS + COMMANDS_OPTIONS).each do |attr_name|
         attr_accessor attr_name
 
         # @return [Boolean] is given command enabled
@@ -65,7 +73,7 @@ module PolishGeeks
       # Initializes configuration and turn on by default
       # all the commands
       def initialize
-        COMMANDS.each do |attr_name|
+        (COMMANDS + COMMANDS_OPTIONS).each do |attr_name|
           public_send(:"#{attr_name}=", true)
         end
 

data/lib/polish_geeks/dev_tools/config_manager.rb

@@ -0,0 +1,68 @@
+module PolishGeeks
+  module DevTools
+    # Config manager which is able to check if config file exist either in local
+    # or application path
+    # @example
+    #   config_manager = ConfigManager.new('rubocop.yml')
+    #   config_manager.present? = true
+    #   config_manager.path = /home/pg/project/.rubocop.yml
+    class ConfigManager
+      def initialize(file_name)
+        @file_name = file_name
+      end
+
+      # @return [Boolean] true if there is a local or application config file present
+      def present?
+        application? || local?
+      end
+
+      # If there is an application config file use that, if not
+      # check if local config file is available if not return nil
+      # @return [String] path to config file or nil
+      # @example
+      #   /home/pg/project/.rubocop.yml
+      def path
+        application? ? application_path : local_path
+      end
+
+      private
+
+      # @return [Boolean] true if there is a config present locally
+      def local?
+        !@file_name.nil? && !local_path.nil?
+      end
+
+      # Provides path to local config file if it exists
+      # @return [String] path to local config file
+      def local_path
+        fetch_path(DevTools.gem_root)
+      end
+
+      # @return [Boolean] true if there is a config present in the application
+      def application?
+        !@file_name.nil? && !application_path.nil?
+      end
+
+      # Provides path to application config file if it exists
+      # @return [String] path to application config file
+      def application_path
+        fetch_path(DevTools.app_root)
+      end
+
+      # Searches for provided file name as well as one with dot in front of it
+      # in main directory and config subdirectory
+      # @return [String] path to config file if it exists
+      # @example
+      #   /home/pg/project/.rubocop.yml
+      def fetch_path(start_path)
+        ['', 'config'].each do |directory|
+          ['', '.'].each do |prefix|
+            path = File.join(start_path, directory, "#{prefix}#{@file_name}")
+            return path if File.exist?(path)
+          end
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/{polishgeeks/dev-tools → polish_geeks/dev_tools}/logger.rb

@@ -16,7 +16,7 @@ module PolishGeeks
           info(task)
         else
           fatal(task)
-          fail Errors::RequirementsError
+          raise Errors::RequirementsError
         end
       end
 
@@ -31,9 +31,9 @@ module PolishGeeks
         msg = 'GENERATED' if task.class.generator?
         msg = 'OK' if task.class.validator?
 
-        fail Errors::UnknownTaskType unless msg
+        raise Errors::UnknownTaskType unless msg
 
-        printf('%-40s %2s', "#{label(task)} ", "\e[32m#{msg}\e[0m\n")
+        printf('%-50s %2s', "#{label(task)} ", "\e[32m#{msg}\e[0m\n")
       end
 
       # Will print message when task did fail while running

data/lib/{polishgeeks/dev-tools → polish_geeks/dev_tools}/validators/base.rb

@@ -12,13 +12,13 @@ module PolishGeeks
         # This should be implemented in a subclass
         # @return [Boolean] if validation check is valid or not
         def valid?
-          fail Errors::NotImplementedError
+          raise 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?
+          raise Errors::PreCommandValidationError unless valid?
         end
       end
     end

data/lib/polish_geeks/dev_tools/validators/rubocop.rb

@@ -0,0 +1,12 @@
+module PolishGeeks
+  module DevTools
+    module Validators
+      # It verifies if Rubocop is enabled
+      class Rubocop < Base
+        def valid?
+          PolishGeeks::DevTools.config.rubocop == true
+        end
+      end
+    end
+  end
+end

data/lib/{polishgeeks/dev-tools → polish_geeks/dev_tools}/validators/simplecov.rb

@@ -7,7 +7,7 @@ module PolishGeeks
         MATCH_REGEXP = /\(\d+.\d+\%\) covered/
 
         def valid?
-          Object.const_defined?('SimpleCov') || (!output.nil? && output.length > 0)
+          Object.const_defined?('SimpleCov') || (!output.nil? && !output.empty?)
         end
 
         # Searches if we have SimpleCov hooked to rspec

data/lib/{polishgeeks/dev-tools → polish_geeks/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.1'
+    VERSION = '1.3.0'.freeze
   end
 end

data/lib/polishgeeks-dev-tools.rb

@@ -11,9 +11,9 @@
 %w(
   validators/base
   commands/base
-  commands/empty_method
-  commands/empty_method/string_refinements
-).each { |lib| require "polishgeeks/dev-tools/#{lib}" }
+  commands/empty_methods
+  commands/empty_methods/string_refinements
+).each { |lib| require "polish_geeks/dev_tools/#{lib}" }
 
 %w(
   *.rb
@@ -21,34 +21,9 @@
   commands/*.rb
   commands/**/*.rb
 ).each do |path|
-  base_path = File.dirname(__FILE__) + "/polishgeeks/dev-tools/#{path}"
+  base_path = File.dirname(__FILE__) + "/polish_geeks/dev_tools/#{path}"
   Dir[base_path].each { |file| require file }
 end
 
-module PolishGeeks
-  module DevTools
-    # This is just an alias so we can use it from DevTools directly
-    # @return [PolishGeeks::DevTools::Config.config]
-    def self.config
-      Config.config
-    end
-
-    # @return [String] root path of this gem
-    def self.gem_root
-      File.expand_path('../..', __FILE__)
-    end
-
-    # @return [String] app root path
-    def self.app_root
-      File.dirname(ENV['BUNDLE_GEMFILE'])
-    end
-
-    # Sets up the whole configuration
-    # @param [Block] block
-    def self.setup(&block)
-      Config.setup(&block)
-    end
-  end
-end
-
-load 'polishgeeks/dev-tools/tasks/dev-tools.rake'
+require 'polish_geeks/dev_tools'
+load 'polish_geeks/dev_tools/tasks/dev-tools.rake'