krisyotam/devdocs

.editorconfig+3−0

@@ -6,3 +6,6 @@ indent_style = space · 5 unmodified lines
6	indent_size = 2	6	indent_size = 2
7	insert_final_newline = true	7	insert_final_newline = true
8	trim_trailing_whitespace = true	8	trim_trailing_whitespace = true
		9
		10	[*.md]
		11	trim_trailing_whitespace = false

.github/CONTRIBUTING.md+5−14

 ## Requesting new features
 1. Search for similar feature requests; someone may have already requested it.
-2. Make sure your feature fits DevDocs's [vision](https://github.com/freeCodeCamp/devdocs/blob/master/README.md#vision).
+2. Make sure your feature fits DevDocs's [vision](../README.md#vision).
 3. Provide a clear and detailed explanation of the feature and why it's important to add it.
-For general feedback and ideas, please use the [mailing list](https://groups.google.com/d/forum/devdocs).
 ## Requesting new documentations
 Please don't open issues to request new documentations.
 Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) where everyone can vote.
 ## Contributing code and features
 1. Search for existing issues; someone may already be working on a similar feature.
-2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something I may not want to merge. This also tells other contributors that you're working on the feature.
+2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something we may not want to merge. This also tells other contributors that you're working on the feature.
 3. Follow the [coding conventions](#coding-conventions).
 4. If you're modifying the Ruby code, include tests and ensure they pass.
 5. Try to keep your pull request small and simple.
 ## Contributing new documentations
-See the [wiki](https://github.com/freeCodeCamp/devdocs/wiki) to learn how to add new documentations.
+See the [`docs` folder](https://github.com/freeCodeCamp/devdocs/tree/master/docs) to learn how to add new documentations.
 **Important:** the documentation's license must permit alteration, redistribution and commercial use, and the documented software must be released under an open source license. Feel free to get in touch if you're not sure if a documentation meets those requirements.
 To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here).
-## Other contributions
-Besides new docs and features, here are other ways you can contribute:
-* **Improve our copy.** English isn't my first language so if you notice grammatical or usage errors, feel free to submit a pull request — it'll be much appreciated.
-* **Participate in the issue tracker.** Your opinion matters — feel free to add comments to existing issues. You're also welcome to participate to the [mailing list](https://groups.google.com/d/forum/devdocs).
 ## Coding conventions
 * two spaces; no tabs
 ## Questions?
-If you have any questions, please feel free to ask on the [mailing list](https://groups.google.com/d/forum/devdocs).
+If you have any questions, please feel free to ask them on the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs).

.github/ISSUE_TEMPLATE.md+1−1

@@ -1,6 +1,6 @@
1	<!--	1	<!--
2	Please read the contributing guidelines before opening an issue:	2	Please read the contributing guidelines before opening an issue:
3	https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md	3	https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md
4		4
5	To request a new documentation, or an update of an existing documentation, go here:	5	To request a new documentation, or an update of an existing documentation, go here:
6	https://trello.com/b/6BmTulfx/devdocs-documentation	6	https://trello.com/b/6BmTulfx/devdocs-documentation

.gitignore+3−4

@@ -1,10 +1,9 @@
1	.DS_Store	1	.DS_Store
2	.bundle	2	.bundle
3	*.pxm	3	log
4	*.sketch
5	tmp	4	tmp
6	public/assets	5	public/assets
7	public/fonts	6	public/fonts
8	public/docs/*/	7	public/docs/*/
9	!public/docs/docs.json	8	docs/*/
10	!public/docs/**/index.json	9	!docs/*.md

.ruby-version+1−1

@@ -1 +1 @@
1	2.5.1	1	2.6.0

.travis.yml+8−0

@@ -5,3 +5,11 @@ cache: bundler · 4 unmodified lines
5	before_script:	5	before_script:
6	- gem update --system	6	- gem update --system
7	- gem install bundler	7	- gem install bundler
		8
		9	deploy:
		10	provider: heroku
		11	app: devdocs
		12	on:
		13	branch: master
		14	api_key:
		15	secure: "4p1klvWJZSOImzFcKOduILjP93hlOlAhceWlYMKS4tU+TCFE8qTBzdKdFPSCsCgjB+YR9pBss+L0lJpVVMjSwFHXqpKe6EeUSltO2k7DFHfW7kXLUM/L0AfqXz+YXk76XUyZMhvOEbldPfaMaj10e8vgDOQCSHABDyK/4CU+hnI="

CODE_OF_CONDUCT.md+2−0

@@ -0,0 +1,2 @@
	1
	2	> Our Code of Conduct is available here: <https://code-of-conduct.freecodecamp.org/>

COPYRIGHT+4−4

@@ -1,13 +1,13 @@
1	Copyright 2013-2018 Thibaut Courouble and other contributors	1	Copyright 2013-2019 Thibaut Courouble and other contributors
2		2
3	This Source Code Form is subject to the terms of the Mozilla Public	3	This Source Code Form is subject to the terms of the Mozilla Public
4	License, v. 2.0. If a copy of the MPL was not distributed with this	4	License, v. 2.0. If a copy of the MPL was not distributed with this
5	file, You can obtain one at http://mozilla.org/MPL/2.0/.	5	file, You can obtain one at http://mozilla.org/MPL/2.0/.
6		6
7	Please do not use the name DevDocs to endorse or promote products	7	Please do not use the name DevDocs to endorse or promote products
8	derived from this software without my permission, except as may be	8	derived from this software without the maintainers' permission, except
9	necessary to comply with the notice/attribution requirements.	9	as may be necessary to comply with the notice/attribution requirements.
10		10
11	I also wish that any documentation file generated using this software	11	We also wish that any documentation file generated using this software
12	be attributed to DevDocs. Let's be fair to all contributors by giving	12	be attributed to DevDocs. Let's be fair to all contributors by giving
13	credit where credit's due. Thanks.	13	credit where credit's due. Thanks.

Dockerfile+2−1

@@ -1,6 +1,7 @@
1	FROM ruby:2.5.1	1	FROM ruby:2.6.0
2		2
3	ENV LANG=C.UTF-8	3	ENV LANG=C.UTF-8
		4	ENV ENABLE_SERVICE_WORKER=true
4		5
5	WORKDIR /devdocs	6	WORKDIR /devdocs
6		7

Dockerfile-alpine+2−1

@@ -1,6 +1,7 @@
1	FROM ruby:2.5.1-alpine	1	FROM ruby:2.6.0-alpine
2		2
3	ENV LANG=C.UTF-8	3	ENV LANG=C.UTF-8
		4	ENV ENABLE_SERVICE_WORKER=true
4		5
5	WORKDIR /devdocs	6	WORKDIR /devdocs
6		7

Gemfile+3−2

 source 'https://rubygems.org'
-ruby '2.5.1'
+ruby '2.6.0'
 gem 'rake'
 gem 'thor'
-gem 'pry', '~> 0.11.0'
+gem 'pry', '~> 0.12.0'
 gem 'activesupport', '~> 5.2', require: false
 gem 'yajl-ruby', require: false
 gem 'html-pipeline'
   gem 'progress_bar', require: false
   gem 'unix_utils', require: false
   gem 'tty-pager', require: false
+  gem 'net-sftp', '>= 2.1.3.rc2', require: false
 end
 group :test do

Gemfile.lock+47−44

 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
+    activesupport (5.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       coffee-script-source
       execjs
     coffee-script-source (1.12.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
-    daemons (1.2.6)
+    daemons (1.3.1)
-    erubi (1.7.1)
+    erubi (1.8.0)
-    ethon (0.11.0)
+    ethon (0.12.0)
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
     execjs (2.7.0)
-    exifr (1.3.4)
+    exifr (1.3.5)
-    ffi (1.9.25)
+    ffi (1.10.0)
     fspath (3.1.0)
     highline (2.0.0)
-    html-pipeline (2.8.4)
+    html-pipeline (2.10.0)
       activesupport (>= 2)
       nokogiri (>= 1.4)
-    i18n (1.1.0)
+    i18n (1.5.2)
       concurrent-ruby (~> 1.0)
-    image_optim (0.26.2)
+    image_optim (0.26.3)
       exifr (~> 1.2, >= 1.2.2)
       fspath (~> 3.0)
       image_size (>= 1.5, < 3)
       in_threads (~> 1.3)
       progress (~> 3.0, >= 3.0.1)
-    image_optim_pack (0.5.1)
+    image_optim_pack (0.5.1.20190105)
       fspath (>= 2.1, < 4)
       image_optim (~> 0.19)
     image_size (2.0.0)
-    in_threads (1.5.0)
+    in_threads (1.5.1)
-    method_source (0.9.0)
+    method_source (0.9.2)
-    mini_portile2 (2.3.0)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
     multi_json (1.13.1)
     mustermann (1.0.3)
-    newrelic_rpm (5.4.0.347)
+    net-sftp (3.0.0.beta1)
-    nokogiri (1.8.4)
+      net-ssh (>= 5.0.0, < 6.0.0)
-      mini_portile2 (~> 2.3.0)
+    net-ssh (5.1.0)
+    newrelic_rpm (5.7.0.350)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
     options (2.3.2)
-    progress (3.4.0)
+    progress (3.5.0)
     progress_bar (1.3.0)
       highline (>= 1.6, < 3)
       options (~> 2.3.0)
-    pry (0.11.3)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.0.5)
+    rack (2.0.6)
-    rack-protection (2.0.4)
+    rack-protection (2.0.5)
       rack
     rack-ssl-enforcer (0.2.9)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rake (12.3.1)
+    rake (12.3.2)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
+    rb-inotify (0.10.0)
-      ffi (>= 0.5.0, < 2)
+      ffi (~> 1.0)
     rr (1.2.1)
-    sass (3.6.0)
+    sass (3.7.3)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    sinatra (2.0.4)
+    sinatra (2.0.5)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.4)
+      rack-protection (= 2.0.5)
       tilt (~> 2.0)
-    sinatra-contrib (2.0.4)
+    sinatra-contrib (2.0.5)
-      activesupport (>= 4.0.0)
       backports (>= 2.8.2)
       multi_json
       mustermann (~> 1.0)
-      rack-protection (= 2.0.4)
+      rack-protection (= 2.0.5)
-      sinatra (= 2.0.4)
+      sinatra (= 2.0.5)
       tilt (>= 1.3, < 3)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0, >= 1.0.4)
       rack (>= 1, < 3)
-    thor (0.20.0)
+    thor (0.20.3)
     thread_safe (0.3.6)
-    tilt (2.0.8)
+    tilt (2.0.9)
-    tty-pager (0.11.0)
+    tty-pager (0.12.0)
-      strings (~> 0.1.0)
+      strings (~> 0.1.4)
-      tty-screen (~> 0.6.4)
+      tty-screen (~> 0.6)
-      tty-which (~> 0.3.0)
+      tty-which (~> 0.4)
     tty-screen (0.6.5)
-    tty-which (0.3.0)
+    tty-which (0.4.0)
-    typhoeus (1.3.0)
+    typhoeus (1.3.1)
       ethon (>= 0.9.0)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    uglifier (4.1.19)
+    uglifier (4.1.20)
       execjs (>= 0.3.0, < 3)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.4.1)
     unicode_utils (1.4.0)
     unix_utils (0.0.15)
     yajl-ruby (1.4.1)
   image_optim
   image_optim_pack
   minitest
+  net-sftp (>= 2.1.3.rc2)
   newrelic_rpm
   nokogiri
   progress_bar
-  pry (~> 0.11.0)
+  pry (~> 0.12.0)
   rack
   rack-ssl-enforcer
   rack-test
   yajl-ruby
 RUBY VERSION
-   ruby 2.5.1p57
+   ruby 2.6.0p0
 BUNDLED WITH
-   1.16.1
+   1.17.2

PULL_REQUEST_TEMPLATE.md+11−0

@@ -0,0 +1,11 @@
	1	If you’re adding a new scraper, please ensure that you have:
	2
	3	- [ ] Tested the scraper on a local copy of DevDocs
	4	- [ ] Ensured that the docs are styled similarly to other docs on DevDocs
	5	<!-- If the docs don’t have an icon, delete the next four items: -->
	6	- [ ] Added these files to the <code>public/icons/your_scraper_name/</code> directory:
	7	- [ ] `16.png`: a 16×16 pixel icon for the doc
	8	- [ ] `16@2x.png`: a 32×32 pixel icon for the doc
	9	- [ ] `SOURCE`: A text file containing the URL to the page the image can be found on or the URL of the original image itself
	10
	11	<!-- Replace the `[ ]` with a `[x]` once you’ve completed each step. -->

README.md+45−20

-# [DevDocs](https://devdocs.io) [![Build Status](https://travis-ci.org/freeCodeCamp/devdocs.svg?branch=master)](https://travis-ci.org/freeCodeCamp/devdocs)
+# [DevDocs](https://devdocs.io) — API Documentation Browser [![Build Status](https://travis-ci.org/freeCodeCamp/devdocs.svg?branch=master)](https://travis-ci.org/freeCodeCamp/devdocs)
-DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
+DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
-* Created by [Thibaut Courouble](https://thibaut.me)
+DevDocs was created by [Thibaut Courouble](https://thibaut.me) and is operated by [freeCodeCamp](https://www.freecodecamp.org).
 Keep track of development news:
 * Join the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs)
 * Watch the repository on [GitHub](https://github.com/freeCodeCamp/devdocs/subscription)
 * Follow [@DevDocs](https://twitter.com/DevDocs) on Twitter
-* Join the [mailing list](https://groups.google.com/d/forum/devdocs)
-**Table of Contents:** [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [License](#copyright--license) · [Questions?](#questions)
+**Table of Contents:** [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [Documentation](#documentation) · [Plugins and Extensions](#plugins-and-extensions) · [License](#copyright--license) · [Questions?](#questions)
 ## Quick Start
-Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box.
+Unless you wish to contribute to the project, we recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box.
 DevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.
-DevDocs requires Ruby 2.5.1, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
+DevDocs requires Ruby 2.6.0, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
 ```
 git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
 Many of the code's design decisions were driven by the fact that the app uses XHR to load content directly into the main frame. This includes stripping the original documents of most of their HTML markup (e.g. scripts and stylesheets) to avoid polluting the main frame, and prefixing all CSS class names with an underscore to prevent conflicts.
-Another driving factor is performance and the fact that everything happens in the browser. `applicationCache` (which comes with its own set of constraints) and `localStorage` are used to speed up the boot time, while memory consumption is kept in check by allowing the user to pick his/her own set of documentations. The search algorithm is kept simple because it needs to be fast even searching through 100,000 strings.
+Another driving factor is performance and the fact that everything happens in the browser. A service worker (which comes with its own set of constraints) and `localStorage` are used to speed up the boot time, while memory consumption is kept in check by allowing the user to pick his/her own set of documentations. The search algorithm is kept simple because it needs to be fast even searching through 100,000 strings.
 DevDocs being a developer tool, the browser requirements are high:
 * Recent versions of Firefox, Chrome, or Opera
-* Safari 9.1+
+* Safari 11.1+
-* Edge 16+
+* Edge 17+
-* iOS 10+
+* iOS 11.3+
 This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun!
 * replacing all external (not scraped) URLs with their fully qualified counterpart
 * replacing all internal (scraped) URLs with their unqualified and relative counterpart
 * adding content, such as a title and link to the original document
+* ensuring correct syntax highlighting using [Prism](http://prismjs.com/)
 These modifications are applied via a set of filters using the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. Each scraper includes filters specific to itself, one of which is tasked with figuring out the pages' metadata.
 The end result is a set of normalized HTML partials and two JSON files (index + offline data). Because the index files are loaded separately by the [app](#app) following the user's preferences, the scraper also creates a JSON manifest file containing information about the documentations currently available on the system (such as their name, version, update date, etc.).
-More information about scrapers and filters is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki).
+More information about [scrapers](./docs/scraper-reference.md) and [filters](./docs/filter-reference.md) is available in the `docs` folder.
 ## Available Commands
 ## Contributing
-Contributions are welcome. Please read the [contributing guidelines](https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md).
+Contributions are welcome. Please read the [contributing guidelines](./.github/CONTRIBUTING.md).
-DevDocs's own documentation is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki).
+## Documentation
+* [Adding documentations to DevDocs](./docs/adding-docs.md)
+* [Scraper Reference](./docs/scraper-reference.md)
+* [Filter Reference](./docs/filter-reference.md)
+* [Maintainers’ Guide](./docs/maintainers.md)
+## Plugins and Extensions
+* [Chrome web app](https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe)
+* [Ubuntu Touch app](https://uappexplorer.com/app/devdocsunofficial.berkes)
+* [Sublime Text plugin](https://sublime.wbond.net/packages/DevDocs)
+* [Atom plugin](https://atom.io/packages/devdocs)
+* [Brackets extension](https://github.com/gruehle/dev-docs-viewer)
+* [Fluid](http://fluidapp.com) for turning DevDocs into a real OS X app
+* [GTK shell / Vim integration](https://github.com/naquad/devdocs-shell)
+* [Emacs lookup](https://github.com/skeeto/devdocs-lookup)
+* [Alfred Workflow](https://github.com/yannickglt/alfred-devdocs)
+* [Vim search plugin with Devdocs in its defaults](https://github.com/waiting-for-dev/vim-www) Just set `let g:www_shortcut_engines = { 'devdocs': ['Devdocs', '<leader>dd'] }` to have a `:Devdocs` command and a `<leader>dd` mapping.
+* [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=akfish.vscode-devdocs ) (1)
+* [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=deibit.devdocs) (2)
+* [Desktop application](https://github.com/egoist/devdocs-desktop)
+* [Doc Browser](https://github.com/qwfy/doc-browser) is a native Linux app that supports DevDocs docsets
+* [GNOME Application](https://github.com/hardpixel/devdocs-desktop) GTK3 application with search integrated in headerbar
+* [macOS Application](https://github.com/dteoh/devdocs-macos)
+* [Android Application](https://github.com/Merith-TK/devdocs_webapp_kotlin) is a fully working, advanced WebView
 ## Copyright / License
-Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors)
+Copyright 2013-2019 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors)
-This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT) and [LICENSE](https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE) files.
+This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](./COPYRIGHT) and [LICENSE](./LICENSE) files.
-Please do not use the name DevDocs to endorse or promote products derived from this software without my permission, except as may be necessary to comply with the notice/attribution requirements.
+Please do not use the name DevDocs to endorse or promote products derived from this software without the maintainers' permission, except as may be necessary to comply with the notice/attribution requirements.
-I also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks!
+We also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks!
 ## Questions?
-If you have any questions, please feel free to ask them on the [mailing list](https://groups.google.com/d/forum/devdocs).
+If you have any questions, please feel free to ask them on the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs).

assets/javascripts/app/app.coffee+10−8

     @el = $('._app')
     @localStorage = new LocalStorageStore
-    @appCache = new app.AppCache if app.AppCache.isEnabled()
+    @serviceWorker = new app.ServiceWorker if app.ServiceWorker.isEnabled()
     @settings = new app.Settings
     @db = new app.DB()
+    @settings.initLayout()
     @docs = new app.collections.Docs
     @disabledDocs = new app.collections.Docs
     @entries = new app.collections.Entries
   saveDocs: ->
     @settings.setDocs(doc.slug for doc in @docs.all())
     @db.migrate()
-    @appCache?.updateInBackground()
+    @serviceWorker?.updateInBackground()
   welcomeBack: ->
     visitCount = @settings.get('count')
     @updateChecker = new app.UpdateChecker()
   reboot: ->
-    if location.pathname isnt '/'
+    if location.pathname isnt '/' and location.pathname isnt '/settings'
       window.location = "/##{location.pathname}"
     else
       window.location = '/'
   reload: ->
     @docs.clearCache()
     @disabledDocs.clearCache()
-    if @appCache then @appCache.reload() else @reboot()
+    if @serviceWorker then @serviceWorker.reload() else @reboot()
     return
   reset: ->
     @localStorage.reset()
     @settings.reset()
     @db?.reset()
-    @appCache?.update()
+    @serviceWorker?.update()
     window.location = '/'
     return
     return
   indexHost: ->
-    # Can't load the index files from the host/CDN when applicationCache is
+    # Can't load the index files from the host/CDN when service worker is
     # enabled because it doesn't support caching URLs that use CORS.
-    @config[if @appCache and @settings.hasDocs() then 'index_path' else 'docs_origin']
+    @config[if @serviceWorker and @settings.hasDocs() then 'index_path' else 'docs_origin']
   onBootError: (args...) ->
     @trigger 'bootError'
         matchMedia:         !!window.matchMedia
         insertAdjacentHTML: !!document.body.insertAdjacentHTML
         defaultPrevented:     document.createEvent('CustomEvent').defaultPrevented is false
-        cssVariables:         CSS.supports and CSS.supports('(--t: 0)')
+        cssVariables:       !!CSS?.supports?('(--t: 0)')
       for key, value of features when not value
         Raven.captureMessage "unsupported/#{key}", level: 'info'

assets/javascripts/app/appcache.coffee+0−46

@@ -1,46 +0,0 @@
1	class app.AppCache
2	$.extend @prototype, Events
3
4	@isEnabled: ->
5	try
6	applicationCache and applicationCache.status isnt applicationCache.UNCACHED
7	catch
8
9	constructor: ->
10	@cache = applicationCache
11	@notifyUpdate = true
12	@onUpdateReady() if @cache.status is @cache.UPDATEREADY
13
14	$.on @cache, 'progress', @onProgress
15	$.on @cache, 'updateready', @onUpdateReady
16
17	update: ->
18	@notifyUpdate = true
19	@notifyProgress = true
20	try @cache.update() catch
21	return
22
23	updateInBackground: ->
24	@notifyUpdate = false
25	@notifyProgress = false
26	try @cache.update() catch
27	return
28
29	reload: ->
30	$.on @cache, 'updateready noupdate error', ->
31	if location.pathname isnt '/'
32	window.location = "/##{location.pathname}"
33	else
34	window.location = '/'
35	@notifyUpdate = false
36	@notifyProgress = true
37	try @cache.update() catch
38	return
39
40	onProgress: (event) =>
41	@trigger 'progress', event if @notifyProgress
42	return
43
44	onUpdateReady: =>
45	@trigger 'updateready' if @notifyUpdate
46	return

assets/javascripts/app/config.coffee.erb+2−0

@@ -13,3 +13,5 @@ app.config = · 12 unmodified lines
13	version: <%= Time.now.to_i %>	13	version: <%= Time.now.to_i %>
14	release: <%= Time.now.utc.httpdate.to_json %>	14	release: <%= Time.now.utc.httpdate.to_json %>
15	mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css'	15	mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css'
		16	service_worker_path: '/service-worker.js'
		17	service_worker_enabled: <%= App.environment == :production \|\| ENV['ENABLE_SERVICE_WORKER'] == 'true' %>

assets/javascripts/app/serviceworker.coffee+49−0

@@ -0,0 +1,49 @@
	1	class app.ServiceWorker
	2	$.extend @prototype, Events
	3
	4	@isEnabled: ->
	5	!!navigator.serviceWorker and app.config.service_worker_enabled
	6
	7	constructor: ->
	8	@registration = null
	9	@notifyUpdate = true
	10
	11	navigator.serviceWorker.register(app.config.service_worker_path, {scope: '/'})
	12	.then(
	13	(registration) => @updateRegistration(registration),
	14	(error) -> console.error('Could not register service worker:', error)
	15	)
	16
	17	update: ->
	18	return unless @registration
	19	@notifyUpdate = true
	20	return @registration.update().catch(->)
	21
	22	updateInBackground: ->
	23	return unless @registration
	24	@notifyUpdate = false
	25	return @registration.update().catch(->)
	26
	27	reload: ->
	28	return @updateInBackground().then(() -> app.reboot())
	29
	30	updateRegistration: (registration) ->
	31	@registration = registration
	32	$.on @registration, 'updatefound', @onUpdateFound
	33	return
	34
	35	onUpdateFound: =>
	36	$.off @installingRegistration, 'statechange', @onStateChange() if @installingRegistration
	37	@installingRegistration = @registration.installing
	38	$.on @installingRegistration, 'statechange', @onStateChange
	39	return
	40
	41	onStateChange: =>
	42	if @installingRegistration and @installingRegistration.state == 'installed' and navigator.serviceWorker.controller
	43	@installingRegistration = null
	44	@onUpdateReady()
	45	return
	46
	47	onUpdateReady: ->
	48	@trigger 'updateready' if @notifyUpdate
	49	return

assets/javascripts/app/settings.coffee+30−0

@@ -19,6 +19,8 @@ class app.Settings · 18 unmodified lines
19	'news'	19	'news'
20	]	20	]
21		21
		22	LAYOUTS: ['_max-width', '_sidebar-hidden', '_native-scrollbars']
		23
22	@defaults:	24	@defaults:
23	count: 0	25	count: 0
24	hideDisabled: false	26	hideDisabled: false
@@ -38,6 +40,7 @@ class app.Settings · 13 unmodified lines
38	set: (key, value) ->	40	set: (key, value) ->
39	@store.set(key, value)	41	@store.set(key, value)
40	delete @cache[key]	42	delete @cache[key]
		43	@toggleDark(value) if key == 'dark'
41	return	44	return
42		45
43	del: (key) ->	46	del: (key) ->
@@ -63,6 +66,8 @@ class app.Settings · 19 unmodified lines
63	return	66	return
64		67
65	setLayout: (name, enable) ->	68	setLayout: (name, enable) ->
		69	@toggleLayout(name, enable)
		70
66	layout = (@store.get('layout') \|\| '').split(' ')	71	layout = (@store.get('layout') \|\| '').split(' ')
67	$.arrayDelete(layout, '')	72	$.arrayDelete(layout, '')
68		73
@@ -104,3 +109,28 @@ class app.Settings · 35 unmodified lines
104	@store.reset()	109	@store.reset()
105	@cache = {}	110	@cache = {}
106	return	111	return
		112
		113	initLayout: ->
		114	@toggleDark(@get('dark') is 1)
		115	@toggleLayout(layout, @hasLayout(layout)) for layout in @LAYOUTS
		116	@initSidebarWidth()
		117	return
		118
		119	toggleDark: (enable) ->
		120	classList = document.documentElement.classList
		121	classList.toggle('_theme-default', !enable)
		122	classList.toggle('_theme-dark', enable)
		123	color = getComputedStyle(document.documentElement).getPropertyValue('--headerBackground').trim()
		124	$('meta[name=theme-color]').setAttribute('content', color)
		125	return
		126
		127	toggleLayout: (layout, enable) ->
		128	classList = document.body.classList
		129	classList.toggle(layout, enable) unless layout is '_sidebar-hidden'
		130	classList.toggle('_overlay-scrollbars', $.overlayScrollbarsEnabled())
		131	return
		132
		133	initSidebarWidth: ->
		134	size = @get('size')
		135	document.documentElement.style.setProperty('--sidebarWidth', size + 'px') if size
		136	return

assets/javascripts/app/update_checker.coffee+3−3

@@ -3,13 +3,13 @@ class app.UpdateChecker · 2 unmodified lines
3	@lastCheck = Date.now()	3	@lastCheck = Date.now()
4		4
5	$.on window, 'focus', @onFocus	5	$.on window, 'focus', @onFocus
6	app.appCache.on 'updateready', @onUpdateReady if app.appCache	6	app.serviceWorker?.on 'updateready', @onUpdateReady
7		7
8	setTimeout @checkDocs, 0	8	setTimeout @checkDocs, 0
9		9
10	check: ->	10	check: ->
11	if app.appCache	11	if app.serviceWorker
12	app.appCache.update()	12	app.serviceWorker.update()
13	else	13	else
14	ajax	14	ajax
15	url: $('script[src*="application"]').getAttribute('src')	15	url: $('script[src*="application"]').getAttribute('src')

assets/javascripts/lib/license.coffee+1−1

@@ -1,5 +1,5 @@
1	###	1	###
2	* Copyright 2013-2018 Thibaut Courouble and other contributors	2	* Copyright 2013-2019 Thibaut Courouble and other contributors
3	*	3	*
4	* This source code is licensed under the terms of the Mozilla	4	* This source code is licensed under the terms of the Mozilla
5	* Public License, v. 2.0, a copy of which may be obtained at:	5	* Public License, v. 2.0, a copy of which may be obtained at:

assets/javascripts/news.json+4−0

 [
+  [
+    "2019-07-19",
+    "Replaced the AppCache with a Service Worker (which makes DevDocs an installable PWA) and fixed layout preferences on Firefox."
+  ],
   [
     "2018-09-23",
     "New documentations: <a href=\"/puppeteer/\">Puppeteer</a> and <a href=\"/handlebars/\">Handlebars.js</a>"

assets/javascripts/templates/error_tmpl.coffee+8−8

@@ -12,8 +12,8 @@ app.templates.notFoundPage = -> · 11 unmodified lines
12		12
13	app.templates.pageLoadError = ->	13	app.templates.pageLoadError = ->
14	error """ The page failed to load. """,	14	error """ The page failed to load. """,
15	""" It may be missing from the server (try reloading the app) or you could be offline.<br>	15	""" It may be missing from the server (try reloading the app) or you could be offline (try <a href="/offline">installing the documentation for offline usage</a> when online again).<br>
16	If you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """,	16	If you're online and you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """,
17	""" #{back} · <a href="/##{location.pathname}" target="_top" class="_error-link">Reload</a>	17	""" #{back} · <a href="/##{location.pathname}" target="_top" class="_error-link">Reload</a>
18	· <a href="#" class="_error-link" data-retry>Retry</a> """	18	· <a href="#" class="_error-link" data-retry>Retry</a> """
19		19
@@ -57,17 +57,17 @@ app.templates.unsupportedBrowser = """ · 37 unmodified lines
57	<p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers:	57	<p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers:
58	<ul class="_fail-list">	58	<ul class="_fail-list">
59	<li>Recent versions of Firefox, Chrome, or Opera	59	<li>Recent versions of Firefox, Chrome, or Opera
60	<li>Safari 9.1+	60	<li>Safari 11.1+
61	<li>Edge 16+	61	<li>Edge 17+
62	<li>iOS 10+	62	<li>iOS 11.3+
63	</ul>	63	</ul>
64	<p class="_fail-text">	64	<p class="_fail-text">
65	If you're unable to upgrade, I apologize.	65	If you're unable to upgrade, we apologize.
66	I decided to prioritize speed and new features over support for older browsers.	66	We decided to prioritize speed and new features over support for older browsers.
67	<p class="_fail-text">	67	<p class="_fail-text">
68	Note: if you're already using one of the browsers above, check your settings and add-ons.	68	Note: if you're already using one of the browsers above, check your settings and add-ons.
69	The app uses feature detection, not user agent sniffing.	69	The app uses feature detection, not user agent sniffing.
70	<p class="_fail-text">	70	<p class="_fail-text">
71	— Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a>	71	— <a href="https://twitter.com/DevDocs">@DevDocs</a>
72	</div>	72	</div>
73	"""	73	"""

assets/javascripts/templates/pages/about_tmpl.coffee+9−14

   </nav>
   <h1 class="_lined-heading">DevDocs: API Documentation Browser</h1>
-  <p>DevDocs combines multiple API documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
+  <p>DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
-  <ul>
+  <p>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>. It was created by <a href="https://thibaut.me">Thibaut Courouble</a> and is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a>.
-    <li>Created and maintained by <a href="https://thibaut.me">Thibaut Courouble</a>
-    <li>Free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>
-        <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe>
-  </ul>
   <p>To keep up-to-date with the latest news:
   <ul>
     <li>Follow <a href="https://twitter.com/DevDocs">@DevDocs</a> on Twitter
-    <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a>
+    <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a> <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe>
-    <li>Join the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>
+    <li>Join the <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a> chat room
   </ul>
   <h2 class="_block-heading" id="copyright">Copyright and License</h2>
   <p class="_note">
-    <strong>Copyright 2013&ndash;2018 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br>
+    <strong>Copyright 2013&ndash;2019 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br>
     This software is licensed under the terms of the Mozilla Public License v2.0.<br>
     You may obtain a copy of the source code at <a href="https://github.com/freeCodeCamp/devdocs">github.com/freeCodeCamp/devdocs</a>.<br>
     For more information, see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a>
     <dt>Where can I suggest new docs and features?
     <dd>You can suggest and vote for new docs on the <a href="https://trello.com/b/6BmTulfx/devdocs-documentation">Trello board</a>.<br>
         If you have a specific feature request, add it to the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>.<br>
-        Otherwise use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>.
+        Otherwise, come talk to us in the <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a> chat room.
     <dt>Where can I report bugs?
     <dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks!
   </dl>
-  <p>For anything else, feel free to email me at <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>.
   <h2 class="_block-heading" id="credits">Credits</h2>
   <h2 class="_block-heading" id="privacy">Privacy Policy</h2>
   <ul>
-    <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by Thibaut Courouble ("We").
+    <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a> ("We").
-    <li>We do not collect personal information.
+    <li>We do not collect personal information through the app.
     <li>We use Google Analytics, Gauges and Sentry to collect anonymous traffic information and improve the app.
     <li>The app uses cookies to store user preferences.
     <li>By using the app, you signify your acceptance of this policy. If you do not agree to this policy, please do not use the app.
-    <li>If you have any questions regarding privacy, please email <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>.
+    <li>If you have any questions regarding privacy, please email <a href="mailto:privacy@freecodecamp.org">privacy@freecodecamp.org</a>.
   </ul>
 """

assets/javascripts/templates/pages/offline_tmpl.coffee+9−4

   <h2 class="_block-heading">Questions & Answers</h2>
   <dl>
     <dt>How does this work?
-    <dd>Each page is cached as a key-value pair in <a href="https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API">IndexedDB</a> (downloaded from a single file).<br>
+    <dd>Each page is cached as a key-value pair in <a href="https://devdocs.io/dom/indexeddb_api">IndexedDB</a> (downloaded from a single file).<br>
-        The app also uses <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache">AppCache</a> and <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API">localStorage</a> to cache the assets and index files.
+        The app also uses <a href="https://devdocs.io/dom/service_worker_api/using_service_workers">Service Workers</a> and <a href="https://devdocs.io/dom/web_storage_api">localStorage</a> to cache the assets and index files.
     <dt>Can I close the tab/browser?
     <dd>#{canICloseTheTab()}
     <dt>What if I don't update a documentation?
 """
 canICloseTheTab = ->
-  if app.AppCache.isEnabled()
+  if app.ServiceWorker.isEnabled()
     """ Yes! Even offline, you can open a new tab, go to <a href="//devdocs.io">devdocs.io</a>, and everything will work as if you were online (provided you installed all the documentations you want to use beforehand). """
   else
-    """ No. AppCache isn't available in your browser (or is disabled), so loading <a href="//devdocs.io">devdocs.io</a> offline won't work.<br>
+    reason = "aren't available in your browser (or are disabled)"
+    if app.config.env != 'production'
+      reason = "are disabled in your development instance of DevDocs (enable them by setting the <code>ENABLE_SERVICE_WORKER</code> environment variable to <code>true</code>)"
+    """ No. Service Workers #{reason}, so loading <a href="//devdocs.io">devdocs.io</a> offline won't work.<br>
         The current tab will continue to function even when you go offline (provided you installed all the documentations beforehand). """
 app.templates.offlineDoc = (doc, status) ->

assets/javascripts/templates/pages/root_tmpl.coffee.erb+2−2

@@ -8,13 +8,13 @@ app.templates.intro = """ · 7 unmodified lines
8	<p>Thanks for downloading DevDocs. Here are a few things you should know:	8	<p>Thanks for downloading DevDocs. Here are a few things you should know:
9	<ol class="_intro-list">	9	<ol class="_intro-list">
10	<li>Your local version of DevDocs won't self-update. Unless you're modifying the code,	10	<li>Your local version of DevDocs won't self-update. Unless you're modifying the code,
11	I recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>.	11	we recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>.
12	<li>Run <code>thor docs:list</code> to see all available documentations.	12	<li>Run <code>thor docs:list</code> to see all available documentations.
13	<li>Run <code>thor docs:download <name></code> to download documentations.	13	<li>Run <code>thor docs:download <name></code> to download documentations.
14	<li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.	14	<li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.
15	<li>To be notified about new versions, don't forget to <a href="https://github.com/freeCodeCamp/devdocs/subscription">watch the repository</a> on GitHub.	15	<li>To be notified about new versions, don't forget to <a href="https://github.com/freeCodeCamp/devdocs/subscription">watch the repository</a> on GitHub.
16	<li>The <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a> is the preferred channel for bug reports and	16	<li>The <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a> is the preferred channel for bug reports and
17	feature requests. For everything else, use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>.	17	feature requests. For everything else, use <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a>.
18	<li>Contributions are welcome. See the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md">guidelines</a>.	18	<li>Contributions are welcome. See the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md">guidelines</a>.
19	<li>DevDocs is licensed under the terms of the Mozilla Public License v2.0. For more information,	19	<li>DevDocs is licensed under the terms of the Mozilla Public License v2.0. For more information,
20	see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a> and	20	see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a> and

assets/javascripts/views/content/entry_page.coffee+1−1

@@ -123,7 +123,7 @@ class app.views.EntryPage extends app.View · 122 unmodified lines
123	@render @tmpl('pageLoadError')	123	@render @tmpl('pageLoadError')
124	@resetClass()	124	@resetClass()
125	@addClass @constructor.errorClass	125	@addClass @constructor.errorClass
126	app.appCache?.update()	126	app.serviceWorker?.update()
127	return	127	return
128		128
129	cache: ->	129	cache: ->

assets/javascripts/views/content/settings_page.coffee+1−11

 class app.views.SettingsPage extends app.View
-  LAYOUTS = ['_max-width', '_sidebar-hidden', '_native-scrollbars']
-  SIDEBAR_HIDDEN_LAYOUT = '_sidebar-hidden'
   @className: '_static'
   @events:
     settings.dark = app.settings.get('dark')
     settings.smoothScroll = !app.settings.get('fastScroll')
     settings.arrowScroll = app.settings.get('arrowScroll')
-    settings[layout] = app.settings.hasLayout(layout) for layout in LAYOUTS
+    settings[layout] = app.settings.hasLayout(layout) for layout in app.settings.LAYOUTS
     settings
   getTitle: ->
     'Preferences'
   toggleDark: (enable) ->
-    html = document.documentElement
-    html.classList.toggle('_theme-default')
-    html.classList.toggle('_theme-dark')
     app.settings.set('dark', !!enable)
-    app.appCache?.updateInBackground()
     return
   toggleLayout: (layout, enable) ->
-    document.body.classList[if enable then 'add' else 'remove'](layout) unless layout is SIDEBAR_HIDDEN_LAYOUT
-    document.body.classList[if $.overlayScrollbarsEnabled() then 'add' else 'remove']('_overlay-scrollbars')
     app.settings.setLayout(layout, enable)
-    app.appCache?.updateInBackground()
     return
   toggleSmoothScroll: (enable) ->

assets/javascripts/views/layout/resizer.coffee+2−9

   init: ->
     @el.setAttribute('draggable', 'true')
     @appendTo $('._app')
-    @style = $('style[data-resizer]')
-    @size = @style.getAttribute('data-size')
     return
   MIN = 260
     return unless value > 0
     value = Math.min(Math.max(Math.round(value), MIN), MAX)
     newSize = "#{value}px"
-    @style.innerHTML = @style.innerHTML.replace(new RegExp(@size, 'g'), newSize)
+    document.documentElement.style.setProperty('--sidebarWidth', newSize)
-    @size = newSize
+    app.settings.setSize(value) if save
-    if save
-      app.settings.setSize(value)
-      app.appCache?.updateInBackground()
     return
   onDragStart: (event) =>
-    @style.removeAttribute('disabled')
     event.dataTransfer.effectAllowed = 'link'
     event.dataTransfer.setData('Text', '')
     $.on(window, 'dragover', @onDrag)

assets/javascripts/views/layout/settings.coffee+1−9

     if super
       @render()
       document.body.classList.remove(SIDEBAR_HIDDEN_LAYOUT)
-      app.appCache?.on 'progress', @onAppCacheProgress
     return
   deactivate: ->
       @resetClass()
       @docPicker.detach()
       document.body.classList.add(SIDEBAR_HIDDEN_LAYOUT) if app.settings.hasLayout(SIDEBAR_HIDDEN_LAYOUT)
-      app.appCache?.off 'progress', @onAppCacheProgress
     return
   render: ->
         docs = @docPicker.getSelectedDocs()
         app.settings.setDocs(docs)
-      @saveBtn.textContent = if app.appCache then 'Downloading\u2026' else 'Saving\u2026'
+      @saveBtn.textContent = 'Saving\u2026'
       disabledDocs = new app.collections.Docs(doc for doc in app.docs.all() when docs.indexOf(doc.slug) is -1)
       disabledDocs.uninstall ->
         app.db.migrate()
       $.stopEvent(event)
       app.router.show '/'
     return
-  onAppCacheProgress: (event) =>
-    if event.lengthComputable
-      percentage = Math.round event.loaded * 100 / event.total
-      @saveBtn.textContent = "Downloading\u2026 (#{percentage}%)"
-    return

assets/javascripts/views/search/search.coffee+8−0

       .on 'results', @onResults
       .on 'end', @onEnd
+    @scope
+      .on 'change', @onScopeChange
     app.on 'ready', @onReady
     $.on window, 'hashchange', @searchUrl
     $.on window, 'focus', @onWindowFocus
     $.stopEvent(event)
     return
+  onScopeChange: =>
+    @value = ''
+    @onInput()
+    return
   afterRoute: (name, context) =>
     return if app.shortcuts.eventInProgress?.name is 'escape'
     @reset(true) if not context.init and app.router.isIndex()

assets/javascripts/views/search/search_scope.coffee+9−2

     tag:   '._search-tag'
   @events:
+    click: 'onClick'
     keydown: 'onKeydown'
     textInput: 'onTextInput'
     $.stopEvent(event) if @doc
     return
+  onClick: (event) =>
+    if event.target is @tag
+      @reset()
+      $.stopEvent(event)
+    return
   onKeydown: (event) =>
     if event.which is 8 # backspace
-      if @doc and not @input.value
+      if @doc and @input.selectionEnd is 0
-        $.stopEvent(event)
         @reset()
+        $.stopEvent(event)
     else if not @doc and @input.value and not $.isChromeForAndroid()
       return if event.ctrlKey or event.metaKey or event.altKey or event.shiftKey
       if event.which is 9 or # tab

assets/javascripts/views/sidebar/sidebar.coffee+1−1

@@ -28,7 +28,7 @@ class app.views.Sidebar extends app.View · 27 unmodified lines
28		28
29	app.on 'ready', @onReady	29	app.on 'ready', @onReady
30		30
31	$.on document.documentElement, 'mouseleave', (event) => @display() if event.clientX < 10	31	$.on document.documentElement, 'mouseleave', (event) => @display() unless event.clientX <= 0
32	$.on document.documentElement, 'mouseenter', => @resetDisplay(forceNoHover: false)	32	$.on document.documentElement, 'mouseenter', => @resetDisplay(forceNoHover: false)
33	return	33	return
34		34

assets/stylesheets/application.css.scss+1−1

@@ -4,7 +4,7 @@ · 3 unmodified lines
4	//= depend_on docs-2@2x.png	4	//= depend_on docs-2@2x.png
5		5
6	/*!	6	/*!
7	* Copyright 2013-2018 Thibaut Courouble and other contributors	7	* Copyright 2013-2019 Thibaut Courouble and other contributors
8	*	8	*
9	* This source code is licensed under the terms of the Mozilla	9	* This source code is licensed under the terms of the Mozilla
10	* Public License, v. 2.0, a copy of which may be obtained at:	10	* Public License, v. 2.0, a copy of which may be obtained at:

assets/stylesheets/components/_fail.scss+0−2

@@ -32,5 +32,3 @@ · 31 unmodified lines
32	}	32	}
33		33
34	._fail-text:last-child { margin: 0; }	34	._fail-text:last-child { margin: 0; }
35
36	._fail-link { float: right; }

assets/stylesheets/components/_header.scss+1−0

@@ -215,5 +215,6 @@ · 214 unmodified lines
215	color: var(--textColorLight);	215	color: var(--textColorLight);
216	background: var(--searchTagBackground);	216	background: var(--searchTagBackground);
217	border-radius: 2px;	217	border-radius: 2px;
		218	cursor: pointer;
218	@extend %truncate-text;	219	@extend %truncate-text;
219	}	220	}

assets/stylesheets/pages/_mdn.scss+25−0

@@ -30,6 +30,7 @@ · 29 unmodified lines
30	.notice,	30	.notice,
31	.warning,	31	.warning,
32	.overheadIndicator,	32	.overheadIndicator,
		33	.blockIndicator,
33	.syntaxbox, // CSS, JavaScript	34	.syntaxbox, // CSS, JavaScript
34	.twopartsyntaxbox, // CSS	35	.twopartsyntaxbox, // CSS
35	.inheritsbox, // JavaScript	36	.inheritsbox, // JavaScript
@@ -104,4 +105,28 @@ · 68 unmodified lines
104	.cleared { clear: both; } // CSS/box-shadow	105	.cleared { clear: both; } // CSS/box-shadow
105		106
106	code > strong { font-weight: normal; }	107	code > strong { font-weight: normal; }
		108
		109	// Compatibility tablees
		110
		111	.bc-github-link {
		112	float: right;
		113	font-size: .75rem;
		114	}
		115
		116	.bc-supports-yes, .bc-supports-yes + dd, .bc-supports-yes + dd + dd { background: var(--noteGreenBackground); }
		117	.bc-supports-partial, .bc-supports-partial + dd, .bc-supports-partial + dd + dd { background: var(--noteOrangeBackground); }
		118	.bc-supports-no, .bc-supports-no + dd, .bc-supports-no + dd + dd { background: var(--noteRedBackground); }
		119
		120	.bc-table {
		121	min-width: 100%;
		122
		123	dl {
		124	margin: .25rem 0 0;
		125	padding: .25rem 0 0;
		126	font-size: .75rem;
		127	border-top: 1px solid var(--boxBorder);
		128	}
		129
		130	dd { margin: 0; }
		131	}
107	}	132	}

assets/stylesheets/pages/_rdoc.scss+0−11

@@ -33,19 +33,8 @@ · 32 unmodified lines
33	}	33	}
34	}	34	}
35		35
36	.method-description { position: relative; }
37
38	.method-source-code {	36	.method-source-code {
39	display: none;	37	display: none;
40	position: absolute;
41	z-index: 1;
42	top: 0;
43	left: -1em;
44	right: 0;
45	background: var(--contentBackground);
46	box-shadow: 0 1em 1em 1em var(--contentBackground);
47
48	> pre { margin: 0; }
49	}	38	}
50		39
51	// Rails guides	40	// Rails guides

docs/adding-docs.md+23−0

@@ -0,0 +1,23 @@
	1	Adding a documentation may look like a daunting task but once you get the hang of it, it's actually quite simple. Don't hesitate to ask for help [in Gitter](https://gitter.im/FreeCodeCamp/DevDocs) if you ever get stuck.
	2
	3	Note: please read the [contributing guidelines](../.github/CONTRIBUTING.md) before submitting a new documentation.
	4
	5	1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [PascalCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)
	6	2. Add the appropriate class attributes and filter options (see the [Scraper Reference](./scraper-reference.md) page).
	7	3. Check that the scraper is listed in `thor docs:list`.
	8	4. Create filters specific to the scraper in the `lib/docs/filters/[my_doc]/` directory and add them to the class's [filter stacks](./scraper-reference.md#filter-stacks). You may create any number of filters but will need at least the following two:
	9	* A [`CleanHtml`](./filter-reference.md#cleanhtmlfilter) filter whose task is to clean the HTML markup (e.g. adding `id` attributes to headings) and remove everything superfluous and/or nonessential.
	10	* An [`Entries`](./filter-reference.md#entriesfilter) filter whose task is to determine the pages' metadata (the list of entries, each with a name, type and path).
	11	The [Filter Reference](./filter-reference.md) page has all the details about filters.
	12	5. Using the `thor docs:page [my_doc] [path]` command, check that the scraper works properly. Files will appear in the `public/docs/[my_doc]/` directory (but not inside the app as the command doesn't touch the index). `path` in this case refers to either the remote path (if using `UrlScraper`) or the local path (if using `FileScraper`).
	13	6. Generate the full documentation using the `thor docs:generate [my_doc] --force` command. Additionally, you can use the `--verbose` option to see which files are being created/updated/deleted (useful to see what changed since the last run), and the `--debug` option to see which URLs are being requested and added to the queue (useful to pin down which page adds unwanted URLs to the queue).
	14	7. Start the server, open the app, enable the documentation, and see how everything plays out.
	15	8. Tweak the scraper/filters and repeat 5) and 6) until the pages and metadata are ok.
	16	9. To customize the pages' styling, create an SCSS file in the `assets/stylesheets/pages/` directory and import it in both `application.css.scss` AND `application-dark.css.scss`. Both the file and CSS class should be named `_[type]` where [type] is equal to the scraper's `type` attribute (documentations with the same type share the same custom CSS and JS). Setting the type to `simple` will apply the general styling rules in `assets/stylesheets/pages/_simple.scss`, which can be used for documentations where little to no CSS changes are needed.
	17	10. To add syntax highlighting or execute custom JavaScript on the pages, create a file in the `assets/javascripts/views/pages/` directory (take a look at the other files to see how it works).
	18	11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 32x32-pixels formats. It'll be added to the icon spritesheet after your pull request is merged.
	19	12. Add the documentation's copyright details to the list in `assets/javascripts/templates/pages/about_tmpl.coffee`. This is the data shown in the table on the [about](https://devdocs.io/about) page, and is ordered alphabetically. Simply copying an existing item, placing it in the right slot and updating the values to match the new scraper will do the job.
	20
	21	If the documentation includes more than a few hundreds pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)
	22
	23	Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.

docs/filter-reference.md+224−0

@@ -0,0 +1,224 @@
	1	Table of contents:
	2
	3	* [Overview](#overview)
	4	* [Instance methods](#instance-methods)
	5	* [Core filters](#core-filters)
	6	* [Custom filters](#custom-filters)
	7	- [CleanHtmlFilter](#cleanhtmlfilter)
	8	- [EntriesFilter](#entriesfilter)
	9
	10	## Overview
	11
	12	Filters use the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. They take an HTML string or [Nokogiri](http://nokogiri.org/) node as input, optionally perform modifications and/or extract information from it, and then outputs the result. Together they form a pipeline where each filter hands its output to the next filter's input. Every documentation page passes through this pipeline before being copied on the local filesystem.
	13
	14	Filters are subclasses of the [`Docs::Filter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/filter.rb) class and require a `call` method. A basic implementation looks like this:
	15
	16	```ruby
	17	module Docs
	18	class CustomFilter < Filter
	19	def call
	20	doc
	21	end
	22	end
	23	end
	24	```
	25
	26	Filters which manipulate the Nokogiri node object (`doc` and related methods) are _HTML filters_ and must not manipulate the HTML string (`html`). Vice-versa, filters which manipulate the string representation of the document are _text filters_ and must not manipulate the Nokogiri node object. The two types are divided into two stacks within the scrapers. These stacks are then combined into a pipeline that calls the HTML filters before the text filters (more details [here](./scraper-reference.md#filter-stacks)). This is to avoid parsing the document multiple times.
	27
	28	The `call` method must return either `doc` or `html`, depending on the type of filter.
	29
	30	## Instance methods
	31
	32	* `doc` [Nokogiri::XML::Node]
	33	The Nokogiri representation of the container element.
	34	See [Nokogiri's API docs](http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node) for the list of available methods.
	35
	36	* `html` [String]
	37	The string representation of the container element.
	38
	39	* `context` [Hash] (frozen)
	40	The scraper's `options` along with a few additional keys: `:base_url`, `:root_url`, `:root_page` and `:url`.
	41
	42	* `result` [Hash]
	43	Used to store the page's metadata and pass back information to the scraper.
	44	Possible keys:
	45
	46	- `:path` — the page's normalized path
	47	- `:store_path` — the path where the page will be stored (equal to `:path` with `.html` at the end)
	48	- `:internal_urls` — the list of distinct internal URLs found within the page
	49	- `:entries` — the [`Entry`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/models/entry.rb) objects to add to the index
	50
	51	* `css`, `at_css`, `xpath`, `at_xpath`
	52	Shortcuts for `doc.css`, `doc.xpath`, etc.
	53
	54	* `base_url`, `current_url`, `root_url` [Docs::URL]
	55	Shortcuts for `context[:base_url]`, `context[:url]`, and `context[:root_url]` respectively.
	56
	57	* `root_path` [String]
	58	Shortcut for `context[:root_path]`.
	59
	60	* `subpath` [String]
	61	The sub-path from the base URL of the current URL.
	62	_Example: if `base_url` equals `example.com/docs` and `current_url` equals `example.com/docs/file?raw`, the returned value is `/file`._
	63
	64	* `slug` [String]
	65	The `subpath` removed of any leading slash or `.html` extension.
	66	_Example: if `subpath` equals `/dir/file.html`, the returned value is `dir/file`._
	67
	68	* `root_page?` [Boolean]
	69	Returns `true` if the current page is the root page.
	70
	71	* `initial_page?` [Boolean]
	72	Returns `true` if the current page is the root page or its subpath is one of the scraper's `initial_paths`.
	73
	74	## Core filters
	75
	76	* [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb) — changes the root node of the document (remove everything outside)
	77	* [`CleanHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_html.rb) — removes HTML comments, `<script>`, `<style>`, etc.
	78	* [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) — replaces all URLs with their fully qualified counterpart
	79	* [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb) — detects internal URLs (the ones to scrape) and replaces them with their unqualified, relative counterpart
	80	* [`NormalizePathsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_paths.rb) — makes the internal paths consistent (e.g. always end with `.html`)
	81	* [`CleanLocalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_local_urls.rb) — removes links, iframes and images pointing to localhost (`FileScraper` only)
	82	* [`InnerHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/inner_html.rb) — converts the document to a string
	83	* [`CleanTextFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_text.rb) — removes empty nodes
	84	* [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb) — appends the license info and link to the original document
	85	* [`TitleFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/title.rb) — prepends the document with a title (disabled by default)
	86	* [`EntriesFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/entries.rb) — abstract filter for extracting the page's metadata
	87
	88	## Custom filters
	89
	90	Scrapers can have any number of custom filters but require at least the two described below.
	91
	92	Note: filters are located in the [`lib/docs/filters`](https://github.com/Thibaut/devdocs/tree/master/lib/docs/filters/) directory. The class's name must be the [CamelCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename.
	93
	94	### `CleanHtmlFilter`
	95
	96	The `CleanHtml` filter is tasked with cleaning the HTML markup where necessary and removing anything superfluous or nonessential. Only the core documentation should remain at the end.
	97
	98	Nokogiri's many jQuery-like methods make it easy to search and modify elements — see the [API docs](http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node).
	99
	100	Here's an example implementation that covers the most common use-cases:
	101
	102	```ruby
	103	module Docs
	104	class MyScraper
	105	class CleanHtmlFilter < Filter
	106	def call
	107	css('hr').remove
	108	css('#changelog').remove if root_page?
	109
	110	# Set id attributes on <h3> instead of an empty <a>
	111	css('h3').each do \|node\|
	112	node['id'] = node.at_css('a')['id']
	113	end
	114
	115	# Make proper table headers
	116	css('td.header').each do \|node\|
	117	node.name = 'th'
	118	end
	119
	120	# Remove code highlighting
	121	css('pre').each do \|node\|
	122	node.content = node.content
	123	end
	124
	125	doc
	126	end
	127	end
	128	end
	129	end
	130	```
	131
	132	Notes:
	133
	134	* Empty elements will be automatically removed by the core `CleanTextFilter` later in the pipeline's execution.
	135	* Although the goal is to end up with a clean version of the page, try to keep the number of modifications to a minimum, so as to make the code easier to maintain. Custom CSS is the preferred way of normalizing the pages (except for hiding stuff which should always be done by removing the markup).
	136	* Try to document your filter's behavior as much as possible, particularly modifications that apply only to a subset of pages. It'll make updating the documentation easier.
	137
	138	### `EntriesFilter`
	139
	140	The `Entries` filter is responsible for extracting the page's metadata, represented by a set of _entries_, each with a name, type and path.
	141
	142	The following two models are used under the hood to represent the metadata:
	143
	144	* [`Entry(name, type, path)`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/models/entry.rb)
	145	* [`Type(name, slug, count)`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/models/type.rb)
	146
	147	Each scraper must implement its own `EntriesFilter` by subclassing the [`Docs::EntriesFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/entries.rb) class. The base class already implements the `call` method and includes four methods which the subclasses can override:
	148
	149	* `get_name` [String]
	150	The name of the default entry (aka. the page's name).
	151	It is usually guessed from the `slug` (documented above) or by searching the HTML markup.
	152	Default: modified version of `slug` (underscores are replaced with spaces and forward slashes with dots)
	153
	154	* `get_type` [String]
	155	The type of the default entry (aka. the page's type).
	156	Entries without a type can be searched for but won't be listed in the app's sidebar (unless no other entries have a type).
	157	Default: `nil`
	158
	159	* `include_default_entry?` [Boolean]
	160	Whether to include the default entry.
	161	Used when a page consists of multiple entries (returned by `additional_entries`) but doesn't have a name/type of its own, or to remove a page from the index (if it has no additional entries), in which case it won't be copied on the local filesystem and any link to it in the other pages will be broken (as explained on the [Scraper Reference](./scraper-reference.md) page, this is used to keep the `:skip` / `:skip_patterns` options to a maintainable size, or if the page includes links that can't reached from anywhere else).
	162	Default: `true`
	163
	164	* `additional_entries` [Array]
	165	The list of additional entries.
	166	Each entry is represented by an Array of three attributes: its name, fragment identifier, and type. The fragment identifier refers to the `id` attribute of the HTML element (usually a heading) that the entry relates to. It is combined with the page's path to become the entry's path. If absent or `nil`, the page's path is used. If the type is absent or `nil`, the default `type` is used.
	167	Example: `[ ['One'], ['Two', 'id'], ['Three', nil, 'type'] ]` adds three additional entries, the first one named "One" with the default path and type, the second one named "Two" with the URL fragment "#id" and the default type, and the third one named "Three" with the default path and the type "type".
	168	The list is usually constructed by running through the markup. Exceptions can also be hard-coded for specific pages.
	169	Default: `[]`
	170
	171	The following accessors are also available, but must not be overridden:
	172
	173	* `name` [String]
	174	Memoized version of `get_name` (`nil` for the root page).
	175
	176	* `type` [String]
	177	Memoized version of `get_type` (`nil` for the root page).
	178
	179	Notes:
	180
	181	* Leading and trailing whitespace is automatically removed from names and types.
	182	* Names must be unique across the documentation and as short as possible (ideally less than 30 characters). Whenever possible, methods should be differentiated from properties by appending `()`, and instance methods should be differentiated from class methods using the `Class#method` or `object.method` conventions.
	183	* You can call `name` from `get_type` or `type` from `get_name` but doing both will cause a stack overflow (i.e. you can infer the name from the type or the type from the name, but you can't do both at the same time). Don't call `get_name` or `get_type` directly as their value isn't memoized.
	184	* The root page has no name and no type (both are `nil`). `get_name` and `get_type` won't get called with the page (but `additional_entries` will).
	185	* `Docs::EntriesFilter` is an _HTML filter_. It must be added to the scraper's `html_filters` stack.
	186	* Try to document the code as much as possible, particularly the special cases. It'll make updating the documentation easier.
	187
	188	Example:
	189
	190	```ruby
	191	module Docs
	192	class MyScraper
	193	class EntriesFilter < Docs::EntriesFilter
	194	def get_name
	195	node = at_css('h1')
	196	result = node.content.strip
	197	result << ' event' if type == 'Events'
	198	result << '()' if node['class'].try(:include?, 'function')
	199	result
	200	end
	201
	202	def get_type
	203	object, method = *slug.split('/')
	204	method ? object : 'Miscellaneous'
	205	end
	206
	207	def additional_entries
	208	return [] if root_page?
	209
	210	css('h2').map do \|node\|
	211	[node.content, node['id']]
	212	end
	213	end
	214
	215	def include_default_entry?
	216	!at_css('.obsolete')
	217	end
	218	end
	219	end
	220	end
	221	```
	222
	223
	224	return [[Home]]

docs/maintainers.md+102−0

@@ -0,0 +1,102 @@
	1	# Maintainer's Guide
	2
	3	This document is intended for [DevDocs maintainers](#list-of-maintainers).
	4
	5	## Merging pull requests
	6
	7	- PRs should be approved by at least one maintainer before being merged.
	8
	9	- PRs that add or update documentations should always be merged locally, and the app deployed, before the merge is pushed to GitHub.
	10
	11	This workflow is required because there is a dependency between the local and production environments. The `thor docs:download` command downloads documentations from production files uploaded by the `thor docs:upload` command. If a PR adding a new documentation is merged and pushed to GitHub before the files have been uploaded to production, the `thor docs:download` will fail for the new documentation and the docker container will not build properly until the new documentation is deployed to production.
	12
	13	## Updating docs
	14
	15	The process for updating docs is as follow:
	16
	17	- Make version/release changes in the scraper file.
	18	- If needed, update the copyright notice of the documentation in the scraper file (`options[:attribution]`) and the about page (`about_tmpl.coffee`). The copyright notice must be the same as the one on the original documentation.
	19	- Run `thor docs:generate`.
	20	- Make sure the documentation still works well. The `thor docs:generate` command outputs a summary of the changes, which helps identifying issues (e.g. deleted files) and new pages to check out in the app. Verify locally that everything works, especially the files that were created (if any), and that the categorization of entries is still good. Often, updates will require code changes to tweak some new markup in the source website or categorize new entries.
	21	- Commit the changes (protip: use the `thor docs:commit` command documented below).
	22	- Optional: do more updates.
	23	- Run `thor docs:upload` (documented below).
	24	- Push to GitHub to [deploy the app](#deploying-devdocs) and verify that everything works in production.
	25	- Run `thor docs:clean` (documented below).
	26
	27	Note: changes to `public/docs/docs.json` should never be committed. This file reflects which documentations have been downloaded or generated locally, which is always none on a fresh `git clone`.
	28
	29	## Setup requirements
	30
	31	In order to deploy DevDocs, you must:
	32
	33	- be given access to Heroku, [configure the Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) on your computer, and familiarize yourself with Heroku's UI and CLI, as well as that of New Relic (accessible through [the Heroku dashboard](https://dashboard.heroku.com/apps/devdocs)).
	34
	35	- be given access to DevDocs's [Sentry instance](https://sentry.io/devdocs/devdocs-js/) (for JS error tracking) and familiarize yourself with its UI.
	36
	37	- be provided with DevDocs's S3 credentials, and install (`brew install awscli` on macOS) and [configure](https://docs.aws.amazon.com/cli/latest/reference/configure/) the AWS CLI on your computer. The configuration must add a named profile called "devdocs":
	38	```
	39	aws configure --profile devdocs
	40	```
	41
	42	- be provided with DevDocs's MaxCDN push zone credentials, and add them to your `.bash_profile` as such:
	43	```
	44	export DEVDOCS_DL_USERNAME="username"
	45	export DEVDOCS_DL_PASSWORD="password"
	46	```
	47
	48	## Thor commands
	49
	50	In addition to the [publicly-documented commands](https://github.com/freeCodeCamp/devdocs#available-commands), the following commands are aimed at DevDocs maintainers:
	51
	52	- `thor docs:package`
	53
	54	Generates packages for one or more documentations. Those packages are intended to be uploaded to DevDocs's MaxCDN push zone by maintainers via the `thor docs:upload` command, and downloaded by users via the `thor docs:download` command.
	55
	56	Versions can be specified as such: `thor docs:package rails@5.2 node@10\ LTS`.
	57
	58	Packages can also be automatically generated during the scraping process by passing the `--package` option to `thor docs:generate`.
	59
	60	- `thor docs:upload`
	61
	62	This command does two operations:
	63
	64	1. sync the files for the specified documentations with S3 (used by the Heroku app);
	65	2. upload the documentations' packages to DevDocs's MaxCDN push zone (used by the `thor docs:download` command).
	66
	67	For the command to work, you must have the AWS CLI and MaxCDN credentials configured as indicated above.
	68
	69	Important: the app should always be deployed immediately after this command has finished running. Do not run this command unless you are able and ready to deploy DevDocs.
	70
	71	To upload all documentations that are packaged on your computer, run `thor docs:upload --packaged`.
	72	To test your configuration and the effect of this command without uploading anything, pass the `--dryrun` option.
	73
	74	- `thor docs:commit`
	75
	76	Shortcut command to create a Git commit for a given documentation once it has been updated. Scraper and `assets/` file changes will be committed. The commit message will include the most recent version that the documentation was updated to. If some files were missed by the commit, use `git commit --amend` to add them to the commit. The command may be run before `thor docs:upload` is run, but the commit should not be pushed to GitHub before the files have been uploaded and the app deployed.
	77
	78	- `thor docs:clean`
	79
	80	Shortcut command to delete all package files (once uploaded via `thor docs:upload`, they are not needed anymore).
	81
	82	## Deploying DevDocs
	83
	84	Once docs have been uploaded via `thor docs:upload` (if applicable), you can push to the DevDocs master branch (or merge the PR containing the updates). If the Travis build succeeds, the Heroku application will be deployed automatically.
	85
	86	- If you're deploying documentation updates, verify that the documentations work properly once the deploy is done. Keep in mind that you'll need to wait a few seconds for the service worker to finish caching the new assets. You should see a "DevDocs has been updated" notification appear when the caching is done, after which you need to refresh the page to see the changes.
	87	- If you're deploying frontend changes, monitor [Sentry](https://sentry.io/devdocs/devdocs-js/) for new JS errors once the deploy is done.
	88	- If you're deploying server changes, monitor New Relic (accessible through [the Heroku dashboard](https://dashboard.heroku.com/apps/devdocs)) for Ruby exceptions and throughput or response time changes once the deploy is done.
	89
	90	If any issue arises, run `heroku rollback` to rollback to the previous version of the app (this can also be done via Heroku's UI). Note that this will not revert changes made to documentation files that were uploaded via `thor docs:upload`. Try and fix the issue as quickly as possible, then re-deploy the app. Reach out to other maintainers if you need help.
	91
	92	If this is your first deploy, make sure another maintainer is around to assist.
	93
	94	## List of maintainers
	95
	96	- [Jed Fox](https://github.com/j-f1)
	97	- [Jasper van Merle](https://github.com/jmerle)
	98	- [Ahmad Abdolsaheb](https://github.com/ahmadabdolsaheb)
	99	- [Mrugesh Mohapatra](https://github.com/raisedadead)
	100	- [Thibaut Courouble](https://github.com/thibaut)
	101
	102	Interested in helping maintain DevDocs? Come talk to us on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs) :)

docs/scraper-reference.md+186−0

@@ -0,0 +1,186 @@
	1	Table of contents:
	2
	3	* [Overview](#overview)
	4	* [Configuration](#configuration)
	5	- [Attributes](#attributes)
	6	- [Filter stacks](#filter-stacks)
	7	- [Filter options](#filter-options)
	8
	9	## Overview
	10
	11	Starting from a root URL, scrapers recursively follow links that match a set of rules, passing each valid response through a chain of filters before writing the file on the local filesystem. They also create an index of the pages' metadata (determined by one filter), which is dumped into a JSON file at the end.
	12
	13	Scrapers rely on the following libraries:
	14
	15	* [Typhoeus](https://github.com/typhoeus/typhoeus) for making HTTP requests
	16	* [HTML::Pipeline](https://github.com/jch/html-pipeline) for applying filters
	17	* [Nokogiri](http://nokogiri.org/) for parsing HTML
	18
	19	There are currently two kinds of scrapers: [`UrlScraper`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/scrapers/url_scraper.rb) which downloads files via HTTP and [`FileScraper`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/scrapers/file_scraper.rb) which reads them from the local filesystem. They function almost identically (both use URLs), except that `FileScraper` substitutes the base URL with a local path before reading a file. `FileScraper` uses the placeholder `localhost` base URL by default and includes a filter to remove any URL pointing to it at the end.
	20
	21	To be processed, a response must meet the following requirements:
	22
	23	* 200 status code
	24	* HTML content type
	25	* effective URL (after redirection) contained in the base URL (explained below)
	26
	27	(`FileScraper` only checks if the file exists and is not empty.)
	28
	29	Each URL is requested only once (case-insensitive).
	30
	31	## Configuration
	32
	33	Configuration is done via class attributes and divided into three main categories:
	34
	35	* [Attributes](#attributes) — essential information such as name, version, URL, etc.
	36	* [Filter stacks](#filter-stacks) — the list of filters that will be applied to each page.
	37	* [Filter options](#filter-options) — the options passed to said filters.
	38
	39	Note: scrapers are located in the [`lib/docs/scrapers`](https://github.com/Thibaut/devdocs/tree/master/lib/docs/scrapers/) directory. The class's name must be the [CamelCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename.
	40
	41	### Attributes
	42
	43	* `name` [String]
	44	Must be unique.
	45	Defaults to the class's name.
	46
	47	* `slug` [String]
	48	Must be unique, lowercase, and not include dashes (underscores are ok).
	49	Defaults to `name` lowercased.
	50
	51	* `type` [String] (required, inherited)
	52	Defines the CSS class name (`_[type]`) and custom JavaScript class (`app.views.[Type]Page`) that will be added/loaded on each page. Documentations sharing a similar structure (e.g. generated with the same tool or originating from the same website) should use the same `type` to avoid duplicating the CSS and JS.
	53	Must include lowercase letters only.
	54
	55	* `release` [String] (required)
	56	The version of the software at the time the scraper was last run. This is only informational and doesn't affect the scraper's behavior.
	57
	58	* `base_url` [String] (required in `UrlScraper`)
	59	The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).
	60	Defaults to `localhost` in `FileScraper`. _(Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)_
	61	Unless `root_path` is set, the root/initial URL is equal to `base_url`.
	62
	63	* `root_path` [String] (inherited)
	64	The path from the `base_url` of the root URL.
	65
	66	* `initial_paths` [Array] (inherited)
	67	A list of paths (from the `base_url`) to add to the initial queue. Useful for scraping isolated documents.
	68	Defaults to `[]`. _(Note: the `root_path` is added to the array at runtime.)_
	69
	70	* `dir` [String] (required, `FileScraper` only)
	71	The absolute path where the files are located on the local filesystem.
	72	_Note: `FileScraper` works exactly like `UrlScraper` (manipulating the same kind of URLs) except that it substitutes `base_url` with `dir` in order to read files instead of making HTTP requests._
	73
	74	* `params` [Hash] (inherited, `UrlScraper` only)
	75	Query string parameters to append to every URL. (e.g. `{ format: 'raw' }` → `?format=raw`)
	76	Defaults to `{}`.
	77
	78	* `abstract` [Boolean]
	79	Make the scraper abstract / not runnable. Used for sharing behavior with other scraper classes (e.g. all MDN scrapers inherit from the abstract [`Mdn`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/scrapers/mdn/mdn.rb) class).
	80	Defaults to `false`.
	81
	82	### Filter stacks
	83
	84	Each scraper has two [filter](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/filter.rb) [stacks](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/filter_stack.rb): `html_filters` and `text_filters`. They are combined into a pipeline (using the [HTML::Pipeline](https://github.com/jch/html-pipeline) library) which causes each filter to hand its output to the next filter's input.
	85
	86	HTML filters are executed first and manipulate a parsed version of the document (a [Nokogiri](http://nokogiri.org/Nokogiri/XML/Node.html) node object), whereas text filters manipulate the document as a string. This separation avoids parsing the document multiple times.
	87
	88	Filter stacks are like sorted sets. They can modified using the following methods:
	89
	90	```ruby
	91	push(*names) # append one or more filters at the end
	92	insert_before(index, *names) # insert one filter before another (index can be a name)
	93	insert_after(index, *names) # insert one filter after another (index can be a name)
	94	replace(index, name) # replace one filter with another (index can be a name)
	95	```
	96
	97	"names" are `require` paths relative to `Docs` (e.g. `jquery/clean_html` → `Docs::Jquery::CleanHtml`).
	98
	99	Default `html_filters`:
	100
	101	* [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb) — changes the root node of the document (remove everything outside)
	102	* [`CleanHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_html.rb) — removes HTML comments, `<script>`, `<style>`, etc.
	103	* [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) — replaces all URLs with their fully qualified counterpart
	104	* [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb) — detects internal URLs (the ones to scrape) and replaces them with their unqualified, relative counterpart
	105	* [`NormalizePathsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_paths.rb) — makes the internal paths consistent (e.g. always end with `.html`)
	106	* [`CleanLocalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_local_urls.rb) — removes links, iframes and images pointing to localhost (`FileScraper` only)
	107
	108	Default `text_filters`:
	109
	110	* [`InnerHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/inner_html.rb) — converts the document to a string
	111	* [`CleanTextFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_text.rb) — removes empty nodes
	112	* [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb) — appends the license info and link to the original document
	113
	114	Additionally:
	115
	116	* [`TitleFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/title.rb) is a core HTML filter, disabled by default, which prepends the document with a title (`<h1>`).
	117	* [`EntriesFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/entries.rb) is an abstract HTML filter that each scraper must implement and responsible for extracting the page's metadata.
	118
	119	### Filter options
	120
	121	The filter options are stored in the `options` Hash. The Hash is inheritable (a recursive copy) and empty by default.
	122
	123	More information about how filters work is available on the [Filter Reference](./filter-reference.md) page.
	124
	125	* [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb)
	126
	127	- `:container` [String or Proc]
	128	A CSS selector of the container element. Everything outside of it will be removed and become unavailable to the other filters. If more than one element match the selector, the first one inside the DOM is used. If no elements match the selector, an error is raised.
	129	If the value is a Proc, it is called for each page with the filter instance as argument, and should return a selector or `nil`.
	130	The default container is the `<body>` element.
	131	_Note: links outside of the container element will not be followed by the scraper. To remove links that should be followed, use a [`CleanHtml`](./filter-reference.md#cleanhtmlfilter) filter later in the stack._
	132
	133	* [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb)
	134	The following options are used to modify URLs in the pages. They are useful to remove duplicates (when the same page is accessible from multiple URLs) and fix websites that have a bunch of redirections in place (when URLs that should be scraped, aren't, because they are behind a redirection which is outside of the `base_url` — see the MDN scrapers for examples of this).
	135
	136	- `:replace_urls` [Hash]
	137	Replaces all instances of a URL with another.
	138	Format: `{ 'original_url' => 'new_url' }`
	139	- `:replace_paths` [Hash]
	140	Replaces all instances of a sub-path (path from the `base_url`) with another.
	141	Format: `{ 'original_path' => 'new_path' }`
	142	- `:fix_urls` [Proc]
	143	Called with each URL. If the returned value is `nil`, the URL isn't modified. Otherwise the returned value is used as replacement.
	144
	145	_Note: before these rules are applied, all URLs are converted to their fully qualified counterpart (http://...)._
	146
	147	* [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb)
	148
	149	Internal URLs are the ones _inside_ the scraper's `base_url` ("inside" more or less means "starting with", except that `/docs` is outside `/doc`). They will be scraped unless excluded by one of the following rules. All internal URLs are converted to relative URLs inside the pages.
	150
	151	- `:skip_links` [Boolean or Proc]
	152	If `false`, does not convert or follow any internal URL (creating a single-page documentation).
	153	If the value is a Proc, it is called for each page with the filter instance as argument.
	154	- `:follow_links` [Proc]
	155	Called for page with the filter instance as argument. If the returned value is `false`, does not add internal URLs to the queue.
	156	- `:trailing_slash` [Boolean]
	157	If `true`, adds a trailing slash to all internal URLs. If `false`, removes it.
	158	This is another option used to remove duplicate pages.
	159	- `:skip` [Array]
	160	Ignores internal URLs whose sub-paths (path from the `base_url`) are in the Array (case-insensitive).
	161	- `:skip_patterns` [Array]
	162	Ignores internal URLs whose sub-paths match any Regexp in the Array.
	163	- `:only` [Array]
	164	Ignores internal URLs whose sub-paths aren't in the Array (case-insensitive) and don't match any Regexp in `:only_patterns`.
	165	- `:only_patterns` [Array]
	166	Ignores internal URLs whose sub-paths don't match any Regexp in the Array and aren't in `:only`.
	167
	168	If the scraper has a `root_path`, the empty and `/` paths are automatically skipped.
	169	If `:only` or `:only_patterns` is set, the root path is automatically added to `:only`.
	170
	171	_Note: pages can be excluded from the index based on their content using the [`Entries`](./filter-reference.md#entriesfilter) filter. However, their URLs will still be converted to relative in the other pages and trying to open them will return a 404 error. Although not ideal, this is often better than having to maintain a long list of `:skip` URLs._
	172
	173	* [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb)
	174
	175	- `:attribution` [String] (required)
	176	An HTML string with the copyright and license information. See the other scrapers for examples.
	177
	178	* [`TitleFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/title.rb)
	179
	180	- `:title` [String or Boolean or Proc]
	181	Unless the value is `false`, adds a title to every page.
	182	If the value is `nil`, the title is the name of the page as determined by the [`Entries`](./filter-reference.md#entriesfilter) filter. Otherwise the title is the String or the value returned by the Proc (called for each page, with the filter instance as argument). If the Proc returns `nil` or `false`, no title is added.
	183	- `:root_title` [String or Boolean]
	184	Overrides the `:title` option for the root page only.
	185
	186	_Note: this filter is disabled by default._

lib/app.rb+36−21

   Rack::Mime::MIME_TYPES['.webapp'] = 'application/x-web-app-manifest+json'
   configure do
-    use Rack::SslEnforcer, only_environments: ['production', 'test'], hsts: false, force_secure_cookies: false
+    use Rack::SslEnforcer, only_environments: ['production', 'test'], hsts: true, force_secure_cookies: false
     set :sentry_dsn, ENV['SENTRY_DSN']
     set :protection, except: [:frame_options, :xss_header]
     set :csp, false
+    require 'docs'
+    Docs.generate_manifest
     Dir[docs_path, root.join(assets_prefix, '*/')].each do |path|
       sprockets.append_path(path)
     end
       request.query_string.empty? ? nil : "?#{request.query_string}"
     end
-    def manifest_asset_urls
+    def service_worker_asset_urls
-      @@manifest_asset_urls ||= [
+      @@service_worker_asset_urls ||= [
         javascript_path('application', asset_host: false),
         stylesheet_path('application'),
         image_path('docs-1.png'),
         image_path('docs-1@2x.png'),
         image_path('docs-2.png'),
         image_path('docs-2@2x.png'),
-        asset_path('docs.js')
+        asset_path('docs.js'),
-      ]
+        App.production? ? nil : javascript_path('debug'),
+      ].compact
     end
-    def app_size
+    # Returns a cache name for the service worker to use which changes if any of the assets changes
-      @app_size ||= memoized_cookies['size'].nil? ? '20rem' : "#{memoized_cookies['size']}px"
+    # When a manifest exist, this name is only created once based on the asset manifest because it never changes without a server restart
-    end
+    # If a manifest does not exist, it is created every time this method is called because the assets can change while the server is running
+    def service_worker_cache_name
+      if File.exist?(App.assets_manifest_path)
+        if defined?(@@service_worker_cache_name)
+          return @@service_worker_cache_name
+        end
-    def app_layout
+        digest = Sprockets::Manifest
-      memoized_cookies['layout']
+                   .new(nil, App.assets_manifest_path)
-    end
+                   .files
+                   .values
+                   .map {|file| file["digest"]}
+                   .join
-    def app_theme
+        return @@service_worker_cache_name ||= Digest::MD5.hexdigest(digest)
-      @app_theme ||= memoized_cookies['dark'].nil? ? 'default' : 'dark'
+      else
-    end
+        paths = App.sprockets
+                  .each_file
+                  .to_a
+                  .reject {|file| file.start_with?(App.docs_path)}
-    def dark_theme?
+        return App.sprockets.pack_hexdigest(App.sprockets.files_digest(paths))
-      app_theme == 'dark'
+      end
     end
-    def redirect_via_js(path) # courtesy of HTML5 App Cache
+    def redirect_via_js(path)
       response.set_cookie :initial_path, value: path, expires: Time.now + 15, path: '/'
       redirect '/', 302
     end
     end
   end
-  get '/manifest.appcache' do
+  get '/service-worker.js' do
-    content_type 'text/cache-manifest'
+    content_type 'application/javascript'
     expires 0, :'no-cache'
-    erb :manifest
+    erb :'service-worker.js'
   end
   get '/' do
     return redirect "/#q=#{params[:q]}" if params[:q]
-    return redirect '/' unless request.query_string.empty? # courtesy of HTML5 App Cache
+    return redirect '/' unless request.query_string.empty?
     response.headers['Content-Security-Policy'] = settings.csp if settings.csp
     erb :index
   end

lib/docs.rb+17−0

@@ -29,6 +29,7 @@ module Docs · 28 unmodified lines
29	self.rescue_errors = false	29	self.rescue_errors = false
30		30
31	class DocNotFound < NameError; end	31	class DocNotFound < NameError; end
		32	class SetupError < StandardError; end
32		33
33	def self.all	34	def self.all
34	Dir["#{root_path}/docs/scrapers/*/.rb"].	35	Dir["#{root_path}/docs/scrapers/*/.rb"].
@@ -74,6 +75,22 @@ module Docs · 39 unmodified lines
74	end	75	end
75	end	76	end
76		77
		78	def self.find_by_slug(slug, version = nil)
		79	doc = all.find { \|klass\| klass.slug == slug }
		80
		81	unless doc
		82	raise DocNotFound.new(%(could not find doc with "#{slug}"), slug)
		83	end
		84
		85	if version.present?
		86	version = doc.versions.find { \|klass\| klass.version == version \|\| klass.version_slug == version }
		87	raise DocNotFound.new(%(could not find version "#{version}" for doc "#{doc.name}"), doc.name) unless version
		88	doc = version
		89	end
		90
		91	doc
		92	end
		93
77	def self.generate_page(name, version, page_id)	94	def self.generate_page(name, version, page_id)
78	find(name, version).store_page(store, page_id)	95	find(name, version).store_page(store, page_id)
79	end	96	end

lib/docs/core/doc.rb+6−0

             false
           end
         end
+      rescue Docs::SetupError => error
+        puts "ERROR: #{error.message}"
+        false
       end
       def store_pages(store)
             false
           end
         end
+      rescue Docs::SetupError => error
+        puts "ERROR: #{error.message}"
+        false
       end
       private

lib/docs/core/requester.rb+8−4

 module Docs
   class Requester < Typhoeus::Hydra
+    include Instrumentable
     attr_reader :request_options
     def self.run(urls, options = {}, &block)
     def initialize(options = {})
       @request_options = options.extract!(:request_options)[:request_options].try(:dup) || {}
       options[:max_concurrency] ||= 20
-      options[:pipelining] = false
+      options[:pipelining] = 0
       super
     end
     end
     def handle_response(response)
-      on_response.each do |callback|
+      instrument 'handle_response.requester', url: response.url do
-        result = callback.call(response)
+        on_response.each do |callback|
-        result.each { |url| request(url) } if result.is_a? Array
+          result = callback.call(response)
+          result.each { |url| request(url) } if result.is_a?(Array)
+        end
       end
     end
   end

lib/docs/core/scrapers/file_scraper.rb+18−7

 module Docs
   class FileScraper < Scraper
+    SOURCE_DIRECTORY = File.expand_path '../../../../../docs', __FILE__
     Response = Struct.new :body, :url
     class << self
-      attr_accessor :dir
       def inherited(subclass)
         super
         subclass.base_url = base_url
-        subclass.dir = dir
       end
     end
     html_filters.push 'clean_local_urls'
+    def source_directory
+      @source_directory ||= File.join(SOURCE_DIRECTORY, self.class.path)
+    end
     private
+    def assert_source_directory_exists
+      unless Dir.exists?(source_directory)
+        raise SetupError, "The #{self.class.name} scraper requires the original documentation files to be stored in the \"#{source_directory}\" directory."
+      end
+    end
     def request_one(url)
-      Response.new read_file(file_path_for(url)), URL.parse(url)
+      assert_source_directory_exists
+      Response.new read_file(url_to_path(url)), URL.parse(url)
     end
     def request_all(urls)
+      assert_source_directory_exists
       queue = [urls].flatten
       until queue.empty?
         result = yield request_one(queue.shift)
       response.body.present?
     end
-    def file_path_for(url)
+    def url_to_path(url)
-      File.join self.class.dir, url.remove(base_url.to_s)
+      url.remove(base_url.to_s)
     end
     def read_file(path)
-      File.read(path)
+      File.read(File.join(source_directory, path))
     rescue
       instrument 'warn.doc', msg: "Failed to open file: #{path}"
       nil

lib/docs/core/url.rb+1−1

@@ -72,7 +72,7 @@ module Docs · 71 unmodified lines
72		72
73	if base == dest	73	if base == dest
74	''	74	''
75	elsif dest.start_with? File.join(base, '')	75	elsif dest.start_with?(::File.join(base, ''))
76	url.path[(path.length)..-1]	76	url.path[(path.length)..-1]
77	end	77	end
78	end	78	end

lib/docs/filters/cpp/entries.rb+2−0

           'Keywords'
         elsif subpath.start_with?('experimental')
           'Experimental libraries'
+        elsif subpath.start_with?('language/')
+          'Language'
         elsif type = at_css('.t-navbar > div:nth-child(4) > :first-child').try(:content)
           type.strip!
           type.remove! ' library'

lib/docs/filters/css/entries.rb+17−10

         'CSS_Background_and_Borders' => 'Backgrounds & Borders',
         'CSS_Columns' => 'Multi-column Layout',
         'CSS_Flexible_Box_Layout' => 'Flexible Box Layout',
+        'CSS_Fonts' => 'Fonts',
         'CSS_Grid_Layout' => 'Grid Layout',
         'CSS_Images' => 'Images',
         'CSS_Lists_and_Counters' => 'Lists',
         'CSS_Transforms' => 'Transforms',
         'Media_Queries' => 'Media Queries',
+        'filter-function' => 'Filter Effects',
         'transform-function' => 'Transforms',
         '@media' => 'Media Queries',
+        'overscroll' => 'Overscroll',
         'text-size-adjust' => 'Miscellaneous',
         'resolved_value' => 'Miscellaneous',
         'touch-action' => 'Miscellaneous',
       end
       def get_type
-        if slug.include?('-webkit') || slug.include?('-moz')
+        if slug.include?('-webkit') || slug.include?('-moz') || slug.include?('-ms')
           'Extensions'
         elsif type = TYPE_BY_PATH[slug.split('/').first]
           type
           'Pseudo-Elements'
         elsif name.start_with?(':')
           'Selectors'
+        elsif name.start_with?('display-')
+          'Display'
         else
           'Miscellaneous'
         end
       end
       STATUSES = {
-        'spec-Living' => 0,
+        'spec-Living'   => 0,
-        'spec-REC'    => 1,
+        'spec-REC'      => 1,
-        'spec-CR'     => 2,
+        'spec-CR'       => 2,
-        'spec-PR'     => 3,
+        'spec-PR'       => 3,
-        'spec-LC'     => 4,
+        'spec-LC'       => 4,
-        'spec-WD'     => 5,
+        'spec-WD'       => 5,
-        'spec-ED'     => 6
+        'spec-ED'       => 6,
+        'spec-Obsolete' => 7
       }
       PRIORITY_STATUSES = %w(spec-REC spec-CR)
       def get_spec
         return unless table = at_css('#Specifications + table') || css('.standard-table').last
         specs = table.css('tbody tr').to_a
         # [link, span]
         specs.map!     { |node| [node.at_css('> td:nth-child(1) > a'), node.at_css('> td:nth-child(2) > span')] }
         'shape' => [
           %w(rect() Syntax) ],
         'timing-function' => [
-          %w(cubic-bezier() The_cubic-bezier()_class_of_timing-functions),
+          %w(cubic-bezier()),
-          %w(steps() The_steps()_class_of_timing-functions),
+          %w(steps()),
           %w(linear linear),
           %w(ease ease),
           %w(ease-in ease-in),

lib/docs/filters/dom/clean_html.rb+1−1

@@ -30,7 +30,7 @@ module Docs · 29 unmodified lines
30	end	30	end
31		31
32	# Remove <div> wrapping .overheadIndicator	32	# Remove <div> wrapping .overheadIndicator
33	css('div > .overheadIndicator:first-child:last-child').each do \|node\|	33	css('div > .overheadIndicator:first-child:last-child', 'div > .blockIndicator:first-child:last-child').each do \|node\|
34	node.parent.replace(node)	34	node.parent.replace(node)
35	end	35	end
36		36

lib/docs/filters/dom/entries.rb+12−2

         'EXT_'                => 'WebGL',
         'OES_'                => 'WebGL',
         'WEBGL_'              => 'WebGL',
+        'Sensor API'          => 'Sensors',
         'Ambient Light'       => 'Ambient Light',
         'Audio'               => 'Audio',
         'Battery Status'      => 'Battery Status',
         'Encrypted Media Extensions' => 'Encrypted Media',
         'Fetch'               => 'Fetch',
         'File API'            => 'File',
+        'Fullscreen'          => 'Fullscreen',
         'Geolocation'         => 'Geolocation',
         'Geometry'            => 'Geometry',
         'High Resolution Time' => 'Performance',
         'Intersection'        => 'Intersection Observer',
+        'Keyboard'            => 'Keyboard',
         'Media Capabilities'  => 'Media',
         'Media Capture'       => 'Media',
         'Media Session'       => 'Media',
         'MIDI'                => 'Audio',
         'Navigation Timing'   => 'Performance',
         'Network Information' => 'Network Information',
+        'Orientation Sensor'  => 'Sensors',
         'Payment'             => 'Payments',
         'Performance Timeline' => 'Performance',
         'Pointer Events'      => 'Pointer Events',
         'Web App Manifest'    => 'Web App Manifest',
         'Budget'              => 'Budget',
         'Web Authentication'  => 'Authentication',
+        'Web Locks'           => 'Locks',
         'Web Workers'         => 'Web Workers',
         'WebGL'               => 'WebGL',
         'WebRTC'              => 'WebRTC',
         'WebUSB'              => 'WebUSB',
-        'WebVR'               => 'WebVR' }
+        'WebVR'               => 'WebVR',
+        'WebVTT'              => 'WebVTT' }
       TYPE_BY_NAME_STARTS_WITH = {
         'AbortController'     => 'Fetch',
         'Fetch'               => 'Fetch',
         'File'                => 'File',
         'GlobalEventHandlers' => 'GlobalEventHandlers',
+        'HMDVR'               => 'WebVR',
         'history'             => 'History',
         'HTML Drag'           => 'Drag & Drop',
         'HTML'                => 'Elements',
         'IDB'                 => 'IndexedDB',
+        'Keyboard'            => 'Keyboard',
         'location'            => 'Location',
         'navigator'           => 'Navigator',
         'MediaKeySession'     => 'Encrypted Media',
         'StyleSheet'          => 'CSS',
         'Stylesheet'          => 'CSS',
         'SVG'                 => 'SVG',
+        'TextTrack'           => 'WebVTT',
         'TimeRanges'          => 'Media',
         'timing'              => 'Performance',
         'Timing'              => 'Performance',
         'timing'        => 'Performance',
         'Timing'        => 'Performance',
         'udio'          => 'Audio',
+        'VRDevice'      => 'WebVR',
         'WebGL'         => 'WebGL',
         'WEBGL'         => 'WebGL',
         'WebRTC'        => 'WebRTC',
       def include_default_entry?
         return true if type == 'Console'
-        return true unless node = doc.at_css('.overheadIndicator')
+        return true unless node = doc.at_css('.overheadIndicator, .blockIndicator')
         node = node.parent while node.parent != doc
         return true if node.previous_element.try(:name).in?(%w(h2 h3))
         content = node.content

lib/docs/filters/html/entries.rb+1−1

@@ -28,7 +28,7 @@ module Docs · 27 unmodified lines
28		28
29	def include_default_entry?	29	def include_default_entry?
30	return false if %w(Element/Heading_Elements).include?(slug)	30	return false if %w(Element/Heading_Elements).include?(slug)
31	(node = doc.at_css '.overheadIndicator').nil? \|\| node.content.exclude?('not on a standards track')	31	(node = doc.at_css '.overheadIndicator, .blockIndicator').nil? \|\| node.content.exclude?('not on a standards track')
32	end	32	end
33		33
34	def additional_entries	34	def additional_entries

lib/docs/filters/javascript/clean_html.rb+2−2

@@ -11,12 +11,12 @@ module Docs · 10 unmodified lines
11		11
12	def other	12	def other
13	# Remove "style" attribute	13	# Remove "style" attribute
14	css('.inheritsbox', '.overheadIndicator').each do \|node\|	14	css('.inheritsbox', '.overheadIndicator', '.blockIndicator').each do \|node\|
15	node.remove_attribute 'style'	15	node.remove_attribute 'style'
16	end	16	end
17		17
18	# Remove <div> wrapping .overheadIndicator	18	# Remove <div> wrapping .overheadIndicator
19	css('div > .overheadIndicator:first-child:last-child').each do \|node\|	19	css('div > .overheadIndicator:first-child:last-child', 'div > .blockIndicator:first-child:last-child').each do \|node\|
20	node.parent.replace(node)	20	node.parent.replace(node)
21	end	21	end
22	end	22	end

lib/docs/filters/javascript/entries.rb+1−1

@@ -88,7 +88,7 @@ module Docs · 87 unmodified lines
88	end	88	end
89		89
90	def include_default_entry?	90	def include_default_entry?
91	node = doc.at_css '.overheadIndicator, .warning'	91	node = doc.at_css '.blockIndicator, .warning'
92		92
93	# Can't use :first-child because #doc is a DocumentFragment	93	# Can't use :first-child because #doc is a DocumentFragment
94	return true unless node && node.parent == doc && !node.previous_element	94	return true unless node && node.parent == doc && !node.previous_element

lib/docs/filters/mdn/clean_html.rb+90−0

@@ -14,6 +14,8 @@ module Docs · 13 unmodified lines
14	'#Quick_Links',	14	'#Quick_Links',
15	'hr']	15	'hr']
16		16
		17	BROWSER_UNNECESSARY_CLASS_REGEX = /\s*bc-browser[\w_-]+/
		18
