pantograph 0.1.0

data/pantograph_core/lib/pantograph_core/ui/errors/pantograph_exception.rb

@@ -0,0 +1,19 @@
+module PantographCore
+  class Interface
+    class PantographException < StandardError
+      def prefix
+        '[PANTOGRAPH_EXCEPTION]'
+      end
+
+      def caused_by_calling_ui_method?(method_name: nil)
+        return false if backtrace.nil? || backtrace[0].nil? || method_name.nil?
+        first_frame = backtrace[0]
+        if first_frame.include?(method_name) && first_frame.include?('interface.rb')
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/pantograph_core/lib/pantograph_core/ui/errors/pantograph_shell_error.rb

@@ -0,0 +1,11 @@
+require_relative 'pantograph_exception'
+
+module PantographCore
+  class Interface
+    class PantographShellError < PantographException
+      def prefix
+        '[SHELL_ERROR]'
+      end
+    end
+  end
+end

data/pantograph_core/lib/pantograph_core/ui/errors.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + "/errors/*.rb"].each { |f| require_relative f }

data/pantograph_core/lib/pantograph_core/ui/github_issue_inspector_reporter.rb

@@ -0,0 +1,62 @@
+require_relative '../helper'
+require_relative '../globals'
+
+module Pantograph
+  # Adds all the necessary emojis (obv)
+  #
+  class InspectorReporter
+    NUMBER_OF_ISSUES_INLINE = 3
+
+    # Called just as the investigation has begun.
+    def inspector_started_query(query, inspector)
+      puts("")
+      puts("Looking for related GitHub issues on #{inspector.repo_owner}/#{inspector.repo_name}...")
+      puts("Search query: #{query}") if PantographCore::Globals.verbose?
+      puts("")
+    end
+
+    # Called once the inspector has received a report with more than one issue.
+    def inspector_successfully_received_report(report, inspector)
+      report.issues[0..(NUMBER_OF_ISSUES_INLINE - 1)].each { |issue| print_issue_full(issue) }
+
+      if report.issues.count > NUMBER_OF_ISSUES_INLINE
+        report.url.sub!('\'', '%27')
+        puts("and #{report.total_results - NUMBER_OF_ISSUES_INLINE} more at: #{report.url}")
+        puts("")
+      end
+
+      print_open_link_hint
+    end
+
+    # Called once the report has been received, but when there are no issues found.
+    def inspector_received_empty_report(report, inspector)
+      puts("Found no similar issues. To create a new issue, please visit:")
+      puts("https://github.com/#{inspector.repo_owner}/#{inspector.repo_name}/issues/new")
+      puts("Run `pantograph env` to append the pantograph environment to your issue")
+    end
+
+    # Called when there have been networking issues in creating the report.
+    def inspector_could_not_create_report(error, query, inspector)
+      puts("Could not access the GitHub API, you may have better luck via the website.")
+      puts("https://github.com/#{inspector.repo_owner}/#{inspector.repo_name}/search?q=#{query}&type=Issues&utf8=✓")
+      puts("Error: #{error.name}")
+    end
+
+    private
+
+    def print_issue_full(issue)
+      resolved = issue.state == 'closed'
+      status = (resolved ? issue.state.green : issue.state.red)
+
+      puts("➡️  #{issue.title.yellow}")
+      puts("    #{issue.html_url} [#{status}] #{issue.comments} 💬")
+      puts("    #{Time.parse(issue.updated_at).to_pretty}")
+      puts("")
+    end
+
+    def print_open_link_hint(newline = false)
+      puts("") if newline
+      puts("🔗  You can ⌘ + double-click on links to open them directly in your browser.") if PantographCore::Helper.mac?
+    end
+  end
+end

data/pantograph_core/lib/pantograph_core/ui/implementations/shell.rb

