[devdocsgjs/main: 1637/1867] Add support for compatibility tables

[Andy Holmes <andyholmes src gnome org>]

commit 0ad6fefa83e4818ac1a170239acb1d6a3e690005
Author: Enoc <brianhernandez222 hotmail com>
Date:   Tue Apr 20 01:46:30 2021 -0600

    Add support for compatibility tables
    
    almost all the mdn docs works, but some have
    minor issues.

 lib/docs/core/compat_tables.rb            | 184 ++++++++++++++++++++++++++++++
 lib/docs/core/filter.rb                   |   5 +
 lib/docs/filters/css/clean_html.rb        |  14 +++
 lib/docs/filters/dom/clean_html.rb        |  14 +++
 lib/docs/filters/html/clean_html.rb       |  12 ++
 lib/docs/filters/javascript/clean_html.rb |  13 +++
 lib/docs/filters/svg/clean_html.rb        |  15 ++-
 lib/docs/filters/xslt_xpath/clean_html.rb |  13 +++
 8 files changed, 269 insertions(+), 1 deletion(-)
---
diff --git a/lib/docs/core/compat_tables.rb b/lib/docs/core/compat_tables.rb
new file mode 100644
index 00000000..fcc1abeb
--- /dev/null
+++ b/lib/docs/core/compat_tables.rb
@@ -0,0 +1,184 @@
+module CompatTables
+  require 'json'
+  require 'net/http'
+  require 'pry'
+
+  BROWSERS = {
+    'chrome' => 'Chrome',
+    'edge' => 'Edge',
+    'firefox' => 'Firefox',
+    'ie' => 'Internet Explorer',
+    'opera' => 'Opera',
+    'safari' => 'Safari',
+    'webview_android' => 'WebView Android',
+    'chrome_android' => 'Chrome Android',
+    'firefox_android' => 'Firefox for Android',
+    'opera_android' => 'Opera Android',
+    'safari_ios' => 'Safari on IOS',
+    'samsunginternet_android' => 'Samsung Internet'
+  }
+
+  def generate_compatibility_table()
+    json_files_uri = request_bcd_uris()
+
+    compat_tables = []
+
+    json_files_uri.each do |uri|
+      compat_tables.push(generate_compatibility_table_wrapper(uri))
+    end
+
+    return compat_tables
+  end
+
+  def request_bcd_uris
+    index_json = JSON.load(Net::HTTP.get(URI(current_url.to_s + '/index.json')))
+
+    uris = []
+
+    index_json['doc']['body'].each do |element|
+      uris.push(element['value']['dataURL']) if element['type'] == 'browser_compatibility'
+    end
+
+    uris.map! do |uri|
+      tmp_uri = URI.parse(base_url.to_s)
+      tmp_uri.path = uri
+      uri = tmp_uri.to_s
+    end
+
+    return uris
+  end
+
+  def generate_compatibility_table_wrapper(uri)
+
+    @json_data = JSON.load(Net::HTTP.get(URI(uri)))['data']
+
+    html_table = generate_basic_html_table()
+
+    @json_data.keys.each do |key|
+      if key == '__compat' or @json_data[key]['__compat']
+        add_entry_to_table(html_table, key)
+      else
+      end
+    end
+
+    return html_table
+  end
+
+  def generate_basic_html_table
+    table = Nokogiri::XML::Node.new('table', doc)
+
+    table.add_child('<thead><tr id=bct-browser-type><tr id=bct-browsers><tbody>')
+
+    table.css('#bct-browser-type').each do |node|
+      node.add_child('<th>')
+      %w(Desktop Mobile).each do |browser_type|
+        node.add_child("<th colspan=6>#{browser_type}")
+      end
+    end
+
+    table.css('#bct-browsers').each do |node|
+      node.add_child('<th>')
+
+      BROWSERS.values.each do |browser|
+        node.add_child("<th>#{browser}")
+      end
+    end
+
+    return table
+  end
+
+  def add_entry_to_table(html_table, key)
+    json = @json_data[key]
+
+    html_table.at_css('tbody').add_child('<tr>')
+
+    last_table_entry = html_table.at_css('tbody').last_element_child
+
+    last_table_entry.add_child("<th><code>#{key}")
+
+    BROWSERS.keys.each do |browser_key|
+      if key == '__compat'
+        add_data_to_entry(json['support'][browser_key], last_table_entry)
+      else
+        add_data_to_entry(json['__compat']['support'][browser_key], last_table_entry)
+      end
+
+    end
+  end
+
+  def add_data_to_entry(json, entry)
+    version_added = []
+    version_removed = []
+    notes = []
+
+    if json.is_a?(Array)
+      json.each do |element|
+
+        if element['version_added']
+        version_added.push(element['version_added'])
+        else
+          version_added.push(false)
+        end
+
+        if element['version_removed']
+          version_removed.push(element['version_removed'])
+        else
+          version_removed.push(false)
+        end
+
+        if element['notes']
+          notes.push(element['notes'])
+        else
+          notes.push(false)
+        end
+
+      end
+    else
+      version_added.push(json['version_added'])
+      version_removed.push(json['version_removed'])
+      notes.push(json['notes'])
+    end
+
+    version_added.map! do |version|
+      if version == true
+        version = 'Yes'
+      elsif version == false
+        version = 'No'
+      elsif version.is_a?(Numeric)
+      else
+        version = '?'
+      end
+
+      version
+    end
+
+    if version_removed[0]
+      format_string = "<td class=bc-supports-no>"
+    else
+      if version_added[0] == 'No'
+        format_string = "<td class=bc-supports-no>"
+      else
+        format_string = "<td class=bc-supports-yes>"
+      end
+    end
+
+    for value in (0..version_added.length-1) do
+      if version_removed[value]
+        format_string += "<div>#{version_added[value]}-#{version_removed[value]}</div>"
+      else
+        if version_added[value] == 'No'
+          format_string += "<div>#{version_added[value]}</div>"
+        else
+          format_string += "<div>#{version_added[value]}</div>"
+        end
+      end
+
+      if notes[value]
+        format_string += "<div>#{notes[value]}</div>"
+      end
+    end
+
+    entry.add_child(format_string)
+  end
+
+end
diff --git a/lib/docs/core/filter.rb b/lib/docs/core/filter.rb
index 5be77883..8f6bf173 100644
--- a/lib/docs/core/filter.rb
+++ b/lib/docs/core/filter.rb
@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
+require './lib/docs/core/compat_tables.rb'
+
 module Docs
   class Filter < ::HTML::Pipeline::Filter
