show_rdoc_docu 0.0.11
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/show_rdoc_docu.rb +1 -0
- data/lib/show_rdoc_docu/show_rdoc_docu.rb +142 -0
- data/lib/show_rdoc_docu/version/version.rb +14 -0
- data/show_rdoc_docu.gemspec +50 -0
- metadata +78 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8731a9bdeb1789e2382b6459bda4a6bed3e3873518d6fe7a2a4cf5a9021c5c13
|
4
|
+
data.tar.gz: 1ac88cf30f62a61fcf5a016e7ecf75b38442481e7efb42b65e9654340be330fa
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c5eac7426066038fc25ecebb517c439cfd075cba8ed75ad21175aa4c81333fddfc1b0fb67c86c58ed3e8b91ebbb1d26420006ebb68b61e5dc3ffc8edd506739b
|
7
|
+
data.tar.gz: 140662d71146d88bd1619d9dda0a0229fecdd790f68a1617b78cc710e627258175bd71b466576307b4952e65fe54c0f75f692eb8d8af552d3f98483c575d2bf2
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'show_rdoc_docu/show_rdoc_docu.rb'
|
@@ -0,0 +1,142 @@
|
|
1
|
+
#!/usr/bin/ruby -w
|
2
|
+
# Encoding: UTF-8
|
3
|
+
# frozen_string_literal: true
|
4
|
+
# =========================================================================== #
|
5
|
+
# === ShowRdocDocu
|
6
|
+
#
|
7
|
+
# Use this class to show rdoc documentation.
|
8
|
+
#
|
9
|
+
# It will be stored in @result.
|
10
|
+
#
|
11
|
+
# Usage example:
|
12
|
+
#
|
13
|
+
# require 'show_rdoc_docu'
|
14
|
+
# ShowRdocDocu.new(ARGV)
|
15
|
+
#
|
16
|
+
# =========================================================================== #
|
17
|
+
# require 'show_rdoc_docu'
|
18
|
+
# =========================================================================== #
|
19
|
+
require 'rdoc'
|
20
|
+
require 'stringio'
|
21
|
+
require 'show_rdoc_docu/version/version.rb'
|
22
|
+
|
23
|
+
class ShowRdocDocu # === ShowRdocDocu
|
24
|
+
|
25
|
+
begin
|
26
|
+
require 'colours'
|
27
|
+
include Colours
|
28
|
+
rescue LoadError; end
|
29
|
+
|
30
|
+
begin
|
31
|
+
require 'opn'
|
32
|
+
rescue LoadError; end
|
33
|
+
|
34
|
+
# ========================================================================= #
|
35
|
+
# === initialize
|
36
|
+
# ========================================================================= #
|
37
|
+
def initialize(
|
38
|
+
i = nil,
|
39
|
+
format_type = '--format=markdown',
|
40
|
+
run_already = true
|
41
|
+
)
|
42
|
+
reset
|
43
|
+
set_input(i)
|
44
|
+
@format_type = format_type # << '--format=ansi' # => ["-T", "--format=ansi"]
|
45
|
+
run if run_already
|
46
|
+
end
|
47
|
+
|
48
|
+
# ========================================================================= #
|
49
|
+
# === reset (reset tag)
|
50
|
+
# ========================================================================= #
|
51
|
+
def reset
|
52
|
+
@found_a_result = true
|
53
|
+
@be_verbose = true
|
54
|
+
end
|
55
|
+
|
56
|
+
# ========================================================================= #
|
57
|
+
# === be_verbose?
|
58
|
+
# ========================================================================= #
|
59
|
+
def be_verbose?
|
60
|
+
@be_verbose
|
61
|
+
end
|
62
|
+
|
63
|
+
# ========================================================================= #
|
64
|
+
# === found_a_result?
|
65
|
+
# ========================================================================= #
|
66
|
+
def found_a_result?
|
67
|
+
@found_a_result
|
68
|
+
end; alias found_result? found_a_result? # === found_result?
|
69
|
+
|
70
|
+
# ========================================================================= #
|
71
|
+
# === set_input
|
72
|
+
# ========================================================================= #
|
73
|
+
def set_input(i = nil)
|
74
|
+
i = 'Array#push' if i.nil?
|
75
|
+
i = 'Array#push' if i.empty?
|
76
|
+
i = i.first if i.is_a? Array
|
77
|
+
@input = i
|
78
|
+
end
|
79
|
+
|
80
|
+
# ========================================================================= #
|
81
|
+
# === restore_stdout
|
82
|
+
# ========================================================================= #
|
83
|
+
def restore_stdout
|
84
|
+
$stdout = STDOUT
|
85
|
+
end
|
86
|
+
|
87
|
+
# ========================================================================= #
|
88
|
+
# === show_result
|
89
|
+
#
|
90
|
+
# Simply output the result.
|
91
|
+
# ========================================================================= #
|
92
|
+
def show_result
|
93
|
+
e result # This is the string output.
|
94
|
+
end; alias report show_result # === report
|
95
|
+
alias report_result show_result # === report_result
|
96
|
+
|
97
|
+
# ========================================================================= #
|
98
|
+
# === result?
|
99
|
+
# ========================================================================= #
|
100
|
+
def result?
|
101
|
+
@result
|
102
|
+
end; alias result result? # === result
|
103
|
+
|
104
|
+
# ========================================================================= #
|
105
|
+
# === result=
|
106
|
+
# ========================================================================= #
|
107
|
+
def result=(i)
|
108
|
+
@result = i
|
109
|
+
end
|
110
|
+
|
111
|
+
# ========================================================================= #
|
112
|
+
# === run (run tag)
|
113
|
+
# ========================================================================= #
|
114
|
+
def run
|
115
|
+
_ = %w( -T )
|
116
|
+
_ << @format_type
|
117
|
+
# ======================================================================= #
|
118
|
+
# Next we delegate into RDoc::RI::Driver.process_args
|
119
|
+
# ======================================================================= #
|
120
|
+
hash = RDoc::RI::Driver.process_args(_) # This hash can be passed to Driver.new
|
121
|
+
rdoc_driver = RDoc::RI::Driver.new(hash)
|
122
|
+
rdoc_driver.use_stdout = true
|
123
|
+
@result = ''.dup # We push the output into this instance variable.
|
124
|
+
$stdout = StringIO.new(@result) # Snatch all std-output.
|
125
|
+
begin # Must rescue here.
|
126
|
+
# @input is a String such as: "String#[]"
|
127
|
+
_dataset = rdoc_driver.display_method(@input) # This will return a Fixnum.
|
128
|
+
rescue RDoc::RI::Driver::NotFoundError
|
129
|
+
if be_verbose?
|
130
|
+
opn; e 'We did not find anything about `'+simp(@input)+'`.'
|
131
|
+
end
|
132
|
+
@found_a_result = false
|
133
|
+
end
|
134
|
+
restore_stdout # And restore stdout again.
|
135
|
+
end
|
136
|
+
|
137
|
+
end
|
138
|
+
|
139
|
+
if __FILE__ == $PROGRAM_NAME
|
140
|
+
_ = ShowRdocDocu.new(ARGV)
|
141
|
+
_.show_result
|
142
|
+
end # showrdocdocu Dir.chdir
|
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/ruby -w
|
2
|
+
# Encoding: UTF-8
|
3
|
+
# frozen_string_literal: true
|
4
|
+
# =========================================================================== #
|
5
|
+
# require 'show_rdoc_docu/version/version.rb'
|
6
|
+
# =========================================================================== #
|
7
|
+
class ShowRdocDocu
|
8
|
+
|
9
|
+
# ========================================================================= #
|
10
|
+
# === VERSION
|
11
|
+
# ========================================================================= #
|
12
|
+
VERSION = '0.0.11'
|
13
|
+
|
14
|
+
end
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# =========================================================================== #
|
2
|
+
# Gemspec for Project ShowRdocDocu.
|
3
|
+
# =========================================================================== #
|
4
|
+
require 'show_rdoc_docu'
|
5
|
+
|
6
|
+
Gem::Specification.new { |s|
|
7
|
+
|
8
|
+
s.name = 'show_rdoc_docu'
|
9
|
+
s.version = ShowRdocDocu::VERSION
|
10
|
+
s.date = Time.now.strftime('%Y-%m-%d')
|
11
|
+
|
12
|
+
s.summary = <<-EOF
|
13
|
+
|
14
|
+
If you have specific suggestions to make this gem more
|
15
|
+
useful for others, please drop me an email at:
|
16
|
+
|
17
|
+
shevegen@gmail.com
|
18
|
+
|
19
|
+
Thank you.
|
20
|
+
|
21
|
+
EOF
|
22
|
+
|
23
|
+
s.description = <<-EOF
|
24
|
+
|
25
|
+
This library is called show_rdoc_docu.
|
26
|
+
|
27
|
+
EOF
|
28
|
+
|
29
|
+
s.extra_rdoc_files = %w()
|
30
|
+
|
31
|
+
s.authors = ['Robert A. Heiler']
|
32
|
+
s.email = 'shevegen@gmail.com'
|
33
|
+
s.files = Dir['**/*']
|
34
|
+
if File.exist? 'USAGE.md'
|
35
|
+
s.files << 'USAGE.md'
|
36
|
+
end
|
37
|
+
s.license = 'GPL-2.0'
|
38
|
+
s.homepage = 'https://rubygems.org/gems/show_rdoc_docu'
|
39
|
+
|
40
|
+
s.required_ruby_version = '>= '+RUBY_VERSION
|
41
|
+
s.required_rubygems_version = '>= '+Gem::VERSION
|
42
|
+
s.rubygems_version = '>= '+Gem::VERSION
|
43
|
+
|
44
|
+
# ========================================================================= #
|
45
|
+
# Dependencies for the project:
|
46
|
+
# ========================================================================= #
|
47
|
+
s.add_dependency 'colours'
|
48
|
+
s.add_dependency 'opn'
|
49
|
+
|
50
|
+
}
|
metadata
ADDED
@@ -0,0 +1,78 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: show_rdoc_docu
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.11
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Robert A. Heiler
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-12-07 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: colours
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: opn
|
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
|
+
description: |2+
|
42
|
+
|
43
|
+
This library is called show_rdoc_docu.
|
44
|
+
|
45
|
+
email: shevegen@gmail.com
|
46
|
+
executables: []
|
47
|
+
extensions: []
|
48
|
+
extra_rdoc_files: []
|
49
|
+
files:
|
50
|
+
- lib/show_rdoc_docu.rb
|
51
|
+
- lib/show_rdoc_docu/show_rdoc_docu.rb
|
52
|
+
- lib/show_rdoc_docu/version/version.rb
|
53
|
+
- show_rdoc_docu.gemspec
|
54
|
+
homepage: https://rubygems.org/gems/show_rdoc_docu
|
55
|
+
licenses:
|
56
|
+
- GPL-2.0
|
57
|
+
metadata: {}
|
58
|
+
post_install_message:
|
59
|
+
rdoc_options: []
|
60
|
+
require_paths:
|
61
|
+
- lib
|
62
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
63
|
+
requirements:
|
64
|
+
- - ">="
|
65
|
+
- !ruby/object:Gem::Version
|
66
|
+
version: 2.7.2
|
67
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
68
|
+
requirements:
|
69
|
+
- - ">="
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
version: 3.1.4
|
72
|
+
requirements: []
|
73
|
+
rubygems_version: 3.1.4
|
74
|
+
signing_key:
|
75
|
+
specification_version: 4
|
76
|
+
summary: 'If you have specific suggestions to make this gem more useful for others,
|
77
|
+
please drop me an email at: shevegen@gmail.com Thank you.'
|
78
|
+
test_files: []
|