@@ -0,0 +1,159 @@
+require_relative '../../helper'
+require_relative '../../globals'
+require_relative '../../env'
+
+require_relative '../interface'
+
+module PantographCore
+  # Shell is the terminal output of things
+  # For documentation for each of the methods open `interface.rb`
+  class Shell < Interface
+    require 'tty-screen'
+
+    def log
+      return @log if @log
+
+      $stdout.sync = true
+
+      if Helper.test? && !ENV.key?('DEBUG')
+        $stdout.puts("Logging disabled while running tests. Force them by setting the DEBUG environment variable")
+        @log ||= Logger.new(nil) # don't show any logs when running tests
+      else
+        @log ||= Logger.new($stdout)
+      end
+
+      @log.formatter = proc do |severity, datetime, progname, msg|
+        "#{format_string(datetime, severity)}#{msg}\n"
+      end
+
+      @log
+    end
+
+    def format_string(datetime = Time.now, severity = "")
+      timezone_string = !PantographCore::Env.truthy?('PANTOGRAPH_SHOW_TIMEZONE') ? '' : ' %z'
+      if PantographCore::Globals.verbose?
+        return "#{severity} [#{datetime.strftime('%Y-%m-%d %H:%M:%S.%2N' + timezone_string)}]: "
+      elsif PantographCore::Env.truthy?("PANTOGRAPH_HIDE_TIMESTAMP")
+        return ""
+      else
+        return "[#{datetime.strftime('%H:%M:%S' + timezone_string)}]: "
+      end
+    end
+
+    #####################################################
+    # @!group Messaging: show text to the user
+    #####################################################
+
+    def error(message)
+      log.error(message.to_s.red)
+    end
+
+    def important(message)
+      log.warn(message.to_s.yellow)
+    end
+
+    def success(message)
+      log.info(message.to_s.green)
+    end
+
+    def message(message)
+      log.info(message.to_s)
+    end
+
+    def deprecated(message)
+      log.error(message.to_s.deprecated)
+    end
+
+    def command(message)
+      log.info("$ #{message}".cyan)
+    end
+
+    def command_output(message)
+      actual = (message.split("\r").last || "") # as clearing the line will remove the `>` and the time stamp
+      actual.split("\n").each do |msg|
+        if PantographCore::Env.truthy?("PANTOGRAPH_DISABLE_OUTPUT_FORMAT")
+          log.info(msg)
+        else
+          prefix = msg.include?("▸") ? "" : "▸ "
+          log.info(prefix + "" + msg.magenta)
+        end
+      end
+    end
+
+    def verbose(message)
+      log.debug(message.to_s) if PantographCore::Globals.verbose?
+    end
+
+    def header(message)
+      format = format_string
+      if message.length + 8 < TTY::Screen.width - format.length
+        message = "--- #{message} ---"
+        i = message.length
+      else
+        i = TTY::Screen.width - format.length
+      end
+      success("-" * i)
+      success(message)
+      success("-" * i)
+    end
+
+    def content_error(content, error_line)
+      error_line = error_line.to_i
+      return unless error_line > 0
+
+      contents = content.split(/\r?\n/).map(&:chomp)
+
+      start_line = error_line - 2 < 1 ? 1 : error_line - 2
+      end_line = error_line + 2 < contents.length ? error_line + 2 : contents.length
+
+      Range.new(start_line, end_line).each do |line|
+        str = line == error_line ? " => " : "    "
+        str << line.to_s.rjust(Math.log10(end_line) + 1)
+        str << ":\t#{contents[line - 1]}"
+        error(str)
+      end
+    end
+
+    #####################################################
+    # @!group Errors: Inputs
+    #####################################################
+
+    def interactive?
+      interactive = true
+      interactive = false if $stdout.isatty == false
+      interactive = false if Helper.ci?
+      return interactive
+    end
+
+    def input(message)
+      verify_interactive!(message)
+      ask("#{format_string}#{message.to_s.yellow}").to_s.strip
+    end
+
+    def confirm(message)
+      verify_interactive!(message)
+      agree("#{format_string}#{message.to_s.yellow} (y/n)", true)
+    end
+
+    def select(message, options)
+      verify_interactive!(message)
+
+      important(message)
+      choose(*options)
+    end
+
+    def password(message)
+      verify_interactive!(message)
+
+      ask("#{format_string}#{message.to_s.yellow}") { |q| q.echo = "*" }
+    end
+
+    private
+
+    def verify_interactive!(message)
+      return if interactive?
+      important(message)
+      crash!("Could not retrieve response as pantograph runs in non-interactive mode")
+    end
+  end
+end

data/pantograph_core/lib/pantograph_core/ui/interface.rb

