gorails 0.1.2 → 0.1.5

data/vendor/deps/cli-kit/lib/cli/kit/error_handler.rb

@@ -0,0 +1,165 @@
+# typed: true
+require 'cli/kit'
+require 'English'
+
+module CLI
+  module Kit
+    class ErrorHandler
+      extend T::Sig
+
+      ExceptionReporterOrProc = T.type_alias do
+        T.any(T.class_of(ExceptionReporter), T.proc.returns(T.class_of(ExceptionReporter)))
+      end
+
+      sig { params(override_exception_handler: T.proc.params(arg0: Exception).returns(Integer)).void }
+      attr_writer :override_exception_handler
+
+      sig do
+        params(
+          log_file: T.nilable(String),
+          exception_reporter: ExceptionReporterOrProc,
+          tool_name: T.nilable(String),
+          dev_mode: T::Boolean,
+        ).void
+      end
+      def initialize(log_file: nil, exception_reporter: NullExceptionReporter, tool_name: nil, dev_mode: false)
+        @log_file = log_file
+        @exception_reporter_or_proc = exception_reporter
+        @tool_name = tool_name
+        @dev_mode = dev_mode
+      end
+
+      class ExceptionReporter
+        extend T::Sig
+        extend T::Helpers
+        abstract!
+
+        sig { abstract.params(exception: T.nilable(Exception), logs: T.nilable(String)).void }
+        def self.report(exception, logs = nil); end
+      end
+
+      class NullExceptionReporter < ExceptionReporter
+        extend T::Sig
+
+        sig { override.params(_exception: T.nilable(Exception), _logs: T.nilable(String)).void }
+        def self.report(_exception, _logs = nil)
+          nil
+        end
+      end
+
+      sig { params(block: T.proc.void).returns(Integer) }
+      def call(&block)
+        # @at_exit_exception is set if handle_abort decides to submit an error.
+        # $ERROR_INFO is set if we terminate because of a signal.
+        at_exit { report_exception(@at_exit_exception || $ERROR_INFO) }
+        triage_all_exceptions(&block)
+      end
+
+      sig { params(error: T.nilable(Exception)).void }
+      def report_exception(error)
+        if (notify_with = exception_for_submission(error))
+          logs = nil
+          if @log_file
+            logs = begin
+              File.read(@log_file)
+            rescue => e
+              "(#{e.class}: #{e.message})"
+            end
+          end
+          exception_reporter.report(notify_with, logs)
+        end
+      end
+
+      SIGNALS_THAT_ARENT_BUGS = [
+        'SIGTERM', 'SIGHUP', 'SIGINT',
+      ].freeze
+
+      private
+
+      # Run the program, handling any errors that occur.
+      #
+      # Errors are printed to stderr unless they're #silent?, and are reported
+      # to bugsnag (by setting @at_exit_exeption for our at_exit handler) if
+      # they're #bug?
+      #
+      # Returns an exit status for the program.
+      sig { params(block: T.proc.void).returns(Integer) }
+      def triage_all_exceptions(&block)
+        begin
+          block.call
+          CLI::Kit::EXIT_SUCCESS
+        rescue Interrupt => e # Ctrl-C
+          # transform message, prevent bugsnag
+          exc = e.exception('Interrupt')
+          CLI::Kit.raise(exc, bug: false)
+        rescue Errno::ENOSPC => e
+          # transform message, prevent bugsnag
+          message = if @tool_name
+            "Your disk is full - {{command:#{@tool_name}}} requires free space to operate"
+          else
+            'Your disk is full - free space is required to operate'
+          end
+          exc = e.exception(message)
+          CLI::Kit.raise(exc, bug: false)
+        end
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        @at_exit_exception = e if e.bug?
+
+        if (eh = @override_exception_handler)
+          return eh.call(e)
+        end
+
+        raise(e) if @dev_mode && e.bug?
+
+        stderr_puts(e.message) unless e.silent?
+        e.bug? ? CLI::Kit::EXIT_BUG : CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
+      end
+
+      sig { params(error: T.nilable(Exception)).returns(T.nilable(Exception)) }
+      def exception_for_submission(error)
+        # happens on normal non-error termination
+        return(nil) if error.nil?
+
+        return(nil) unless error.bug?
+
+        case error
+        when SignalException
+          SIGNALS_THAT_ARENT_BUGS.include?(error.message) ? nil : error
+        when SystemExit # "exit N" called
+          case error.status
+          when CLI::Kit::EXIT_SUCCESS # submit nothing if it was `exit 0`
+            nil
+          when CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
+            # if it was `exit 30`, translate the exit code to 1, and submit
+            # nothing. 30 is used to signal normal failures that are not
+            # indicative of bugs. However, users should see it presented as 1.
+            exit(1)
+          else
+            # A weird termination status happened. `error.exception "message"`
+            # will maintain backtrace but allow us to set a message
+            error.exception("abnormal termination status: #{error.status}")
+          end
+        else
+          error
+        end
+      end
+
+      sig { params(message: String).void }
+      def stderr_puts(message)
+        $stderr.puts(CLI::UI.fmt("{{red:#{message}}}"))
+      rescue Errno::EPIPE
+        nil
+      end
+
+      sig { returns(T.class_of(ExceptionReporter)) }
+      def exception_reporter
+        case @exception_reporter_or_proc
+        when Proc
+          @exception_reporter_or_proc.call
+        else
+          @exception_reporter_or_proc
+        end
+      end
+    end
+  end
+end

