krisyotam/devdocs

.gitignore+1−0

@@ -1,5 +1,6 @@
1	.DS_Store	1	.DS_Store
2	.bundle	2	.bundle
		3	log
3	tmp	4	tmp
4	public/assets	5	public/assets
5	public/fonts	6	public/fonts

Dockerfile+1−0

@@ -1,6 +1,7 @@
1	FROM ruby:2.6.0	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+1−0

@@ -1,6 +1,7 @@
1	FROM ruby:2.6.0-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

README.md+5−5

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

     @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')
   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'

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

@@ -1,42 +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', -> app.reboot()
31	@notifyUpdate = false
32	@notifyProgress = true
33	try @cache.update() catch
34	return
35
36	onProgress: (event) =>
37	@trigger 'progress', event if @notifyProgress
38	return
39
40	onUpdateReady: =>
41	@trigger 'updateready' if @notifyUpdate
42	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/templates/error_tmpl.coffee+5−5

@@ -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,9 +57,9 @@ 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, we apologize.	65	If you're unable to upgrade, we apologize.

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+1−1

@@ -8,7 +8,7 @@ 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.

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

docs/maintainers.md+1−1

@@ -83,7 +83,7 @@ In addition to the [publicly-documented commands](https://github.com/freeCodeCam · 82 unmodified lines
83		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.	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		85
86	- If you're deploying documentation updates, verify that the documentations work properly once the deploy is done (you will need to reload [devdocs.io](https://devdocs.io/) a couple times for the application cache to update and the new version to load).	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.	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.	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		89

lib/app.rb+32−20

       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

public/images/webapp-icon-192.png+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+0−81

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

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+3−3

@@ -11,9 +11,9 @@ · 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, we apologize.	19	If you're unable to upgrade, we apologize.

@@ -59,14 +59,14 @@ The web app is all client-side JavaScript, written in [CoffeeScript](http://coff · 58 unmodified lines
59		59
60	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.	60	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.
61		61
62	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.	62	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.
63		63
64	DevDocs being a developer tool, the browser requirements are high:	64	DevDocs being a developer tool, the browser requirements are high:
65		65
66	* Recent versions of Firefox, Chrome, or Opera	66	* Recent versions of Firefox, Chrome, or Opera
67	* Safari 9.1+	67	* Safari 11.1+
68	* Edge 16+	68	* Edge 17+
69	* iOS 10+	69	* iOS 11.3+
70		70
71	This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun!	71	This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun!
72		72
@@ -156,7 +156,7 @@ Contributions are welcome. Please read the [contributing guidelines](./.github/C · 83 unmodified lines
156	* [Doc Browser](https://github.com/qwfy/doc-browser) is a native Linux app that supports DevDocs docsets	156	* [Doc Browser](https://github.com/qwfy/doc-browser) is a native Linux app that supports DevDocs docsets
157	* [GNOME Application](https://github.com/hardpixel/devdocs-desktop) GTK3 application with search integrated in headerbar	157	* [GNOME Application](https://github.com/hardpixel/devdocs-desktop) GTK3 application with search integrated in headerbar
158	* [macOS Application](https://github.com/dteoh/devdocs-macos)	158	* [macOS Application](https://github.com/dteoh/devdocs-macos)
159	* [Android Application](https://github.com/Merith-TK/devdocs_webapp_kotlin) is a fully working, advanced WebView with AppCache enabled	159	* [Android Application](https://github.com/Merith-TK/devdocs_webapp_kotlin) is a fully working, advanced WebView
160		160
161	## Copyright / License	161	## Copyright / License
162		162