class_docu_shower 1.0.3 → 1.0.21

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 706a06d9164f89d3cf5a600bdbc0e1eb65bb839f
4
- data.tar.gz: 6c58b78d9404c2e5e0983a983befcd6fe1196a96
2
+ SHA256:
3
+ metadata.gz: 403b52dadc7d2d0c9434d9af218b1892c3674110af0c9ebf7c1d1e8ef2edb2c1
4
+ data.tar.gz: d193d3d8192fb50a8dfee4a0a600bc2275d1e2679e13836953d4f3ca340ca7b0
5
5
  SHA512:
6
- metadata.gz: a85869271e95c374ecdc4cf39cf2d9c19f141068d92c47d9e0da93930452682c46041b73fc487541af2da247293c8e8fa193c649cfb270130b0db08f3cd489c5
7
- data.tar.gz: 445e7ac50e3b53e8413835c35413b87f145aabc6814404bb1b7125a5562cb8d8c32d2e29107292876f7f7223a009606d5b77d0e11699ac778bbee66e29441758
6
+ metadata.gz: a3f955a6c65c0e77558c7dd6cc0c4a6b952be51559f38e279270157726f661a3c38f3946d7aa8ae795348fc6ec6192b1f3fb2e140e3629710a7944c04f33bc54
7
+ data.tar.gz: a84f1458d1a4e2ed166e4fff0ef6a5c2fdea4a67d09fd52a1d7ccc9b276a0882a68e9f478384e44d3c505c89a18b6936778e6db8219ef5f90bcbe3b643d94098
@@ -0,0 +1,20 @@
1
+ ## Why was this class necessary?
2
+
3
+ I found that I wrote a lot of ruby .rb files over the various
4
+ years. When the file is of some importance, I would usually
5
+ also document in the header what this class does. Since I
6
+ was already doing so, I figured that it may be useful to
7
+ display this explanation on the commandline too, via a
8
+ unified interface, invocable such as via "--info".
9
+
10
+ That way I can note down what the respective class is doing
11
+ and have this output on the commandline.
12
+
13
+ ## Contact information
14
+
15
+ If you have specific suggestions to make this gem more
16
+ useful for others, please drop me an email at:
17
+
18
+ shevegen@gmail.com
19
+
20
+ Thank you.
data/USAGE.md CHANGED
@@ -7,4 +7,10 @@
7
7
  == Using it in a project
8
8
 
9
9
  ClassDocuShower.new("some_file_here.rb")
10
+ ClassDocuShower['some_file_here.rb']
10
11
 
12
+ == Commandline
13
+
14
+ You can run the executable called
15
+
16
+ class_docu_shower
@@ -0,0 +1,7 @@
1
+ #!/System/Index/bin/ruby -w
2
+ # Encoding: ISO-8859-1
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ require 'class_docu_shower'
6
+
7
+ ClassDocuShower[ARGV]
@@ -1,64 +1,56 @@
1
1
  # =========================================================================== #
2
2
  # Gemspec for Project ClassDocuShower.
3
3
  # =========================================================================== #
