rdoc-markdown 0.4.2 → 0.6.0

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.
Files changed (23) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +0 -2
  3. data/Gemfile.lock +52 -33
  4. data/README.md +70 -2
  5. data/Rakefile +174 -0
  6. data/example/Bird.md +15 -9
  7. data/example/Duck.md +61 -49
  8. data/example/Object.md +9 -6
  9. data/example/Waterfowl.md +8 -5
  10. data/example/index.csv +16 -0
  11. data/lib/rdoc/generator/markdown.rb +441 -93
  12. data/lib/rdoc/markdown/version.rb +1 -1
  13. data/lib/templates/classfile.md.erb +56 -35
  14. data/rdoc-markdown.gemspec +25 -25
  15. metadata +38 -48
  16. data/.standard.yml +0 -10
  17. data/.streerc +0 -2
  18. data/example/RDoc/Generator/Markdown.md +0 -30
  19. data/example/RDoc/Generator.md +0 -2
  20. data/example/RDoc/Markdown.md +0 -6
  21. data/example/RDoc.md +0 -2
  22. data/example/TestGenerator.md +0 -10
  23. data/example/index.db +0 -0
data/lib/templates/classfile.md.erb CHANGED
@@ -1,35 +1,56 @@
1
- # <%= klass.type %> <%= klass.full_name %> [](#<%= klass.aref.strip %>) [](#top)
2
- <%= h klass.description %>
3
- <% klass.each_section do |section, constants, attributes| %>
4
- <% if section.title %># <%= section.title.strip %>
5
-
6
- <% end %>
7
- <% if section.comment %> <%=h section.description %>
8
-
9
- <%end%>
10
- <% unless klass.constants.empty? %>
11
- ## Constants
12
- | Name | Description |
13
- | ---- | ----------- |
14
- <% klass.constants.each do |const| %> | **<%= const.name %>[](#<%= const.name %>)** | <% unless const.description.empty? %> <%= h(const.description).rstrip %> <%else%> Not documented <% end %> |
15
- <% end %>
16
- <% end %>
17
- <% unless attributes&.empty? %>
18
- ## Attributes
19
- <% attributes.each do |attr| %>
20
- ### <%= attr.name %>[<%= attr.rw %>] [](#<%= attr.aref.strip %>)
21
- <% if attr.comment %> <%= h(attr.description) %> <%else%> Not documented <% end %>
22
- <% end %>
23
- <% end %>
24
- <% klass.methods_by_type(section).each do |type, visibilities| %>
25
- <% next if visibilities.empty? %>
26
- <% visibilities.each do |visibility, methods| %>
27
- <% next if methods.empty? %>
28
- ## <%= visibility.capitalize %> <%= type.capitalize %> Methods
29
- <% methods.each do |method|%>
30
- ### <%= method.name %><%= method.param_seq %> [](#<%= method.aref %>)
31
- <% if method.comment %> <%= h(method.description) %> <% else %> Not documented <%end%>
32
- <% end %>
33
- <% end %>
34
- <% end %>
35
- <% end %>
1
+ # <%= klass.type.capitalize %> <%= display_name(klass) %>
2
+ <%= anchor(klass.aref.strip) %>
3
+ <%- class_description = describe(klass) -%>
4
+ <%- unless class_description.empty? -%>
5
+
6
+ <%= class_description %>
7
+ <%- end -%>
8
+
9
+ <% klass.each_section do |section, constants, attributes| -%>
10
+ <%- section_title = section.title.to_s.strip -%>
11
+ <%- unless section_title.empty? -%>
12
+
13
+ ## <%= section_title %>
14
+ <%- end -%>
15
+ <%- section_description = section_description(section, heading_level_offset: 2) -%>
16
+ <%- unless section_description.empty? -%>
17
+
18
+ <%= section_description %>
19
+ <%- end -%>
20
+ <%- unless constants.empty? -%>
21
+
22
+ ### Constants
23
+ <% constants.sort_by(&:name).each do |const| -%>
24
+
25
+ #### `<%= const.name %>`
26
+ <%= anchor(const.name) %>
27
+
28
+ <%= describe(const, fallback: "Not documented.", heading_level_offset: 4) %>
29
+ <% end -%>
30
+ <%- end -%>
31
+ <%- unless attributes.empty? -%>
32
+
33
+ ### Attributes
34
+ <% attributes.sort_by(&:name).each do |attr| -%>
35
+
36
+ #### `<%= attr.name %>` [<%= attr.rw %>]
37
+ <%= anchor(attr.aref.strip) %>
38
+
39
+ <%= describe(attr, fallback: "Not documented.", heading_level_offset: 4) %>
40
+ <% end -%>
41
+ <%- end -%>
42
+ <% klass.methods_by_type(section).each do |type, visibilities| -%>
43
+ <% visibilities.each do |visibility, methods| -%>
44
+ <% next if methods.empty? -%>
45
+
46
+ ### <%= visibility.capitalize %> <%= type.capitalize %> Methods
47
+ <% methods.each do |method| -%>
48
+
49
+ #### `<%= method.name %><%= method_signature(method) %>`
50
+ <%= anchor(method.aref) %>
51
+
52
+ <%= method_description(method, current_class: klass) %>
53
+ <% end -%>
54
+ <% end -%>
55
+ <% end -%>
56
+ <% end -%>
data/rdoc-markdown.gemspec CHANGED
@@ -1,24 +1,24 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require_relative "lib/rdoc/markdown/version"
3
+ require_relative 'lib/rdoc/markdown/version'
4
4
 
5
5
  Gem::Specification.new do |spec|
6
- spec.name = "rdoc-markdown"
6
+ spec.name = 'rdoc-markdown'
7
7
  spec.version = Rdoc::Markdown::VERSION
8
- spec.authors = ["Stanislav (Stas) Katkov"]
9
- spec.email = ["github@skatkov.com"]
10
- spec.license = "GPL-3.0-or-later"
8
+ spec.authors = ['Stanislav (Stas) Katkov']
9
+ spec.email = ['github@skatkov.com']
10
+ spec.license = 'GPL-3.0-or-later'
11
11
 
12
- spec.summary = "RDoc plugin to generate markdown documentation "
13
- spec.description = "RDoc plugin to generate markdown documentation and search index as sqlite database for entire content."
14
- spec.homepage = "https://poshtui.com"
15
- spec.required_ruby_version = ">= 2.7.0"
12
+ spec.summary = 'RDoc plugin to generate markdown documentation '
13
+ spec.description = 'RDoc plugin to generate markdown documentation and search index as sqlite database for entire content.'
14
+ spec.homepage = 'https://poshtui.com'
15
+ spec.required_ruby_version = '>= 2.7.0'
16
16
 
17
17
  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
18
18
 
19
- spec.metadata["homepage_uri"] = spec.homepage
20
- spec.metadata["source_code_uri"] = "https://github.com/skatkov/rdoc-markdown"
21
- spec.metadata["changelog_uri"] = "https://github.com/skatkov/rdoc-markdown"
19
+ spec.metadata['homepage_uri'] = spec.homepage
20
+ spec.metadata['source_code_uri'] = 'https://github.com/skatkov/rdoc-markdown'
21
+ spec.metadata['changelog_uri'] = 'https://github.com/skatkov/rdoc-markdown'
22
22
 
23
23
  # Specify which files should be added to the gem when it is released.
24
24
  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,18 +27,18 @@ Gem::Specification.new do |spec|
27
27
  (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
28
28
  end
29
29
  end
30
- spec.bindir = "exe"
30
+ spec.bindir = 'exe'
31
31
  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
32
- spec.require_paths = ["lib"]
33
-
34
- spec.add_dependency "rdoc", "~> 6.0"
35
- spec.add_dependency "erb", "~> 2.0"
36
- spec.add_dependency "reverse_markdown", "~> 2.0"
37
- spec.add_dependency "extralite-bundle", "~> 1.0"
38
- spec.add_dependency "unindent", "~> 1.0"
39
-
40
- spec.add_development_dependency "minitest", "~> 5.0"
41
- spec.add_development_dependency "rake", "~> 13.0"
42
- spec.add_development_dependency "bundler", "~> 2.0"
43
- spec.add_development_dependency "rdiscount", "~> 2.0"
32
+ spec.require_paths = ['lib']
33
+
34
+ spec.add_dependency 'csv'
35
+ spec.add_dependency 'erb'
36
+ spec.add_dependency 'rdoc'
37
+ spec.add_dependency 'reverse_markdown'
38
+
39
+ spec.add_development_dependency 'bundler', '~> 2.0'
40
+ spec.add_development_dependency 'commonmarker'
41
+ spec.add_development_dependency 'minitest', '~> 5.0'
42
+ spec.add_development_dependency 'rake', '~> 13.0'
43
+ spec.add_development_dependency 'rdiscount', '~> 2.0'
44
44
  end
metadata CHANGED
@@ -1,127 +1,126 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rdoc-markdown
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.2
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stanislav (Stas) Katkov
8
- autorequire:
9
8
  bindir: exe
10
9
  cert_chain: []
11
- date: 2023-10-15 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
- name: rdoc
13
+ name: csv
15
14
  requirement: !ruby/object:Gem::Requirement
16
15
  requirements:
17
- - - "~>"
16
+ - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: '6.0'
18
+ version: '0'
20
19
  type: :runtime
21
20
  prerelease: false
22
21
  version_requirements: !ruby/object:Gem::Requirement
23
22
  requirements:
24
- - - "~>"
23
+ - - ">="
25
24
  - !ruby/object:Gem::Version
26
- version: '6.0'
25
+ version: '0'
27
26
  - !ruby/object:Gem::Dependency
28
27
  name: erb
29
28
  requirement: !ruby/object:Gem::Requirement
30
29
  requirements:
31
- - - "~>"
30
+ - - ">="
32
31
  - !ruby/object:Gem::Version
33
- version: '2.0'
32
+ version: '0'
34
33
  type: :runtime
35
34
  prerelease: false
36
35
  version_requirements: !ruby/object:Gem::Requirement
37
36
  requirements:
38
- - - "~>"
37
+ - - ">="
39
38
  - !ruby/object:Gem::Version
40
- version: '2.0'
39
+ version: '0'
41
40
  - !ruby/object:Gem::Dependency
42
- name: reverse_markdown
41
+ name: rdoc
43
42
  requirement: !ruby/object:Gem::Requirement
44
43
  requirements:
45
- - - "~>"
44
+ - - ">="
46
45
  - !ruby/object:Gem::Version
47
- version: '2.0'
46
+ version: '0'
48
47
  type: :runtime
49
48
  prerelease: false
50
49
  version_requirements: !ruby/object:Gem::Requirement
51
50
  requirements:
52
- - - "~>"
51
+ - - ">="
53
52
  - !ruby/object:Gem::Version
54
- version: '2.0'
53
+ version: '0'
55
54
  - !ruby/object:Gem::Dependency
56
- name: extralite-bundle
55
+ name: reverse_markdown
57
56
  requirement: !ruby/object:Gem::Requirement
58
57
  requirements:
59
- - - "~>"
58
+ - - ">="
60
59
  - !ruby/object:Gem::Version
61
- version: '1.0'
60
+ version: '0'
62
61
  type: :runtime
63
62
  prerelease: false
64
63
  version_requirements: !ruby/object:Gem::Requirement
65
64
  requirements:
66
- - - "~>"
65
+ - - ">="
67
66
  - !ruby/object:Gem::Version
68
- version: '1.0'
67
+ version: '0'
69
68
  - !ruby/object:Gem::Dependency
70
- name: unindent
69
+ name: bundler
71
70
  requirement: !ruby/object:Gem::Requirement
72
71
  requirements:
73
72
  - - "~>"
74
73
  - !ruby/object:Gem::Version
75
- version: '1.0'
76
- type: :runtime
74
+ version: '2.0'
75
+ type: :development
77
76
  prerelease: false
78
77
  version_requirements: !ruby/object:Gem::Requirement
79
78
  requirements:
80
79
  - - "~>"
81
80
  - !ruby/object:Gem::Version
82
- version: '1.0'
81
+ version: '2.0'
83
82
  - !ruby/object:Gem::Dependency
84
- name: minitest
83
+ name: commonmarker
85
84
  requirement: !ruby/object:Gem::Requirement
86
85
  requirements:
87
- - - "~>"
86
+ - - ">="
88
87
  - !ruby/object:Gem::Version
89
- version: '5.0'
88
+ version: '0'
90
89
  type: :development
91
90
  prerelease: false
92
91
  version_requirements: !ruby/object:Gem::Requirement
93
92
  requirements:
94
- - - "~>"
93
+ - - ">="
95
94
  - !ruby/object:Gem::Version
96
- version: '5.0'
95
+ version: '0'
97
96
  - !ruby/object:Gem::Dependency
98
- name: rake
97
+ name: minitest
99
98
  requirement: !ruby/object:Gem::Requirement
100
99
  requirements:
101
100
  - - "~>"
102
101
  - !ruby/object:Gem::Version
103
- version: '13.0'
102
+ version: '5.0'
104
103
  type: :development
105
104
  prerelease: false
106
105
  version_requirements: !ruby/object:Gem::Requirement
107
106
  requirements:
108
107
  - - "~>"
109
108
  - !ruby/object:Gem::Version
110
- version: '13.0'
109
+ version: '5.0'
111
110
  - !ruby/object:Gem::Dependency
112
- name: bundler
111
+ name: rake
113
112
  requirement: !ruby/object:Gem::Requirement
114
113
  requirements:
115
114
  - - "~>"
116
115
  - !ruby/object:Gem::Version
117
- version: '2.0'
116
+ version: '13.0'
118
117
  type: :development
119
118
  prerelease: false
120
119
  version_requirements: !ruby/object:Gem::Requirement
121
120
  requirements:
122
121
  - - "~>"
123
122
  - !ruby/object:Gem::Version
124
- version: '2.0'
123
+ version: '13.0'
125
124
  - !ruby/object:Gem::Dependency
126
125
  name: rdiscount
127
126
  requirement: !ruby/object:Gem::Requirement
@@ -145,8 +144,6 @@ extensions: []
145
144
  extra_rdoc_files: []
146
145
  files:
147
146
  - ".editorconfig"
148
- - ".standard.yml"
149
- - ".streerc"
150
147
  - CODE_OF_CONDUCT.md
151
148
  - Gemfile
152
149
  - Gemfile.lock
@@ -156,13 +153,8 @@ files:
156
153
  - example/Bird.md
157
154
  - example/Duck.md
158
155
  - example/Object.md
159
- - example/RDoc.md
160
- - example/RDoc/Generator.md
161
- - example/RDoc/Generator/Markdown.md
162
- - example/RDoc/Markdown.md
163
- - example/TestGenerator.md
164
156
  - example/Waterfowl.md
165
- - example/index.db
157
+ - example/index.csv
166
158
  - lib/markdown.rb
167
159
  - lib/rdoc/discover.rb
168
160
  - lib/rdoc/generator/markdown.rb
@@ -177,7 +169,6 @@ metadata:
177
169
  homepage_uri: https://poshtui.com
178
170
  source_code_uri: https://github.com/skatkov/rdoc-markdown
179
171
  changelog_uri: https://github.com/skatkov/rdoc-markdown
180
- post_install_message:
181
172
  rdoc_options: []
182
173
  require_paths:
183
174
  - lib
@@ -192,8 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
192
183
  - !ruby/object:Gem::Version
193
184
  version: '0'
194
185
  requirements: []
195
- rubygems_version: 3.4.20
196
- signing_key:
186
+ rubygems_version: 4.0.3
197
187
  specification_version: 4
198
188
  summary: RDoc plugin to generate markdown documentation
199
189
  test_files: []
data/.standard.yml DELETED
@@ -1,10 +0,0 @@
1
- # For available configuration options, see:
2
- # https://github.com/testdouble/standard
3
- ruby_version: 2.7
4
- parallel: true
5
- format: progress
6
-
7
- ignore:
8
- - 'docs/example.rb'
9
- - '**/*':
10
- - Style/GlobalVars
data/.streerc DELETED
@@ -1,2 +0,0 @@
1
- --print-width=100
2
- --plugins=plugin/trailing_comma,disable_ternary
data/example/RDoc/Generator/Markdown.md DELETED
@@ -1,30 +0,0 @@
1
- # class RDoc::Generator::Markdown [](#class-RDoc::Generator::Markdown) [](#top)
2
- ## Constants
3
- | Name | Description |
4
- | ---- | ----------- |
5
- | **TEMPLATE_DIR[](#TEMPLATE_DIR)** | Defines a constant for directory where templates could be found |
6
- ## Attributes
7
- ### base_dir[R] [](#attribute-i-base_dir)
8
- The path to generate files into, combined with `--op` from the options for a full path.
9
-
10
- ### classes[R] [](#attribute-i-classes)
11
- Classes and modules to be used by this generator, not necessarily displayed.
12
-
13
- ### store[R] [](#attribute-i-store)
14
- The RDoc::Store that is the source of the generated content
15
-
16
- ## Public Class Methods
17
- ### new(store, options) [](#method-c-new)
18
- Initializer method for Rdoc::Generator::Markdown
19
-
20
- ## Public Instance Methods
21
- ### class_dir() [](#method-i-class_dir)
22
- Directory where generated class HTML files live relative to the output dir.
23
-
24
- ### file_dir() [](#method-i-file_dir)
25
- this alias is required for rdoc to work
26
-
27
- ### generate() [](#method-i-generate)
28
- Generates markdown files and search index file
29
-
30
-
data/example/RDoc/Generator.md DELETED
@@ -1,2 +0,0 @@
1
- # module RDoc::Generator [](#module-RDoc::Generator) [](#top)
2
-
data/example/RDoc/Markdown.md DELETED
@@ -1,6 +0,0 @@
1
- # module Rdoc::Markdown [](#module-Rdoc::Markdown) [](#top)
2
- ## Constants
3
- | Name | Description |
4
- | ---- | ----------- |
5
- | **VERSION[](#VERSION)** | Not documented |
6
-
data/example/RDoc.md DELETED
@@ -1,2 +0,0 @@
1
- # module Rdoc [](#module-Rdoc) [](#top)
2
-
data/example/TestGenerator.md DELETED
@@ -1,10 +0,0 @@
1
- # class TestGenerator [](#class-TestGenerator) [](#top)
2
- ## Constants
3
- | Name | Description |
4
- | ---- | ----------- |
5
- | **CLASSES[](#CLASSES)** | Not documented |
6
- ## Public Instance Methods
7
- ### run_generator(file, title) { |options| ... } [](#method-i-run_generator)
8
- ### source_file() [](#method-i-source_file)
9
- ### test_generator() [](#method-i-test_generator)
10
-
data/example/index.db DELETED
Binary file