vuex: finish scraper and filters

Jasper van Merle committed 7 years ago

Commit 40defdd1 parent 186932e5 files · +37 −32Browse files

Unified · Split

5 files

assets/javascripts/templates/pages/about_tmpl.coffee +7 −7
lib/docs/filters/vuex/clean_html.rb +4 −1
lib/docs/filters/vuex/entries.rb +18 −17
lib/docs/scrapers/vuex.rb +7 −6
public/icons/docs/vuex/SOURCE +1 −1

assets/javascripts/templates/pages/about_tmpl.coffee+7−7

@@ -729,6 +729,11 @@ credits = [ · 728 unmodified lines
729	729	'2010-2018 Mitchell Hashimoto',
730	730	'MPL',
731	731	'https://raw.githubusercontent.com/mitchellh/vagrant/master/website/LICENSE.md'
	732	+ ], [
	733	+ 'Vue Router',
	734	+ '2013-present Evan You',
	735	+ 'MIT',
	736	+ 'https://raw.githubusercontent.com/vuejs/vue-router/dev/LICENSE'
732	737	], [
733	738	'Vue.js',
734	739	'2013-2018 Evan You, Vue.js contributors',
@@ -736,14 +741,9 @@ credits = [ · 1 unmodified line
736	741	'https://raw.githubusercontent.com/vuejs/vue/master/LICENSE'
737	742	], [
738	743	'Vuex',
739		− '2015-2018 Evan You, Vue.js contributors',
	744	+ '2015-present Evan You',
740	745	'MIT',
741		− 'https://raw.githubusercontent.com/vuejs/vuex/master/LICENSE'
742		− ], [
743		− 'Vue Router',
744		− '2013-present Evan You',
745		− 'MIT',
746		− 'https://raw.githubusercontent.com/vuejs/vue-router/dev/LICENSE'
	746	+ 'https://raw.githubusercontent.com/vuejs/vuex/dev/LICENSE'
747	747	], [
748	748	'Vulkan',
749	749	'2014-2017 Khronos Group Inc.<br>Vulkan and the Vulkan logo are registered trademarks of the Khronos Group Inc.',

lib/docs/filters/vuex/clean_html.rb+4−1

@@ -4,6 +4,9 @@ module Docs · 3 unmodified lines
4	4	def call
5	5	@doc = at_css('.content')
6	6
	7	+ # Remove video from root page
	8	+ css('a[href="#"]').remove if root_page?
	9	+
7	10	# Remove unneeded elements
8	11	css('.header-anchor').remove
9	12
@@ -11,4 +14,4 @@ module Docs · 1 unmodified line
11	14	end
12	15	end
13	16	end
14		−end
	17	+end

lib/docs/filters/vuex/entries.rb+18−17

@@ -8,10 +8,10 @@ module Docs · 7 unmodified lines
8	8
9	9	# Add index on guides
10	10	unless subpath.start_with?('api')
11		− sidebarLink = at_css('.sidebar-link.active')
12		− allLinks = css('.sidebar-link:not([href="/"]):not([href="../index"])')
	11	+ sidebar_link = at_css('.sidebar-link.active')
	12	+ all_links = css('.sidebar-link:not([href="/"]):not([href="../index"])')
13	13
14		− index = allLinks.index(sidebarLink)
	14	+ index = all_links.index(sidebar_link)
15	15
16	16	name.prepend "#{index + 1}. " if index
17	17	end
@@ -28,7 +28,7 @@ module Docs · 10 unmodified lines
28	28	end
29	29
30	30	def additional_entries
31		− return [] unless subpath.start_with?('api')
	31	+ return [] unless subpath.start_with?('api')
32	32
33	33	entries = [
34	34	['Component Binding Helpers', 'component-binding-helpers', 'API Reference'],
@@ -36,7 +36,7 @@ module Docs · 1 unmodified line
36	36	]
37	37
38	38	css('h3').each do \|node\|
39		− entryName = node.content.strip
	39	+ entry_name = node.content.strip
40	40
41	41	# Get the previous h2 title
42	42	title = node
@@ -44,25 +44,26 @@ module Docs · 1 unmodified line
44	44	title = title.content.strip
45	45	title.remove! '# '
46	46
47		− entryName.remove! '# '
	47	+ entry_name.remove! '# '
48	48
49		− unless entryName.start_with?('router.')
50		− if title == "Vuex.Store Constructor Options"
51		− entryName = "StoreOptions.#{entryName}"
52		− elsif title == "Vuex.Store Instance Properties"
53		− entryName = "Vuex.Store.#{entryName}"
54		− elsif title == "Vuex.Store Instance Methods"
55		− entryName = "Vuex.Store.#{entryName}()"
56		− elsif title == "Component Binding Helpers"
57		− entryName = "#{entryName}()"
	49	+ unless entry_name.start_with?('router.')
	50	+ case title
	51	+ when "Vuex.Store Constructor Options"
	52	+ entry_name = "StoreOptions.#{entry_name}"
	53	+ when "Vuex.Store Instance Properties"
	54	+ entry_name = "Vuex.Store.#{entry_name}"
	55	+ when "Vuex.Store Instance Methods"
	56	+ entry_name = "Vuex.Store.#{entry_name}()"
	57	+ when "Component Binding Helpers"
	58	+ entry_name = "#{entry_name}()"
58	59	end
59	60	end
60	61
61		− entries << [entryName, node['id'], 'API Reference']
	62	+ entries << [entry_name, node['id'], 'API Reference']
62	63	end
63	64
64	65	entries
65	66	end
66	67	end
67	68	end
68		−end
	69	+end

lib/docs/scrapers/vuex.rb+7−6

@@ -1,8 +1,8 @@
1	1	module Docs
2	2	class Vuex < UrlScraper
3		− self.name = 'Vuex'
4	3	self.type = 'simple'
5		−
	4	+ self.release = '3.1.1'
	5	+ self.base_url = 'https://vuex.vuejs.org/'
6	6	self.links = {
7	7	home: 'https://vuex.vuejs.org',
8	8	code: 'https://github.com/vuejs/vuex'
@@ -10,17 +10,18 @@ module Docs · 1 unmodified line
10	10
11	11	html_filters.push 'vuex/entries', 'vuex/clean_html'
12	12
13		− self.release = '3.0.1'
14		− self.base_url = 'https://vuex.vuejs.org/'
15		−
16	13	options[:skip_patterns] = [
17	14	# Other languages
18	15	/^(zh\|ja\|ru\|kr\|fr\|ptbr)\//,
19	16	]
20	17
21	18	options[:attribution] = <<-HTML
22		− © 2015–2018 Evan You, Vue.js contributors<br>
	19	+ © 2015–present Evan You<br>
23	20	Licensed under the MIT License.
24	21	HTML
	22	+
	23	+ def get_latest_version(opts)
	24	+ get_npm_version('vuex', opts)
	25	+ end
25	26	end
26	27	end

public/icons/docs/vuex/SOURCE+1−1

@@ -1 +1 @@
1		−http://vuejs.org/
	1	+https://github.com/vuejs/vuejs.org/blob/master/assets/logo.ai