wearefine/maximus

module Maximus
  # Evaluates quality of security on a Rails site
  # @since 0.1.0
  class Brakeman < Maximus::Lint

    # Brakeman (requires Rails)
    # @see Lint#initialize
    def result
      @task = 'brakeman'
      @path = discover_path

      return unless is_rails? && temp_config(@task) && path_exists?(@path)

      tmp = Tempfile.new('brakeman')
      quietly { `brakeman #{@path} -f json -o #{tmp.path} -q` }
      brakeman = tmp.read
      tmp.close
      tmp.unlink

      unless brakeman.blank?
        bjson = JSON.parse(brakeman)
        basics(bjson)
        brakeman = {}
        ['warnings', 'errors'].each do |type|
          new_brakeman = bjson[type].group_by { |s| s['file'] }
          new_brakeman.each do |file, errors|
            next unless file
            brakeman[file] = errors.map { |e| hash_for_brakeman(e, type) }
          end
        end
      end

      @output[:files_inspected] ||= files_inspected('rb', ' ')
      refine brakeman
    end


    private

      # Convert to {file:README.md Maximus format}
      # @param error [Hash] lint error
      # @return [Hash]
      def hash_for_brakeman(error, type)
        {
          'linter' => error['warning_type'].delete(' '),
          'severity' => type.chomp('s'),
          'reason' => error['message'],
          'column' => 0,
          'line' => error['line'].to_i,
          'confidence' => error['confidence']
        }
      end

      # Pull out the general data brakeman provides
      # @since 0.1.6
      # @see #result
      # @param brakeman_data [Hash]
      def basics(brakeman_data)
        @output[:ignored_warnings] = brakeman_data['scan_info']['ignored_warnings']
        @output[:checks_performed] = brakeman_data['scan_info']['checks_performed']
        @output[:number_of_controllers] = brakeman_data['scan_info']['number_of_controllers']
        @output[:number_of_models] = brakeman_data['scan_info']['number_of_models']
        @output[:number_of_templates] = brakeman_data['scan_info']['number_of_templates']
        @output[:ruby_version] = brakeman_data['scan_info']['ruby_version']
        @output[:rails_version] = brakeman_data['scan_info']['rails_version']
      end

  end
end