cypress: finish scraper and filters

Jasper van Merle committed 7 years ago

Commit 11234ec1 parent f1887bc4 files · +36 −25Browse files

Unified · Split

4 files

assets/javascripts/templates/pages/about_tmpl.coffee +6 −0
lib/docs/filters/cypress/clean_html.rb +12 −3
lib/docs/filters/cypress/entries.rb +0 −7
lib/docs/scrapers/cypress.rb +18 −15

assets/javascripts/templates/pages/about_tmpl.coffee+6−0

     'Apache',
     'https://raw.githubusercontent.com/crystal-lang/crystal/master/LICENSE'
   ], [
+    'Cypress',
+    '2017 Cypress.io',
+    'MIT',
+    'https://raw.githubusercontent.com/cypress-io/cypress-documentation/develop/LICENSE.md'
+  ],
+  [
     'D',
     '1999-2018 The D Language Foundation',
     'Boost',

lib/docs/filters/cypress/clean_html.rb+12−3

   class Cypress
     class CleanHtmlFilter < Filter
       def call
+        article_div = at_css('#article > div')
+        @doc = article_div unless article_div.nil?
+        header = at_css('h1.article-title')
+        doc.prepend_child(header) unless header.nil?
         css('.article-edit-link').remove
-        css('#sidebar').remove
+        css('.article-footer').remove
-        css('article footer').remove
-        css('#article-toc').remove
         css('.article-footer-updated').remove
+        css('pre').each do |node|
+          node.content = node.content
+          node['data-language'] = 'javascript'
+        end
         doc
       end
     end

lib/docs/filters/cypress/entries.rb+0−7

         core-concepts
         cypress-api
         events
-        examples
         getting-started
         guides
         overview
           end
         end
       end
-      def additional_entries
-        css('.sidebar-li > a').map do |node|
-          [node['href']]
-        end
-      end
     end
   end
 end

lib/docs/scrapers/cypress.rb+18−15

@@ -2,32 +2,35 @@ · 1 unmodified line
2		2
3	module Docs	3	module Docs
4	class Cypress < UrlScraper	4	class Cypress < UrlScraper
5	# Follow the instructions on https://github.com/cypress-io/cypress-documentation/blob/develop/CONTRIBUTING.md
6	# to run the cypress documentation server locally in the following URL:
7	# self.base_url = 'http://localhost:2222'
8	self.base_url = 'https://docs.cypress.io'
9
10	self.name = 'Cypress'	5	self.name = 'Cypress'
11	self.type = 'cypress'	6	self.type = 'cypress'
		7	self.release = '3.4.1'
		8	self.base_url = 'https://docs.cypress.io'
12	self.root_path = '/api/api/table-of-contents.html'	9	self.root_path = '/api/api/table-of-contents.html'
		10	self.links = {
		11	home: 'https://www.cypress.io/',
		12	code: 'https://github.com/cypress-io/cypress',
		13	}
13		14
14	html_filters.push 'cypress/clean_html', 'cypress/entries'	15	html_filters.push 'cypress/entries', 'cypress/clean_html'
15		16
16	options[:root_title] = 'Cypress'
17	options[:container] = '#content'	17	options[:container] = '#content'
18		18	options[:max_image_size] = 300_000
19	options[:include_default_entry] = true	19	options[:include_default_entry] = true
20		20
21	options[:skip_link] = lambda do \|link\|	21	options[:skip_patterns] = [/examples\//]
		22	options[:skip_link] = ->(link) {
22	href = link.attr(:href)	23	href = link.attr(:href)
23		24	href.nil? ? true : EntriesFilter::SECTIONS.none? { \|section\| href.match?("/#{section}/") }
24	EntriesFilter::SECTIONS.none? { \|section\| href.match?("/#{section}/") }	25	}
25	end
26		26
27	options[:attribution] = <<-HTML	27	options[:attribution] = <<-HTML
28	© 2018 <a href="https://cypress.io">Cypress.io</a>	28	© 2017 Cypress.io<br>
29	- Licensed under the	29	Licensed under the MIT License.
30	<a href="https://github.com/cypress-io/cypress-documentation/blob/develop/LICENSE.md">MIT License</a>.
31	HTML	30	HTML
		31
		32	def get_latest_version(opts)
		33	get_latest_github_release('cypress-io', 'cypress', opts)
		34	end
32	end	35	end
33	end	36	end