Merge pull request #954 from filipesilva/rxjs

Add RxJS

Co-authored-by: Jasper van Merle <[email protected]>

Author: jmerle

assets/javascripts/templates/pages/about_tmpl.coffee

@@ -211,8 +211,7 @@ credits = [
     '2017 Cypress.io',
     'MIT',
     'https://raw.githubusercontent.com/cypress-io/cypress-documentation/develop/LICENSE.md'
-  ],
-  [
+  ], [
     'D',
     '1999-2018 The D Language Foundation',
     'Boost',
@@ -572,8 +571,7 @@ credits = [
     '2016-2018, The Pony Developers & 2014-2015, Causality Ltd.',
     'BSD',
     'https://raw.githubusercontent.com/ponylang/ponyc/master/LICENSE'
-  ],
-  [
+  ], [
     'PostgreSQL',
     '1996-2018 The PostgreSQL Global Development Group<br>&copy; 1994 The Regents of the University of California',
     'PostgreSQL',
@@ -648,13 +646,17 @@ credits = [
     '2010 The Rust Project Developers',
     'MIT',
     'https://raw.githubusercontent.com/rust-lang/rust/master/LICENSE-MIT'
+  ], [
+    'RxJS',
+    '2015-2018 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors',
+    'Apache',
+    'https://raw.githubusercontent.com/ReactiveX/rxjs/master/LICENSE.txt'
   ], [
     'Salt Stack',
     '2019 SaltStack',
     'Apache',
     'https://raw.githubusercontent.com/saltstack/salt/develop/LICENSE'
-  ],
-  [
+  ], [
     'Sass',
     '2006-2016 Hampton Catlin, Nathan Weizenbaum, and Chris Eppstein',
     'MIT',
@@ -664,8 +666,7 @@ credits = [
     '2002-2019 EPFL, with contributions from Lightbend',
     'Apache',
     'https://raw.githubusercontent.com/scala/scala-lang/master/license.md'
-  ],
-  [
+  ], [
     'scikit-image',
     '2011 the scikit-image team',
     'BSD',
@@ -765,8 +766,7 @@ credits = [
     '2003-2019 WordPress Foundation',
     'GPLv2+',
     'https://wordpress.org/about/license/'
-  ],
-  [
+  ], [
     'Yarn',
     '2016-present Yarn Contributors',
     'BSD',

assets/stylesheets/application.css.scss

@@ -94,6 +94,7 @@
         'pages/rfc',
         'pages/rubydoc',
         'pages/rust',
+        'pages/rxjs',
         'pages/scala',
         'pages/sinon',
         'pages/socketio',

assets/stylesheets/pages/_rxjs.scss

@@ -0,0 +1,24 @@
+._rxjs {
+  @extend %simple;
+
+  .pre-title { @extend %pre-heading; }
+
+  .breadcrumbs { @extend %note; }
+  .banner { @extend %note-green; }
+  code.stable { @extend %label-green; }
+  code.experimental { @extend %label-orange; }
+  code.deprecated { @extend %label-red; }
+  .alert.is-important { @extend %note-red; }
+  .alert.is-helpful, .breadcrumbs { @extend %note-blue; }
+
+  .breadcrumbs { padding-left: 2em; }
+
+  img { margin: 1em 0; }
+
+  .location-badge {
+    font-style: italic;
+    text-align: right;
+  }
+
+  td h3 { margin: 0 !important; }
+}

lib/docs/filters/rxjs/clean_html.rb

@@ -0,0 +1,139 @@
+module Docs
+  class Rxjs
+    class CleanHtmlFilter < Filter
+      def call
+        if root_page?
+          css('.card-container').remove
+          at_css('h1').content = 'RxJS Documentation'
+        end
+
+        if at_css('h1').nil?
+          title = subpath.rpartition('/').last.titleize
+          doc.prepend_child("<h1>#{title}</h1>")
+        end
+
+        css('br', 'hr', '.material-icons', '.header-link', '.breadcrumb').remove
+
+        css('.content', 'article', '.api-header', 'section', '.instance-member').each do |node|
+          node.before(node.children).remove
+        end
+
+        css('label', 'h2 > em', 'h3 > em').each do |node|
+          node.name = 'code'
+        end
+
+        css('h1 + code').each do |node|
+          node.before('<p></p>')
+          while node.next_element.name == 'code'
+            node.previous_element << ' '
+            node.previous_element << node.next_element
+          end
+          node.previous_element.prepend_child(node)
+        end
+
+        css('td h3', '.l-sub-section > h3', '.alert h3', '.row-margin > h3', '.api-heading ~ h3', '.api-heading + h2', '.metadata-member h3').each do |node|
+          node.name = 'h4'
+        end
+
+        css('.l-sub-section', '.alert', '.banner').each do |node|
+          node.name = 'blockquote'
+        end
+
+        css('.file').each do |node|
+          node.content = node.content.strip
+        end
+
+        css('.filetree .children').each do |node|
+          node.css('.file').each do |n|
+            n.content = "  #{n.content}"
+          end
+        end
+
+        css('.filetree').each do |node|
+          node.content = node.css('.file').map(&:inner_html).join("\n")
+          node.name = 'pre'
+          node.remove_attribute('class')
+        end
+
+        css('pre').each do |node|
+          node.content = node.content.strip
+
+          node['data-language'] = 'typescript' if node['path'].try(:ends_with?, '.ts')
+          node['data-language'] = 'html' if node['path'].try(:ends_with?, '.html')
+          node['data-language'] = 'css' if node['path'].try(:ends_with?, '.css')
+          node['data-language'] = 'js' if node['path'].try(:ends_with?, '.js')
+          node['data-language'] = 'json' if node['path'].try(:ends_with?, '.json')
+          node['data-language'] = node['language'].sub(/\Ats/, 'typescript').strip if node['language']
+          node['data-language'] ||= 'typescript' if node.content.start_with?('@')
+
+          node.before(%(<div class="pre-title">#{node['title']}</div>)) if node['title']
+
+          if node['class'] && node['class'].include?('api-heading')
+            node.name = 'h3'
+
+            unless node.ancestors('.instance-method').empty?
+              matches = node.inner_html.scan(/([^(& ]+)[(&]/)
+
+              unless matches.empty? || matches[0][0] == 'constructor'
+                node['name'] = matches[0][0]
+                node['id'] = node['name'].downcase + '-'
+              end
+            end
+
+            node.inner_html = "<code>#{node.inner_html}</code>"
+          end
+
+          node.remove_attribute('path')
+          node.remove_attribute('region')
+          node.remove_attribute('linenums')
+          node.remove_attribute('title')
+          node.remove_attribute('language')
+          node.remove_attribute('hidecopy')
+          node.remove_attribute('class')
+        end
+
+        css('td > .overloads').each do |node|
+          node.replace node.at_css('.detail-contents')
+        end
+
+        css('td.short-description p').each do |node|
+          signature = node.parent.parent.next_element.at_css('h3[id]')
+          signature.after(node) unless signature.nil?
+        end
+
+        css('.method-table').each do |node|
+          node.replace node.at_css('tbody')
+        end
+
+        css('.api-body > table > caption').each do |node|
+          node.name = 'center'
+          lift_out_of_table node
+        end
+
+        css('.api-body > table > tbody > tr:not([class]) > td > *').each do |node|
+          lift_out_of_table node
+        end
+
+        css('.api-body > table').each do |node|
+          node.remove if node.content.strip.blank?
+        end
+
+        css('h1[class]').remove_attr('class')
+        css('table[class]').remove_attr('class')
+        css('table[width]').remove_attr('width')
+        css('tr[style]').remove_attr('style')
+
+        css('code code').each do |node|
+          node.before(node.children).remove
+        end
+
+        doc
+      end
+
+      def lift_out_of_table(node)
+        table = node.ancestors('table').first
+        table.previous_element.after(node)
+      end
+    end
+  end
+end

lib/docs/filters/rxjs/entries.rb

@@ -0,0 +1,29 @@
+module Docs
+  class Rxjs
+    class EntriesFilter < Docs::EntriesFilter
+      def get_name
+        title = at_css('h1')
+        name = title.nil? ? subpath.rpartition('/').last.titleize : title.content
+        name.prepend "#{$1}. " if subpath =~ /\-pt(\d+)/
+        name += '()' unless at_css('.api-type-label.function').nil?
+        name
+      end
+
+      def get_type
+        if slug.start_with?('guide')
+          'Guide'
+        elsif slug.start_with?('api/')
+          slug.split('/').second
+        else
+          'Miscellaneous'
+        end
+      end
+
+      def additional_entries
+        css('h3[id]').map do |node|
+          ["#{name}.#{node['name']}()", node['id']]
+        end
+      end
+    end
+  end
+end

lib/docs/scrapers/rxjs.rb

@@ -0,0 +1,94 @@
+require 'yajl/json_gem'
+
+module Docs
+  class Rxjs < UrlScraper
+    self.name = 'RxJS'
+    self.type = 'rxjs'
+    self.release = '6.5.2'
+    self.base_url = 'https://rxjs.dev/'
+    self.root_path = 'guide/overview'
+    self.links = {
+      home: 'https://rxjs.dev/',
+      code: 'https://github.com/ReactiveX/rxjs'
+    }
+
+    html_filters.push 'rxjs/clean_html', 'rxjs/entries'
+
+    options[:follow_links] = false
+    options[:only_patterns] = [/guide\//, /api\//]
+    options[:skip_patterns] = [/api\/([^\/]+)\.json/]
+    options[:fix_urls_before_parse] = ->(url) do
+      url.sub! %r{\Aguide/}, '/guide/'
+      url.sub! %r{\Aapi/}, '/api/'
+      url.sub! %r{\Agenerated/}, '/generated/'
+      url
+    end
+
+    options[:max_image_size] = 256_000
+
+    options[:attribution] = <<-HTML
+      &copy; 2015&ndash;2018 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors.<br>
+      Code licensed under an Apache-2.0 License. Documentation licensed under CC BY 4.0.
+    HTML
+
+    def get_latest_version(opts)
+      json = fetch_json('https://rxjs.dev/generated/navigation.json', opts)
+      json['__versionInfo']['raw']
+    end
+
+    private
+
+    def initial_urls
+      initial_urls = []
+
+      Request.run "#{self.class.base_url}generated/navigation.json" do |response|
+        data = JSON.parse(response.body)
+        dig = ->(entry) do
+          initial_urls << url_for("generated/docs/#{entry['url']}.json") if entry['url'] && entry['url'] != 'api'
+          entry['children'].each(&dig) if entry['children']
+        end
+        data['SideNav'].each(&dig)
+      end
+
+      Request.run "#{self.class.base_url}generated/docs/api/api-list.json" do |response|
+        data = JSON.parse(response.body)
+        dig = ->(entry) do
+          initial_urls << url_for("generated/docs/#{entry['path']}.json") if entry['path']
+          initial_urls << url_for("generated/docs/api/#{entry['name']}.json") if entry['name'] && !entry['path']
+          entry['items'].each(&dig) if entry['items']
+        end
+        data.each(&dig)
+      end
+
+      initial_urls.select do |url|
+        options[:only_patterns].any? { |pattern| url =~ pattern } &&
+          options[:skip_patterns].none? { |pattern| url =~ pattern }
+      end
+    end
+
+    def handle_response(response)
+      if response.mime_type.include?('json')
+        begin
+          response.options[:response_body] = JSON.parse(response.body)['contents']
+        rescue JSON::ParserError
+          response.options[:response_body] = ''
+        end
+        response.headers['Content-Type'] = 'text/html'
+        response.url.path = response.url.path.sub('/generated/docs/', '/').remove('.json')
+        response.effective_url.path = response.effective_url.path.sub('/generated/docs/', '/').remove('.json')
+      end
+      super
+    end
+
+    def parse(response)
+      response.body.gsub! '<code-example', '<pre'
+      response.body.gsub! '</code-example', '</pre'
+      response.body.gsub! '<code-pane', '<pre'
+      response.body.gsub! '</code-pane', '</pre'
+      response.body.gsub! '<live-example></live-example>', 'live example'
+      response.body.gsub! '<live-example', '<span'
+      response.body.gsub! '</live-example', '</span'
+      super
+    end
+  end
+end

public/icons/docs/rxjs/16.png

@@ -0,0 +1 @@
+https://github.com/ReactiveX/reactivex.github.io/blob/develop/favicon.ico