gh_inspector 1.1.2 → 1.1.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6ba701be35f8a6f2feb2409c45e7d4b03f730030
4
- data.tar.gz: 03a74824f9bfb19c36e879cfb3157a3ce2f53772
3
+ metadata.gz: 702ea39585d79f3f6e3610953a7edc8e393bdc7d
4
+ data.tar.gz: 3cf560a89d6fd1d9df14a1f58bff15d8f70f022e
5
5
  SHA512:
6
- metadata.gz: 6cd592c6f8ced0a170db22f7abbeeed4774bfca21440c5c346058b44279d8af93c2eae1787878a013c0156f2ad1a0035c24c368ac8fa6eba6523058fbece7fba
7
- data.tar.gz: 33bc859fb731994d10e162f0a6a1ab0b2d35ef8ec0cfdaa51ef1d82b0a4f917911e580c423bff4aded1f953098a0980cca7acb9b251f88d47657e5c6430b1cfe
6
+ metadata.gz: ca68d194c3845e84dea3208a3790045cbea79c37f5f391af4bdc9a62cd67074a4d66b4971fa364482be513bd78bed3da758fc9de6a326f096840d9f9fdf2cef6
7
+ data.tar.gz: 886e327d5e87477b8109a3e591472009319e8f46baca5d6284c376db883397493c4db315bfb280a012dabee38aefa6308e0ac5959279cd9d1a528e8e40b65c3d
@@ -1,5 +1,9 @@
1
1
  ### Master
2
2
 
3
+ ### 1.1.3
4
+
5
+ * Require IRB early in the lib's lifecycle - segiddins
6
+
3
7
  ### 1.1.2
4
8
 
5
9
  * URL escape the query for GH issues - revolter
data/README.md CHANGED
@@ -76,15 +76,15 @@ inspector = GhInspector::Inspector.new "fastlane", "fastlane"
76
76
  inspector.search_query "Someone set us up the bomb", FastlaneUI.new
77
77
  ```
78
78
 
79
-
80
79
  Protocol for custom objects:
81
80
 
82
81
  - `inspector_started_query(query, inspector)` - Called just as the investigation has begun.
82
+ - `inspector_successfully_recieved_report(report, inspector)` - Deprecated: Please use `inspector_successfully_received_report` instead.
83
83
  - `inspector_successfully_received_report(report, inspector)` - Called once the inspector has received a report with more than one issue.
84
+ - `inspector_recieved_empty_report(report, inspector)` - Deprecated: Please use `inspector_received_empty_report` instead.
84
85
  - `inspector_received_empty_report(report, inspector)` - Called once the report has been received, but when there are no issues found.
85
86
  - `inspector_could_not_create_report(error, query, inspector)` - Called when there have been networking issues in creating the report.
86
87
 
87
-
88
88
  ## Development
89
89
 
90
90
  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 CHANGED
@@ -1,4 +1,13 @@
1
+ require 'bundler'
1
2
  require 'bundler/gem_tasks'
3
+ begin
4
+ Bundler.setup(:default, :development)
5
+ rescue Bundler::BundlerError => e
6
+ warn e.message
7
+ warn 'Run `bundle install` to install missing gems'
8
+ exit e.status_code
9
+ end
10
+
2
11
  require 'rspec/core/rake_task'
3
12
  require 'rubocop/rake_task'
4
13
 
@@ -38,6 +47,7 @@ task :readme do
38
47
  usage << "#### Presenting Your Report \n\n"
39
48
  evidence = docs.at("GhInspector::Evidence")
40
49
  usage << evidence.docstring
50
+ usage << "\n"
41
51
 
42
52
  usage << "\nProtocol for custom objects:\n\n"
43
53
  evidence.children.each do |method|
@@ -45,7 +55,7 @@ task :readme do
45
55
  params = method.parameters.flatten.compact
46
56
  usage << " - `#{method.name}(#{params.join ', '})` - #{method.docstring}\n"
47
57
  end
48
- usage << "\n\n"
58
+ usage << "\n"
49
59
 
50
60
  new_file = start + start_split + usage + end_split + finale
51
61
  File.open("README.md", 'w') { |f| f.write new_file }
@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
23
23
  spec.add_development_dependency 'rake', '~> 10.0'
24
24
  spec.add_development_dependency 'rspec', '~> 3.0'
25
25
  spec.add_development_dependency 'rubocop', '~> 0', '> 0'
