overcommit 0.45.0 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f1f3224b8c51c6c50b52e986004d11874970a11b9c47780a6ae4c01b9df6ea6
-  data.tar.gz: 4fe8b023481b5e401232a89291a2a6b91223132d15be927568f30770ff9b5d1d
+  metadata.gz: f55e18f8852d00b8732b915daab20a7b37c28e60ee38dd35caacb091e0d87873
+  data.tar.gz: c75636dd8144cb6022b0400d1d5e1615cc1c27e765d32432332ee7b2701b1f66
 SHA512:
-  metadata.gz: 8b0824349ab9379be8b2ecd1d924ada6f920544a96b6bc84a257e349595c0df65c7e8900883a9928a2e8ca375f3a12efc181e2d5cad7612fdc86c5a44fbd9623
-  data.tar.gz: cfca38d75fee7228b335c2da2a33e34859d726e40dd8423bfaa60f464c79a0aabf7673cd991ab900cd0ed9c1159f76976aac5a24dfb01675348e38871190c9f8
+  metadata.gz: d8f0d7599c440d4389d19b94b558292f531d2832adf4846a104e2c033e3f0e12866b2f4febc444690ddc26fd245bd4146ff443c2fab5d49d2b44bec15b5befc8
+  data.tar.gz: 977649b8287f01bb7871db881583eac0490b68687cb1ab671612bb1d41e116b3efe45d39dbdec30909ca8dd49da00a9678674b1d1512c7cf5e35d20e5f2ea99f

data/config/default.yml

@@ -283,6 +283,16 @@ PreCommit:
     flags: ['-IEHnw']
     keywords: ['BROKEN', 'BUG', 'ERROR', 'FIXME', 'HACK', 'NOTE', 'OPTIMIZE', 'REVIEW', 'TODO', 'WTF', 'XXX']
 
+  Flay:
+    enabled: false
+    description: 'Analyze ruby code for structural similarities with Flay'
+    required_executable: 'flay'
+    install_command: 'gem install flay'
+    mass_threshold: 16
+    fuzzy: 1
+    liberal: false
+    include: '**/*.rb'
+
   Foodcritic:
     enabled: false
     description: 'Analyze with Foodcritic'
@@ -499,6 +509,15 @@ PreCommit:
     flags: ['--standard=PSR2', '--report=csv']
     include: '**/*.php'
 
+  PhpCsFixer:
+    enabled: false
+    description: 'Fix non compliant PHP files'
+    required_executable: 'php-cs-fixer'
+    command: 'vendor/bin/php-cs-fixer'
+    flags: ['fix', '-v', '--path-mode=intersection']
+    install_command: 'composer global require friendsofphp/php-cs-fixer'
+    include: '**/*.php'
+
   PhpStan:
     description: 'Analyze with phpstan'
     enabled: false
@@ -692,12 +711,22 @@ PreCommit:
     install_command: 'npm install -g standard'
     include: '**/*.js'
 
+  Stylelint:
+    enabled: false
+    description: 'Check styles with Stylelint'
+    require_executable: 'stylelint'
+    flags: ['-f', 'compact']
+    install_command: 'npm install -g stylelint'
+    include:
+      - '**/*.scss'
+      - '**/*.css'
+      - '**/*.less'
+
   TsLint:
       enabled: false
       description: 'Analyze with TSLint'
       required_executable: 'tslint'
       install_command: 'npm install -g tslint typescript'
-      flags: ['--t=prose']
       include: '**/*.ts'
 
   TrailingWhitespace:
@@ -786,6 +815,17 @@ PreCommit:
       - '**/*.yaml'
       - '**/*.yml'
 
+  YardCoverage:
+    enabled: false
+    description: 'Checking for yard coverage'
+    command: ['yard', 'stats', '--list-undoc', '--compact']
+    flags: ['--private', '--protected']
+    required_executable: 'yard'
+    install_command: 'gem install yard'
+    min_coverage_percentage: 100
+    include:
+      - '/**/*.rb'
+
   YarnCheck:
     enabled: false
     description: 'Check yarn.lock dependencies'

data/lib/overcommit/hook/pre_commit/credo.rb

@@ -8,7 +8,7 @@ module Overcommit::Hook::PreCommit
     # lib/file2.ex:12:81: R: Line is too long (max is 80, was 81).
 
     def run
-      result = execute command
+      result = execute(command, args: applicable_files)
       return :pass if result.success?
 
       result.stdout.split("\n").map(&:strip).reject(&:empty?).