17	def call	19	def call
18	css(*REMOVE_NODES).remove	20	css(*REMOVE_NODES).remove
19		21
@@ -61,6 +63,94 @@ module Docs · 41 unmodified lines
61	node.previous_element << node	63	node.previous_element << node
62	end	64	end
63		65
		66	# New compatibility tables
		67
		68	css('.bc-data #Legend + dl', '.bc-data #Legend', '.bc-data #Legend_2 + dl', '.bc-data #Legend_2', '.bc-browser-name').remove
		69
		70	css('abbr.only-icon[title="Full support"]',
		71	'abbr.only-icon[title="Partial support"]',
		72	'abbr.only-icon[title="No support"]',
		73	'abbr.only-icon[title="See implementation notes"]').remove
		74
		75	css('.bc-data .ic-altname', '.bc-data .ic-deprecated', '.bc-data .ic-non-standard', '.bc-data .ic-experimental').each do \|node\|
		76	node.parent.remove
		77	end
		78
		79	css('abbr.only-icon').each do \|node\|
		80	node.replace(node.content)
		81	end
		82
		83	css('.bc-table .bc-platforms td', '.bc-table .bc-browsers td').each do \|node\|
		84	node.name = 'th'
		85	end
		86
		87	css('.bc-data').each do \|node\|
		88	link = node.at_css('.bc-github-link')
		89	prev = node.previous_element
		90	prev = prev.previous_element until prev.name == 'h2'
		91	prev.add_child(link)
		92
		93	node.before(node.children).remove
		94	end
		95
		96	css('.bc-table').each do \|node\|
		97	desktop_table = node
		98
		99	mobile_table = node.dup
		100	desktop_table.after(mobile_table)
		101
		102	if desktop_table.at_css('.bc-platform-server')
		103	server_table = node.dup
		104	mobile_table.after(server_table)
		105	end
		106
		107	desktop_columns = desktop_table.at_css('th.bc-platform-desktop')['colspan'].to_i
		108	mobile_columns = desktop_table.at_css('th.bc-platform-mobile')['colspan'].to_i
		109
		110	desktop_table.css('.bc-platform-mobile').remove
		111	desktop_table.css('.bc-platform-server').remove
		112	desktop_table.css('.bc-browsers th').to_a[(desktop_columns + 1)..-1].each(&:remove)
		113	desktop_table.css('tr:not(.bc-platforms):not(.bc-browsers)').each do \|line\|
		114	line.css('td').to_a[(desktop_columns)..-1].each(&:remove)
		115	end
		116
		117	mobile_table.css('.bc-platform-desktop').remove
		118	mobile_table.css('.bc-platform-server').remove
		119	mobile_table.css('.bc-browsers th').to_a[1..(desktop_columns)].each(&:remove)
		120	mobile_table.css('.bc-browsers th').to_a[(mobile_columns + 1)..-1].each(&:remove)
		121	mobile_table.css('tr:not(.bc-platforms):not(.bc-browsers)').each do \|line\|
		122	line.css('td').to_a[0..(desktop_columns - 1)].each(&:remove)
		123	line.css('td').to_a[(mobile_columns)..-1].each(&:remove)
		124	end
		125
		126	if server_table
		127	server_table.css('.bc-platform-desktop').remove
		128	server_table.css('.bc-platform-mobile').remove
		129	server_table.css('.bc-browsers th').to_a[1..(desktop_columns + mobile_columns)].each(&:remove)
		130	server_table.css('tr:not(.bc-platforms):not(.bc-browsers)').each do \|line\|
		131	line.css('td').to_a[0..(desktop_columns + mobile_columns - 1)].each(&:remove)
		132	end
		133	end
		134	end
		135
		136	# Reduce page size to make the offline bundle smaller.
		137	css('.bc-supports-unknown').remove_attr('class')
		138	css('td[class="bc-platform"], th[class="bc-platform"]').remove_attr('class')
		139	css('td[class="bc-browser"], th[class="bc-browser"]').each do \|node\|
		140	class_name = node['class']
		141	class_name.remove!(BROWSER_UNNECESSARY_CLASS_REGEX)
		142
		143	if class_name.present?
		144	node['class'] = class_name
		145	else
		146	node.remove_attribute('class')
		147	end
		148	end
		149
		150	css('abbr[title*="Compatibility unknown"]').each do \|node\|
		151	node.before(node.children).remove
		152	end
		153