data/vendor/deps/cli-kit/lib/cli/kit/executor.rb

@@ -0,0 +1,99 @@
+# typed: true
+require 'cli/kit'
+require 'English'
+require 'fileutils'
+
+module CLI
+  module Kit
+    class Executor
+      extend T::Sig
+
+      sig { params(log_file: String).void }
+      def initialize(log_file:)
+        FileUtils.mkpath(File.dirname(log_file))
+        @log_file = log_file
+      end
+
+      sig { params(command: T.class_of(CLI::Kit::BaseCommand), command_name: String, args: T::Array[String]).void }
+      def call(command, command_name, args)
+        with_traps do
+          with_logging do |id|
+            command.call(args, command_name)
+          rescue => e
+            begin
+              $stderr.puts "This command ran with ID: #{id}"
+              $stderr.puts 'Please include this information in any issues/report along with relevant logs'
+            rescue SystemCallError
+              # Outputting to stderr is best-effort.  Avoid raising another error when outputting debug info so that
+              # we can detect and log the original error, which may even be the source of this error.
+              nil
+            end
+            raise e
+          end
+        end
+      end
+
+      private
+
+      sig do
+        type_parameters(:T).params(block: T.proc.params(id: String).returns(T.type_parameter(:T)))
+          .returns(T.type_parameter(:T))
+      end
+      def with_logging(&block)
+        CLI::UI.log_output_to(@log_file) do
+          CLI::UI::StdoutRouter.with_id(on_streams: [CLI::UI::StdoutRouter.duplicate_output_to].compact) do |id|
+            block.call(id)
+          end
+        end
+      end
+
+      sig { type_parameters(:T).params(block: T.proc.returns(T.type_parameter(:T))).returns(T.type_parameter(:T)) }
+      def with_traps(&block)
+        twrap('QUIT', method(:quit_handler)) do
+          twrap('INFO', method(:info_handler), &block)
+        end
+      end
+
+      sig do
+        type_parameters(:T).params(signal: String, handler: Method,
+          block: T.proc.returns(T.type_parameter(:T))).returns(T.type_parameter(:T))
+      end
+      def twrap(signal, handler, &block)
+        return yield unless Signal.list.key?(signal)
+
+        begin
+          begin
+            prev_handler = trap(signal, handler)
+            installed = true
+          rescue ArgumentError
+            # If we couldn't install a signal handler because the signal is
+            # reserved, remember not to uninstall it later.
+            installed = false
+          end
+          yield
+        ensure
+          trap(signal, prev_handler) if installed
+        end
+      end
+
+      sig { params(_sig: T.untyped).void }
+      def quit_handler(_sig)
+        z = caller
+        CLI::UI.raw do
+          $stderr.puts('SIGQUIT: quit')
+          $stderr.puts(z)
+        end
+        exit(CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG)
+      end
+
+      sig { params(_sig: T.untyped).void }
+      def info_handler(_sig)
+        z = caller
+        CLI::UI.raw do
+          $stderr.puts('SIGINFO:')
+          $stderr.puts(z)
+        end
+      end
+    end
+  end
+end