4
+ require 'class_docu_shower/version/version.rb'
5
+
4
6
  Gem::Specification.new { |s|
5
7
 
6
- s.name = 'class_docu_shower'
7
- s.version = '1.0.3'
8
- s.date = Time.now.strftime('%Y-%m-%d')
8
+ s.name = 'class_docu_shower'
9
+ s.version = ClassDocuShower::VERSION
10
+ s.date = Time.now.strftime('%Y-%m-%d')
9
11
 
10
- s.summary = <<-EOF
12
+ DESCRIPTION = <<-EOF
11
13
 
12
- It will display the header of a .rb file in question.
13
- For this to properly function, you should use 3 =
14
- followed by the name of the class, and delimited
15
- in # ===== entries.
16
-
17
- Example:
18
-
19
- === Menu
14
+ This library is called class_docu_shower.
20
15
 
21
- If you have specific suggestions to make this gem more
22
- useful for others, please drop me an email at:
23
- shevegen@gmail.com
24
- Thank you.
16
+ It will display the header of a .rb file in question.
25
17
 
26
- EOF
27
-
28
- s.description = <<-EOF
18
+ For this to properly function, you should use 3 '=' characters,
19
+ followed by the name of the class, and delimited via '# ====='
20
+ entries.
21
+
22
+ Example:
23
+
24
+ '=== Menu'
29
25
 
30
- This library is called class_docu_shower.
31
-
32
- It will display the header of a .rb file in question.
33
- For this to properly function, you should use 3 =
34
- followed by the name of the class, and delimited
35
- in # ===== entries.
36
-
37
- Example:
38
-
39
- === Menu
26
+ Without the '' quotes.
40
27
 
41
- If you have specific suggestions to make this gem more
42
- useful for others, please drop me an email at:
43
- shevegen@gmail.com
44
- Thank you.
28
+ There also is an executable at bin/class_docu_shower.
29
+
30
+ Pass it the path to a .rb file and it will output the
31
+ top header comment.
45
32
 
46
33
  EOF
47
34
 
35
+ s.summary = DESCRIPTION
36
+ s.description = DESCRIPTION
37
+
48
38
  s.extra_rdoc_files = %w( USAGE.md )
49
39
 
50
- s.authors = ['Robert A. Heiler']
51
- s.email = 'shevegen@gmail.com'
52
- s.files = Dir['**/*']
53
- s.files << 'USAGE.md'
54
- s.license = 'GPL 2'
55
- s.required_ruby_version = '>= 1.9.2'
56
- s.homepage = 'http://rubygems.org/gems/class_docu_shower'
57
-
58
- s.rubygems_version = '2.1.11'
59
-
60
- s.add_dependency 'colours', '>= 0.0.12'
61
- s.add_dependency 'opn', '>= 1.0.0'
62
- s.add_dependency 'usher', '>= 0.0.6'
63
-
64
- }
40
+ s.authors = ['Robert A. Heiler']
41
+ s.email = 'shevegen@gmail.com'
42
+ s.files = Dir['**/*']
43
+ s.files << 'USAGE.md'
44
+ s.license = 'GPL-2.0'
45
+ s.homepage = 'http://rubygems.org/gems/class_docu_shower'
46
+
47
+ s.required_ruby_version = '>= '+RUBY_VERSION
48
+ s.required_rubygems_version = '>= '+Gem::VERSION
49
+ s.rubygems_version = '>= '+Gem::VERSION
50
+
51
+ s.add_dependency 'colours'
52
+ s.add_dependency 'opn'
53
+ # s.add_dependency 'usher'
54
+ # ^^^ The variant on rubygems.org is not the one we need.
55
+
56
+ }
@@ -0,0 +1,20 @@
1
+ ## Why was this class necessary?
2
+
3
+ I found that I wrote a lot of ruby .rb files over the various
4
+ years. When the file is of some importance, I would usually
5
+ also document in the header what this class does. Since I
6
+ was already doing so, I figured that it may be useful to
7
+ display this explanation on the commandline too, via a
8
+ unified interface, invocable such as via "--info".
9
+
10
+ That way I can note down what the respective class is doing
11
+ and have this output on the commandline.
12
+
13
+ ## Contact information
14
+
15
+ If you have specific suggestions to make this gem more
16
+ useful for others, please drop me an email at:
17
+
18
+ shevegen@gmail.com
19
+
20
+ Thank you.
@@ -1,31 +1,60 @@
1
- #!/System/Executables/ruby -w
2
- # Encoding: ASCII-8BIT
1
+ #!/System/Index/bin/ruby -w
2
+ # Encoding: UTF-8
3
+ # frozen_string_literal: true
3
4
  # =========================================================================== #
4
5
  # === ClassDocuShower
5
6
  #
6
- # This file will extract the comment from a class and return a
7
- # string about the docu. That comment must be padded inside lines
8
- # with '# ====' lines, like this file here.
7
+ # This file will extract the comment from a class and return a string about
8
+ # the docu. That comment must be padded inside lines with '# ====' lines,
9
+ # like this file here.
9
10
  #
10
11
  # Usage example:
11
12
  # ClassDocuShower.new('file_location_comes_in_here')
12
13
  # =========================================================================== #
13
- require 'pp'
14
- require 'colours'
14
+ # require 'class_docu_shower.rb'
15
+ # =========================================================================== #
15
16
  require 'opn'
