Thanks for downloading DevDocs. Here are a few things you should know:
thor docs:list to see all available documentations.
thor docs:download <name> to download documentations.
thor docs:download --installed to update all downloaded documentations.
diff --git a/assets/javascripts/templates/pages/settings_tmpl.coffee b/assets/javascripts/templates/pages/settings_tmpl.coffee
index 4a2066f1..1d439edb 100644
--- a/assets/javascripts/templates/pages/settings_tmpl.coffee
+++ b/assets/javascripts/templates/pages/settings_tmpl.coffee
@@ -15,10 +15,6 @@ app.templates.settingsPage = (settings) -> """
Automatically hide and show the sidebar
Tip: drag the edge of the sidebar to resize it.
-
diff --git a/assets/javascripts/views/content/settings_page.coffee b/assets/javascripts/views/content/settings_page.coffee
index 96904a13..af2e9a9d 100644
--- a/assets/javascripts/views/content/settings_page.coffee
+++ b/assets/javascripts/views/content/settings_page.coffee
@@ -14,7 +14,6 @@ class app.views.SettingsPage extends app.View
settings.dark = app.settings.get('dark')
settings.smoothScroll = !app.settings.get('fastScroll')
settings.arrowScroll = app.settings.get('arrowScroll')
- settings.bypassCache = app.settings.get('bypassCache')
settings[layout] = app.settings.hasLayout(layout) for layout in app.settings.LAYOUTS
settings
@@ -33,10 +32,6 @@ class app.views.SettingsPage extends app.View
app.settings.set('fastScroll', !enable)
return
- toggleBypassCache: (enable) ->
- app.settings.setBypassCache(!!enable)
- return
-
toggle: (name, enable) ->
app.settings.set(name, enable)
return
@@ -80,8 +75,6 @@ class app.views.SettingsPage extends app.View
@toggleSmoothScroll input.checked
when 'import'
@import input.files[0], input
- when 'bypassCache'
- @toggleBypassCache input.checked
else
@toggle input.name, input.checked
return
diff --git a/docs/adding-docs.md b/docs/adding-docs.md
index 4b34b045..dfc96cb1 100644
--- a/docs/adding-docs.md
+++ b/docs/adding-docs.md
@@ -2,8 +2,6 @@ Adding a documentation may look like a daunting task but once you get the hang o
**Note:** please read the [contributing guidelines](../.github/CONTRIBUTING.md) before submitting a new documentation.
-**Note:** when editing any of the files in the `assets` directory or the `public` directory, you'll have to bypass the service worker cache. To do this, go to the Preferences page on your local instance of DevDocs, check "Bypass Service Worker cache" and refresh the page.
-
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`)
2. Add the appropriate class attributes and filter options (see the [Scraper Reference](./scraper-reference.md) page).
3. Check that the scraper is listed in `thor docs:list`.
diff --git a/lib/app.rb b/lib/app.rb
index 83e646e4..a0063e49 100644
--- a/lib/app.rb
+++ b/lib/app.rb
@@ -205,8 +205,28 @@ class App < Sinatra::Application
].compact
end
- def bypass_cache?
- !memoized_cookies['bypassCache'].nil?
+ def service_worker_cache_name
+ # Returns the digest of the last modified asset
+ # When a manifest exist, this digest is only calculated once based on the asset manifest because it never changes without a server restart
+ # If a manifest does not exist, it is calculated every time this method is called because the assets can change while the server is running
+ if File.exist?(App.assets_manifest_path)
+ return @@service_worker_cache_name ||=
+ Sprockets::Manifest
+ .new(nil, App.assets_manifest_path)
+ .files
+ .values
+ .sort_by {|file| file["mtime"]}
+ .reverse
+ .first["digest"]
+ else
+ last_modified_file = App.sprockets
+ .each_file
+ .to_a
+ .reject {|file| file.start_with?(App.docs_path)}
+ .max_by {|file| File.mtime(file)}
+
+ return App.sprockets.pack_base64digest(App.sprockets.file_digest(last_modified_file))
+ end
end
def redirect_via_js(path)
diff --git a/views/service-worker.js.erb b/views/service-worker.js.erb
index 20de7bbe..d9eb4a6c 100644
--- a/views/service-worker.js.erb
+++ b/views/service-worker.js.erb
@@ -1,6 +1,6 @@
-<%# Use the hash of the application.js file as cache name or 'app' if not running in production %>
-<%# This ensures that the cache is always updated if the hash of the application.js file changes %>
-const cacheName = '<%= javascript_path('application', asset_host: false).scan(/application-([^\.]+)\.js/).last&.first || 'app' %>';
+<%# The name of the cache to store responses in %>
+<%# If the cache name changes DevDocs is assumed to be updated %>
+const cacheName = '<%= service_worker_cache_name %>';
<%# Url's to cache when the service worker is installed %>
const urlsToCache = [
@@ -32,9 +32,6 @@ self.addEventListener('activate', event => {
<%# Handle HTTP requests %>
self.addEventListener('fetch', event => {
event.respondWith((async () => {
- <% if bypass_cache? %>
- return fetch(event.request);
- <% else %>
const cachedResponse = await caches.match(event.request);
if (cachedResponse) return cachedResponse;
@@ -53,6 +50,5 @@ self.addEventListener('fetch', event => {
throw err;
}
- <% end %>
})());
});