data/lib/overcommit/hook/pre_commit/flay.rb

@@ -0,0 +1,36 @@
+module Overcommit::Hook::PreCommit
+  # Runs `flay` against any modified files.
+  #
+  # @see https://github.com/seattlerb/flay
+  class Flay < Base
+    # Flay prints two kinds of messages:
+    #
+    # 1) IDENTICAL code found in :defn (mass*2 = MASS)
+    # file_path_1.rb:LINE_1
+    # file_path_2.rb:LINE_2
+    #
+    # 2) Similar code found in :defn (mass = MASS)
+    # file_path_1.rb:LINE_1
+    # file_path_2.rb:LINE_2
+    #
+
+    def run
+      command = ['flay', '--mass', @config['mass_threshold'].to_s, '--fuzzy', @config['fuzzy'].to_s]
+      # Use a more liberal detection method
+      command += ['--liberal'] if @config['liberal']
+      messages = []
+      # Run the command for each file
+      applicable_files.each do |file|
+        result = execute(command, args: [file])
+        results = result.stdout.split("\n\n")
+        results.shift
+        unless results.empty?
+          error_message = results.join("\n").gsub(/^\d+\)\s*/, '')
+          message = Overcommit::Hook::Message.new(:error, nil, nil, error_message)
+          messages << message
+        end
+      end
+      messages
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/php_cs_fixer.rb

@@ -0,0 +1,55 @@
+module Overcommit::Hook::PreCommit
+  # Runs `php-cs-fixer` against any modified PHP files.
+  class PhpCsFixer < Base
+    MESSAGE_REGEX = /\s+\d+\)\s+(?<file>.*\.php)(?<violated_rules>\s+\(\w+(?:,\s+)?\))?/
+
+    def run
+      messages = []
+      feedback = ''
+
+      # Exit status for all of the runs. Should be zero!
+      exit_status_sum = 0
+
+      applicable_files.each do |file|
+        result = execute(command, args: [file])
+        output = result.stdout.chomp
+        exit_status_sum += result.status
+
+        if result.status
+          messages = output.lstrip.split("\n")
+        end
+      end
+
+      unless messages.empty?
+        feedback = parse_messages(messages)
+      end
+
+      :pass if exit_status_sum == 0
+      :pass if feedback.empty?
+
+      feedback
+    end
+
+    def parse_messages(messages)
+      output = []
+
+      messages.map do |message|
+        message.scan(MESSAGE_REGEX).map do |file, violated_rules|
+          type = :error
+          unless violated_rules.nil?
+            type = :warning
+          end
+          text = if type == :error
+                   "Cannot process #{file}: Syntax error"
+                 else
+                   "#{file} has been fixed"
+                 end
+
+          output << Overcommit::Hook::Message.new(type, file, 0, text)
+        end
+      end
+
+      output
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/stylelint.rb

@@ -0,0 +1,21 @@
+module Overcommit::Hook::PreCommit
+  # Runs `stylelint` against any modified CSS file.
+  #
+  # @see https://github.com/stylelint/stylelint
+  class Stylelint < Base
+    # example of output:
+    # index.css: line 4, col 4, error - Expected indentation of 2 spaces (indentation)
+
+    MESSAGE_REGEX = /^(?<file>.+):\D*(?<line>\d).*$/
+
+    def run
+      result = execute(command, args: applicable_files)
+      output = result.stdout.chomp
+      return :pass if result.success? && output.empty?
+      extract_messages(
+        output.split("\n"),
+        MESSAGE_REGEX
+      )
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/yard_coverage.rb

