shopify-cli 0.9.0

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

@@ -0,0 +1,115 @@
+require 'cli/kit'
+require 'English'
+
+module CLI
+  module Kit
+    class ErrorHandler
+      def initialize(log_file:, exception_reporter:, tool_name: nil)
+        @log_file = log_file
+        @exception_reporter_or_proc = exception_reporter || NullExceptionReporter
+        @tool_name = tool_name
+      end
+
+      module NullExceptionReporter
+        def self.report(_exception, _logs)
+          nil
+        end
+      end
+
+      def call(&block)
+        install!
+        handle_abort(&block)
+      end
+
+      def handle_exception(error)
+        if notify_with = exception_for_submission(error)
+          logs = begin
+            File.read(@log_file)
+          rescue => e
+            "(#{e.class}: #{e.message})"
+          end
+          exception_reporter.report(notify_with, logs)
+        end
+      end
+
+      # maybe we can get rid of this.
+      attr_writer :exception
+
+      private
+
+      def exception_for_submission(error)
+        case error
+        when nil         # normal, non-error termination
+          nil
+        when Interrupt   # ctrl-c
+          nil
+        when CLI::Kit::Abort, CLI::Kit::AbortSilent # Not a bug
+          nil
+        when SignalException
+          skip = %w(SIGTERM SIGHUP SIGINT)
+          skip.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
+
+      def install!
+        at_exit { handle_exception(@exception || $ERROR_INFO) }
+      end
+
+      def handle_abort
+        yield
+        CLI::Kit::EXIT_SUCCESS
+      rescue CLI::Kit::GenericAbort => e
+        is_bug    = e.is_a?(CLI::Kit::Bug) || e.is_a?(CLI::Kit::BugSilent)
+        is_silent = e.is_a?(CLI::Kit::AbortSilent) || e.is_a?(CLI::Kit::BugSilent)
+
+        print_error_message(e) unless is_silent
+        (@exception = e) if is_bug
+
+        CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
+      rescue Interrupt
+        $stderr.puts(format_error_message("Interrupt"))
+        CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
+      rescue Errno::ENOSPC
+        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
+        $stderr.puts(format_error_message(message))
+        CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
+      end
+
+      def exception_reporter
+        if @exception_reporter_or_proc.respond_to?(:report)
+          @exception_reporter_or_proc
+        else
+          @exception_reporter_or_proc.call
+        end
+      end
+
+      def format_error_message(msg)
+        CLI::UI.fmt("{{red:#{msg}}}")
+      end
+
+      def print_error_message(e)
+        $stderr.puts(format_error_message(e.message))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+require 'cli/kit'
+require 'English'
+require 'fileutils'
+
+module CLI
+  module Kit
+    class Executor
+      def initialize(log_file:)
+        FileUtils.mkpath(File.dirname(log_file))
+        @log_file = log_file
+      end
+
+      def call(command, command_name, args)
+        with_traps do
+          with_logging do |id|
+            begin
+              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
+      end
+
+      private
+
+      def with_logging(&block)
+        return yield unless @log_file
+        CLI::UI.log_output_to(@log_file) do
+          CLI::UI::StdoutRouter.with_id(on_streams: [CLI::UI::StdoutRouter.duplicate_output_to]) do |id|
+            block.call(id)
+          end
+        end
+      end
+
+      def with_traps
+        twrap('QUIT', method(:quit_handler)) do
+          twrap('INFO', method(:info_handler)) do
+            yield
+          end
+        end
+      end
+
+      def twrap(signal, handler)
+        return yield unless Signal.list.key?(signal)
+
+        begin
+          prev_handler = trap(signal, handler)
+          yield
+        ensure
+          trap(signal, prev_handler)
+        end
+      end
+
+      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
+
+      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,102 @@
+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
+      attr_accessor :ini
+
+      def initialize(path = nil, config: nil, default_section: nil, convert_types: true)
+        @config = if path && File.exist?(path)
+          File.readlines(path)
+        elsif config
+          config.lines
+        end
+        @ini = {}
+        @current_key = nil
+        @default_section = default_section
+        @convert_types = convert_types
+      end
+
+      def parse
+        return @ini if @config.nil?
+
+        @config.each do |l|
+          l.strip!
+
+          # If section, then set current key, this will nest the setting
+          if section_designator?(l)
+            @current_key = l
+
+          # A new line will reset the current key
+          elsif l.strip.empty?
+            @current_key = nil
+
+          # Otherwise set the values
+          else
+            k, v = l.split('=', 2).map(&:strip)
+            set_val(k, v)
+          end
+        end
+        @ini
+      end
+
+      def git_format
+        to_ini(@ini, git_format: true).flatten.join("\n")
+      end
+
+      def to_s
+        to_ini(@ini).flatten.join("\n")
+      end
+
+      private
+
+      def to_ini(h, git_format: false)
+        optional_tab = git_format ? "\t" : ""
+        str = []
+        h.each do |k, v|
+          if section_designator?(k)
+            str << "" unless str.empty? || git_format
+            str << k
+            str << to_ini(v, git_format: git_format)
+          else
+            str << "#{optional_tab}#{k} = #{v}"
+          end
+        end
+        str
+      end
+
+      def set_val(key, val)
+        return if key.nil? && val.nil?
+
+        current_key = @current_key || @default_section
+        if current_key
+          @ini[current_key] ||= {}
+          @ini[current_key][key] = typed_val(val)
+        else
+          @ini[key] = typed_val(val)
+        end
+      end
+
+      def typed_val(val)
+        return val.to_s unless @convert_types
+        return val.to_i if val =~ /^-?[0-9]+$/
+        return val.to_f if val =~ /^-?[0-9]+\.[0-9]*$/
+        val.to_s
+      end
+
+      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,82 @@
+# 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.
+
+module CLI
+  module Kit
+    module Levenshtein
+      # 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
+      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 = nil
+
+        # 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(
+              d[j + 1] + 1, # insertion
+              i + 1,      # deletion
+              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.
+      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,76 @@
+require 'logger'
+require 'fileutils'
+
+module CLI
+  module Kit
+    class Logger
+      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
+      def initialize(debug_log_file:)
+        FileUtils.mkpath(File.dirname(debug_log_file))
+        @debug_logger = ::Logger.new(debug_log_file, MAX_NUM_LOGS, MAX_LOG_SIZE)
+      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)
+      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)
+      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)
+      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)
+      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
+      def debug(msg)
+        $stdout.puts CLI::UI.fmt(msg) if ENV['DEBUG']
+        @debug_logger.debug(format_debug(msg))
+      end
+
+      private
+
+      def format_debug(msg)
+        msg = CLI::UI.fmt(msg)
+        return msg unless CLI::UI::StdoutRouter.current_id
+        "[#{CLI::UI::StdoutRouter.current_id[:id]}] #{msg}"
+      end
+    end
+  end
+end