docrb-html 0.3.0 → 0.3.1
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/Gemfile.lock +1 -1
- data/assets/class_path_reference.scss +30 -0
- data/assets/markdown.scss +4 -0
- data/assets/reference.scss +5 -0
- data/assets/style.scss +1 -0
- data/lib/docrb-html.rb +7 -2
- data/lib/renderer/component/class_path_reference.rb +9 -0
- data/lib/renderer/component/doc_box.rb +1 -1
- data/lib/renderer/helpers.rb +1 -1
- data/lib/renderer/version.rb +1 -1
- data/templates/class_path_reference.erb +9 -0
- data/templates/documentation_block.erb +1 -1
- data/templates/documentation_comment.erb +3 -2
- data/templates/method_argument.erb +6 -1
- data/templates/reference.erb +1 -1
- metadata +4 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5e032e7d421f2811ed73880d0e9b224ebf11b9027446baee4fbf58f8fe28efb5
|
4
|
+
data.tar.gz: 9ea3088213e3e09e31c12a81041ad3cab9f48d16b859a36597603d159bc8423d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6e4c417666d05eb251dfee6ffc8b1243f1db13e73d34b48e9c7a1645fedb6fbad9eec4679387d18e76f25e78fb0253ac9c44c6f3ff753ed78673884e7d26ab75
|
7
|
+
data.tar.gz: 6b4e542016f1c14f2f40a6adabddecc97afbde132021c1ac5f830a1b785255b79eb27078570296f287e39a9ef2f348e75612446b360c3a530b47f077748bfad2
|
data/Gemfile.lock
CHANGED
@@ -0,0 +1,30 @@
|
|
1
|
+
.html div.class-path-reference-base {
|
2
|
+
@include mono;
|
3
|
+
display: flex;
|
4
|
+
flex-wrap: wrap;
|
5
|
+
|
6
|
+
span {
|
7
|
+
white-space: unset;
|
8
|
+
|
9
|
+
a {
|
10
|
+
@include mono;
|
11
|
+
}
|
12
|
+
|
13
|
+
&.segment {
|
14
|
+
&:not(:last-child) {
|
15
|
+
::after {
|
16
|
+
content: '::'
|
17
|
+
}
|
18
|
+
}
|
19
|
+
|
20
|
+
|
21
|
+
&.class a {
|
22
|
+
color: #FFAB42;
|
23
|
+
}
|
24
|
+
|
25
|
+
&.module a {
|
26
|
+
color: #579AD1;
|
27
|
+
}
|
28
|
+
}
|
29
|
+
}
|
30
|
+
}
|
data/assets/markdown.scss
CHANGED
data/assets/reference.scss
CHANGED
data/assets/style.scss
CHANGED
data/lib/docrb-html.rb
CHANGED
@@ -73,9 +73,14 @@ class Renderer
|
|
73
73
|
links: Metadata.project_links(@spec)
|
74
74
|
)
|
75
75
|
|
76
|
-
|
77
|
-
|
76
|
+
readme = if @spec[:readme]
|
77
|
+
Component::Markdown.new(source: Markdown.render(@spec[:readme]))
|
78
|
+
else
|
79
|
+
Component::Markdown.new(source: "<div class=\"html\">" \
|
80
|
+
"<div class=\"faded\">This project does not contain a README.</div></div>")
|
81
|
+
end
|
78
82
|
|
83
|
+
index = Page.new(title: "#{@spec[:name]} - Docrb") do
|
79
84
|
[
|
80
85
|
project_header,
|
81
86
|
Component::TabBar.new(
|
@@ -12,7 +12,7 @@ class Renderer
|
|
12
12
|
:page_components
|
13
13
|
|
14
14
|
def prepare
|
15
|
-
@has_class_docs = (item.doc && !item.doc.empty?) || false
|
15
|
+
@has_class_docs = (item.doc && !item.doc.empty? && !item.doc[:value].empty?) || false
|
16
16
|
@instance_methods = item.all_instance_methods
|
17
17
|
@class_methods = item.all_class_methods
|
18
18
|
@instance_attributes = item.kind == :class ? item.all_instance_attributes : []
|
data/lib/renderer/helpers.rb
CHANGED
@@ -90,7 +90,7 @@ class Renderer
|
|
90
90
|
parent ||= obj.parent
|
91
91
|
|
92
92
|
case (v = parent.source_of(obj))
|
93
|
-
when :inherited, :included, :extended then
|
93
|
+
when :inherited, :included, :extended then "inherited"
|
94
94
|
when :self then ("override" if obj.try(:overriding))
|
95
95
|
else raise "WTF? Source of #{obj} is #{v.inspect}!"
|
96
96
|
end
|
data/lib/renderer/version.rb
CHANGED
@@ -0,0 +1,9 @@
|
|
1
|
+
<% div("class-path-reference-base", id:) do %>
|
2
|
+
<% if doc[:prefix] %>
|
3
|
+
<span><%= doc[:prefix] %></span>
|
4
|
+
<% end %>
|
5
|
+
<% doc[:segments].each do |segment| %>
|
6
|
+
<span class="segment <%= segment.kind %>"><a class="dashed" href="<%= link_for(segment) %>"><%= segment.name %></a></span>
|
7
|
+
<% end %>
|
8
|
+
<span class="segment <%= doc[:target].kind %>"><a class="dashed" href="<%= link_for(doc[:target]) %>"><%= doc[:target].name %></a></span>
|
9
|
+
<% end %>
|
@@ -8,12 +8,13 @@
|
|
8
8
|
<% elsif doc[:type] == :neutral_identifier || doc[:type] == :unresolved_identifier %>
|
9
9
|
<code><%= doc[:value] %></code>
|
10
10
|
<% elsif doc[:type] == :reference %>
|
11
|
-
<%= reference(object:
|
11
|
+
<%= reference(object: doc) %>
|
12
12
|
<% elsif doc[:type] == :symbol %>
|
13
13
|
<%= symbol(name: doc[:value]) %>
|
14
14
|
<% elsif doc[:type] == :method_ref %>
|
15
15
|
<a class="method-ref dashed" href="<%= link_for(doc[:object]) %>"><%= doc[:value] %></a>
|
16
|
-
|
16
|
+
<% elsif doc[:type] == :class_path_reference %>
|
17
|
+
<%= class_path_reference(doc: doc) %>
|
17
18
|
<% else %>
|
18
19
|
<div class="unknown-object">
|
19
20
|
Unknown object <%= doc[:type] %>
|
@@ -3,7 +3,12 @@
|
|
3
3
|
<span class="rest-arg <%= computed[:rest] %>"></span>
|
4
4
|
<% end %>
|
5
5
|
|
6
|
-
|
6
|
+
<% if computed[:rest] || computed[:block] %>
|
7
|
+
<%= computed[:name].to_s.gsub(/^([*]{1,2}|&)$/, '') %>
|
8
|
+
<% else %>
|
9
|
+
<%= computed[:name] %>
|
10
|
+
<% end %>
|
11
|
+
|
7
12
|
|
8
13
|
<% if computed[:continuation] %>
|
9
14
|
<span class="continuation <%= computed[:continuation] %>"></span>
|
data/templates/reference.erb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: docrb-html
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.3.
|
4
|
+
version: 0.3.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Victor Gama
|
@@ -83,6 +83,7 @@ files:
|
|
83
83
|
- assets/checkbox.scss
|
84
84
|
- assets/class_header.scss
|
85
85
|
- assets/class_mod_name.scss
|
86
|
+
- assets/class_path_reference.scss
|
86
87
|
- assets/component_list.scss
|
87
88
|
- assets/constant_display.scss
|
88
89
|
- assets/container.scss
|
@@ -134,6 +135,7 @@ files:
|
|
134
135
|
- lib/renderer/component/checkbox.rb
|
135
136
|
- lib/renderer/component/class_header.rb
|
136
137
|
- lib/renderer/component/class_mod_name.rb
|
138
|
+
- lib/renderer/component/class_path_reference.rb
|
137
139
|
- lib/renderer/component/component_list.rb
|
138
140
|
- lib/renderer/component/constant_display.rb
|
139
141
|
- lib/renderer/component/doc_box.rb
|
@@ -182,6 +184,7 @@ files:
|
|
182
184
|
- templates/checkbox.erb
|
183
185
|
- templates/class_header.erb
|
184
186
|
- templates/class_mod_name.erb
|
187
|
+
- templates/class_path_reference.erb
|
185
188
|
- templates/component_list.erb
|
186
189
|
- templates/constant_display.erb
|
187
190
|
- templates/doc_box.erb
|