16
- require 'usher'
17
+ begin
18
+ require 'usher'
19
+ rescue LoadError; end
20
+ begin
21
+ require 'colours'
22
+ rescue LoadError; end
23
+ require 'class_docu_shower/version/version.rb'
24
+ require 'class_docu_shower/colours.rb'
17
25
 
18
- class ClassDocuShower # require 'class_docu_shower'; ClassDocuShower.new
26
+ class ClassDocuShower # === ClassDocuShower.new
19
27
 
20
28
  include Colours
21
29
 
22
- attr_reader :files
30
+ N = "\n"
31
+
32
+ # ========================================================================= #
33
+ # === DEFAULT_FILE
34
+ # ========================================================================= #
35
+ DEFAULT_FILE =
36
+ '/Users/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/tools/show_available_users.rb'
23
37
 
24
- DEFAULT_FILE = '/Users/x/DATA/PROGRAMMING_LANGUAGES/RUBY/SRC/TOOLS/show_available_users.rb'
38
+ # ========================================================================= #
39
+ # === FORBIDDEN_CHARACTERS
40
+ # ========================================================================= #
25
41
  FORBIDDEN_CHARACTERS = '# ===='
26
42
 
43
+ # ========================================================================= #
44
+ # === ENCODING_TO_USE
45
+ # ========================================================================= #
46
+ ENCODING_TO_USE = 'ISO-8859-1' # Which Encoding to consistently use for this class.
47
+
48
+ # ========================================================================= #
49
+ # === initialize
50
+ #
51
+ # The first argument should be a .rb file.
52
+ #
53
+ # The second argument can be :silent, in which case we will be silent
54
+ # rather than verbose.
55
+ # ========================================================================= #
27
56
  def initialize(
28
- i = nil,
57
+ i = nil,
29
58
  run_already = true
30
59
  )
31
60
  be_silent
@@ -36,65 +65,146 @@ class ClassDocuShower # require 'class_docu_shower'; ClassDocuShower.new
36
65
  @be_verbose = run_already[:verbose]
37
66
  run_already = true
38
67
  end
39
- elsif run_already == :silent
40
- be_silent
41
- run_already = true
68
+ else
69
+ case run_already
70
+ when :silent
71
+ be_silent
72
+ run_already = true
73
+ when :no_colours
74
+ @use_colours = false
75
+ run_already = true
76
+ end
77
+ end
78
+ if block_given?
79
+ yielded = yield
80
+ case yielded
81
+ when :do_not_report_the_filename
82
+ @report_the_filename = false
83
+ end
42
84
  end
43
85
  run if run_already
44
86
  end
45
- def reset # (reset tag)
46
- @data = nil
47
- @usher = Usher.new
87
+
88
+ # ========================================================================= #
89
+ # === reset (reset tag)
90
+ # ========================================================================= #
91
+ def reset
92
+ @data = nil
93
+ if Object.const_defined? :Usher
94
+ @usher = Usher.new
95
+ else
96
+ @usher = nil
97
+ end
98
+ @result = nil
99
+ @use_colours = true
100
+ @report_the_filename = true
48
101
  end
102
+
103
+ # ========================================================================= #
104
+ # === reset_usher_object
105
+ # ========================================================================= #
49
106
  def reset_usher_object
50
- @usher.reset
51
- @usher.allow_n_changes = 1
107
+ if @usher
108
+ @usher.reset
109
+ @usher.allow_n_changes = 1
110
+ end
52
111
  end
53
- def be_verbose; @be_verbose = true; end
54
- def be_silent; @be_verbose = false; end
55
- def set_files(i = DEFAULT_FILE)
56
- # i = i[0] if i.is_a? Array
57
- i = DEFAULT_FILE if i.nil?
58
- # i = i.to_s.dup if i
59
- i = [i] unless i.is_a? Array # Must always be an Array.
60
- i = i.flatten # But keep it flattened.
61
- @files = i
112
+
113
+ # ========================================================================= #
114
+ # === be_verbose
115
+ # ========================================================================= #
116
+ def be_verbose
117
+ @be_verbose = true
118
+ end
119
+
120
+ # ========================================================================= #
121
+ # === be_silent
122
+ # ========================================================================= #
123
+ def be_silent
124
+ @be_verbose = false
125
+ end
126
+
127
+ # ========================================================================= #
128
+ # === file?
129
+ # ========================================================================= #
130
+ def file?
131
+ @file.to_s
62
132
  end
