gh_inspector 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ba701be35f8a6f2feb2409c45e7d4b03f730030
-  data.tar.gz: 03a74824f9bfb19c36e879cfb3157a3ce2f53772
+  metadata.gz: 702ea39585d79f3f6e3610953a7edc8e393bdc7d
+  data.tar.gz: 3cf560a89d6fd1d9df14a1f58bff15d8f70f022e
 SHA512:
-  metadata.gz: 6cd592c6f8ced0a170db22f7abbeeed4774bfca21440c5c346058b44279d8af93c2eae1787878a013c0156f2ad1a0035c24c368ac8fa6eba6523058fbece7fba
-  data.tar.gz: 33bc859fb731994d10e162f0a6a1ab0b2d35ef8ec0cfdaa51ef1d82b0a4f917911e580c423bff4aded1f953098a0980cca7acb9b251f88d47657e5c6430b1cfe
+  metadata.gz: ca68d194c3845e84dea3208a3790045cbea79c37f5f391af4bdc9a62cd67074a4d66b4971fa364482be513bd78bed3da758fc9de6a326f096840d9f9fdf2cef6
+  data.tar.gz: 886e327d5e87477b8109a3e591472009319e8f46baca5d6284c376db883397493c4db315bfb280a012dabee38aefa6308e0ac5959279cd9d1a528e8e40b65c3d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Master
 
+### 1.1.3
+
+* Require IRB early in the lib's lifecycle - segiddins
+
 ### 1.1.2
 
 * URL escape the query for GH issues - revolter

data/README.md

@@ -76,15 +76,15 @@ inspector = GhInspector::Inspector.new "fastlane", "fastlane"
 inspector.search_query "Someone set us up the bomb", FastlaneUI.new
 ```
 
-
 Protocol for custom objects:
 
  - `inspector_started_query(query, inspector)` - Called just as the investigation has begun.
+ - `inspector_successfully_recieved_report(report, inspector)` - Deprecated: Please use `inspector_successfully_received_report` instead.
  - `inspector_successfully_received_report(report, inspector)` - Called once the inspector has received a report with more than one issue.
+ - `inspector_recieved_empty_report(report, inspector)` - Deprecated: Please use `inspector_received_empty_report` instead.
  - `inspector_received_empty_report(report, inspector)` - Called once the report has been received, but when there are no issues found.
  - `inspector_could_not_create_report(error, query, inspector)` - Called when there have been networking issues in creating the report.
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,4 +1,13 @@
+require 'bundler'
 require 'bundler/gem_tasks'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
@@ -38,6 +47,7 @@ task :readme do
   usage << "#### Presenting Your Report \n\n"
   evidence = docs.at("GhInspector::Evidence")
   usage << evidence.docstring
+  usage << "\n"
 
   usage << "\nProtocol for custom objects:\n\n"
   evidence.children.each do |method|
@@ -45,7 +55,7 @@ task :readme do
     params = method.parameters.flatten.compact
     usage << " - `#{method.name}(#{params.join ', '})` - #{method.docstring}\n"
   end
-  usage << "\n\n"
+  usage << "\n"
 
   new_file = start + start_split + usage + end_split + finale
   File.open("README.md", 'w') { |f| f.write new_file }

data/gh_inspector.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0', '> 0'
+  spec.add_development_dependency 'yard', '~> 0', '> 0'
 end

data/lib/gh_inspector/evidence.rb

@@ -2,12 +2,14 @@ require 'gh_inspector/version'
 require 'time'
 
 module GhInspector
+  NUMBER_OF_ISSUES_INLINE = 3
+
   # The default user interface for the inspector, its public API should be
   # considered the protocol for other classes wanting to provide a user interface.
   #
   # Your custom objects will be verified at runtime that they conform to the protocol.
   #
-  # You can see the default implmentation at
+  # You can see the default implementation at
   # [lib/evidence.rb](/orta/gh-issues-inspector/tree/master/lib/evidence.rb).
   #
   # Both `search_query` and `search_exception` take your custom delegate as a 2nd optional parameter.
@@ -15,11 +17,17 @@ module GhInspector
   # ``` ruby
   # require 'gh_inspector'
   # inspector = GhInspector::Inspector.new "orta", "eigen"
-  # inspector.search_query "Someone set us up the bomb", ArtsyUI.new
+  # inspector.search_exception an_error, ArtsyUI.new
+  # ```
+  #
+  # or
+  #
+  # ``` ruby
+  # require 'gh_inspector'
+  # inspector = GhInspector::Inspector.new "fastlane", "fastlane"
+  # inspector.search_query "Someone set us up the bomb", FastlaneUI.new
   # ```
   #
-
-  NUMBER_OF_ISSUES_INLINE = 3
 
   class Evidence
     # Called just as the investigation has begun.
@@ -29,7 +37,7 @@ module GhInspector
       puts ""
     end
 
-    # Deprecated: Please use `inspector_successfully_received_report` instead
+    # Deprecated: Please use `inspector_successfully_received_report` instead.
     def inspector_successfully_recieved_report(report, inspector)
       warn "[DEPRECATION] `inspector_successfully_recieved_report` is deprecated. Please use `inspector_successfully_received_report` instead."
       inspector_successfully_received_report(report, inspector)
@@ -47,7 +55,7 @@ module GhInspector
       print_open_link_hint
     end
 
-    # Deprecated: Please use `inspector_received_empty_report` instead
+    # Deprecated: Please use `inspector_received_empty_report` instead.
     def inspector_recieved_empty_report(report, inspector)
       warn "[DEPRECATION] `inspector_recieved_empty_report` is deprecated. Please use `inspector_received_empty_report` instead."
       inspector_received_empty_report(report, inspector)

data/lib/gh_inspector/inspector.rb

@@ -13,6 +13,9 @@ module GhInspector
   # ``` 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"
   # ```
   #

data/lib/gh_inspector/sidekick.rb

@@ -1,3 +1,4 @@
+require 'erb'
 require "net/http"
 require 'uri'
 

data/lib/gh_inspector/version.rb

@@ -1,3 +1,3 @@
 module GhInspector
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.1.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gh_inspector
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,26 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Search through GitHub issues for your project for existing issues about
   a Ruby Error.
 email: