rspec-documentation 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/.rspec +1 -0
  3. data/.rubocop.yml +2 -0
  4. data/Gemfile +3 -0
  5. data/Gemfile.lock +25 -2
  6. data/README.md +1 -1
  7. data/Rakefile +1 -0
  8. data/exe/rspec-documentation +5 -0
  9. data/lib/rspec/documentation/version.rb +2 -2
  10. data/lib/rspec/documentation.rb +65 -2
  11. data/lib/rspec_documentation/ansi_html.rb +28 -0
  12. data/lib/rspec_documentation/configuration.rb +15 -0
  13. data/lib/rspec_documentation/context.rb +44 -0
  14. data/lib/rspec_documentation/document.rb +61 -0
  15. data/lib/rspec_documentation/html_element.rb +55 -0
  16. data/lib/rspec_documentation/markdown_renderer.rb +7 -0
  17. data/lib/rspec_documentation/page_collection.rb +49 -0
  18. data/lib/rspec_documentation/page_tree.rb +73 -0
  19. data/lib/rspec_documentation/page_tree_element.rb +56 -0
  20. data/lib/rspec_documentation/parsed_document.rb +70 -0
  21. data/lib/rspec_documentation/rspec/example_group.rb +26 -0
  22. data/lib/rspec_documentation/rspec/failure.rb +37 -0
  23. data/lib/rspec_documentation/rspec/reporter.rb +45 -0
  24. data/lib/rspec_documentation/rspec.rb +14 -0
  25. data/lib/rspec_documentation/spec.rb +62 -0
  26. data/lib/rspec_documentation/util.rb +46 -0
  27. data/lib/rspec_documentation.rb +58 -0
  28. data/lib/tasks/rspec/documentation/generate.rake +10 -0
  29. data/lib/templates/footer.html.erb +1 -0
  30. data/lib/templates/header.html.erb +7 -0
  31. data/lib/templates/layout.css.erb +39 -0
  32. data/lib/templates/layout.html.erb +100 -0
  33. data/lib/templates/tabbed_spec.html.erb +119 -0
  34. data/lib/templates/themes/cerulean.css +12 -0
  35. data/lib/templates/themes/cosmo.css +12 -0
  36. data/lib/templates/themes/cyborg.css +12 -0
  37. data/lib/templates/themes/darkly.css +12 -0
  38. data/lib/templates/themes/flatly.css +12 -0
  39. data/lib/templates/themes/journal.css +12 -0
  40. data/lib/templates/themes/litera.css +12 -0
  41. data/lib/templates/themes/lumen.css +12 -0
  42. data/lib/templates/themes/lux.css +12 -0
  43. data/lib/templates/themes/materia.css +12 -0
  44. data/lib/templates/themes/minty.css +12 -0
  45. data/lib/templates/themes/morph.css +12 -0
  46. data/lib/templates/themes/pulse.css +12 -0
  47. data/lib/templates/themes/quartz.css +12 -0
  48. data/lib/templates/themes/sandstone.css +12 -0
  49. data/lib/templates/themes/simplex.css +12 -0
  50. data/lib/templates/themes/sketchy.css +12 -0
  51. data/lib/templates/themes/slate.css +12 -0
  52. data/lib/templates/themes/solar.css +12 -0
  53. data/lib/templates/themes/spacelab.css +12 -0
  54. data/lib/templates/themes/superhero.css +12 -0
  55. data/lib/templates/themes/united.css +12 -0
  56. data/lib/templates/themes/vapor.css +12 -0
  57. data/lib/templates/themes/yeti.css +12 -0
  58. data/lib/templates/themes/zephyr.css +12 -0
  59. data/rspec-documentation/pages/000-Introduction.md +39 -0
  60. data/rspec-documentation/pages/010-File System/000-Ordering.md +14 -0
  61. data/rspec-documentation/pages/010-File System/010-Standalone Directories.md +17 -0
  62. data/rspec-documentation/pages/010-File System/020-Standalone Directory/Example Page.md +3 -0
  63. data/rspec-documentation/pages/010-File System.md +26 -0
  64. data/rspec-documentation/pages/020-Running Specs.md +11 -0
  65. data/rspec-documentation.gemspec +9 -1
  66. data/sig/rspec/documentation.rbs +1 -1
  67. metadata +158 -4
@@ -4,7 +4,7 @@ require_relative 'lib/rspec/documentation/version'
4
4
 
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = 'rspec-documentation'
7
- spec.version = Rspec::Documentation::VERSION
7
+ spec.version = RSpec::Documentation::VERSION
8
8
  spec.authors = ['Bob Farrell']
