rxjs.rb 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. require 'yajl/json_gem'
  2. module Docs
  3. class Rxjs < UrlScraper
  4. self.name = 'RxJS'
  5. self.type = 'rxjs'
  6. self.release = '7.0.1'
  7. self.base_url = 'https://rxjs.dev/'
  8. self.root_path = 'guide/overview'
  9. self.links = {
  10. home: 'https://rxjs.dev/',
  11. code: 'https://github.com/ReactiveX/rxjs'
  12. }
  13. html_filters.push 'rxjs/clean_html', 'rxjs/entries'
  14. options[:follow_links] = false
  15. options[:only_patterns] = [/guide\//, /api\//]
  16. options[:skip_patterns] = [/api\/([^\/]+)\.json/]
  17. options[:fix_urls_before_parse] = ->(url) do
  18. url.sub! %r{\A(\.\/)?guide/}, '/guide/'
  19. url.sub! %r{\Aapi/}, '/api/'
  20. url.sub! %r{\Agenerated/}, '/generated/'
  21. url
  22. end
  23. options[:max_image_size] = 256_000
  24. options[:attribution] = <<-HTML
  25. &copy; 2015&ndash;2021 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors.<br>
  26. Code licensed under an Apache-2.0 License. Documentation licensed under CC BY 4.0.
  27. HTML
  28. def get_latest_version(opts)
  29. json = fetch_json('https://rxjs.dev/generated/navigation.json', opts)
  30. json['__versionInfo']['raw']
  31. end
  32. private
  33. def initial_urls
  34. initial_urls = []
  35. Request.run "#{self.class.base_url}generated/navigation.json" do |response|
  36. data = JSON.parse(response.body)
  37. dig = ->(entry) do
  38. initial_urls << url_for("generated/docs/#{entry['url']}.json") if entry['url'] && entry['url'] != 'api'
  39. entry['children'].each(&dig) if entry['children']
  40. end
  41. data['SideNav'].each(&dig)
  42. end
  43. Request.run "#{self.class.base_url}generated/docs/api/api-list.json" do |response|
  44. data = JSON.parse(response.body)
  45. dig = ->(entry) do
  46. initial_urls << url_for("generated/docs/#{entry['path']}.json") if entry['path']
  47. initial_urls << url_for("generated/docs/api/#{entry['name']}.json") if entry['name'] && !entry['path']
  48. entry['items'].each(&dig) if entry['items']
  49. end
  50. data.each(&dig)
  51. end
  52. initial_urls.select do |url|
  53. options[:only_patterns].any? { |pattern| url =~ pattern } &&
  54. options[:skip_patterns].none? { |pattern| url =~ pattern }
  55. end
  56. end
  57. def handle_response(response)
  58. if response.mime_type.include?('json')
  59. begin
  60. response.options[:response_body] = JSON.parse(response.body)['contents']
  61. rescue JSON::ParserError
  62. response.options[:response_body] = ''
  63. end
  64. response.headers['Content-Type'] = 'text/html'
  65. response.url.path = response.url.path.sub('/generated/docs/', '/').remove('.json')
  66. response.effective_url.path = response.effective_url.path.sub('/generated/docs/', '/').remove('.json')
  67. end
  68. super
  69. end
  70. def parse(response)
  71. response.body.gsub! '<code-example', '<pre'
  72. response.body.gsub! '</code-example', '</pre'
  73. response.body.gsub! '<code-pane', '<pre'
  74. response.body.gsub! '</code-pane', '</pre'
  75. response.body.gsub! '<live-example></live-example>', 'live example'
  76. response.body.gsub! '<live-example', '<span'
  77. response.body.gsub! '</live-example', '</span'
  78. super
  79. end
  80. end
  81. end