64	doc	154	doc
65	end	155	end
66	end	156	end

lib/docs/filters/rdoc/clean_html.rb+4−2

         end
         # Add class to differentiate Ruby code from C code
-        css('.method-source-code > pre').each do |node|
+        css('.method-source-code').each do |node|
-          node['class'] = node.at_css('.ruby-keyword') ? 'ruby' : 'c'
+          node.parent.prepend_child(node)
+          pre = node.at_css('pre')
+          pre['class'] = pre.at_css('.ruby-keyword') ? 'ruby' : 'c'
         end
         # Remove code highlighting

lib/docs/filters/rust/clean_html.rb+4−2

+# frozen_string_literal: true
 module Docs
   class Rust
     class CleanHtmlFilter < Filter
           node.remove
         end
-        css('h2 .important-traits', 'h3 .important-traits', 'h4 .important-traits').each do |node|
+        css('.important-traits').to_a.each_with_index do |node, index|
           content = node.at_css('.content.hidden .content')
           node.at_css('.content.hidden').replace(content) if content
-          node.parent.after(node)
+          node.parent.after(node) if node.parent.name.in?(%(h2 h3 h4))
         end
         css('code.content').each do |node|

lib/docs/filters/rust/entries.rb+5−6

           end
         else
           css('.method')
