greenhat 0.5.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80ae7c6dafc44e996d7caba2d749ece00fb6a278d4fc1e948d1b3809f2c00d3f
-  data.tar.gz: 1ffeef454c84a4786d443947b772702672a7a91285ac073a2798e6d973006da4
+  metadata.gz: 4787b5c739b568b8f6f5d22bab609f685ed4e4ed725085c432809102174e9dd5
+  data.tar.gz: 7fcedca5675835ae177c58418dc2ddcaf25bae27333aeea9430e5a36d92a0b01
 SHA512:
-  metadata.gz: fd728dee64de63c74f9e3505d79d723f67b167063fb6adb57108f1f61433a0f690c2dea4740e5e160520be710c190051318e695f98df1cdac23c6602ed5cf245
-  data.tar.gz: 1702b760383da6ee9a390876859fb0c4f9855b839edef562bdc9b4e0e5c97f8a939b25062bfcd8a907d7522b9229c26cbcf1b3886f5cd6057d0ab60656d60d4a
+  metadata.gz: c54a1054bd1c38b8514d4cd4c2b38f1c851a463134399c6c5c1af4c81ae9ffe6dbde083856b4dcabd1f09b9b68c5632240fdce5f135b5f8c763d5c72dc7047b0
+  data.tar.gz: 894307efe02d22b50a4a6ca8674700409611e24cf8b46b9653b7f4b24f242b65a0f1649f4fd881bc636c92afea4d42085043b4a8cf3c4662b4535127f9e70b85

data/lib/greenhat/archive.rb

@@ -62,7 +62,9 @@ module GreenHat
       when '.gz'
         `gzip -d "#{archive_path}"`
       when '.zip'
+        base_path = archive_path.gsub(File.basename(archive_path), '')
         `unzip -o -d "#{base_path}" #{archive_path}`
+        FileUtils.rm(archive_path)
       when '.bz2'
         `bzip2 -d #{archive_path}`
       when '.s'

data/lib/greenhat/cli.rb

@@ -35,8 +35,14 @@ module GreenHat
       @reader ||= reader_setup
     end
 
+    # Context matters on which ones to autocomplete / Not saving in memory to allow better tab / auto complete
     def self.files
-      @files ||= Thing.all.map(&:name).uniq
+      case current_location
+      when GreenHat::Shell::Log
+        Thing.all.select(&:log).map(&:name.uniq)
+      else
+        Thing.all.map(&:name).uniq
+      end
     end
 
     def self.reader_setup
@@ -314,6 +320,11 @@ module GreenHat
       @location = [spot]
     end
 
+    # Shell Context Location
+    def self.move_shell(spot)
+      @location = [GreenHat::Shell, spot]
+    end
+
     # Append to Location
     def self.submodule!
       spot = @list.shift
@@ -332,7 +343,6 @@ module GreenHat
     # Reader to Get Last Location's Available Methods / Keep Helper Methods
     def self.current_methods
       current_location.methods(false).map(&:to_s)
-      # .reject { |x| x.include? '_help' }
     end
 
     def self.current_submodules

data/lib/greenhat/entrypoint.rb

@@ -4,23 +4,25 @@ module GreenHat
   # Command Line Args / File Parsing etc
   module Entrypoint
     # If no arguments Supplied Print and quit - rather than nasty exception
-    def self.start(raw)
-      @clear = true # Reset screen by default
+    def self.start(raw, clear = true, cli = true)
+      @clear = clear # Reset screen by default
       Settings.start
       files, flags, args = Args.parse(raw)
       pre_args(flags, files)
       load_files files
       Cli.run_command(args) if args.any? { |arg| Cli.run_command?(arg) }
+
+      report_runner(args: args, files: files, raw: raw, flags: flags)
       post_args(flags)
       post_setup(flags)
 
-      Cli.start # Kick over to CLI
+      Cli.start if cli # Kick over to CLI
     end
 
     # Arguments before general processing
     def self.pre_args(flags, files)
       # Help
-      if flags?(%i[help h], flags)
+      if flags?(%i[help h], flags) && !ENV['GREENHAT_REPORT']
         cli_help
         exit 0
       end
@@ -53,30 +55,37 @@ module GreenHat
       end
     end
 