+
+    include CompatTables
+
     def css(*args)
       doc.css(*args)
     end
diff --git a/lib/docs/filters/css/clean_html.rb b/lib/docs/filters/css/clean_html.rb
index f202f7c9..a081e32a 100644
--- a/lib/docs/filters/css/clean_html.rb
+++ b/lib/docs/filters/css/clean_html.rb
@@ -26,7 +26,21 @@ module Docs
         css('img[style*="float"]').each do |node|
           node['style'] = node['style'] + ';float: none; display: block;'
         end
+
+        if at_css('#browser_compatibility') \
+          and not at_css('#browser_compatibility').next_sibling.classes.include?('warning') \
+          and not at_css('#browser_compatibility').next_sibling.content.match?('Supported')
+
+          at_css('#browser_compatibility').next_sibling.remove
+
+          compatibility_tables = generate_compatibility_table()
+          compatibility_tables.each do |table|
+            at_css('#browser_compatibility').add_next_sibling(table)
+          end
+        end
+
       end
+
     end
   end
 end
diff --git a/lib/docs/filters/dom/clean_html.rb b/lib/docs/filters/dom/clean_html.rb
index d6704468..d7c3981c 100644
--- a/lib/docs/filters/dom/clean_html.rb
+++ b/lib/docs/filters/dom/clean_html.rb
@@ -38,7 +38,21 @@ module Docs
           node['class'] = 'syntaxbox'
           node.parent.before(node).remove
         end
+
+        if at_css('#browser_compatibility') \
+          and not at_css('#browser_compatibility').next_sibling.classes.include?('warning') \
+          and not at_css('#browser_compatibility').next_sibling.content.match?('Supported')
+
+          at_css('#browser_compatibility').next_sibling.remove
+
+          compatibility_tables = generate_compatibility_table()
+          compatibility_tables.each do |table|
+            at_css('#browser_compatibility').add_next_sibling(table)
+          end
+        end
+
       end
