whatis 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,70 @@
1
+ class WhatIs
2
+ class ThisIs
3
+ # Represents not found page, allowing to search for term through Wikipedia API.
4
+ #
5
+ # You should never create instances of this class directly, but rather obtain it from {WhatIs#this}
6
+ # and {WhatIs#these}.
7
+ #
8
+ # @example
9
+ # notfound = WhatIs.this('Guardians Of The Galaxy') # Wikipedia fetching is case-sensitive
10
+ # # => #<ThisIs::NotFound Guardians Of The Galaxy>
11
+ # notfound.search(3)
12
+ # # => [#<ThisIs::Ambigous Guardians of the Galaxy (11 options)>, #<ThisIs Guardians of the Galaxy (film)>, #<ThisIs Guardians of the Galaxy Vol. 2>]
13
+ #
14
+ class NotFound
15
+ # @return [String]
16
+ attr_reader :title
17
+
18
+ # @private
19
+ def initialize(owner, title)
20
+ @owner = owner
21
+ @title = title
22
+ end
23
+
24
+ # Searches for requested entity name through Wikipedia API.
25
+ #
26
+ # See {WhatIs#this} for options explanation.
27
+ #
28
+ # @param limit [Integer] Number of results to return.
29
+ # @param options [Hash]
30
+ # @option options [true, String, Symbol] :languages
31
+ # @option options [true, false] :categories
32
+ # @return [Array<ThisIs, ThisIs::Ambigous>]
33
+ def search(limit = 5, **options)
34
+ @owner.search(title, limit, **options)
35
+ end
36
+
37
+ # @return [String]
38
+ def inspect
39
+ "#<ThisIs::NotFound #{title}>"
40
+ end
41
+
42
+ # @return [String]
43
+ def to_s
44
+ "#{title}: not found"
45
+ end
46
+
47
+ # @return [Hash]
48
+ def to_h
49
+ {type: 'ThisIs::NotFound', title: title}
50
+ end
51
+
52
+ # @return [String]
53
+ def to_json(opts)
54
+ to_h.to_json(opts)
55
+ end
56
+
57
+ # @return [Description]
58
+ def describe(help: true)
59
+ Description.new("#{self}#{describe_help(help)}")
60
+ end
61
+
62
+ private
63
+
64
+ def describe_help(render = true)
65
+ return '' unless render
66
+ "\n Usage: .search(limit, **options)"
67
+ end
68
+ end
69
+ end
70
+ end
@@ -0,0 +1,55 @@
1
+ Gem::Specification.new do |s|
2
+ s.name = 'whatis'
3
+ s.version = '0.0.1'
4
+ s.authors = ['Victor Shepelev']
5
+ s.email = 'zverok.offline@gmail.com'
6
+ s.homepage = 'https://github.com/molybdenum-99/whatis'
7
+
8
+ s.summary = 'WhatIs.this: Small entity resolver through Wikipedia'
9
+ s.description = <<-EOF
10
+ WhatIs.this fetches any entity metadata from Wikipedia by title and renders it concisely and
11
+ informatively. Think `WhatIs.these(list, of, user, entered, toponyms).map(&:coordinates)` for
12
+ example.
13
+ EOF
14
+ s.licenses = ['MIT']
15
+
16
+ s.required_ruby_version = '>= 2.1.0'
17
+
18
+ s.files = `git ls-files`.split($RS).reject do |file|
19
+ file =~ /^(?:
20
+ spec\/.*
21
+ |Gemfile
22
+ |Rakefile
23
+ |\.codeclimate.yml
24
+ |\.rspec
25
+ |\.gitignore
26
+ |\.rubocop.yml
27
+ |\.rubocop_todo.yml
28
+ |\.travis.yml
29
+ |\.yardopts
30
+ )$/x
31
+ end
32
+ s.require_paths = ["lib"]
33
+ s.bindir = 'exe'
34
+ s.executables << 'whatis'
35
+
36
+ s.required_ruby_version = '>= 2.3.0'
37
+
38
+ s.add_dependency 'infoboxer', '= 0.3.1'
39
+ s.add_dependency 'geo_coord'
40
+ s.add_dependency 'backports'
41
+
42
+ s.add_development_dependency 'rubocop'
43
+ s.add_development_dependency 'rspec', '>= 3'
44
+ s.add_development_dependency 'rubocop-rspec'
45
+ s.add_development_dependency 'rspec-its', '~> 1'
46
+ s.add_development_dependency 'saharspec', '0.0.4'
47
+ s.add_development_dependency 'simplecov', '~> 0.9'
48
+ s.add_development_dependency 'rake'
49
+ s.add_development_dependency 'rubygems-tasks'
50
+ s.add_development_dependency 'yard'
51
+ s.add_development_dependency 'kramdown'
52
+ s.add_development_dependency 'vcr'
53
+ s.add_development_dependency 'webmock'
54
+ s.add_development_dependency 'dokaz'
55
+ end
metadata ADDED
@@ -0,0 +1,283 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: whatis
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Victor Shepelev
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-12-04 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: infoboxer
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '='
18
+ - !ruby/object:Gem::Version
19
+ version: 0.3.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '='
25
+ - !ruby/object:Gem::Version
26
+ version: 0.3.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: geo_coord
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: backports
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rubocop
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '3'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '3'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rubocop-rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rspec-its
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '1'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '1'
111
+ - !ruby/object:Gem::Dependency
112
+ name: saharspec
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - '='
116
+ - !ruby/object:Gem::Version
117
+ version: 0.0.4
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - '='
123
+ - !ruby/object:Gem::Version
124
+ version: 0.0.4
125
+ - !ruby/object:Gem::Dependency
126
+ name: simplecov
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '0.9'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '0.9'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rake
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rubygems-tasks
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: '0'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ - !ruby/object:Gem::Dependency
168
+ name: yard
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - ">="
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - ">="
179
+ - !ruby/object:Gem::Version
180
+ version: '0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: kramdown
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - ">="
186
+ - !ruby/object:Gem::Version
187
+ version: '0'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - ">="
193
+ - !ruby/object:Gem::Version
194
+ version: '0'
195
+ - !ruby/object:Gem::Dependency
196
+ name: vcr
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - ">="
200
+ - !ruby/object:Gem::Version
201
+ version: '0'
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - ">="
207
+ - !ruby/object:Gem::Version
208
+ version: '0'
209
+ - !ruby/object:Gem::Dependency
210
+ name: webmock
211
+ requirement: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - ">="
214
+ - !ruby/object:Gem::Version
215
+ version: '0'
216
+ type: :development
217
+ prerelease: false
218
+ version_requirements: !ruby/object:Gem::Requirement
219
+ requirements:
220
+ - - ">="
221
+ - !ruby/object:Gem::Version
222
+ version: '0'
223
+ - !ruby/object:Gem::Dependency
224
+ name: dokaz
225
+ requirement: !ruby/object:Gem::Requirement
226
+ requirements:
227
+ - - ">="
228
+ - !ruby/object:Gem::Version
229
+ version: '0'
230
+ type: :development
231
+ prerelease: false
232
+ version_requirements: !ruby/object:Gem::Requirement
233
+ requirements:
234
+ - - ">="
235
+ - !ruby/object:Gem::Version
236
+ version: '0'
237
+ description: |2
238
+ WhatIs.this fetches any entity metadata from Wikipedia by title and renders it concisely and
239
+ informatively. Think `WhatIs.these(list, of, user, entered, toponyms).map(&:coordinates)` for
240
+ example.
241
+ email: zverok.offline@gmail.com
242
+ executables:
243
+ - whatis
244
+ extensions: []
245
+ extra_rdoc_files: []
246
+ files:
247
+ - LICENSE.txt
248
+ - README.md
249
+ - exe/whatis
250
+ - lib/whatis.rb
251
+ - lib/whatis/cli.rb
252
+ - lib/whatis/formatter.rb
253
+ - lib/whatis/refinements.rb
254
+ - lib/whatis/thisis.rb
255
+ - lib/whatis/thisis/ambigous.rb
256
+ - lib/whatis/thisis/link.rb
257
+ - lib/whatis/thisis/notfound.rb
258
+ - whatis.gemspec
259
+ homepage: https://github.com/molybdenum-99/whatis
260
+ licenses:
261
+ - MIT
262
+ metadata: {}
263
+ post_install_message:
264
+ rdoc_options: []
265
+ require_paths:
266
+ - lib
267
+ required_ruby_version: !ruby/object:Gem::Requirement
268
+ requirements:
269
+ - - ">="
270
+ - !ruby/object:Gem::Version
271
+ version: 2.3.0
272
+ required_rubygems_version: !ruby/object:Gem::Requirement
273
+ requirements:
274
+ - - ">="
275
+ - !ruby/object:Gem::Version
276
+ version: '0'
277
+ requirements: []
278
+ rubyforge_project:
279
+ rubygems_version: 2.6.10
280
+ signing_key:
281
+ specification_version: 4
282
+ summary: 'WhatIs.this: Small entity resolver through Wikipedia'
283
+ test_files: []