+    # Helper to allow running any kind of report with arguments directly with greenhat
+    def self.report_runner(args:, files:, raw:, flags:)
+      if flags.report || flags.r
+        GreenHat::Shell::Reports.default(['full'])
+        exit 0
+      end
+
+      # See if Param was passed
+      report = args.find { |x| %i[report r].include? x.field }
+      return false unless report
+
+      Cli.quiet! # Hush
+
+      # Filter for additional params for Reports
+      raw_filter = raw.reject do |entry|
+        entry.include?('--report') || files.include?(entry)
+      end
+
+      # Prepend report name
+      raw_filter.unshift(report.value)
+
+      GreenHat::Shell::Reports.default([report.value])
+
+      exit 0
+    end
+
     # Arguments to be handled after general processing
     def self.post_args(flags)
       # Supress Color
       GreenHat::Settings.settings[:color] = false if flags?(%i[no-color n], flags)
-
-      # Run report and exit / Don't Clear for reports
-      if flags?(%i[report r], flags)
-        Cli.quiet!
-        # Don't Use Pagination
-        GreenHat::Shell.report(['--raw'])
-        exit 0
-      elsif flags?(%i[full-report f], flags)
-        Cli.quiet!
-        # Don't Use Pagination
-        GreenHat::Shell.report(['--raw', '--full'])
-        exit 0
-      elsif flags?(%i[markdown m], flags)
-        Cli.quiet!
-        # Don't Use Pagination
-        GreenHat::Shell.markdown_report(['--raw'])
-        exit 0
-      elsif @clear
-        Cli.clear_screen
-      end
+      Cli.clear_screen if @clear
     end
 
     def self.post_setup(flags)
@@ -116,15 +125,9 @@ module GreenHat
 
       puts 'Options'.pastel(:yellow)
       puts '  --report, -r'.pastel(:green)
-      puts '    Run `report` against archives and exit'
-      puts
-
-      puts '  --full-report, -f'.pastel(:green)
-      puts '    Run `report` with all details. e.g. include fast-stats top/errors'
-      puts
-
-      puts '  --markdown, -m'.pastel(:green)
-      puts '    Run `markdown_report` against archives and exit'
+      puts '    Run default or specified `report` against archives and exit'
+      puts '    Default report "full", --report, --report=demo, --report=errors'
+      puts '    See reportable.md/wiki or the `reports` submodule'
       puts
 
       puts '  --quiet, -r'.pastel(:green)

data/lib/greenhat/logbot.rb

@@ -21,7 +21,7 @@ module LogBot
                 end
     end
 
-    puts output unless ENV['TESTING'] || GreenHat::Cli.quiet
+    puts output unless ENV.fetch('TESTING') { GreenHat::Cli.quiet }
   end
 
   def self.color_level(level)

data/lib/greenhat/paper/flag_helper.rb

@@ -0,0 +1,18 @@
+module GreenHat
+  # Helpers for Paper Render
+  module PaperFlagHelper
+    # --------------------------------------------------------------------------
+    def truncate
+      flags[:truncate]
+    end
+
+    def table_style
+      flags[:table_style]&.to_sym || :unicode
+    end
+
+    def stats
+      flags[:stats]
+    end
+    # --------------------------------------------------------------------------
+  end
+end

data/lib/greenhat/paper/paper_helper.rb