133
+
134
+ # ========================================================================= #
135
+ # === show_the_result
136
+ # ========================================================================= #
137
+ def show_the_result
138
+ e @result if result?
139
+ end
140
+
141
+ # ========================================================================= #
142
+ # === use_colours?
143
+ # ========================================================================= #
144
+ def use_colours?
145
+ @use_colours
146
+ end
147
+
148
+ # ========================================================================= #
149
+ # === read_in_file
150
+ #
151
+ # We determine @data here.
152
+ # ========================================================================= #
63
153
  def read_in_file(this_file = @file)
64
154
  if File.exist? this_file
65
- @data = File.readlines(this_file)
155
+ @data = File.readlines(this_file, :encoding => ENCODING_TO_USE)
66
156
  else # We should report.
67
- opn; e 'We could not find a file at '+sfile(this_file)+','
68
- opn; e 'thus can not check whether it has an documentation.'
157
+ result = 'We could not find a file at '+sfile(this_file)+','
158
+ result = Colours.remove_colours(result) unless use_colours?
159
+ opn; e result
160
+ result = 'thus can not check whether it has an documentation.'
161
+ result = Colours.remove_colours(result) unless use_colours?
162
+ opn; e result
69
163
  end
70
164
  end
165
+
166
+ # ========================================================================= #
167
+ # === result?
168
+ # ========================================================================= #
169
+ def result?
170
+ @result
171
+ end
172
+
173
+ # ========================================================================= #
174
+ # === show_result
175
+ # ========================================================================= #
71
176
  def show_result
72
- if @be_verbose # We will be chatty here.
73
- opn; e 'From the file '+sfile(@file)+' we '
74
- opn; e 'can show this result:'
177
+ if @be_verbose # We will be chatty here, aka, verbose.
178
+ result = 'From the file '+sfile(file?)+' we '
179
+ result = Colours.remove_colours(result) unless use_colours?
180
+ opn; e result
181
+ result = 'can show this result:'
182
+ result = Colours.remove_colours(result) unless use_colours?
183
+ opn; e result
75
184
  end
76
185
  show_the_result
77
186
  end
78
- def show_the_result
79
- e @result
80
- end
81
- def process_dataset
82
- reset_usher_object
83
- @data.each {|entry| # @data is an Array.
84
- if entry.include? FORBIDDEN_CHARACTERS
85
- @usher.toggle
86
- else
87
- # Else add the entry. We should not use .lstrip
88
- # on it because that way we can preserve
89
- # indent.
90
- @usher << entry.delete('#') # .lstrip
91
- end
92
- }
93
- @result = @usher._
94
- end
95
- def show_file_header(i)
96
- e 'From file '+sfile(i)+':'+N+N
187
+
188
+ # ========================================================================= #
189
+ # === files?
190
+ # ========================================================================= #
191
+ def files?
192
+ @files
193
+ end; alias files files? # === files
194
+
195
+ # ========================================================================= #
196
+ # === sfile
197
+ # ========================================================================= #
198
+ def sfile(i = '')
199
+ i = Colours.sfile(i) if use_colours?
200
+ return i
97
201
  end
202
+
203
+ # ========================================================================= #
204
+ # === process
205
+ #
206
+ # This method contains the in-class logic.
207
+ # ========================================================================= #
98
208
  def process
99
209
  @files.each {|file|
100
210
  show_file_header(file)
@@ -104,12 +214,78 @@ class ClassDocuShower # require 'class_docu_shower'; ClassDocuShower.new
104
214
  e
105
215
  }
106
216
  end
