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.

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

Unlink WEBrick::HTTPUtils.#escape_form because the page is missing #2113

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

Conversation

JunichiIto
Copy link
Contributor

https://docs.ruby-lang.org/ja/latest/method/URI/s/encode.htmlWEBrick::HTTPUtils.#escape_formへのリンクがあるのですが、ページが未作成なので(参考)、リンクをクリックしても404になります。
ですので、ページが作成されるまでリンクを外しておいた方がいいのでは?と思いました。

(ただし、 https://docs.ruby-lang.org/ja/latest/class/WEBrick=3a=3aHTTPUtils.html を見てもescape_formが見当たらないので、結局読み手は困惑しそうですが・・・)

@znz
Copy link
Member

znz commented Jan 28, 2020

リンクを消してしまうと戻し忘れると思うので、リンク先を作成する方向で対応したいです。

@@ -159,7 +159,7 @@ URI 文字列をエンコードした文字列を返します。
[[m:ERB::Util.#url_encode]],
[[m:CGI.escape]],
[[m:URI.encode_www_form_component]],
[[m:WEBrick::HTTPUtils.#escape_form]],
WEBrick::HTTPUtils.#escape_form,
Copy link
Member

Choose a reason for hiding this comment

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

これるりまではコメントアウトされてるようですね

#@#--- escape_form(str)
#@#todo

rdocにはエントリありました
https://docs.ruby-lang.org/en/2.7.0/WEBrick/HTTPUtils.html#method-i-escape_form

「内部で使われているだけのメソッドと定数を削除。 」と 4648051 のコミットで削除されていますが、実際には使われているようですね

% csearch -f '\.rb$' '\.escape_form'
/mnt/gems/gem-codesearch/latest-gem/Chrononaut-echoe-3.0.2/lib/echoe/client.rb:          WEBrick::HTTPUtils.escape_form(k.to_s) + "\""
/mnt/gems/gem-codesearch/latest-gem/aws-sdk-s3-1.59.0/lib/aws-sdk-s3/legacy_signer.rb:        #         WEBrick::HTTPUtils.escape_form(s),
/mnt/gems/gem-codesearch/latest-gem/cinch-lastfm-ng-0.1.3/lib/cinch/plugins/lastfm.rb:          doop = WEBrick::HTTPUtils.escape_form(artist)
/mnt/gems/gem-codesearch/latest-gem/cinch-lastfm-ng-0.1.3/lib/cinch/plugins/lastfm.rb:          pood = WEBrick::HTTPUtils.escape_form(title)
/mnt/gems/gem-codesearch/latest-gem/cinch-lastfm-ng-0.1.3/lib/cinch/plugins/lastfm.rb:          doop = WEBrick::HTTPUtils.escape_form(artist)
/mnt/gems/gem-codesearch/latest-gem/cinch-lastfm-ng-0.1.3/lib/cinch/plugins/lastfm.rb:        artist = WEBrick::HTTPUtils.escape_form(artist)
/mnt/gems/gem-codesearch/latest-gem/elliottcable-echoe-3.1.3/lib/echoe/client.rb:          WEBrick::HTTPUtils.escape_form(k.to_s) + "\""
/mnt/gems/gem-codesearch/latest-gem/eric-mechanize-0.9.3.20090623142847/lib/www/mechanize/util.rb:              [WEBrick::HTTPUtils.escape_form(k.to_s),
/mnt/gems/gem-codesearch/latest-gem/eric-mechanize-0.9.3.20090623142847/lib/www/mechanize/util.rb:                WEBrick::HTTPUtils.escape_form(v.to_s)].join("=")
/mnt/gems/gem-codesearch/latest-gem/fauna-echoe-3.2/lib/echoe/client.rb:          WEBrick::HTTPUtils.escape_form(k.to_s) + "\""
/mnt/gems/gem-codesearch/latest-gem/gemrage-1.0.0/vendor/ruby/1.8/gems/rubyforge-2.0.4/lib/rubyforge/client.rb:            WEBrick::HTTPUtils.escape_form(k.to_s) + "\""
/mnt/gems/gem-codesearch/latest-gem/gemrage-1.0.0/vendor/ruby/1.8/gems/rubyforge-2.0.4/lib/rubyforge/client.rb:        k && [  WEBrick::HTTPUtils.escape_form(k.to_s),
/mnt/gems/gem-codesearch/latest-gem/gemrage-1.0.0/vendor/ruby/1.8/gems/rubyforge-2.0.4/lib/rubyforge/client.rb:                WEBrick::HTTPUtils.escape_form(v.to_s) ].join('=')
/mnt/gems/gem-codesearch/latest-gem/gonzui-1.2/lib/gonzui/webapp/markup.rb:        query_string =  sprintf("%s:%s", tt, HTTPUtils.escape_form(text))
/mnt/gems/gem-codesearch/latest-gem/gonzui-1.2/lib/gonzui/webapp/uri.rb:              HTTPUtils.escape_form(search_query.string_without_properties))
/mnt/gems/gem-codesearch/latest-gem/gonzui-1.2/lib/gonzui/webapp/uri.rb:          param = sprintf("%s=%s", qv.short_name, HTTPUtils.escape_form(value.to_s))
/mnt/gems/gem-codesearch/latest-gem/horseman-0.0.5/vendor/ruby/1.9.1/gems/rubyforge-2.0.4/lib/rubyforge/client.rb:            WEBrick::HTTPUtils.escape_form(k.to_s) + "\""
/mnt/gems/gem-codesearch/latest-gem/horseman-0.0.5/vendor/ruby/1.9.1/gems/rubyforge-2.0.4/lib/rubyforge/client.rb:        k && [  WEBrick::HTTPUtils.escape_form(k.to_s),
/mnt/gems/gem-codesearch/latest-gem/horseman-0.0.5/vendor/ruby/1.9.1/gems/rubyforge-2.0.4/lib/rubyforge/client.rb:                WEBrick::HTTPUtils.escape_form(v.to_s) ].join('=')
/mnt/gems/gem-codesearch/latest-gem/ivanvc-logstash-input-s3-3.1.1.4/vendor/local/gems/aws-sdk-core-2.3.22/lib/aws-sdk-core/signers/s3.rb:        #         WEBrick::HTTPUtils.escape_form(s),
/mnt/gems/gem-codesearch/latest-gem/knu-mechanize-0.9.3.20090623142847/lib/www/mechanize/util.rb:              [WEBrick::HTTPUtils.escape_form(k.to_s),
/mnt/gems/gem-codesearch/latest-gem/knu-mechanize-0.9.3.20090623142847/lib/www/mechanize/util.rb:                WEBrick::HTTPUtils.escape_form(v.to_s)].join("=")
/mnt/gems/gem-codesearch/latest-gem/mack-0.8.3.1/lib/gems/rubyforge-1.0.1/lib/rubyforge/client.rb:            WEBrick::HTTPUtils.escape_form(k.to_s) + "\""
/mnt/gems/gem-codesearch/latest-gem/mack-0.8.3.1/lib/gems/rubyforge-1.0.1/lib/rubyforge/client.rb:        k && [  WEBrick::HTTPUtils.escape_form(k.to_s),
/mnt/gems/gem-codesearch/latest-gem/mack-0.8.3.1/lib/gems/rubyforge-1.0.1/lib/rubyforge/client.rb:                WEBrick::HTTPUtils.escape_form(v.to_s) ].join('=')
/mnt/gems/gem-codesearch/latest-gem/mechanize-ntlm-0.9.1/lib/www/mechanize/util.rb:              [WEBrick::HTTPUtils.escape_form(k.to_s),
/mnt/gems/gem-codesearch/latest-gem/mechanize-ntlm-0.9.1/lib/www/mechanize/util.rb:                WEBrick::HTTPUtils.escape_form(v.to_s)].join("=")
/mnt/gems/gem-codesearch/latest-gem/ric-0.13.0/vendor/bundle/ruby/2.5.0/gems/rubyforge-2.0.4/lib/rubyforge/client.rb:            WEBrick::HTTPUtils.escape_form(k.to_s) + "\""
/mnt/gems/gem-codesearch/latest-gem/ric-0.13.0/vendor/bundle/ruby/2.5.0/gems/rubyforge-2.0.4/lib/rubyforge/client.rb:        k && [  WEBrick::HTTPUtils.escape_form(k.to_s),
/mnt/gems/gem-codesearch/latest-gem/ric-0.13.0/vendor/bundle/ruby/2.5.0/gems/rubyforge-2.0.4/lib/rubyforge/client.rb:                WEBrick::HTTPUtils.escape_form(v.to_s) ].join('=')
/mnt/gems/gem-codesearch/latest-gem/rsanheim-echoe-3/lib/echoe/client.rb:          WEBrick::HTTPUtils.escape_form(k.to_s) + "\""
/mnt/gems/gem-codesearch/latest-gem/rubyforge-2.0.4/lib/rubyforge/client.rb:            WEBrick::HTTPUtils.escape_form(k.to_s) + "\""
/mnt/gems/gem-codesearch/latest-gem/rubyforge-2.0.4/lib/rubyforge/client.rb:        k && [  WEBrick::HTTPUtils.escape_form(k.to_s),
/mnt/gems/gem-codesearch/latest-gem/rubyforge-2.0.4/lib/rubyforge/client.rb:                WEBrick::HTTPUtils.escape_form(v.to_s) ].join('=')
/mnt/gems/gem-codesearch/latest-gem/search_do-0.3.0/lib/estraier_admin.rb:    params.map{|k,v| "#{k}=#{WEBrick::HTTPUtils.escape_form(v.to_s)}" }.join('&')
/mnt/gems/gem-codesearch/latest-gem/technicalpickles-echoe-3/lib/echoe/client.rb:          WEBrick::HTTPUtils.escape_form(k.to_s) + "\""

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants