polishgeeks-dev-tools 1.2.1 → 1.3.0

data/config/rubocop.yml

@@ -1,16 +1,5 @@
-AlignParameters:
-  Enabled: false
-ClassLength:
-  CountComments: false
-  Max: 200
-LineLength:
-  Max: 99
-MethodLength:
-  CountComments: false
-  Max: 15
-Metrics/AbcSize:
-  Max: 25
 AllCops:
+  TargetRubyVersion: 2.3
   Exclude:
     - bin/**/*
     - db/**/*
@@ -23,13 +12,24 @@ AllCops:
     - !ruby/regexp /polishgeeks-[^\/]{2,}\.rb/
   Include:
     - '**/Rakefile'
-    - config.ru
+    - '**/config.ru'
     - lib/tasks/**/*.rake
     - lib/tasks/**/*.rb
     - lib/capistrano/**/*.rb
     - lib/capistrano/**/*.cap
+AlignParameters:
+  Enabled: false
+ClassLength:
+  CountComments: false
+  Max: 200
+LineLength:
+  Max: 99
+MethodLength:
+  CountComments: false
+  Max: 15
+Metrics/AbcSize:
+  Max: 25
 Style/MultilineOperationIndentation:
   EnforcedStyle: indented
-  SupportedStyles:
-    - aligned
-    - indented
+
+inherit_from: rubocop_todo.yml

data/config/rubocop_todo.yml

@@ -0,0 +1,14 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-18 19:14:30 +0100 using RuboCop version 0.37.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 74
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: when_needed, always
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/lib/polish_geeks/dev_tools.rb

@@ -0,0 +1,26 @@
+module PolishGeeks
+  # Allows us to get config, gem_root, app_root and setup
+  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

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

@@ -11,7 +11,7 @@ module PolishGeeks
           yml
           rb.example
           yml.example
-        )
+        ).freeze
 
         # Executes this command
         # @return [Array] command output array with list of
@@ -20,9 +20,9 @@ module PolishGeeks
           results = Dir[config_path]
 
           @output = results
-            .flatten
-            .map { |line| line.gsub!(PolishGeeks::DevTools.app_root + '/config/', '') }
-            .uniq
+                    .flatten
+                    .map { |line| line.gsub!(PolishGeeks::DevTools.app_root + '/config/', '') }
+                    .uniq
           @output.delete_if do |line|
             ALLOWED_EXTENSIONS.any? { |allow| line =~ /^.*\.#{allow}$/i }
           end

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

@@ -14,9 +14,12 @@ module PolishGeeks
         # Available command types. We have validators that check something
         # and that should have a 'valid?' method and that check for errors, etc
         # and generators that are executed to generate some stats, docs, etc
-        TYPES = %i( validator generator )
+        TYPES = %i( validator generator ).freeze
 
         class << self
+          # ConfigManager instance can be provided, which allows us to find a
+          # config file for a command
+          attr_accessor :config_manager
           attr_accessor :type
           attr_accessor :validators
 
@@ -30,14 +33,14 @@ module PolishGeeks
 
         # @raise [NotImplementedError] this should be implemented in a subclass
         def execute
-          fail Errors::NotImplementedError
+          raise Errors::NotImplementedError
         end
 
         # @raise [NotImplementedError] this should be implemented in a subclass
         #   if it is a validator type (or no implementation required when
         #   it is a validator)
         def valid?
-          fail Errors::NotImplementedError
+          raise Errors::NotImplementedError
         end
 
         # @return [String] what message should be printed when error occures
@@ -57,6 +60,18 @@ module PolishGeeks
             validator_class.new(stored_output).validate!
           end
         end
+
+        private
+
+        # @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
       end
     end
   end

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

@@ -4,6 +4,7 @@ module PolishGeeks
       # A static analysis security vulnerability scanner for Ruby on Rails applications
       # @see https://github.com/presidentbeef/brakeman
       class Brakeman < Base
+        self.config_manager = ConfigManager.new('brakeman.yml')
         self.type = :validator
         self.validators = [
           Validators::Rails
@@ -16,12 +17,14 @@ module PolishGeeks
           templates: /Template.* (\d+)/,
           errors: /Error.* (\d+)/,
           warnings: /Warning.* (\d+)/
-        }
+        }.freeze
 
         # Executes this command
         # @return [String] command output
         def execute