data/vendor/deps/cli-kit/lib/cli/kit/ini.rb

@@ -0,0 +1,94 @@
+# typed: true
+require 'cli/kit'
+
+module CLI
+  module Kit
+    # INI is a language similar to JSON or YAML, but simplied
+    # The spec is here: https://en.wikipedia.org/wiki/INI_file
+    # This parser includes supports for 2 very basic uses
+    # - Sections
+    # - Key Value Pairs (within and outside of the sections)
+    #
+    # [global]
+    # key = val
+    #
+    # Nothing else is supported right now
+    # See the ini_test.rb file for more examples
+    #
+    class Ini
+      extend T::Sig
+
+      sig { returns(T::Hash[String, T::Hash[String, String]]) }
+      attr_accessor :ini
+
+      sig do
+        params(path: T.nilable(String), config: T.nilable(String), default_section: String).void
+      end
+      def initialize(path = nil, config: nil, default_section: '[global]')
+        @config = if path && File.exist?(path)
+          File.readlines(path)
+        elsif config
+          config.lines
+        end
+        @ini = {}
+        @current_key = default_section
+      end
+
+      sig { returns(T::Hash[String, T::Hash[String, String]]) }
+      def parse
+        return @ini if @config.nil?
+
+        @config.each do |l|
+          l.strip!
+
+          if section_designator?(l)
+            @current_key = l
+          else
+            k, v = l.split('=', 2).map(&:strip)
+            set_val(k, v) if k && v
+          end
+        end
+
+        @ini
+      end
+
+      sig { returns(String) }
+      def git_format
+        to_ini(git_format: true)
+      end
+
+      sig { returns(String) }
+      def to_s
+        to_ini
+      end
+
+      private
+
+      sig { params(git_format: T::Boolean).returns(String) }
+      def to_ini(git_format: false)
+        optional_tab = git_format ? "\t" : ''
+        str = []
+        @ini.each do |section_designator, section|
+          str << '' unless str.empty? || git_format
+          str << section_designator
+          section.each do |k, v|
+            str << "#{optional_tab}#{k} = #{v}"
+          end
+        end
+        str.join("\n")
+      end
+
+      sig { params(key: String, val: String).void }
+      def set_val(key, val)
+        current_key = @current_key
+        @ini[current_key] ||= {}
+        @ini[current_key][key] = val
+      end
+
+      sig { params(k: String).returns(T::Boolean) }
+      def section_designator?(k)
+        k.start_with?('[') && k.end_with?(']')
+      end
+    end
+  end
+end

data/vendor/deps/cli-kit/lib/cli/kit/levenshtein.rb

@@ -0,0 +1,89 @@
+# typed: true
+# Copyright (c) 2014-2016 Yuki Nishijima
+
+# MIT License
+
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'cli/kit'
+
+module CLI
+  module Kit
+    module Levenshtein
+      extend T::Sig
+
+      # This code is based directly on the Text gem implementation
+      # Copyright (c) 2006-2013 Paul Battley, Michael Neumann, Tim Fletcher.
+      #
+      # Returns a value representing the "cost" of transforming str1 into str2
+      sig { params(str1: String, str2: String).returns(Integer) }
+      def distance(str1, str2)
+        n = str1.length
+        m = str2.length
+        return m if n.zero?
+        return n if m.zero?
+
+        d = (0..m).to_a
+        x = 0
+
+        # to avoid duplicating an enumerable object, create it outside of the loop
+        str2_codepoints = str2.codepoints
+
+        str1.each_codepoint.with_index(1) do |char1, i|
+          j = 0
+          while j < m
+            cost = char1 == str2_codepoints[j] ? 0 : 1
+            x = min3(
+              T.must(d[j + 1]) + 1, # insertion
+              i + 1, # deletion
+              T.must(d[j]) + cost # substitution
+            )
+            d[j] = i
+            i = x
+
+            j += 1
+          end
+          d[m] = x
+        end
+
+        x
+      end
+      module_function :distance
+
+      private
+
+      # detects the minimum value out of three arguments. This method is
+      # faster than `[a, b, c].min` and puts less GC pressure.
+      # See https://github.com/yuki24/did_you_mean/pull/1 for a performance
+      # benchmark.
+      sig { params(a: Integer, b: Integer, c: Integer).returns(Integer) }
+      def min3(a, b, c)
+        if a < b && a < c
+          a
+        elsif b < c
+          b
+        else
+          c
+        end
+      end
+      module_function :min3
+    end
+  end
+end