@@ -0,0 +1,88 @@
+
+module Overcommit::Hook::PreCommit
+  # Class to check yard documentation coverage.
+  #
+  # Use option "min_coverage_percentage" in your YardCoverage configuration
+  # to set your desired documentation coverage percentage.
+  #
+  class YardCoverage < Base
+    def run
+      # Run a no-stats yard command to get the coverage
+      args = flags + applicable_files
+      result = execute(command, args: args)
+
+      warnings_and_stats_text, undocumented_objects_text =
+        result.stdout.split('Undocumented Objects:')
+
+      warnings_and_stats = warnings_and_stats_text.strip.split("\n")
+
+      # Stats are the last 7 lines before the undocumented objects
+      stats = warnings_and_stats.slice(-7, 7)
+
+      # If no stats present (shouldn't happen), warn the user and end
+      if stats.class != Array || stats.length != 7
+        return [:warn, 'Impossible to read the yard stats. Please, check your yard installation.']
+      end
+
+      # Check the yard coverage
+      yard_coverage = check_yard_coverage(stats)
+      if yard_coverage == :warn
+        return [
+          :warn,
+          'Impossible to read yard doc coverage. Please, check your yard installation.'
+        ]
+      end
+      return :pass if yard_coverage == :pass
+
+      error_messages(yard_coverage, undocumented_objects_text)
+    end
+
+    private
+
+    # Check the yard coverage
+    #
+    # Return a :pass if the coverage is enough, :warn if it couldn't be read,
+    # otherwise, it has been read successfully.
+    #
+    def check_yard_coverage(stat_lines)
+      if config['min_coverage_percentage']
+        match = stat_lines.last.match(/^\s*([\d.]+)%\s+documented\s*$/)
+        unless match
+          return :warn
+        end
+
+        yard_coverage = match.captures[0].to_f
+        if yard_coverage >= config['min_coverage_percentage'].to_f
+          return :pass
+        end
+
+        yard_coverage
+      end
+    end
+
+    # Create the error messages
+    def error_messages(yard_coverage, error_text)
+      first_message = "You have a #{yard_coverage}% yard documentation coverage. "\
+                      "#{config['min_coverage_percentage']}% is the minimum required."
+
+      # Add the undocumented objects text as error messages
+      messages = [Overcommit::Hook::Message.new(:error, nil, nil, first_message)]
+
+      errors = error_text.strip.split("\n")
+      errors.each do |undocumented_object|
+        undocumented_object_message, file_info = undocumented_object.split(/:?\s+/)
+        file_info_match = file_info.match(/^\(([^:]+):(\d+)\)/)
+
+        # In case any compacted error does not follow the format, ignore it
+        if file_info_match
+          file = file_info_match.captures[0]
+          line = file_info_match.captures[1]
+          messages << Overcommit::Hook::Message.new(
+            :error, file, line, "#{file}:#{line}: #{undocumented_object_message}"
+          )
+        end
+      end
+      messages
+    end
+  end
+end

data/lib/overcommit/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.45.0'.freeze
+  VERSION = '0.46.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.45.0
+  version: 0.46.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-15 00:00:00.000000000 Z
+date: 2018-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -134,6 +134,7 @@ files:
 - lib/overcommit/hook/pre_commit/execute_permissions.rb
 - lib/overcommit/hook/pre_commit/fasterer.rb
 - lib/overcommit/hook/pre_commit/fix_me.rb
+- lib/overcommit/hook/pre_commit/flay.rb
 - lib/overcommit/hook/pre_commit/foodcritic.rb
 - lib/overcommit/hook/pre_commit/forbidden_branches.rb
 - lib/overcommit/hook/pre_commit/go_lint.rb
@@ -161,6 +162,7 @@ files:
 - lib/overcommit/hook/pre_commit/pep257.rb
 - lib/overcommit/hook/pre_commit/pep8.rb
 - lib/overcommit/hook/pre_commit/php_cs.rb
+- lib/overcommit/hook/pre_commit/php_cs_fixer.rb
 - lib/overcommit/hook/pre_commit/php_lint.rb
 - lib/overcommit/hook/pre_commit/php_stan.rb
 - lib/overcommit/hook/pre_commit/pronto.rb
@@ -186,6 +188,7 @@ files:
 - lib/overcommit/hook/pre_commit/slim_lint.rb
 - lib/overcommit/hook/pre_commit/sqlint.rb
 - lib/overcommit/hook/pre_commit/standard.rb
+- lib/overcommit/hook/pre_commit/stylelint.rb
 - lib/overcommit/hook/pre_commit/trailing_whitespace.rb
 - lib/overcommit/hook/pre_commit/travis_lint.rb
 - lib/overcommit/hook/pre_commit/ts_lint.rb
@@ -196,6 +199,7 @@ files:
 - lib/overcommit/hook/pre_commit/xml_syntax.rb
 - lib/overcommit/hook/pre_commit/yaml_lint.rb
 - lib/overcommit/hook/pre_commit/yaml_syntax.rb
+- lib/overcommit/hook/pre_commit/yard_coverage.rb
 - lib/overcommit/hook/pre_commit/yarn_check.rb
 - lib/overcommit/hook/pre_push/base.rb
 - lib/overcommit/hook/pre_push/brakeman.rb
@@ -277,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Git hook manager