@@ -0,0 +1,205 @@
+require_relative 'errors'
+
+module PantographCore
+  # Abstract super class
+  class Interface
+    #####################################################
+    # @!group Messaging: show text to the user
+    #####################################################
+
+    # Level Error: Can be used to show additional error
+    #   information before actually raising an exception
+    #   or can be used to just show an error from which
+    #   pantograph can recover (much magic)
+    #
+    #   By default those messages are shown in red
+    def error(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Important: Can be used to show warnings to the user
+    #   not necessarily negative, but something the user should
+    #   be aware of.
+    #
+    #   By default those messages are shown in yellow
+    def important(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Success: Show that something was successful
+    #
+    #   By default those messages are shown in green
+    def success(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Message: Show a neutral message to the user
+    #
+    #   By default those messages shown in white/black
+    def message(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Deprecated: Show that a particular function is deprecated
+    #
+    #   By default those messages shown in strong blue
+    def deprecated(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Command: Print out a terminal command that is being
+    #   executed.
+    #
+    #   By default those messages shown in cyan
+    def command(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Command Output: Print the output of a command with
+    #   this method
+    #
+    #   By default those messages shown in magenta
+    def command_output(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Verbose: Print out additional information for the
+    #   users that are interested. Will only be printed when
+    #   PantographCore::Globals.verbose? = true
+    #
+    #   By default those messages are shown in white
+    def verbose(_message)
+      not_implemented(__method__)
+    end
+
+    # Print a header = a text in a box
+    #   use this if this message is really important
+    def header(_message)
+      not_implemented(__method__)
+    end
+
+    # Print lines of content around specific line where
+    #   failed to parse.
+    #
+    #   This message will be shown as error
+    def content_error(content, error_line)
+      not_implemented(__method__)
+    end
+
+    #####################################################
+    # @!group Errors: Inputs
+    #####################################################
+
+    # Is is possible to ask the user questions?
+    def interactive?
+      not_implemented(__method__)
+    end
+
+    # get a standard text input (single line)
+    def input(_message)
+      not_implemented(__method__)
+    end
+
+    # A simple yes or no question
+    def confirm(_message)
+      not_implemented(__method__)
+    end
+
+    # Let the user select one out of x items
+    # return value is the value of the option the user chose
+    def select(_message, _options)
+      not_implemented(__method__)
+    end
+
+    # Password input for the user, text field shouldn't show
+    # plain text
+    def password(_message)
+      not_implemented(__method__)
+    end
+
+    #####################################################
+    # @!group Abort helper methods
+    #####################################################
+
+    # Pass an exception to this method to exit the program
+    #   using the given exception
+    # Use this method instead of user_error! if this error is
+    # unexpected, e.g. an invalid server response that shouldn't happen
+    def crash!(exception)
+      raise PantographCrash.new, exception.to_s
+    end
+
+    # Use this method to exit the program because of an user error
+    #   e.g. app doesn't exist on the given Developer Account
+    #        or invalid user credentials
+    #        or scan tests fail
+    # This will show the error message, but doesn't show the full
+    #   stack trace
+    # Basically this should be used when you actively catch the error
+    # and want to show a nice error message to the user
+    def user_error!(error_message, options = {})
+      raise PantographError.new(options), error_message.to_s
+    end
+
+    # Use this method to exit the program because of a shell command
+    # failure -- the command returned a non-zero response. This does
+    # not specify the nature of the error. The error might be from a
+    # programming error, a user error, or an expected  error because
+    # the user of the Pantfile doesn't have their environment set up
+    # properly. Because of this, when these errors occur, it means
+    # that the caller of the shell command did not adequate error
+    # handling and the caller error handling should be improved.
+    def shell_error!(error_message, options = {})
+      raise PantographShellError.new(options), error_message.to_s
+    end
+
+    # Use this method to exit the program because of a build failure
+    # that's caused by the source code of the user. Example for this
+    # is that gym will fail when the code doesn't compile or because
+    # settings for the project are incorrect.
+    # By using this method we'll have more accurate results about
+    # pantograph failures
+    def build_failure!(error_message, options = {})
+      raise PantographBuildFailure.new(options), error_message.to_s
+    end
+
+    # Use this method to exit the program because of a test failure
+    # that's caused by the source code of the user. Example for this
+    # is that scan will fail when the tests fail.
+    # By using this method we'll have more accurate results about
+    # pantograph failures
+    def test_failure!(error_message)
+      raise PantographTestFailure.new, error_message
+    end
+
+    # Use this method to exit the program because of terminal state
+    # that is neither the fault of pantograph, nor a problem with the
+    # user's input. Using this method instead of user_error! will
+    # avoid tracking this outcome as a pantograph failure.
+    #
+    #   e.g. tests ran successfully, but no screenshots were found
+    #
+    # This will show the message, but hide the full stack trace.
+    def abort_with_message!(message)
+      raise PantographCommonException.new, message
+    end
+
+    #####################################################
+    # @!group Helpers
+    #####################################################
+    def not_implemented(method_name)
+      require_relative 'ui'
+      UI.user_error!("Current UI '#{self}' doesn't support method '#{method_name}'")
+    end
+
+    def to_s
+      self.class.name.split('::').last
+    end
+  end
+end
+
+class String
+  def deprecated
+    self.bold.blue
+  end
+end