Update Kotlin documentation (1.6.0)

Simon Legner committed 4 years ago

Commit 1378b381 parent 2fa27c33 files · +38 −22Browse files

Unified · Split

3 files

lib/docs/filters/kotlin/clean_html.rb +7 −1
lib/docs/filters/kotlin/entries.rb +8 −7
lib/docs/scrapers/kotlin.rb +23 −14

lib/docs/filters/kotlin/clean_html.rb+7−1

@@ -2,7 +2,6 @@ module Docs · 1 unmodified line
2	2	class Kotlin
3	3	class CleanHtmlFilter < Filter
4	4	def call
5		− @doc = at_css('.page-content')
6	5	subpath.start_with?('api') ? api_page : doc_page
7	6	doc
8	7	end
@@ -14,6 +13,13 @@ module Docs · 5 unmodified lines
14	13	node.parent.before(node.parent.content).remove
15	14	end
16	15
	16	+ css('div.code-block').each do \|node\|
	17	+ node.name = 'pre'
	18	+ node['data-language'] = node['data-lang']
	19	+ node.content = node.content
	20	+ # FIXME: newlines in code-block are lost because of <div>? (on https://kotlinlang.org/docs/typecasts.html for instance)
	21	+ end
	22	+
17	23	css('pre').each do \|node\|
18	24	node['data-language'] = 'kotlin' if node.at_css('code.language-kotlin')
19	25	node['data-language'] = 'groovy' if node.at_css('code.language-groovy')

lib/docs/filters/kotlin/entries.rb+8−7

@@ -6,25 +6,26 @@ module Docs · 5 unmodified lines
6	6	breadcrumbs[1..-1].join('.')
7	7	else
8	8	node = (at_css('h1') \|\| at_css('h2'))
9		− return node.content unless node.nil?
10		− subpath[/\/([a-z0-9_-]+)\./][1..-2].titleize.sub('Faq', 'FAQ')
	9	+ return [breadcrumbs[1..], [node.content]].flatten.join(': ') unless node.nil?
11	10	end
12	11	end
13	12
14	13	def get_type
15	14	if subpath.start_with?('api')
16	15	breadcrumbs[1]
17		− elsif subpath.start_with?('docs/tutorials')
18		− 'Tutorials'
19		− elsif subpath.start_with?('docs/reference')
20		− 'Reference'
	16	+ else
	17	+ breadcrumbs[0]
21	18	end
22	19	end
23	20
24	21	private
25	22
26	23	def breadcrumbs
27		− @breadcrumbs \|\|= css('.api-docs-breadcrumbs a').map(&:content).map(&:strip)
	24	+ if subpath.start_with?('api')
	25	+ @breadcrumbs \|\|= css('.api-docs-breadcrumbs a').map(&:content).map(&:strip)
	26	+ else
	27	+ @breadcrumbs \|\|= doc.document.at_css('body')['data-breadcrumbs'].split('///')
	28	+ end
28	29	end
29	30	end
30	31	end

lib/docs/scrapers/kotlin.rb+23−14

@@ -1,7 +1,6 @@
1	1	module Docs
2	2	class Kotlin < UrlScraper
3	3	self.type = 'kotlin'
4		− self.release = '1.4.10'
5	4	self.base_url = 'https://kotlinlang.org/'
6	5	self.root_path = 'api/latest/jvm/stdlib/index.html'
7	6	self.links = {
@@ -11,9 +10,8 @@ module Docs · 3 unmodified lines
11	10
12	11	html_filters.push 'kotlin/entries', 'kotlin/clean_html'
13	12
14		− options[:container] = '.global-content'
15		−
16		− options[:only_patterns] = [/\Adocs\/tutorials\//, /\Adocs\/reference\//, /\Aapi\/latest\/jvm\/stdlib\//]
	13	+ options[:container] = 'article'
	14	+ options[:only_patterns] = [/\Adocs\//, /\Aapi\/latest\/jvm\/stdlib\//]
17	15	options[:skip_patterns] = [/stdlib\/org\./]
18	16	options[:skip] = %w(
19	17	api/latest/jvm/stdlib/alltypes/index.html
@@ -22,23 +20,34 @@ module Docs · 2 unmodified lines
22	20	docs/events.html
23	21	docs/resources.html
24	22	docs/reference/grammar.html)
25		− options[:replace_paths] = {
26		− 'api/latest/jvm/stdlib/' => 'api/latest/jvm/stdlib/index.html',
27		− 'docs/reference/coroutines.html' => 'docs/reference/coroutines-overview.html',
28		− 'api/latest/jvm/stdlib/kotlin/fold.html' => 'api/latest/jvm/stdlib/kotlin.collections/fold.html',
29		− 'api/latest/jvm/stdlib/kotlin/get-or-else.html' => 'api/latest/jvm/stdlib/kotlin.collections/get-or-else.html',
30		− 'api/latest/jvm/stdlib/kotlin/map.html' => 'api/latest/jvm/stdlib/kotlin.collections/map.html',
31		− 'docs/tutorials/native/targeting-multiple-platforms.html' => 'docs/tutorials/native/basic-kotlin-native-app.html',
32		− 'api/latest/jvm/stdlib/kotlin/-throwable/print-stack-trace.html' => 'api/latest/jvm/stdlib/kotlin/print-stack-trace.html',
33		− }
	23	+
	24	+ options[:fix_urls] = ->(url) do
	25	+ url.sub! %r{/docs/reference/}, '/docs/'
	26	+ url
	27	+ end
34	28
35	29	options[:attribution] = <<-HTML
36		− © 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors<br>
	30	+ © 2010–2021 JetBrains s.r.o. and Kotlin Programming Language contributors<br>
37	31	Licensed under the Apache License, Version 2.0.
38	32	HTML
39	33
	34	+ version '1.6' do
	35	+ self.release = '1.6.0'
	36	+ end
	37	+
	38	+ version '1.4' do
	39	+ self.release = '1.4.10'
	40	+ end
	41	+
40	42	def get_latest_version(opts)
41	43	get_latest_github_release('JetBrains', 'kotlin', opts)
42	44	end
	45	+
	46	+ private
	47	+
	48	+ def process_response?(response)
	49	+ return false unless super
	50	+ response.body !~ /http-equiv="refresh"/i
	51	+ end
43	52	end
44	53	end