107
- def run # (run tag)
217
+
218
+ # ========================================================================= #
219
+ # === process_dataset
220
+ # ========================================================================= #
221
+ def process_dataset
222
+ reset_usher_object
223
+ if @data
224
+ @data.each {|entry| # @data is an Array.
225
+ if entry.include? FORBIDDEN_CHARACTERS # Reject leading '# ===' parts.
226
+ @usher.toggle if @usher
227
+ else
228
+ # ================================================================= #
229
+ # Else add the entry. We should not use .lstrip on it because
230
+ # that way we can preserve the original indent.
231
+ # ================================================================= #
232
+ entry.delete!('#') # .lstrip
233
+ if use_colours? and Object.const_defined?(:Colours)
234
+ if entry.start_with? ' ==='
235
+ entry = orange(entry)
236
+ elsif entry.include? 'Usage examples:'
237
+ entry = lightblue(entry)
238
+ end
239
+ end
240
+ @usher << entry if @usher
241
+ end
242
+ }
243
+ @result = @usher._ if @usher
244
+ end
245
+ end
246
+
247
+ # ========================================================================= #
248
+ # === set_files
249
+ # ========================================================================= #
250
+ def set_files(i = DEFAULT_FILE)
251
+ i = DEFAULT_FILE if i.nil?
252
+ # i = i.to_s.dup if i
253
+ i = [i] unless i.is_a? Array # Must always be an Array.
254
+ i.flatten! # But keep it flattened.
255
+ @files = i
256
+ end
257
+
258
+ # ========================================================================= #
259
+ # === show_file_header
260
+ #
261
+ # This method will show the header, with an introduction like
262
+ # "From file bla".
263
+ # ========================================================================= #
264
+ def show_file_header(i)
265
+ if @report_the_filename#
266
+ result = 'From file '+sfile(i)+':'+N+N
267
+ result = Colours.remove_colours(result) unless use_colours?
268
+ e result
269
+ end
270
+ end
271
+
272
+ # ========================================================================= #
273
+ # === run (run tag)
274
+ # ========================================================================= #
275
+ def run
108
276
  process
109
277
  end
110
278
 
279
+ # ========================================================================= #
280
+ # === ClassDocuShower[]
281
+ # ========================================================================= #
282
+ def self.[](i)
283
+ ClassDocuShower.new(i)
284
+ end
285
+
111
286
  end
112
287
 
113
288
  if __FILE__ == $PROGRAM_NAME
114
- ClassDocuShower.new(ARGV, :silent)
115
- end # cdocu
289
+ _ = ClassDocuShower.new(ARGV, :silent)
290
+ # pp _.result? # This here for debug.
291
+ end # rdocu
@@ -0,0 +1,30 @@
1
+ #!/System/Index/bin/ruby -w
2
+ # Encoding: UTF-8
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ # Colour-related code will be stored here.
6
+ # =========================================================================== #
7
+ class ClassDocuShower
8
+
9
+ # ========================================================================= #
10
+ # === orange
11
+ # ========================================================================= #
12
+ def orange(i)
13
+ ::Colours.orange(i)
14
+ end
15
+
16
+ # ========================================================================= #
17
+ # === slateblue
18
+ # ========================================================================= #
19
+ def slateblue(i)
20
+ ::Colours.slateblue(i)
21
+ end
22
+
23
+ # ========================================================================= #
24
+ # === lightblue
25
+ # ========================================================================= #
26
+ def lightblue(i)
27
+ ::Colours.lightblue(i)
28
+ end
29
+
30
+ end
@@ -0,0 +1,14 @@
1
+ #!/System/Index/bin/ruby -w
2
+ # Encoding: ISO-8859-1
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ # require 'class_docu_shower/version/version.rb'
6
+ # =========================================================================== #
7
+ class ClassDocuShower
8
+
9
+ # ========================================================================= #
10
+ # === ClassDocuShower::VERSION
11
+ # ========================================================================= #
12
+ VERSION = '1.0.21'
13
+
14
+ end
@@ -0,0 +1,14 @@
1
+ #!/System/Index/bin/ruby -w
2
+ # Encoding: ISO-8859-1
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ require 'colour_e/autoinclude'
6
+ require 'class_docu_shower'
7
+
8
+ i = '/Users/x/DATA/PROGRAMMING_LANGUAGES/RUBY/SRC/cookbooks/lib/cookbooks/utility_scripts/registered_libraries.rb' # The class comes here.
9
+ e 'Using colour-codes next.'
10
+ e
11
+ ClassDocuShower.new(i)
12
+ e 'Getting rid of all colour-codes.'
13
+ e
14
+ ClassDocuShower.new(i, :no_colours)
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: class_docu_shower
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.3
4
+ version: 1.0.21
5
5
  platform: ruby
