sdoc 2.0.3 → 2.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/test.yml +38 -0
- data/.gitignore +1 -0
- data/CHANGELOG.md +42 -6
- data/Gemfile +8 -2
- data/README.md +14 -4
- data/Rakefile +54 -2
- data/config.ru +3 -3
- data/lib/rdoc/generator/template/rails/_context.rhtml +16 -8
- data/lib/rdoc/generator/template/rails/_head.rhtml +14 -39
- data/lib/rdoc/generator/template/rails/_panel.rhtml +6 -3
- data/lib/rdoc/generator/template/rails/class.rhtml +5 -2
- data/lib/rdoc/generator/template/rails/file.rhtml +5 -2
- data/lib/rdoc/generator/template/rails/index.rhtml +7 -7
- data/lib/rdoc/generator/template/rails/resources/css/main.css +33 -6
- data/lib/rdoc/generator/template/rails/resources/css/panel.css +123 -6
- data/lib/rdoc/generator/template/rails/resources/css/reset.css +0 -1
- data/lib/rdoc/generator/template/rails/resources/js/main.js +17 -0
- data/lib/rdoc/generator/template/rails/resources/js/searchdoc.js +14 -17
- data/lib/rdoc/generator/template/rails/search_index.rhtml +6 -2
- data/lib/rdoc/generator/template/sdoc/_context.rhtml +11 -3
- data/lib/rdoc/generator/template/sdoc/class.rhtml +5 -6
- data/lib/rdoc/generator/template/sdoc/file.rhtml +5 -6
- data/lib/rdoc/generator/template/sdoc/index.rhtml +3 -4
- data/lib/rdoc/generator/template/sdoc/resources/css/reset.css +0 -1
- data/lib/rdoc/generator/template/sdoc/resources/js/searchdoc.js +0 -10
- data/lib/rdoc/generator/template/sdoc/resources/panel/index.html +2 -1
- data/lib/rdoc/generator/template/sdoc/search_index.rhtml +6 -2
- data/lib/sdoc/generator.rb +3 -3
- data/lib/sdoc/merge.rb +5 -28
- data/lib/sdoc/templatable.rb +1 -1
- data/lib/sdoc/version.rb +1 -1
- data/netlify.toml +39 -0
- data/sdoc.gemspec +1 -3
- data/spec/helpers_spec.rb +2 -2
- data/spec/rdoc_generator_spec.rb +9 -9
- metadata +13 -21
- data/.travis.yml +0 -31
- data/lib/rdoc/generator/template/merge/index.rhtml +0 -12
data/sdoc.gemspec
CHANGED
@@ -22,9 +22,7 @@ Gem::Specification.new do |s|
|
|
22
22
|
s.rdoc_options = ["--charset=UTF-8"]
|
23
23
|
s.extra_rdoc_files = ["README.md"]
|
24
24
|
|
25
|
-
s.add_runtime_dependency("rdoc", ">= 5.0")
|
26
|
-
|
27
|
-
s.add_development_dependency("rack")
|
25
|
+
s.add_runtime_dependency("rdoc", ">= 5.0", "< 6.4.0")
|
28
26
|
|
29
27
|
s.files = `git ls-files`.split("\n")
|
30
28
|
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
data/spec/helpers_spec.rb
CHANGED
@@ -19,14 +19,14 @@ describe SDoc::Helpers do
|
|
19
19
|
]
|
20
20
|
|
21
21
|
strings.each do |(html, stripped)|
|
22
|
-
@helpers.strip_tags(html).must_equal stripped
|
22
|
+
_(@helpers.strip_tags(html)).must_equal stripped
|
23
23
|
end
|
24
24
|
end
|
25
25
|
end
|
26
26
|
|
27
27
|
describe "#truncate" do
|
28
28
|
it "should truncate the given text around a given length" do
|
29
|
-
@helpers.truncate("Hello world", length: 5).must_equal "Hello."
|
29
|
+
_(@helpers.truncate("Hello world", length: 5)).must_equal "Hello."
|
30
30
|
end
|
31
31
|
end
|
32
32
|
end
|
data/spec/rdoc_generator_spec.rb
CHANGED
@@ -8,12 +8,12 @@ describe RDoc::Generator::SDoc do
|
|
8
8
|
end
|
9
9
|
|
10
10
|
it "should find sdoc generator" do
|
11
|
-
RDoc::RDoc::GENERATORS.must_include 'sdoc'
|
11
|
+
_(RDoc::RDoc::GENERATORS).must_include 'sdoc'
|
12
12
|
end
|
13
13
|
|
14
14
|
it "should use sdoc generator" do
|
15
|
-
@options.generator.must_equal RDoc::Generator::SDoc
|
16
|
-
@options.generator_name.must_equal 'sdoc'
|
15
|
+
_(@options.generator).must_equal RDoc::Generator::SDoc
|
16
|
+
_(@options.generator_name).must_equal 'sdoc'
|
17
17
|
end
|
18
18
|
|
19
19
|
it "should parse github option" do
|
@@ -23,8 +23,8 @@ describe RDoc::Generator::SDoc do
|
|
23
23
|
@parser.parse %w[--github]
|
24
24
|
end
|
25
25
|
|
26
|
-
err.wont_match(/^invalid options/)
|
27
|
-
@options.github.must_equal true
|
26
|
+
_(err).wont_match(/^invalid options/)
|
27
|
+
_(@options.github).must_equal true
|
28
28
|
end
|
29
29
|
|
30
30
|
it "should parse github short-hand option" do
|
@@ -34,15 +34,15 @@ describe RDoc::Generator::SDoc do
|
|
34
34
|
@parser.parse %w[-g]
|
35
35
|
end
|
36
36
|
|
37
|
-
err.wont_match(/^invalid options/)
|
38
|
-
@options.github.must_equal true
|
37
|
+
_(err).wont_match(/^invalid options/)
|
38
|
+
_(@options.github).must_equal true
|
39
39
|
end
|
40
40
|
|
41
41
|
it "should display SDoc version on -v or --version" do
|
42
42
|
out_full = `./bin/sdoc --version`
|
43
43
|
out_short = `./bin/sdoc -v`
|
44
44
|
|
45
|
-
out_short.strip.must_equal SDoc::VERSION
|
46
|
-
out_full.strip.must_equal SDoc::VERSION
|
45
|
+
_(out_short.strip).must_equal SDoc::VERSION
|
46
|
+
_(out_full.strip).must_equal SDoc::VERSION
|
47
47
|
end
|
48
48
|
end
|
metadata
CHANGED
@@ -1,17 +1,17 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: sdoc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.0
|
4
|
+
version: 2.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Vladimir Kolesnikov
|
8
8
|
- Nathan Broadbent
|
9
9
|
- Jean Mertz
|
10
10
|
- Zachary Scott
|
11
|
-
autorequire:
|
11
|
+
autorequire:
|
12
12
|
bindir: bin
|
13
13
|
cert_chain: []
|
14
|
-
date:
|
14
|
+
date: 2022-01-05 00:00:00.000000000 Z
|
15
15
|
dependencies:
|
16
16
|
- !ruby/object:Gem::Dependency
|
17
17
|
name: rdoc
|
@@ -20,6 +20,9 @@ dependencies:
|
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: '5.0'
|
23
|
+
- - "<"
|
24
|
+
- !ruby/object:Gem::Version
|
25
|
+
version: 6.4.0
|
23
26
|
type: :runtime
|
24
27
|
prerelease: false
|
25
28
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -27,20 +30,9 @@ dependencies:
|
|
27
30
|
- - ">="
|
28
31
|
- !ruby/object:Gem::Version
|
29
32
|
version: '5.0'
|
30
|
-
-
|
31
|
-
name: rack
|
32
|
-
requirement: !ruby/object:Gem::Requirement
|
33
|
-
requirements:
|
34
|
-
- - ">="
|
35
|
-
- !ruby/object:Gem::Version
|
36
|
-
version: '0'
|
37
|
-
type: :development
|
38
|
-
prerelease: false
|
39
|
-
version_requirements: !ruby/object:Gem::Requirement
|
40
|
-
requirements:
|
41
|
-
- - ">="
|
33
|
+
- - "<"
|
42
34
|
- !ruby/object:Gem::Version
|
43
|
-
version:
|
35
|
+
version: 6.4.0
|
44
36
|
description: rdoc generator html with javascript search index.
|
45
37
|
email: voloko@gmail.com mail@zzak.io
|
46
38
|
executables:
|
@@ -50,8 +42,8 @@ extensions: []
|
|
50
42
|
extra_rdoc_files:
|
51
43
|
- README.md
|
52
44
|
files:
|
45
|
+
- ".github/workflows/test.yml"
|
53
46
|
- ".gitignore"
|
54
|
-
- ".travis.yml"
|
55
47
|
- CHANGELOG.md
|
56
48
|
- Gemfile
|
57
49
|
- LICENSE
|
@@ -61,7 +53,6 @@ files:
|
|
61
53
|
- bin/sdoc-merge
|
62
54
|
- config.ru
|
63
55
|
- lib/rdoc/discover.rb
|
64
|
-
- lib/rdoc/generator/template/merge/index.rhtml
|
65
56
|
- lib/rdoc/generator/template/rails/_context.rhtml
|
66
57
|
- lib/rdoc/generator/template/rails/_head.rhtml
|
67
58
|
- lib/rdoc/generator/template/rails/_panel.rhtml
|
@@ -113,6 +104,7 @@ files:
|
|
113
104
|
- lib/sdoc/merge.rb
|
114
105
|
- lib/sdoc/templatable.rb
|
115
106
|
- lib/sdoc/version.rb
|
107
|
+
- netlify.toml
|
116
108
|
- sdoc.gemspec
|
117
109
|
- spec/helpers_spec.rb
|
118
110
|
- spec/rdoc_generator_spec.rb
|
@@ -121,7 +113,7 @@ homepage: https://github.com/zzak/sdoc
|
|
121
113
|
licenses:
|
122
114
|
- MIT
|
123
115
|
metadata: {}
|
124
|
-
post_install_message:
|
116
|
+
post_install_message:
|
125
117
|
rdoc_options:
|
126
118
|
- "--charset=UTF-8"
|
127
119
|
require_paths:
|
@@ -137,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
137
129
|
- !ruby/object:Gem::Version
|
138
130
|
version: 1.3.6
|
139
131
|
requirements: []
|
140
|
-
rubygems_version: 3.
|
141
|
-
signing_key:
|
132
|
+
rubygems_version: 3.1.6
|
133
|
+
signing_key:
|
142
134
|
specification_version: 4
|
143
135
|
summary: rdoc html with javascript search index.
|
144
136
|
test_files: []
|
data/.travis.yml
DELETED
@@ -1,31 +0,0 @@
|
|
1
|
-
language: ruby
|
2
|
-
cache: bundler
|
3
|
-
before_install:
|
4
|
-
- gem update --system || gem update --system 2.7.8
|
5
|
-
- gem install bundler || gem install bundler -v 1.17.3
|
6
|
-
rvm:
|
7
|
-
- 1.9.3
|
8
|
-
- 2.0.0
|
9
|
-
- 2.1.0
|
10
|
-
- 2.2.10
|
11
|
-
- 2.3.7
|
12
|
-
- 2.4.4
|
13
|
-
- 2.5.1
|
14
|
-
- 2.6.0
|
15
|
-
- ruby-head
|
16
|
-
- jruby-head
|
17
|
-
matrix:
|
18
|
-
allow_failures:
|
19
|
-
- env: rdoc=master
|
20
|
-
- rvm: jruby-head
|
21
|
-
include:
|
22
|
-
- { rvm: 2.2.10, env: rdoc=master }
|
23
|
-
- { rvm: 2.3.7, env: rdoc=master }
|
24
|
-
- { rvm: 2.4.4, env: rdoc=master }
|
25
|
-
- { rvm: 2.5.1, env: rdoc=master }
|
26
|
-
- { rvm: 2.6.0, env: rdoc=master }
|
27
|
-
- { rvm: ruby-head, env: rdoc=master }
|
28
|
-
- { rvm: jruby-head, env: rdoc=master }
|
29
|
-
notifications:
|
30
|
-
email:
|
31
|
-
- mail@zzak.io
|
@@ -1,12 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html lang="en">
|
3
|
-
<head>
|
4
|
-
<meta charset="utf-8">
|
5
|
-
|
6
|
-
<title><%= @title %></title>
|
7
|
-
</head>
|
8
|
-
<frameset cols="300,*" frameborder="1" border="1" bordercolor="#999999" framespacing="1">
|
9
|
-
<frame src="panel/index.html" title="Search" name="panel" />
|
10
|
-
<frame src="<%= index_path %>" name="docwin" />
|
11
|
-
</frameset>
|
12
|
-
</html>
|