<commit_before>module Homebrew
  module Style
    module_function

    # Checks style for a list of files, printing simple RuboCop output.
    # Returns true if violations were found, false otherwise.
    def check_style_and_print(files, options = {})
      check_style_impl(files, :print, options)
    end

    # Checks style for a list of files, returning results as a RubocopResults
    # object parsed from its JSON output.
    def check_style_json(files, options = {})
      check_style_impl(files, :json, options)
    end

    def check_style_impl(files, output_type, options = {})
      fix = options[:fix]

      Homebrew.install_gem_setup_path! "rubocop", HOMEBREW_RUBOCOP_VERSION
      Homebrew.install_gem! "rubocop-rspec"
      require "rubocop"
      require "rubocops"

      args = %w[
        --force-exclusion
      ]
      if fix
        args << "--auto-correct"
      else
        args << "--parallel"
      end

      if ARGV.verbose?
        args += ["--extra-details", "--display-cop-names"]
      end

      if options[:except_cops]
        options[:except_cops].map! { |cop| RuboCop::Cop::Cop.registry.qualified_cop_name(cop.to_s, "") }
        cops_to_exclude = options[:except_cops].select do |cop|
          RuboCop::Cop::Cop.registry.names.include?(cop) ||
            RuboCop::Cop::Cop.registry.departments.include?(cop.to_sym)
        end

        args << "--except" << cops_to_exclude.join(",") unless cops_to_exclude.empty?
      elsif options[:only_cops]
        options[:only_cops].map! { |cop| RuboCop::Cop::Cop.registry.qualified_cop_name(cop.to_s, "") }
        cops_to_include = options[:only_cops].select do |cop|
          RuboCop::Cop::Cop.registry.names.include?(cop) ||
            RuboCop::Cop::Cop.registry.departments.include?(cop.to_sym)
        end

        if cops_to_include.empty?
          odie "RuboCops #{options[:only_cops].join(",")} were not found"
        end

        args << "--only" << cops_to_include.join(",")
      end

      has_non_formula = Array(files).any? do |file|
        File.expand_path(file).start_with? HOMEBREW_LIBRARY_PATH
      end
      config_file = if files.nil? || has_non_formula
        HOMEBREW_LIBRARY_PATH/".rubocop.yml"
      else
        HOMEBREW_LIBRARY/".rubocop_audit.yml"
      end

      args << "--config" << config_file

      if files.nil?
        args << HOMEBREW_LIBRARY_PATH
      else
        args += files
      end

      cache_env = { "XDG_CACHE_HOME" => "#{HOMEBREW_CACHE}/style" }

      case output_type
      when :print
        args << "--debug" if ARGV.debug?
        args << "--display-cop-names" if ARGV.include? "--display-cop-names"
        args << "--format" << "simple" if files
        system(cache_env, "rubocop", "_#{HOMEBREW_RUBOCOP_VERSION}_", *args)
        !$CHILD_STATUS.success?
      when :json
        json, err, status =
          Open3.capture3(cache_env, "rubocop", "_#{HOMEBREW_RUBOCOP_VERSION}_",
                         "--format", "json", *args)
        # exit status of 1 just means violations were found; other numbers mean
        # execution errors.
        # exitstatus can also be nil if RuboCop process crashes, e.g. due to
        # native extension problems.
        # JSON needs to be at least 2 characters.
        if !(0..1).cover?(status.exitstatus) || json.to_s.length < 2
          raise "Error running `rubocop --format json #{args.join " "}`\n#{err}"
        end

        RubocopResults.new(JSON.parse(json))
      else
        raise "Invalid output_type for check_style_impl: #{output_type}"
      end
    end

    class RubocopResults
      def initialize(json)
        @metadata = json["metadata"]
        @file_offenses = {}
        json["files"].each do |f|
          next if f["offenses"].empty?

          file = File.realpath(f["path"])
          @file_offenses[file] = f["offenses"].map { |x| RubocopOffense.new(x) }
        end
      end

      def file_offenses(path)
        @file_offenses.fetch(path.to_s, [])
      end
    end

    class RubocopOffense
      attr_reader :severity, :message, :corrected, :location, :cop_name

      def initialize(json)<commit_msg>style: check Bash style with shellcheck<commit_after>module Homebrew
  module Style
    module_function

    # Checks style for a list of files, printing simple RuboCop output.
    # Returns true if violations were found, false otherwise.
    def check_style_and_print(files, options = {})
      check_style_impl(files, :print, options)
    end

    # Checks style for a list of files, returning results as a RubocopResults
    # object parsed from its JSON output.
    def check_style_json(files, options = {})
      check_style_impl(files, :json, options)
    end

    def check_style_impl(files, output_type, options = {})
      fix = options[:fix]

      Homebrew.install_gem_setup_path! "rubocop", HOMEBREW_RUBOCOP_VERSION
      Homebrew.install_gem! "rubocop-rspec"
      require "rubocop"
      require "rubocops"

      args = %w[
        --force-exclusion
      ]
      if fix
        args << "--auto-correct"
      else
        args << "--parallel"
      end

      if ARGV.verbose?
        args += ["--extra-details", "--display-cop-names"]
      end

      if options[:except_cops]
        options[:except_cops].map! { |cop| RuboCop::Cop::Cop.registry.qualified_cop_name(cop.to_s, "") }
        cops_to_exclude = options[:except_cops].select do |cop|
          RuboCop::Cop::Cop.registry.names.include?(cop) ||
            RuboCop::Cop::Cop.registry.departments.include?(cop.to_sym)
        end

        args << "--except" << cops_to_exclude.join(",") unless cops_to_exclude.empty?
      elsif options[:only_cops]
        options[:only_cops].map! { |cop| RuboCop::Cop::Cop.registry.qualified_cop_name(cop.to_s, "") }
        cops_to_include = options[:only_cops].select do |cop|
          RuboCop::Cop::Cop.registry.names.include?(cop) ||
            RuboCop::Cop::Cop.registry.departments.include?(cop.to_sym)
        end

        if cops_to_include.empty?
          odie "RuboCops #{options[:only_cops].join(",")} were not found"
        end

        args << "--only" << cops_to_include.join(",")
      end

      has_non_formula = Array(files).any? do |file|
        File.expand_path(file).start_with? HOMEBREW_LIBRARY_PATH
      end
      config_file = if files.nil? || has_non_formula
        HOMEBREW_LIBRARY_PATH/".rubocop.yml"
      else
        HOMEBREW_LIBRARY/".rubocop_audit.yml"
      end

      args << "--config" << config_file

      if files.nil?
        args << HOMEBREW_LIBRARY_PATH
      else
        args += files
      end

      cache_env = { "XDG_CACHE_HOME" => "#{HOMEBREW_CACHE}/style" }

      rubocop_success = false

      case output_type
      when :print
        args << "--debug" if ARGV.debug?
        args << "--display-cop-names" if ARGV.include? "--display-cop-names"
        args << "--format" << "simple" if files
        system(cache_env, "rubocop", "_#{HOMEBREW_RUBOCOP_VERSION}_", *args)
        rubocop_success = $CHILD_STATUS.success?
      when :json
        json, err, status =
          Open3.capture3(cache_env, "rubocop", "_#{HOMEBREW_RUBOCOP_VERSION}_",
                         "--format", "json", *args)
        # exit status of 1 just means violations were found; other numbers mean
        # execution errors.
        # exitstatus can also be nil if RuboCop process crashes, e.g. due to
        # native extension problems.
        # JSON needs to be at least 2 characters.
        if !(0..1).cover?(status.exitstatus) || json.to_s.length < 2
          raise "Error running `rubocop --format json #{args.join " "}`\n#{err}"
        end

        return RubocopResults.new(JSON.parse(json))
      else
        raise "Invalid output_type for check_style_impl: #{output_type}"
      end

      return !rubocop_success if !files.nil? && !has_non_formula

      shellcheck   = which("shellcheck")
      shellcheck ||= which("shellcheck", ENV["HOMEBREW_PATH"])
      shellcheck ||= begin
        ohai "Installing `shellcheck` for shell style checks..."
        system HOMEBREW_BREW_FILE, "install", "shellcheck"
        which("shellcheck") || which("shellcheck", ENV["HOMEBREW_PATH"])
      end
      unless shellcheck
        opoo "Could not find or install `shellcheck`! Not checking shell style."
        return !rubocop_success
      end

      shell_files = [
        HOMEBREW_BREW_FILE,
        *Pathname.glob("#{HOMEBREW_LIBRARY}/Homebrew/*.sh"),
        *Pathname.glob("#{HOMEBREW_LIBRARY}/Homebrew/cmd/*.sh"),
        *Pathname.glob("#{HOMEBREW_LIBRARY}/Homebrew/utils/*.sh"),
      ].select(&:exist?)
      # TODO: check, fix completions here too.
      # TODO: consider using ShellCheck JSON output
      shellcheck_success = system shellcheck, "--shell=bash", *shell_files
      !rubocop_success || !shellcheck_success
    end

    class RubocopResults
      def initialize(json)
        @metadata = json["metadata"]
        @file_offenses = {}
        json["files"].each do |f|
          next if f["offenses"].empty?

          file = File.realpath(f["path"])
          @file_offenses[file] = f["offenses"].map { |x| RubocopOffense.new(x) }
        end
      end

      def file_offenses(path)
        @file_offenses.fetch(path.to_s, [])
      end
    end

    class RubocopOffense
      attr_reader :severity, :message, :corrected, :location, :cop_name

      def initialize(json)
{'fraction_non_alphanumeric': 0.12308184143222506, 'fraction_numerical': 0.0014919011082693947, 'mean_word_length': 2.483667409057164, 'pattern_counts': {'":': 0, '<': 57, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3068133', 'n_tokens_mistral': 3057, 'n_tokens_neox': 2934, 'n_words': 654}