diff --git a/.editorconfig b/.editorconfig index 73db316c..03c17bf8 100644 --- a/.editorconfig +++ b/.editorconfig @@ -6,3 +6,6 @@ indent_style = space indent_size = 2 insert_final_newline = true trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d1f848bd..99fd8584 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,12 +24,12 @@ Want to contribute? Great. Please review the following guidelines carefully and ## 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. ## Requesting new documentations -Please don't open issues to request 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 @@ -44,7 +44,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher ## 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. @@ -55,13 +55,12 @@ In addition to the [guidelines for contributing code](#contributing-code-and-fea * Remove as much content and HTML markup as possible, particularly content not associated with any entry (e.g. introduction, changelog, etc.). * Names must be as short as possible and unique across the documentation. * The number of types (categories) should ideally be less than 100. -* Don't modify the icon sprite. I'll do it after your pull request is merged. ## Updating existing documentations Please don't submit a pull request updating the version number of a documentation, unless a change is required in the scraper and you've verified that it works. -To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here). +To ask that an existing documentation be updated, first check the last two [documentation versions reports](https://github.com/freeCodeCamp/devdocs/issues?utf8=%E2%9C%93&q=Documentation+versions+report+is%3Aissue+author%3Adevdocs-bot+sort%3Acreated-desc). Only create an issue if the documentation has been wrongly marked as up-to-date. ## Coding conventions diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 807f88e0..0fb624d4 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -2,6 +2,6 @@ Please read the contributing guidelines before opening an issue: https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md - To request a new documentation, or an update of an existing documentation, go here: + Go here to request a new documentation: https://trello.com/b/6BmTulfx/devdocs-documentation --> diff --git a/.gitignore b/.gitignore index 1060fcf0..f89ecb61 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .DS_Store .bundle +log tmp public/assets public/fonts diff --git a/.ruby-version b/.ruby-version index 914ec967..ec1cf33c 100644 --- a/.ruby-version +++ b/.ruby-version @@ -1 +1 @@ -2.6.0 \ No newline at end of file +2.6.3 diff --git a/.slugignore b/.slugignore index 6a7070f5..9daeafb9 100644 --- a/.slugignore +++ b/.slugignore @@ -1,2 +1 @@ -public/icons -test \ No newline at end of file +test diff --git a/.travis.yml b/.travis.yml index d5e5a6aa..6c59f0be 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,26 @@ language: ruby +addons: + apt: + packages: + - libcurl4-openssl-dev + cache: bundler -before_script: +before_install: + - "echo 'gem: --no-document' > ~/.gemrc" - gem update --system - gem install bundler + +script: + - if [ "$TRAVIS_EVENT_TYPE" != "cron" ]; then bundle exec rake; fi + - if [ "$TRAVIS_EVENT_TYPE" = "cron" ]; then bundle exec thor updates:check --github-token $GH_TOKEN --upload; fi + +deploy: + provider: heroku + app: devdocs + on: + branch: master + condition: $TRAVIS_EVENT_TYPE != cron + api_key: + secure: "4p1klvWJZSOImzFcKOduILjP93hlOlAhceWlYMKS4tU+TCFE8qTBzdKdFPSCsCgjB+YR9pBss+L0lJpVVMjSwFHXqpKe6EeUSltO2k7DFHfW7kXLUM/L0AfqXz+YXk76XUyZMhvOEbldPfaMaj10e8vgDOQCSHABDyK/4CU+hnI=" diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..26f8ab09 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,2 @@ + +> Our Code of Conduct is available here: diff --git a/Dockerfile b/Dockerfile index 77443edd..b033427a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,11 +1,12 @@ -FROM ruby:2.6.0 +FROM ruby:2.6.3 ENV LANG=C.UTF-8 +ENV ENABLE_SERVICE_WORKER=true WORKDIR /devdocs RUN apt-get update && \ - apt-get -y install git nodejs && \ + apt-get -y install git nodejs libcurl4 && \ gem install bundler && \ rm -rf /var/lib/apt/lists/* diff --git a/Dockerfile-alpine b/Dockerfile-alpine index 5bd25afe..33a06b0e 100644 --- a/Dockerfile-alpine +++ b/Dockerfile-alpine @@ -1,12 +1,13 @@ -FROM ruby:2.6.0-alpine +FROM ruby:2.6.3-alpine ENV LANG=C.UTF-8 +ENV ENABLE_SERVICE_WORKER=true WORKDIR /devdocs COPY . /devdocs -RUN apk --update add nodejs build-base libstdc++ gzip git zlib-dev && \ +RUN apk --update add nodejs build-base libstdc++ gzip git zlib-dev libcurl && \ gem install bundler && \ bundle install --system --without test && \ thor docs:download --all && \ diff --git a/Gemfile b/Gemfile index 31b57064..3c9ce68b 100644 --- a/Gemfile +++ b/Gemfile @@ -1,5 +1,5 @@ source 'https://rubygems.org' -ruby '2.6.0' +ruby '2.6.3' gem 'rake' gem 'thor' @@ -22,6 +22,8 @@ group :app do gem 'browser' gem 'sass' gem 'coffee-script' + gem 'chunky_png' + gem 'sprockets-sass' end group :production do @@ -40,6 +42,7 @@ group :docs do gem 'unix_utils', require: false gem 'tty-pager', require: false gem 'net-sftp', '>= 2.1.3.rc2', require: false + gem 'terminal-table', require: false end group :test do diff --git a/Gemfile.lock b/Gemfile.lock index d968a27b..d1abb66b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,49 +1,50 @@ GEM remote: https://rubygems.org/ specs: - activesupport (5.2.2) + activesupport (5.2.3) concurrent-ruby (~> 1.0, >= 1.0.2) i18n (>= 0.7, < 2) minitest (~> 5.1) tzinfo (~> 1.1) - backports (3.11.4) - better_errors (2.5.0) + backports (3.15.0) + better_errors (2.5.1) coderay (>= 1.0.0) erubi (>= 1.0.0) rack (>= 0.9.0) - browser (2.5.3) + browser (2.6.1) + chunky_png (1.3.11) coderay (1.1.2) coffee-script (2.4.1) coffee-script-source execjs coffee-script-source (1.12.2) - concurrent-ruby (1.1.4) + concurrent-ruby (1.1.5) daemons (1.3.1) erubi (1.8.0) ethon (0.12.0) ffi (>= 1.3.0) eventmachine (1.2.7) execjs (2.7.0) - exifr (1.3.5) - ffi (1.10.0) - fspath (3.1.0) - highline (2.0.0) - html-pipeline (2.10.0) + exifr (1.3.6) + ffi (1.11.1) + fspath (3.1.2) + highline (2.0.2) + html-pipeline (2.11.1) activesupport (>= 2) nokogiri (>= 1.4) - i18n (1.5.2) + i18n (1.6.0) concurrent-ruby (~> 1.0) - image_optim (0.26.3) + image_optim (0.26.5) 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.20190105) + image_optim_pack (0.5.6) fspath (>= 2.1, < 4) image_optim (~> 0.19) - image_size (2.0.0) - in_threads (1.5.1) + image_size (2.0.2) + in_threads (1.5.3) method_source (0.9.2) mini_portile2 (2.4.0) minitest (5.11.3) @@ -51,19 +52,19 @@ GEM mustermann (1.0.3) net-sftp (3.0.0.beta1) net-ssh (>= 5.0.0, < 6.0.0) - net-ssh (5.1.0) - newrelic_rpm (5.7.0.350) - nokogiri (1.10.1) + net-ssh (5.2.0) + newrelic_rpm (6.5.0.357) + nokogiri (1.10.3) mini_portile2 (~> 2.4.0) options (2.3.2) - progress (3.5.0) + progress (3.5.2) progress_bar (1.3.0) highline (>= 1.6, < 3) options (~> 2.3.0) pry (0.12.2) coderay (~> 1.1.0) method_source (~> 0.9.0) - rack (2.0.6) + rack (2.0.7) rack-protection (2.0.5) rack rack-ssl-enforcer (0.2.9) @@ -74,7 +75,7 @@ GEM rb-inotify (0.10.0) ffi (~> 1.0) rr (1.2.1) - sass (3.7.3) + sass (3.7.4) sass-listen (~> 4.0.0) sass-listen (4.0.0) rb-fsevent (~> 0.9, >= 0.9.4) @@ -96,11 +97,15 @@ GEM rack (> 1, < 3) sprockets-helpers (1.2.1) sprockets (>= 2.2) - strings (0.1.4) - strings-ansi (~> 0.1.0) - unicode-display_width (~> 1.4.0) - unicode_utils (~> 1.4.0) + sprockets-sass (2.0.0.beta2) + sprockets (>= 2.0, < 4.0) + strings (0.1.5) + strings-ansi (~> 0.1) + unicode-display_width (~> 1.5) + unicode_utils (~> 1.4) strings-ansi (0.1.0) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) thin (1.7.2) daemons (~> 1.0, >= 1.0.9) eventmachine (~> 1.0, >= 1.0.4) @@ -108,19 +113,19 @@ GEM thor (0.20.3) thread_safe (0.3.6) tilt (2.0.9) - tty-pager (0.12.0) + tty-pager (0.12.1) strings (~> 0.1.4) tty-screen (~> 0.6) tty-which (~> 0.4) - tty-screen (0.6.5) - tty-which (0.4.0) + tty-screen (0.7.0) + tty-which (0.4.1) typhoeus (1.3.1) ethon (>= 0.9.0) tzinfo (1.2.5) thread_safe (~> 0.1) uglifier (4.1.20) execjs (>= 0.3.0, < 3) - unicode-display_width (1.4.1) + unicode-display_width (1.6.0) unicode_utils (1.4.0) unix_utils (0.0.15) yajl-ruby (1.4.1) @@ -132,6 +137,7 @@ DEPENDENCIES activesupport (~> 5.2) better_errors browser + chunky_png coffee-script erubi html-pipeline @@ -153,6 +159,8 @@ DEPENDENCIES sinatra-contrib sprockets sprockets-helpers + sprockets-sass + terminal-table thin thor tty-pager @@ -162,7 +170,7 @@ DEPENDENCIES yajl-ruby RUBY VERSION - ruby 2.6.0p0 + ruby 2.6.3p62 BUNDLED WITH - 1.17.2 + 2.0.2 diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..0df55970 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +If you’re adding a new scraper, please ensure that you have: + +- [ ] Tested the scraper on a local copy of DevDocs +- [ ] Ensured that the docs are styled similarly to other docs on DevDocs + +- [ ] Added these files to the public/icons/*your_scraper_name*/ directory: + - [ ] `16.png`: a 16×16 pixel icon for the doc + - [ ] `16@2x.png`: a 32×32 pixel icon for the doc + - [ ] `SOURCE`: A text file containing the URL to the page the image can be found on or the URL of the original image itself + + diff --git a/README.md b/README.md index 37074f1c..630142d4 100644 --- a/README.md +++ b/README.md @@ -59,14 +59,14 @@ The web app is all client-side JavaScript, written in [CoffeeScript](http://coff 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+ -* Edge 16+ -* iOS 10+ +* Safari 11.1+ +* Edge 17+ +* 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! @@ -83,12 +83,13 @@ Modifications made to each document include: * 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 @@ -128,9 +129,7 @@ If multiple versions of Ruby are installed on your system, commands must be run ## Contributing -Contributions are welcome. Please read the [contributing guidelines](https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md). - -DevDocs's own documentation is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki). +Contributions are welcome. Please read the [contributing guidelines](./.github/CONTRIBUTING.md). ## Documentation @@ -145,7 +144,7 @@ DevDocs's own documentation is available on the [wiki](https://github.com/freeCo * [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) +* [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) @@ -156,12 +155,14 @@ DevDocs's own documentation is available on the [wiki](https://github.com/freeCo * [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-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 the maintainers' permission, except as may be necessary to comply with the notice/attribution requirements. diff --git a/assets/images/.gitignore b/assets/images/.gitignore new file mode 100644 index 00000000..4a72ec74 --- /dev/null +++ b/assets/images/.gitignore @@ -0,0 +1 @@ +sprites/**/* diff --git a/assets/images/docs-1.png b/assets/images/docs-1.png deleted file mode 100644 index c5bfb6b8..00000000 Binary files a/assets/images/docs-1.png and /dev/null differ diff --git a/assets/images/docs-1@2x.png b/assets/images/docs-1@2x.png deleted file mode 100644 index 1f81ecd9..00000000 Binary files a/assets/images/docs-1@2x.png and /dev/null differ diff --git a/assets/images/docs-2.png b/assets/images/docs-2.png deleted file mode 100644 index bd9d44a8..00000000 Binary files a/assets/images/docs-2.png and /dev/null differ diff --git a/assets/images/docs-2@2x.png b/assets/images/docs-2@2x.png deleted file mode 100644 index 512ea7a5..00000000 Binary files a/assets/images/docs-2@2x.png and /dev/null differ diff --git a/assets/javascripts/app/app.coffee b/assets/javascripts/app/app.coffee index ab67a92a..b55e552c 100644 --- a/assets/javascripts/app/app.coffee +++ b/assets/javascripts/app/app.coffee @@ -13,10 +13,12 @@ @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 @@ -76,7 +78,7 @@ .install() @previousErrorHandler = onerror window.onerror = @onWindowError.bind(@) - CookieStore.onBlocked = @onCookieBlocked + CookiesStore.onBlocked = @onCookieBlocked return bootOne: -> @@ -138,7 +140,10 @@ @docs.sort() @initDoc(doc) @saveDocs() - _onSuccess() + if app.settings.get('autoInstall') + doc.install(_onSuccess, onError) + else + _onSuccess() return doc.load onSuccess, onError, writeCache: true @@ -147,7 +152,7 @@ saveDocs: -> @settings.setDocs(doc.slug for doc in @docs.all()) @db.migrate() - @appCache?.updateInBackground() + @serviceWorker?.updateInBackground() welcomeBack: -> visitCount = @settings.get('count') @@ -167,14 +172,14 @@ 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 @@ -193,9 +198,9 @@ 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' @@ -252,7 +257,7 @@ 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' diff --git a/assets/javascripts/app/appcache.coffee b/assets/javascripts/app/appcache.coffee deleted file mode 100644 index 235cae02..00000000 --- a/assets/javascripts/app/appcache.coffee +++ /dev/null @@ -1,42 +0,0 @@ -class app.AppCache - $.extend @prototype, Events - - @isEnabled: -> - try - applicationCache and applicationCache.status isnt applicationCache.UNCACHED - catch - - constructor: -> - @cache = applicationCache - @notifyUpdate = true - @onUpdateReady() if @cache.status is @cache.UPDATEREADY - - $.on @cache, 'progress', @onProgress - $.on @cache, 'updateready', @onUpdateReady - - update: -> - @notifyUpdate = true - @notifyProgress = true - try @cache.update() catch - return - - updateInBackground: -> - @notifyUpdate = false - @notifyProgress = false - try @cache.update() catch - return - - reload: -> - $.on @cache, 'updateready noupdate error', -> app.reboot() - @notifyUpdate = false - @notifyProgress = true - try @cache.update() catch - return - - onProgress: (event) => - @trigger 'progress', event if @notifyProgress - return - - onUpdateReady: => - @trigger 'updateready' if @notifyUpdate - return diff --git a/assets/javascripts/app/config.coffee.erb b/assets/javascripts/app/config.coffee.erb index ec26b697..a822f7e2 100644 --- a/assets/javascripts/app/config.coffee.erb +++ b/assets/javascripts/app/config.coffee.erb @@ -13,3 +13,6 @@ app.config = version: <%= Time.now.to_i %> release: <%= Time.now.utc.httpdate.to_json %> mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css' + favicon_spritesheet: '<%= image_path('sprites/docs.png') %>' + service_worker_path: '/service-worker.js' + service_worker_enabled: <%= App.environment == :production || ENV['ENABLE_SERVICE_WORKER'] == 'true' %> diff --git a/assets/javascripts/app/serviceworker.coffee b/assets/javascripts/app/serviceworker.coffee new file mode 100644 index 00000000..40235566 --- /dev/null +++ b/assets/javascripts/app/serviceworker.coffee @@ -0,0 +1,49 @@ +class app.ServiceWorker + $.extend @prototype, Events + + @isEnabled: -> + !!navigator.serviceWorker and app.config.service_worker_enabled + + constructor: -> + @registration = null + @notifyUpdate = true + + navigator.serviceWorker.register(app.config.service_worker_path, {scope: '/'}) + .then( + (registration) => @updateRegistration(registration), + (error) -> console.error('Could not register service worker:', error) + ) + + update: -> + return unless @registration + @notifyUpdate = true + return @registration.update().catch(->) + + updateInBackground: -> + return unless @registration + @notifyUpdate = false + return @registration.update().catch(->) + + reload: -> + return @updateInBackground().then(() -> app.reboot()) + + updateRegistration: (registration) -> + @registration = registration + $.on @registration, 'updatefound', @onUpdateFound + return + + onUpdateFound: => + $.off @installingRegistration, 'statechange', @onStateChange() if @installingRegistration + @installingRegistration = @registration.installing + $.on @installingRegistration, 'statechange', @onStateChange + return + + onStateChange: => + if @installingRegistration and @installingRegistration.state == 'installed' and navigator.serviceWorker.controller + @installingRegistration = null + @onUpdateReady() + return + + onUpdateReady: -> + @trigger 'updateready' if @notifyUpdate + return diff --git a/assets/javascripts/app/settings.coffee b/assets/javascripts/app/settings.coffee index 8d309c41..350a08c0 100644 --- a/assets/javascripts/app/settings.coffee +++ b/assets/javascripts/app/settings.coffee @@ -5,11 +5,13 @@ class app.Settings 'manualUpdate' 'fastScroll' 'arrowScroll' + 'analyticsConsent' 'docs' 'dark' 'layout' 'size' 'tips' + 'autoInstall' ] INTERNAL_KEYS = [ @@ -19,6 +21,8 @@ class app.Settings 'news' ] + LAYOUTS: ['_max-width', '_sidebar-hidden', '_native-scrollbars'] + @defaults: count: 0 hideDisabled: false @@ -26,9 +30,10 @@ class app.Settings news: 0 manualUpdate: false schema: 1 + analyticsConsent: false constructor: -> - @store = new CookieStore + @store = new CookiesStore @cache = {} get: (key) -> @@ -38,6 +43,7 @@ class app.Settings set: (key, value) -> @store.set(key, value) delete @cache[key] + @toggleDark(value) if key == 'dark' return del: (key) -> @@ -63,6 +69,8 @@ class app.Settings return setLayout: (name, enable) -> + @toggleLayout(name, enable) + layout = (@store.get('layout') || '').split(' ') $.arrayDelete(layout, '') @@ -104,3 +112,28 @@ class app.Settings @store.reset() @cache = {} return + + initLayout: -> + @toggleDark(@get('dark') is 1) + @toggleLayout(layout, @hasLayout(layout)) for layout in @LAYOUTS + @initSidebarWidth() + return + + toggleDark: (enable) -> + classList = document.documentElement.classList + classList.toggle('_theme-default', !enable) + classList.toggle('_theme-dark', enable) + color = getComputedStyle(document.documentElement).getPropertyValue('--headerBackground').trim() + $('meta[name=theme-color]').setAttribute('content', color) + return + + toggleLayout: (layout, enable) -> + classList = document.body.classList + classList.toggle(layout, enable) unless layout is '_sidebar-hidden' + classList.toggle('_overlay-scrollbars', $.overlayScrollbarsEnabled()) + return + + initSidebarWidth: -> + size = @get('size') + document.documentElement.style.setProperty('--sidebarWidth', size + 'px') if size + return diff --git a/assets/javascripts/app/update_checker.coffee b/assets/javascripts/app/update_checker.coffee index 5630b488..3558d6bc 100644 --- a/assets/javascripts/app/update_checker.coffee +++ b/assets/javascripts/app/update_checker.coffee @@ -3,13 +3,13 @@ class app.UpdateChecker @lastCheck = Date.now() $.on window, 'focus', @onFocus - app.appCache.on 'updateready', @onUpdateReady if app.appCache + app.serviceWorker?.on 'updateready', @onUpdateReady setTimeout @checkDocs, 0 check: -> - if app.appCache - app.appCache.update() + if app.serviceWorker + app.serviceWorker.update() else ajax url: $('script[src*="application"]').getAttribute('src') diff --git a/assets/javascripts/lib/cookie_store.coffee b/assets/javascripts/lib/cookies_store.coffee similarity index 76% rename from assets/javascripts/lib/cookie_store.coffee rename to assets/javascripts/lib/cookies_store.coffee index 3b340571..eaf1bd4f 100644 --- a/assets/javascripts/lib/cookie_store.coffee +++ b/assets/javascripts/lib/cookies_store.coffee @@ -1,4 +1,8 @@ -class @CookieStore +class @CookiesStore + # Intentionally called CookiesStore instead of CookieStore + # Calling it CookieStore causes issues when the Experimental Web Platform features flag is enabled in Chrome + # Related issue: https://github.com/freeCodeCamp/devdocs/issues/932 + INT = /^\d+$/ @onBlocked: -> diff --git a/assets/javascripts/lib/favicon.coffee b/assets/javascripts/lib/favicon.coffee new file mode 100644 index 00000000..2f2d9f93 --- /dev/null +++ b/assets/javascripts/lib/favicon.coffee @@ -0,0 +1,64 @@ +defaultUrl = null +currentSlug = null + +imageCache = {} +urlCache = {} + +withImage = (url, action) -> + if imageCache[url] + action(imageCache[url]) + else + img = new Image() + img.crossOrigin = 'anonymous' + img.src = url + img.onload = () => + imageCache[url] = img + action(img) + +@setFaviconForDoc = (doc) -> + return if currentSlug == doc.slug + + favicon = $('link[rel="icon"]') + + if defaultUrl == null + defaultUrl = favicon.href + + if urlCache[doc.slug] + favicon.href = urlCache[doc.slug] + currentSlug = doc.slug + return + + styles = window.getComputedStyle($("._icon-#{doc.slug.split('~')[0]}"), ':before') + + bgUrl = app.config.favicon_spritesheet + sourceSize = 16 + sourceX = Math.abs(parseInt(styles['background-position-x'].slice(0, -2))) + sourceY = Math.abs(parseInt(styles['background-position-y'].slice(0, -2))) + + withImage(bgUrl, (docImg) -> + withImage(defaultUrl, (defaultImg) -> + size = defaultImg.width + + canvas = document.createElement('canvas') + ctx = canvas.getContext('2d') + + canvas.width = size + canvas.height = size + ctx.drawImage(defaultImg, 0, 0) + + docIconPercentage = 65 + destinationCoords = size / 100 * (100 - docIconPercentage) + destinationSize = size / 100 * docIconPercentage + ctx.drawImage(docImg, sourceX, sourceY, sourceSize, sourceSize, destinationCoords, destinationCoords, destinationSize, destinationSize) + + urlCache[doc.slug] = canvas.toDataURL() + favicon.href = urlCache[doc.slug] + + currentSlug = doc.slug + ) + ) + +@resetFavicon = () -> + if defaultUrl != null and currentSlug != null + $('link[rel="icon"]').href = defaultUrl + currentSlug = null diff --git a/assets/javascripts/lib/page.coffee b/assets/javascripts/lib/page.coffee index 5d3f6c88..ba2f2647 100644 --- a/assets/javascripts/lib/page.coffee +++ b/assets/javascripts/lib/page.coffee @@ -199,5 +199,21 @@ page.track = (fn) -> return track = -> - tracker.call() for tracker in trackers + consentGiven = Cookies.get('analyticsConsent') + consentAsked = Cookies.get('analyticsConsentAsked') + + if consentGiven == '1' + tracker.call() for tracker in trackers + else if consentGiven == undefined and consentAsked == undefined + # Only ask for consent once per browser session + Cookies.set('analyticsConsentAsked', '1') + + new app.views.Notif 'AnalyticsConsent', autoHide: null + return + +@resetAnalytics = -> + for cookie in document.cookie.split(/;\s?/) + name = cookie.split('=')[0] + if name[0] == '_' + Cookies.expire(name) return diff --git a/assets/javascripts/lib/util.coffee b/assets/javascripts/lib/util.coffee index 058106fd..001b13de 100644 --- a/assets/javascripts/lib/util.coffee +++ b/assets/javascripts/lib/util.coffee @@ -352,6 +352,10 @@ isIE = null $.isIE = -> isIE ?= navigator.userAgent?.indexOf('MSIE') >= 0 || navigator.userAgent?.indexOf('rv:11.0') >= 0 +isChromeForAndroid = null +$.isChromeForAndroid = -> + isChromeForAndroid ?= navigator.userAgent?.indexOf('Android') >= 0 && /Chrome\/([.0-9])+ Mobile/.test(navigator.userAgent) + isAndroid = null $.isAndroid = -> isAndroid ?= navigator.userAgent?.indexOf('Android') >= 0 diff --git a/assets/javascripts/models/doc.coffee b/assets/javascripts/models/doc.coffee index 2d5f7e4a..c51e13fa 100644 --- a/assets/javascripts/models/doc.coffee +++ b/assets/javascripts/models/doc.coffee @@ -142,4 +142,6 @@ class app.models.Doc extends app.Model return isOutdated: (status) -> - status and status.installed and @mtime isnt status.mtime + return false if not status + isInstalled = status.installed or app.settings.get('autoInstall') + isInstalled and @mtime isnt status.mtime diff --git a/assets/javascripts/news.json b/assets/javascripts/news.json index 32da738e..0266dea3 100644 --- a/assets/javascripts/news.json +++ b/assets/javascripts/news.json @@ -1,4 +1,12 @@ [ + [ + "2019-07-21", + "Fixed several bugs, added an option to automatically download documentation and more." + ], + [ + "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: Puppeteer and Handlebars.js" diff --git a/assets/javascripts/templates/error_tmpl.coffee b/assets/javascripts/templates/error_tmpl.coffee index c4bf40ec..9cca1f9d 100644 --- a/assets/javascripts/templates/error_tmpl.coffee +++ b/assets/javascripts/templates/error_tmpl.coffee @@ -12,8 +12,8 @@ app.templates.notFoundPage = -> app.templates.pageLoadError = -> error """ The page failed to load. """, - """ It may be missing from the server (try reloading the app) or you could be offline.
- If you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """, + """ It may be missing from the server (try reloading the app) or you could be offline (try installing the documentation for offline usage when online again).
+ If you're online and you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """, """ #{back} · Reload · Retry """ @@ -57,9 +57,9 @@ app.templates.unsupportedBrowser = """

