rspec-documentation 0.0.1 → 0.0.3
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 +4 -4
- data/.rspec +1 -0
- data/.rubocop.yml +3 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +25 -2
- data/Makefile +9 -0
- data/README.md +18 -22
- data/Rakefile +1 -0
- data/exe/rspec-documentation +17 -0
- data/lib/rspec/documentation/version.rb +2 -2
- data/lib/rspec/documentation.rb +15 -2
- data/lib/rspec_documentation/configuration.rb +28 -0
- data/lib/rspec_documentation/document.rb +75 -0
- data/lib/rspec_documentation/documentation.rb +85 -0
- data/lib/rspec_documentation/formatters/ansi.rb +44 -0
- data/lib/rspec_documentation/formatters/html.rb +31 -0
- data/lib/rspec_documentation/formatters/json.rb +32 -0
- data/lib/rspec_documentation/formatters/ruby.rb +31 -0
- data/lib/rspec_documentation/formatters/yaml.rb +36 -0
- data/lib/rspec_documentation/formatters.rb +20 -0
- data/lib/rspec_documentation/html_element.rb +58 -0
- data/lib/rspec_documentation/javascript_bundle.rb +17 -0
- data/lib/rspec_documentation/markdown_renderer.rb +7 -0
- data/lib/rspec_documentation/page_collection.rb +64 -0
- data/lib/rspec_documentation/page_tree.rb +81 -0
- data/lib/rspec_documentation/page_tree_element.rb +78 -0
- data/lib/rspec_documentation/parsed_document.rb +72 -0
- data/lib/rspec_documentation/project_initialization.rb +52 -0
- data/lib/rspec_documentation/rspec/failure.rb +52 -0
- data/lib/rspec_documentation/rspec.rb +12 -0
- data/lib/rspec_documentation/spec.rb +108 -0
- data/lib/rspec_documentation/stylesheet_bundle.rb +17 -0
- data/lib/rspec_documentation/summary.rb +87 -0
- data/lib/rspec_documentation/util.rb +58 -0
- data/lib/rspec_documentation.rb +71 -0
- data/lib/tasks/rspec/documentation/generate.rake +10 -0
- data/lib/templates/000-Introduction.md.erb +35 -0
- data/lib/templates/010-Usage.md.erb +3 -0
- data/lib/templates/500-License.md.erb +3 -0
- data/lib/templates/bootstrap.js.erb +7 -0
- data/lib/templates/footer.html.erb +6 -0
- data/lib/templates/header.html.erb +20 -0
- data/lib/templates/layout.css.erb +418 -0
- data/lib/templates/layout.html.erb +31 -0
- data/lib/templates/layout.js.erb +67 -0
- data/lib/templates/modal_spec.html.erb +51 -0
- data/lib/templates/moon.svg.erb +1 -0
- data/lib/templates/script_tags.html.erb +1 -0
- data/lib/templates/stylesheet_links.html.erb +1 -0
- data/lib/templates/sun.svg.erb +1 -0
- data/lib/templates/tabbed_spec.html.erb +82 -0
- data/lib/templates/themes/bootstrap.min.css +11 -0
- data/lib/templates/themes/cerulean.css +11 -0
- data/lib/templates/themes/cosmo.css +11 -0
- data/lib/templates/themes/cyborg.css +11 -0
- data/lib/templates/themes/darkly.css +11 -0
- data/lib/templates/themes/flatly.css +11 -0
- data/lib/templates/themes/journal.css +11 -0
- data/lib/templates/themes/litera.css +11 -0
- data/lib/templates/themes/lumen.css +11 -0
- data/lib/templates/themes/lux.css +11 -0
- data/lib/templates/themes/materia.css +11 -0
- data/lib/templates/themes/minty.css +11 -0
- data/lib/templates/themes/morph.css +11 -0
- data/lib/templates/themes/pulse.css +11 -0
- data/lib/templates/themes/quartz.css +11 -0
- data/lib/templates/themes/sandstone.css +11 -0
- data/lib/templates/themes/simplex.css +11 -0
- data/lib/templates/themes/sketchy.css +11 -0
- data/lib/templates/themes/slate.css +11 -0
- data/lib/templates/themes/solar.css +11 -0
- data/lib/templates/themes/spacelab.css +11 -0
- data/lib/templates/themes/superhero.css +11 -0
- data/lib/templates/themes/united.css +11 -0
- data/lib/templates/themes/vapor.css +11 -0
- data/lib/templates/themes/yeti.css +11 -0
- data/lib/templates/themes/zephyr.css +11 -0
- data/rspec-documentation/pages/000-Introduction/000-Quickstart.md +17 -0
- data/rspec-documentation/pages/000-Introduction.md +23 -0
- data/rspec-documentation/pages/010-File System/000-Ordering.md +14 -0
- data/rspec-documentation/pages/010-File System/010-Documentation Bundle.md +9 -0
- data/rspec-documentation/pages/010-File System.md +26 -0
- data/rspec-documentation/pages/020-Running Tests.md +41 -0
- data/rspec-documentation/pages/030-Examples/010-Basic.md +51 -0
- data/rspec-documentation/pages/030-Examples/020-HTML.md +45 -0
- data/rspec-documentation/pages/030-Examples/030-ANSI.md +33 -0
- data/rspec-documentation/pages/030-Examples/040-JSON.md +39 -0
- data/rspec-documentation/pages/030-Examples/050-YAML.md +40 -0
- data/rspec-documentation/pages/030-Examples.md +7 -0
- data/rspec-documentation/pages/040-Spec Helper.md +11 -0
- data/rspec-documentation/pages/050-Linking.md +20 -0
- data/rspec-documentation/pages/060-Configuration/010-Context.md +26 -0
- data/rspec-documentation/pages/060-Configuration/020-Build Paths.md +33 -0
- data/rspec-documentation/pages/060-Configuration/030-Attribution.md +23 -0
- data/rspec-documentation/pages/060-Configuration.md +13 -0
- data/rspec-documentation/pages/070-Publishing.md +13 -0
- data/rspec-documentation/pages/500-License.md +11 -0
- data/rspec-documentation/spec_helper.rb +8 -0
- data/rspec-documentation.gemspec +10 -1
- data/sig/rspec/documentation.rbs +1 -1
- metadata +193 -5
metadata
CHANGED
|
@@ -1,19 +1,118 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: rspec-documentation
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Bob Farrell
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-
|
|
12
|
-
dependencies:
|
|
11
|
+
date: 2023-06-04 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: htmlbeautifier
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '1.4'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '1.4'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: kramdown
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '2.4'
|
|
34
|
+
type: :runtime
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - "~>"
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '2.4'
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: kramdown-parser-gfm
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - "~>"
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: '1.1'
|
|
48
|
+
type: :runtime
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - "~>"
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: '1.1'
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: paintbrush
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - "~>"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: 0.1.3
|
|
62
|
+
type: :runtime
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: 0.1.3
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: redcarpet
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '3.6'
|
|
76
|
+
type: :runtime
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: '3.6'
|
|
83
|
+
- !ruby/object:Gem::Dependency
|
|
84
|
+
name: rouge
|
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - "~>"
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: '4.1'
|
|
90
|
+
type: :runtime
|
|
91
|
+
prerelease: false
|
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - "~>"
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: '4.1'
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: rspec
|
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
|
100
|
+
requirements:
|
|
101
|
+
- - "~>"
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: '3.12'
|
|
104
|
+
type: :runtime
|
|
105
|
+
prerelease: false
|
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
107
|
+
requirements:
|
|
108
|
+
- - "~>"
|
|
109
|
+
- !ruby/object:Gem::Version
|
|
110
|
+
version: '3.12'
|
|
13
111
|
description: Generates documentation from RSpec code blocks in Markdown files.
|
|
14
112
|
email:
|
|
15
113
|
- git@bob.frl
|
|
16
|
-
executables:
|
|
114
|
+
executables:
|
|
115
|
+
- rspec-documentation
|
|
17
116
|
extensions: []
|
|
18
117
|
extra_rdoc_files: []
|
|
19
118
|
files:
|
|
@@ -25,13 +124,102 @@ files:
|
|
|
25
124
|
- Makefile
|
|
26
125
|
- README.md
|
|
27
126
|
- Rakefile
|
|
127
|
+
- exe/rspec-documentation
|
|
28
128
|
- lib/rspec/documentation.rb
|
|
29
129
|
- lib/rspec/documentation/version.rb
|
|
130
|
+
- lib/rspec_documentation.rb
|
|
131
|
+
- lib/rspec_documentation/configuration.rb
|
|
132
|
+
- lib/rspec_documentation/document.rb
|
|
133
|
+
- lib/rspec_documentation/documentation.rb
|
|
134
|
+
- lib/rspec_documentation/formatters.rb
|
|
135
|
+
- lib/rspec_documentation/formatters/ansi.rb
|
|
136
|
+
- lib/rspec_documentation/formatters/html.rb
|
|
137
|
+
- lib/rspec_documentation/formatters/json.rb
|
|
138
|
+
- lib/rspec_documentation/formatters/ruby.rb
|
|
139
|
+
- lib/rspec_documentation/formatters/yaml.rb
|
|
140
|
+
- lib/rspec_documentation/html_element.rb
|
|
141
|
+
- lib/rspec_documentation/javascript_bundle.rb
|
|
142
|
+
- lib/rspec_documentation/markdown_renderer.rb
|
|
143
|
+
- lib/rspec_documentation/page_collection.rb
|
|
144
|
+
- lib/rspec_documentation/page_tree.rb
|
|
145
|
+
- lib/rspec_documentation/page_tree_element.rb
|
|
146
|
+
- lib/rspec_documentation/parsed_document.rb
|
|
147
|
+
- lib/rspec_documentation/project_initialization.rb
|
|
148
|
+
- lib/rspec_documentation/rspec.rb
|
|
149
|
+
- lib/rspec_documentation/rspec/failure.rb
|
|
150
|
+
- lib/rspec_documentation/spec.rb
|
|
151
|
+
- lib/rspec_documentation/stylesheet_bundle.rb
|
|
152
|
+
- lib/rspec_documentation/summary.rb
|
|
153
|
+
- lib/rspec_documentation/util.rb
|
|
154
|
+
- lib/tasks/rspec/documentation/generate.rake
|
|
155
|
+
- lib/templates/000-Introduction.md.erb
|
|
156
|
+
- lib/templates/010-Usage.md.erb
|
|
157
|
+
- lib/templates/500-License.md.erb
|
|
158
|
+
- lib/templates/bootstrap.js.erb
|
|
159
|
+
- lib/templates/footer.html.erb
|
|
160
|
+
- lib/templates/header.html.erb
|
|
161
|
+
- lib/templates/layout.css.erb
|
|
162
|
+
- lib/templates/layout.html.erb
|
|
163
|
+
- lib/templates/layout.js.erb
|
|
164
|
+
- lib/templates/modal_spec.html.erb
|
|
165
|
+
- lib/templates/moon.svg.erb
|
|
166
|
+
- lib/templates/script_tags.html.erb
|
|
167
|
+
- lib/templates/stylesheet_links.html.erb
|
|
168
|
+
- lib/templates/sun.svg.erb
|
|
169
|
+
- lib/templates/tabbed_spec.html.erb
|
|
170
|
+
- lib/templates/themes/bootstrap.min.css
|
|
171
|
+
- lib/templates/themes/cerulean.css
|
|
172
|
+
- lib/templates/themes/cosmo.css
|
|
173
|
+
- lib/templates/themes/cyborg.css
|
|
174
|
+
- lib/templates/themes/darkly.css
|
|
175
|
+
- lib/templates/themes/flatly.css
|
|
176
|
+
- lib/templates/themes/journal.css
|
|
177
|
+
- lib/templates/themes/litera.css
|
|
178
|
+
- lib/templates/themes/lumen.css
|
|
179
|
+
- lib/templates/themes/lux.css
|
|
180
|
+
- lib/templates/themes/materia.css
|
|
181
|
+
- lib/templates/themes/minty.css
|
|
182
|
+
- lib/templates/themes/morph.css
|
|
183
|
+
- lib/templates/themes/pulse.css
|
|
184
|
+
- lib/templates/themes/quartz.css
|
|
185
|
+
- lib/templates/themes/sandstone.css
|
|
186
|
+
- lib/templates/themes/simplex.css
|
|
187
|
+
- lib/templates/themes/sketchy.css
|
|
188
|
+
- lib/templates/themes/slate.css
|
|
189
|
+
- lib/templates/themes/solar.css
|
|
190
|
+
- lib/templates/themes/spacelab.css
|
|
191
|
+
- lib/templates/themes/superhero.css
|
|
192
|
+
- lib/templates/themes/united.css
|
|
193
|
+
- lib/templates/themes/vapor.css
|
|
194
|
+
- lib/templates/themes/yeti.css
|
|
195
|
+
- lib/templates/themes/zephyr.css
|
|
30
196
|
- rspec-documentation-0.1.0.gem
|
|
31
197
|
- rspec-documentation.gemspec
|
|
198
|
+
- rspec-documentation/pages/000-Introduction.md
|
|
199
|
+
- rspec-documentation/pages/000-Introduction/000-Quickstart.md
|
|
200
|
+
- rspec-documentation/pages/010-File System.md
|
|
201
|
+
- rspec-documentation/pages/010-File System/000-Ordering.md
|
|
202
|
+
- rspec-documentation/pages/010-File System/010-Documentation Bundle.md
|
|
203
|
+
- rspec-documentation/pages/020-Running Tests.md
|
|
204
|
+
- rspec-documentation/pages/030-Examples.md
|
|
205
|
+
- rspec-documentation/pages/030-Examples/010-Basic.md
|
|
206
|
+
- rspec-documentation/pages/030-Examples/020-HTML.md
|
|
207
|
+
- rspec-documentation/pages/030-Examples/030-ANSI.md
|
|
208
|
+
- rspec-documentation/pages/030-Examples/040-JSON.md
|
|
209
|
+
- rspec-documentation/pages/030-Examples/050-YAML.md
|
|
210
|
+
- rspec-documentation/pages/040-Spec Helper.md
|
|
211
|
+
- rspec-documentation/pages/050-Linking.md
|
|
212
|
+
- rspec-documentation/pages/060-Configuration.md
|
|
213
|
+
- rspec-documentation/pages/060-Configuration/010-Context.md
|
|
214
|
+
- rspec-documentation/pages/060-Configuration/020-Build Paths.md
|
|
215
|
+
- rspec-documentation/pages/060-Configuration/030-Attribution.md
|
|
216
|
+
- rspec-documentation/pages/070-Publishing.md
|
|
217
|
+
- rspec-documentation/pages/500-License.md
|
|
218
|
+
- rspec-documentation/spec_helper.rb
|
|
32
219
|
- sig/rspec/documentation.rbs
|
|
33
220
|
homepage: https://github.com/bobf/rspec-documentation
|
|
34
|
-
licenses:
|
|
221
|
+
licenses:
|
|
222
|
+
- MIT
|
|
35
223
|
metadata:
|
|
36
224
|
homepage_uri: https://github.com/bobf/rspec-documentation
|
|
37
225
|
source_code_uri: https://github.com/bobf/rspec-documentation
|