# Note that the README is generated from the class comments, so it's a bit
# wider scope than your average class comment.

module GhInspector
  # To get started using The Issues Inspector, you will need to
  # create an inspector instance. This class is main public API for querying issues.
  #
  # #### Getting Started
  #
  # Create an instance of `GhInspector::Inspector`, you can then ask it to search
  # based on your raised exception, or as a direct query yourself.
  #
  # ``` ruby
  # require 'gh_inspector'
  # inspector = GhInspector::Inspector.new "orta", "eigen"
  # # Either use an error:
  # inspector.search_exception an_error, ArtsyUI.new
  # # Or use a specific query:
  # inspector.search_query "Someone set us up the bomb"
  # ```
  #
  # By default this would output:
  #
  # ```
  # Looking for related issues on CocoaPods/CocoaPods...
  #
  #   - undefined method `to_ary' for #<Pod::Specification name="iVersion">Did you mean? to_query
  #     https://github.com/CocoaPods/CocoaPods/issues/4748 [closed] [1 comment]
  #
  #   - NoMethodError - undefined method `to_ary' for Pod EAIntroView
  #     https://github.com/CocoaPods/CocoaPods/issues/4391 [closed] [15 comments]
  #
  #   - Do a search on GitHub for issues relating to a crash?
  #     https://github.com/CocoaPods/CocoaPods/issues/4391 [open] [3 comments]
  #
  # and 10 more at:
  # https://github.com/CocoaPods/CocoaPods/search?q=undefined+method+%60to_ary%27&type=Issues
  # ```
  #

  class Inspector
    attr_accessor :repo_owner, :repo_name, :query, :sidekick, :verbose

    # Class init function with a "orta/project" style string
    def self.from_slug(slug)
      details = slug.split '/'
      Inspector.new details.first, details.last
    end

    # Init function with "orta", "project"
    def initialize(repo_owner, repo_name, verbose: false)
      self.repo_owner = repo_owner
      self.repo_name = repo_name
      self.verbose = verbose
      self.sidekick = Sidekick.new(self, repo_owner, repo_name)
    end

    # Will do some magic to try and pull out a reasonable search query
    # for an exception, then searches with that
    def search_exception(exception, delegate = nil)
      query = ExceptionHound.new(exception).query
      search_query(query, delegate)
    end

    # Queries for an specific search string
    def search_query(query, delegate = nil)
      delegate ||= Evidence.new
      sidekick.search(query, delegate)
    end
  end
end