DevDocs is an API documentation browser which supports the following browsers:

  • Recent versions of Firefox, Chrome, or Opera -
  • Safari 9.1+ -
  • Edge 16+ -
  • iOS 10+ +
  • Safari 11.1+ +
  • Edge 17+ +
  • iOS 11.3+

If you're unable to upgrade, we apologize. diff --git a/assets/javascripts/templates/notif_tmpl.coffee b/assets/javascripts/templates/notif_tmpl.coffee index 93611a5c..0821036e 100644 --- a/assets/javascripts/templates/notif_tmpl.coffee +++ b/assets/javascripts/templates/notif_tmpl.coffee @@ -68,3 +68,9 @@ app.templates.notifShare = -> app.templates.notifUpdateDocs = -> textNotif """ Documentation updates available. """, """ Install them as soon as possible to avoid broken pages. """ + +app.templates.notifAnalyticsConsent = -> + textNotif """ Tracking cookies """, + """ We would like to gather usage data about how DevDocs is used through Google Analytics and Gauges. We only collect anonymous traffic information. + Please confirm if you accept our tracking cookies. You can always change your decision in the settings. +
Accept or Decline """ diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 5d997403..e7b4cc80 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -73,7 +73,8 @@ app.templates.aboutPage = -> """

  • devdocs.io ("App") is operated by freeCodeCamp ("We").
  • We do not collect personal information through the app. -
  • We use Google Analytics, Gauges and Sentry to collect anonymous traffic information and improve the app. +
  • We use Google Analytics and Gauges to collect anonymous traffic information if you have given consent to this. You can change your decision in the settings. +
  • We use Sentry to collect crash data and improve the app.
  • The app uses cookies to store user preferences.
  • 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.
  • If you have any questions regarding privacy, please email privacy@freecodecamp.org. diff --git a/assets/javascripts/templates/pages/offline_tmpl.coffee b/assets/javascripts/templates/pages/offline_tmpl.coffee index a9a3c21c..bb9e06e8 100644 --- a/assets/javascripts/templates/pages/offline_tmpl.coffee +++ b/assets/javascripts/templates/pages/offline_tmpl.coffee @@ -25,8 +25,8 @@ app.templates.offlinePage = (docs) -> """

    Questions & Answers

    How does this work? -
    Each page is cached as a key-value pair in IndexedDB (downloaded from a single file).
    - The app also uses AppCache and localStorage to cache the assets and index files. +
    Each page is cached as a key-value pair in IndexedDB (downloaded from a single file).
    + The app also uses Service Workers and localStorage to cache the assets and index files.
    Can I close the tab/browser?
    #{canICloseTheTab()}
    What if I don't update a documentation? @@ -41,10 +41,15 @@ app.templates.offlinePage = (docs) -> """ """ canICloseTheTab = -> - if app.AppCache.isEnabled() + if app.ServiceWorker.isEnabled() """ Yes! Even offline, you can open a new tab, go to devdocs.io, 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 devdocs.io offline won't work.
    + 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 ENABLE_SERVICE_WORKER environment variable to true)" + + """ No. Service Workers #{reason}, so loading devdocs.io offline won't work.
    The current tab will continue to function even when you go offline (provided you installed all the documentations beforehand). """ app.templates.offlineDoc = (doc, status) -> diff --git a/assets/javascripts/templates/pages/root_tmpl.coffee.erb b/assets/javascripts/templates/pages/root_tmpl.coffee.erb index 7adce7fd..714e0e20 100644 --- a/assets/javascripts/templates/pages/root_tmpl.coffee.erb +++ b/assets/javascripts/templates/pages/root_tmpl.coffee.erb @@ -8,7 +8,7 @@ app.templates.intro = """

    Thanks for downloading DevDocs. Here are a few things you should know:

    1. Your local version of DevDocs won't self-update. Unless you're modifying the code, - I recommend using the hosted version at devdocs.io. + we recommend using the hosted version at devdocs.io.
    2. Run thor docs:list to see all available documentations.
    3. Run thor docs:download <name> to download documentations.
    4. Run thor docs:download --installed to update all downloaded documentations. @@ -39,7 +39,7 @@ app.templates.intro = """
    5. DevDocs works offline, on mobile, and can be installed on Chrome.
    6. For the latest news, follow @DevDocs.
    7. DevDocs is free and open source. - +
    8. And if you're new to coding, check out freeCodeCamp's open source curriculum.

    Happy coding! diff --git a/assets/javascripts/templates/pages/settings_tmpl.coffee b/assets/javascripts/templates/pages/settings_tmpl.coffee index 1d439edb..94afe3df 100644 --- a/assets/javascripts/templates/pages/settings_tmpl.coffee +++ b/assets/javascripts/templates/pages/settings_tmpl.coffee @@ -15,6 +15,14 @@ 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/tracking.js b/assets/javascripts/tracking.js index ca05b218..a68ca493 100644 --- a/assets/javascripts/tracking.js +++ b/assets/javascripts/tracking.js @@ -1,28 +1,32 @@ try { - if (app.config.env == 'production') { - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-5544833-12', 'devdocs.io'); - page.track(function() { - ga('send', 'pageview', { - page: location.pathname + location.search + location.hash, - dimension1: app.router.context && app.router.context.doc && app.router.context.doc.slug_without_version + if (app.config.env === 'production') { + if (Cookies.get('analyticsConsent') === '1') { + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + ga('create', 'UA-5544833-12', 'devdocs.io'); + page.track(function() { + ga('send', 'pageview', { + page: location.pathname + location.search + location.hash, + dimension1: app.router.context && app.router.context.doc && app.router.context.doc.slug_without_version + }); }); - }); - page.track(function() { - if (window._gauges) - _gauges.push(['track']); - else - (function() { - var _gauges=_gauges||[];!function(){var a=document.createElement("script"); - a.type="text/javascript",a.async=!0,a.id="gauges-tracker", - a.setAttribute("data-site-id","51c15f82613f5d7819000067"), - a.src="https://secure.gaug.es/track.js";var b=document.getElementsByTagName("script")[0]; - b.parentNode.insertBefore(a,b)}(); - })(); - }); + page.track(function() { + if (window._gauges) + _gauges.push(['track']); + else + (function() { + var _gauges=_gauges||[];!function(){var a=document.createElement("script"); + a.type="text/javascript",a.async=!0,a.id="gauges-tracker", + a.setAttribute("data-site-id","51c15f82613f5d7819000067"), + a.src="https://secure.gaug.es/track.js";var b=document.getElementsByTagName("script")[0]; + b.parentNode.insertBefore(a,b)}(); + })(); + }); + } else { + resetAnalytics(); + } } } catch(e) { } diff --git a/assets/javascripts/views/content/content.coffee b/assets/javascripts/views/content/content.coffee index 8c5ba874..4e01733e 100644 --- a/assets/javascripts/views/content/content.coffee +++ b/assets/javascripts/views/content/content.coffee @@ -153,6 +153,9 @@ class app.views.Content extends app.View return afterRoute: (route, context) => + if route != 'entry' and route != 'type' + resetFavicon() + switch route when 'root' @show @rootPage diff --git a/assets/javascripts/views/content/entry_page.coffee b/assets/javascripts/views/content/entry_page.coffee index beae4d77..f6f06511 100644 --- a/assets/javascripts/views/content/entry_page.coffee +++ b/assets/javascripts/views/content/entry_page.coffee @@ -40,6 +40,7 @@ class app.views.EntryPage extends app.View if app.disabledDocs.findBy 'slug', @entry.doc.slug @hiddenView = new app.views.HiddenPage @el, @entry + setFaviconForDoc(@entry.doc) @delay @polyfillMathML @trigger 'loaded' return @@ -123,7 +124,7 @@ class app.views.EntryPage extends app.View @render @tmpl('pageLoadError') @resetClass() @addClass @constructor.errorClass - app.appCache?.update() + app.serviceWorker?.update() return cache: -> diff --git a/assets/javascripts/views/content/settings_page.coffee b/assets/javascripts/views/content/settings_page.coffee index e39b17df..9ca606c6 100644 --- a/assets/javascripts/views/content/settings_page.coffee +++ b/assets/javascripts/views/content/settings_page.coffee @@ -1,7 +1,4 @@ class app.views.SettingsPage extends app.View - LAYOUTS = ['_max-width', '_sidebar-hidden', '_native-scrollbars'] - SIDEBAR_HIDDEN_LAYOUT = '_sidebar-hidden' - @className: '_static' @events: @@ -17,31 +14,31 @@ 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[layout] = app.settings.hasLayout(layout) for layout in LAYOUTS + settings.autoInstall = app.settings.get('autoInstall') + settings.analyticsConsent = app.settings.get('analyticsConsent') + 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) -> app.settings.set('fastScroll', !enable) return + toggleAnalyticsConsent: (enable) -> + app.settings.set('analyticsConsent', if enable then '1' else '0') + resetAnalytics() unless enable + return + toggle: (name, enable) -> app.settings.set(name, enable) return @@ -85,6 +82,8 @@ class app.views.SettingsPage extends app.View @toggleSmoothScroll input.checked when 'import' @import input.files[0], input + when 'analyticsConsent' + @toggleAnalyticsConsent input.checked else @toggle input.name, input.checked return diff --git a/assets/javascripts/views/content/type_page.coffee b/assets/javascripts/views/content/type_page.coffee index 147fa7ed..ef360c14 100644 --- a/assets/javascripts/views/content/type_page.coffee +++ b/assets/javascripts/views/content/type_page.coffee @@ -9,6 +9,7 @@ class app.views.TypePage extends app.View render: (@type) -> @html @tmpl('typePage', @type) + setFaviconForDoc(@type.doc) return getTitle: -> diff --git a/assets/javascripts/views/layout/document.coffee b/assets/javascripts/views/layout/document.coffee index 02b98c7a..597dfe37 100644 --- a/assets/javascripts/views/layout/document.coffee +++ b/assets/javascripts/views/layout/document.coffee @@ -75,9 +75,11 @@ class app.views.Document extends app.View return unless target.hasAttribute('data-behavior') $.stopEvent(event) switch target.getAttribute('data-behavior') - when 'back' then history.back() - when 'reload' then window.location.reload() - when 'reboot' then app.reboot() - when 'hard-reload' then app.reload() - when 'reset' then app.reset() if confirm('Are you sure you want to reset DevDocs?') + when 'back' then history.back() + when 'reload' then window.location.reload() + when 'reboot' then app.reboot() + when 'hard-reload' then app.reload() + when 'reset' then app.reset() if confirm('Are you sure you want to reset DevDocs?') + when 'accept-analytics' then Cookies.set('analyticsConsent', '1') && app.reboot() + when 'decline-analytics' then Cookies.set('analyticsConsent', '0') && app.reboot() return diff --git a/assets/javascripts/views/layout/resizer.coffee b/assets/javascripts/views/layout/resizer.coffee index 86bb46f5..5584bfbe 100644 --- a/assets/javascripts/views/layout/resizer.coffee +++ b/assets/javascripts/views/layout/resizer.coffee @@ -11,9 +11,6 @@ class app.views.Resizer extends app.View init: -> @el.setAttribute('draggable', 'true') @appendTo $('._app') - - @style = $('style[data-resizer]') - @size = @style.getAttribute('data-size') return MIN = 260 @@ -24,15 +21,11 @@ class app.views.Resizer extends app.View 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) - @size = newSize - if save - app.settings.setSize(value) - app.appCache?.updateInBackground() + document.documentElement.style.setProperty('--sidebarWidth', newSize) + app.settings.setSize(value) if save return onDragStart: (event) => - @style.removeAttribute('disabled') event.dataTransfer.effectAllowed = 'link' event.dataTransfer.setData('Text', '') $.on(window, 'dragover', @onDrag) diff --git a/assets/javascripts/views/layout/settings.coffee b/assets/javascripts/views/layout/settings.coffee index 7888118a..6941b9cd 100644 --- a/assets/javascripts/views/layout/settings.coffee +++ b/assets/javascripts/views/layout/settings.coffee @@ -25,7 +25,6 @@ class app.views.Settings extends app.View if super @render() document.body.classList.remove(SIDEBAR_HIDDEN_LAYOUT) - app.appCache?.on 'progress', @onAppCacheProgress return deactivate: -> @@ -33,7 +32,6 @@ class app.views.Settings extends app.View @resetClass() @docPicker.detach() document.body.classList.add(SIDEBAR_HIDDEN_LAYOUT) if app.settings.hasLayout(SIDEBAR_HIDDEN_LAYOUT) - app.appCache?.off 'progress', @onAppCacheProgress return render: -> @@ -52,7 +50,7 @@ class app.views.Settings extends app.View 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() @@ -83,9 +81,3 @@ class app.views.Settings extends app.View $.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 diff --git a/assets/javascripts/views/search/search.coffee b/assets/javascripts/views/search/search.coffee index 8fab885c..7d05f0a0 100644 --- a/assets/javascripts/views/search/search.coffee +++ b/assets/javascripts/views/search/search.coffee @@ -30,6 +30,9 @@ class app.views.Search extends app.View .on 'results', @onResults .on 'end', @onEnd + @scope + .on 'change', @onScopeChange + app.on 'ready', @onReady $.on window, 'hashchange', @searchUrl $.on window, 'focus', @onWindowFocus @@ -138,6 +141,11 @@ class app.views.Search extends app.View $.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() diff --git a/assets/javascripts/views/search/search_scope.coffee b/assets/javascripts/views/search/search_scope.coffee index 24de57ce..52ff753a 100644 --- a/assets/javascripts/views/search/search_scope.coffee +++ b/assets/javascripts/views/search/search_scope.coffee @@ -6,7 +6,9 @@ class app.views.SearchScope extends app.View tag: '._search-tag' @events: + click: 'onClick' keydown: 'onKeydown' + textInput: 'onTextInput' @routes: after: 'afterRoute' @@ -87,17 +89,33 @@ class app.views.SearchScope extends app.View @trigger 'change', null, previousDoc return + doScopeSearch: (event) => + @search @input.value[0...@input.selectionStart] + $.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 - $.stopEvent(event) + if @doc and @input.selectionEnd is 0 @reset() - else if not @doc and @input.value + $.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 (event.which is 32 and app.isMobile()) # space - @search @input.value[0...@input.selectionStart] - $.stopEvent(event) if @doc + @doScopeSearch(event) + return + + onTextInput: (event) => + return unless $.isChromeForAndroid() + if not @doc and @input.value and event.data == ' ' + @doScopeSearch(event) return extractHashValue: -> diff --git a/assets/javascripts/views/sidebar/sidebar.coffee b/assets/javascripts/views/sidebar/sidebar.coffee index c8dc52a6..f3ae3bd4 100644 --- a/assets/javascripts/views/sidebar/sidebar.coffee +++ b/assets/javascripts/views/sidebar/sidebar.coffee @@ -28,7 +28,7 @@ class app.views.Sidebar extends app.View app.on 'ready', @onReady - $.on document.documentElement, 'mouseleave', (event) => @display() if event.clientX < 10 + $.on document.documentElement, 'mouseleave', (event) => @display() unless event.clientX <= 0 $.on document.documentElement, 'mouseenter', => @resetDisplay(forceNoHover: false) return diff --git a/assets/stylesheets/application.css.scss b/assets/stylesheets/application.css.scss index 2a64e5c9..85d1134f 100644 --- a/assets/stylesheets/application.css.scss +++ b/assets/stylesheets/application.css.scss @@ -1,7 +1,6 @@ -//= depend_on docs-1.png -//= depend_on docs-1@2x.png -//= depend_on docs-2.png -//= depend_on docs-2@2x.png +//= depend_on sprites/docs.png +//= depend_on sprites/docs@2x.png +//= depend_on sprites/docs.json /*! * Copyright 2013-2019 Thibaut Courouble and other contributors diff --git a/assets/stylesheets/components/_header.scss b/assets/stylesheets/components/_header.scss index 5bae8901..e74830aa 100644 --- a/assets/stylesheets/components/_header.scss +++ b/assets/stylesheets/components/_header.scss @@ -215,5 +215,6 @@ color: var(--textColorLight); background: var(--searchTagBackground); border-radius: 2px; + cursor: pointer; @extend %truncate-text; } diff --git a/assets/stylesheets/components/_notif.scss b/assets/stylesheets/components/_notif.scss index dd23c43a..f0880fdd 100644 --- a/assets/stylesheets/components/_notif.scss +++ b/assets/stylesheets/components/_notif.scss @@ -134,3 +134,7 @@ ._notif-info { color: var(--textColorLight); } } + +._notif-right { + float: right; +} diff --git a/assets/stylesheets/global/_icons.scss b/assets/stylesheets/global/_icons.scss deleted file mode 100644 index e7a805f4..00000000 --- a/assets/stylesheets/global/_icons.scss +++ /dev/null @@ -1,182 +0,0 @@ -%svg-icon { - display: inline-block; - vertical-align: top; - width: 1rem; - height: 1rem; - pointer-events: none; - fill: currentColor; -} - -%doc-icon { - content: ''; - display: block; - width: 1rem; - height: 1rem; - background-image: image-url('docs-1.png'); - background-size: 10rem 10rem; -} - -%doc-icon-2 { background-image: image-url('docs-2.png') !important; } - -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - %doc-icon { background-image: image-url('docs-1@2x.png'); } - %doc-icon-2 { background-image: image-url('docs-2@2x.png') !important; } -} - -html._theme-dark { - %darkIconFix { - filter: invert(100%) grayscale(100%); - -webkit-filter: invert(100%) grayscale(100%); - } -} - -._icon-jest:before { background-position: 0 0; } -._icon-liquid:before { background-position: -1rem 0; } -._icon-openjdk:before { background-position: -2rem 0; } -._icon-codeceptjs:before { background-position: -3rem 0; } -._icon-codeception:before { background-position: -4rem 0; } -._icon-sqlite:before { background-position: -5rem 0; @extend %darkIconFix !optional; } -._icon-async:before { background-position: -6rem 0; @extend %darkIconFix !optional; } -._icon-http:before { background-position: -7rem 0; @extend %darkIconFix !optional; } -._icon-jquery:before { background-position: -8rem 0; @extend %darkIconFix !optional; } -._icon-underscore:before { background-position: -9rem 0; @extend %darkIconFix !optional; } -._icon-html:before { background-position: 0 -1rem; } -._icon-css:before { background-position: -1rem -1rem; } -._icon-dom:before { background-position: -2rem -1rem; } -._icon-dom_events:before { background-position: -3rem -1rem; } -._icon-javascript:before { background-position: -4rem -1rem; } -._icon-backbone:before { background-position: -5rem -1rem; @extend %darkIconFix !optional; } -._icon-node:before, -._icon-node_lts:before { background-position: -6rem -1rem; } -._icon-sass:before { background-position: -7rem -1rem; } -._icon-less:before { background-position: -8rem -1rem; } -._icon-angularjs:before { background-position: -9rem -1rem; } -._icon-coffeescript:before { background-position: 0 -2rem; @extend %darkIconFix !optional; } -._icon-ember:before { background-position: -1rem -2rem; } -._icon-yarn:before { background-position: -2rem -2rem; } -._icon-immutable:before { background-position: -3rem -2rem; @extend %darkIconFix !optional; } -._icon-jqueryui:before { background-position: -4rem -2rem; } -._icon-jquerymobile:before { background-position: -5rem -2rem; } -._icon-lodash:before { background-position: -6rem -2rem; } -._icon-php:before { background-position: -7rem -2rem; } -._icon-ruby:before, -._icon-minitest:before { background-position: -8rem -2rem; } -._icon-rails:before { background-position: -9rem -2rem; } -._icon-python:before, -._icon-python2:before { background-position: 0 -3rem; } -._icon-git:before { background-position: -1rem -3rem; } -._icon-redis:before { background-position: -2rem -3rem; } -._icon-postgresql:before { background-position: -3rem -3rem; } -._icon-d3:before { background-position: -4rem -3rem; } -._icon-knockout:before { background-position: -5rem -3rem; } -._icon-moment:before { background-position: -6rem -3rem; @extend %darkIconFix !optional; } -._icon-c:before { background-position: -7rem -3rem; } -._icon-statsmodels:before { background-position: -8rem -3rem; } -._icon-yii:before, -._icon-yii1:before { background-position: -9rem -3rem; } -._icon-cpp:before { background-position: 0 -4rem; } -._icon-go:before { background-position: -1rem -4rem; } -._icon-express:before { background-position: -2rem -4rem; } -._icon-grunt:before { background-position: -3rem -4rem; } -._icon-rust:before { background-position: -4rem -4rem; @extend %darkIconFix !optional; } -._icon-laravel:before { background-position: -5rem -4rem; } -._icon-haskell:before { background-position: -6rem -4rem; } -._icon-requirejs:before { background-position: -7rem -4rem; } -._icon-chai:before { background-position: -8rem -4rem; } -._icon-sinon:before { background-position: -9rem -4rem; } -._icon-cordova:before { background-position: 0 -5rem; } -._icon-markdown:before { background-position: -1rem -5rem; @extend %darkIconFix !optional; } -._icon-django:before { background-position: -2rem -5rem; } -._icon-xslt_xpath:before { background-position: -3rem -5rem; } -._icon-nginx:before, -._icon-nginx_lua_module:before { background-position: -4rem -5rem; } -._icon-svg:before { background-position: -5rem -5rem; } -._icon-marionette:before { background-position: -6rem -5rem; } -._icon-jsdoc:before, -._icon-koa:before, -._icon-graphite:before, -._icon-mongoose:before { background-position: -7rem -5rem; } -._icon-phpunit:before { background-position: -8rem -5rem; } -._icon-nokogiri:before { background-position: -9rem -5rem; @extend %darkIconFix !optional; } -._icon-rethinkdb:before { background-position: 0 -6rem; } -._icon-react:before { background-position: -1rem -6rem; } -._icon-socketio:before { background-position: -2rem -6rem; } -._icon-modernizr:before { background-position: -3rem -6rem; } -._icon-bower:before { background-position: -4rem -6rem; } -._icon-fish:before { background-position: -5rem -6rem; @extend %darkIconFix !optional; } -._icon-scikit_image:before { background-position: -6rem -6rem; } -._icon-twig:before { background-position: -7rem -6rem; } -._icon-pandas:before { background-position: -8rem -6rem; } -._icon-scikit_learn:before { background-position: -9rem -6rem; } -._icon-bottle:before { background-position: 0 -7rem; } -._icon-docker:before { background-position: -1rem -7rem; } -._icon-cakephp:before { background-position: -2rem -7rem; } -._icon-lua:before { background-position: -3rem -7rem; @extend %darkIconFix !optional; } -._icon-clojure:before { background-position: -4rem -7rem; } -._icon-symfony:before { background-position: -5rem -7rem; } -._icon-mocha:before { background-position: -6rem -7rem; } -._icon-meteor:before { background-position: -7rem -7rem; @extend %darkIconFix !optional; } -._icon-npm:before { background-position: -8rem -7rem; } -._icon-apache_http_server:before { background-position: -9rem -7rem; } -._icon-drupal:before { background-position: 0 -8rem; } -._icon-webpack:before { background-position: -1rem -8rem; } -._icon-phaser:before { background-position: -2rem -8rem; } -._icon-vue:before { background-position: -3rem -8rem; } -._icon-opentsdb:before { background-position: -4rem -8rem; } -._icon-q:before { background-position: -5rem -8rem; } -._icon-crystal:before { background-position: -6rem -8rem; @extend %darkIconFix !optional; } -._icon-julia:before { background-position: -7rem -8rem; @extend %darkIconFix !optional; } -._icon-redux:before { background-position: -8rem -8rem; @extend %darkIconFix !optional; } -._icon-bootstrap:before { background-position: -9rem -8rem; } -._icon-react_native:before { background-position: 0 -9rem; } -._icon-phalcon:before { background-position: -1rem -9rem; } -._icon-matplotlib:before { background-position: -2rem -9rem; } -._icon-cmake:before { background-position: -3rem -9rem; } -._icon-elixir:before { background-position: -4rem -9rem; @extend %darkIconFix !optional; } -._icon-vagrant:before { background-position: -5rem -9rem; } -._icon-dojo:before { background-position: -6rem -9rem; } -._icon-flow:before { background-position: -7rem -9rem; } -._icon-relay:before { background-position: -8rem -9rem; } -._icon-phoenix:before { background-position: -9rem -9rem; } - -._icon-tcl_tk:before { background-position: 0 0; @extend %doc-icon-2; } -._icon-erlang:before { background-position: -1rem 0; @extend %doc-icon-2; } -._icon-chef:before { background-position: -2rem 0; @extend %doc-icon-2; } -._icon-ramda:before { background-position: -3rem 0; @extend %doc-icon-2; @extend %darkIconFix !optional; } -._icon-codeigniter:before { background-position: -4rem 0; @extend %doc-icon-2; @extend %darkIconFix !optional; } -._icon-influxdata:before { background-position: -5rem 0; @extend %doc-icon-2; @extend %darkIconFix !optional; } -._icon-tensorflow:before { background-position: -6rem 0; @extend %doc-icon-2; } -._icon-haxe:before { background-position: -7rem 0; @extend %doc-icon-2; } -._icon-ansible:before { background-position: -8rem 0; @extend %doc-icon-2; @extend %darkIconFix !optional; } -._icon-typescript:before { background-position: -9rem 0; @extend %doc-icon-2; } -._icon-browser_support_tables:before { background-position: 0rem -1rem; @extend %doc-icon-2; } -._icon-gnu_fortran:before { background-position: -1rem -1rem; @extend %doc-icon-2; } -._icon-gcc:before { background-position: -2rem -1rem; @extend %doc-icon-2; } -._icon-perl:before { background-position: -3rem -1rem; @extend %doc-icon-2; } -._icon-apache_pig:before { background-position: -4rem -1rem; @extend %doc-icon-2; } -._icon-numpy:before { background-position: -5rem -1rem; @extend %doc-icon-2; } -._icon-kotlin:before { background-position: -6rem -1rem; @extend %doc-icon-2; } -._icon-padrino:before { background-position: -7rem -1rem; @extend %doc-icon-2; } -._icon-angular:before { background-position: -8rem -1rem; @extend %doc-icon-2; } -._icon-love:before { background-position: -9rem -1rem; @extend %doc-icon-2; } -._icon-jasmine:before { background-position: 0 -2rem; @extend %doc-icon-2; } -._icon-pug:before { background-position: -1rem -2rem; @extend %doc-icon-2; } -._icon-electron:before { background-position: -2rem -2rem; @extend %doc-icon-2; } -._icon-falcon:before { background-position: -3rem -2rem; @extend %doc-icon-2; } -._icon-godot:before { background-position: -4rem -2rem; @extend %doc-icon-2; } -._icon-nim:before { background-position: -5rem -2rem; @extend %doc-icon-2; @extend %darkIconFix !optional; } -._icon-vulkan:before { background-position: -6rem -2rem; @extend %doc-icon-2; @extend %darkIconFix !optional; } -._icon-d:before { background-position: -7rem -2rem; @extend %doc-icon-2; } -._icon-bluebird:before { background-position: -8rem -2rem; @extend %doc-icon-2; } -._icon-eslint:before { background-position: -9rem -2rem; @extend %doc-icon-2; } -._icon-homebrew:before { background-position: 0 -3rem; @extend %doc-icon-2; } -._icon-jekyll:before { background-position: -1rem -3rem; @extend %doc-icon-2; } -._icon-babel:before { background-position: -2rem -3rem; @extend %doc-icon-2; } -._icon-leaflet:before { background-position: -3rem -3rem; @extend %doc-icon-2; } -._icon-terraform:before { background-position: -4rem -3rem; @extend %doc-icon-2; } -._icon-pygame:before { background-position: -5rem -3rem; @extend %doc-icon-2; } -._icon-bash:before { background-position: -6rem -3rem; @extend %doc-icon-2; } -._icon-dart:before { background-position: -7rem -3rem; @extend %doc-icon-2; } -._icon-qt:before { background-position: -8rem -3rem; @extend %doc-icon-2; } -._icon-puppeteer:before { background-position: -9rem -3rem; @extend %doc-icon-2; } -._icon-handlebars:before { background-position: 0 -4rem; @extend %doc-icon-2; @extend %darkIconFix !optional; } diff --git a/assets/stylesheets/global/_icons.scss.erb b/assets/stylesheets/global/_icons.scss.erb new file mode 100644 index 00000000..b2b22c22 --- /dev/null +++ b/assets/stylesheets/global/_icons.scss.erb @@ -0,0 +1,43 @@ +<% manifest = JSON.parse(File.read('assets/images/sprites/docs.json')) %> + +%svg-icon { + display: inline-block; + vertical-align: top; + width: 1rem; + height: 1rem; + pointer-events: none; + fill: currentColor; +} + +%doc-icon { + content: ''; + display: block; + width: 1rem; + height: 1rem; + background-image: image-url('sprites/docs.png'); + background-size: <%= manifest['icons_per_row'] %>rem <%= manifest['icons_per_row'] %>rem; +} + +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + %doc-icon { background-image: image-url('sprites/docs@2x.png'); } +} + +html._theme-dark { + %darkIconFix { + filter: invert(100%) grayscale(100%); + -webkit-filter: invert(100%) grayscale(100%); + } +} + +<%= + items = [] + + manifest['items'].each do |item| + rules = [] + rules << "background-position: -#{item['col']}rem -#{item['row']}rem;" + rules << "@extend %darkIconFix !optional;" if item['dark_icon_fix'] + items << "._icon-#{item['type']}:before { #{rules.join(' ')} }" + end + + items.join('') + %> diff --git a/docs/adding-docs.md b/docs/adding-docs.md index 03c6b87a..9984a15c 100644 --- a/docs/adding-docs.md +++ b/docs/adding-docs.md @@ -1,6 +1,6 @@ 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. -**Note:** please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/.github/CONTRIBUTING.md) before submitting a new documentation. +**Note:** please read the [contributing guidelines](../.github/CONTRIBUTING.md) before submitting a new documentation. 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). @@ -13,9 +13,11 @@ Adding a documentation may look like a daunting task but once you get the hang o 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). 7. Start the server, open the app, enable the documentation, and see how everything plays out. 8. Tweak the scraper/filters and repeat 5) and 6) until the pages and metadata are ok. -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). _(Note: feel free to submit a pull request without custom CSS/JS)_ +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. 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). -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 sprite after your pull request is merged. +11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 32x32-pixels formats. The icon spritesheet is automatically generated when you (re)start your local DevDocs instance. +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. +13. Ensure `thor updates:check [my_doc]` shows the correct latest version. 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.) diff --git a/docs/Filter-Reference.md b/docs/filter-reference.md similarity index 100% rename from docs/Filter-Reference.md rename to docs/filter-reference.md diff --git a/docs/maintainers.md b/docs/maintainers.md index d994a0fd..da7e910e 100644 --- a/docs/maintainers.md +++ b/docs/maintainers.md @@ -4,7 +4,7 @@ This document is intended for [DevDocs maintainers](#list-of-maintainers). ## Merging pull requests -- Unless the change is trivial or in an area that you are familiar with, PRs should be approved by at least two maintainers before being merged. +- PRs should be approved by at least one maintainer before being merged. - PRs that add or update documentations should always be merged locally, and the app deployed, before the merge is pushed to GitHub. @@ -21,8 +21,7 @@ The process for updating docs is as follow: - Commit the changes (protip: use the `thor docs:commit` command documented below). - Optional: do more updates. - Run `thor docs:upload` (documented below). -- [Deploy the app](#deploying-devdocs) and verify that everything works in production. -- Push to GitHub. +- Push to GitHub to [deploy the app](#deploying-devdocs) and verify that everything works in production. - Run `thor docs:clean` (documented below). 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`. @@ -82,21 +81,22 @@ In addition to the [publicly-documented commands](https://github.com/freeCodeCam ## Deploying DevDocs -Once docs have been uploaded via `thor docs:upload` (if applicable), deploying DevDocs is as simple as running `git push heroku master`. See [Heroku's documentation](https://devcenter.heroku.com/articles/git) for more information. +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. -- 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). +- 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. - If you're deploying frontend changes, monitor [Sentry](https://sentry.io/devdocs/devdocs-js/) for new JS errors once the deploy is done. - 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. -If any issue arises, run `heroku rollback` to rollback to the previous 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. +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. If this is your first deploy, make sure another maintainer is around to assist. ## List of maintainers -- [Beau Carnes](https://github.com/beaucarnes) - [Jed Fox](https://github.com/j-f1) - [Jasper van Merle](https://github.com/jmerle) +- [Ahmad Abdolsaheb](https://github.com/ahmadabdolsaheb) +- [Mrugesh Mohapatra](https://github.com/raisedadead) - [Thibaut Courouble](https://github.com/thibaut) Interested in helping maintain DevDocs? Come talk to us on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs) :) diff --git a/docs/Scraper-Reference.md b/docs/scraper-reference.md similarity index 86% rename from docs/Scraper-Reference.md rename to docs/scraper-reference.md index d9fe8b4a..c2872388 100644 --- a/docs/Scraper-Reference.md +++ b/docs/scraper-reference.md @@ -184,3 +184,44 @@ More information about how filters work is available on the [Filter Reference](. Overrides the `:title` option for the root page only. _Note: this filter is disabled by default._ + +## Keeping scrapers up-to-date + +In order to keep scrapers up-to-date the `get_latest_version(opts)` method should be overridden. If `self.release` is defined, this should return the latest version of the documentation. If `self.release` is not defined, it should return the Epoch time when the documentation was last modified. If the documentation will never change, simply return `1.0.0`. The result of this method is periodically reported in a "Documentation versions report" issue which helps maintainers keep track of outdated documentations. + +To make life easier, there are a few utility methods that you can use in `get_latest_version`: +* `fetch(url, opts)` + + Makes a GET request to the url and returns the response body. + + Example: [lib/docs/scrapers/bash.rb](../lib/docs/scrapers/bash.rb) +* `fetch_doc(url, opts)` + + Makes a GET request to the url and returns the HTML body converted to a Nokogiri document. + + Example: [lib/docs/scrapers/git.rb](../lib/docs/scrapers/git.rb) +* `fetch_json(url, opts)` + + Makes a GET request to the url and returns the JSON body converted to a dictionary. + + Example: [lib/docs/scrapers/mdn/mdn.rb](../lib/docs/scrapers/mdn/mdn.rb) +* `get_npm_version(package, opts)` + + Returns the latest version of the given npm package. + + Example: [lib/docs/scrapers/bower.rb](../lib/docs/scrapers/bower.rb) +* `get_latest_github_release(owner, repo, opts)` + + Returns the tag name of the latest GitHub release of the given repository. If the tag name is preceded by a "v", the "v" will be removed. + + Example: [lib/docs/scrapers/jsdoc.rb](../lib/docs/scrapers/jsdoc.rb) +* `get_github_tags(owner, repo, opts)` + + Returns the list of tags on the given repository ([format](https://developer.github.com/v3/repos/#list-tags)). + + Example: [lib/docs/scrapers/liquid.rb](../lib/docs/scrapers/liquid.rb) +* `get_github_file_contents(owner, repo, path, opts)` + + Returns the contents of the requested file in the default branch of the given repository. + + Example: [lib/docs/scrapers/minitest.rb](../lib/docs/scrapers/minitest.rb) diff --git a/lib/app.rb b/lib/app.rb index 32cac31b..a1ace892 100644 --- a/lib/app.rb +++ b/lib/app.rb @@ -37,6 +37,9 @@ class App < Sinatra::Application set :csp, false + require 'docs' + Docs.generate_manifest + Dir[docs_path, root.join(assets_prefix, '*/')].each do |path| sprockets.append_path(path) end @@ -50,6 +53,11 @@ class App < Sinatra::Application end configure :test, :development do + require 'thor' + load 'tasks/sprites.thor' + + SpritesCLI.new.invoke(:generate) + require 'active_support/per_thread_registry' require 'active_support/cache' sprockets.cache = ActiveSupport::Cache.lookup_store :file_store, root.join('tmp', 'cache', 'assets', environment.to_s) @@ -192,35 +200,45 @@ class App < Sinatra::Application request.query_string.empty? ? nil : "?#{request.query_string}" end - def manifest_asset_urls - @@manifest_asset_urls ||= [ + def service_worker_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') - ] + image_path('sprites/docs.png'), + image_path('sprites/docs@2x.png'), + asset_path('docs.js'), + App.production? ? nil : javascript_path('debug'), + ].compact end - def app_size - @app_size ||= memoized_cookies['size'].nil? ? '20rem' : "#{memoized_cookies['size']}px" - end + # Returns a cache name for the service worker to use which changes if any of the assets changes + # When a manifest exist, this name is only created once based on the asset manifest because it never changes without a server restart + # 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 - memoized_cookies['layout'] - end + digest = Sprockets::Manifest + .new(nil, App.assets_manifest_path) + .files + .values + .map {|file| file["digest"]} + .join - def app_theme - @app_theme ||= memoized_cookies['dark'].nil? ? 'default' : 'dark' - end + return @@service_worker_cache_name ||= Digest::MD5.hexdigest(digest) + else + paths = App.sprockets + .each_file + .to_a + .reject {|file| file.start_with?(App.docs_path)} - def dark_theme? - app_theme == 'dark' + return App.sprockets.pack_hexdigest(App.sprockets.files_digest(paths)) + 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 @@ -243,15 +261,15 @@ class App < Sinatra::Application end end - get '/manifest.appcache' do - content_type 'text/cache-manifest' + get '/service-worker.js' do + 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 diff --git a/lib/docs/core/doc.rb b/lib/docs/core/doc.rb index cb1cd209..da21daf8 100644 --- a/lib/docs/core/doc.rb +++ b/lib/docs/core/doc.rb @@ -152,7 +152,6 @@ module Docs end end - def initialize raise NotImplementedError, "#{self.class} is an abstract class and cannot be instantiated." if self.class.abstract end @@ -164,5 +163,104 @@ module Docs def build_pages(&block) raise NotImplementedError end + + def get_scraper_version(opts) + if self.class.method_defined?(:options) and !options[:release].nil? + options[:release] + else + # If options[:release] does not exist, we return the Epoch timestamp of when the doc was last modified in DevDocs production + json = fetch_json('https://devdocs.io/docs.json', opts) + items = json.select {|item| item['name'] == self.class.name} + items = items.map {|item| item['mtime']} + items.max + end + end + + # Should return the latest version of this documentation + # If options[:release] is defined, it should be in the same format + # If options[:release] is not defined, it should return the Epoch timestamp of when the documentation was last updated + # If the docs will never change, simply return '1.0.0' + def get_latest_version(opts) + raise NotImplementedError + end + + # Returns whether or not this scraper is outdated. + # + # The default implementation assumes the documentation uses a semver(-like) approach when it comes to versions. + # Patch updates are ignored because there are usually little to no documentation changes in bug-fix-only releases. + # + # Scrapers of documentations that do not use this versioning approach should override this method. + # + # Examples of the default implementation: + # 1 -> 2 = outdated + # 1.1 -> 1.2 = outdated + # 1.1.1 -> 1.1.2 = not outdated + def is_outdated(scraper_version, latest_version) + scraper_parts = scraper_version.to_s.split(/\./).map(&:to_i) + latest_parts = latest_version.to_s.split(/\./).map(&:to_i) + + # Only check the first two parts, the third part is for patch updates + [0, 1].each do |i| + break if i >= scraper_parts.length or i >= latest_parts.length + return true if latest_parts[i] > scraper_parts[i] + return false if latest_parts[i] < scraper_parts[i] + end + + false + end + + private + + # + # Utility methods for get_latest_version + # + + def fetch(url, opts) + headers = {} + + if opts.key?(:github_token) and url.start_with?('https://api.github.com/') + headers['Authorization'] = "token #{opts[:github_token]}" + end + + opts[:logger].debug("Fetching #{url}") + response = Request.run(url, { connecttimeout: 15, headers: headers }) + + if response.success? + response.body + else + reason = response.timed_out? ? "Timed out while connecting to #{url}" : "Couldn't fetch #{url} (response code #{response.code})" + opts[:logger].error(reason) + raise reason + end + end + + def fetch_doc(url, opts) + body = fetch(url, opts) + Nokogiri::HTML.parse(body, nil, 'UTF-8') + end + + def fetch_json(url, opts) + JSON.parse fetch(url, opts) + end + + def get_npm_version(package, opts) + json = fetch_json("https://registry.npmjs.com/#{package}", opts) + json['dist-tags']['latest'] + end + + def get_latest_github_release(owner, repo, opts) + release = fetch_json("https://api.github.com/repos/#{owner}/#{repo}/releases/latest", opts) + tag_name = release['tag_name'] + tag_name.start_with?('v') ? tag_name[1..-1] : tag_name + end + + def get_github_tags(owner, repo, opts) + fetch_json("https://api.github.com/repos/#{owner}/#{repo}/tags", opts) + end + + def get_github_file_contents(owner, repo, path, opts) + json = fetch_json("https://api.github.com/repos/#{owner}/#{repo}/contents/#{path}", opts) + Base64.decode64(json['content']) + end end end diff --git a/lib/docs/core/scrapers/file_scraper.rb b/lib/docs/core/scrapers/file_scraper.rb index 9d354631..72a99b99 100644 --- a/lib/docs/core/scrapers/file_scraper.rb +++ b/lib/docs/core/scrapers/file_scraper.rb @@ -29,7 +29,7 @@ module Docs def request_one(url) assert_source_directory_exists - Response.new read_file(url_to_path(url)), URL.parse(url) + Response.new read_file(File.join(source_directory, url_to_path(url))), URL.parse(url) end def request_all(urls) @@ -50,7 +50,7 @@ module Docs end def read_file(path) - File.read(File.join(source_directory, path)) + File.read(path) rescue instrument 'warn.doc', msg: "Failed to open file: #{path}" nil diff --git a/lib/docs/filters/elixir/clean_html.rb b/lib/docs/filters/elixir/clean_html.rb index 7ff3a86a..cf703389 100644 --- a/lib/docs/filters/elixir/clean_html.rb +++ b/lib/docs/filters/elixir/clean_html.rb @@ -57,6 +57,11 @@ module Docs node.parent.after(node) end + css('.signature').each do |node| + non_text_children = node.xpath('node()[not(self::text())]') + non_text_children.to_a.reverse.each { |child| node.parent.add_next_sibling(child) } + end + css('pre').each do |node| node['data-language'] = 'elixir' node.content = node.content diff --git a/lib/docs/filters/homebrew/clean_html.rb b/lib/docs/filters/homebrew/clean_html.rb index 5bf6aa29..6a81a5c6 100644 --- a/lib/docs/filters/homebrew/clean_html.rb +++ b/lib/docs/filters/homebrew/clean_html.rb @@ -4,6 +4,11 @@ module Docs def call css('hr') + if at_css('h1').nil? + title = current_url.normalized_path[1..-1].gsub(/-/, ' ') + doc.children.before("

    #{title}

    ") + end + css('div.highlighter-rouge').each do |node| lang = node['class'][/language-(\w+)/, 1] node['data-language'] = lang if lang diff --git a/lib/docs/filters/homebrew/entries.rb b/lib/docs/filters/homebrew/entries.rb index 03650ad9..c698cf72 100644 --- a/lib/docs/filters/homebrew/entries.rb +++ b/lib/docs/filters/homebrew/entries.rb @@ -2,7 +2,8 @@ module Docs class Homebrew class EntriesFilter < Docs::EntriesFilter def get_name - name = at_css('h1').content.strip + header = at_css('h1') + name = header.nil? ? current_url.normalized_path[1..-1].gsub(/-/, ' ') : header.content.strip name.remove! %r{\(.*} name end @@ -16,6 +17,7 @@ module Docs Python-for-Formula-Authors Migrating-A-Formula-To-A-Tap Rename-A-Formula + Building-Against-Non-Homebrew-Dependencies How-to-Create-and-Maintain-a-Tap Brew-Test-Bot Prose-Style-Guidelines) diff --git a/lib/docs/filters/qt/clean_html.rb b/lib/docs/filters/qt/clean_html.rb index f8f7ebd0..1772a765 100644 --- a/lib/docs/filters/qt/clean_html.rb +++ b/lib/docs/filters/qt/clean_html.rb @@ -8,6 +8,7 @@ module Docs # QML property/method header css('.qmlproto').each do |node| id = node.at_css('tr')['id'] + id = node.at_css('a')['name'] if id.blank? node.inner_html = node.at_css('td').inner_html node.name = 'h3' node['id'] = id diff --git a/lib/docs/filters/qt/entries.rb b/lib/docs/filters/qt/entries.rb index 64d342f1..27cd0a31 100644 --- a/lib/docs/filters/qt/entries.rb +++ b/lib/docs/filters/qt/entries.rb @@ -111,6 +111,7 @@ module Docs css('.qmlproto').each do |node| title = node.content.strip id = node.at_css('tr')['id'] + id = node.at_css('a')['name'] if id.blank? # Remove options title.remove!(%r{^\[.*\] }) diff --git a/lib/docs/scrapers/angular.rb b/lib/docs/scrapers/angular.rb index c318ce25..3365ec67 100644 --- a/lib/docs/scrapers/angular.rb +++ b/lib/docs/scrapers/angular.rb @@ -155,6 +155,10 @@ module Docs end end + def get_latest_version(opts) + get_npm_version('@angular/core', opts) + end + private def parse(response) diff --git a/lib/docs/scrapers/angularjs.rb b/lib/docs/scrapers/angularjs.rb index b8ff08b9..9d663e35 100644 --- a/lib/docs/scrapers/angularjs.rb +++ b/lib/docs/scrapers/angularjs.rb @@ -69,5 +69,9 @@ module Docs self.release = '1.2.32' self.base_url = "https://code.angularjs.org/#{release}/docs/partials/" end + + def get_latest_version(opts) + get_npm_version('angular', opts) + end end end diff --git a/lib/docs/scrapers/ansible.rb b/lib/docs/scrapers/ansible.rb index 2d62909a..b2363d4d 100644 --- a/lib/docs/scrapers/ansible.rb +++ b/lib/docs/scrapers/ansible.rb @@ -87,5 +87,10 @@ module Docs quickstart.html list_of_all_modules.html) end + + def get_latest_version(opts) + doc = fetch_doc('https://docs.ansible.com/ansible/latest/index.html', opts) + doc.at_css('.DocSiteProduct-CurrentVersion').content.strip + end end end diff --git a/lib/docs/scrapers/apache.rb b/lib/docs/scrapers/apache.rb index 9ee82f12..1301b574 100644 --- a/lib/docs/scrapers/apache.rb +++ b/lib/docs/scrapers/apache.rb @@ -33,5 +33,10 @@ module Docs © 2018 The Apache Software Foundation
    Licensed under the Apache License, Version 2.0. HTML + + def get_latest_version(opts) + doc = fetch_doc('http://httpd.apache.org/docs/', opts) + doc.at_css('#apcontents > ul a')['href'][0...-1] + end end end diff --git a/lib/docs/scrapers/apache_pig.rb b/lib/docs/scrapers/apache_pig.rb index 65897a78..f35085e6 100644 --- a/lib/docs/scrapers/apache_pig.rb +++ b/lib/docs/scrapers/apache_pig.rb @@ -43,5 +43,10 @@ module Docs self.base_url = "https://pig.apache.org/docs/r#{release}/" end + def get_latest_version(opts) + doc = fetch_doc('https://pig.apache.org/', opts) + item = doc.at_css('div[id="menu_1.2"] > .menuitem:last-child') + item.content.strip.sub(/Release /, '') + end end end diff --git a/lib/docs/scrapers/async.rb b/lib/docs/scrapers/async.rb index 40022f19..61615b54 100644 --- a/lib/docs/scrapers/async.rb +++ b/lib/docs/scrapers/async.rb @@ -17,5 +17,10 @@ module Docs © 2010–2018 Caolan McMahon
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://caolan.github.io/async/v3/', opts) + doc.at_css('#version-dropdown > a').content.strip[1..-1] + end end end diff --git a/lib/docs/scrapers/babel.rb b/lib/docs/scrapers/babel.rb index c9e40212..c8d716f1 100644 --- a/lib/docs/scrapers/babel.rb +++ b/lib/docs/scrapers/babel.rb @@ -22,5 +22,10 @@ module Docs stub '' do '
    ' end + + def get_latest_version(opts) + doc = fetch_doc('https://babeljs.io/docs/en/', opts) + doc.at_css('a[href="/versions"] > h3').content + end end end diff --git a/lib/docs/scrapers/backbone.rb b/lib/docs/scrapers/backbone.rb index b72b1084..2b33505e 100644 --- a/lib/docs/scrapers/backbone.rb +++ b/lib/docs/scrapers/backbone.rb @@ -20,5 +20,10 @@ module Docs © 2010–2016 Jeremy Ashkenas, DocumentCloud
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://backbonejs.org/', opts) + doc.at_css('.version').content[1...-1] + end end end diff --git a/lib/docs/scrapers/bash.rb b/lib/docs/scrapers/bash.rb index feb0ddce..ba4135ec 100644 --- a/lib/docs/scrapers/bash.rb +++ b/lib/docs/scrapers/bash.rb @@ -1,7 +1,7 @@ module Docs class Bash < UrlScraper self.type = 'bash' - self.release = '4.4' + self.release = '5.0' self.base_url = 'https://www.gnu.org/software/bash/manual' self.root_path = '/html_node/index.html' self.links = { @@ -17,5 +17,10 @@ module Docs Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
    Licensed under the GNU Free Documentation License. HTML + + def get_latest_version(opts) + body = fetch('https://www.gnu.org/software/bash/manual/html_node/index.html', opts) + body.scan(/, Version ([0-9.]+)/)[0][0][0...-1] + end end end diff --git a/lib/docs/scrapers/bluebird.rb b/lib/docs/scrapers/bluebird.rb index e5cd6b59..8f38120a 100644 --- a/lib/docs/scrapers/bluebird.rb +++ b/lib/docs/scrapers/bluebird.rb @@ -18,5 +18,9 @@ module Docs © 2013–2017 Petka Antonov
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('bluebird', opts) + end end end diff --git a/lib/docs/scrapers/bootstrap.rb b/lib/docs/scrapers/bootstrap.rb index 7b2406b8..8571462e 100644 --- a/lib/docs/scrapers/bootstrap.rb +++ b/lib/docs/scrapers/bootstrap.rb @@ -34,5 +34,10 @@ module Docs options[:only] = %w(getting-started/ css/ components/ javascript/) end + + def get_latest_version(opts) + doc = fetch_doc('https://getbootstrap.com/', opts) + doc.at_css('#bd-versions').content.strip[1..-1] + end end end diff --git a/lib/docs/scrapers/bottle.rb b/lib/docs/scrapers/bottle.rb index 25ad7f6e..d0397ec7 100644 --- a/lib/docs/scrapers/bottle.rb +++ b/lib/docs/scrapers/bottle.rb @@ -27,5 +27,11 @@ module Docs self.release = '0.11.7' self.base_url = "https://bottlepy.org/docs/#{self.version}/" end + + def get_latest_version(opts) + doc = fetch_doc('https://bottlepy.org/docs/stable/', opts) + label = doc.at_css('.sphinxsidebarwrapper > ul > li > b') + label.content.sub(/Bottle /, '') + end end end diff --git a/lib/docs/scrapers/bower.rb b/lib/docs/scrapers/bower.rb index b032f1d3..aab2a1e9 100644 --- a/lib/docs/scrapers/bower.rb +++ b/lib/docs/scrapers/bower.rb @@ -19,5 +19,9 @@ module Docs © 2018 Bower contributors
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('bower', opts) + end end end diff --git a/lib/docs/scrapers/c.rb b/lib/docs/scrapers/c.rb index f9289617..ec99f704 100644 --- a/lib/docs/scrapers/c.rb +++ b/lib/docs/scrapers/c.rb @@ -26,6 +26,13 @@ module Docs Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0. HTML + def get_latest_version(opts) + doc = fetch_doc('https://en.cppreference.com/w/Cppreference:Archives', opts) + link = doc.at_css('a[title^="File:"]') + date = link.content.scan(/(\d+)\./)[0][0] + DateTime.strptime(date, '%Y%m%d').to_time.to_i + end + private def file_path_for(*) diff --git a/lib/docs/scrapers/cakephp.rb b/lib/docs/scrapers/cakephp.rb index 08dbead0..6291b4ab 100644 --- a/lib/docs/scrapers/cakephp.rb +++ b/lib/docs/scrapers/cakephp.rb @@ -71,6 +71,11 @@ module Docs self.base_url = 'https://api.cakephp.org/2.7/' end + def get_latest_version(opts) + doc = fetch_doc('https://api.cakephp.org/3.7/', opts) + doc.at_css('.version-picker .dropdown-toggle').content.strip + end + private def parse(response) diff --git a/lib/docs/scrapers/chai.rb b/lib/docs/scrapers/chai.rb index 9d8aa4d2..759f7540 100644 --- a/lib/docs/scrapers/chai.rb +++ b/lib/docs/scrapers/chai.rb @@ -23,5 +23,9 @@ module Docs © 2016 Chai.js Assertion Library
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('chai', opts) + end end end diff --git a/lib/docs/scrapers/chef.rb b/lib/docs/scrapers/chef.rb index 2fd32a83..f0b7d6b0 100644 --- a/lib/docs/scrapers/chef.rb +++ b/lib/docs/scrapers/chef.rb @@ -47,5 +47,10 @@ module Docs options[:only_patterns] = [/\A#{client_path}\//, /\A#{server_path}\//] end + + def get_latest_version(opts) + doc = fetch_doc('https://downloads.chef.io/chef', opts) + doc.at_css('h1.product-heading > span').content.strip + end end end diff --git a/lib/docs/scrapers/clojure.rb b/lib/docs/scrapers/clojure.rb index c6bdcdea..5de4288e 100644 --- a/lib/docs/scrapers/clojure.rb +++ b/lib/docs/scrapers/clojure.rb @@ -13,19 +13,29 @@ module Docs Licensed under the Eclipse Public License 1.0. HTML - version '1.9' do - self.release = '1.9' + version '1.10' do + self.release = '1.10 (stable)' self.base_url = 'https://clojure.github.io/clojure/' end + version '1.9' do + self.release = '1.9 (legacy)' + self.base_url = 'https://clojure.github.io/clojure/branch-clojure-1.9.0/' + end + version '1.8' do - self.release = '1.8' + self.release = '1.8 (legacy)' self.base_url = 'https://clojure.github.io/clojure/branch-clojure-1.8.0/' end version '1.7' do - self.release = '1.7' + self.release = '1.7 (legacy)' self.base_url = 'https://clojure.github.io/clojure/branch-clojure-1.7.0/' end + + def get_latest_version(opts) + doc = fetch_doc('http://clojure.github.io/clojure/index.html', opts) + doc.at_css('#header-version').content[1..-1] + end end end diff --git a/lib/docs/scrapers/cmake.rb b/lib/docs/scrapers/cmake.rb index c455e4fd..7548a4a9 100644 --- a/lib/docs/scrapers/cmake.rb +++ b/lib/docs/scrapers/cmake.rb @@ -59,5 +59,11 @@ module Docs self.release = '3.5.2' self.base_url = 'https://cmake.org/cmake/help/v3.5/' end + + def get_latest_version(opts) + doc = fetch_doc('https://cmake.org/documentation/', opts) + link = doc.at_css('.entry-content ul > li > strong > a > big') + link.content.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/codeception.rb b/lib/docs/scrapers/codeception.rb index 919f146d..caafc9cf 100644 --- a/lib/docs/scrapers/codeception.rb +++ b/lib/docs/scrapers/codeception.rb @@ -18,5 +18,10 @@ module Docs © 2011 Michael Bodnarchuk and contributors
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://codeception.com/changelog', opts) + doc.at_css('#page > h4').content + end end end diff --git a/lib/docs/scrapers/codeceptjs.rb b/lib/docs/scrapers/codeceptjs.rb index 13189340..34d9b855 100644 --- a/lib/docs/scrapers/codeceptjs.rb +++ b/lib/docs/scrapers/codeceptjs.rb @@ -21,5 +21,9 @@ module Docs © 2015 DavertMik <davert@codegyre.com> (http://codegyre.com)
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('codeceptjs', opts) + end end end diff --git a/lib/docs/scrapers/codeigniter.rb b/lib/docs/scrapers/codeigniter.rb index 573f9b8c..05258d9a 100644 --- a/lib/docs/scrapers/codeigniter.rb +++ b/lib/docs/scrapers/codeigniter.rb @@ -38,5 +38,11 @@ module Docs version '3' do self.release = '3.1.8' end + + def get_latest_version(opts) + doc = fetch_doc('https://codeigniter.com/user_guide/changelog.html', opts) + header = doc.at_css('#change-log h2') + header.content.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/coffeescript.rb b/lib/docs/scrapers/coffeescript.rb index 23e9557f..695f3697 100644 --- a/lib/docs/scrapers/coffeescript.rb +++ b/lib/docs/scrapers/coffeescript.rb @@ -30,5 +30,9 @@ module Docs options[:container] = '.container' end + + def get_latest_version(opts) + get_npm_version('coffeescript', opts) + end end end diff --git a/lib/docs/scrapers/cordova.rb b/lib/docs/scrapers/cordova.rb index f74c72ff..65cf7f60 100644 --- a/lib/docs/scrapers/cordova.rb +++ b/lib/docs/scrapers/cordova.rb @@ -42,5 +42,15 @@ module Docs self.release = '6.5.0' self.base_url = 'https://cordova.apache.org/docs/en/6.x/' end + + def get_latest_version(opts) + doc = fetch_doc('https://cordova.apache.org/docs/en/latest/', opts) + + label = doc.at_css('#versionDropdown').content.strip + version = label.scan(/([0-9.]+)/)[0][0] + version = version[0...-1] if version.end_with?('.') + + version + end end end diff --git a/lib/docs/scrapers/cpp.rb b/lib/docs/scrapers/cpp.rb index 374f6883..f96ee8f1 100644 --- a/lib/docs/scrapers/cpp.rb +++ b/lib/docs/scrapers/cpp.rb @@ -34,6 +34,14 @@ module Docs Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0. HTML + # Same as get_latest_version in lib/docs/scrapers/c.rb + def get_latest_version(opts) + doc = fetch_doc('https://en.cppreference.com/w/Cppreference:Archives', opts) + link = doc.at_css('a[title^="File:"]') + date = link.content.scan(/(\d+)\./)[0][0] + DateTime.strptime(date, '%Y%m%d').to_time.to_i + end + private def file_path_for(*) diff --git a/lib/docs/scrapers/crystal.rb b/lib/docs/scrapers/crystal.rb index 29061a1d..14537c7f 100644 --- a/lib/docs/scrapers/crystal.rb +++ b/lib/docs/scrapers/crystal.rb @@ -34,5 +34,10 @@ module Docs HTML end } + + def get_latest_version(opts) + body = fetch('https://crystal-lang.org/api', opts) + body.scan(/Crystal Docs ([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/d.rb b/lib/docs/scrapers/d.rb index 6126380e..e1475b45 100644 --- a/lib/docs/scrapers/d.rb +++ b/lib/docs/scrapers/d.rb @@ -26,5 +26,10 @@ module Docs def initial_urls %w(https://dlang.org/phobos/index.html https://dlang.org/spec/intro.html) end + + def get_latest_version(opts) + doc = fetch_doc('https://dlang.org/changelog/', opts) + doc.at_css('#content > ul > li:nth-child(2) > a')['id'] + end end end diff --git a/lib/docs/scrapers/d3.rb b/lib/docs/scrapers/d3.rb index 26b27ca5..e26c1f3d 100644 --- a/lib/docs/scrapers/d3.rb +++ b/lib/docs/scrapers/d3.rb @@ -58,5 +58,9 @@ module Docs options[:root_title] = 'D3.js' options[:only_patterns] = [/\.md\z/] end + + def get_latest_version(opts) + get_npm_version('d3', opts) + end end end diff --git a/lib/docs/scrapers/dart.rb b/lib/docs/scrapers/dart.rb index c345c22f..322bfe2a 100644 --- a/lib/docs/scrapers/dart.rb +++ b/lib/docs/scrapers/dart.rb @@ -31,5 +31,11 @@ module Docs self.release = '1.24.3' self.base_url = "https://api.dartlang.org/stable/#{release}/" end + + def get_latest_version(opts) + doc = fetch_doc('https://api.dartlang.org/', opts) + label = doc.at_css('footer > span').content.strip + label.sub(/Dart /, '') + end end end diff --git a/lib/docs/scrapers/django.rb b/lib/docs/scrapers/django.rb index 45273540..6d48c6d7 100644 --- a/lib/docs/scrapers/django.rb +++ b/lib/docs/scrapers/django.rb @@ -63,5 +63,10 @@ module Docs self.release = '1.8.18' self.base_url = 'https://docs.djangoproject.com/en/1.8/' end + + def get_latest_version(opts) + doc = fetch_doc('https://docs.djangoproject.com/', opts) + doc.at_css('#doc-versions > li.current > span > strong').content + end end end diff --git a/lib/docs/scrapers/docker.rb b/lib/docs/scrapers/docker.rb index 9e457207..6ac8fea2 100644 --- a/lib/docs/scrapers/docker.rb +++ b/lib/docs/scrapers/docker.rb @@ -176,5 +176,11 @@ module Docs options[:container] = '#docs' options[:only_patterns] << /\Aswarm\// end + + def get_latest_version(opts) + doc = fetch_doc('https://docs.docker.com/', opts) + label = doc.at_css('.nav-container button.dropdown-toggle').content.strip + label.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/dojo.rb b/lib/docs/scrapers/dojo.rb index 937ed21a..79898916 100644 --- a/lib/docs/scrapers/dojo.rb +++ b/lib/docs/scrapers/dojo.rb @@ -36,6 +36,11 @@ module Docs urls.map { |url| "#{url}" }.join end + def get_latest_version(opts) + doc = fetch_doc('https://dojotoolkit.org/api/', opts) + doc.at_css('#versionSelector > option[selected]').content + end + private def get_url_list(json, set = Set.new) diff --git a/lib/docs/scrapers/drupal.rb b/lib/docs/scrapers/drupal.rb index 5710eb36..3798caec 100644 --- a/lib/docs/scrapers/drupal.rb +++ b/lib/docs/scrapers/drupal.rb @@ -98,5 +98,10 @@ module Docs /\A[\w\-\.]+\.php\/7\.x\z/ ] end + + def get_latest_version(opts) + json = fetch_json('https://packagist.org/packages/drupal/drupal.json', opts) + json['package']['versions'].keys.find {|version| !version.end_with?('-dev')} + end end end diff --git a/lib/docs/scrapers/electron.rb b/lib/docs/scrapers/electron.rb index 3cb399f0..8e635f49 100644 --- a/lib/docs/scrapers/electron.rb +++ b/lib/docs/scrapers/electron.rb @@ -22,5 +22,10 @@ module Docs © 2013–2018 GitHub Inc.
    Licensed under the MIT license. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://electronjs.org/docs', opts) + doc.at_css('.docs-version').content + end end end diff --git a/lib/docs/scrapers/elixir.rb b/lib/docs/scrapers/elixir.rb index 10d5aac1..f3cc94b2 100644 --- a/lib/docs/scrapers/elixir.rb +++ b/lib/docs/scrapers/elixir.rb @@ -33,8 +33,34 @@ module Docs "https://elixir-lang.org/getting-started/introduction.html" ] end + version '1.9' do + self.release = '1.9.1' + self.base_urls = [ + "https://hexdocs.pm/elixir/#{release}/", + "https://hexdocs.pm/eex/#{release}/", + "https://hexdocs.pm/ex_unit/#{release}/", + "https://hexdocs.pm/iex/#{release}/", + "https://hexdocs.pm/logger/#{release}/", + "https://hexdocs.pm/mix/#{release}/", + 'https://elixir-lang.org/getting-started/' + ] + end + + version '1.8' do + self.release = '1.8.2' + self.base_urls = [ + "https://hexdocs.pm/elixir/#{release}/", + "https://hexdocs.pm/eex/#{release}/", + "https://hexdocs.pm/ex_unit/#{release}/", + "https://hexdocs.pm/iex/#{release}/", + "https://hexdocs.pm/logger/#{release}/", + "https://hexdocs.pm/mix/#{release}/", + 'https://elixir-lang.org/getting-started/' + ] + end + version '1.7' do - self.release = '1.7.3' + self.release = '1.7.4' self.base_urls = [ "https://hexdocs.pm/elixir/#{release}/", "https://hexdocs.pm/eex/#{release}/", @@ -47,7 +73,7 @@ module Docs end version '1.6' do - self.release = '1.6.5' + self.release = '1.6.6' self.base_urls = [ "https://hexdocs.pm/elixir/#{release}/", "https://hexdocs.pm/eex/#{release}/", @@ -97,5 +123,10 @@ module Docs 'https://elixir-lang.org/getting-started/' ] end + + def get_latest_version(opts) + doc = fetch_doc('https://hexdocs.pm/elixir/api-reference.html', opts) + doc.at_css('h2.sidebar-projectVersion').content.strip[1..-1] + end end end diff --git a/lib/docs/scrapers/ember.rb b/lib/docs/scrapers/ember.rb index 3db20c94..6f853bb9 100644 --- a/lib/docs/scrapers/ember.rb +++ b/lib/docs/scrapers/ember.rb @@ -56,5 +56,10 @@ module Docs https://emberjs.com/api/ember-data/2.14/classes/DS ) end + + def get_latest_version(opts) + doc = fetch_doc('https://emberjs.com/api/ember/release', opts) + doc.at_css('.sidebar > .select-container .ember-power-select-selected-item').content.strip + end end end diff --git a/lib/docs/scrapers/erlang.rb b/lib/docs/scrapers/erlang.rb index d6aa2a0b..14a87cf5 100644 --- a/lib/docs/scrapers/erlang.rb +++ b/lib/docs/scrapers/erlang.rb @@ -55,5 +55,10 @@ module Docs version '18' do self.release = '18.3' end + + def get_latest_version(opts) + doc = fetch_doc('https://www.erlang.org/downloads', opts) + doc.at_css('.col-lg-3 > ul > li').content.strip.sub(/OTP /, '') + end end end diff --git a/lib/docs/scrapers/eslint.rb b/lib/docs/scrapers/eslint.rb index 8b4c9a2e..c213eacc 100644 --- a/lib/docs/scrapers/eslint.rb +++ b/lib/docs/scrapers/eslint.rb @@ -20,5 +20,9 @@ module Docs © JS Foundation and other contributors
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('eslint', opts) + end end end diff --git a/lib/docs/scrapers/express.rb b/lib/docs/scrapers/express.rb index 0fb4ed14..990019fb 100644 --- a/lib/docs/scrapers/express.rb +++ b/lib/docs/scrapers/express.rb @@ -28,5 +28,9 @@ module Docs © 2017 StrongLoop, IBM, and other expressjs.com contributors.
    Licensed under the Creative Commons Attribution-ShareAlike License v3.0. HTML + + def get_latest_version(opts) + get_npm_version('express', opts) + end end end diff --git a/lib/docs/scrapers/falcon.rb b/lib/docs/scrapers/falcon.rb index 5bfd8efc..8ba69150 100644 --- a/lib/docs/scrapers/falcon.rb +++ b/lib/docs/scrapers/falcon.rb @@ -33,5 +33,10 @@ module Docs self.release = '1.2.0' self.base_url = "https://falcon.readthedocs.io/en/#{self.release}/" end + + def get_latest_version(opts) + doc = fetch_doc('https://falcon.readthedocs.io/en/stable/changes/index.html', opts) + doc.at_css('#changelogs ul > li > a').content + end end end diff --git a/lib/docs/scrapers/fish.rb b/lib/docs/scrapers/fish.rb index 5ccfa71c..c9a98802 100644 --- a/lib/docs/scrapers/fish.rb +++ b/lib/docs/scrapers/fish.rb @@ -46,5 +46,10 @@ module Docs self.release = '2.2.0' self.base_url = "https://fishshell.com/docs/#{version}/" end + + def get_latest_version(opts) + doc = fetch_doc('http://fishshell.com/docs/current/index.html', opts) + doc.at_css('#toc-index').content.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/flow.rb b/lib/docs/scrapers/flow.rb index 16ea70dd..b3b5a02f 100644 --- a/lib/docs/scrapers/flow.rb +++ b/lib/docs/scrapers/flow.rb @@ -18,5 +18,9 @@ module Docs © 2013–present Facebook Inc.
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('flow-bin', opts) + end end end diff --git a/lib/docs/scrapers/git.rb b/lib/docs/scrapers/git.rb index 26b2da95..9de5cb0d 100644 --- a/lib/docs/scrapers/git.rb +++ b/lib/docs/scrapers/git.rb @@ -19,5 +19,10 @@ module Docs © 2005–2018 Linus Torvalds and others
    Licensed under the GNU General Public License version 2. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://git-scm.com/', opts) + doc.at_css('.version').content.strip + end end end diff --git a/lib/docs/scrapers/gnu/gcc.rb b/lib/docs/scrapers/gnu/gcc.rb index be3bb54e..565706d9 100644 --- a/lib/docs/scrapers/gnu/gcc.rb +++ b/lib/docs/scrapers/gnu/gcc.rb @@ -99,5 +99,11 @@ module Docs options[:replace_paths] = CPP_PATHS end + + def get_latest_version(opts) + doc = fetch_doc('https://gcc.gnu.org/onlinedocs/', opts) + label = doc.at_css('ul > li > ul > li > a').content.strip + label.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/gnu/gnu_fortran.rb b/lib/docs/scrapers/gnu/gnu_fortran.rb index 2610178e..dd18827c 100644 --- a/lib/docs/scrapers/gnu/gnu_fortran.rb +++ b/lib/docs/scrapers/gnu/gnu_fortran.rb @@ -25,5 +25,11 @@ module Docs self.release = '4.9.3' self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/" end + + def get_latest_version(opts) + doc = fetch_doc('https://gcc.gnu.org/onlinedocs/', opts) + label = doc.at_css('ul > li > ul > li > a').content.strip + label.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/go.rb b/lib/docs/scrapers/go.rb index 7b233317..27b46652 100644 --- a/lib/docs/scrapers/go.rb +++ b/lib/docs/scrapers/go.rb @@ -24,6 +24,11 @@ module Docs Licensed under the Creative Commons Attribution License 3.0. HTML + def get_latest_version(opts) + doc = fetch_doc('https://golang.org/project/', opts) + doc.at_css('#page ul > li > a').text[3..-1] + end + private def parse(response) # Hook here because Nokogori removes whitespace from textareas diff --git a/lib/docs/scrapers/godot.rb b/lib/docs/scrapers/godot.rb index 7e7da9a6..06c330b2 100644 --- a/lib/docs/scrapers/godot.rb +++ b/lib/docs/scrapers/godot.rb @@ -37,5 +37,10 @@ module Docs self.release = '2.1' self.base_url = "http://docs.godotengine.org/en/#{self.version}/" end + + def get_latest_version(opts) + doc = fetch_doc('https://docs.godotengine.org/', opts) + doc.at_css('.version').content.strip + end end end diff --git a/lib/docs/scrapers/graphite.rb b/lib/docs/scrapers/graphite.rb index 49ade898..83e9314a 100644 --- a/lib/docs/scrapers/graphite.rb +++ b/lib/docs/scrapers/graphite.rb @@ -17,5 +17,10 @@ module Docs © 2011–2016 The Graphite Project
    Licensed under the Apache License, Version 2.0. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://graphite.readthedocs.io/en/latest/releases.html', opts) + doc.at_css('#release-notes li > a').content + end end end diff --git a/lib/docs/scrapers/grunt.rb b/lib/docs/scrapers/grunt.rb index 2201c043..469d10a0 100644 --- a/lib/docs/scrapers/grunt.rb +++ b/lib/docs/scrapers/grunt.rb @@ -26,5 +26,9 @@ module Docs © GruntJS Team
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('grunt-cli', opts) + end end end diff --git a/lib/docs/scrapers/handlebars.rb b/lib/docs/scrapers/handlebars.rb index 22935d21..046cdf0f 100644 --- a/lib/docs/scrapers/handlebars.rb +++ b/lib/docs/scrapers/handlebars.rb @@ -19,5 +19,9 @@ module Docs © 2011–2017 by Yehuda Katz
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('handlebars', opts) + end end end diff --git a/lib/docs/scrapers/haskell.rb b/lib/docs/scrapers/haskell.rb index 442339b3..fb118851 100755 --- a/lib/docs/scrapers/haskell.rb +++ b/lib/docs/scrapers/haskell.rb @@ -10,7 +10,7 @@ module Docs html_filters.push 'haskell/entries', 'haskell/clean_html' - options[:container] = ->(filter) { filter.subpath.start_with?('users_guide') ? '.body' : '#content' } + options[:container] = ->(filter) {filter.subpath.start_with?('users_guide') ? '.body' : '#content'} options[:only_patterns] = [/\Alibraries\//, /\Ausers_guide\//] options[:skip_patterns] = [ @@ -68,5 +68,12 @@ module Docs options[:only_patterns] = [/\Alibraries\//] end + + def get_latest_version(opts) + doc = fetch_doc('https://downloads.haskell.org/~ghc/latest/docs/html/', opts) + links = doc.css('a').to_a + versions = links.map {|link| link['href'].scan(/ghc-([0-9.]+)/)} + versions.find {|version| !version.empty?}[0][0] + end end end diff --git a/lib/docs/scrapers/haxe.rb b/lib/docs/scrapers/haxe.rb index 33f20b93..2dbab01a 100644 --- a/lib/docs/scrapers/haxe.rb +++ b/lib/docs/scrapers/haxe.rb @@ -66,5 +66,11 @@ module Docs version 'Python' do self.base_url = 'https://api.haxe.org/python/' end + + def get_latest_version(opts) + doc = fetch_doc('https://api.haxe.org/', opts) + label = doc.at_css('.container.main-content h1 > small').content + label.sub(/version /, '') + end end end diff --git a/lib/docs/scrapers/homebrew.rb b/lib/docs/scrapers/homebrew.rb index fba79ec0..5743735f 100644 --- a/lib/docs/scrapers/homebrew.rb +++ b/lib/docs/scrapers/homebrew.rb @@ -2,7 +2,7 @@ module Docs class Homebrew < UrlScraper self.name = 'Homebrew' self.type = 'simple' - self.release = '1.8.1' + self.release = '2.1.9' self.base_url = 'https://docs.brew.sh/' self.links = { home: 'https://brew.sh', @@ -19,5 +19,9 @@ module Docs © 2009–present Homebrew contributors
    Licensed under the BSD 2-Clause License. HTML + + def get_latest_version(opts) + get_latest_github_release('Homebrew', 'brew', opts) + end end end diff --git a/lib/docs/scrapers/http.rb b/lib/docs/scrapers/http.rb index 60f15f75..90e6f5c1 100644 --- a/lib/docs/scrapers/http.rb +++ b/lib/docs/scrapers/http.rb @@ -7,6 +7,8 @@ module Docs html_filters.push 'http/clean_html', 'http/entries', 'title' + options[:mdn_tag] = 'HTTP' + options[:root_title] = 'HTTP' options[:title] = ->(filter) { filter.current_url.host == 'tools.ietf.org' ? false : filter.default_title } options[:container] = ->(filter) { filter.current_url.host == 'tools.ietf.org' ? '.content' : nil } diff --git a/lib/docs/scrapers/immutable.rb b/lib/docs/scrapers/immutable.rb index fa7fb81b..8b1b47a2 100644 --- a/lib/docs/scrapers/immutable.rb +++ b/lib/docs/scrapers/immutable.rb @@ -54,5 +54,9 @@ module Docs JS capybara.html end + + def get_latest_version(opts) + get_npm_version('immutable', opts) + end end end diff --git a/lib/docs/scrapers/influxdata.rb b/lib/docs/scrapers/influxdata.rb index 6c83b66b..db160f9c 100644 --- a/lib/docs/scrapers/influxdata.rb +++ b/lib/docs/scrapers/influxdata.rb @@ -46,5 +46,11 @@ module Docs © 2015 InfluxData, Inc.
    Licensed under the MIT license. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://docs.influxdata.com/influxdb/', opts) + label = doc.at_css('.navbar--current-product').content.strip + label.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/jasmine.rb b/lib/docs/scrapers/jasmine.rb index 82f3c9cf..b1971ecd 100644 --- a/lib/docs/scrapers/jasmine.rb +++ b/lib/docs/scrapers/jasmine.rb @@ -17,5 +17,9 @@ module Docs © 2008–2017 Pivotal Labs
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_latest_github_release('jasmine', 'jasmine', opts) + end end end diff --git a/lib/docs/scrapers/jekyll.rb b/lib/docs/scrapers/jekyll.rb index 1faaa9de..500eee10 100644 --- a/lib/docs/scrapers/jekyll.rb +++ b/lib/docs/scrapers/jekyll.rb @@ -28,5 +28,10 @@ module Docs © 2008–2018 Tom Preston-Werner and Jekyll contributors
    Licensed under the MIT license. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://jekyllrb.com/docs/', opts) + doc.at_css('.meta a').content[1..-1] + end end end diff --git a/lib/docs/scrapers/jest.rb b/lib/docs/scrapers/jest.rb index f4ce944f..a495d939 100644 --- a/lib/docs/scrapers/jest.rb +++ b/lib/docs/scrapers/jest.rb @@ -17,5 +17,10 @@ module Docs © 2014–present Facebook Inc.
    Licensed under the BSD License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://jestjs.io/docs/en/getting-started', opts) + doc.at_css('header > a > h3').content + end end end diff --git a/lib/docs/scrapers/jquery/jquery_core.rb b/lib/docs/scrapers/jquery/jquery_core.rb index 20aca0dc..a0c8b97a 100644 --- a/lib/docs/scrapers/jquery/jquery_core.rb +++ b/lib/docs/scrapers/jquery/jquery_core.rb @@ -22,5 +22,9 @@ module Docs /Selectors\/odd/i, /index/i ] + + def get_latest_version(opts) + get_npm_version('jquery', opts) + end end end diff --git a/lib/docs/scrapers/jquery/jquery_mobile.rb b/lib/docs/scrapers/jquery/jquery_mobile.rb index 8e5abf1c..5b856a95 100644 --- a/lib/docs/scrapers/jquery/jquery_mobile.rb +++ b/lib/docs/scrapers/jquery/jquery_mobile.rb @@ -16,5 +16,10 @@ module Docs options[:fix_urls] = ->(url) do url.sub! 'http://api.jquerymobile.com/', 'https://api.jquerymobile.com/' end + + def get_latest_version(opts) + doc = fetch_doc('https://jquerymobile.com/', opts) + doc.at_css('.download-box > .download-option:last-child > span').content.sub(/Version /, '') + end end end diff --git a/lib/docs/scrapers/jquery/jquery_ui.rb b/lib/docs/scrapers/jquery/jquery_ui.rb index 0c90fc1a..021d1d22 100644 --- a/lib/docs/scrapers/jquery/jquery_ui.rb +++ b/lib/docs/scrapers/jquery/jquery_ui.rb @@ -15,5 +15,9 @@ module Docs options[:fix_urls] = ->(url) do url.sub! 'http://api.jqueryui.com/', 'https://api.jqueryui.com/' end + + def get_latest_version(opts) + get_npm_version('jquery-ui', opts) + end end end diff --git a/lib/docs/scrapers/jsdoc.rb b/lib/docs/scrapers/jsdoc.rb index bb3781ca..df27e578 100644 --- a/lib/docs/scrapers/jsdoc.rb +++ b/lib/docs/scrapers/jsdoc.rb @@ -21,5 +21,9 @@ module Docs © 2011–2017 the contributors to the JSDoc 3 documentation project
    Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0. HTML + + def get_latest_version(opts) + get_latest_github_release('jsdoc3', 'jsdoc', opts) + end end end diff --git a/lib/docs/scrapers/julia.rb b/lib/docs/scrapers/julia.rb index 5bc16b77..c9c96da6 100644 --- a/lib/docs/scrapers/julia.rb +++ b/lib/docs/scrapers/julia.rb @@ -49,5 +49,9 @@ module Docs html_filters.push 'julia/entries_sphinx', 'julia/clean_html_sphinx', 'sphinx/clean_html' end + + def get_latest_version(opts) + get_latest_github_release('JuliaLang', 'julia', opts) + end end end diff --git a/lib/docs/scrapers/knockout.rb b/lib/docs/scrapers/knockout.rb index 663f7847..efad86f0 100644 --- a/lib/docs/scrapers/knockout.rb +++ b/lib/docs/scrapers/knockout.rb @@ -33,5 +33,9 @@ module Docs © Steven Sanderson, the Knockout.js team, and other contributors
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_latest_github_release('knockout', 'knockout', opts) + end end end diff --git a/lib/docs/scrapers/koa.rb b/lib/docs/scrapers/koa.rb index 3ce79cac..cac14920 100644 --- a/lib/docs/scrapers/koa.rb +++ b/lib/docs/scrapers/koa.rb @@ -34,5 +34,9 @@ module Docs © 2018 Koa contributors
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('koa', opts) + end end end diff --git a/lib/docs/scrapers/kotlin.rb b/lib/docs/scrapers/kotlin.rb index 415393d1..5055b65e 100644 --- a/lib/docs/scrapers/kotlin.rb +++ b/lib/docs/scrapers/kotlin.rb @@ -28,5 +28,9 @@ module Docs © 2010–2018 JetBrains s.r.o.
    Licensed under the Apache License, Version 2.0. HTML + + def get_latest_version(opts) + get_latest_github_release('JetBrains', 'kotlin', opts) + end end end diff --git a/lib/docs/scrapers/laravel.rb b/lib/docs/scrapers/laravel.rb index 5c88ae0f..e45b0bed 100644 --- a/lib/docs/scrapers/laravel.rb +++ b/lib/docs/scrapers/laravel.rb @@ -133,5 +133,9 @@ module Docs url end end + + def get_latest_version(opts) + get_latest_github_release('laravel', 'laravel', opts) + end end end diff --git a/lib/docs/scrapers/leaflet.rb b/lib/docs/scrapers/leaflet.rb index c8e2071c..38e497e7 100644 --- a/lib/docs/scrapers/leaflet.rb +++ b/lib/docs/scrapers/leaflet.rb @@ -39,5 +39,10 @@ module Docs self.base_url = "https://leafletjs.com/reference-#{release}.html" end + def get_latest_version(opts) + doc = fetch_doc('https://leafletjs.com/index.html', opts) + link = doc.css('ul > li > a').to_a.select {|node| node.content == 'Docs'}.first + link['href'].scan(/reference-([0-9.]+)\.html/)[0][0] + end end end diff --git a/lib/docs/scrapers/less.rb b/lib/docs/scrapers/less.rb index a0947e1a..b19bbe17 100644 --- a/lib/docs/scrapers/less.rb +++ b/lib/docs/scrapers/less.rb @@ -21,5 +21,11 @@ module Docs © 2009–2016 The Core Less Team
    Licensed under the Creative Commons Attribution License 3.0. HTML + + def get_latest_version(opts) + doc = fetch_doc('http://lesscss.org/features/', opts) + label = doc.at_css('.footer-links > li').content + label.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/liquid.rb b/lib/docs/scrapers/liquid.rb index 9ebc4041..b8e40d59 100644 --- a/lib/docs/scrapers/liquid.rb +++ b/lib/docs/scrapers/liquid.rb @@ -19,5 +19,10 @@ module Docs © 2005, 2006 Tobias Luetke
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + tags = get_github_tags('Shopify', 'liquid', opts) + tags[0]['name'][1..-1] + end end end diff --git a/lib/docs/scrapers/lodash.rb b/lib/docs/scrapers/lodash.rb index 0461f7b7..bce625e6 100644 --- a/lib/docs/scrapers/lodash.rb +++ b/lib/docs/scrapers/lodash.rb @@ -32,5 +32,10 @@ module Docs self.release = '2.4.2' self.base_url = "https://lodash.com/docs/#{release}" end + + def get_latest_version(opts) + doc = fetch_doc('https://lodash.com/docs/', opts) + doc.at_css('#version > option[selected]').content + end end end diff --git a/lib/docs/scrapers/love.rb b/lib/docs/scrapers/love.rb index 7f23bded..887b796f 100644 --- a/lib/docs/scrapers/love.rb +++ b/lib/docs/scrapers/love.rb @@ -39,5 +39,10 @@ module Docs © 2006–2016 LÖVE Development Team
    Licensed under the GNU Free Documentation License, Version 1.3. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://love2d.org/wiki/Version_History', opts) + doc.at_css('#mw-content-text table a').content + end end end diff --git a/lib/docs/scrapers/lua.rb b/lib/docs/scrapers/lua.rb index 40a5c007..e3608918 100644 --- a/lib/docs/scrapers/lua.rb +++ b/lib/docs/scrapers/lua.rb @@ -26,5 +26,10 @@ module Docs self.release = '5.1.5' self.base_url = 'https://www.lua.org/manual/5.1/' end + + def get_latest_version(opts) + doc = fetch_doc('https://www.lua.org/manual/', opts) + doc.at_css('p.menubar > a').content + end end end diff --git a/lib/docs/scrapers/marionette.rb b/lib/docs/scrapers/marionette.rb index fea6617f..fd1eab8e 100644 --- a/lib/docs/scrapers/marionette.rb +++ b/lib/docs/scrapers/marionette.rb @@ -38,5 +38,9 @@ module Docs html_filters.push 'marionette/entries_v2' end + + def get_latest_version(opts) + get_npm_version('backbone.marionette', opts) + end end end diff --git a/lib/docs/scrapers/markdown.rb b/lib/docs/scrapers/markdown.rb index 87e9c957..b837c692 100644 --- a/lib/docs/scrapers/markdown.rb +++ b/lib/docs/scrapers/markdown.rb @@ -13,5 +13,9 @@ module Docs © 2004 John Gruber
    Licensed under the BSD License. HTML + + def get_latest_version(opts) + '1.0.0' + end end end diff --git a/lib/docs/scrapers/matplotlib.rb b/lib/docs/scrapers/matplotlib.rb index ddd1f9de..eeecea71 100644 --- a/lib/docs/scrapers/matplotlib.rb +++ b/lib/docs/scrapers/matplotlib.rb @@ -64,5 +64,9 @@ module Docs "https://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/" ] end + + def get_latest_version(opts) + get_latest_github_release('matplotlib', 'matplotlib', opts) + end end end diff --git a/lib/docs/scrapers/mdn/css.rb b/lib/docs/scrapers/mdn/css.rb index 4c44f1f1..abb69b3a 100644 --- a/lib/docs/scrapers/mdn/css.rb +++ b/lib/docs/scrapers/mdn/css.rb @@ -6,6 +6,8 @@ module Docs html_filters.push 'css/clean_html', 'css/entries', 'title' + options[:mdn_tag] = 'CSS' + options[:root_title] = 'CSS' options[:skip] = %w(/CSS3 /Media/Visual /paged_media /Media/TV /Media/Tactile) diff --git a/lib/docs/scrapers/mdn/dom.rb b/lib/docs/scrapers/mdn/dom.rb index bbf95b20..a2202929 100644 --- a/lib/docs/scrapers/mdn/dom.rb +++ b/lib/docs/scrapers/mdn/dom.rb @@ -8,6 +8,8 @@ module Docs html_filters.push 'dom/clean_html', 'dom/entries', 'title' + options[:mdn_tag] = 'XSLT_Reference' + options[:root_title] = 'DOM' options[:skip] = %w( diff --git a/lib/docs/scrapers/mdn/dom_events.rb b/lib/docs/scrapers/mdn/dom_events.rb index fcbdc08f..258fbcd4 100644 --- a/lib/docs/scrapers/mdn/dom_events.rb +++ b/lib/docs/scrapers/mdn/dom_events.rb @@ -9,6 +9,8 @@ module Docs html_filters.insert_after 'clean_html', 'dom_events/clean_html' html_filters.push 'dom_events/entries', 'title' + options[:mdn_tag] = 'events' + options[:root_title] = 'DOM Events' options[:skip] = %w(/MozOrientation) diff --git a/lib/docs/scrapers/mdn/html.rb b/lib/docs/scrapers/mdn/html.rb index 4b28cefd..f38432f1 100644 --- a/lib/docs/scrapers/mdn/html.rb +++ b/lib/docs/scrapers/mdn/html.rb @@ -7,6 +7,8 @@ module Docs html_filters.push 'html/clean_html', 'html/entries', 'title' + options[:mdn_tag] = 'HTML' + options[:root_title] = 'HTML' options[:title] = ->(filter) do diff --git a/lib/docs/scrapers/mdn/javascript.rb b/lib/docs/scrapers/mdn/javascript.rb index 935df61c..cea55fc8 100644 --- a/lib/docs/scrapers/mdn/javascript.rb +++ b/lib/docs/scrapers/mdn/javascript.rb @@ -8,6 +8,8 @@ module Docs html_filters.push 'javascript/clean_html', 'javascript/entries', 'title' + options[:mdn_tag] = 'JavaScript' + options[:root_title] = 'JavaScript' # Don't want diff --git a/lib/docs/scrapers/mdn/mdn.rb b/lib/docs/scrapers/mdn/mdn.rb index 2ebd38aa..defb4533 100644 --- a/lib/docs/scrapers/mdn/mdn.rb +++ b/lib/docs/scrapers/mdn/mdn.rb @@ -21,6 +21,11 @@ module Docs Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later. HTML + def get_latest_version(opts) + json = fetch_json("https://developer.mozilla.org/en-US/docs/feeds/json/tag/#{options[:mdn_tag]}", opts) + DateTime.parse(json[0]['pubdate']).to_time.to_i + end + private def process_response?(response) diff --git a/lib/docs/scrapers/mdn/svg.rb b/lib/docs/scrapers/mdn/svg.rb index db9de7a1..66baf60d 100644 --- a/lib/docs/scrapers/mdn/svg.rb +++ b/lib/docs/scrapers/mdn/svg.rb @@ -8,6 +8,8 @@ module Docs html_filters.push 'svg/clean_html', 'svg/entries', 'title' + options[:mdn_tag] = 'XSLT_Reference' + options[:root_title] = 'SVG' options[:title] = ->(filter) do diff --git a/lib/docs/scrapers/mdn/xslt_xpath.rb b/lib/docs/scrapers/mdn/xslt_xpath.rb index 5d812dd4..9bf01c01 100644 --- a/lib/docs/scrapers/mdn/xslt_xpath.rb +++ b/lib/docs/scrapers/mdn/xslt_xpath.rb @@ -8,6 +8,8 @@ module Docs html_filters.push 'xslt_xpath/clean_html', 'xslt_xpath/entries', 'title' + options[:mdn_tag] = 'XSLT_Reference' + options[:root_title] = 'XSLT' options[:only_patterns] = [/\A\/XSLT/, /\A\/XPath/] diff --git a/lib/docs/scrapers/meteor.rb b/lib/docs/scrapers/meteor.rb index b38d5dc2..a758d154 100644 --- a/lib/docs/scrapers/meteor.rb +++ b/lib/docs/scrapers/meteor.rb @@ -45,5 +45,10 @@ module Docs self.base_urls = ['https://guide.meteor.com/v1.3/', "https://docs.meteor.com/v#{self.release}/"] options[:fix_urls] = nil end + + def get_latest_version(opts) + doc = fetch_doc('https://docs.meteor.com/#/full/', opts) + doc.at_css('select.version-select > option').content + end end end diff --git a/lib/docs/scrapers/mocha.rb b/lib/docs/scrapers/mocha.rb index 8ab9bdc8..04945425 100644 --- a/lib/docs/scrapers/mocha.rb +++ b/lib/docs/scrapers/mocha.rb @@ -18,5 +18,9 @@ module Docs © 2011–2018 JS Foundation and contributors
    Licensed under the Creative Commons Attribution 4.0 International License. HTML + + def get_latest_version(opts) + get_npm_version('mocha', opts) + end end end diff --git a/lib/docs/scrapers/modernizr.rb b/lib/docs/scrapers/modernizr.rb index 96c82153..01ad49a7 100644 --- a/lib/docs/scrapers/modernizr.rb +++ b/lib/docs/scrapers/modernizr.rb @@ -15,5 +15,9 @@ module Docs © 2009–2017 The Modernizr team
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('modernizr', opts) + end end end diff --git a/lib/docs/scrapers/moment.rb b/lib/docs/scrapers/moment.rb index 88df0d14..5b7491ea 100644 --- a/lib/docs/scrapers/moment.rb +++ b/lib/docs/scrapers/moment.rb @@ -22,5 +22,10 @@ module Docs © JS Foundation and other contributors
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + doc = fetch_doc('http://momentjs.com/', opts) + doc.at_css('.hero-title > h1 > span').content + end end end diff --git a/lib/docs/scrapers/mongoose.rb b/lib/docs/scrapers/mongoose.rb index 71ee04d2..fbd4ca92 100644 --- a/lib/docs/scrapers/mongoose.rb +++ b/lib/docs/scrapers/mongoose.rb @@ -26,5 +26,11 @@ module Docs © 2010 LearnBoost
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://mongoosejs.com/docs/', opts) + label = doc.at_css('.pure-menu-link').content.strip + label.sub(/Version /, '') + end end end diff --git a/lib/docs/scrapers/nginx.rb b/lib/docs/scrapers/nginx.rb index 5a3dbf1e..5354b8bd 100644 --- a/lib/docs/scrapers/nginx.rb +++ b/lib/docs/scrapers/nginx.rb @@ -25,5 +25,11 @@ module Docs © 2011-2018 Nginx, Inc.
    Licensed under the BSD License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://nginx.org/en/download.html', opts) + table = doc.at_css('#content > table').inner_html + table.scan(/nginx-([0-9.]+) Licensed under the BSD License. HTML + + def get_latest_version(opts) + tags = get_github_tags('openresty', 'lua-nginx-module', opts) + tag = tags.find {|tag| !tag['name'].include?('rc')} + tag['name'][1..-1] + end end end diff --git a/lib/docs/scrapers/nim.rb b/lib/docs/scrapers/nim.rb index cce16f1c..a927605d 100644 --- a/lib/docs/scrapers/nim.rb +++ b/lib/docs/scrapers/nim.rb @@ -17,5 +17,10 @@ module Docs © 2006–2018 Andreas Rumpf
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://nim-lang.org/docs/overview.html', opts) + doc.at_css('.container > .docinfo > tbody > tr:last-child > td').content.strip + end end end diff --git a/lib/docs/scrapers/node.rb b/lib/docs/scrapers/node.rb index 66c6a456..0e5ee8fa 100644 --- a/lib/docs/scrapers/node.rb +++ b/lib/docs/scrapers/node.rb @@ -46,5 +46,10 @@ module Docs self.release = '4.9.1' self.base_url = 'https://nodejs.org/dist/latest-v4.x/docs/api/' end + + def get_latest_version(opts) + doc = fetch_doc('https://nodejs.org/en/', opts) + doc.at_css('#home-intro > .home-downloadblock:last-of-type > a')['data-version'][1..-1] + end end end diff --git a/lib/docs/scrapers/nokogiri2.rb b/lib/docs/scrapers/nokogiri2.rb index 084ad2fb..7c28ca92 100644 --- a/lib/docs/scrapers/nokogiri2.rb +++ b/lib/docs/scrapers/nokogiri2.rb @@ -19,5 +19,9 @@ module Docs Patrick Mahoney, Yoko Harada, Akinori Musha, John Shahid, Lars Kanis
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_latest_github_release('sparklemotion', 'nokogiri', opts) + end end end diff --git a/lib/docs/scrapers/npm.rb b/lib/docs/scrapers/npm.rb index 2c854e6e..3f868a3c 100644 --- a/lib/docs/scrapers/npm.rb +++ b/lib/docs/scrapers/npm.rb @@ -29,5 +29,9 @@ module Docs Licensed under the npm License.
    npm is a trademark of npm, Inc. HTML + + def get_latest_version(opts) + get_latest_github_release('npm', 'cli', opts) + end end end diff --git a/lib/docs/scrapers/numpy.rb b/lib/docs/scrapers/numpy.rb index 1327fc02..84de6cab 100644 --- a/lib/docs/scrapers/numpy.rb +++ b/lib/docs/scrapers/numpy.rb @@ -49,5 +49,9 @@ module Docs self.release = '1.10.4' self.base_url = "https://docs.scipy.org/doc/numpy-#{self.release}/reference/" end + + def get_latest_version(opts) + get_latest_github_release('numpy', 'numpy', opts) + end end end diff --git a/lib/docs/scrapers/openjdk.rb b/lib/docs/scrapers/openjdk.rb index 944ac416..c26bce4c 100644 --- a/lib/docs/scrapers/openjdk.rb +++ b/lib/docs/scrapers/openjdk.rb @@ -86,5 +86,25 @@ module Docs def read_file(path) File.read(path).force_encoding('iso-8859-1').encode('utf-8') rescue nil end + + def get_latest_version(opts) + latest_version = 8 + current_attempt = latest_version + attempts = 0 + + while attempts < 3 + current_attempt += 1 + + doc = fetch_doc("https://packages.debian.org/sid/openjdk-#{current_attempt}-doc", opts) + if doc.at_css('.perror').nil? + latest_version = current_attempt + attempts = 0 + else + attempts += 1 + end + end + + latest_version + end end end diff --git a/lib/docs/scrapers/opentsdb.rb b/lib/docs/scrapers/opentsdb.rb index 0372e331..6eec407c 100644 --- a/lib/docs/scrapers/opentsdb.rb +++ b/lib/docs/scrapers/opentsdb.rb @@ -18,5 +18,9 @@ module Docs © 2010–2016 The OpenTSDB Authors
    Licensed under the GNU LGPLv2.1+ and GPLv3+ licenses. HTML + + def get_latest_version(opts) + get_latest_github_release('OpenTSDB', 'opentsdb', opts) + end end end diff --git a/lib/docs/scrapers/padrino.rb b/lib/docs/scrapers/padrino.rb index 218f1731..d34b7db5 100644 --- a/lib/docs/scrapers/padrino.rb +++ b/lib/docs/scrapers/padrino.rb @@ -23,5 +23,9 @@ module Docs stub 'index2' do request_one(url_for('index')).body end + + def get_latest_version(opts) + get_github_tags('padrino', 'padrino-framework', opts)[0]['name'] + end end end diff --git a/lib/docs/scrapers/pandas.rb b/lib/docs/scrapers/pandas.rb index 1355a012..a8c2ea51 100644 --- a/lib/docs/scrapers/pandas.rb +++ b/lib/docs/scrapers/pandas.rb @@ -49,5 +49,11 @@ module Docs self.release = '0.18.1' self.base_url = "http://pandas.pydata.org/pandas-docs/version/#{self.release}/" end + + def get_latest_version(opts) + doc = fetch_doc('http://pandas.pydata.org/pandas-docs/stable/', opts) + label = doc.at_css('.body > .section > p').content + label.scan(/Version: ([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/perl.rb b/lib/docs/scrapers/perl.rb index 142ceaa5..ebf0a653 100644 --- a/lib/docs/scrapers/perl.rb +++ b/lib/docs/scrapers/perl.rb @@ -43,5 +43,11 @@ module Docs self.release = '5.20.2' self.base_url = "https://perldoc.perl.org/#{self.release}/" end + + def get_latest_version(opts) + doc = fetch_doc('https://perldoc.perl.org/', opts) + header = doc.at_css('h2.h1').content + header.scan(/Perl ([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/phalcon.rb b/lib/docs/scrapers/phalcon.rb index c2cb9242..c6ca63f2 100644 --- a/lib/docs/scrapers/phalcon.rb +++ b/lib/docs/scrapers/phalcon.rb @@ -29,5 +29,10 @@ module Docs self.release = '2.0.13' self.base_url = 'https://docs.phalconphp.com/en/2.0.0/' end + + def get_latest_version(opts) + doc = fetch_doc('https://docs.phalconphp.com/', opts) + doc.at_css('.header__lang.expand > div > ul > li > a').content + end end end diff --git a/lib/docs/scrapers/phaser.rb b/lib/docs/scrapers/phaser.rb index 5ae371c1..bd5f411c 100644 --- a/lib/docs/scrapers/phaser.rb +++ b/lib/docs/scrapers/phaser.rb @@ -25,5 +25,9 @@ module Docs © 2016 Richard Davey, Photon Storm Ltd.
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_latest_github_release('photonstorm', 'phaser', opts) + end end end diff --git a/lib/docs/scrapers/phoenix.rb b/lib/docs/scrapers/phoenix.rb index 26b0144f..2ad053e2 100644 --- a/lib/docs/scrapers/phoenix.rb +++ b/lib/docs/scrapers/phoenix.rb @@ -46,5 +46,10 @@ module Docs HTML end } + + def get_latest_version(opts) + doc = fetch_doc('https://hexdocs.pm/phoenix/Phoenix.html', opts) + doc.at_css('.sidebar-projectVersion').content.strip[1..-1] + end end end diff --git a/lib/docs/scrapers/php.rb b/lib/docs/scrapers/php.rb index d4a66b5b..181d8b67 100644 --- a/lib/docs/scrapers/php.rb +++ b/lib/docs/scrapers/php.rb @@ -66,5 +66,11 @@ module Docs © 1997–2018 The PHP Documentation Group
    Licensed under the Creative Commons Attribution License v3.0 or later. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://secure.php.net/manual/en/doc.changelog.php', opts) + label = doc.at_css('tbody.gen-changelog > tr > td').content + label.split(',').last.strip + end end end diff --git a/lib/docs/scrapers/phpunit.rb b/lib/docs/scrapers/phpunit.rb index 665ca4c7..5f2cbfea 100644 --- a/lib/docs/scrapers/phpunit.rb +++ b/lib/docs/scrapers/phpunit.rb @@ -37,5 +37,11 @@ module Docs self.release = '4.8' self.base_url = "https://phpunit.de/manual/#{release}/en/" end + + def get_latest_version(opts) + doc = fetch_doc('https://phpunit.readthedocs.io/', opts) + label = doc.at_css('.rst-current-version').content.strip + label.scan(/v: ([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/postgresql.rb b/lib/docs/scrapers/postgresql.rb index 109685ba..cc7a85c8 100644 --- a/lib/docs/scrapers/postgresql.rb +++ b/lib/docs/scrapers/postgresql.rb @@ -80,5 +80,11 @@ module Docs html_filters.insert_before 'postgresql/extract_metadata', 'postgresql/normalize_class_names' end + + def get_latest_version(opts) + doc = fetch_doc('https://www.postgresql.org/docs/current/index.html', opts) + label = doc.at_css('#pgContentWrap h1.title').content + label.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/pug.rb b/lib/docs/scrapers/pug.rb index 76949529..79a1b0a8 100644 --- a/lib/docs/scrapers/pug.rb +++ b/lib/docs/scrapers/pug.rb @@ -18,6 +18,10 @@ module Docs Licensed under the MIT license. HTML + def get_latest_version(opts) + get_npm_version('pug', opts) + end + private def parse(response) # Hook here because Nokogori removes whitespace from textareas diff --git a/lib/docs/scrapers/puppeteer.rb b/lib/docs/scrapers/puppeteer.rb index 2e26c180..043380d5 100644 --- a/lib/docs/scrapers/puppeteer.rb +++ b/lib/docs/scrapers/puppeteer.rb @@ -14,5 +14,10 @@ module Docs © 2017 Google Inc
    Licensed under the Apache License 2.0. HTML + + def get_latest_version(opts) + contents = get_github_file_contents('GoogleChrome', 'puppeteer', 'README.md', opts) + contents.scan(/\/v([0-9.]+)\/docs\/api\.md/)[0][0] + end end end diff --git a/lib/docs/scrapers/pygame.rb b/lib/docs/scrapers/pygame.rb index 9da3148d..94c3d508 100644 --- a/lib/docs/scrapers/pygame.rb +++ b/lib/docs/scrapers/pygame.rb @@ -2,6 +2,7 @@ module Docs class Pygame < UrlScraper self.type = 'simple' self.release = '1.9.4' + self.base_url = 'https://www.pygame.org/docs/' self.root_path = 'py-modindex.html' self.links = { home: 'https://www.pygame.org/', @@ -16,5 +17,9 @@ module Docs © Pygame Developpers.
    Licensed under the GNU LGPL License version 2.1. HTML + + def get_latest_version(opts) + get_latest_github_release('pygame', 'pygame', opts) + end end end diff --git a/lib/docs/scrapers/python.rb b/lib/docs/scrapers/python.rb index aa4336d9..c7905591 100644 --- a/lib/docs/scrapers/python.rb +++ b/lib/docs/scrapers/python.rb @@ -50,5 +50,10 @@ module Docs html_filters.push 'python/entries_v2', 'sphinx/clean_html', 'python/clean_html' end + + def get_latest_version(opts) + doc = fetch_doc('https://docs.python.org/', opts) + doc.at_css('.version_switcher_placeholder').content + end end end diff --git a/lib/docs/scrapers/q.rb b/lib/docs/scrapers/q.rb index bb66c156..a4c449c0 100644 --- a/lib/docs/scrapers/q.rb +++ b/lib/docs/scrapers/q.rb @@ -19,5 +19,9 @@ module Docs © 2009–2017 Kristopher Michael Kowal
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('q', opts) + end end end diff --git a/lib/docs/scrapers/qt.rb b/lib/docs/scrapers/qt.rb index 412eca6d..4dc2aea0 100644 --- a/lib/docs/scrapers/qt.rb +++ b/lib/docs/scrapers/qt.rb @@ -103,9 +103,19 @@ module Docs Licensed under the GNU Free Documentation License, Version 1.3. HTML + version '5.13' do + self.release = '5.13' + self.base_url = 'https://doc.qt.io/qt-5.13/' + end + + version '5.12' do + self.release = '5.12' + self.base_url = 'https://doc.qt.io/qt-5.12/' + end + version '5.11' do self.release = '5.11' - self.base_url = 'https://doc.qt.io/qt-5/' + self.base_url = 'https://doc.qt.io/archives/qt-5.11/' end version '5.9' do @@ -115,7 +125,12 @@ module Docs version '5.6' do self.release = '5.6' - self.base_url = 'https://doc.qt.io/qt-5.6/' + self.base_url = 'https://doc.qt.io/archives/qt-5.6/' + end + + def get_latest_version(opts) + doc = fetch_doc('https://doc.qt.io/qt-5/index.html', opts) + doc.at_css('.mainContent h1.title').content.sub(/Qt /, '') end end end diff --git a/lib/docs/scrapers/ramda.rb b/lib/docs/scrapers/ramda.rb index 09ff46c8..0b86e365 100644 --- a/lib/docs/scrapers/ramda.rb +++ b/lib/docs/scrapers/ramda.rb @@ -15,6 +15,11 @@ module Docs © 2013–2016 Scott Sauyet and Michael Hurley
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://ramdajs.com/docs/', opts) + doc.at_css('.navbar-brand > .version').content[1..-1] + end end end diff --git a/lib/docs/scrapers/rdoc/minitest.rb b/lib/docs/scrapers/rdoc/minitest.rb index 761da1de..2a4249fc 100644 --- a/lib/docs/scrapers/rdoc/minitest.rb +++ b/lib/docs/scrapers/rdoc/minitest.rb @@ -21,5 +21,10 @@ module Docs © Ryan Davis, seattle.rb
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + contents = get_github_file_contents('seattlerb', 'minitest', 'History.rdoc', opts) + contents.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/rdoc/rails.rb b/lib/docs/scrapers/rdoc/rails.rb index 6bdce34a..0dec42a9 100644 --- a/lib/docs/scrapers/rdoc/rails.rb +++ b/lib/docs/scrapers/rdoc/rails.rb @@ -93,5 +93,9 @@ module Docs version '4.1' do self.release = '4.1.16' end + + def get_latest_version(opts) + get_latest_github_release('rails', 'rails', opts) + end end end diff --git a/lib/docs/scrapers/rdoc/ruby.rb b/lib/docs/scrapers/rdoc/ruby.rb index dd296765..bc064660 100644 --- a/lib/docs/scrapers/rdoc/ruby.rb +++ b/lib/docs/scrapers/rdoc/ruby.rb @@ -84,5 +84,16 @@ module Docs version '2.2' do self.release = '2.2.10' end + + def get_latest_version(opts) + tags = get_github_tags('ruby', 'ruby', opts) + tags.each do |tag| + version = tag['name'].gsub(/_/, '.')[1..-1] + + if !/^([0-9.]+)$/.match(version).nil? && version.count('.') == 2 + return version + end + end + end end end diff --git a/lib/docs/scrapers/react.rb b/lib/docs/scrapers/react.rb index 704f3189..3c41ea5a 100644 --- a/lib/docs/scrapers/react.rb +++ b/lib/docs/scrapers/react.rb @@ -30,5 +30,10 @@ module Docs © 2013–present Facebook Inc.
    Licensed under the Creative Commons Attribution 4.0 International Public License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://reactjs.org/docs/getting-started.html', opts) + doc.at_css('a[href="/versions"]').content.strip[1..-1] + end end end diff --git a/lib/docs/scrapers/react_native.rb b/lib/docs/scrapers/react_native.rb index d1f94001..fe87e492 100644 --- a/lib/docs/scrapers/react_native.rb +++ b/lib/docs/scrapers/react_native.rb @@ -30,5 +30,10 @@ module Docs © 2015–2018 Facebook Inc.
    Licensed under the Creative Commons Attribution 4.0 International Public License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://facebook.github.io/react-native/docs/getting-started.html', opts) + doc.at_css('header > a > h3').content + end end end diff --git a/lib/docs/scrapers/redis.rb b/lib/docs/scrapers/redis.rb index 201dbb47..81440a82 100644 --- a/lib/docs/scrapers/redis.rb +++ b/lib/docs/scrapers/redis.rb @@ -19,5 +19,11 @@ module Docs © 2009–2018 Salvatore Sanfilippo
    Licensed under the Creative Commons Attribution-ShareAlike License 4.0. HTML + + def get_latest_version(opts) + body = fetch('http://download.redis.io/redis-stable/00-RELEASENOTES', opts) + body = body.lines[1..-1].join + body.scan(/Redis ([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/redux.rb b/lib/docs/scrapers/redux.rb index cd7369ba..14f8e8b4 100644 --- a/lib/docs/scrapers/redux.rb +++ b/lib/docs/scrapers/redux.rb @@ -20,5 +20,9 @@ module Docs stub '' do request_one('http://redux.js.org/index.html').body end + + def get_latest_version(opts) + get_npm_version('redux', opts) + end end end diff --git a/lib/docs/scrapers/relay.rb b/lib/docs/scrapers/relay.rb index a020e9d7..807d6e1d 100644 --- a/lib/docs/scrapers/relay.rb +++ b/lib/docs/scrapers/relay.rb @@ -18,5 +18,10 @@ module Docs © 2013–present Facebook Inc.
    Licensed under the BSD License. HTML + + def get_latest_version(opts) + doc = fetch_doc('http://facebook.github.io/relay/en/', opts) + doc.at_css('header > a > h3').content[1..-1] + end end end diff --git a/lib/docs/scrapers/requirejs.rb b/lib/docs/scrapers/requirejs.rb index 200f1f2d..80ecc722 100644 --- a/lib/docs/scrapers/requirejs.rb +++ b/lib/docs/scrapers/requirejs.rb @@ -30,5 +30,9 @@ module Docs © jQuery Foundation and other contributors
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('requirejs', opts) + end end end diff --git a/lib/docs/scrapers/rethinkdb.rb b/lib/docs/scrapers/rethinkdb.rb index 023bbe77..35d8d334 100644 --- a/lib/docs/scrapers/rethinkdb.rb +++ b/lib/docs/scrapers/rethinkdb.rb @@ -58,6 +58,10 @@ module Docs CODE end + def get_latest_version(opts) + get_latest_github_release('rethinkdb', 'rethinkdb', opts) + end + private def process_response?(response) diff --git a/lib/docs/scrapers/rust.rb b/lib/docs/scrapers/rust.rb index 1677e138..635afc1c 100644 --- a/lib/docs/scrapers/rust.rb +++ b/lib/docs/scrapers/rust.rb @@ -39,6 +39,12 @@ module Docs Licensed under the Apache License, Version 2.0 or the MIT license, at your option. HTML + def get_latest_version(opts) + doc = fetch_doc('https://www.rust-lang.org/', opts) + label = doc.at_css('.button-download + p > a').content + label.sub(/Version /, '') + end + private REDIRECT_RGX = /http-equiv="refresh"/i diff --git a/lib/docs/scrapers/sass.rb b/lib/docs/scrapers/sass.rb index 244a88e7..c9774cdf 100644 --- a/lib/docs/scrapers/sass.rb +++ b/lib/docs/scrapers/sass.rb @@ -23,5 +23,9 @@ module Docs © 2006–2016 Hampton Catlin, Nathan Weizenbaum, and Chris Eppstein
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_latest_github_release('sass', 'libsass', opts) + end end end diff --git a/lib/docs/scrapers/scikit_image.rb b/lib/docs/scrapers/scikit_image.rb index 2a60aaec..a5959581 100644 --- a/lib/docs/scrapers/scikit_image.rb +++ b/lib/docs/scrapers/scikit_image.rb @@ -20,5 +20,10 @@ module Docs © 2011 the scikit-image team
    Licensed under the BSD 3-clause License. HTML + + def get_latest_version(opts) + tags = get_github_tags('scikit-image', 'scikit-image', opts) + tags[0]['name'][1..-1] + end end end diff --git a/lib/docs/scrapers/scikit_learn.rb b/lib/docs/scrapers/scikit_learn.rb index fe6a8665..973c9d7e 100644 --- a/lib/docs/scrapers/scikit_learn.rb +++ b/lib/docs/scrapers/scikit_learn.rb @@ -25,5 +25,9 @@ module Docs Licensed under the 3-clause BSD License. HTML + def get_latest_version(opts) + doc = fetch_doc('https://scikit-learn.org/stable/documentation.html', opts) + doc.at_css('.body h1').content.scan(/([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/sinon.rb b/lib/docs/scrapers/sinon.rb index 9e81cba9..632348dc 100644 --- a/lib/docs/scrapers/sinon.rb +++ b/lib/docs/scrapers/sinon.rb @@ -52,5 +52,10 @@ module Docs self.release = '1.17.7' self.base_url = "https://sinonjs.org/releases/v#{release}/" end + + def get_latest_version(opts) + body = fetch('https://sinonjs.org/', opts) + body.scan(/\/releases\/v([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/socketio.rb b/lib/docs/scrapers/socketio.rb index 427098c4..e9bc264a 100644 --- a/lib/docs/scrapers/socketio.rb +++ b/lib/docs/scrapers/socketio.rb @@ -20,5 +20,9 @@ module Docs © 2014–2015 Automattic
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + get_npm_version('socket.io', opts) + end end end diff --git a/lib/docs/scrapers/sqlite.rb b/lib/docs/scrapers/sqlite.rb index 790acf83..d3a5fa6b 100644 --- a/lib/docs/scrapers/sqlite.rb +++ b/lib/docs/scrapers/sqlite.rb @@ -41,6 +41,11 @@ module Docs options[:attribution] = 'SQLite is in the Public Domain.' + def get_latest_version(opts) + doc = fetch_doc('https://sqlite.org/chronology.html', opts) + doc.at_css('#chrontab > tbody > tr > td:last-child > a').content + end + private def parse(response) diff --git a/lib/docs/scrapers/statsmodels.rb b/lib/docs/scrapers/statsmodels.rb index 255bde6c..3e8a357c 100644 --- a/lib/docs/scrapers/statsmodels.rb +++ b/lib/docs/scrapers/statsmodels.rb @@ -21,5 +21,9 @@ module Docs Licensed under the 3-clause BSD License. HTML + def get_latest_version(opts) + doc = fetch_doc('http://www.statsmodels.org/stable/', opts) + doc.at_css('.sphinxsidebarwrapper h3 + p > b').content[1..-1] + end end end diff --git a/lib/docs/scrapers/support_tables.rb b/lib/docs/scrapers/support_tables.rb index 9a550c1e..d04072da 100644 --- a/lib/docs/scrapers/support_tables.rb +++ b/lib/docs/scrapers/support_tables.rb @@ -178,5 +178,11 @@ module Docs

    HTML + + def get_latest_version(opts) + body = fetch('https://feeds.feedburner.com/WhenCanIUse?format=xml', opts) + timestamp = body.scan(/([^<]+)<\/updated>/)[0][0] + DateTime.parse(timestamp).to_time.to_i + end end end diff --git a/lib/docs/scrapers/symfony.rb b/lib/docs/scrapers/symfony.rb index f5e4285a..4bdde054 100644 --- a/lib/docs/scrapers/symfony.rb +++ b/lib/docs/scrapers/symfony.rb @@ -70,5 +70,9 @@ module Docs self.release = '2.7.35' self.base_url = "https://api.symfony.com/#{version}/" end + + def get_latest_version(opts) + get_latest_github_release('symfony', 'symfony', opts) + end end end diff --git a/lib/docs/scrapers/tcl_tk.rb b/lib/docs/scrapers/tcl_tk.rb index 1e4b2567..bca840c6 100644 --- a/lib/docs/scrapers/tcl_tk.rb +++ b/lib/docs/scrapers/tcl_tk.rb @@ -25,5 +25,10 @@ module Docs options[:attribution] = <<-HTML Licensed under Tcl/Tk terms HTML + + def get_latest_version(opts) + doc = fetch_doc('https://www.tcl.tk/man/tcl/contents.htm', opts) + doc.at_css('h2').content.scan(/Tk([0-9.]+)/)[0][0] + end end end diff --git a/lib/docs/scrapers/tensorflow.rb b/lib/docs/scrapers/tensorflow.rb index 0296299f..9638b516 100644 --- a/lib/docs/scrapers/tensorflow.rb +++ b/lib/docs/scrapers/tensorflow.rb @@ -56,6 +56,10 @@ module Docs /\Aextend/] end + def get_latest_version(opts) + get_latest_github_release('tensorflow', 'tensorflow', opts) + end + private def parse(response) diff --git a/lib/docs/scrapers/terraform.rb b/lib/docs/scrapers/terraform.rb index ab12775d..0965ad06 100644 --- a/lib/docs/scrapers/terraform.rb +++ b/lib/docs/scrapers/terraform.rb @@ -18,5 +18,10 @@ module Docs © 2018 HashiCorp
    Licensed under the MPL 2.0 License. HTML + + def get_latest_version(opts) + contents = get_github_file_contents('hashicorp', 'terraform-website', 'content/config.rb', opts) + contents.scan(/version\s+=\s+"([0-9.]+)"/)[0][0] + end end end diff --git a/lib/docs/scrapers/twig.rb b/lib/docs/scrapers/twig.rb index 4781dcb2..e52ff6bd 100755 --- a/lib/docs/scrapers/twig.rb +++ b/lib/docs/scrapers/twig.rb @@ -28,5 +28,10 @@ module Docs self.release = '1.34.3' self.base_url = 'https://twig.symfony.com/doc/1.x/' end + + def get_latest_version(opts) + tags = get_github_tags('twigphp', 'Twig', opts) + tags[0]['name'][1..-1] + end end end diff --git a/lib/docs/scrapers/typescript.rb b/lib/docs/scrapers/typescript.rb index 1117314a..777f5dd6 100644 --- a/lib/docs/scrapers/typescript.rb +++ b/lib/docs/scrapers/typescript.rb @@ -24,6 +24,10 @@ module Docs © Microsoft and other contributors
    Licensed under the Apache License, Version 2.0. HTML + + def get_latest_version(opts) + get_latest_github_release('Microsoft', 'TypeScript', opts) + end end end diff --git a/lib/docs/scrapers/underscore.rb b/lib/docs/scrapers/underscore.rb index 004a09e9..a09b4acb 100644 --- a/lib/docs/scrapers/underscore.rb +++ b/lib/docs/scrapers/underscore.rb @@ -20,5 +20,10 @@ module Docs © 2009–2018 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
    Licensed under the MIT License. HTML + + def get_latest_version(opts) + doc = fetch_doc('https://underscorejs.org/', opts) + doc.at_css('.version').content[1...-1] + end end end diff --git a/lib/docs/scrapers/vagrant.rb b/lib/docs/scrapers/vagrant.rb index 955746aa..7400fc8c 100644 --- a/lib/docs/scrapers/vagrant.rb +++ b/lib/docs/scrapers/vagrant.rb @@ -18,5 +18,10 @@ module Docs © 2010–2018 Mitchell Hashimoto
    Licensed under the MPL 2.0 License. HTML + + def get_latest_version(opts) + contents = get_github_file_contents('hashicorp', 'vagrant', 'website/config.rb', opts) + contents.scan(/version\s+=\s+"([0-9.]+)"/)[0][0] + end end end diff --git a/lib/docs/scrapers/vue.rb b/lib/docs/scrapers/vue.rb index f92991f2..333ade1d 100644 --- a/lib/docs/scrapers/vue.rb +++ b/lib/docs/scrapers/vue.rb @@ -32,5 +32,9 @@ module Docs self.root_path = '/guide/index.html' self.initial_paths = %w(/api/index.html) end + + def get_latest_version(opts) + get_latest_github_release('vuejs', 'vue', opts) + end end end diff --git a/lib/docs/scrapers/vulkan.rb b/lib/docs/scrapers/vulkan.rb index e1fa4b4b..da5d696d 100644 --- a/lib/docs/scrapers/vulkan.rb +++ b/lib/docs/scrapers/vulkan.rb @@ -20,5 +20,10 @@ module Docs Licensed under the Creative Commons Attribution 4.0 International License.
    Vulkan and the Vulkan logo are registered trademarks of the Khronos Group Inc. HTML + + def get_latest_version(opts) + tags = get_github_tags('KhronosGroup', 'Vulkan-Docs', opts) + tags[0]['name'][1..-1] + end end end diff --git a/lib/docs/scrapers/webpack.rb b/lib/docs/scrapers/webpack.rb index 255c1bb4..7af2cf11 100644 --- a/lib/docs/scrapers/webpack.rb +++ b/lib/docs/scrapers/webpack.rb @@ -68,5 +68,9 @@ module Docs Licensed under the MIT License. HTML end + + def get_latest_version(opts) + get_npm_version('webpack', opts) + end end end diff --git a/lib/docs/scrapers/yarn.rb b/lib/docs/scrapers/yarn.rb index 825a749f..c45695af 100644 --- a/lib/docs/scrapers/yarn.rb +++ b/lib/docs/scrapers/yarn.rb @@ -20,5 +20,9 @@ module Docs © 2016–present Yarn Contributors
    Licensed under the BSD License. HTML + + def get_latest_version(opts) + get_latest_github_release('yarnpkg', 'yarn', opts) + end end end diff --git a/lib/docs/scrapers/yii.rb b/lib/docs/scrapers/yii.rb index d99d3ac7..eaabdbf0 100755 --- a/lib/docs/scrapers/yii.rb +++ b/lib/docs/scrapers/yii.rb @@ -34,5 +34,9 @@ module Docs options[:container] = '.grid_9' end + + def get_latest_version(opts) + get_latest_github_release('yiisoft', 'yii2', opts) + end end end diff --git a/lib/tasks/assets.thor b/lib/tasks/assets.thor index c3a4caf5..e9de1b6f 100644 --- a/lib/tasks/assets.thor +++ b/lib/tasks/assets.thor @@ -14,6 +14,9 @@ class AssetsCLI < Thor option :keep, type: :numeric, default: 0, desc: 'Number of old assets to keep' option :verbose, type: :boolean def compile + load 'tasks/sprites.thor' + invoke 'sprites:generate', [], :remove_public_icons => true, :verbose => options[:verbose] + manifest.compile App.assets_compile manifest.clean(options[:keep]) if options[:clean] end diff --git a/lib/tasks/sprites.thor b/lib/tasks/sprites.thor new file mode 100644 index 00000000..1c0d3600 --- /dev/null +++ b/lib/tasks/sprites.thor @@ -0,0 +1,213 @@ +class SpritesCLI < Thor + def self.to_s + 'Sprites' + end + + def initialize(*args) + require 'docs' + require 'chunky_png' + require 'fileutils' + super + end + + desc 'generate [--remove-public-icons] [--verbose]', 'Generate the documentation icon spritesheets' + option :remove_public_icons, type: :boolean, desc: 'Remove public/icons after generating the spritesheets' + option :verbose, type: :boolean + def generate + items = get_items + items_with_icons = items.select {|item| item[:has_icons]} + items_without_icons = items.select {|item| !item[:has_icons]} + icons_per_row = Math.sqrt(items_with_icons.length).ceil + + bg_color = get_sidebar_background + + items_with_icons.each_with_index do |item, index| + item[:row] = (index / icons_per_row).floor + item[:col] = index - item[:row] * icons_per_row + + item[:icon_16] = get_icon(item[:path_16], 16) + item[:icon_32] = get_icon(item[:path_32], 32) + + item[:dark_icon_fix] = needs_dark_icon_fix(item[:icon_32], bg_color) + end + + return unless items_with_icons.length > 0 + + log_details(items_with_icons, icons_per_row) + + generate_spritesheet(16, items_with_icons, 'assets/images/sprites/docs.png') {|item| item[:icon_16]} + generate_spritesheet(32, items_with_icons, 'assets/images/sprites/docs@2x.png') {|item| item[:icon_32]} + + # Add Mongoose's icon details to docs without custom icons + default_item = items_with_icons.find {|item| item[:type] == 'mongoose'} + items_without_icons.each do |item| + item[:row] = default_item[:row] + item[:col] = default_item[:col] + item[:dark_icon_fix] = default_item[:dark_icon_fix] + end + + save_manifest(items, icons_per_row, 'assets/images/sprites/docs.json') + + if options[:remove_public_icons] + logger.info('Removing public/icons') + FileUtils.rm_rf('public/icons') + end + end + + private + + def get_items + items = Docs.all.map do |doc| + base_path = "public/icons/docs/#{doc.slug}" + { + :type => doc.slug, + :path_16 => "#{base_path}/16.png", + :path_32 => "#{base_path}/16@2x.png" + } + end + + # Checking paths against an array of possible paths is faster than 200+ File.exist? calls + files = Dir.glob('public/icons/docs/**/*.png') + + items.each do |item| + item[:has_icons] = files.include?(item[:path_16]) && files.include?(item[:path_32]) + end + end + + def get_icon(path, max_size) + icon = ChunkyPNG::Image.from_file(path) + + # Check if the icon is too big + # If it is, resize the image without changing the aspect ratio + if icon.width > max_size || icon.height > max_size + ratio = icon.width.to_f / icon.height + new_width = (icon.width >= icon.height ? max_size : max_size * ratio).floor + new_height = (icon.width >= icon.height ? max_size / ratio : max_size).floor + + logger.warn("Icon #{path} is too big: max size is #{max_size} x #{max_size}, icon is #{icon.width} x #{icon.height}, resizing to #{new_width} x #{new_height}") + + icon.resample_nearest_neighbor!(new_width, new_height) + end + + icon + end + + def get_sidebar_background + # This is a hacky way to get the background color of the sidebar + # Unfortunately, it's not possible to get the value of a SCSS variable from a Thor task + # Because hard-coding the value is even worse, we extract it using some regex + path = 'assets/stylesheets/global/_variables-dark.scss' + regex = /--sidebarBackground:\s+([^;]+);/ + ChunkyPNG::Color.parse(File.read(path)[regex, 1]) + end + + def needs_dark_icon_fix(icon, bg_color) + # Determine whether the icon needs to be grayscaled if the user has enabled the dark theme + # The logic is roughly based on https://www.w3.org/TR/2008/REC-WCAG20-20081211/#visual-audio-contrast + contrast = icon.pixels.select {|pixel| ChunkyPNG::Color.a(pixel) > 0}.map do |pixel| + get_contrast(bg_color, pixel) + end + + avg = contrast.reduce(:+) / contrast.size.to_f + avg < 3.5 + end + + def get_contrast(base, other) + # Calculating the contrast ratio as described in the WCAG 2.0: + # https://www.w3.org/TR/2008/REC-WCAG20-20081211/#contrast-ratiodef + l1 = get_luminance(base) + 0.05 + l2 = get_luminance(other) + 0.05 + ratio = l1 / l2 + l2 > l1 ? 1 / ratio : ratio + end + + def get_luminance(color) + rgb = [ + ChunkyPNG::Color.r(color).to_f, + ChunkyPNG::Color.g(color).to_f, + ChunkyPNG::Color.b(color).to_f + ] + + # Calculating the relative luminance as described in the WCAG 2.0: + # https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef + + rgb.map! do |value| + value /= 255 + value < 0.03928 ? value / 12.92 : ((value + 0.055) / 1.055) ** 2.4 + end + + 0.2126 * rgb[0] + 0.7152 * rgb[1] + 0.0722 * rgb[2] + end + + def generate_spritesheet(size, items_with_icons, output_path, &item_to_icon) + logger.info("Generating spritesheet #{output_path} with icons of size #{size} x #{size}") + + icons_per_row = Math.sqrt(items_with_icons.length).ceil + spritesheet = ChunkyPNG::Image.new(size * icons_per_row, size * icons_per_row) + + items_with_icons.each do |item| + icon = item_to_icon.call(item) + + # Calculate the base coordinates + base_x = item[:col] * size + base_y = item[:row] * size + + # Center the icon if it's not a perfect rectangle + x = base_x + ((size - icon.width) / 2).floor + y = base_y + ((size - icon.height) / 2).floor + + spritesheet.compose!(icon, x, y) + end + + FileUtils.mkdir_p(File.dirname(output_path)) + spritesheet.save(output_path) + end + + def save_manifest(items, icons_per_row, path) + logger.info("Saving spritesheet details to #{path}") + + FileUtils.mkdir_p(File.dirname(path)) + + # Only save the details that the scss file needs + manifest_items = items.map do |item| + { + :type => item[:type], + :row => item[:row], + :col => item[:col], + :dark_icon_fix => item[:dark_icon_fix] + } + end + + manifest = {:icons_per_row => icons_per_row, :items => manifest_items} + + File.open(path, 'w') do |f| + f.write(JSON.generate(manifest)) + end + end + + def log_details(items_with_icons, icons_per_row) + logger.debug("Amount of icons: #{items_with_icons.length}") + logger.debug("Amount of icons needing the dark icon fix: #{items_with_icons.count {|item| item[:dark_icon_fix]}}") + logger.debug("Amount of icons per row: #{icons_per_row}") + + max_type_length = items_with_icons.map {|item| item[:type].length}.max + border = "+#{'-' * (max_type_length + 2)}+#{'-' * 5}+#{'-' * 8}+#{'-' * 15}+" + + logger.debug(border) + logger.debug("| #{'Type'.ljust(max_type_length)} | Row | Column | Dark icon fix |") + logger.debug(border) + + items_with_icons.each do |item| + logger.debug("| #{item[:type].ljust(max_type_length)} | #{item[:row].to_s.ljust(3)} | #{item[:col].to_s.ljust(6)} | #{(item[:dark_icon_fix] ? 'Yes' : 'No').ljust(13)} |") + end + + logger.debug(border) + end + + def logger + @logger ||= Logger.new($stdout).tap do |logger| + logger.level = options[:verbose] ? Logger::DEBUG : Logger::INFO + logger.formatter = proc {|severity, datetime, progname, msg| "#{msg}\n"} + end + end +end diff --git a/lib/tasks/updates.thor b/lib/tasks/updates.thor new file mode 100644 index 00000000..c715f752 --- /dev/null +++ b/lib/tasks/updates.thor @@ -0,0 +1,315 @@ +class UpdatesCLI < Thor + # The GitHub user that is allowed to upload reports + UPLOAD_USER = 'devdocs-bot' + + # The repository to create an issue in when uploading the results + UPLOAD_REPO = 'freeCodeCamp/devdocs' + + def self.to_s + 'Updates' + end + + def initialize(*args) + require 'docs' + require 'progress_bar' + require 'terminal-table' + require 'date' + super + end + + desc 'check [--github-token] [--upload] [--verbose] [doc]...', 'Check for outdated documentations' + option :github_token, :type => :string + option :upload, :type => :boolean + option :verbose, :type => :boolean + def check(*names) + # Convert names to a list of Scraper instances + # Versions are omitted, if v10 is outdated than v8 is aswell + docs = names.map {|name| Docs.find(name.split(/@|~/)[0], false)}.uniq + + # Check all documentations for updates when no arguments are given + docs = Docs.all if docs.empty? + + opts = { + logger: logger + } + + if options.key?(:github_token) + opts[:github_token] = options[:github_token] + end + + with_progress_bar do |bar| + bar.max = docs.length + bar.write + end + + results = docs.map do |doc| + result = check_doc(doc, opts) + with_progress_bar(&:increment!) + result + end + + process_results(results) + rescue Docs::DocNotFound => error + logger.error(error) + logger.info('Run "thor docs:list" to see the list of docs.') + end + + private + + def check_doc(doc, opts) + logger.debug("Checking #{doc.name}") + + instance = doc.versions.first.new + scraper_version = instance.get_scraper_version(opts) + latest_version = instance.get_latest_version(opts) + + { + name: doc.name, + scraper_version: format_version(scraper_version), + latest_version: format_version(latest_version), + is_outdated: instance.is_outdated(scraper_version, latest_version) + } + rescue NotImplementedError + logger.warn("Couldn't check #{doc.name}, get_latest_version is not implemented") + error_result(doc, '`get_latest_version` is not implemented') + rescue => error + logger.error("Error while checking #{doc.name}\n#{error.full_message.strip}") + error_result(doc, error.message.gsub(/'/, '`')) + end + + def format_version(version) + str = version.to_s + + # If the version is numeric and greater than or equal to 1e9 it's probably a timestamp + return str if str.match(/^(\d)+$/).nil? or str.to_i < 1e9 + + DateTime.strptime(str, '%s').strftime('%F') + end + + def error_result(doc, reason) + { + name: doc.name, + error: reason + } + end + + def process_results(results) + successful_results = results.select {|result| result.key?(:is_outdated)} + failed_results = results.select {|result| result.key?(:error)} + + up_to_date_results = successful_results.select {|result| !result[:is_outdated]} + outdated_results = successful_results.select {|result| result[:is_outdated]} + + log_results(outdated_results, up_to_date_results, failed_results) + upload_results(outdated_results, up_to_date_results, failed_results) if options[:upload] + end + + # + # Result logging methods + # + + def log_results(outdated_results, up_to_date_results, failed_results) + log_failed_results(failed_results) unless failed_results.empty? + log_successful_results('Up-to-date', up_to_date_results) unless up_to_date_results.empty? + log_successful_results('Outdated', outdated_results) unless outdated_results.empty? + end + + def log_successful_results(label, results) + title = "#{label} documentations (#{results.length})" + headings = ['Documentation', 'Scraper version', 'Latest version'] + rows = results.map {|result| [result[:name], result[:scraper_version], result[:latest_version]]} + + table = Terminal::Table.new :title => title, :headings => headings, :rows => rows + puts table + end + + def log_failed_results(results) + title = "Documentations that could not be checked (#{results.length})" + headings = %w(Documentation Reason) + rows = results.map {|result| [result[:name], result[:error]]} + + table = Terminal::Table.new :title => title, :headings => headings, :rows => rows + puts table + end + + # + # Upload methods + # + + def upload_results(outdated_results, up_to_date_results, failed_results) + # We can't create issues without a GitHub token + unless options.key?(:github_token) + logger.error("Please specify a GitHub token with the public_repo permission for #{UPLOAD_USER} with the --github-token parameter") + return + end + + logger.info('Uploading the results to a new GitHub issue') + + logger.info('Checking if the GitHub token belongs to the correct user') + user = github_get('/user') + + # Only allow the DevDocs bot to upload reports + unless user['login'] == UPLOAD_USER + logger.error("Only #{UPLOAD_USER} is supposed to upload the results to a new issue. The specified github token is not for #{UPLOAD_USER}.") + return + end + + logger.info('Creating a new GitHub issue') + + issue = results_to_issue(outdated_results, up_to_date_results, failed_results) + created_issue = github_post("/repos/#{UPLOAD_REPO}/issues", issue) + + logger.info('Checking if the previous issue is still open') + + search_params = { + q: "Documentation versions report in:title author:#{UPLOAD_USER} is:issue repo:#{UPLOAD_REPO}", + sort: 'created', + order: 'desc' + } + + matching_issues = github_get('/search/issues', search_params) + previous_issue = matching_issues['items'].find {|item| item['number'] != created_issue['number']} + + if previous_issue.nil? + logger.info('No previous issue found') + log_upload_success(created_issue) + else + logger.info('Commenting on the previous issue') + + comment = "This report was superseded by ##{created_issue['number']}." + github_post("/repos/#{UPLOAD_REPO}/issues/#{previous_issue['number']}/comments", {body: comment}) + if previous_issue['closed_at'].nil? + logger.info('Closing the previous issue') + github_patch("/repos/#{UPLOAD_REPO}/issues/#{previous_issue['number']}", {state: 'closed'}) + log_upload_success(created_issue) + else + logger.info('The previous issue has already been closed') + log_upload_success(created_issue) + end + end + end + + def results_to_issue(outdated_results, up_to_date_results, failed_results) + results = [ + successful_results_to_markdown('Outdated', outdated_results), + successful_results_to_markdown('Up-to-date', up_to_date_results), + failed_results_to_markdown(failed_results) + ] + + results_str = results.select {|result| !result.nil?}.join("\n\n") + travis_str = ENV['TRAVIS'].nil? ? '' : "\n\nThis issue was created by Travis CI build [##{ENV['TRAVIS_BUILD_NUMBER']}](#{ENV['TRAVIS_BUILD_WEB_URL']})." + + title = "Documentation versions report for #{Date.today.strftime('%B %Y')}" + body = <<-MARKDOWN +## What is this? + +This is an automatically created issue which contains information about the version status of the documentations available on DevDocs. The results of this report can be used by maintainers when updating outdated documentations. + +Maintainers can close this issue when all documentations are up-to-date. The issue is also automatically closed when the next report is created.#{travis_str} + +## Results + +The #{outdated_results.length + up_to_date_results.length + failed_results.length} documentations are divided as follows: +- #{outdated_results.length} that #{outdated_results.length == 1 ? 'is' : 'are'} outdated +- #{up_to_date_results.length} that #{up_to_date_results.length == 1 ? 'is' : 'are'} up-to-date (patch updates are ignored) +- #{failed_results.length} that could not be checked + MARKDOWN + + { + title: title, + body: body.strip + "\n\n" + results_str + } + end + + def successful_results_to_markdown(label, results) + return nil if results.empty? + + title = "#{label} documentations (#{results.length})" + headings = ['Documentation', 'Scraper version', 'Latest version'] + rows = results.map {|result| [result[:name], result[:scraper_version], result[:latest_version]]} + + results_to_markdown(title, headings, rows) + end + + def failed_results_to_markdown(results) + return nil if results.empty? + + title = "Documentations that could not be checked (#{results.length})" + headings = %w(Documentation Reason) + rows = results.map {|result| [result[:name], result[:error]]} + + results_to_markdown(title, headings, rows) + end + + def results_to_markdown(title, headings, rows) + "
    \n#{title}\n\n#{create_markdown_table(headings, rows)}\n
    " + end + + def create_markdown_table(headings, rows) + header = headings.join(' | ') + separator = '-|' * headings.length + body = rows.map {|row| row.join(' | ')} + + header + "\n" + separator[0...-1] + "\n" + body.join("\n") + end + + def log_upload_success(created_issue) + logger.info("Successfully uploaded the results to #{created_issue['html_url']}") + end + + # + # HTTP utilities + # + + def github_get(endpoint, params = {}) + github_request(endpoint, {method: :get, params: params}) + end + + def github_post(endpoint, params) + github_request(endpoint, {method: :post, body: params.to_json}) + end + + def github_patch(endpoint, params) + github_request(endpoint, {method: :patch, body: params.to_json}) + end + + def github_request(endpoint, opts) + url = "https://api.github.com#{endpoint}" + + # GitHub token authentication + opts[:headers] = { + Authorization: "token #{options[:github_token]}" + } + + # GitHub requires the Content-Type to be application/json when a body is passed + if opts.key?(:body) + opts[:headers]['Content-Type'] = 'application/json' + end + + logger.debug("Making a #{opts[:method]} request to #{url}") + response = Docs::Request.run(url, opts) + + # response.success? is false if the response code is 201 + # GitHub returns 201 Created after an issue is created + if response.success? || response.code == 201 + JSON.parse(response.body) + else + logger.error("Couldn't make a #{opts[:method]} request to #{url} (response code #{response.code})") + nil + end + end + + # A utility method which ensures no progress bar is shown when stdout is not a tty + def with_progress_bar(&block) + return unless $stdout.tty? + @progress_bar ||= ::ProgressBar.new + block.call @progress_bar + end + + def logger + @logger ||= Logger.new($stdout).tap do |logger| + logger.level = options[:verbose] ? Logger::DEBUG : Logger::INFO + logger.formatter = proc {|severity, datetime, progname, msg| "[#{severity}] #{msg}\n"} + end + end +end diff --git a/public/docs/docs.json b/public/docs/docs.json deleted file mode 100644 index 0637a088..00000000 --- a/public/docs/docs.json +++ /dev/null @@ -1 +0,0 @@ -[] \ No newline at end of file diff --git a/public/icons/docs-1.pxm b/public/icons/docs-1.pxm deleted file mode 100644 index d9418ee7..00000000 Binary files a/public/icons/docs-1.pxm and /dev/null differ diff --git a/public/icons/docs-1@2x.pxm b/public/icons/docs-1@2x.pxm deleted file mode 100644 index d2b97c84..00000000 Binary files a/public/icons/docs-1@2x.pxm and /dev/null differ diff --git a/public/icons/docs-2.pxm b/public/icons/docs-2.pxm deleted file mode 100644 index ba5ce1b5..00000000 Binary files a/public/icons/docs-2.pxm and /dev/null differ diff --git a/public/icons/docs-2@2x.pxm b/public/icons/docs-2@2x.pxm deleted file mode 100644 index 3c390953..00000000 Binary files a/public/icons/docs-2@2x.pxm and /dev/null differ diff --git a/public/icons/docs/bluebird/16@2x.png b/public/icons/docs/bluebird/16@2x.png index 9ffae075..64ad5903 100644 Binary files a/public/icons/docs/bluebird/16@2x.png and b/public/icons/docs/bluebird/16@2x.png differ diff --git a/public/images/webapp-icon-192.png b/public/images/webapp-icon-192.png new file mode 100644 index 00000000..d1d1dd75 Binary files /dev/null and b/public/images/webapp-icon-192.png differ diff --git a/public/manifest.json b/public/manifest.json index 1faa5978..301c56d1 100644 --- a/public/manifest.json +++ b/public/manifest.json @@ -4,6 +4,7 @@ "description": "API Documentation Browser", "start_url": "/", "display": "standalone", + "background_color": "#EEEEEE", "icons": [ { "src": "/images/webapp-icon-32.png", @@ -25,6 +26,11 @@ "sizes": "128x128", "type": "image/png" }, + { + "src": "/images/webapp-icon-192.png", + "sizes": "192x192", + "type": "image/png" + }, { "src": "/images/webapp-icon-256.png", "sizes": "256x256", diff --git a/test/app_test.rb b/test/app_test.rb index 92a24acd..8e9e369b 100644 --- a/test/app_test.rb +++ b/test/app_test.rb @@ -43,35 +43,6 @@ class AppTest < MiniTest::Spec assert last_response.redirect? assert_equal 'https://example.org/', last_response['Location'] end - - it "sets default size" do - get '/' - assert_includes last_response.body, 'data-size="20rem"' - end - - it "sets size from cookie" do - set_cookie('size=42') - get '/' - assert_includes last_response.body, 'data-size="42px"' - end - - it "sets layout from cookie" do - set_cookie('layout=foo') - get '/' - assert_includes last_response.body, '' - end - - it "sets the theme from cookie" do - get '/' - assert_match %r{]*class="[^\"]*_theme-default}, last_response.body - refute_includes last_response.body, '_theme-dark' - - set_cookie('dark=1') - - get '/' - assert_match %r{]*class="[^\"]*_theme-dark}, last_response.body - refute_includes last_response.body, '_theme-default' - end end describe "/[static-page]" do @@ -106,58 +77,6 @@ class AppTest < MiniTest::Spec end end - describe "/manifest.appcache" do - it "works" do - get '/manifest.appcache' - assert last_response.ok? - end - - it "works with cookie" do - set_cookie('docs=css/html~5') - get '/manifest.appcache' - assert last_response.ok? - assert_includes last_response.body, '/css/index.json?1420139788' - assert_includes last_response.body, '/html~5/index.json?1420139791' - end - - it "ignores invalid docs in the cookie" do - set_cookie('docs=foo') - get '/manifest.appcache' - assert last_response.ok? - refute_includes last_response.body, 'foo' - end - - it "has the word 'default' when no 'dark' cookie is set" do - get '/manifest.appcache' - assert_includes last_response.body, '# default' - refute_includes last_response.body, '# dark' - end - - it "has the word 'dark' when the cookie is set" do - set_cookie('dark=1') - get '/manifest.appcache' - assert_includes last_response.body, '# dark' - refute_includes last_response.body, '# default' - end - - it "sets default size" do - get '/manifest.appcache' - assert_includes last_response.body, '20rem' - end - - it "sets size from cookie" do - set_cookie('size=42') - get '/manifest.appcache' - assert_includes last_response.body, '42px' - end - - it "sets layout from cookie" do - set_cookie('layout=foo_layout') - get '/manifest.appcache' - assert_includes last_response.body, 'foo_layout' - end - end - describe "/[doc]" do it "renders when the doc exists and isn't enabled" do set_cookie('docs=html~5') diff --git a/test/lib/docs/core/scrapers/file_scraper_test.rb b/test/lib/docs/core/scrapers/file_scraper_test.rb index 7d90d262..88b5e8d5 100644 --- a/test/lib/docs/core/scrapers/file_scraper_test.rb +++ b/test/lib/docs/core/scrapers/file_scraper_test.rb @@ -63,7 +63,7 @@ class FileScraperTest < MiniTest::Spec end it "reads a file" do - mock(scraper).read_file(path) + mock(scraper).read_file(File.join(ROOT_PATH, 'docs/scraper', path)) result end @@ -165,7 +165,7 @@ class FileScraperTest < MiniTest::Spec describe "#read_file" do let :result do - scraper.send :read_file, 'file' + scraper.send :read_file, File.join(ROOT_PATH, 'docs', 'scraper', 'file') end it "returns the file's content when the file exists in the source directory" do diff --git a/views/app.erb b/views/app.erb index 7cffabd0..ffaa1bf3 100644 --- a/views/app.erb +++ b/views/app.erb @@ -28,13 +28,7 @@
    -
    - <% unless @doc %> - <% App.docs.each do |slug, doc| %> - <%= doc['full_name'] %> - <% end %> - <% end %> -
    +
    @@ -63,9 +57,3 @@ - diff --git a/views/index.erb b/views/index.erb index 022e927f..4fb96153 100644 --- a/views/index.erb +++ b/views/index.erb @@ -1,5 +1,5 @@ - prefix="og: http://ogp.me/ns#" lang="en" class="_booting _theme-<%= app_theme %>"> + @@ -14,6 +14,7 @@ + DevDocs API Documentation @@ -32,7 +33,7 @@ <%= stylesheet_tag 'application' %> -> + <%= erb :app -%> <%= javascript_tag 'application', asset_host: false %> diff --git a/views/manifest.erb b/views/manifest.erb deleted file mode 100644 index 9d2df923..00000000 --- a/views/manifest.erb +++ /dev/null @@ -1,14 +0,0 @@ -CACHE MANIFEST -# <%= app_theme %> <%= app_size %> <%= app_layout %> - -CACHE: -/ -<%= manifest_asset_urls.join "\n" %> -<%= doc_index_urls.join "\n" %> - -NETWORK: -/s/ -* - -FALLBACK: -/ / diff --git a/views/other.erb b/views/other.erb index ee9b8de1..45cab943 100644 --- a/views/other.erb +++ b/views/other.erb @@ -1,10 +1,11 @@ - + <% if doc_index_page? %><% else %><% end %> + DevDocs<%= " — #{@doc['full_name']} documentation" if doc_index_page? %> @@ -13,7 +14,7 @@ <%= stylesheet_tag 'application' %> - data-doc="<%= CGI::escape_html @doc.to_json %>"> + <%= erb :app -%> <%= javascript_tag 'application', asset_host: false %><% unless App.production? %> diff --git a/views/service-worker.js.erb b/views/service-worker.js.erb new file mode 100644 index 00000000..8d5698a7 --- /dev/null +++ b/views/service-worker.js.erb @@ -0,0 +1,49 @@ +<%# 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 = [ + '/', + '/favicon.ico', + '/manifest.json', + '<%= service_worker_asset_urls.join "',\n '" %>', + '<%= doc_index_urls.join "',\n '" %>', +]; + +<%# Set-up the cache %> +self.addEventListener('install', event => { + self.skipWaiting(); + + event.waitUntil( + caches.open(cacheName).then(cache => cache.addAll(urlsToCache)), + ); +}); + +<%# Remove old caches %> +self.addEventListener('activate', event => { + event.waitUntil((async () => { + const keys = await caches.keys(); + const jobs = keys.map(key => key !== cacheName ? caches.delete(key) : Promise.resolve()); + return Promise.all(jobs); + })()); +}); + +<%# Handle HTTP requests %> +self.addEventListener('fetch', event => { + event.respondWith((async () => { + const cachedResponse = await caches.match(event.request); + if (cachedResponse) return cachedResponse; + + const url = new URL(event.request.url); + + <%# 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 %> + <%# The index page will handle the routing %> + if (url.origin === location.origin && !url.pathname.includes('.')) { + const cachedIndex = await caches.match('/'); + if (cachedIndex) return cachedIndex; + } + + return fetch(event.request); + })()); +}); diff --git a/views/unsupported.erb b/views/unsupported.erb index a01b7c7e..6c1ded7e 100644 --- a/views/unsupported.erb +++ b/views/unsupported.erb @@ -11,9 +11,9 @@

    DevDocs is an API documentation browser which supports the following browsers:

    • Recent versions of Firefox, Chrome, or Opera
      • -
    • Safari 9.1+
      • -
    • Edge 16+
      • -
    • iOS 10+
      • +
    • Safari 11.1+
      • +
    • Edge 17+
      • +
    • iOS 11.3+

    If you're unable to upgrade, we apologize.