rxjs.rb 3.0 KB

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