ronn-ng 0.7.4 → 0.8.0.SNAPSHOT
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/CHANGES +12 -3
- data/Gemfile +2 -0
- data/INSTALLING.md +100 -0
- data/README.md +19 -1
- data/Rakefile +39 -49
- data/bin/ronn +93 -75
- data/completion/bash/ronn +32 -0
- data/completion/zsh/_ronn +24 -0
- data/config.ru +3 -3
- data/lib/ronn/document.rb +127 -106
- data/lib/ronn/index.rb +8 -9
- data/lib/ronn/roff.rb +153 -76
- data/lib/ronn/server.rb +19 -22
- data/lib/ronn/template.rb +27 -26
- data/lib/ronn/utils.rb +9 -7
- data/lib/ronn.rb +5 -3
- data/man/ronn-format.7 +6 -62
- data/man/ronn.1 +21 -123
- data/man/ronn.1.ronn +8 -0
- data/ronn-ng.gemspec +38 -13
- data/test/angle_bracket_syntax.html +4 -5
- data/test/backticks.html +14 -0
- data/test/backticks.ronn +10 -0
- data/test/basic_document.html +3 -4
- data/test/basic_document.ronn +2 -2
- data/test/circumflexes.ronn +1 -0
- data/test/code_blocks.7.ronn +41 -0
- data/test/contest.rb +56 -54
- data/test/custom_title_document.html +2 -2
- data/test/definition_list_syntax.html +13 -9
- data/test/definition_list_syntax.roff +2 -9
- data/test/definition_list_syntax.ronn +2 -2
- data/test/dots_at_line_start_test.roff +12 -3
- data/test/dots_at_line_start_test.ronn +8 -0
- data/test/ellipses.roff +7 -0
- data/test/ellipses.ronn +7 -0
- data/test/entity_encoding_test.html +13 -14
- data/test/entity_encoding_test.roff +1 -22
- data/test/entity_encoding_test.ronn +1 -1
- data/test/markdown_syntax.html +4 -5
- data/test/markdown_syntax.roff +1 -561
- data/test/middle_paragraph.html +2 -3
- data/test/middle_paragraph.roff +1 -5
- data/test/middle_paragraph.ronn +1 -1
- data/test/missing_spaces.roff +0 -2
- data/test/nested_list.ronn +19 -0
- data/test/nested_list_with_code.html +15 -0
- data/test/nested_list_with_code.roff +11 -0
- data/test/nested_list_with_code.ronn +6 -0
- data/test/page.with.periods.in.name.5.ronn +4 -0
- data/test/pre_block_with_quotes.roff +0 -5
- data/test/section_reference_links.html +2 -3
- data/test/section_reference_links.roff +1 -4
- data/test/section_reference_links.ronn +1 -1
- data/test/tables.ronn +24 -0
- data/test/test_ronn.rb +49 -35
- data/test/test_ronn_document.rb +81 -81
- data/test/test_ronn_index.rb +11 -11
- data/test/titleless_document.html +0 -1
- data/test/underline_spacing_test.roff +0 -8
- metadata +140 -22
- data/INSTALLING +0 -20
data/test/test_ronn_index.rb
CHANGED
@@ -3,22 +3,22 @@ require 'ronn'
|
|
3
3
|
|
4
4
|
class IndexTest < Test::Unit::TestCase
|
5
5
|
setup do
|
6
|
-
@index_path = File.expand_path('
|
7
|
-
@missing_path = File.expand_path('
|
6
|
+
@index_path = File.expand_path('index.txt', __dir__)
|
7
|
+
@missing_path = File.expand_path('missing-index.txt', __dir__)
|
8
8
|
end
|
9
9
|
|
10
|
-
def expand_path(path, rel=File.dirname(__FILE__))
|
10
|
+
def expand_path(path, rel = File.dirname(__FILE__))
|
11
11
|
File.expand_path(path, rel)
|
12
12
|
end
|
13
13
|
|
14
|
-
test
|
14
|
+
test 'creating with a non-existent file' do
|
15
15
|
index = Ronn::Index.new(@missing_path)
|
16
16
|
assert_equal @missing_path, index.path
|
17
17
|
assert_equal 0, index.size
|
18
18
|
assert index.empty?
|
19
19
|
end
|
20
20
|
|
21
|
-
test
|
21
|
+
test 'creating with an index file and no block' do
|
22
22
|
index = Ronn::Index.new(@index_path)
|
23
23
|
assert_equal 3, index.size
|
24
24
|
assert_equal 2, index.manuals.size
|
@@ -46,8 +46,8 @@ class IndexTest < Test::Unit::TestCase
|
|
46
46
|
assert !ref.ronn?
|
47
47
|
end
|
48
48
|
|
49
|
-
test
|
50
|
-
index = Ronn::Index.new(@index_path) {
|
49
|
+
test 'creating with a block reader' do
|
50
|
+
index = Ronn::Index.new(@index_path) { 'hello(1) hello.1.ronn' }
|
51
51
|
assert_equal @index_path, index.path
|
52
52
|
assert_equal 1, index.size
|
53
53
|
ref = index.first
|
@@ -57,17 +57,17 @@ class IndexTest < Test::Unit::TestCase
|
|
57
57
|
assert_equal expand_path('hello.1.ronn'), ref.path
|
58
58
|
end
|
59
59
|
|
60
|
-
test
|
60
|
+
test 'adding manual paths' do
|
61
61
|
index = Ronn::Index.new(@index_path)
|
62
|
-
index << expand_path(
|
62
|
+
index << expand_path('angle_bracket_syntax.ronn')
|
63
63
|
assert_equal 'angle_bracket_syntax(5)', index.last.name
|
64
64
|
assert_equal expand_path('angle_bracket_syntax.ronn'), index.last.path
|
65
65
|
end
|
66
66
|
|
67
|
-
test
|
67
|
+
test 'adding manual paths that are already present' do
|
68
68
|
index = Ronn::Index.new(@index_path)
|
69
69
|
size = index.size
|
70
|
-
index << expand_path(
|
70
|
+
index << expand_path('basic_document.ronn')
|
71
71
|
assert_equal size, index.size
|
72
72
|
end
|
73
73
|
end
|
@@ -1,21 +1,13 @@
|
|
1
1
|
.TH "UNDERLINE_SPACING_TEST" "" "January 1979" "" ""
|
2
|
-
.
|
3
2
|
.SH "NAME"
|
4
3
|
\fBunderline_spacing_test\fR
|
5
|
-
.
|
6
4
|
.P
|
7
5
|
This input
|
8
|
-
.
|
9
6
|
.TP
|
10
7
|
\fB\-S\fR \fItext\fR, \fBsearch\fR \fItext\fR
|
11
8
|
Performs a substring search of formula names for \fItext\fR\.
|
12
|
-
.
|
13
9
|
.TP
|
14
10
|
\fB\-O\fR \fItext\fR, \fBother\fR \fItext\fR
|
15
11
|
Does something else\.
|
16
|
-
.
|
17
12
|
.P
|
18
13
|
Should space text properly\.
|
19
|
-
.
|
20
|
-
.P
|
21
|
-
\fI!\-\- this is a comment \-\-\fR
|
metadata
CHANGED
@@ -1,75 +1,175 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ronn-ng
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.8.0.SNAPSHOT
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Andrew Janke
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-12-
|
11
|
+
date: 2018-12-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
|
-
name:
|
14
|
+
name: mustache
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.7'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 0.
|
22
|
+
version: 0.7.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
26
26
|
requirements:
|
27
27
|
- - "~>"
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: '0.
|
29
|
+
version: '0.7'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 0.
|
32
|
+
version: 0.7.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
|
-
name:
|
34
|
+
name: nokogiri
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
36
36
|
requirements:
|
37
37
|
- - "~>"
|
38
38
|
- !ruby/object:Gem::Version
|
39
|
-
version: '1.
|
39
|
+
version: '1.9'
|
40
40
|
- - ">="
|
41
41
|
- !ruby/object:Gem::Version
|
42
|
-
version: 1.
|
42
|
+
version: 1.9.0
|
43
43
|
type: :runtime
|
44
44
|
prerelease: false
|
45
45
|
version_requirements: !ruby/object:Gem::Requirement
|
46
46
|
requirements:
|
47
47
|
- - "~>"
|
48
48
|
- !ruby/object:Gem::Version
|
49
|
-
version: '1.
|
49
|
+
version: '1.9'
|
50
50
|
- - ">="
|
51
51
|
- !ruby/object:Gem::Version
|
52
|
-
version: 1.
|
52
|
+
version: 1.9.0
|
53
53
|
- !ruby/object:Gem::Dependency
|
54
|
-
name:
|
54
|
+
name: rdiscount
|
55
55
|
requirement: !ruby/object:Gem::Requirement
|
56
56
|
requirements:
|
57
57
|
- - "~>"
|
58
58
|
- !ruby/object:Gem::Version
|
59
|
-
version: '0
|
59
|
+
version: '2.0'
|
60
60
|
- - ">="
|
61
61
|
- !ruby/object:Gem::Version
|
62
|
-
version: 0.7
|
62
|
+
version: 2.0.7
|
63
63
|
type: :runtime
|
64
64
|
prerelease: false
|
65
65
|
version_requirements: !ruby/object:Gem::Requirement
|
66
66
|
requirements:
|
67
67
|
- - "~>"
|
68
68
|
- !ruby/object:Gem::Version
|
69
|
-
version: '0
|
69
|
+
version: '2.0'
|
70
70
|
- - ">="
|
71
71
|
- !ruby/object:Gem::Version
|
72
|
-
version: 0.7
|
72
|
+
version: 2.0.7
|
73
|
+
- !ruby/object:Gem::Dependency
|
74
|
+
name: rack
|
75
|
+
requirement: !ruby/object:Gem::Requirement
|
76
|
+
requirements:
|
77
|
+
- - "~>"
|
78
|
+
- !ruby/object:Gem::Version
|
79
|
+
version: '2.0'
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: 2.0.6
|
83
|
+
type: :development
|
84
|
+
prerelease: false
|
85
|
+
version_requirements: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '2.0'
|
90
|
+
- - ">="
|
91
|
+
- !ruby/object:Gem::Version
|
92
|
+
version: 2.0.6
|
93
|
+
- !ruby/object:Gem::Dependency
|
94
|
+
name: rake
|
95
|
+
requirement: !ruby/object:Gem::Requirement
|
96
|
+
requirements:
|
97
|
+
- - "~>"
|
98
|
+
- !ruby/object:Gem::Version
|
99
|
+
version: '12.3'
|
100
|
+
- - ">="
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: 12.3.0
|
103
|
+
type: :development
|
104
|
+
prerelease: false
|
105
|
+
version_requirements: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - "~>"
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '12.3'
|
110
|
+
- - ">="
|
111
|
+
- !ruby/object:Gem::Version
|
112
|
+
version: 12.3.0
|
113
|
+
- !ruby/object:Gem::Dependency
|
114
|
+
name: rubocop
|
115
|
+
requirement: !ruby/object:Gem::Requirement
|
116
|
+
requirements:
|
117
|
+
- - "~>"
|
118
|
+
- !ruby/object:Gem::Version
|
119
|
+
version: '0.60'
|
120
|
+
- - ">="
|
121
|
+
- !ruby/object:Gem::Version
|
122
|
+
version: 0.57.1
|
123
|
+
type: :development
|
124
|
+
prerelease: false
|
125
|
+
version_requirements: !ruby/object:Gem::Requirement
|
126
|
+
requirements:
|
127
|
+
- - "~>"
|
128
|
+
- !ruby/object:Gem::Version
|
129
|
+
version: '0.60'
|
130
|
+
- - ">="
|
131
|
+
- !ruby/object:Gem::Version
|
132
|
+
version: 0.57.1
|
133
|
+
- !ruby/object:Gem::Dependency
|
134
|
+
name: sinatra
|
135
|
+
requirement: !ruby/object:Gem::Requirement
|
136
|
+
requirements:
|
137
|
+
- - "~>"
|
138
|
+
- !ruby/object:Gem::Version
|
139
|
+
version: '2.0'
|
140
|
+
- - ">="
|
141
|
+
- !ruby/object:Gem::Version
|
142
|
+
version: 2.0.0
|
143
|
+
type: :development
|
144
|
+
prerelease: false
|
145
|
+
version_requirements: !ruby/object:Gem::Requirement
|
146
|
+
requirements:
|
147
|
+
- - "~>"
|
148
|
+
- !ruby/object:Gem::Version
|
149
|
+
version: '2.0'
|
150
|
+
- - ">="
|
151
|
+
- !ruby/object:Gem::Version
|
152
|
+
version: 2.0.0
|
153
|
+
- !ruby/object:Gem::Dependency
|
154
|
+
name: test-unit
|
155
|
+
requirement: !ruby/object:Gem::Requirement
|
156
|
+
requirements:
|
157
|
+
- - "~>"
|
158
|
+
- !ruby/object:Gem::Version
|
159
|
+
version: '3.2'
|
160
|
+
- - ">="
|
161
|
+
- !ruby/object:Gem::Version
|
162
|
+
version: 3.2.7
|
163
|
+
type: :development
|
164
|
+
prerelease: false
|
165
|
+
version_requirements: !ruby/object:Gem::Requirement
|
166
|
+
requirements:
|
167
|
+
- - "~>"
|
168
|
+
- !ruby/object:Gem::Version
|
169
|
+
version: '3.2'
|
170
|
+
- - ">="
|
171
|
+
- !ruby/object:Gem::Version
|
172
|
+
version: 3.2.7
|
73
173
|
description: Ronn-NG builds manuals in HTML and Unix man page format from Markdown.
|
74
174
|
email: floss@apjanke.net
|
75
175
|
executables:
|
@@ -81,11 +181,14 @@ extra_rdoc_files:
|
|
81
181
|
files:
|
82
182
|
- AUTHORS
|
83
183
|
- CHANGES
|
84
|
-
-
|
184
|
+
- Gemfile
|
185
|
+
- INSTALLING.md
|
85
186
|
- LICENSE.txt
|
86
187
|
- README.md
|
87
188
|
- Rakefile
|
88
189
|
- bin/ronn
|
190
|
+
- completion/bash/ronn
|
191
|
+
- completion/zsh/_ronn
|
89
192
|
- config.ru
|
90
193
|
- lib/ronn.rb
|
91
194
|
- lib/ronn/document.rb
|
@@ -111,8 +214,12 @@ files:
|
|
111
214
|
- ronn-ng.gemspec
|
112
215
|
- test/angle_bracket_syntax.html
|
113
216
|
- test/angle_bracket_syntax.ronn
|
217
|
+
- test/backticks.html
|
218
|
+
- test/backticks.ronn
|
114
219
|
- test/basic_document.html
|
115
220
|
- test/basic_document.ronn
|
221
|
+
- test/circumflexes.ronn
|
222
|
+
- test/code_blocks.7.ronn
|
116
223
|
- test/contest.rb
|
117
224
|
- test/custom_title_document.html
|
118
225
|
- test/custom_title_document.ronn
|
@@ -121,6 +228,8 @@ files:
|
|
121
228
|
- test/definition_list_syntax.ronn
|
122
229
|
- test/dots_at_line_start_test.roff
|
123
230
|
- test/dots_at_line_start_test.ronn
|
231
|
+
- test/ellipses.roff
|
232
|
+
- test/ellipses.ronn
|
124
233
|
- test/entity_encoding_test.html
|
125
234
|
- test/entity_encoding_test.roff
|
126
235
|
- test/entity_encoding_test.ronn
|
@@ -133,11 +242,17 @@ files:
|
|
133
242
|
- test/middle_paragraph.ronn
|
134
243
|
- test/missing_spaces.roff
|
135
244
|
- test/missing_spaces.ronn
|
245
|
+
- test/nested_list.ronn
|
246
|
+
- test/nested_list_with_code.html
|
247
|
+
- test/nested_list_with_code.roff
|
248
|
+
- test/nested_list_with_code.ronn
|
249
|
+
- test/page.with.periods.in.name.5.ronn
|
136
250
|
- test/pre_block_with_quotes.roff
|
137
251
|
- test/pre_block_with_quotes.ronn
|
138
252
|
- test/section_reference_links.html
|
139
253
|
- test/section_reference_links.roff
|
140
254
|
- test/section_reference_links.ronn
|
255
|
+
- test/tables.ronn
|
141
256
|
- test/test_ronn.rb
|
142
257
|
- test/test_ronn_document.rb
|
143
258
|
- test/test_ronn_index.rb
|
@@ -148,7 +263,10 @@ files:
|
|
148
263
|
homepage: https://github.com/apjanke/ronn-ng
|
149
264
|
licenses:
|
150
265
|
- MIT
|
151
|
-
metadata:
|
266
|
+
metadata:
|
267
|
+
bug_tracker_uri: https://github.com/apjanke/ronn-ng/issues
|
268
|
+
source_code_uri: https://github.com/apjanke/ronn-ng
|
269
|
+
changelog_uri: https://github.com/apjanke/ronn-ng/blob/master/CHANGES
|
152
270
|
post_install_message:
|
153
271
|
rdoc_options:
|
154
272
|
- "--line-numbers"
|
@@ -164,13 +282,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
164
282
|
version: '0'
|
165
283
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
166
284
|
requirements:
|
167
|
-
- - "
|
285
|
+
- - ">"
|
168
286
|
- !ruby/object:Gem::Version
|
169
|
-
version:
|
287
|
+
version: 1.3.1
|
170
288
|
requirements: []
|
171
289
|
rubyforge_project:
|
172
290
|
rubygems_version: 2.7.7
|
173
291
|
signing_key:
|
174
292
|
specification_version: 4
|
175
|
-
summary: Builds
|
293
|
+
summary: Builds man pages from Markdown
|
176
294
|
test_files: []
|
data/INSTALLING
DELETED
@@ -1,20 +0,0 @@
|
|
1
|
-
Ronn is currently distributed mainly as a gem package. Install with rubygems:
|
2
|
-
|
3
|
-
$ gem install ronn
|
4
|
-
$ ronn --help
|
5
|
-
|
6
|
-
Historical Ronn tarballs available at: <http://github.com/rtomayko/ronn/downloads>
|
7
|
-
|
8
|
-
$ curl -L http://github.com/rtomayko/ronn/downloads/0.6.6 | tar xvzf -
|
9
|
-
$ cd rtomayko-r*
|
10
|
-
$ ruby setup.rb
|
11
|
-
|
12
|
-
The hpricot, mustache, and rdiscount packages are required.
|
13
|
-
|
14
|
-
$ gem install hpricot mustache rdiscount
|
15
|
-
|
16
|
-
Hacking? Clone the git repository and put ronn/bin on your PATH:
|
17
|
-
|
18
|
-
$ git clone git://github.com/apjanke/ronn-ng
|
19
|
-
$ PATH=$(pwd)/ronn-ng/bin:$PATH
|
20
|
-
$ ronn --help
|