polishgeeks-dev-tools 1.0.0

data/config/rubocop.yml

@@ -0,0 +1,35 @@
+AlignParameters:
+  Enabled: false
+ClassLength:
+  CountComments: false
+  Max: 200
+LineLength:
+  Max: 99
+MethodLength:
+  CountComments: false
+  Max: 15
+Metrics/AbcSize:
+  Max: 25
+AllCops:
+  Exclude:
+    - bin/**/*
+    - db/**/*
+    - .gemspec/**/*
+    - .bundle/**/*
+    - vendor/**/*
+    - config/**/*
+    - script/**/*
+    - !ruby/regexp /old_and_unused\.rb$/
+    - !ruby/regexp /polishgeeks-[^\/]{2,}\.rb/
+  Include:
+    - '**/Rakefile'
+    - config.ru
+    - lib/tasks/**/*.rake
+    - lib/tasks/**/*.rb
+    - lib/capistrano/**/*.rb
+    - lib/capistrano/**/*.cap
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  SupportedStyles:
+    - aligned
+    - indented

data/config/yardopts

@@ -0,0 +1,7 @@
+-o doc/yard
+- doc/*.md
+--title 'PolishGeeks Dev Tools documentation'
+--charset utf-8
+--markup markdown
+--private
+--protected

data/lib/polishgeeks-dev-tools.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+require 'yard'
+require 'pry'
+require 'fileutils'
+require 'timecop'
+require 'faker'
+require 'ostruct'
+
+base_path = File.dirname(__FILE__) + '/polishgeeks/dev-tools/*.rb'
+Dir[base_path].each { |file| require file }
+
+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
+
+require 'polishgeeks/dev-tools/command/base'
+
+commands_path = File.dirname(__FILE__) + '/polishgeeks/dev-tools/command/*.rb'
+Dir[commands_path].each { |file| require file }
+
+load 'polishgeeks/dev-tools/tasks/dev-tools.rake'

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

@@ -0,0 +1,62 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Checking config directory that all files are allowed
+      class AllowedExtensions < Base
+        self.type = :validator
+
+        # List of allowed extensions of files
+        ALLOWED_EXTENSIONS = %w(
+          rb
+          yml
+          rb.example
+          yml.example
+        )
+
+        # Executes this command
+        # @return [Array] command output array with list of
+        # not allowed files in config directory
+        def execute
+          results = Dir[config_path]
+
+          @output = results
+            .flatten
+            .map { |line| line.gsub!(PolishGeeks::DevTools.app_root + '/config/', '') }
+            .uniq
+          @output.delete_if do |line|
+            ALLOWED_EXTENSIONS.any? { |allow| line =~ /^.*\.#{allow}$/i }
+          end
+
+          @output
+        end
+
+        # @return [String] label with this validator description
+        def label
+          'Allowed Extensions'
+        end
+
+        # @return [String] error message that will be displayed if something
+        #   goes wrong
+        def error_message
+          err = 'Following files are not allowed in config directory:'
+          err << "\n\n"
+          err << @output.join("\n")
+          err << "\n"
+        end
+
+        # @return [Boolean] true if all files in config directory
+        # have correct extension
+        def valid?
+          @output.empty?
+        end
+
+        private
+
+        # @return [String] config path with all files included
+        def config_path
+          "#{File.expand_path(PolishGeeks::DevTools.app_root + '/config')}/*.*"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module PolishGeeks
+  module DevTools
+    # Module encapsulating all the commands that we use to check/verify code
+    module Command
+      # Base class for all the commands
+      # @abstract Subclass and use
+      class Base
+        # Raised when we specify a framework in which a given command can be executed
+        # and it is not present (not detected)
+        class MissingFramework < StandardError; end
+
+        attr_reader :output
+        # stored_output [PolishGeeks::DevTools::OutputStorer] storer with results of previous
+        #   commands (they might use output from previous/other commands)
+        attr_accessor :stored_output
+
+        # 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 )
+
+        class << self
+          attr_accessor :type
+          attr_accessor :framework
+
+          TYPES.each do |type|
+            # @return [Boolean] if it is a given type command
+            define_method :"#{type}?" do
+              self.type == type
+            end
+          end
+        end
+
+        # When we will try to use a given command, we need to check if it requires
+        # a given framework (Rails, Sinatra), if so, then we need to check if it is
+        # present, because without it a given command cannot run
+        def initialize
+          ensure_framework_if_required
+        end
+
+        # @raise [NotImplementedError] this should be implemented in a subclass
+        def execute
+          fail 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 NotImplementedError
+        end
+
+        # @return [String] what message should be printed when error occures
+        # @note By default the whole output of an executed command will be printed
+        def error_message
+          output
+        end
+
+        private
+
+        # Checks if a framework is required for a given command, and if so, it wont
+        # allow to execute this command if it is not present
+        # @raise [PolishGeeks::DevTools::Command::Base::MissingFramework] if req framework missing
+        def ensure_framework_if_required
+          return unless self.class.framework
+          return if PolishGeeks::DevTools.config.public_send(:"#{self.class.framework}?")
+
+          fail MissingFramework, self.class.framework
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # A static analysis security vulnerability scanner for Ruby on Rails applications
+      # @see https://github.com/presidentbeef/brakeman
+      class Brakeman < Base
+        self.type = :validator
+        self.framework = :rails
+
+        # Regexps to get some stat info from brakeman output
+        REGEXPS = {
+          controllers: /Controller.* (\d+)/,
+          models: /Model.* (\d+)/,
+          templates: /Template.* (\d+)/,
+          errors: /Error.* (\d+)/,
+          warnings: /Warning.* (\d+)/
+        }
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          @output = Shell.new.execute('bundle exec brakeman -q')
+        end
+
+        # @return [Boolean] true if we didn't have any vulnerabilities detected
+        def valid?
+          warnings == 0 && errors == 0
+        end
+
+        # @return [String] label with details bout brakeman scan
+        def label
+          "Brakeman (#{controllers} con, #{models} mod, #{templates} temp)"
+        end
+
+        REGEXPS.each do |name, regexp|
+          # @return [Integer] number of matches for given regexp
+          define_method(name) do
+            output.scan(regexp).flatten.first.to_i
+          end
+
+          private name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Command wrapper for Simple code coverage analysing
+      # It informs us if we didn't reach a proper code coverage level
+      class Coverage < Base
+        self.type = :validator
+
+        # Regexp used to match code coverage level
+        MATCH_REGEXP = /\(\d+.\d+\%\) covered/
+        # Regexp used to match float number from coverage
+        NUMBER_REGEXP = /(\d+[.]\d+)/
+
+        # @return [Float] code coverage level
+        def to_f
+          output[*NUMBER_REGEXP].to_f
+        end
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          @output = stored_output.rspec[*MATCH_REGEXP]
+        end
+
+        # @return [Boolean] true if code coverage level is higher or equal to expected
+        def valid?
+          to_f >= DevTools.config.simplecov_threshold
+        end
+
+        # @return [String] default label for this command
+        def label
+          "Coverage #{to_f}% covered - #{DevTools.config.simplecov_threshold}% required"
+        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}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Command wrapper for ExamplesComparator rake task
+      # It informs us if our .example files structure is the same as non-example once
+      class ExamplesComparator < Base
+        self.type = :validator
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          @output = "Comparing yaml structure of example files\n\n"
+
+          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
+          end
+        end
+
+        # @return [Boolean] true if all the example files have the same structure
+        #   as non-example once, false otherwise
+        def valid?
+          !output.include?('failed')
+        end
+
+        private
+
+        # @return [String] config path with all the yml.example files included
+        # @note This method is used in Dir[] to get all the example files
+        def config_path
+          "#{File.expand_path(PolishGeeks::DevTools.app_root + '/config')}/**/*.yml.example"
+        end
+
+        # @param [File] example_file which we compare with dedicated one
+        # @param [File] dedicated_file which is compared with example one
+        # @return [Boolean] true if the key structure is the same in both files
+        #   otherwise false
+        def same_key_structure?(example_file, dedicated_file)
+          yaml1 = PolishGeeks::DevTools::Hash.new
+          yaml1.merge!(YAML.load_file(example_file))
+          yaml2 = PolishGeeks::DevTools::Hash.new
+          yaml2.merge!(YAML.load_file(dedicated_file))
+
+          yaml1.same_key_structure?(yaml2)
+        end
+
+        # @param [File] example_file which we compare with dedicated one
+        # @param [File] dedicated_file which is compared with example one
+        # @return [String] success/failure (both) message header
+        def compare_header(example_file, dedicated_file)
+          "#{File.basename(example_file)} and #{File.basename(dedicated_file)}"
+        end
+
+        # @param [String] compare_header output message
+        # @return [String] success message for single file
+        def successful_compare(compare_header)
+          "\e[32m success\e[0m - #{compare_header}\n"
+        end
+
+        # @param [String] compare_header output message
+        # @return [String] failed message for single file
+        def failed_compare(compare_header)
+          "\e[31m failed\e[0m - #{compare_header} - structure not equal\n"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Checking Rails cache options especially expires_in
+      class ExpiresIn < Base
+        self.type = :validator
+
+        # List of dirs that we will check for
+        CHECKED_DIRS = %w(
+          app
+          lib
+        )
+
+        # Regexp that we want to use to catch invalid things that occur
+        # instead of expires_in
+        CHECKED_REGEXP = 'expire_in\|expir_in'
+
+        # Executes this command
+        def execute
+          results = CHECKED_DIRS.map do |directory|
+            path = File.join(PolishGeeks::DevTools.app_root, directory)
+            shell_command(path).split("\n")
+          end
+
+          @output = results
+            .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}/ }
+          end
+        end
+
+        # @return [String] label with this validator description
+        def label
+          'Expires in'
+        end
+
+        # @return [String] error message
+        def error_message
+          err = 'Following files use expire_in instead of expires_in:'
+          err << "\n\n"
+          err << @output.join("\n")
+          err << "\n"
+        end
+
+        # @return [Boolean] true if not find expire_in
+        def valid?
+          @output.empty?
+        end
+
+        # @return [Array<String>] list of files/directories that should be excluded from checking
+        # @note This should be set in the initializer for this gem in the
+        #   place where it is going to be used
+        def excludes
+          DevTools.config.expires_in_files_ignored || []
+        end
+
+        private
+
+        # @param [String] path in which we want to search
+        # @return [String] grep command that should be executed
+        #   to find what we search for
+        # @note Not every path must exist, thats why we redirect errors to /dev/null, that way
+        # we can skip all the errors
+        def shell_command(path)
+          `grep -R \"#{CHECKED_REGEXP}\" #{path}/* 2>/dev/null`
+        end
+      end
+    end
+  end
+end