data/vendor/deps/cli-kit/lib/cli/kit/logger.rb

@@ -0,0 +1,95 @@
+# typed: true
+require 'cli/kit'
+require 'logger'
+require 'fileutils'
+
+module CLI
+  module Kit
+    class Logger
+      extend T::Sig
+
+      MAX_LOG_SIZE = 5 * 1024 * 1000 # 5MB
+      MAX_NUM_LOGS = 10
+
+      # Constructor for CLI::Kit::Logger
+      #
+      # @param debug_log_file [String] path to the file where debug logs should be stored
+      sig { params(debug_log_file: String, env_debug_name: String).void }
+      def initialize(debug_log_file:, env_debug_name: 'DEBUG')
+        FileUtils.mkpath(File.dirname(debug_log_file))
+        @debug_logger = ::Logger.new(debug_log_file, MAX_NUM_LOGS, MAX_LOG_SIZE)
+        @env_debug_name = env_debug_name
+      end
+
+      # Functionally equivalent to Logger#info
+      # Also logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      # @param debug [Boolean] determines if the debug logger will receive the log (default true)
+      sig { params(msg: String, debug: T::Boolean).void }
+      def info(msg, debug: true)
+        $stdout.puts CLI::UI.fmt(msg)
+        @debug_logger.info(format_debug(msg)) if debug
+      end
+
+      # Functionally equivalent to Logger#warn
+      # Also logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      # @param debug [Boolean] determines if the debug logger will receive the log (default true)
+      sig { params(msg: String, debug: T::Boolean).void }
+      def warn(msg, debug: true)
+        $stdout.puts CLI::UI.fmt("{{yellow:#{msg}}}")
+        @debug_logger.warn(format_debug(msg)) if debug
+      end
+
+      # Functionally equivalent to Logger#error
+      # Also logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      # @param debug [Boolean] determines if the debug logger will receive the log (default true)
+      sig { params(msg: String, debug: T::Boolean).void }
+      def error(msg, debug: true)
+        $stderr.puts CLI::UI.fmt("{{red:#{msg}}}")
+        @debug_logger.error(format_debug(msg)) if debug
+      end
+
+      # Functionally equivalent to Logger#fatal
+      # Also logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      # @param debug [Boolean] determines if the debug logger will receive the log (default true)
+      sig { params(msg: String, debug: T::Boolean).void }
+      def fatal(msg, debug: true)
+        $stderr.puts CLI::UI.fmt("{{red:{{bold:Fatal:}} #{msg}}}")
+        @debug_logger.fatal(format_debug(msg)) if debug
+      end
+
+      # Similar to Logger#debug, however will not output to STDOUT unless DEBUG env var is set
+      # Logs to the debug file, taking into account CLI::UI::StdoutRouter.current_id
+      #
+      # @param msg [String] the message to log
+      sig { params(msg: String).void }
+      def debug(msg)
+        $stdout.puts CLI::UI.fmt(msg) if debug?
+        @debug_logger.debug(format_debug(msg))
+      end
+
+      private
+
+      sig { params(msg: String).returns(String) }
+      def format_debug(msg)
+        msg = CLI::UI.fmt(msg)
+        return msg unless CLI::UI::StdoutRouter.current_id
+
+        "[#{CLI::UI::StdoutRouter.current_id&.fetch(:id, nil)}] #{msg}"
+      end
+
+      sig { returns(T::Boolean) }
+      def debug?
+        val = ENV[@env_debug_name]
+        !!val && val != '0' && val != ''
+      end
+    end
+  end
+end