-            .select {|node| !node.at_css('.fnname').nil?}
+            .each_with_object({}) { |node, entries|
-            .map {|node|
+              name = node.at_css('.fnname').try(:content)
-              name = node.at_css('.fnname').content
+              next unless name
               name.prepend "#{self.name}::"
-              [name, node['id']]
+              entries[name] ||= [name, node['id']]
-            }
+            }.values
-            .uniq {|item| item[0]}
         end
       end
     end

lib/docs/scrapers/c.rb+0−1

@@ -1,7 +1,6 @@
1	module Docs	1	module Docs
2	class C < FileScraper	2	class C < FileScraper
3	self.type = 'c'	3	self.type = 'c'
4	self.dir = '/Users/Thibaut/DevDocs/Docs/c'
5	self.base_url = 'http://en.cppreference.com/w/c/'	4	self.base_url = 'http://en.cppreference.com/w/c/'
6	self.root_path = 'header.html'	5	self.root_path = 'header.html'
7		6

lib/docs/scrapers/cpp.rb+0−1

@@ -3,7 +3,6 @@ module Docs · 2 unmodified lines
3	self.name = 'C++'	3	self.name = 'C++'
4	self.slug = 'cpp'	4	self.slug = 'cpp'
5	self.type = 'c'	5	self.type = 'c'
6	self.dir = '/Users/Thibaut/DevDocs/Docs/cpp'
7	self.base_url = 'http://en.cppreference.com/w/cpp/'	6	self.base_url = 'http://en.cppreference.com/w/cpp/'
8	self.root_path = 'header.html'	7	self.root_path = 'header.html'
9		8

lib/docs/scrapers/dart.rb+0−2

     version '2' do
       self.release = '2.0.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Dart2'
       self.base_url = "https://api.dartlang.org/stable/#{release}/"
     end
     version '1' do
       self.release = '1.24.3'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Dart1'
       self.base_url = "https://api.dartlang.org/stable/#{release}/"
     end
   end

lib/docs/scrapers/django.rb+0−6

     version '2.1' do
       self.release = '2.1.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Django21'
       self.base_url = 'https://docs.djangoproject.com/en/2.1/'
     end
     version '2.0' do
       self.release = '2.0.7'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Django20'
       self.base_url = 'https://docs.djangoproject.com/en/2.0/'
     end
     version '1.11' do
       self.release = '1.11.9'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Django111'
       self.base_url = 'https://docs.djangoproject.com/en/1.11/'
     end
     version '1.10' do
       self.release = '1.10.8'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Django110'
       self.base_url = 'https://docs.djangoproject.com/en/1.10/'
     end
     version '1.9' do
       self.release = '1.9.13'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Django19'
       self.base_url = 'https://docs.djangoproject.com/en/1.9/'
     end
     version '1.8' do
       self.release = '1.8.18'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Django18'
       self.base_url = 'https://docs.djangoproject.com/en/1.8/'
     end
   end

lib/docs/scrapers/erlang.rb+0−4

     version '21' do
       self.release = '21.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Erlang21'
     end
     version '20' do
       self.release = '20.3'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Erlang20'
     end
     version '19' do
       self.release = '19.3'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Erlang19'
     end
     version '18' do
       self.release = '18.3'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Erlang18'
     end
   end
 end

lib/docs/scrapers/gnu/gcc.rb+0−8

     version '7' do
       self.release = '7.3.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gcc7'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gcc/"
     end
     version '7 CPP' do
       self.release = '7.3.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gcpp7'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/cpp/"
       options[:replace_paths] = CPP_PATHS
     version '6' do
       self.release = '6.4.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gcc6'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gcc/"
       options[:root_title] = 'Using the GNU Compiler Collection (GCC)'
     version '6 CPP' do
       self.release = '6.4.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gcpp6'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/cpp/"
       options[:replace_paths] = CPP_PATHS
     version '5' do
       self.release = '5.4.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gcc5'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gcc/"
       options[:root_title] = 'Using the GNU Compiler Collection (GCC)'
     version '5 CPP' do
       self.release = '5.4.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gcpp5'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/cpp/"
       options[:replace_paths] = CPP_PATHS
     version '4' do
       self.release = '4.9.3'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gcc4'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gcc/"
       options[:root_title] = 'Using the GNU Compiler Collection (GCC)'
     version '4 CPP' do
       self.release = '4.9.3'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gcpp4'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/cpp/"
       options[:replace_paths] = CPP_PATHS

lib/docs/scrapers/gnu/gnu_fortran.rb+0−4

     version '7' do
       self.release = '7.3.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gfortran7'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/"
     end
     version '6' do
       self.release = '6.4.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gfortran6'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/"
     end
     version '5' do
       self.release = '5.4.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gfortran5'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/"
     end
     version '4' do
       self.release = '4.9.3'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/gfortran4'
       self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/"
     end
   end

lib/docs/scrapers/nokogiri2.rb+8−4

 module Docs
   class Nokogiri2 < Rdoc
+    # Instructions:
+    #   1. Download the latest release at https://github.com/sparklemotion/nokogiri/releases
+    #   2. Run "bundle install && bundle exec rake docs" (in the Nokogiri directory)
+    #   4. Copy the "doc" directory to "docs/nokgiri"
     self.name = 'Nokogiri'
     self.slug = 'nokogiri'
-    self.release = '1.8.1'
+    self.release = '1.9.0'
-    self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Nokogiri'
     html_filters.replace 'rdoc/entries', 'nokogiri2/entries'
     options[:only_patterns] = [/\ANokogiri/, /\AXSD/]
     options[:attribution] = <<-HTML
-      &copy; 2008&ndash;2017 Aaron Patterson, Mike Dalessio, Charles Nutter, Sergio Arbeo<br>
+      &copy; 2008&ndash;2018 Aaron Patterson, Mike Dalessio, Charles Nutter, Sergio Arbeo,<br>
-      Patrick Mahoney, Yoko Harada, Akinori Musha, John Shahid<br>
+      Patrick Mahoney, Yoko Harada, Akinori Musha, John Shahid, Lars Kanis<br>
       Licensed under the MIT License.
     HTML
   end

lib/docs/scrapers/numpy.rb+0−1

