From 40defddb6cdea03f9b66579843da7ac70fa5449a Mon Sep 17 00:00:00 2001 From: Jasper van Merle Date: Tue, 13 Aug 2019 23:52:21 +0200 Subject: [PATCH] vuex: finish scraper and filters --- .../templates/pages/about_tmpl.coffee | 14 ++++---- lib/docs/filters/vuex/clean_html.rb | 5 ++- lib/docs/filters/vuex/entries.rb | 35 ++++++++++--------- lib/docs/scrapers/vuex.rb | 13 +++---- public/icons/docs/vuex/SOURCE | 2 +- 5 files changed, 37 insertions(+), 32 deletions(-) diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 51d76c61..07c92ad8 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -729,6 +729,11 @@ credits = [ '2010-2018 Mitchell Hashimoto', 'MPL', 'https://raw.githubusercontent.com/mitchellh/vagrant/master/website/LICENSE.md' + ], [ + 'Vue Router', + '2013-present Evan You', + 'MIT', + 'https://raw.githubusercontent.com/vuejs/vue-router/dev/LICENSE' ], [ 'Vue.js', '2013-2018 Evan You, Vue.js contributors', @@ -736,14 +741,9 @@ credits = [ 'https://raw.githubusercontent.com/vuejs/vue/master/LICENSE' ], [ 'Vuex', - '2015-2018 Evan You, Vue.js contributors', + '2015-present Evan You', 'MIT', - 'https://raw.githubusercontent.com/vuejs/vuex/master/LICENSE' - ], [ - 'Vue Router', - '2013-present Evan You', - 'MIT', - 'https://raw.githubusercontent.com/vuejs/vue-router/dev/LICENSE' + 'https://raw.githubusercontent.com/vuejs/vuex/dev/LICENSE' ], [ 'Vulkan', '2014-2017 Khronos Group Inc.
Vulkan and the Vulkan logo are registered trademarks of the Khronos Group Inc.', diff --git a/lib/docs/filters/vuex/clean_html.rb b/lib/docs/filters/vuex/clean_html.rb index f62870cc..4aad55a9 100644 --- a/lib/docs/filters/vuex/clean_html.rb +++ b/lib/docs/filters/vuex/clean_html.rb @@ -4,6 +4,9 @@ module Docs def call @doc = at_css('.content') + # Remove video from root page + css('a[href="#"]').remove if root_page? + # Remove unneeded elements css('.header-anchor').remove @@ -11,4 +14,4 @@ module Docs end end end -end \ No newline at end of file +end diff --git a/lib/docs/filters/vuex/entries.rb b/lib/docs/filters/vuex/entries.rb index 72c8486e..04846fd2 100644 --- a/lib/docs/filters/vuex/entries.rb +++ b/lib/docs/filters/vuex/entries.rb @@ -8,10 +8,10 @@ module Docs # Add index on guides unless subpath.start_with?('api') - sidebarLink = at_css('.sidebar-link.active') - allLinks = css('.sidebar-link:not([href="/"]):not([href="../index"])') + sidebar_link = at_css('.sidebar-link.active') + all_links = css('.sidebar-link:not([href="/"]):not([href="../index"])') - index = allLinks.index(sidebarLink) + index = all_links.index(sidebar_link) name.prepend "#{index + 1}. " if index end @@ -28,7 +28,7 @@ module Docs end def additional_entries - return [] unless subpath.start_with?('api') + return [] unless subpath.start_with?('api') entries = [ ['Component Binding Helpers', 'component-binding-helpers', 'API Reference'], @@ -36,7 +36,7 @@ module Docs ] css('h3').each do |node| - entryName = node.content.strip + entry_name = node.content.strip # Get the previous h2 title title = node @@ -44,25 +44,26 @@ module Docs title = title.content.strip title.remove! '# ' - entryName.remove! '# ' + entry_name.remove! '# ' - unless entryName.start_with?('router.') - if title == "Vuex.Store Constructor Options" - entryName = "StoreOptions.#{entryName}" - elsif title == "Vuex.Store Instance Properties" - entryName = "Vuex.Store.#{entryName}" - elsif title == "Vuex.Store Instance Methods" - entryName = "Vuex.Store.#{entryName}()" - elsif title == "Component Binding Helpers" - entryName = "#{entryName}()" + unless entry_name.start_with?('router.') + case title + when "Vuex.Store Constructor Options" + entry_name = "StoreOptions.#{entry_name}" + when "Vuex.Store Instance Properties" + entry_name = "Vuex.Store.#{entry_name}" + when "Vuex.Store Instance Methods" + entry_name = "Vuex.Store.#{entry_name}()" + when "Component Binding Helpers" + entry_name = "#{entry_name}()" end end - entries << [entryName, node['id'], 'API Reference'] + entries << [entry_name, node['id'], 'API Reference'] end entries end end end -end \ No newline at end of file +end diff --git a/lib/docs/scrapers/vuex.rb b/lib/docs/scrapers/vuex.rb index 774e989f..57e761ce 100644 --- a/lib/docs/scrapers/vuex.rb +++ b/lib/docs/scrapers/vuex.rb @@ -1,8 +1,8 @@ module Docs class Vuex < UrlScraper - self.name = 'Vuex' self.type = 'simple' - + self.release = '3.1.1' + self.base_url = 'https://vuex.vuejs.org/' self.links = { home: 'https://vuex.vuejs.org', code: 'https://github.com/vuejs/vuex' @@ -10,17 +10,18 @@ module Docs html_filters.push 'vuex/entries', 'vuex/clean_html' - self.release = '3.0.1' - self.base_url = 'https://vuex.vuejs.org/' - options[:skip_patterns] = [ # Other languages /^(zh|ja|ru|kr|fr|ptbr)\//, ] options[:attribution] = <<-HTML - © 2015–2018 Evan You, Vue.js contributors
+ © 2015–present Evan You
Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('vuex', opts) + end end end diff --git a/public/icons/docs/vuex/SOURCE b/public/icons/docs/vuex/SOURCE index 97bd9e03..6999e8c5 100644 --- a/public/icons/docs/vuex/SOURCE +++ b/public/icons/docs/vuex/SOURCE @@ -1 +1 @@ -http://vuejs.org/ +https://github.com/vuejs/vuejs.org/blob/master/assets/logo.ai