26
+ spec.add_development_dependency 'yard', '~> 0', '> 0'
26
27
  end
@@ -2,12 +2,14 @@ require 'gh_inspector/version'
2
2
  require 'time'
3
3
 
4
4
  module GhInspector
5
+ NUMBER_OF_ISSUES_INLINE = 3
6
+
5
7
  # The default user interface for the inspector, its public API should be
6
8
  # considered the protocol for other classes wanting to provide a user interface.
7
9
  #
8
10
  # Your custom objects will be verified at runtime that they conform to the protocol.
9
11
  #
10
- # You can see the default implmentation at
12
+ # You can see the default implementation at
11
13
  # [lib/evidence.rb](/orta/gh-issues-inspector/tree/master/lib/evidence.rb).
12
14
  #
13
15
  # Both `search_query` and `search_exception` take your custom delegate as a 2nd optional parameter.
@@ -15,11 +17,17 @@ module GhInspector
15
17
  # ``` ruby
16
18
  # require 'gh_inspector'
17
19
  # inspector = GhInspector::Inspector.new "orta", "eigen"
18
- # inspector.search_query "Someone set us up the bomb", ArtsyUI.new
20
+ # inspector.search_exception an_error, ArtsyUI.new
21
+ # ```
22
+ #
23
+ # or
24
+ #
25
+ # ``` ruby
26
+ # require 'gh_inspector'
27
+ # inspector = GhInspector::Inspector.new "fastlane", "fastlane"
28
+ # inspector.search_query "Someone set us up the bomb", FastlaneUI.new
19
29
  # ```
20
30
  #
21
-
22
- NUMBER_OF_ISSUES_INLINE = 3
23
31
 
24
32
  class Evidence
25
33
  # Called just as the investigation has begun.
@@ -29,7 +37,7 @@ module GhInspector
29
37
  puts ""
30
38
  end
31
39
 
32
- # Deprecated: Please use `inspector_successfully_received_report` instead
40
+ # Deprecated: Please use `inspector_successfully_received_report` instead.
33
41
  def inspector_successfully_recieved_report(report, inspector)
34
42
  warn "[DEPRECATION] `inspector_successfully_recieved_report` is deprecated. Please use `inspector_successfully_received_report` instead."
35
43
  inspector_successfully_received_report(report, inspector)
@@ -47,7 +55,7 @@ module GhInspector
47
55
  print_open_link_hint
48
56
  end
49
57
 
50
- # Deprecated: Please use `inspector_received_empty_report` instead
58
+ # Deprecated: Please use `inspector_received_empty_report` instead.
51
59
  def inspector_recieved_empty_report(report, inspector)
52
60
  warn "[DEPRECATION] `inspector_recieved_empty_report` is deprecated. Please use `inspector_received_empty_report` instead."
53
61
  inspector_received_empty_report(report, inspector)
@@ -13,6 +13,9 @@ module GhInspector
13
13
  # ``` ruby
14
14
  # require 'gh_inspector'
15
15
  # inspector = GhInspector::Inspector.new "orta", "eigen"
16
+ # # Either use an error:
17
+ # inspector.search_exception an_error, ArtsyUI.new
18
+ # # Or use a specific query:
16
19
  # inspector.search_query "Someone set us up the bomb"
17
20
  # ```
18
21
  #
@@ -1,3 +1,4 @@
1
+ require 'erb'
1
2
  require "net/http"
2
3
  require 'uri'
3
4
 
@@ -1,3 +1,3 @@
1
1
  module GhInspector
2
- VERSION = '1.1.2'.freeze
2
+ VERSION = '1.1.3'.freeze
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gh_inspector
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.2
4
+ version: 1.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Orta Therox
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2018-02-08 00:00:00.000000000 Z
12
+ date: 2018-03-06 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: bundler
@@ -87,6 +87,26 @@ dependencies:
87
87
  - - ">"
88
88
  - !ruby/object:Gem::Version
89
89
  version: '0'
90
+ - !ruby/object:Gem::Dependency
91
+ name: yard
92
+ requirement: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - - ">"
98
+ - !ruby/object:Gem::Version
99
+ version: '0'
100
+ type: :development
101
+ prerelease: false
102
+ version_requirements: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - "~>"
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ - - ">"
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
90
110
  description: Search through GitHub issues for your project for existing issues about
91
111
  a Ruby Error.
92
112
  email: