Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display ancestor's singleton methods in class page #148

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Display ancestor's singleton methods in class page #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions data/bitclust/catalog/ja_JP.UTF-8
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Ancestor Methods
継承しているメソッド
Ancestor Methods %s
%sから継承しているメソッド
Ancestor Singleton Methods %s
%sから継承している特異メソッド
Builtin
組み込み
Builtin Library
Expand Down
31 changes: 25 additions & 6 deletions data/bitclust/template.offline/class
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,17 +146,37 @@

<%
_myself, *ancestors = @entry.ancestors.reject { |c| %w[Object Kernel BasicObject].include?(c.name) }
displayed_methods = Set.new(ents.instance_methods.flat_map(&:names))
displayed_instance_methods = Set.new(ents.instance_methods.flat_map(&:names))
displayed_singleton_methods = Set.new(ents.singleton_methods.flat_map(&:names))
%>

<% unless ancestors.empty? %>
<%= headline(_("Ancestor Methods")) %>
<dl>
<% ancestors.each do |c|
undefined_methods = @entry.partitioned_entries.undefined
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hanachin undefined_methodsって特異メソッドとインスタンスメソッドを区別していないように見えたのですが、合っていますか？
このPRで追加したコードだと継承したインスタンスメソッドを表示するコードをそのまま特異メソッドの方にも持ってきているので、特異メソッドとインスタンスメソッドで同名のメソッドがundefされている場合になにか壊れそうな気がしています。

その辺どうなっているのかよく理解していないので、見てもらえると助かりますー🙏

Copy link
Member

@hanachin hanachin Oct 27, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

このPRで追加したコードだと継承したインスタンスメソッドを表示するコードをそのまま特異メソッドの方にも持ってきているので、特異メソッドとインスタンスメソッドで同名のメソッドがundefされている場合になにか壊れそうな気がしています。

雑にundefinedされたメソッドをひとまとまりにしているので壊れますね。
現状のmasterでも特異メソッドで @undef すると同名のインスタンスメソッドが継承したメソッド一覧から消えてしまいそうな気がします。

修正方針として

  1. partitioned_entries の中でundefinedでひとまとめにせずに特異メソッドとインスタンスメソッドを分ける
  2. 雑に undefined_methods.any? の中に「m.instance_method?」なり「m.singleton_method?」のガードを追加する

のどちらかかな、と考えてます。

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

特異メソッドとインスタンスメソッドで同名のメソッドがundefされている場合になにか壊れそうな気がしています。

今も壊れてそうなので2の方で直してみました
#150

singleton methodの場合こういう絞りこみが必要そうです

Suggested change
undefined_methods = @entry.partitioned_entries.undefined
undefined_methods = @entry.partitioned_entries.undefined.select(&:singleton_method?)

methods = c.partitioned_entries(@alevel).singleton_methods
.flat_map { |m| m.names.map { |n| [n, m] } }
.reject { |name,| displayed_singleton_methods.include?(name) }
.reject { |name,| undefined_methods.any? { |m| m.names.include?(name) } }
.sort
next if methods.empty? %>
<dt><%= _('Ancestor Singleton Methods %s', c.name) %></dt>
<dd>
<ul class="class-toc">
<% methods.each do |name, m| %>
<li><%= method_link(m.spec_string, name) %></li>
<% displayed_singleton_methods << name %>
<% end %>
</ul>
</dd>
<% end %>

<% ancestors.each do |c|
undefined_methods = @entry.partitioned_entries.undefined
methods = c.partitioned_entries(@alevel).instance_methods
.flat_map { |m| m.names.map { |n| [n, m] } }
.reject { |name,| displayed_methods.include?(name) }
.reject { |name,| displayed_instance_methods.include?(name) }
.reject { |name,| undefined_methods.any? { |m| m.names.include?(name) } }
.sort
next if methods.empty? %>
Expand All @@ -165,14 +185,13 @@ displayed_methods = Set.new(ents.instance_methods.flat_map(&:names))
<ul class="class-toc">
<% methods.each do |name, m| %>
<li><%= method_link(m.spec_string, name) %></li>
<% displayed_methods << name %>
<% displayed_instance_methods << name %>
<% end %>
</ul>
</dd>
<%
end
end %>
<% end %>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ここはついでの修正で、 </dl>の位置がずれていて継承したメソッドがない時にHTMLが壊れていたので修正しています

</dl>
<% end %>

<%
items.each do |label, entries|
Expand Down