Miroirs/devdocs
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/devdocs synced 2024-11-16 19:48:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update HTTP documentation

Browse source
This commit is contained in:
Simon Legner 2021-10-22 19:07:00 +02:00
parent 3e391f156e
commit c34bbc965c
4 changed files with 31 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
assets/javascripts/vendor/raven.js vendored
View file

@ -2222,7 +2222,7 @@ function urlencode(o) {
return pairs.join('&'); return pairs.join('&');
} }
// borrowed from https://tools.ietf.org/html/rfc3986#appendix-B // borrowed from https://datatracker.ietf.org/doc/html/rfc3986#appendix-B
// intentionally using regex and not <a/> href parsing trick because React Native and other // intentionally using regex and not <a/> href parsing trick because React Native and other
// environments where DOM might not be available // environments where DOM might not be available
function parseUrl(url) { function parseUrl(url) {

4
lib/docs/filters/http/clean_html.rb
View file

@ -2,7 +2,7 @@ module Docs
class Http class Http
class CleanHtmlFilter < Filter class CleanHtmlFilter < Filter
def call def call
current_url.host == 'tools.ietf.org' ? ietf : mdn current_url.host == 'datatracker.ietf.org' ? ietf : mdn
doc doc
end end
@ -43,7 +43,7 @@ module Docs
end end
css('.selflink').each do |node| css('.selflink').each do |node|
node.parent['id'] = node['name'] node.parent['id'] = node['id']
node.before(node.children).remove node.before(node.children).remove
end end

6
lib/docs/filters/http/entries.rb
View file

@ -2,7 +2,7 @@ module Docs
class Http class Http
class EntriesFilter < Docs::EntriesFilter class EntriesFilter < Docs::EntriesFilter
def get_name def get_name
if current_url.host == 'tools.ietf.org' if current_url.host == 'datatracker.ietf.org'
name = at_css('h1').content name = at_css('h1').content
name.remove! %r{\A.+\:} name.remove! %r{\A.+\:}
name.remove! %r{\A.+\-\-} name.remove! %r{\A.+\-\-}
@ -22,7 +22,7 @@ module Docs
end end
def get_type def get_type
return name if current_url.host == 'tools.ietf.org' return name if current_url.host == 'datatracker.ietf.org'
if slug.start_with?('Headers/Content-Security-Policy') if slug.start_with?('Headers/Content-Security-Policy')
'CSP' 'CSP'
@ -101,7 +101,7 @@ module Docs
LEVEL_3 = /\A(\d+)\.\d+\.\d+\z/ LEVEL_3 = /\A(\d+)\.\d+\.\d+\z/
def additional_entries def additional_entries
return [] unless current_url.host == 'tools.ietf.org' return [] unless current_url.host == 'datatracker.ietf.org'
type = nil type = nil
css('a[href^="#section-"]').each_with_object([]) do |node, entries| css('a[href^="#section-"]').each_with_object([]) do |node, entries|

40
lib/docs/scrapers/http.rb
View file

@ -2,15 +2,25 @@ module Docs
class Http < Mdn class Http < Mdn
include MultipleBaseUrls include MultipleBaseUrls
# release = '2021-10-22'
self.name = 'HTTP' self.name = 'HTTP'
self.base_urls = ['https://developer.mozilla.org/en-US/docs/Web/HTTP', 'https://tools.ietf.org/html/'] self.base_urls = [
'https://developer.mozilla.org/en-US/docs/Web/HTTP',
'https://datatracker.ietf.org/doc/html/',
]
html_filters.push 'http/clean_html', 'http/entries', 'title' html_filters.push 'http/clean_html', 'http/entries', 'title'
options[:root_title] = 'HTTP' options[:root_title] = 'HTTP'
options[:title] = ->(filter) { filter.current_url.host == 'tools.ietf.org' ? false : filter.default_title } options[:title] = ->(filter) do
options[:container] = ->(filter) { filter.current_url.host == 'tools.ietf.org' ? '.content' : nil } filter.current_url.host == 'datatracker.ietf.org' ? false : filter.default_title
options[:skip_links] = ->(filter) { filter.current_url.host == 'tools.ietf.org' ? true : false } end
options[:container] = ->(filter) do
filter.current_url.host == 'datatracker.ietf.org' ? '.content .draftcontent' : Docs::Mdn.options[:container]
end
options[:skip_links] = ->(filter) do
filter.current_url.host == 'datatracker.ietf.org' ? true : false
end
options[:replace_paths] = { '/Access_control_CORS' => '/CORS' } options[:replace_paths] = { '/Access_control_CORS' => '/CORS' }
options[:fix_urls] = ->(url) do options[:fix_urls] = ->(url) do
url.sub! %r{(Status/\d\d\d)_[A-Z].+}, '\1' url.sub! %r{(Status/\d\d\d)_[A-Z].+}, '\1'
@ -18,7 +28,7 @@ module Docs
end end
options[:attribution] = ->(filter) do options[:attribution] = ->(filter) do
if filter.current_url.host == 'tools.ietf.org' if filter.current_url.host == 'datatracker.ietf.org'
"&copy; document authors. All rights reserved." "&copy; document authors. All rights reserved."
else else
Docs::Mdn.options[:attribution] Docs::Mdn.options[:attribution]
@ -27,16 +37,16 @@ module Docs
def initial_urls def initial_urls
%w(https://developer.mozilla.org/en-US/docs/Web/HTTP %w(https://developer.mozilla.org/en-US/docs/Web/HTTP
https://tools.ietf.org/html/rfc2616 https://datatracker.ietf.org/doc/html/rfc2616
https://tools.ietf.org/html/rfc4918 https://datatracker.ietf.org/doc/html/rfc4918
https://tools.ietf.org/html/rfc7230 https://datatracker.ietf.org/doc/html/rfc7230
https://tools.ietf.org/html/rfc7231 https://datatracker.ietf.org/doc/html/rfc7231
https://tools.ietf.org/html/rfc7232 https://datatracker.ietf.org/doc/html/rfc7232
https://tools.ietf.org/html/rfc7233 https://datatracker.ietf.org/doc/html/rfc7233
https://tools.ietf.org/html/rfc7234 https://datatracker.ietf.org/doc/html/rfc7234
https://tools.ietf.org/html/rfc7235 https://datatracker.ietf.org/doc/html/rfc7235
https://tools.ietf.org/html/rfc7540 https://datatracker.ietf.org/doc/html/rfc7540
https://tools.ietf.org/html/rfc5023) https://datatracker.ietf.org/doc/html/rfc5023)
end end
end end
end end