6
6
  authors:
7
7
  - Robert A. Heiler
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-04-16 00:00:00.000000000 Z
11
+ date: 2019-05-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: colours
@@ -16,61 +16,52 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.0.12
19
+ version: '0'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: 0.0.12
26
+ version: '0'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: opn
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: 1.0.0
33
+ version: '0'
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - ">="
39
39
  - !ruby/object:Gem::Version
40
- version: 1.0.0
41
- - !ruby/object:Gem::Dependency
42
- name: usher
43
- requirement: !ruby/object:Gem::Requirement
44
- requirements:
45
- - - ">="
46
- - !ruby/object:Gem::Version
47
- version: 0.0.6
48
- type: :runtime
49
- prerelease: false
50
- version_requirements: !ruby/object:Gem::Requirement
51
- requirements:
52
- - - ">="
53
- - !ruby/object:Gem::Version
54
- version: 0.0.6
55
- description: "\n This library is called class_docu_shower.\n \n It will display
56
- the header of a .rb file in question.\n For this to properly function, you should
57
- use 3 =\n followed by the name of the class, and delimited\n in # ===== entries.\n
58
- \ \n Example:\n \n === Menu\n\n If you have specific suggestions to
59
- make this gem more\n useful for others, please drop me an email at:\n shevegen@gmail.com\n
60
- \ Thank you.\n\n"
40
+ version: '0'
41
+ description: " \nThis library is called class_docu_shower.\n\nIt will display the
42
+ header of a .rb file in question.\n\nFor this to properly function, you should use
43
+ 3 '=' characters,\nfollowed by the name of the class, and delimited via '# ====='\nentries.\n\nExample:\n\n'===
44
+ Menu'\n\nWithout the '' quotes.\n\nThere also is an executable at bin/class_docu_shower.\n\nPass
45
+ it the path to a .rb file and it will output the\ntop header comment.\n\n"
61
46
  email: shevegen@gmail.com
62
47
  executables: []
63
48
  extensions: []
64
49
  extra_rdoc_files:
65
50
  - USAGE.md
66
51
  files:
52
+ - README.md
67
53
  - USAGE.md
54
+ - bin/class_docu_shower
68
55
  - class_docu_shower.gemspec
56
+ - doc/README.gen
69
57
  - lib/class_docu_shower.rb
70
58
  - lib/class_docu_shower/class_docu_shower.rb
59
+ - lib/class_docu_shower/colours.rb
60
+ - lib/class_docu_shower/version/version.rb
61
+ - test/testing_class_docu_shower.rb
71
62
  homepage: http://rubygems.org/gems/class_docu_shower
72
63
  licenses:
73
- - GPL 2
64
+ - GPL-2.0
74
65
  metadata: {}
75
66
  post_install_message:
76
67
  rdoc_options: []
@@ -80,21 +71,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
80
71
  requirements:
81
72
  - - ">="
82
73
  - !ruby/object:Gem::Version
83
- version: 1.9.2
74
+ version: 2.6.3
84
75
  required_rubygems_version: !ruby/object:Gem::Requirement
85
76
  requirements:
86
77
  - - ">="
87
78
  - !ruby/object:Gem::Version
88
- version: '0'
79
+ version: 3.0.3
89
80
  requirements: []
90
- rubyforge_project:
91
- rubygems_version: 2.2.2
81
+ rubygems_version: 3.0.3
92
82
  signing_key:
93
83
  specification_version: 4
94
- summary: 'It will display the header of a .rb file in question. For this to properly
95
- function, you should use 3 = followed by the name of the class, and delimited in
96
- # ===== entries. Example: === Menu If you have specific suggestions to make this
97
- gem more useful for others, please drop me an email at: shevegen@gmail.com Thank
98
- you.'
84
+ summary: 'This library is called class_docu_shower. It will display the header of
85
+ a .rb file in question. For this to properly function, you should use 3 ''='' characters,
86
+ followed by the name of the class, and delimited via ''# ====='' entries. Example: ''===
87
+ Menu'' Without the '''' quotes. There also is an executable at bin/class_docu_shower. Pass
88
+ it the path to a .rb file and it will output the top header comment.'
99
89
  test_files: []
100
- has_rdoc: