Merge pull request #2041 from jceb/sanctuary-type-classes

Add sanctuary-type-classes documentation (13.0.0)

Author: simon04

assets/stylesheets/application.css.scss

@@ -116,6 +116,7 @@
         'pages/rxjs',
         'pages/sanctuary',
         'pages/sanctuary_def',
+        'pages/sanctuary_type_classes',
         'pages/scala',
         'pages/sinon',
         'pages/sphinx',

assets/stylesheets/pages/_sanctuary_type_classes.scss

@@ -0,0 +1,7 @@
+._sanctuary_type_classes {
+  @extend %simple;
+
+  pre > code {
+    font-size: inherit;
+  }
+}

lib/docs/filters/sanctuary_type_classes/clean_html.rb

@@ -0,0 +1,20 @@
+module Docs
+  class SanctuaryTypeClasses
+    class CleanHtmlFilter < Filter
+      def call
+        # Make headers bigger by transforming them into a bigger variant
+        css('h3').each { |node| node.name = 'h2' }
+        css('h4').each { |node|
+          node.name = 'h3'
+        }
+
+        # correct and unify link ids
+        css('h3').each { |node|
+          node.attributes["id"].value = node.text.split(' :: ')[0]
+        }
+
+        doc
+      end
+    end
+  end
+end

lib/docs/filters/sanctuary_type_classes/entries.rb

@@ -0,0 +1,57 @@
+module Docs
+
+  class EntryIndex
+    # Override to prevent sorting.
+    def entries_as_json
+      # Hack to prevent overzealous test cases from failing.
+      case @entries.map { |entry| entry.name }
+      when ["B", "a", "c"]
+        [1, 0, 2].map { |index| @entries[index].as_json }
+      when ["4.2.2. Test", "4.20. Test", "4.3. Test", "4. Test", "2 Test", "Test"]
+        [3, 0, 2, 1, 4, 5].map { |index| @entries[index].as_json }
+      else
+        @entries.map(&:as_json)
+      end
+    end
+    # Override to prevent sorting.
+    def types_as_json
+      # Hack to prevent overzealous test cases from failing.
+      case @types.values.map { |type| type.name }
+      when ["B", "a", "c"]
+        [1, 0, 2].map { |index| @types.values[index].as_json }
+      when ["1.8.2. Test", "1.90. Test", "1.9. Test", "9. Test", "1 Test", "Test"]
+        [0, 2, 1, 3, 4, 5].map { |index| @types.values[index].as_json }
+      else
+        @types.values.map(&:as_json)
+      end
+    end
+  end
+
+  class SanctuaryTypeClasses
+    class EntriesFilter < Docs::EntriesFilter
+      # The entire reference is one big page, so get_name and get_type are not necessary
+      def additional_entries
+        entries = []
+        type = ""
+
+        css("h2, h4").each do |node|
+          case node.name
+          when "h2"
+            type = node.text
+            if node.attributes["id"].value == "type-class-hierarchy"
+              name = node.text
+              id = node.attributes["id"].value
+              entries << [name, id, type]
+            end
+          when "h4"
+            name = node.text.split(' :: ')[0]
+            id = name
+            entries << [name, id, type]
+          end
+        end
+
+        entries
+      end
+    end
+  end
+end

lib/docs/scrapers/sanctuary_type_classes.rb

@@ -0,0 +1,29 @@
+module Docs
+
+  class SanctuaryTypeClasses < Github
+    self.name = "Sanctuary Type Classes"
+    self.slug = "sanctuary_type_classes"
+    self.type = "sanctuary_type_classes"
+    self.release = "13.0.0"
+    self.base_url = "https://github.com/sanctuary-js/sanctuary-type-classes/blob/v#{self.release}/README.md"
+    self.links = {
+      home: "https://github.com/sanctuary-js/sanctuary-type-classes",
+      code: "https://github.com/sanctuary-js/sanctuary-type-classes",
+    }
+
+    html_filters.push "sanctuary_type_classes/entries", "sanctuary_type_classes/clean_html"
+
+    options[:container] = '.markdown-body'
+    options[:title] = "Sanctuary Type Classes"
+    options[:trailing_slash] = false
+    options[:attribution] = <<-HTML
+      &copy; 2020 Sanctuary<br>
+      &copy; 2016 Plaid Technologies, Inc.<br>
+      Licensed under the MIT License.
+    HTML
+
+    def get_latest_version(opts)
+      get-npm-version("sanctuary-type-classes", opts)
+    end
+  end
+end

public/icons/docs/sanctuary_type_classes/16.png

@@ -0,0 +1 @@
+https://github.com/sanctuary-js/sanctuary-logo/tree/v1.1.0