@@ -0,0 +1,118 @@
+module GreenHat
+  # Helpers for Paper Render
+  module PaperHelpers
+    # =========================================================================
+    # Entrypoint
+    # =========================================================================
+    def process
+      LogBot.debug('Entry Show', data.class) if ENV['DEBUG']
+      case data
+      when Hash then render_table
+      when Float, Integer
+        self.output = format_table_entry(data)
+        # Ignore Special Formatting for Strings / Usually already formatted
+      when String
+        self.output = data
+      when Array
+        # Check for Nested Arrays (Array Table)
+        if data.first.instance_of? Array
+          render_array_table(data)
+        else
+          self.output = data
+        end
+      else
+        LogBot.warn('Shell Show', "Unknown #{data.class}")
+        self.output = data
+      end
+    end
+
+    # --------------------------------------------------------------------------
+    def render_table
+      formatted = data.to_h { |key, entry| [key, format_table_entry(entry, key)] }
+
+      # Pre-format Entry
+      table = TTY::Table.new(header: formatted.keys, rows: [formatted], orientation: :vertical)
+
+      LogBot.debug('Rendering Entries') if ENV['DEBUG']
+      self.output = table.render(table_style, padding: [0, 1, 0, 1], multiline: true) do |renderer|
+        renderer.border.style = :cyan
+      end
+
+      # Line breaks for basic tables
+      self.output += "\n" if table_style == :basic
+    rescue StandardError => e
+      if ENV['DEBUG']
+        LogBot.warn('Table', message: e.message)
+        ap e.backtrace
+      end
+
+      self.output = [
+        data.ai,
+        ('_' * (TTY::Screen.width / 3)).pastel(:cyan),
+        "\n"
+      ].join("\n")
+    end
+
+    # --------------------------------------------------------------------------
+    # Format Table Entries
+    def format_table_entry(entry, key = nil)
+      formatted_entry = case entry
+                        # Rounding
+                        when Float, Integer || entry.numeric?
+                          flags.key?(:round) ? entry.to_f.round(flags.round).ai : entry.ai
+
+                        # General Inspecting
+                        when Hash then entry.ai(ruby19_syntax: true)
+
+                        # Arrays often contain Hashes. Dangerous Recursive?
+                        when Array
+                          entry.map { |x| format_table_entry(x) }.join("\n")
+                        when Time
+                          entry.to_s.pastel(:bright_white)
+
+                        # Default String Formatting
+                        else
+                          ShellHelper::StringColor.do(key, entry)
+                        end
+
+      # Stats truncation handled separately
+      if truncate && !stats
+        entry_truncate(formatted_entry)
+      else
+        formatted_entry
+      end
+    rescue StandardError => e
+      if ENV['DEBUG']
+        LogBot.warn('Table Format Entry', message: e.message)
+        ap e.backtrace
+      end
+    end
+
+    # --------------------------------------------------------------------------
+    def entry_truncate(entry)
+      # Ignore if Truncation Off
+      return entry if truncate.zero?
+
+      # Only truncate large strings
+      return entry unless entry.instance_of?(String) && entry.size > truncate
+
+      # Include  '...' to indicate truncation
+      "#{entry.to_s[0..truncate]} #{'...'.pastel(:bright_blue)}"
+    end
+
+    # --------------------------------------------------------------------------
+    def render_array_table(entry)
+      header, rows = entry
+      table = TTY::Table.new(header: header, rows: rows)
+
+      LogBot.debug('Rendering Entries') if ENV['DEBUG']
+      self.output = table.render(table_style, padding: [0, 1, 0, 1], multiline: true) do |renderer|
+        renderer.border.style = :cyan
+      end
+
+      # Line breaks for basic tables
+      self.output += "\n" if table_style == :basic
+    end
+    # --------------------------------------------------------------------------
+  end
+end

data/lib/greenhat/paper.rb

@@ -0,0 +1,34 @@
+module GreenHat
+  # Output Helper
+  class Paper
+    include PaperHelpers
+    include PaperFlagHelper
+    attr_accessor :task, :output, :flags, :data, :done, :mutex
+
+    def initialize(data:, flags:)
+      self.mutex = Mutex.new
+      self.data = data
+      self.flags = flags
+    end
+
+    def async
+      return if done # Don't attempt lock if already done
+
+      mutex.synchronize do
+        return if done # Turn if was waiting on lock
+
+        process
+
+        self.output ||= '' # If Empty
+
+        self.done = true
+      end
+    end
+
+    def render
+      async unless done
+
+      output
+    end
+  end
+end

data/lib/greenhat/reports/builder.rb