9
9
  spec.email = ['git@bob.frl']
10
10
 
@@ -26,4 +26,12 @@ Gem::Specification.new do |spec|
26
26
  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
27
27
  spec.require_paths = ['lib']
28
28
  spec.metadata['rubygems_mfa_required'] = 'true'
29
+
30
+ spec.add_runtime_dependency 'htmlbeautifier', '~> 1.4'
31
+ spec.add_runtime_dependency 'kramdown', '~> 2.4'
32
+ spec.add_runtime_dependency 'kramdown-parser-gfm', '~> 1.1'
33
+ spec.add_runtime_dependency 'paintbrush', '~> 0.1.1'
34
+ spec.add_runtime_dependency 'redcarpet', '~> 3.6'
35
+ spec.add_runtime_dependency 'rouge', '~> 4.1'
36
+ spec.add_runtime_dependency 'rspec', '~> 3.12'
29
37
  end
@@ -1,4 +1,4 @@
1
- module Rspec
1
+ module RSpec
2
2
  module Documentation
3
3
  VERSION: String
4
4
  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
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.1
4
+ version: 0.0.2
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-05-21 00:00:00.000000000 Z
12
- dependencies: []
11
+ date: 2023-05-26 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.1
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.1
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,10 +124,65 @@ 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/ansi_html.rb
132
+ - lib/rspec_documentation/configuration.rb
133
+ - lib/rspec_documentation/context.rb
134
+ - lib/rspec_documentation/document.rb
135
+ - lib/rspec_documentation/html_element.rb
136
+ - lib/rspec_documentation/markdown_renderer.rb
137
+ - lib/rspec_documentation/page_collection.rb
138
+ - lib/rspec_documentation/page_tree.rb
139
+ - lib/rspec_documentation/page_tree_element.rb
140
+ - lib/rspec_documentation/parsed_document.rb
141
+ - lib/rspec_documentation/rspec.rb
142
+ - lib/rspec_documentation/rspec/example_group.rb
143
+ - lib/rspec_documentation/rspec/failure.rb
144
+ - lib/rspec_documentation/rspec/reporter.rb
145
+ - lib/rspec_documentation/spec.rb
146
+ - lib/rspec_documentation/util.rb
147
+ - lib/tasks/rspec/documentation/generate.rake
148
+ - lib/templates/footer.html.erb
149
+ - lib/templates/header.html.erb
150
+ - lib/templates/layout.css.erb
151
+ - lib/templates/layout.html.erb
152
+ - lib/templates/tabbed_spec.html.erb
153
+ - lib/templates/themes/cerulean.css
154
+ - lib/templates/themes/cosmo.css
155
+ - lib/templates/themes/cyborg.css
156
+ - lib/templates/themes/darkly.css
157
+ - lib/templates/themes/flatly.css
158
+ - lib/templates/themes/journal.css
159
+ - lib/templates/themes/litera.css
160
+ - lib/templates/themes/lumen.css
161
+ - lib/templates/themes/lux.css
162
+ - lib/templates/themes/materia.css
163
+ - lib/templates/themes/minty.css
164
+ - lib/templates/themes/morph.css
165
+ - lib/templates/themes/pulse.css
166
+ - lib/templates/themes/quartz.css
167
+ - lib/templates/themes/sandstone.css
168
+ - lib/templates/themes/simplex.css
169
+ - lib/templates/themes/sketchy.css
170
+ - lib/templates/themes/slate.css
171
+ - lib/templates/themes/solar.css
172
+ - lib/templates/themes/spacelab.css
173
+ - lib/templates/themes/superhero.css
174
+ - lib/templates/themes/united.css
175
+ - lib/templates/themes/vapor.css
176
+ - lib/templates/themes/yeti.css
177
+ - lib/templates/themes/zephyr.css
30
178
  - rspec-documentation-0.1.0.gem
31
179
  - rspec-documentation.gemspec
180
+ - rspec-documentation/pages/000-Introduction.md
181
+ - rspec-documentation/pages/010-File System.md
182
+ - rspec-documentation/pages/010-File System/000-Ordering.md
183
+ - rspec-documentation/pages/010-File System/010-Standalone Directories.md
184
+ - rspec-documentation/pages/010-File System/020-Standalone Directory/Example Page.md
185
+ - rspec-documentation/pages/020-Running Specs.md
32
186
  - sig/rspec/documentation.rbs
33
187
  homepage: https://github.com/bobf/rspec-documentation
34
188
  licenses: []