+
     end
   end
 end
diff --git a/lib/docs/filters/html/clean_html.rb b/lib/docs/filters/html/clean_html.rb
index 0d6b43b4..ee090ef2 100644
--- a/lib/docs/filters/html/clean_html.rb
+++ b/lib/docs/filters/html/clean_html.rb
@@ -6,6 +6,18 @@ module Docs
           node.before(node.children).remove
         end
 
+        if at_css('#browser_compatibility') \
+          and not at_css('#browser_compatibility').next_sibling.classes.include?('warning') \
+          and not at_css('#browser_compatibility').next_sibling.content.match?('Supported')
+
+          at_css('#browser_compatibility').next_sibling.remove
+
+          compatibility_tables = generate_compatibility_table()
+          compatibility_tables.each do |table|
+            at_css('#browser_compatibility').add_next_sibling(table)
+          end
+        end
+
         doc
       end
     end
diff --git a/lib/docs/filters/javascript/clean_html.rb b/lib/docs/filters/javascript/clean_html.rb
index eeb23ba8..0187e4bf 100644
--- a/lib/docs/filters/javascript/clean_html.rb
+++ b/lib/docs/filters/javascript/clean_html.rb
@@ -19,6 +19,19 @@ module Docs
         css('div > .overheadIndicator:first-child:last-child', 'div > 
.blockIndicator:first-child:last-child').each do |node|
           node.parent.replace(node)
         end
+
+        if at_css('#browser_compatibility') \
+          and not at_css('#browser_compatibility').next_sibling.classes.include?('warning') \
+          and not at_css('#browser_compatibility').next_sibling.content.match?('Supported')
+
+          at_css('#browser_compatibility').next_sibling.remove
+
+            compatibility_tables = generate_compatibility_table()
+            compatibility_tables.each do |table|
+              at_css('#browser_compatibility').add_next_sibling(table)
+            end
+        end
+
       end
     end
   end
diff --git a/lib/docs/filters/svg/clean_html.rb b/lib/docs/filters/svg/clean_html.rb
index 3468cfb7..15904229 100644
--- a/lib/docs/filters/svg/clean_html.rb
+++ b/lib/docs/filters/svg/clean_html.rb
@@ -7,7 +7,7 @@ module Docs
       end
 
       def root
-        doc.inner_html = doc.at_css('#Documentation + dl').to_html
+
       end
 
       def other
@@ -26,7 +26,20 @@ module Docs
           node['class'] = 'index'
           css('h3').each { |n| n.name = 'span' }
         end
+
+        if at_css('#browser_compatibility') \
+          and not at_css('#browser_compatibility').next_sibling.classes.include?('warning') \
+          and not at_css('#browser_compatibility').next_sibling.content.match?('Supported')
+
+          at_css('#browser_compatibility').next_sibling.remove
+
+          compatibility_tables = generate_compatibility_table()
+          compatibility_tables.each do |table|
+            at_css('#browser_compatibility').add_next_sibling(table)
+          end
+        end
       end
+
     end
   end
 end
diff --git a/lib/docs/filters/xslt_xpath/clean_html.rb b/lib/docs/filters/xslt_xpath/clean_html.rb
index 82096b20..e7c62084 100644
--- a/lib/docs/filters/xslt_xpath/clean_html.rb
+++ b/lib/docs/filters/xslt_xpath/clean_html.rb
@@ -24,6 +24,19 @@ module Docs
           child = child.next while child && child.text? && child.content.blank?
           child.remove if child.try(:name) == 'br'
         end
+
+        if at_css('#browser_compatibility') \
+          and not at_css('#browser_compatibility').next_sibling.classes.include?('warning') \
+          and not at_css('#browser_compatibility').next_sibling.content.match?('Supported')
+
+          at_css('#browser_compatibility').next_sibling.remove
+
+          compatibility_tables = generate_compatibility_table()
+          compatibility_tables.each do |table|
+            at_css('#browser_compatibility').add_next_sibling(table)
+          end
+        end
+
       end
     end
   end