@@ -0,0 +1,98 @@
+# GreenHat Namespace
+module GreenHat
+  # Reports Parent Class
+  module Reports
+    # Used for within GreenHat Use
+    class Builder
+      include GreenHat::Reports::Shared
+
+      attr_accessor :store, :flags, :args
+
+      def initialize(file:, flags:, args:)
+        self.store = []
+        self.flags = flags
+        self.args = args
+        instance_eval File.read(file)
+      rescue StandardError => e
+        print "#{e.message}\n"
+        print e.backtrace[0..4].join("\n").pastel(:red)
+      end
+
+      # Adding Methods
+      def add(*params)
+        store.push params
+      end
+
+      # ------------------------------------------------------------------------
+      # Store Methods
+      # ------------------------------------------------------------------------
+
+      def quiet!
+        GreenHat::Cli.quiet!
+      end
+
+      def no_prompt!
+        # TODO: Should this do anything?
+      end
+
+      # Default Header
+      def header(text, color = :bright_yellow)
+        add(:header, text, color)
+      end
+
+      # Archive Header
+      def archive_header(color = :blue)
+        add(:archive_header, color)
+      end
+
+      # Raw
+      def cat(name, show_output = true, &block)
+        add(:cat, name, show_output, block)
+      end
+
+      # Parsed
+      def info(name, show_output = true, &block)
+        add(:info, name, show_output, block)
+      end
+
+      # New Line Helepr
+      def br
+        add :br
+      end
+
+      def puts(text = '')
+        add :puts, text
+      end
+
+      # Helper to Print GitLab Version
+      def gitlab_version
+        add :gitlab_version
+      end
+
+      # Help
+      def help(&block)
+        add(:help, block)
+      end
+
+      def show(text = '')
+        add :show, text
+      end
+
+      # Log Query
+      def query(query, show_output = true, &block)
+        add(:query, query, show_output, block)
+      end
+
+      # Log Query / Assume Format
+      def query_format(query, show_output = true, &block)
+        add(:query_format, query, show_output, block)
+      end
+
+      # FastStats Helper
+      def faststats(query, subcmd = '')
+        add(:faststats, query, subcmd)
+      end
+      # ------------------------------------------------------------------------
+    end
+  end
+end

data/lib/greenhat/reports/helpers.rb

@@ -0,0 +1,101 @@
+# Disable for executor
+# rubocop:disable Style/MixinUsage
+include ActionView::Helpers::DateHelper
+include ActionView::Helpers::NumberHelper
+include GreenHat::Reports::Shared
+# rubocop:enable Style/MixinUsage
+
+def add(*params)
+  GreenHat::Reports.add(*params)
+end
+
+# ==============================================================================
+# General Report Helpers
+# ==============================================================================
+# Supress output
+def quiet!
+  GreenHat::Cli.quiet!
+end
+
+# Supress output
+def page(value = true)
+  ENV['GREENHAT_PAGE'] = value == true ? 'true' : 'false'
+end
+
+# Attempt Autoload raw/json
+def no_prompt!
+  Settings.settings[:assume_raw] = true
+end
+
+# Default Header
+def header(text, color = :bright_yellow)
+  add(:header, text, color)
+end
+
+# Archive Header
+def archive_header(color = :blue)
+  add(:archive_header, color)
+end
+
+# Raw
+def cat(name, show_output = true, &block)
+  add(:cat, name, show_output, block)
+end
+
+# Parsed
+def info(name, show_output = true, &block)
+  add(:info, name, show_output, block)
+end
+
+# Log Query
+def query(query, show_output = true, &block)
+  add(:query, query, show_output, block)
+end
+
+# Log Query / Assume Format
+def query_format(query, show_output = true, &block)
+  add(:query_format, query, show_output, block)
+end
+
+# FastStats Helper
+def faststats(query, subcmd = '')
+  add(:faststats, query, subcmd)
+end
+
+# New Line Helper
+def br
+  add :br
+end
+
+def puts(text = '')
+  add :puts, text
+end
+
+def show(text = '')
+  add :show, text
+end
+
+# Help
+def help(&block)
+  add(:help, block)
+end
+
+# Helper to Print GitLab Version
+def gitlab_version
+  add :gitlab_version
+end
+
+# =================================================================
+# These are here to allow flags/args to be used outside of blocks
+# =================================================================
+def args
+  _file_list, _flags, args = GreenHat::Args.parse(ARGV)
+  args
+end
+
+def flags
+  _file_list, flags, _args = GreenHat::Args.parse(ARGV)
+
+  flags
+end
+# =================================================================

data/lib/greenhat/reports/internal_methods.rb

