Merge branch 'master' into typo-fixes

jmerle · jmerle · commit 971d2c67dd20 · 2019-08-06T01:06:40.000+02:00
diff --git a/Dockerfile b/Dockerfile
@@ -6,7 +6,7 @@ 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
@@ -7,7 +7,7 @@ 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/assets/javascripts/app/app.coffee b/assets/javascripts/app/app.coffee
@@ -78,7 +78,7 @@
         .install()
       @previousErrorHandler = onerror
       window.onerror = @onWindowError.bind(@)
-      CookieStore.onBlocked = @onCookieBlocked
+      CookiesStore.onBlocked = @onCookieBlocked
     return
 
   bootOne: ->
diff --git a/assets/javascripts/app/config.coffee.erb b/assets/javascripts/app/config.coffee.erb
@@ -13,5 +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/settings.coffee b/assets/javascripts/app/settings.coffee
@@ -33,7 +33,7 @@ class app.Settings
     analyticsConsent: false
 
   constructor: ->
-    @store = new CookieStore
+    @store = new CookiesStore
     @cache = {}
 
   get: (key) ->
diff --git a/assets/javascripts/lib/cookies_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
@@ -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/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
@@ -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
diff --git 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/lib/docs/filters/elixir/clean_html.rb b/lib/docs/filters/elixir/clean_html.rb
@@ -57,6 +57,11 @@ def api
           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
@@ -4,6 +4,11 @@ class CleanHtmlFilter < Filter
       def call
         css('hr')
 
+        if at_css('h1').nil?
+          title = current_url.normalized_path[1..-1].gsub(/-/, ' ')
+          doc.children.before("<h1>#{title}</h1>")
+        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
@@ -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 @@ def get_name
         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/kotlin/clean_html.rb b/lib/docs/filters/kotlin/clean_html.rb
@@ -46,6 +46,13 @@ def api_page
           parent.content = parent.content
           parent['data-language'] = 'kotlin'
         end
+
+        css('.tags').each do |wrapper|
+          platforms = wrapper.css('.platform:not(.tag-value-Common)').to_a
+          platforms = platforms.map { |node| "#{node.content} (#{node['data-tag-version']})" }
+          platforms = "<b>Platform and version requirements:</b> #{platforms.join ", "}"
+          wrapper.replace(platforms)
+        end
       end
     end
   end
diff --git a/lib/docs/filters/kotlin/entries.rb b/lib/docs/filters/kotlin/entries.rb
@@ -5,7 +5,9 @@ def get_name
         if subpath.start_with?('api')
           breadcrumbs[1..-1].join('.')
         else
-          (at_css('h1') || at_css('h2')).content
+          node = (at_css('h1') || at_css('h2'))
+          return node.content unless node.nil?
+          subpath[/\/([a-z0-9_-]+)\./][1..-2].titleize.sub('Faq', 'FAQ')
         end
       end
 
diff --git a/lib/docs/filters/pandas/entries.rb b/lib/docs/filters/pandas/entries.rb
@@ -2,8 +2,10 @@ module Docs
   class Pandas
     class EntriesFilter < Docs::EntriesFilter
       def get_name
-        if subpath.start_with?('generated')
-          name = at_css('dt').content.strip
+        if subpath.start_with?('generated') || (subpath.include?('reference') && !subpath.include?('reference/index'))
+          name_node = at_css('dt')
+          name_node = at_css('h1') if name_node.nil?
+          name = name_node.content.strip
           name.sub! %r{\(.*}, '()'
           name.remove! %r{\s=.*}
           name.remove! %r{\A(class(method)?) (pandas\.)?}
@@ -16,7 +18,7 @@ def get_name
       end
 
       def get_type
-        if subpath.start_with?('generated')
+        if subpath.start_with?('generated') || (subpath.include?('reference') && !subpath.include?('reference/index'))
           css('.toctree-l2.current > a').last.content.remove(/\s\(.+?\)/)
         else
           'Manual'
diff --git a/lib/docs/filters/qt/clean_html.rb b/lib/docs/filters/qt/clean_html.rb
@@ -8,6 +8,7 @@ def call
         # 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
@@ -111,6 +111,7 @@ def additional_entries
         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/clojure.rb b/lib/docs/scrapers/clojure.rb
@@ -13,18 +13,23 @@ class Clojure < UrlScraper
       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
 
diff --git a/lib/docs/scrapers/django.rb b/lib/docs/scrapers/django.rb
@@ -34,18 +34,23 @@ class Django < FileScraper
       Licensed under the BSD License.
     HTML
 
+    version '2.2' do
+      self.release = '2.2.4'
+      self.base_url = 'https://docs.djangoproject.com/en/2.2/'
+    end
+
     version '2.1' do
-      self.release = '2.1.0'
+      self.release = '2.1.11'
       self.base_url = 'https://docs.djangoproject.com/en/2.1/'
     end
 
     version '2.0' do
-      self.release = '2.0.7'
+      self.release = '2.0.13'
       self.base_url = 'https://docs.djangoproject.com/en/2.0/'
     end
 
     version '1.11' do
-      self.release = '1.11.9'
+      self.release = '1.11.23'
       self.base_url = 'https://docs.djangoproject.com/en/1.11/'
     end
 
diff --git a/lib/docs/scrapers/docker.rb b/lib/docs/scrapers/docker.rb
diff --git a/lib/docs/scrapers/elixir.rb b/lib/docs/scrapers/elixir.rb
diff --git a/lib/docs/scrapers/homebrew.rb b/lib/docs/scrapers/homebrew.rb
diff --git a/lib/docs/scrapers/kotlin.rb b/lib/docs/scrapers/kotlin.rb
diff --git a/lib/docs/scrapers/padrino.rb b/lib/docs/scrapers/padrino.rb
diff --git a/lib/docs/scrapers/pandas.rb b/lib/docs/scrapers/pandas.rb
diff --git a/lib/docs/scrapers/qt.rb b/lib/docs/scrapers/qt.rb
diff --git a/lib/tasks/sprites.thor b/lib/tasks/sprites.thor
diff --git a/views/service-worker.js.erb b/views/service-worker.js.erb