-          @output = Shell.new.execute('bundle exec brakeman -q')
+          cmd = ['bundle exec brakeman -q']
+          cmd << "-c #{self.class.config_manager.path}" if self.class.config_manager.present?
+          @output = Shell.new.execute(cmd.join(' '))
         end
 
         # @return [Boolean] true if we didn't have any vulnerabilities detected

data/lib/polish_geeks/dev_tools/commands/bundler_audit.rb

@@ -0,0 +1,23 @@
+module PolishGeeks
+  module DevTools
+    module Commands
+      # Command wrapper for Bundler Audit
+      # Checks for vulnerable versions of gems in Gemfile.lock.
+      # @see https://github.com/rubysec/bundler-audit
+      class BundlerAudit < Base
+        self.type = :validator
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          @output = Shell.new.execute('bundle-audit update 2>&1 > /dev/null; bundle-audit check')
+        end
+
+        # @return [Boolean] true if there were no vulnerabilities found
+        def valid?
+          @output.match(/Unpatched versions found/).nil?
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ module PolishGeeks
   module DevTools
     module Commands
       # Validator used to check if all '.rb' files don't have empty methods
-      class EmptyMethod < Base
+      class EmptyMethods < Base
         self.type = :validator
 
         attr_reader :counter
@@ -17,7 +17,7 @@ module PolishGeeks
           public
           app/assets/images
           app/assets/fonts
-        )
+        ).freeze
 
         # Executes this command and set output and counter variables
         def execute
@@ -76,17 +76,7 @@ module PolishGeeks
 
         # @return [Array<String>] list of excluded files/directories from config file
         def config_excludes
-          DevTools.config.empty_method_ignored || []
-        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 }
+          DevTools.config.empty_methods_ignored || []
         end
 
         # @param [String] file name that we want to sanitize

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

@@ -1,7 +1,7 @@
 module PolishGeeks
   module DevTools
     module Commands
-      class EmptyMethod
+      class EmptyMethods
         # Parse file and search whether it contain empty methods
         class FileParser
           attr_reader :empty_methods

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

@@ -1,7 +1,7 @@
 module PolishGeeks
   module DevTools
     module Commands
-      class EmptyMethod
+      class EmptyMethods
         # Adds ability to check strings on specific regex matching
         module StringRefinements
           # Regex to determine commented or empty string
@@ -13,7 +13,7 @@ module PolishGeeks
           # Regex to determine end of method
           END_REGEX = /^\s*end(\.\w+(\s+|$)|\s*#.+|\s+|$)\s*/
           # Regex to determine begin of method definition through define_method
-          DEFINE_METHOD = '^\s*(define_method|define_singleton_method)'
+          DEFINE_METHOD = '^\s*(define_method|define_singleton_method)'.freeze
           # Regex to determine definition of method with do-end block
           DEFINE_METHOD_WITH_DO_END =
             /#{DEFINE_METHOD}(\s+|\().*do(\s*(\s*|.*\|\s*))(\s*|#.*)$/

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

@@ -13,14 +13,8 @@ module PolishGeeks
 
           Dir[config_path].each do |example_file|
             dedicated_file = example_file.gsub('.example', '')
-
             header = compare_header(example_file, dedicated_file)
-
-            if same_key_structure?(example_file, dedicated_file)
-              @output << successful_compare(header)
-            else
-              @output << failed_compare(header)
-            end
+            @output << compare_output(header, example_file, dedicated_file)
           end
         end
 
@@ -58,6 +52,18 @@ module PolishGeeks
           "#{File.basename(example_file)} and #{File.basename(dedicated_file)}"
         end
 
+        # @param [String] header output message
+        # @param [File] example_file which we compare with dedicated one
+        # @param [File] dedicated_file which is compared with example one
+        # @return [String] success/failure message for single file
+        def compare_output(header, example_file, dedicated_file)
+          if same_key_structure?(example_file, dedicated_file)
+            successful_compare(header)
+          else
+            failed_compare(header)
+          end
+        end
+
         # @param [String] compare_header output message
         # @return [String] success message for single file
         def successful_compare(compare_header)

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

@@ -9,11 +9,11 @@ module PolishGeeks
         CHECKED_DIRS = %w(
           app
           lib
-        )
+        ).freeze
 
         # Regexp that we want to use to catch invalid things that occur
         # instead of expires_in
