[devdocsgjs/wip/andyholmes/gjs-repository-docs: 4/4] DevDocs: add scraper for GJS's in-tree documentation

[Andy Holmes <andyholmes src gnome org>]

commit 7d3c68daac76ca8cae2c697837cea31f8a2d00c4
Author: Andy Holmes <andrew g r holmes gmail com>
Date:   Sun Aug 14 18:08:57 2022 -0700

    DevDocs: add scraper for GJS's in-tree documentation
    
    This adds a scraper that piggy-backs on GitHub's MD-to-HTML feature to
    add documentation for the in-tree documentation for GJS.

 Dockerfile                                 |   3 ++
 assets/images/gnome-icons.json             |   3 ++
 lib/docs/filters/gjs_scraper/clean_html.rb |  11 ++++++
 lib/docs/filters/gjs_scraper/entries.rb    |  53 +++++++++++++++++++++++++++++
 lib/docs/scrapers/gnome/gjs_scraper.rb     |  43 +++++++++++++++++++++++
 public/icons/docs/gjs/16.png               | Bin 0 -> 6054 bytes
 public/icons/docs/gjs/16 2x png            | Bin 0 -> 7788 bytes
 public/icons/docs/gjs/SOURCE               |   1 +
 8 files changed, 114 insertions(+)
---
diff --git a/Dockerfile b/Dockerfile
index 94f7bcc5..7eb0f50c 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -59,6 +59,9 @@ RUN bundle config set --local deployment 'true' && \
 # JavaScript/TypeScript, Jasmine, CSS
 RUN bundle exec thor docs:download css javascript jasmine typescript
 
+# GJS documentation
+RUN bundle exec thor docs:generate gjs_scraper --force
+
 # Generate scrapers
 RUN bundle exec thor gir:generate_all /usr/share/gir-1.0 && \
     bundle exec thor gir:generate_all /usr/lib64/mutter-3 && \
diff --git a/assets/images/gnome-icons.json b/assets/images/gnome-icons.json
index baca06bd..7a9ef7b8 100644
--- a/assets/images/gnome-icons.json
+++ b/assets/images/gnome-icons.json
@@ -1,4 +1,7 @@
 {
+  "gjs": [
+    "^gjs$"
+  ],
   "javascript": [
     "^javascript$"
   ],
diff --git a/lib/docs/filters/gjs_scraper/clean_html.rb b/lib/docs/filters/gjs_scraper/clean_html.rb
new file mode 100644
index 00000000..857c191c
--- /dev/null
+++ b/lib/docs/filters/gjs_scraper/clean_html.rb
@@ -0,0 +1,11 @@
+module Docs
+  class GjsScraper
+    # CleanHtmlFilter for GJS's in-tree documentation. This is currently empty,
+    # but could be used to make adjustments to the HTML.
+    class CleanHtmlFilter < Filter
+      def call
+        doc
+      end
+    end
+  end
+end
diff --git a/lib/docs/filters/gjs_scraper/entries.rb b/lib/docs/filters/gjs_scraper/entries.rb
new file mode 100644
index 00000000..34eba637
--- /dev/null
+++ b/lib/docs/filters/gjs_scraper/entries.rb
@@ -0,0 +1,53 @@
+module Docs
+  class GjsScraper
+    class EntriesFilter < Docs::EntriesFilter
+      SKIP_SYMBOLS = [
+        'ECMAScript Modules'
+      ]
+
+      # "name" is the title of the entry in the sidebar.
+      def get_name
+        node = at_css('h1')
+        name = node.content.strip
+      end
+
+      # "type" is the expandable group the "name" is under.
+      def get_type
+        node = at_css('h1')
+        type = node.content.strip
+      end
+
+      def strip_symbol (node, entry)
+        # If this is a function (e.g. "baz()"), strip down to the member
+        # name to get a reasonable sidebar entry and fragment link
+        func_match = /(.*)(?=\(.*\))/.match(entry[0])
+        if func_match
+          entry[0] = func_match[1] + '()'
+          entry[1] = node['id'] = func_match[1].parameterize
+        end
+      end
+
+      def additional_entries
+        # skip README.md
+        return [] if root_page?
+
+        css('h2, h3').each_with_object [] do |node, entries|
+          # skip `###` entries for pages that don't have symbols
+          next if node.name == 'h3' and SKIP_SYMBOLS.include? type
+          
+          # common filtering
+          name = node.content.strip
+          id = node['id'] = name.parameterize
+          type = self.get_type
+          entry = [name, id, type]
+            
+          if node.name == 'h3'
+            strip_symbol node, entry
+          end
+          
+          entries << entry
+        end
+      end
+    end
+  end
+end
diff --git a/lib/docs/scrapers/gnome/gjs_scraper.rb b/lib/docs/scrapers/gnome/gjs_scraper.rb
new file mode 100644
index 00000000..4be5b590
--- /dev/null
+++ b/lib/docs/scrapers/gnome/gjs_scraper.rb
@@ -0,0 +1,43 @@
+module Docs
+  class GjsScraper < Github
+    self.name = 'GJS'
+    self.base_url = 'https://github.com/GNOME/gjs/blob/master/doc/'
+    self.root_path = 'README.md'
+    self.initial_paths = %w[
+      ByteArray
+      cairo
+      Console
+      Encoding
+      Environment
+      ESModules
+      Format
+      Gettext
+      Lang
+      Logging
+      Mainloop
+      Mapping
+      Overrides
+      Profiling
+      Signals
+      System
+      Testing
+      Timers
+    ].map { |name| name + '.md' }
+
+    html_filters.push 'gjs_scraper/entries', 'gjs_scraper/clean_html'
+
+    options[:container] = '.markdown-body'
+    options[:title] = 'GJS'
+    options[:skip_links] = true
+
+    options[:attribution] = <<-HTML
+      &copy; 2022 GJS Contributors<br>
+      Licensed under the MIT License.
+    HTML
+
+    def get_latest_version(opts)
+      tags = get_gitlab_tags('gitlab.gnome.org', 'GNOME', 'gjs', opts)
+      tags[0]['name']
+    end
+  end
+end
diff --git a/public/icons/docs/gjs/16.png b/public/icons/docs/gjs/16.png
new file mode 100644
index 00000000..ae860ab3
Binary files /dev/null and b/public/icons/docs/gjs/16.png differ
diff --git a/public/icons/docs/gjs/16 2x png b/public/icons/docs/gjs/16 2x png
new file mode 100644
index 00000000..469b334a
Binary files /dev/null and b/public/icons/docs/gjs/16 2x png differ
diff --git a/public/icons/docs/gjs/SOURCE b/public/icons/docs/gjs/SOURCE
new file mode 100644
index 00000000..e95e6533
--- /dev/null
+++ b/public/icons/docs/gjs/SOURCE
@@ -0,0 +1 @@
+http://commons.wikimedia.org/wiki/File:Gnomelogo-footprint.svg