overcommit-jeygeethanmedia 0.53.1

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs 'sqlint' against any modified SQL files.
+  #
+  # @see https://github.com/purcell/sqlint
+  class Sqlint < Base
+    MESSAGE_REGEX = /(?<file>(?:\w:)?.+):(?<line>\d+):\d+:(?<type>\w+)/
+
+    MESSAGE_TYPE_CATEGORIZER = lambda do |type|
+      type == 'ERROR' ? :error : :warning
+    end
+
+    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,
+        MESSAGE_TYPE_CATEGORIZER
+      )
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `standard` against any modified JavaScript files.
+  #
+  # @see https://github.com/feross/standard
+  class Standard < Base
+    MESSAGE_REGEX = /^\s*(?<file>(?:\w:)?[^:]+):(?<line>\d+)/
+
+    def run
+      result = execute(command, args: applicable_files)
+      output = result.stdout.chomp
+      return :pass if result.success? && output.empty?
+
+      # example message:
+      #   path/to/file.js:1:1: Error message (ruleName)
+      extract_messages(
+        output.split("\n").grep(MESSAGE_REGEX), # ignore header line
+        MESSAGE_REGEX
+      )
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+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/swift_lint.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `swiftlint lint` against modified Swift files.
+  # @see https://github.com/realm/SwiftLint
+  class SwiftLint < Base
+    MESSAGE_REGEX = /^(?<file>(?:\w:)?[^:]+):(?<line>\d+)[^ ]* (?<type>[^ ]+):(?<message>.*)/
+
+    def run
+      result = execute(command, args: applicable_files)
+      return :pass if result.success?
+
+      extract_messages(
+        result.stdout.split("\n").grep(MESSAGE_REGEX),
+        MESSAGE_REGEX
+      )
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs 'terraform fmt' against any modified *.tf files.
+  #
+  # @see https://www.terraform.io/docs/commands/fmt.html
+  class TerraformFormat < Base
+    def run
+      messages = []
+      applicable_files.each do |f|
+        result = execute(command, args: [f])
+        unless result.success?
+          messages << Overcommit::Hook::Message.new(:error, f, nil, "violation found in #{f}")
+        end
+      end
+      messages
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Checks for trailing whitespace in files.
+  class TrailingWhitespace < Base
+    def run
+      result = execute(command, args: applicable_files)
+
+      extract_messages(
+        result.stdout.split("\n"),
+        /^(?<file>(?:\w:)?[^:]+):(?<line>\d+)/,
+      )
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `travis-lint` against any modified Travis CI files.
+  #
+  # @see https://github.com/travis-ci/travis.rb
+  class TravisLint < Base
+    def run
+      result = execute(command, args: applicable_files)
+      return :pass if result.success?
+
+      [:fail, (result.stdout + result.stderr).strip]
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `tslint` against modified TypeScript files.
+  # @see http://palantir.github.io/tslint/
+  class TsLint < Base
+    # example message:
+    # "src/file/anotherfile.ts[298, 1]: exceeds maximum line length of 140"
+    # or
+    # "ERROR: src/AccountController.ts[4, 28]: expected call-signature to have a typedef"
+    MESSAGE_REGEX = /^(?<type>.+: )?(?<file>.+?(?=\[))[^\d]+(?<line>\d+).*?/
+
+    def run
+      result = execute(command, args: applicable_files)
+      output = result.stdout.chomp
+      return :pass if result.success? && output.empty?
+
+      output_lines = output.split("\n").map(&:strip).reject(&:empty?)
+      type_categorizer = ->(type) { type.nil? || type.include?('ERROR') ? :error : :warning }
+
+      extract_messages(
+          output_lines,
+          MESSAGE_REGEX,
+          type_categorizer
+      )
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `vint` against any modified Vim script files.
+  #
+  # @see https://github.com/Kuniwak/vint
+  class Vint < Base
+    def run
+      result = execute(command, args: applicable_files)
+      return :pass if result.success?
+
+      return [:fail, result.stderr] unless result.stderr.empty?
+
+      # example message:
+      #   path/to/file.vim:1:1: Error message
+      extract_messages(
+        result.stdout.split("\n"),
+        /^(?<file>(?:\w:)?[^:]+):(?<line>\d+)/
+      )
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `w3c_validators` against any modified CSS files.
+  #
+  # @see https://github.com/alexdunae/w3c_validators
+  class W3cCss < Base
+    def run
+      collect_messages
+    rescue W3CValidators::ParsingError,
+           W3CValidators::ValidatorUnavailable => e
+      [:fail, e.message]
+    end
+
+    private
+
+    def collect_messages
+      applicable_files.collect do |path|
+        results = validator.validate_file(path)
+        messages = results.errors + results.warnings
+        messages.collect do |msg|
+          # Some warnings are not per-line, so use 0 as a default
+          line = Integer(msg.line || 0)
+
+          # Build message by hand to reduce noise from the validator response
+          text = "#{msg.type.to_s.upcase}; URI: #{path}; line #{line}: #{msg.message.strip}"
+          Overcommit::Hook::Message.new(msg.type, path, line, text)
+        end
+      end.flatten
+    end
+
+    def validator
+      unless @validator
+        @validator = W3CValidators::CSSValidator.new(opts)
+        @validator.set_language!(language) unless language.nil?
+        @validator.set_profile!(profile) unless profile.nil?
+        @validator.set_warn_level!(warn_level) unless warn_level.nil?
+      end
+      @validator
+    end
+
+    def opts
+      @opts ||= {
+        validator_uri: config['validator_uri'],
+        proxy_server:  config['proxy_server'],
+        proxy_port:    config['proxy_port'],
+        proxy_user:    config['proxy_user'],
+        proxy_pass:    config['proxy_pass']
+      }
+    end
+
+    def language
+      @language ||= config['language']
+    end
+
+    # Values specified at
+    #   http://www.rubydoc.info/gems/w3c_validators/1.2/W3CValidators#CSS_PROFILES
+    def profile
+      @profile ||= config['profile']
+    end
+
+    # One of 0, 1, 2, 'no'
+    def warn_level
+      @warn_level ||= config['warn_level']
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `w3c_validators` against any modified HTML files.
+  #
+  # @see https://github.com/alexdunae/w3c_validators
+  class W3cHtml < Base
+    def run
+      collect_messages
+    rescue W3CValidators::ParsingError,
+           W3CValidators::ValidatorUnavailable => e
+      [:fail, e.message]
+    end
+
+    private
+
+    def collect_messages
+      applicable_files.collect do |path|
+        results = validator.validate_file(path)
+        messages = results.errors + results.warnings
+        messages.collect do |msg|
+          # Some warnings are not per-line, so use 0 as a default
+          line = Integer(msg.line || 0)
+
+          # Build message by hand to reduce noise from the validator response
+          text = "#{msg.type.to_s.upcase}; URI: #{path}; line #{line}: #{msg.message.strip}"
+          Overcommit::Hook::Message.new(msg.type, path, line, text)
+        end
+      end.flatten
+    end
+
+    def validator
+      unless @validator
+        @validator = W3CValidators::MarkupValidator.new(opts)
+        @validator.set_charset!(charset, true) unless charset.nil?
+        @validator.set_doctype!(doctype, true) unless doctype.nil?
+        @validator.set_debug!
+      end
+      @validator
+    end
+
+    def opts
+      @opts ||= {
+        validator_uri: config['validator_uri'],
+        proxy_server:  config['proxy_server'],
+        proxy_port:    config['proxy_port'],
+        proxy_user:    config['proxy_user'],
+        proxy_pass:    config['proxy_pass']
+      }
+    end
+
+    # Values specified at
+    #   http://www.rubydoc.info/gems/w3c_validators/1.2/W3CValidators#CHARSETS
+    def charset
+      @charset ||= config['charset']
+    end
+
+    # Values specified at
+    #   http://www.rubydoc.info/gems/w3c_validators/1.2/W3CValidators#DOCTYPES
+    def doctype
+      @doctype ||= config['doctype']
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `xmllint` against any modified XML files.
+  #
+  # @see http://xmlsoft.org/xmllint.html
+  class XmlLint < Base
+    MESSAGE_REGEX = /^(?<file>(?:\w:)?[^:]+):(?<line>\d+):/
+
+    def run
+      result = execute(command, args: applicable_files)
+      output = result.stderr.chomp
+
+      return :pass if result.success? && output.empty?
+
+      # example message:
+      #   path/to/file.xml:1: parser error : Error message
+      extract_messages(
+        output.split("\n").grep(MESSAGE_REGEX),
+        MESSAGE_REGEX
+      )
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Checks the syntax of any modified XML files.
+  class XmlSyntax < Base
+    def run
+      messages = []
+
+      applicable_files.each do |file|
+        begin
+          REXML::Document.new(IO.read(file))
+        rescue REXML::ParseException => e
+          error = "Error parsing #{file}: #{e.message}"
+          messages << Overcommit::Hook::Message.new(:error, file, nil, error)
+        end
+      end
+
+      messages
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `YAMLLint` against any modified YAML files.
+  #
+  # @see https://github.com/adrienverge/yamllint
+  class YamlLint < Base
+    def run
+      result = execute(command, args: applicable_files)
+
+      if result.success?
+        :pass
+      else
+        return [:warn, result.stdout]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Checks the syntax of any modified YAML files.
+  class YamlSyntax < Base
+    def run
+      messages = []
+
+      applicable_files.each do |file|
+        begin
+          YAML.load_file(file)
+        rescue ArgumentError, Psych::SyntaxError => e
+          messages << Overcommit::Hook::Message.new(:error, file, nil, e.message)
+        end
+      end
+
+      messages
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+
+# frozen_string_literal: true
+
+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