10 | Edit this page on MDN 11 |
12 |Test
') 10 | assert_equal 'Test
', filter_output 11 | end 12 | 13 | it "returns a valid string" do 14 | invalid_string = "\x92" 15 | @body = Nokogiri::HTML.parse(invalid_string) 16 | assert filter_output.valid_encoding? 17 | end 18 | end 19 | -------------------------------------------------------------------------------- /lib/docs/filters/bower/clean_html.rb: -------------------------------------------------------------------------------- 1 | module Docs 2 | class Bower 3 | class CleanHtmlFilter < Filter 4 | def call 5 | title = at_css('.page-title, .main h1') 6 | @doc = at_css('.main') 7 | doc.child.before(title) 8 | 9 | css('.site-footer').remove 10 | 11 | css('.highlight').each do |node| 12 | node.name = 'pre' 13 | node['data-language'] = node.at_css('[data-lang]')['data-lang'] 14 | node.content = node.content 15 | end 16 | 17 | doc 18 | end 19 | end 20 | end 21 | end 22 | -------------------------------------------------------------------------------- /lib/docs/filters/erlang/pre_clean_html.rb: -------------------------------------------------------------------------------- 1 | module Docs 2 | class Erlang 3 | class PreCleanHtmlFilter < Filter 4 | def call 5 | css('.flipMenu li[title] > a').remove unless subpath.start_with?('erts') # perf 6 | 7 | css('.REFTYPES').each do |node| 8 | node.name = 'pre' 9 | end 10 | 11 | css('span.bold_code', 'span.code').each do |node| 12 | node.name = 'code' 13 | node.inner_html = node.inner_html.strip.gsub(/\s+/, ' ') 14 | end 15 | 16 | doc 17 | end 18 | end 19 | end 20 | end 21 | -------------------------------------------------------------------------------- /lib/docs/scrapers/rdoc/rdoc.rb: -------------------------------------------------------------------------------- 1 | module Docs 2 | class Rdoc < FileScraper 3 | self.abstract = true 4 | self.type = 'rdoc' 5 | self.root_path = 'table_of_contents.html' 6 | 7 | html_filters.replace 'container', 'rdoc/container' 8 | html_filters.push 'rdoc/entries', 'rdoc/clean_html', 'title' 9 | 10 | options[:title] = false 11 | options[:skip] = %w(index.html) 12 | options[:skip_patterns] = [ 13 | /history/i, 14 | /rakefile/i, 15 | /changelog/i, 16 | /readme/i, 17 | /news/i, 18 | /license/i] 19 | end 20 | end 21 | -------------------------------------------------------------------------------- /assets/stylesheets/pages/_socketio.scss: -------------------------------------------------------------------------------- 1 | ._socketio { 2 | > h2 { @extend %block-heading; } 3 | > h3 { @extend %block-label, %label-blue; } 4 | > h2, > h3 { clear: both; } 5 | h4 { font-size: 1em; } 6 | 7 | .ezcol-one-half { 8 | margin: .5em 0 1.5em; 9 | float: left; 10 | width: 50%; 11 | padding-right: .5em; 12 | @extend %border-box; 13 | 14 | &.ezcol-last { 15 | float: right; 16 | padding: 0 0 0 .5em; 17 | } 18 | 19 | > h4 { margin: 0 0 1em; } 20 | > pre { margin: 1em 0 0; } 21 | } 22 | 23 | code { @extend %label; } 24 | } 25 | -------------------------------------------------------------------------------- /lib/docs/filters/phpunit/entries.rb: -------------------------------------------------------------------------------- 1 | module Docs 2 | class Phpunit 3 | class EntriesFilter < Docs::EntriesFilter 4 | def get_name 5 | at_css('h1').content 6 | end 7 | 8 | def get_type 9 | if name.in?(%w(Assertions Annotations)) 10 | name 11 | else 12 | 'Guides' 13 | end 14 | end 15 | 16 | def additional_entries 17 | return [] if type == 'Guides' 18 | 19 | css('h2').map do |node| 20 | [node.content, node['id']] 21 | end 22 | end 23 | end 24 | end 25 | end 26 | -------------------------------------------------------------------------------- /assets/javascripts/views/pages/rdoc.coffee: -------------------------------------------------------------------------------- 1 | #= require views/pages/base 2 | 3 | class app.views.RdocPage extends app.views.BasePage 4 | @events: 5 | click: 'onClick' 6 | 7 | onClick: (event) -> 8 | return unless event.target.classList.contains 'method-click-advice' 9 | $.stopEvent(event) 10 | 11 | source = $ '.method-source-code', event.target.parentNode.parentNode 12 | isShown = source.style.display is 'block' 13 | 14 | source.style.display = if isShown then 'none' else 'block' 15 | event.target.textContent = if isShown then 'Show source' else 'Hide source' 16 | -------------------------------------------------------------------------------- /lib/docs/filters/lodash/entries.rb: -------------------------------------------------------------------------------- 1 | module Docs 2 | class Lodash 3 | class EntriesFilter < Docs::EntriesFilter 4 | def additional_entries 5 | entries = [] 6 | 7 | css('.toc-container h2').each do |heading| 8 | type = heading.content.split.first 9 | 10 | heading.parent.css('a').each do |link| 11 | name = link.content 12 | name.remove! %r{\s.*} 13 | entries << [name, link['href'].remove('#'), type] 14 | end 15 | end 16 | 17 | entries 18 | end 19 | end 20 | end 21 | end 22 | -------------------------------------------------------------------------------- /assets/javascripts/app/config.coffee.erb: -------------------------------------------------------------------------------- 1 | app.config = 2 | db_filename: 'db.json' 3 | default_docs: <%= App.default_docs.to_json %> 4 | docs_origin: '<%= App.docs_origin %>' 5 | env: '<%= App.environment %>' 6 | history_cache_size: 10 7 | index_filename: 'index.json' 8 | index_path: '/<%= App.docs_prefix %>' 9 | max_results: 50 10 | production_host: 'devdocs.io' 11 | search_param: 'q' 12 | sentry_dsn: '<%= App.sentry_dsn %>' 13 | version: <%= Time.now.to_i %> 14 | release: <%= Time.now.utc.httpdate.to_json %> 15 | mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css' 16 | -------------------------------------------------------------------------------- /assets/javascripts/collections/types.coffee: -------------------------------------------------------------------------------- 1 | class app.collections.Types extends app.Collection 2 | @model: 'Type' 3 | 4 | groups: -> 5 | result = [] 6 | for type in @models 7 | (result[@_groupFor(type)] ||= []).push(type) 8 | result.filter (e) -> e.length > 0 9 | 10 | GUIDES_RGX = /(^|\()(guides?|tutorials?|reference|book|getting\ started|manual|examples)($|[\):])/i 11 | APPENDIX_RGX = /appendix/i 12 | 13 | _groupFor: (type) -> 14 | if GUIDES_RGX.test(type.name) 15 | 0 16 | else if APPENDIX_RGX.test(type.name) 17 | 2 18 | else 19 | 1 20 | -------------------------------------------------------------------------------- /assets/stylesheets/pages/_crystal.scss: -------------------------------------------------------------------------------- 1 | ._crystal { 2 | @extend %simple; 3 | 4 | .signature { @extend %code; } 5 | a.signature, .superclass > a { @extend %label; } 6 | 7 | .entry-detail { margin-top: 1em; } 8 | .view-source { float: right; } 9 | 10 | .superclass-hierarchy { 11 | list-style: none; 12 | padding: 0; 13 | overflow: hidden; 14 | } 15 | 16 | li.superclass { 17 | float: left; 18 | margin: 0 .5em 0 0; 19 | padding: 0; 20 | } 21 | 22 | li.superclass + li.superclass:before { 23 | content: '<'; 24 | margin-right: .5em; 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /lib/docs/core/instrumentable.rb: -------------------------------------------------------------------------------- 1 | require 'active_support/notifications' 2 | 3 | module Docs 4 | module Instrumentable 5 | def self.extended(base) 6 | base.send :extend, Methods 7 | end 8 | 9 | def self.included(base) 10 | base.send :include, Methods 11 | end 12 | 13 | module Methods 14 | def instrument(*args, &block) 15 | ActiveSupport::Notifications.instrument(*args, &block) 16 | end 17 | 18 | def subscribe(*args, &block) 19 | ActiveSupport::Notifications.subscribe(*args, &block) 20 | end 21 | end 22 | end 23 | end 24 | -------------------------------------------------------------------------------- /assets/javascripts/templates/notice_tmpl.coffee: -------------------------------------------------------------------------------- 1 | notice = (text) -> """#{text}
""" 2 | 3 | app.templates.singleDocNotice = (doc) -> 4 | notice """ You're browsing the #{doc.fullName} documentation. To browse all docs, go to 5 | #{app.config.production_host} (or pressesc). """
6 |
7 | app.templates.disabledDocNotice = ->
8 | notice """ This documentation is disabled.
9 | To enable it, go to Preferences. """
10 |
--------------------------------------------------------------------------------
/lib/docs/filters/async/entries.rb:
--------------------------------------------------------------------------------
1 | module Docs
2 | class Async
3 | class EntriesFilter < Docs::EntriesFilter
4 | def additional_entries
5 | type = nil
6 | entries = []
7 |
8 | css('.nav.methods li').each do |node|
9 | if node['class'] == 'toc-header'
10 | type = node.content
11 | else
12 | name = node.content
13 | id = node.at_css('a')['href'].remove('#')
14 | entries << [name, id, type]
15 | end
16 | end
17 |
18 | entries
19 | end
20 | end
21 | end
22 | end
23 |
--------------------------------------------------------------------------------
/lib/docs/scrapers/modernizr.rb:
--------------------------------------------------------------------------------
1 | module Docs
2 | class Modernizr < UrlScraper
3 | self.name = 'Modernizr'
4 | self.type = 'modernizr'
5 | self.release = '3.5.0'
6 | self.base_url = 'https://modernizr.com/docs/'
7 |
8 | html_filters.push 'modernizr/entries', 'modernizr/clean_html', 'title'
9 |
10 | options[:title] = 'Modernizr'
11 | options[:container] = '#main'
12 | options[:skip_links] = true
13 |
14 | options[:attribution] = <<-HTML
15 | © 2009–2017 The Modernizr team3 | ProTip 4 | (click to dismiss) 5 |
6 | Hit ↓ ↑ ← → to navigate the sidebar.
7 | Hit space / shift space, alt ↓/↑ or shift ↓/↑ to scroll the page.
8 |
9 | See all keyboard shortcuts
10 | """
11 |
--------------------------------------------------------------------------------
/assets/stylesheets/pages/_postgres.scss:
--------------------------------------------------------------------------------
1 | ._postgres {
2 | padding-left: 1rem;
3 |
4 | h1, h1 ~ p, h1 ~ pre, h1 ~ blockquote, h2, .NAVFOOTER { margin-left: -1rem; }
5 | h2 { @extend %block-heading; }
6 |
7 | .VARIABLELIST dt { @extend %block-label, %label-blue; }
8 |
9 | blockquote.NOTE, blockquote.IMPORTANT, blockquote.TIP, blockquote.CAUTION { @extend %note; }
10 | blockquote.TIP { @extend %note-green; }
11 | blockquote.CAUTION { @extend %note-orange; }
12 |
13 | p > code { @extend %label; }
14 | p.c2 { font-weight: $boldFontWeight; }
15 |
16 | .NAVFOOTER > table { width: 100%; }
17 | td[align=center] { text-align: center; }
18 | td[align=right] { text-align: right; }
19 | }
20 |
--------------------------------------------------------------------------------
/lib/docs/scrapers/vagrant.rb:
--------------------------------------------------------------------------------
1 | module Docs
2 | class Vagrant < UrlScraper
3 | self.name = 'Vagrant'
4 | self.type = 'vagrant'
5 | self.release = '2.0.0'
6 | self.base_url = 'https://www.vagrantup.com/docs/'
7 | self.root_path = 'index.html'
8 | self.links = {
9 | home: 'https://www.vagrantup.com/',
10 | code: 'https://github.com/mitchellh/vagrant'
11 | }
12 |
13 | html_filters.push 'vagrant/entries', 'vagrant/clean_html'
14 |
15 | options[:skip_patterns] = [/vagrant-cloud/]
16 |
17 | options[:attribution] = <<-HTML
18 | © 2010–2017 Mitchell Hashimoto
19 | Licensed under the MPL 2.0 License.
20 | HTML
21 | end
22 | end
23 |
--------------------------------------------------------------------------------
/lib/docs/scrapers/q.rb:
--------------------------------------------------------------------------------
1 | module Docs
2 | class Q < Github
3 | self.name = 'Q'
4 | self.release = '1.5.0'
5 | self.base_url = 'https://github.com/kriskowal/q/wiki/'
6 | self.root_path = 'API-Reference'
7 | self.links = {
8 | home: 'http://documentup.com/kriskowal/q/',
9 | code: 'https://github.com/kriskowal/q'
10 | }
11 |
12 | html_filters.push 'q/entries', 'title'
13 |
14 | options[:container] = '.markdown-body'
15 | options[:title] = 'Q'
16 | options[:skip_links] = true
17 |
18 | options[:attribution] = <<-HTML
19 | © 2009–2017 Kristopher Michael Kowal
20 | Licensed under the MIT License.
21 | HTML
22 | end
23 | end
24 |
--------------------------------------------------------------------------------
/lib/docs/scrapers/underscore.rb:
--------------------------------------------------------------------------------
1 | module Docs
2 | class Underscore < UrlScraper
3 | self.name = 'Underscore.js'
4 | self.slug = 'underscore'
5 | self.type = 'underscore'
6 | self.release = '1.8.3'
7 | self.base_url = 'http://underscorejs.org'
8 |
9 | html_filters.push 'underscore/clean_html', 'underscore/entries', 'title'
10 |
11 | options[:title] = 'Underscore.js'
12 | options[:container] = '#documentation'
13 | options[:skip_links] = true
14 |
15 | options[:attribution] = <<-HTML
16 | © 2009–2015 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
17 | Licensed under the MIT License.
18 | HTML
19 | end
20 | end
21 |
--------------------------------------------------------------------------------
/lib/docs/scrapers/mocha.rb:
--------------------------------------------------------------------------------
1 | module Docs
2 | class Mocha < UrlScraper
3 | self.type = 'mocha'
4 | self.release = '3.5.0'
5 | self.base_url = 'https://mochajs.org/'
6 | self.links = {
7 | home: 'https://mochajs.org/',
8 | code: 'https://github.com/mochajs/mocha'
9 | }
10 |
11 | html_filters.push 'mocha/clean_html', 'mocha/entries', 'title'
12 |
13 | options[:container] = '#content'
14 | options[:title] = 'mocha'
15 | options[:skip_links] = true
16 |
17 | options[:attribution] = <<-HTML
18 | © 2016 JS Foundation and contributors
19 | Licensed under the Creative Commons Attribution 4.0 International License.
20 | HTML
21 | end
22 | end
23 |
--------------------------------------------------------------------------------
/assets/javascripts/application.js.coffee:
--------------------------------------------------------------------------------
1 | #= require_tree ./vendor
2 |
3 | #= require lib/license
4 | #= require_tree ./lib
5 |
6 | #= require app/app
7 | #= require app/config
8 | #= require_tree ./app
9 |
10 | #= require collections/collection
11 | #= require_tree ./collections
12 |
13 | #= require models/model
14 | #= require_tree ./models
15 |
16 | #= require views/view
17 | #= require_tree ./views
18 |
19 | #= require_tree ./templates
20 |
21 | #= require tracking
22 |
23 | init = ->
24 | document.removeEventListener 'DOMContentLoaded', init, false
25 |
26 | if document.body
27 | app.init()
28 | else
29 | setTimeout(init, 42)
30 |
31 | document.addEventListener 'DOMContentLoaded', init, false
32 |
--------------------------------------------------------------------------------
/lib/docs/core/parser.rb:
--------------------------------------------------------------------------------
1 | module Docs
2 | class Parser
3 | attr_reader :title, :html
4 |
5 | def initialize(content)
6 | @content = content
7 | @html = document? ? parse_as_document : parse_as_fragment
8 | end
9 |
10 | private
11 |
12 | DOCUMENT_RGX = /\A(?:\s|(?:))*<(?:\!doctype|html)/i
13 |
14 | def document?
15 | @content =~ DOCUMENT_RGX
16 | end
17 |
18 | def parse_as_document
19 | document = Nokogiri::HTML.parse @content, nil, 'UTF-8'
20 | @title = document.at_css('title').try(:content)
21 | document
22 | end
23 |
24 | def parse_as_fragment
25 | Nokogiri::HTML.fragment @content, 'UTF-8'
26 | end
27 | end
28 | end
29 |
--------------------------------------------------------------------------------
/lib/docs/filters/pug/entries.rb:
--------------------------------------------------------------------------------
1 | module Docs
2 | class Pug
3 | class EntriesFilter < Docs::EntriesFilter
4 | def get_name
5 | at_css('h1').content
6 | end
7 |
8 | def get_type
9 | if subpath.start_with?('language')
10 | 'Language'
11 | elsif subpath.start_with?('api')
12 | 'API'
13 | end
14 | end
15 |
16 | def additional_entries
17 | return [] unless slug == 'api/reference'
18 |
19 | css('h3').each_with_object [] do |node, entries|
20 | name = node.content
21 | name.sub! %r{\(.*\)}, '()'
22 | entries << [name, node['id']]
23 | end
24 | end
25 | end
26 | end
27 | end
28 |
--------------------------------------------------------------------------------
/test/lib/docs/filters/core/clean_text_test.rb:
--------------------------------------------------------------------------------
1 | require 'test_helper'
2 | require 'docs'
3 |
4 | class CleanTextFilterTest < MiniTest::Spec
5 | include FilterTestHelper
6 | self.filter_class = Docs::CleanTextFilter
7 |
8 | it "removes empty nodes" do
9 | @body = "