@@ -2,7 +2,6 @@ module Docs · 1 unmodified line
2	class Numpy < FileScraper	2	class Numpy < FileScraper
3	self.name = 'NumPy'	3	self.name = 'NumPy'
4	self.type = 'sphinx'	4	self.type = 'sphinx'
5	self.dir = '/Users/Thibaut/DevDocs/Docs/numpy/reference/'
6	self.root_path = 'index.html'	5	self.root_path = 'index.html'
7	self.links = {	6	self.links = {
8	home: 'http://www.numpy.org/',	7	home: 'http://www.numpy.org/',

lib/docs/scrapers/openjdk.rb+2−3

 module Docs
   class Openjdk < FileScraper
+    # Downloaded from packages.debian.org/sid/openjdk-8-doc
+    # Extracting subdirectory /usr/share/doc/openjdk-8-jre-headless/api
     self.name = 'OpenJDK'
     self.type = 'openjdk'
     self.root_path = 'overview-summary.html'
-    # Downloaded from packages.debian.org/sid/openjdk-8-doc
-    # Extracting subdirectory /usr/share/doc/openjdk-8-jre-headless/api
-    self.dir = '/Users/Thibaut/DevDocs/Docs/OpenJDK'
     html_filters.insert_after 'internal_urls', 'openjdk/clean_urls'
     html_filters.push 'openjdk/entries', 'openjdk/clean_html'

lib/docs/scrapers/perl.rb+0−1

@@ -2,7 +2,6 @@ module Docs · 1 unmodified line
2	class Perl < FileScraper	2	class Perl < FileScraper
3	self.name = 'Perl'	3	self.name = 'Perl'
4	self.type = 'perl'	4	self.type = 'perl'
5	self.dir = '/Users/Thibaut/DevDocs/Docs/Perl'
6	self.root_path = 'index.html'	5	self.root_path = 'index.html'
7	self.links = {	6	self.links = {
8	home: 'https://www.perl.org/'	7	home: 'https://www.perl.org/'

lib/docs/scrapers/php.rb+2−3

 module Docs
   class Php < FileScraper
+    # Downloaded from php.net/download-docs.php
     include FixInternalUrlsBehavior
     self.name = 'PHP'
       code: 'https://git.php.net/?p=php-src.git;a=summary'
     }
-    # Downloaded from php.net/download-docs.php
-    self.dir = '/Users/Thibaut/DevDocs/Docs/PHP'
     html_filters.push 'php/internal_urls', 'php/entries', 'php/clean_html', 'title'
     text_filters.push 'php/fix_urls'

lib/docs/scrapers/python.rb+4−8

       Licensed under the PSF License.
     HTML
-    version '3.7' do
+    version '3.7' do # docs.python.org/3.7/download.html
       self.release = '3.7.0'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Python37' # docs.python.org/3.7/download.html
       self.base_url = 'https://docs.python.org/3.7/'
       html_filters.push 'python/entries_v3', 'sphinx/clean_html', 'python/clean_html'
     end
-    version '3.6' do
+    version '3.6' do # docs.python.org/3.6/download.html
       self.release = '3.6.6'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Python36' # docs.python.org/3.6/download.html
       self.base_url = 'https://docs.python.org/3.6/'
       html_filters.push 'python/entries_v3', 'sphinx/clean_html', 'python/clean_html'
     end
-    version '3.5' do
+    version '3.5' do # docs.python.org/3.5/download.html
       self.release = '3.5.3'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Python35' # docs.python.org/3.5/download.html
       self.base_url = 'https://docs.python.org/3.5/'
       html_filters.push 'python/entries_v3', 'sphinx/clean_html', 'python/clean_html'
     end
-    version '2.7' do
+    version '2.7' do # docs.python.org/2.7/download.html
       self.release = '2.7.13'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/Python27' # docs.python.org/2.7/download.html
       self.base_url = 'https://docs.python.org/2.7/'
       html_filters.push 'python/entries_v2', 'sphinx/clean_html', 'python/clean_html'

lib/docs/scrapers/rdoc/minitest.rb+7−2

 module Docs
   class Minitest < Rdoc
+    # Instructions:
+    #   1. Run "gem update rdoc hoe"
+    #   2. Download the source code at https://github.com/seattlerb/minitest
+    #   3. Run "rake docs" (in the Minitest directory)
+    #   4. Copy the "docs" directory to "docs/minitest"
     self.name = 'Ruby / Minitest'
     self.slug = 'minitest'
-    self.release = '5.10.3'
+    self.release = '5.11.3'
-    self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Minitest' # rake docs
     self.links = {
       code: 'https://github.com/seattlerb/minitest'
     }

lib/docs/scrapers/rdoc/rails.rb+10−3

 module Docs
   class Rails < Rdoc
+    # Instructions:
+    #   1. Download a release at https://github.com/rails/rails/releases
+    #   2. Open "railties/lib/rails/api/task.rb" and comment out any code related to sdoc ("configure_sdoc")
+    #   3. Run "bundle install --without db && bundle exec rake rdoc" (in the Rails directory)
+    #   4. Run "cd guides && bundle exec rake guides:generate:html"
+    #   5. Copy the "guides/output" directory to "html/guides"
+    #   6. Copy the "html" directory to "docs/rails~[version]"
     include FixInternalUrlsBehavior
     self.name = 'Ruby on Rails'
     self.slug = 'rails'
-    self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Rails'
     self.initial_paths = %w(guides/index.html)
     self.links = {
       home: 'http://rubyonrails.org/',
     end
     version '5.2' do
-      self.release = '5.2.0'
+      self.release = '5.2.2'
     end
     version '5.1' do
     end
     version '4.2' do
-      self.release = '4.2.10'
+      self.release = '4.2.11'
     end
     version '4.1' do

lib/docs/scrapers/rdoc/ruby.rb+8−19

 module Docs
   class Ruby < Rdoc
-    # Generated with:
+    # Instructions:
-    #   ./configure && make html
+    #   1. Download Ruby's source code
-    # or:
+    #   2. Run "./configure && make html" (in the Ruby directory)
-    #   rdoc \
+    #   3. Copy the ".ext/html" directory to "docs/ruby~[version]"
-    #     --root . \
-    #     --page-dir doc \
-    #     --encoding=UTF-8 \
-    #     --visibility=public \
-    #     --format=darkfish \
-    #     --no-line-numbers \
-    #     --op html .
     include FixInternalUrlsBehavior
     HTML
     version '2.5' do
-      self.release = '2.5.0'
+      self.release = '2.5.3'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Ruby25'
     end
     version '2.4' do
-      self.release = '2.4.3'
+      self.release = '2.4.5'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Ruby24'
     end
     version '2.3' do
-      self.release = '2.3.6'
+      self.release = '2.3.8'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Ruby23'
     end
     version '2.2' do
-      self.release = '2.2.9'
+      self.release = '2.2.10'
-      self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Ruby22'
     end
   end
 end

lib/docs/scrapers/rust.rb+4−1

+# frozen_string_literal: true
 module Docs
   class Rust < UrlScraper
     self.type = 'rust'
-    self.release = '1.29.1'
+    self.release = '1.30.1'
     self.base_url = 'https://doc.rust-lang.org/'
     self.root_path = 'book/second-edition/index.html'
     self.initial_paths = %w(
     options[:fix_urls] = ->(url) do
       url.sub! %r{(#{Rust.base_url}.+/)\z}, '\1index.html'
       url.sub! '/unicode/u_str', '/unicode/str/'
+      url.sub! '/std/std/', '/std/'
       url
     end

lib/docs/scrapers/sqlite.rb+0−1

@@ -3,7 +3,6 @@ module Docs · 2 unmodified lines
3	self.name = 'SQLite'	3	self.name = 'SQLite'
4	self.type = 'sqlite'	4	self.type = 'sqlite'
5	self.release = '3.25.2'	5	self.release = '3.25.2'
6	self.dir = '/Users/Thibaut/DevDocs/Docs/sqlite/'
7	self.base_url = 'https://sqlite.org/'	6	self.base_url = 'https://sqlite.org/'
8	self.root_path = 'docs.html'	7	self.root_path = 'docs.html'
9	self.initial_paths = %w(keyword_index.html)	8	self.initial_paths = %w(keyword_index.html)

lib/docs/subscribers/requester_subscriber.rb+13−0

@@ -0,0 +1,13 @@
	1	# frozen_string_literal: true
	2
	3	module Docs
	4	class RequesterSubscriber < Subscriber
	5	self.namespace = 'requester'
	6
	7	def handle_response(event)
	8	if event.duration > 10_000
	9	log "WARN: #{format_url event.payload[:url]} was slow to process (#{(event.duration / 1000).round}s)"
	10	end
	11	end
	12	end
	13	end

lib/tasks/docs.thor+74−13

@@ -12,15 +12,29 @@ class DocsCLI < Thor · 11 unmodified lines
12	end	12	end
13		13
14	desc 'list', 'List available documentations'	14	desc 'list', 'List available documentations'
		15	option :packaged, type: :boolean
15	def list	16	def list
16	output = Docs.all.flat_map do \|doc\|	17	if options[:packaged]
17	name = doc.to_s.demodulize.underscore	18	slugs = Dir[File.join(Docs.store_path, '*.tar.gz')].map { \|f\| File.basename(f, '.tar.gz') }
18	if doc.versioned?	19	names = find_docs_by_slugs(slugs).map do \|doc\|
19	doc.versions.map { \|_doc\| "#{name}@#{_doc.version}" }	20	name = if doc.version?
20	else	21	"#{doc.superclass.to_s.demodulize.underscore}@#{doc.version}"
21	name	22	else
		23	doc.to_s.demodulize.underscore
		24	end
22	end	25	end
23	end.join("\n")	26	else
		27	names = Docs.all.flat_map do \|doc\|
		28	name = doc.to_s.demodulize.underscore
		29	if doc.versioned?
		30	doc.versions.map { \|_doc\| "#{name}@#{_doc.version}" }
		31	else
		32	name
		33	end
		34	end
		35	end
		36
		37	output = names.join("\n")
24		38
25	require 'tty-pager'	39	require 'tty-pager'
26	TTY::Pager.new.page(output)	40	TTY::Pager.new.page(output)
@@ -39,7 +53,7 @@ class DocsCLI < Thor · 12 unmodified lines
39	Docs.install_report :store if options[:verbose]	53	Docs.install_report :store if options[:verbose]
40	if options[:debug]	54	if options[:debug]
41	GC.disable	55	GC.disable
42	Docs.install_report :filter, :request	56	Docs.install_report :filter, :request, :doc
43	end	57	end
44		58
45	if Docs.generate_page(name, options[:version], path)	59	if Docs.generate_page(name, options[:version], path)
@@ -62,7 +76,7 @@ class DocsCLI < Thor · 16 unmodified lines
62	Docs.rescue_errors = true	76	Docs.rescue_errors = true
63	Docs.install_report :store if options[:verbose]	77	Docs.install_report :store if options[:verbose]
64	Docs.install_report :scraper if options[:debug]	78	Docs.install_report :scraper if options[:debug]
65	Docs.install_report :progress_bar, :doc, :image if $stdout.tty?	79	Docs.install_report :progress_bar, :doc, :image, :requester if $stdout.tty?
66		80
67	require 'unix_utils' if options[:package]	81	require 'unix_utils' if options[:package]
68		82
@@ -149,15 +163,55 @@ class DocsCLI < Thor · 80 unmodified lines
149	option :dryrun, type: :boolean	163	option :dryrun, type: :boolean
150	option :packaged, type: :boolean	164	option :packaged, type: :boolean
151	def upload(*names)	165	def upload(*names)
152	names = Dir[File.join(Docs.store_path, '*.tar.gz')].map { \|f\| File.basename(f, '.tar.gz') } if options[:packaged]	166	require 'net/sftp'
153	docs = find_docs(names)	167
		168	if options[:packaged]
		169	slugs = Dir[File.join(Docs.store_path, '*.tar.gz')].map { \|f\| File.basename(f, '.tar.gz') }
		170	docs = find_docs_by_slugs(slugs)
		171	else
		172	docs = find_docs(names)
		173	end
		174
154	assert_docs(docs)	175	assert_docs(docs)
		176
		177	# Verify files are present
		178	docs.each do \|doc\|
		179	unless Dir.exists?(File.join(Docs.store_path, doc.path))
		180	puts "ERROR: directory #{File.join(Docs.store_path, doc.path)} not found."
		181	return
		182	end
		183
		184	unless File.exists?(File.join(Docs.store_path, "#{doc.path}.tar.gz"))
		185	puts "ERROR: package for '#{doc.slug}' documentation not found. Run 'thor docs:package #{doc.slug}' to create it."
		186	return
		187	end
		188	end
		189
		190	# Sync files with S3 (used by the web app)
		191	puts '[S3] Begin syncing.'
155	docs.each do \|doc\|	192	docs.each do \|doc\|
156	puts "Syncing #{doc.path}..."	193	puts "[S3] Syncing #{doc.path}..."
157	cmd = "aws s3 sync #{File.join(Docs.store_path, doc.path)} s3://docs.devdocs.io/#{doc.path} --delete"	194	cmd = "aws s3 sync #{File.join(Docs.store_path, doc.path)} s3://devdocs-assets/#{doc.path} --delete --profile devdocs"
158	cmd << ' --dryrun' if options[:dryrun]	195	cmd << ' --dryrun' if options[:dryrun]
159	system(cmd)	196	system(cmd)
160	end	197	end
		198	puts '[S3] Done syncing.'
		199
		200	# Upload packages to dl.devdocs.io (used by the "thor docs:download" command)
		201	puts '[MaxCDN] Begin uploading.'
		202	Net::SFTP.start('ftp.devdocs-dl.devdocs.netdna-cdn.com', ENV['DEVDOCS_DL_USERNAME'], password: ENV['DEVDOCS_DL_PASSWORD']) do \|sftp\|
		203	docs.each do \|doc\|
		204	filename = "#{doc.path}.tar.gz"
		205	print "[MaxCDN] Uploading #{filename}..."
		206	if options[:dryrun]
		207	print "\n"
		208	else
		209	sftp.upload! File.join(Docs.store_path, filename), File.join('', 'public_html', filename)
		210	print " OK\n"
		211	end
		212	end
		213	end
		214	puts '[MaxCDN] Done uploading.'
161	end	215	end
162		216
163	desc 'commit', '[private]'	217	desc 'commit', '[private]'
@@ -222,6 +276,13 @@ class DocsCLI < Thor · 58 unmodified lines
222	end	276	end
223	end	277	end
224		278
		279	def find_docs_by_slugs(slugs)
		280	slugs.flat_map do \|slug\|
		281	slug, version = slug.split(/~/)
		282	Docs.find_by_slug(slug, version)
		283	end
		284	end
		285
225	def assert_docs(docs)	286	def assert_docs(docs)
226	if docs.empty?	287	if docs.empty?
227	puts 'ERROR: called with no arguments.'	288	puts 'ERROR: called with no arguments.'

public/docs/docs.json+0−1

@@ -1 +0,0 @@
1	[]

public/favicon.pxm+0−0

Binary file not shown.

public/favicon@2x.pxm+0−0

Binary file not shown.

public/icons/docs/css/CSS3.sketch/Data+0−0

Binary file not shown.

public/icons/docs/css/CSS3.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/css/CSS3.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/css/CSS3.sketch/fonts+0−0

Empty file added.

public/icons/docs/css/CSS3.sketch/version+1−0

@@ -0,0 +1 @@
		1	10

public/icons/docs/dom/DOM.sketch/Data+0−0

Binary file not shown.

public/icons/docs/dom/DOM.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/dom/DOM.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/dom/DOM.sketch/fonts+0−0

Empty file added.

public/icons/docs/dom/DOM.sketch/version+1−0

@@ -0,0 +1 @@
		1	10

public/icons/docs/dom_events/DOM_events.sketch/Data+0−0

Binary file not shown.

public/icons/docs/dom_events/DOM_events.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/dom_events/DOM_events.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/dom_events/DOM_events.sketch/fonts+0−0

Empty file added.

public/icons/docs/dom_events/DOM_events.sketch/version+1−0

@@ -0,0 +1 @@
		1	10

public/icons/docs/express/16.pxm+0−0

Binary file not shown.

public/icons/docs/express/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/html/HTML5.sketch/Data+0−0

Binary file not shown.

public/icons/docs/html/HTML5.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/html/HTML5.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/html/HTML5.sketch/fonts+0−0

Empty file added.

public/icons/docs/html/HTML5.sketch/version+1−0

@@ -0,0 +1 @@
		1	10

public/icons/docs/http/16.pxm+0−0

Binary file not shown.

public/icons/docs/http/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/javascript/16.pxm+0−0

Binary file not shown.

public/icons/docs/javascript/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/knockout/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/less/less.pxm+0−0

Binary file not shown.

public/icons/docs/moment/moment.sketch/Data+0−0

Binary file not shown.

public/icons/docs/moment/moment.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/moment/moment.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/moment/moment.sketch/fonts+0−0

Empty file added.

public/icons/docs/moment/moment.sketch/metadata+14−0

@@ -0,0 +1,14 @@
	1	<?xml version="1.0" encoding="UTF-8"?>
	2	<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
	3	<plist version="1.0">
	4	<dict>
	5	<key>app</key>
	6	<string>com.bohemiancoding.sketch</string>
	7	<key>build</key>
	8	<integer>5302</integer>
	9	<key>commit</key>
	10	<string>9460a4bc62af5e9ba50dd4143578fd9401710ce5</string>
	11	<key>version</key>
	12	<integer>18</integer>
	13	</dict>
	14	</plist>

public/icons/docs/moment/moment.sketch/version+1−0

@@ -0,0 +1 @@
		1	18

public/icons/docs/nokogiri/icon.pxm+0−0

Binary file not shown.

public/icons/docs/php/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/rails/rails.pxm+0−0

Binary file not shown.

public/icons/docs/sass/sass.pxm+0−0

Binary file not shown.

public/icons/docs/support_tables/16.pxm+0−0

Binary file not shown.

public/icons/docs/support_tables/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/xpath/XPath.sketch/Data+0−0

Binary file not shown.

public/icons/docs/xpath/XPath.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/xpath/XPath.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/xpath/XPath.sketch/metadata+18−0

@@ -0,0 +1,18 @@
	1	<?xml version="1.0" encoding="UTF-8"?>
	2	<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
	3	<plist version="1.0">
	4	<dict>
	5	<key>app</key>
	6	<string>com.bohemiancoding.sketch</string>
	7	<key>build</key>
	8	<integer>5355</integer>
	9	<key>commit</key>
	10	<string>b7d299b0a34651d1a0e066786b75aa36168d5809</string>
	11	<key>fonts</key>
	12	<array/>
	13	<key>length</key>
	14	<integer>22373</integer>
	15	<key>version</key>
	16	<integer>18</integer>
	17	</dict>
	18	</plist>

public/icons/docs/xpath/XPath.sketch/version+1−0

@@ -0,0 +1 @@
		1	18

public/images/apple-icon.pxm+0−0

Binary file not shown.

public/images/fluid-icon.pxm+0−0

Binary file not shown.

public/images/icon.pxm+0−0

Binary file not shown.

public/images/webapp-icon-192.png+0−0

Binary file not shown.

public/images/webapp-icon-small.pxm+0−0

Binary file not shown.

public/manifest.json+6−0

   "description": "API Documentation Browser",
   "start_url": "/",
   "display": "standalone",
+  "background_color": "#EEEEEE",
   "icons": [
     {
       "src": "/images/webapp-icon-32.png",
       "sizes": "128x128",
       "type": "image/png"
     },
+    {
+      "src": "/images/webapp-icon-192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
     {
       "src": "/images/webapp-icon-256.png",
       "sizes": "256x256",

test/app_test.rb+5−81

@@ -21,6 +21,11 @@ class AppTest < MiniTest::Spec · 20 unmodified lines
21	assert_equal 'https://example.com/test?q=1', last_response['Location']	21	assert_equal 'https://example.com/test?q=1', last_response['Location']
22	end	22	end
23		23
		24	it 'returns HSTS header' do
		25	get 'https://example.com/test'
		26	assert_equal 'max-age=31536000; includeSubDomains', last_response['Strict-Transport-Security']
		27	end
		28
24	describe "/" do	29	describe "/" do
25	it "works" do	30	it "works" do
26	get '/'	31	get '/'
@@ -38,35 +43,6 @@ class AppTest < MiniTest::Spec · 11 unmodified lines
38	assert last_response.redirect?	43	assert last_response.redirect?
39	assert_equal 'https://example.org/', last_response['Location']	44	assert_equal 'https://example.org/', last_response['Location']
40	end	45	end
41
42	it "sets default size" do
43	get '/'
44	assert_includes last_response.body, 'data-size="20rem"'
45	end
46
47	it "sets size from cookie" do
48	set_cookie('size=42')
49	get '/'
50	assert_includes last_response.body, 'data-size="42px"'
51	end
52
53	it "sets layout from cookie" do
54	set_cookie('layout=foo')
55	get '/'
56	assert_includes last_response.body, '<body class="foo">'
57	end
58
59	it "sets the <html> theme from cookie" do
60	get '/'
61	assert_match %r{<html [^>]class="[^\"]_theme-default}, last_response.body
62	refute_includes last_response.body, '_theme-dark'
63
64	set_cookie('dark=1')
65
66	get '/'
67	assert_match %r{<html [^>]class="[^\"]_theme-dark}, last_response.body
68	refute_includes last_response.body, '_theme-default'
69	end
70	end	46	end
71		47
72	describe "/[static-page]" do	48	describe "/[static-page]" do
@@ -101,58 +77,6 @@ class AppTest < MiniTest::Spec · 28 unmodified lines
101	end	77	end
102	end	78	end
103		79
104	describe "/manifest.appcache" do
105	it "works" do
106	get '/manifest.appcache'
107	assert last_response.ok?
108	end
109
110	it "works with cookie" do
111	set_cookie('docs=css/html~5')
112	get '/manifest.appcache'
113	assert last_response.ok?
114	assert_includes last_response.body, '/css/index.json?1420139788'
115	assert_includes last_response.body, '/html~5/index.json?1420139791'
116	end
117
118	it "ignores invalid docs in the cookie" do
119	set_cookie('docs=foo')
120	get '/manifest.appcache'
121	assert last_response.ok?
122	refute_includes last_response.body, 'foo'
123	end
124
125	it "has the word 'default' when no 'dark' cookie is set" do
126	get '/manifest.appcache'
127	assert_includes last_response.body, '# default'
128	refute_includes last_response.body, '# dark'
129	end
130
131	it "has the word 'dark' when the cookie is set" do
132	set_cookie('dark=1')
133	get '/manifest.appcache'
134	assert_includes last_response.body, '# dark'
135	refute_includes last_response.body, '# default'
136	end
137
138	it "sets default size" do
139	get '/manifest.appcache'
140	assert_includes last_response.body, '20rem'
141	end
142
143	it "sets size from cookie" do
144	set_cookie('size=42')
145	get '/manifest.appcache'
146	assert_includes last_response.body, '42px'
147	end
148
149	it "sets layout from cookie" do
150	set_cookie('layout=foo_layout')
151	get '/manifest.appcache'
152	assert_includes last_response.body, 'foo_layout'
153	end
154	end
155
156	describe "/[doc]" do	80	describe "/[doc]" do
157	it "renders when the doc exists and isn't enabled" do	81	it "renders when the doc exists and isn't enabled" do
158	set_cookie('docs=html~5')	82	set_cookie('docs=html~5')

test/lib/docs/core/scrapers/file_scraper_test.rb+89−47

@@ -2,16 +2,23 @@ require 'test_helper' · 1 unmodified line
2	require 'docs'	2	require 'docs'
3		3
4	class FileScraperTest < MiniTest::Spec	4	class FileScraperTest < MiniTest::Spec
		5	ROOT_PATH = File.expand_path('../../../../../../', __FILE__)
		6
5	class Scraper < Docs::FileScraper	7	class Scraper < Docs::FileScraper
6	self.dir = '/'
7	self.html_filters = Docs::FilterStack.new	8	self.html_filters = Docs::FilterStack.new
8	self.text_filters = Docs::FilterStack.new	9	self.text_filters = Docs::FilterStack.new
		10
		11	version 'version' do; end
9	end	12	end
10		13
11	let :scraper do	14	let :scraper do
12	Scraper.new	15	Scraper.new
13	end	16	end
14		17
		18	let :versioned_scraper do
		19	Scraper.versions.first.new
		20	end
		21
15	let :response do	22	let :response do
16	OpenStruct.new body: 'body', url: Docs::URL.parse(Scraper.base_url)	23	OpenStruct.new body: 'body', url: Docs::URL.parse(Scraper.base_url)
17	end	24	end
@@ -22,9 +29,16 @@ class FileScraperTest < MiniTest::Spec · 4 unmodified lines
22	end	29	end
23	end	30	end
24		31
		32	describe "#source_directory" do
		33	it "returns the directory at docs/[slug]" do
		34	assert_equal File.join(ROOT_PATH, 'docs', 'scraper'), scraper.source_directory
		35	assert_equal File.join(ROOT_PATH, 'docs', 'scraper~version'), versioned_scraper.source_directory
		36	end
		37	end
		38
25	describe "#request_one" do	39	describe "#request_one" do
26	let :path do	40	let :path do
27	File.join(Scraper.dir, 'path')	41	'path'
28	end	42	end
29		43
30	let :result do	44	let :result do
@@ -35,20 +49,34 @@ class FileScraperTest < MiniTest::Spec · 4 unmodified lines
35	stub(scraper).read_file	49	stub(scraper).read_file
36	end	50	end
37		51
38	it "reads a file" do	52	context "when the source directory doesn't exist" do
39	mock(scraper).read_file(path)	53	it "raises an error" do
40	result	54	assert_raises Docs::SetupError do
		55	result
		56	end
		57	end
41	end	58	end
42		59
43	describe "the returned response object" do	60	context "when the source directory exists" do
44	it "has a #body" do	61	before do
45	stub(scraper).read_file { 'body' }	62	stub(scraper).assert_source_directory_exists
46	assert_equal 'body', result.body	63	end
		64
		65	it "reads a file" do
		66	mock(scraper).read_file(path)
		67	result
47	end	68	end
48		69
49	it "has a #url" do	70	describe "the returned response object" do
50	assert_equal path, result.url.to_s	71	it "has a #body" do
51	assert_instance_of Docs::URL, result.url	72	stub(scraper).read_file { 'body' }
		73	assert_equal 'body', result.body
		74	end
		75
		76	it "has a #url" do
		77	assert_equal path, result.url.to_s
		78	assert_instance_of Docs::URL, result.url
		79	end
52	end	80	end
53	end	81	end
54	end	82	end
@@ -58,49 +86,63 @@ class FileScraperTest < MiniTest::Spec · 3 unmodified lines
58	%w(one two)	86	%w(one two)
59	end	87	end
60		88
61	it "requests the given url" do	89	context "when the source directory doesn't exist" do
62	mock(scraper).request_one('url')	90	it "raises an error" do
63	scraper.send(:request_all, 'url') {}	91	assert_raises Docs::SetupError do
64	end	92	scraper.send(:request_all, urls) {}
65		93	end
66	it "requests the given urls" do	94	end
67	requests = []
68	stub(scraper).request_one { \|url\| requests << url; nil }
69	scraper.send(:request_all, urls) {}
70	assert_equal urls, requests
71	end
72
73	it "yields the responses" do
74	responses = []
75	stub(scraper).request_one { \|url\| urls.index(url) }
76	scraper.send(:request_all, urls) { \|response\| responses << response; nil }
77	assert_equal (0...urls.length).to_a, responses
78	end	95	end
79		96
80	context "when the block returns an array" do	97	context "when the source directory exists" do
81	let :next_urls do	98	before do
82	%w(three four)	99	stub(scraper).assert_source_directory_exists
83	end	100	end
84		101
85	let :all_urls do	102	it "requests the given url" do
86	urls + %w(three four)	103	mock(scraper).request_one('url')
		104	scraper.send(:request_all, 'url') {}
87	end	105	end
88		106
89	it "requests the returned urls" do	107	it "requests the given urls" do
90	requests = []	108	requests = []
91	stub(scraper).request_one { \|url\| requests << url; url }	109	stub(scraper).request_one { \|url\| requests << url; nil }
92	scraper.send(:request_all, urls) { [next_urls.shift].compact }	110	scraper.send(:request_all, urls) {}
93	assert_equal all_urls, requests	111	assert_equal urls, requests
94	end	112	end
95		113
96	it "yields their responses" do	114	it "yields the responses" do
97	responses = []	115	responses = []
98	stub(scraper).request_one { \|url\| all_urls.index(url) }	116	stub(scraper).request_one { \|url\| urls.index(url) }
99	scraper.send :request_all, urls do \|response\|	117	scraper.send(:request_all, urls) { \|response\| responses << response; nil }
100	responses << response	118	assert_equal (0...urls.length).to_a, responses
101	[next_urls.shift].compact	119	end
		120
		121	context "when the block returns an array" do
		122	let :next_urls do
		123	%w(three four)
		124	end
		125
		126	let :all_urls do
		127	urls + %w(three four)
		128	end
		129
		130	it "requests the returned urls" do
		131	requests = []
		132	stub(scraper).request_one { \|url\| requests << url; url }
		133	scraper.send(:request_all, urls) { [next_urls.shift].compact }
		134	assert_equal all_urls, requests
		135	end
		136
		137	it "yields their responses" do
		138	responses = []
		139	stub(scraper).request_one { \|url\| all_urls.index(url) }
		140	scraper.send :request_all, urls do \|response\|
		141	responses << response
		142	[next_urls.shift].compact
		143	end
		144	assert_equal (0...all_urls.length).to_a, responses
102	end	145	end
103	assert_equal (0...all_urls.length).to_a, responses
104	end	146	end
105	end	147	end
106	end	148	end
@@ -126,13 +168,13 @@ class FileScraperTest < MiniTest::Spec · 19 unmodified lines
126	scraper.send :read_file, 'file'	168	scraper.send :read_file, 'file'
127	end	169	end
128		170
129	it "returns the file's content when the file exists" do	171	it "returns the file's content when the file exists in the source directory" do
130	stub(File).read('file') { 'content' }	172	stub(File).read(File.join(ROOT_PATH, 'docs', 'scraper', 'file')) { 'content' }
131	assert_equal 'content', result	173	assert_equal 'content', result
132	end	174	end
133		175
134	it "returns nil when the file doesn't exist" do	176	it "returns nil when the file doesn't exist" do
135	stub(File).read('file') { raise }	177	stub(File).read(File.join(ROOT_PATH, 'docs', 'scraper', 'file')) { raise }
136	assert_nil result	178	assert_nil result
137	end	179	end
138	end	180	end

views/app.erb+1−13

@@ -28,13 +28,7 @@ · 27 unmodified lines
28	</nav>	28	</nav>
29	</header>	29	</header>
30	<section class="_sidebar" tabindex="-1">	30	<section class="_sidebar" tabindex="-1">
31	<div class="_list" role="navigation">	31	<div class="_list" role="navigation"></div>
32	<% unless @doc %>
33	<% App.docs.each do \|slug, doc\| %>
34	<a href="/<%= slug %>/" class="_list-item"><%= doc['full_name'] %></a>
35	<% end %>
36	<% end %>
37	</div>
38	</section>	32	</section>
39	<div class="_container" role="document">	33	<div class="_container" role="document">
40	<main class="_content _content-loading" role="main"></main>	34	<main class="_content _content-loading" role="main"></main>
@@ -63,9 +57,3 @@ · 22 unmodified lines
63	<symbol id="icon-external-link" viewBox="0 0 24 24"><path d="M19 19H5V5h7V3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2v-7h-2v7zM14 3v2h3.59l-9.83 9.83 1.41 1.41L19 6.41V10h2V3h-7z"/></symbol>	57	<symbol id="icon-external-link" viewBox="0 0 24 24"><path d="M19 19H5V5h7V3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2v-7h-2v7zM14 3v2h3.59l-9.83 9.83 1.41 1.41L19 6.41V10h2V3h-7z"/></symbol>
64	</defs>	58	</defs>
65	</svg>	59	</svg>
66	<style data-size="<%= app_size %>" data-resizer>
67	._container { margin-left: <%= app_size %>; }
68	._header, ._list { width: <%= app_size %>; }
69	._list-hover.clone { min-width: <%= app_size %>; }
70	._notice, ._path, ._resizer { left: <%= app_size %>; }
71	</style>

views/index.erb+3−2

 <!DOCTYPE html>
-<html<%= ' manifest="/manifest.appcache"' if App.production? %> prefix="og: http://ogp.me/ns#" lang="en" class="_booting _theme-<%= app_theme %>">
+<html prefix="og: http://ogp.me/ns#" lang="en" class="_booting">
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no,shrink-to-fit=no">
   <meta name="apple-mobile-web-app-capable" content="yes">
   <meta name="apple-mobile-web-app-status-bar-style" content="black">
   <meta name="format-detection" content="telephone=no">
+  <meta name="theme-color" content="#eee">
   <meta name="robots" content="noodp">
   <title>DevDocs API Documentation</title>
   <link rel="canonical" href="<%= canonical_origin %>">
   <link rel="mask-icon" href="<%= App.cdn_origin %>/images/webkit-mask-icon.svg" color="#398df0">
   <%= stylesheet_tag 'application' %>
 </head>
-<body<%= %( class="#{app_layout}") if app_layout %>>
+<body>
 <noscript class="_fail">DevDocs requires JavaScript to run.</noscript>
 <%= erb :app -%>
 <%= javascript_tag 'application', asset_host: false %>

views/manifest.erb+0−14

@@ -1,14 +0,0 @@
1	CACHE MANIFEST
2	# <%= app_theme %> <%= app_size %> <%= app_layout %>
3
4	CACHE:
5	/
6	<%= manifest_asset_urls.join "\n" %>
7	<%= doc_index_urls.join "\n" %>
8
9	NETWORK:
10	/s/
11	*
12
13	FALLBACK:
14	/ /

views/other.erb+3−2

 <!DOCTYPE html>
-<html lang="en" class="_booting _theme-<%= app_theme %>">
+<html lang="en" class="_booting">
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no">
   <% if doc_index_page? %><meta name="description" content="<%= @doc['name'] %> <%= @doc['release'] %> API documentation with instant search, offline support, keyboard shortcuts, mobile version, and more."><% else %><meta name="robots" content="noindex"><% end %>
   <meta name="format-detection" content="telephone=no">
+  <meta name="theme-color" content="#eee">
   <meta property="og:image" content="<%= App.cdn_origin %>/images/icon-320.png">
   <title>DevDocs<%= " &mdash; #{@doc['full_name']} documentation" if doc_index_page? %></title>
   <link rel="canonical" href="<%= canonical_origin %><%= request.path %>">
   <link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="Search DevDocs">
   <%= stylesheet_tag 'application' %>
 </head>
-<body<%= %( class="#{app_layout}") if app_layout %> data-doc="<%= CGI::escape_html @doc.to_json %>">
+<body data-doc="<%= CGI::escape_html @doc.to_json %>">
 <noscript class="_fail">DevDocs requires JavaScript to run.</noscript>
 <%= erb :app -%>
 <%= javascript_tag 'application', asset_host: false %><% unless App.production? %>

views/service-worker.js.erb+49−0

@@ -0,0 +1,49 @@
	1	<%# The name of the cache to store responses in %>
	2	<%# If the cache name changes DevDocs is assumed to be updated %>
	3	const cacheName = '<%= service_worker_cache_name %>';
	4
	5	<%# Url's to cache when the service worker is installed %>
	6	const urlsToCache = [
	7	'/',
	8	'/favicon.ico',
	9	'/manifest.json',
	10	'<%= service_worker_asset_urls.join "',\n '" %>',
	11	'<%= doc_index_urls.join "',\n '" %>',
	12	];
	13
	14	<%# Set-up the cache %>
	15	self.addEventListener('install', event => {
	16	self.skipWaiting();
	17
	18	event.waitUntil(
	19	caches.open(cacheName).then(cache => cache.addAll(urlsToCache)),
	20	);
	21	});
	22
	23	<%# Remove old caches %>
	24	self.addEventListener('activate', event => {
	25	event.waitUntil((async () => {
	26	const keys = await caches.keys();
	27	const jobs = keys.map(key => key !== cacheName ? caches.delete(key) : Promise.resolve());
	28	return Promise.all(jobs);
	29	})());
	30	});
	31
	32	<%# Handle HTTP requests %>
	33	self.addEventListener('fetch', event => {
	34	event.respondWith((async () => {
	35	const cachedResponse = await caches.match(event.request);
	36	if (cachedResponse) return cachedResponse;
	37
	38	const url = new URL(event.request.url);
	39
	40	<%# Attempt to return the index page from the cache if the user is visiting a url like devdocs.io/offline or devdocs.io/javascript/global_objects/array/find %>
	41	<%# The index page will handle the routing %>
	42	if (url.origin === location.origin && !url.pathname.includes('.')) {
	43	const cachedIndex = await caches.match('/');
	44	if (cachedIndex) return cachedIndex;
	45	}
	46
	47	return fetch(event.request);
	48	})());
	49	});

views/unsupported.erb+6−6

@@ -11,16 +11,16 @@ · 10 unmodified lines
11	<p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers:</p>	11	<p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers:</p>
12	<ul class="_fail-list">	12	<ul class="_fail-list">
13	<li>Recent versions of Firefox, Chrome, or Opera</li>	13	<li>Recent versions of Firefox, Chrome, or Opera</li>
14	<li>Safari 9.1+</li>	14	<li>Safari 11.1+</li>
15	<li>Edge 16+</li>	15	<li>Edge 17+</li>
16	<li>iOS 10+</li>	16	<li>iOS 11.3+</li>
17	</ul>	17	</ul>
18	<p class="_fail-text">	18	<p class="_fail-text">
19	If you're unable to upgrade, I apologize.	19	If you're unable to upgrade, we apologize.
20	I decided to prioritize speed and new features over support for older browsers.	20	We decided to prioritize speed and new features over support for older browsers.
21	</p>	21	</p>
22	<p class="_fail-text">	22	<p class="_fail-text">
23	— Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a>	23	— <a href="https://twitter.com/DevDocs">@DevDocs</a>
24	</p>	24	</p>
25	</div>	25	</div>
26	</body>	26	</body>