-        CHECKED_REGEXP = 'expire_in\|expir_in'
+        CHECKED_REGEXP = 'expire_in\|expir_in'.freeze
 
         # Executes this command
         def execute
@@ -23,10 +23,10 @@ module PolishGeeks
           end
 
           @output = results
-            .flatten
-            .map { |line| line.split(':').first }
-            .map { |line| line.gsub!(PolishGeeks::DevTools.app_root, '') }
-            .uniq
+                    .flatten
+                    .map { |line| line.split(':').first }
+                    .map { |line| line.gsub!(PolishGeeks::DevTools.app_root, '') }
+                    .uniq
 
           @output.delete_if do |line|
             excludes.any? { |exclude| line =~ /#{exclude}/ }

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

@@ -19,7 +19,7 @@ module PolishGeeks
           app/assets/fonts
           .DS_Store
           .gem
-        )
+        ).freeze
 
         # Executes this command and set output and counter variables
         def execute
@@ -80,16 +80,6 @@ module PolishGeeks
           DevTools.config.final_blank_line_ignored || []
         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

data/lib/polish_geeks/dev_tools/commands/gemfile.rb

@@ -0,0 +1,39 @@
+module PolishGeeks
+  module DevTools
+    module Commands
+      # Checks if Gemfile contains local gems
+      class Gemfile < Base
+        self.type = :validator
+
+        # Regex which check if Gemfile has local gem
+        # ex:
+        #   gem 'example_gem', path: '/Users/Projects/gems/example_gem'
+        #   gem 'example_gem', :path => '/Users/Projects/gems/example_gem'
+        CHECKED_REGEXP = /^[^#]*((\bpath:)|(:path[ \t]*=>))/
+
+        # Executes this command
+        def execute
+          @output = []
+          gemfile = File.join(::PolishGeeks::DevTools.app_root, 'Gemfile')
+          return unless File.exist?(gemfile)
+          @output = IO.readlines(gemfile).select { |l| l.match(CHECKED_REGEXP) }
+        end
+
+        # @return [String] label with this validator description
+        def label
+          'Gemfile checking'
+        end
+
+        # @return [String] message with local gems
+        def error_message
+          "Gemfile contains gems from local path: \n#{output.join('')}"
+        end
+
+        # @return [Boolean] true if output doesn't contain any local gems
+        def valid?
+          @output.empty?
+        end
+      end
+    end
+  end
+end

data/lib/polish_geeks/dev_tools/commands/required_files.rb

@@ -0,0 +1,38 @@
+module PolishGeeks
+  module DevTools
+    module Commands
+      # Checks for required files
+      class RequiredFiles < Base
+        self.type = :validator
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          output = []
+          required_files = ['README.md']
+          required_files.concat(::PolishGeeks::DevTools.config.required_files_include || [])
+          required_files.each do |required_file|
+            file_path = File.join(::PolishGeeks::DevTools.app_root, required_file)
+            output << "#{file_path} not exist" unless File.exist?(file_path)
+            output << "#{file_path} is empty" if File.zero?(file_path)
+          end
+          @output = output
+        end
+
+        # @return [String] error message
+        def error_message
+          return if @output.nil?
+          err = 'Following files does not exist or are empty:'
+          err << "\n"
+          err << @output.join("\n")
+          err << "\n"
+        end
+
+        # @return [Boolean] true if files exist and are not empty
+        def valid?
+          @output.empty?
+        end
+      end
+    end
+  end
+end