@@ -0,0 +1,156 @@
+# GreenHat Namespace
+module GreenHat
+  # Reports Parent Class
+  module Reports
+    # Method Helper Module
+    module InternalMethods
+      # Archive Header Printer
+      def archive_header(color = :blue)
+        puts archive.friendly_name.pastel(color)
+      end
+
+      # Header Printer
+      def header(text, color = :bright_yellow, bold = :bold)
+        puts text.pastel(color, bold)
+      end
+
+      # Raw Print
+      def cat(name, show_output, block)
+        thing = archive.thing? name
+        return unless thing
+
+        output = instance_exec(thing.raw_full, &block)
+        show output if show_output
+      end
+
+      # Parsed Print
+      def info(name, show_output, block)
+        thing = archive.thing? name
+        return unless thing
+
+        output = instance_exec(thing.data, &block)
+        show output if show_output
+      end
+
+      # Help
+      def help(block)
+        instance_exec(&block)
+      end
+
+      # Log Query
+      def query(query, show_output, block)
+        files, query_flags, query_args = GreenHat::Args.parse(Shellwords.split(query))
+        query_flags[:archive] = [archive.name] # Limit query to archive
+        query_flags[:combine] = true
+
+        # Default to everything
+        files = archive.things if files.empty?
+
+        results = Query.start(files, query_flags, query_args)
+
+        # Print and Exit of No Block / Show
+        return show(results) if block.nil? && show_output
+
+        output = instance_exec(results, &block)
+        show output if show_output
+      end
+
+      # Log Query / Assume Format
+      def query_format(query, show_output, block)
+        files, query_flags, query_args = GreenHat::Args.parse(Shellwords.split(query))
+        query_flags[:archive] = [archive.name] # Limit query to archive
+        query_flags[:combine] = true
+
+        # Default to everything
+        query_flags = archive.things if files.empty?
+
+        # Filter
+        results = GreenHat::Query.start(files, query_flags, query_args)
+
+        # Print and Exit of No Block / Show
+        return show(results) if block.nil? && show_output
+
+        block_output = instance_exec(results, &block)
+        show block_output if show_output
+      end
+
+      def faststats(raw, subcmd)
+        return true unless TTY::Which.exist? 'fast-stats'
+
+        files, _flags, cmd = ShellHelper::Faststats.parse(Shellwords.split(raw))
+
+        results = ShellHelper.file_process(files) do |file|
+          output = `fast-stats #{subcmd} #{cmd} #{file.file} 2>&1`
+          result = $CHILD_STATUS.success?
+
+          next unless result
+
+          [
+            file.name.pastel(:green),
+            output.split("\n"),
+            "\n"
+          ]
+        end
+
+        show results.compact.flatten
+      end
+
+      # TODO
+      # results = GreenHat::ShellHelper::Faststats.run(thing, 'top') # JSON FORMAT
+
+      # Paper Render Helper
+      def show(value)
+        if value.instance_of?(Array)
+          value.each do |x|
+            output.push GreenHat::Paper.new(data: x, flags: flags).render
+          end
+        else
+          output.push GreenHat::Paper.new(data: value, flags: flags).render
+        end
+      end
+
+      # Line Break Helper
+      def br(_ = nil)
+        puts
+      end
+
+      # Store for potential Paginated Response
+      def puts(text = '')
+        output.push text
+      end
+
+      # Accessor Helper
+      def archive
+        archive
+      end
+
+      def gitlab_version
+        thing = archive.thing? 'gitlab/version-manifest.json'
+        return unless thing
+
+        puts "#{'GitLab Version'.pastel(:cyan)}: #{thing.data.build_version}"
+      end
+
+      # ==============================================================================
+      # General Helpers
+      # ==============================================================================
+      # Indentation Helper
+      def indent(text, indent_value = 2)
+        if indent_value.zero?
+          text
+        else
+          "#{' ' * indent_value}#{text}"
+        end
+      end
+
+      def percent(value, total)
+        ((value / total.to_f) * 100).round
+      end
+
+      # Number Helper
+      def human_size_to_number(value)
+        GreenHat::ShellHelper.human_size_to_number value
+      end
+    end
+  end
+end