puppeteer-ruby 0.0.13 → 0.0.14

Sign up to get free protection for your applications and to get access to all the features.
Files changed (126) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +0 -12
  3. data/.github/workflows/docs.yml +45 -0
  4. data/.github/workflows/reviewdog.yml +15 -0
  5. data/README.md +52 -1
  6. data/lib/puppeteer.rb +1 -1
  7. data/lib/puppeteer/browser.rb +17 -25
  8. data/lib/puppeteer/cdp_session.rb +3 -19
  9. data/lib/puppeteer/concurrent_ruby_utils.rb +6 -0
  10. data/lib/puppeteer/connection.rb +3 -15
  11. data/lib/puppeteer/define_async_method.rb +23 -0
  12. data/lib/puppeteer/dom_world.rb +6 -21
  13. data/lib/puppeteer/element_handle.rb +15 -44
  14. data/lib/puppeteer/emulation_manager.rb +2 -6
  15. data/lib/puppeteer/execution_context.rb +1 -6
  16. data/lib/puppeteer/frame.rb +30 -16
  17. data/lib/puppeteer/frame_manager.rb +7 -25
  18. data/lib/puppeteer/js_handle.rb +3 -12
  19. data/lib/puppeteer/keyboard.rb +6 -27
  20. data/lib/puppeteer/mouse.rb +5 -25
  21. data/lib/puppeteer/page.rb +39 -63
  22. data/lib/puppeteer/remote_object.rb +2 -5
  23. data/lib/puppeteer/touch_screen.rb +2 -7
  24. data/lib/puppeteer/version.rb +1 -1
  25. data/lib/puppeteer/wait_task.rb +2 -4
  26. data/puppeteer-ruby.gemspec +1 -1
  27. metadata +7 -103
  28. data/docs/Puppeteer.html +0 -2338
  29. data/docs/Puppeteer/AsyncAwaitBehavior.html +0 -105
  30. data/docs/Puppeteer/Browser.html +0 -2258
  31. data/docs/Puppeteer/BrowserContext.html +0 -809
  32. data/docs/Puppeteer/BrowserFetcher.html +0 -214
  33. data/docs/Puppeteer/BrowserRunner.html +0 -914
  34. data/docs/Puppeteer/BrowserRunner/BrowserProcess.html +0 -477
  35. data/docs/Puppeteer/CDPSession.html +0 -813
  36. data/docs/Puppeteer/CDPSession/Error.html +0 -124
  37. data/docs/Puppeteer/ConcurrentRubyUtils.html +0 -438
  38. data/docs/Puppeteer/Connection.html +0 -964
  39. data/docs/Puppeteer/Connection/MessageCallback.html +0 -434
  40. data/docs/Puppeteer/Connection/ProtocolError.html +0 -216
  41. data/docs/Puppeteer/Connection/RequestDebugPrinter.html +0 -217
  42. data/docs/Puppeteer/Connection/ResponseDebugPrinter.html +0 -244
  43. data/docs/Puppeteer/ConsoleMessage.html +0 -565
  44. data/docs/Puppeteer/ConsoleMessage/Location.html +0 -433
  45. data/docs/Puppeteer/DOMWorld.html +0 -2293
  46. data/docs/Puppeteer/DOMWorld/DetachedError.html +0 -124
  47. data/docs/Puppeteer/DOMWorld/DocumentEvaluationError.html +0 -124
  48. data/docs/Puppeteer/DebugPrint.html +0 -233
  49. data/docs/Puppeteer/Device.html +0 -470
  50. data/docs/Puppeteer/Devices.html +0 -139
  51. data/docs/Puppeteer/ElementHandle.html +0 -2542
  52. data/docs/Puppeteer/ElementHandle/BoundingBox.html +0 -507
  53. data/docs/Puppeteer/ElementHandle/BoxModel.html +0 -404
  54. data/docs/Puppeteer/ElementHandle/ElementNotFoundError.html +0 -206
  55. data/docs/Puppeteer/ElementHandle/ElementNotVisibleError.html +0 -206
  56. data/docs/Puppeteer/ElementHandle/Point.html +0 -492
  57. data/docs/Puppeteer/ElementHandle/ScrollIntoViewError.html +0 -124
  58. data/docs/Puppeteer/EmulationManager.html +0 -454
  59. data/docs/Puppeteer/EventCallbackable.html +0 -499
  60. data/docs/Puppeteer/EventCallbackable/EventListeners.html +0 -435
  61. data/docs/Puppeteer/ExecutionContext.html +0 -998
  62. data/docs/Puppeteer/ExecutionContext/EvaluationError.html +0 -124
  63. data/docs/Puppeteer/ExecutionContext/JavaScriptExpression.html +0 -357
  64. data/docs/Puppeteer/ExecutionContext/JavaScriptFunction.html +0 -389
  65. data/docs/Puppeteer/FileChooser.html +0 -455
  66. data/docs/Puppeteer/Frame.html +0 -3835
  67. data/docs/Puppeteer/FrameManager.html +0 -2410
  68. data/docs/Puppeteer/FrameManager/NavigationError.html +0 -124
  69. data/docs/Puppeteer/IfPresent.html +0 -222
  70. data/docs/Puppeteer/JSHandle.html +0 -1352
  71. data/docs/Puppeteer/Keyboard.html +0 -1557
  72. data/docs/Puppeteer/Keyboard/KeyDefinition.html +0 -831
  73. data/docs/Puppeteer/Keyboard/KeyDescription.html +0 -603
  74. data/docs/Puppeteer/Launcher.html +0 -237
  75. data/docs/Puppeteer/Launcher/Base.html +0 -385
  76. data/docs/Puppeteer/Launcher/Base/ExecutablePathNotFound.html +0 -124
  77. data/docs/Puppeteer/Launcher/BrowserOptions.html +0 -441
  78. data/docs/Puppeteer/Launcher/Chrome.html +0 -674
  79. data/docs/Puppeteer/Launcher/Chrome/DefaultArgs.html +0 -382
  80. data/docs/Puppeteer/Launcher/ChromeArgOptions.html +0 -531
  81. data/docs/Puppeteer/Launcher/LaunchOptions.html +0 -893
  82. data/docs/Puppeteer/LifecycleWatcher.html +0 -834
  83. data/docs/Puppeteer/LifecycleWatcher/ExpectedLifecycle.html +0 -363
  84. data/docs/Puppeteer/LifecycleWatcher/FrameDetachedError.html +0 -206
  85. data/docs/Puppeteer/LifecycleWatcher/TerminatedError.html +0 -124
  86. data/docs/Puppeteer/Mouse.html +0 -1095
  87. data/docs/Puppeteer/Mouse/Button.html +0 -136
  88. data/docs/Puppeteer/NetworkManager.html +0 -901
  89. data/docs/Puppeteer/NetworkManager/Credentials.html +0 -385
  90. data/docs/Puppeteer/Page.html +0 -6173
  91. data/docs/Puppeteer/Page/FileChooserTimeoutError.html +0 -206
  92. data/docs/Puppeteer/Page/ScreenshotOptions.html +0 -845
  93. data/docs/Puppeteer/Page/ScriptTag.html +0 -555
  94. data/docs/Puppeteer/Page/StyleTag.html +0 -448
  95. data/docs/Puppeteer/Page/TargetCrashedError.html +0 -124
  96. data/docs/Puppeteer/RemoteObject.html +0 -1087
  97. data/docs/Puppeteer/Target.html +0 -1336
  98. data/docs/Puppeteer/Target/InitializeFailure.html +0 -124
  99. data/docs/Puppeteer/Target/TargetInfo.html +0 -729
  100. data/docs/Puppeteer/TimeoutError.html +0 -135
  101. data/docs/Puppeteer/TimeoutSettings.html +0 -496
  102. data/docs/Puppeteer/TouchScreen.html +0 -464
  103. data/docs/Puppeteer/Viewport.html +0 -837
  104. data/docs/Puppeteer/WaitTask.html +0 -637
  105. data/docs/Puppeteer/WaitTask/TerminatedError.html +0 -124
  106. data/docs/Puppeteer/WaitTask/TimeoutError.html +0 -206
  107. data/docs/Puppeteer/WebSocket.html +0 -673
  108. data/docs/Puppeteer/WebSocket/DriverImpl.html +0 -412
  109. data/docs/Puppeteer/WebSocket/TransportError.html +0 -124
  110. data/docs/Puppeteer/WebSocketTransport.html +0 -600
  111. data/docs/Puppeteer/WebSocktTransportError.html +0 -124
  112. data/docs/_index.html +0 -816
  113. data/docs/class_list.html +0 -51
  114. data/docs/css/common.css +0 -1
  115. data/docs/css/full_list.css +0 -58
  116. data/docs/css/style.css +0 -496
  117. data/docs/file.README.html +0 -125
  118. data/docs/file_list.html +0 -56
  119. data/docs/frames.html +0 -17
  120. data/docs/index.html +0 -125
  121. data/docs/js/app.js +0 -314
  122. data/docs/js/full_list.js +0 -216
  123. data/docs/js/jquery.js +0 -4
  124. data/docs/method_list.html +0 -4123
  125. data/docs/top-level-namespace.html +0 -126
  126. data/lib/puppeteer/async_await_behavior.rb +0 -38
data/docs/file.README.html DELETED
@@ -1,125 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- File: README
8
-
9
- &mdash; Documentation by YARD 0.9.24
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="css/style.css" type="text/css" />
14
-
15
- <link rel="stylesheet" href="css/common.css" type="text/css" />
16
-
17
- <script type="text/javascript">
18
- pathId = "README";
19
- relpath = '';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="file_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="_index.html">Index</a> &raquo;
40
- <span class="title">File: README</span>
41
-
42
- </div>
43
-
44
- <div id="search">
45
-
46
- <a class="full_list_link" id="class_list_link"
47
- href="class_list.html">
48
-
49
- <svg width="24" height="24">
50
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
- </svg>
54
- </a>
55
-
56
- </div>
57
- <div class="clear"></div>
58
- </div>
59
-
60
- <div id="content"><div id='filecontents'>
61
- <h1 id="label-Puppeteer+in+Ruby+-5BUNDER+HEAVY+DEVELOPMENT-5D">Puppeteer in Ruby [UNDER HEAVY DEVELOPMENT]</h1>
62
-
63
- <p>A Ruby port of <a href="https://pptr.dev/">puppeteer</a>.</p>
64
-
65
- <p><img src="puppeteer-ruby.png"></p>
66
-
67
- <p>REMARK: This Gem is NOT production-ready!!</p>
68
-
69
- <h2 id="label-Getting+Started">Getting Started</h2>
70
-
71
- <h3 id="label-Capture+a+site">Capture a site</h3>
72
-
73
- <pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Puppeteer.html" title="Puppeteer (class)">Puppeteer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_launch'><span class='object_link'><a href="Puppeteer.html#launch-instance_method" title="Puppeteer#launch (method)">launch</a></span></span><span class='lparen'>(</span><span class='label'>headless:</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_browser'>browser</span><span class='op'>|</span>
74
- <span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_pages'>pages</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>||</span> <span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_new_page'>new_page</span>
75
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_goto'>goto</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://github.com/YusukeIwaki</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
76
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_screenshot'>screenshot</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>YusukeIwaki.png</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
77
- <span class='kw'>end</span>
78
- </code></pre>
79
-
80
- <h3 id="label-Simple+scraping">Simple scraping</h3>
81
-
82
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>puppeteer</span><span class='tstring_end'>&#39;</span></span>
83
-
84
- <span class='const'><span class='object_link'><a href="Puppeteer.html" title="Puppeteer (class)">Puppeteer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_launch'><span class='object_link'><a href="Puppeteer.html#launch-instance_method" title="Puppeteer#launch (method)">launch</a></span></span><span class='lparen'>(</span><span class='label'>headless:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>slow_mo:</span> <span class='int'>50</span><span class='comma'>,</span> <span class='label'>args:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>--guest</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>--window-size=1280,800</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_browser'>browser</span><span class='op'>|</span>
85
- <span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_pages'>pages</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>||</span> <span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_new_page'>new_page</span>
86
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_viewport'>viewport</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Puppeteer.html" title="Puppeteer (class)">Puppeteer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Puppeteer/Viewport.html" title="Puppeteer::Viewport (class)">Viewport</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Puppeteer/Viewport.html#initialize-instance_method" title="Puppeteer::Viewport#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>width:</span> <span class='int'>1280</span><span class='comma'>,</span> <span class='label'>height:</span> <span class='int'>800</span><span class='rparen'>)</span>
87
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_goto'>goto</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://github.com/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>wait_until:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>domcontentloaded</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
88
-
89
- <span class='id identifier rubyid_form'>form</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='const'>S</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>form.js-site-search-form</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
90
- <span class='id identifier rubyid_searchInput'>searchInput</span> <span class='op'>=</span> <span class='id identifier rubyid_form'>form</span><span class='period'>.</span><span class='const'>S</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>input.header-search-input</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
91
- <span class='id identifier rubyid_searchInput'>searchInput</span><span class='period'>.</span><span class='id identifier rubyid_type_text'>type_text</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>puppeteer</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
92
- <span class='id identifier rubyid_await_all'><span class='object_link'><a href="Puppeteer/ConcurrentRubyUtils.html#await_all-instance_method" title="Puppeteer::ConcurrentRubyUtils#await_all (method)">await_all</a></span></span><span class='lparen'>(</span>
93
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_async_wait_for_navigation'>async_wait_for_navigation</span><span class='comma'>,</span>
94
- <span class='id identifier rubyid_searchInput'>searchInput</span><span class='period'>.</span><span class='id identifier rubyid_async_press'>async_press</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Enter</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
95
- <span class='rparen'>)</span>
96
-
97
- <span class='id identifier rubyid_list'>list</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='const'>S</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ul.repo-list</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
98
- <span class='id identifier rubyid_items'>items</span> <span class='op'>=</span> <span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='const'>SS</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>div.f4</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
99
- <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_item'>item</span><span class='op'>|</span>
100
- <span class='id identifier rubyid_title'>title</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='const'>Seval</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>a</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>a =&gt; a.innerText</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
101
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>==&gt; </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_title'>title</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
102
- <span class='kw'>end</span>
103
- <span class='kw'>end</span>
104
- </code></pre>
105
-
106
- <p>More usage examples can be found <a href="https://github.com/YusukeIwaki/puppeteer-ruby-example">here</a></p>
107
-
108
- <h2 id="label-API">API</h2>
109
-
110
- <p><a href="https://yusukeiwaki.github.io/puppeteer-ruby">yusukeiwaki.github.io/puppeteer-ruby</a>/</p>
111
-
112
- <h2 id="label-Contributing">Contributing</h2>
113
-
114
- <p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/YusukeIwaki/puppeteer-ruby">github.com/YusukeIwaki/puppeteer-ruby</a>.</p>
115
- </div></div>
116
-
117
- <div id="footer">
118
- Generated on Wed Jun 24 03:07:58 2020 by
119
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
120
- 0.9.24 (ruby-2.6.3).
121
- </div>
122
-
123
- </div>
124
- </body>
125
- </html>
data/docs/file_list.html DELETED
@@ -1,56 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
- <meta charset="utf-8" />
6
-
7
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
8
-
9
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
10
-
11
-
12
-
13
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
-
15
- <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
-
17
-
18
- <title>File List</title>
19
- <base id="base_target" target="_parent" />
20
- </head>
21
- <body>
22
- <div id="content">
23
- <div class="fixed_header">
24
- <h1 id="full_list_header">File List</h1>
25
- <div id="full_list_nav">
26
-
27
- <span><a target="_self" href="class_list.html">
28
- Classes
29
- </a></span>
30
-
31
- <span><a target="_self" href="method_list.html">
32
- Methods
33
- </a></span>
34
-
35
- <span><a target="_self" href="file_list.html">
36
- Files
37
- </a></span>
38
-
39
- </div>
40
-
41
- <div id="search">Search: <input type="text" /></div>
42
- </div>
43
-
44
- <ul id="full_list" class="file">
45
-
46
-
47
- <li id="object_README" class="odd">
48
- <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
49
- </li>
50
-
51
-
52
-
53
- </ul>
54
- </div>
55
- </body>
56
- </html>
data/docs/frames.html DELETED
@@ -1,17 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <title>Documentation by YARD 0.9.24</title>
6
- </head>
7
- <script type="text/javascript">
8
- var match = unescape(window.location.hash).match(/^#!(.+)/);
9
- var name = match ? match[1] : 'index.html';
10
- name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
11
- window.top.location = name;
12
- </script>
13
- <noscript>
14
- <h1>Oops!</h1>
15
- <h2>YARD requires JavaScript!</h2>
16
- </noscript>
17
- </html>
data/docs/index.html DELETED
@@ -1,125 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- File: README
8
-
9
- &mdash; Documentation by YARD 0.9.24
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="css/style.css" type="text/css" />
14
-
15
- <link rel="stylesheet" href="css/common.css" type="text/css" />
16
-
17
- <script type="text/javascript">
18
- pathId = "README";
19
- relpath = '';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="_index.html">Index</a> &raquo;
40
- <span class="title">File: README</span>
41
-
42
- </div>
43
-
44
- <div id="search">
45
-
46
- <a class="full_list_link" id="class_list_link"
47
- href="class_list.html">
48
-
49
- <svg width="24" height="24">
50
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
- </svg>
54
- </a>
55
-
56
- </div>
57
- <div class="clear"></div>
58
- </div>
59
-
60
- <div id="content"><div id='filecontents'>
61
- <h1 id="label-Puppeteer+in+Ruby+-5BUNDER+HEAVY+DEVELOPMENT-5D">Puppeteer in Ruby [UNDER HEAVY DEVELOPMENT]</h1>
62
-
63
- <p>A Ruby port of <a href="https://pptr.dev/">puppeteer</a>.</p>
64
-
65
- <p><img src="puppeteer-ruby.png"></p>
66
-
67
- <p>REMARK: This Gem is NOT production-ready!!</p>
68
-
69
- <h2 id="label-Getting+Started">Getting Started</h2>
70
-
71
- <h3 id="label-Capture+a+site">Capture a site</h3>
72
-
73
- <pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Puppeteer.html" title="Puppeteer (class)">Puppeteer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_launch'><span class='object_link'><a href="Puppeteer.html#launch-instance_method" title="Puppeteer#launch (method)">launch</a></span></span><span class='lparen'>(</span><span class='label'>headless:</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_browser'>browser</span><span class='op'>|</span>
74
- <span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_pages'>pages</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>||</span> <span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_new_page'>new_page</span>
75
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_goto'>goto</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://github.com/YusukeIwaki</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
76
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_screenshot'>screenshot</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>YusukeIwaki.png</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
77
- <span class='kw'>end</span>
78
- </code></pre>
79
-
80
- <h3 id="label-Simple+scraping">Simple scraping</h3>
81
-
82
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>puppeteer</span><span class='tstring_end'>&#39;</span></span>
83
-
84
- <span class='const'><span class='object_link'><a href="Puppeteer.html" title="Puppeteer (class)">Puppeteer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_launch'><span class='object_link'><a href="Puppeteer.html#launch-instance_method" title="Puppeteer#launch (method)">launch</a></span></span><span class='lparen'>(</span><span class='label'>headless:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>slow_mo:</span> <span class='int'>50</span><span class='comma'>,</span> <span class='label'>args:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>--guest</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>--window-size=1280,800</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_browser'>browser</span><span class='op'>|</span>
85
- <span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_pages'>pages</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>||</span> <span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_new_page'>new_page</span>
86
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_viewport'>viewport</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Puppeteer.html" title="Puppeteer (class)">Puppeteer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Puppeteer/Viewport.html" title="Puppeteer::Viewport (class)">Viewport</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Puppeteer/Viewport.html#initialize-instance_method" title="Puppeteer::Viewport#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>width:</span> <span class='int'>1280</span><span class='comma'>,</span> <span class='label'>height:</span> <span class='int'>800</span><span class='rparen'>)</span>
87
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_goto'>goto</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://github.com/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>wait_until:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>domcontentloaded</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
88
-
89
- <span class='id identifier rubyid_form'>form</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='const'>S</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>form.js-site-search-form</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
90
- <span class='id identifier rubyid_searchInput'>searchInput</span> <span class='op'>=</span> <span class='id identifier rubyid_form'>form</span><span class='period'>.</span><span class='const'>S</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>input.header-search-input</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
91
- <span class='id identifier rubyid_searchInput'>searchInput</span><span class='period'>.</span><span class='id identifier rubyid_type_text'>type_text</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>puppeteer</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
92
- <span class='id identifier rubyid_await_all'><span class='object_link'><a href="Puppeteer/ConcurrentRubyUtils.html#await_all-instance_method" title="Puppeteer::ConcurrentRubyUtils#await_all (method)">await_all</a></span></span><span class='lparen'>(</span>
93
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_async_wait_for_navigation'>async_wait_for_navigation</span><span class='comma'>,</span>
94
- <span class='id identifier rubyid_searchInput'>searchInput</span><span class='period'>.</span><span class='id identifier rubyid_async_press'>async_press</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Enter</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
95
- <span class='rparen'>)</span>
96
-
97
- <span class='id identifier rubyid_list'>list</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='const'>S</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ul.repo-list</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
98
- <span class='id identifier rubyid_items'>items</span> <span class='op'>=</span> <span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='const'>SS</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>div.f4</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
99
- <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_item'>item</span><span class='op'>|</span>
100
- <span class='id identifier rubyid_title'>title</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='const'>Seval</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>a</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>a =&gt; a.innerText</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
101
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>==&gt; </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_title'>title</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
102
- <span class='kw'>end</span>
103
- <span class='kw'>end</span>
104
- </code></pre>
105
-
106
- <p>More usage examples can be found <a href="https://github.com/YusukeIwaki/puppeteer-ruby-example">here</a></p>
107
-
108
- <h2 id="label-API">API</h2>
109
-
110
- <p><a href="https://yusukeiwaki.github.io/puppeteer-ruby">yusukeiwaki.github.io/puppeteer-ruby</a>/</p>
111
-
112
- <h2 id="label-Contributing">Contributing</h2>
113
-
114
- <p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/YusukeIwaki/puppeteer-ruby">github.com/YusukeIwaki/puppeteer-ruby</a>.</p>
115
- </div></div>
116
-
117
- <div id="footer">
118
- Generated on Wed Jun 24 03:07:58 2020 by
119
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
120
- 0.9.24 (ruby-2.6.3).
121
- </div>
122
-
123
- </div>
124
- </body>
125
- </html>
data/docs/js/app.js DELETED
@@ -1,314 +0,0 @@
1
- (function() {
2
-
3
- var localStorage = {}, sessionStorage = {};
4
- try { localStorage = window.localStorage; } catch (e) { }
5
- try { sessionStorage = window.sessionStorage; } catch (e) { }
6
-
7
- function createSourceLinks() {
8
- $('.method_details_list .source_code').
9
- before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
10
- $('.toggleSource').toggle(function() {
11
- $(this).parent().nextAll('.source_code').slideDown(100);
12
- $(this).text("Hide source");
13
- },
14
- function() {
15
- $(this).parent().nextAll('.source_code').slideUp(100);
16
- $(this).text("View source");
17
- });
18
- }
19
-
20
- function createDefineLinks() {
21
- var tHeight = 0;
22
- $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
23
- $('.toggleDefines').toggle(function() {
24
- tHeight = $(this).parent().prev().height();
25
- $(this).prev().css('display', 'inline');
26
- $(this).parent().prev().height($(this).parent().height());
27
- $(this).text("(less)");
28
- },
29
- function() {
30
- $(this).prev().hide();
31
- $(this).parent().prev().height(tHeight);
32
- $(this).text("more...");
33
- });
34
- }
35
-
36
- function createFullTreeLinks() {
37
- var tHeight = 0;
38
- $('.inheritanceTree').toggle(function() {
39
- tHeight = $(this).parent().prev().height();
40
- $(this).parent().toggleClass('showAll');
41
- $(this).text("(hide)");
42
- $(this).parent().prev().height($(this).parent().height());
43
- },
44
- function() {
45
- $(this).parent().toggleClass('showAll');
46
- $(this).parent().prev().height(tHeight);
47
- $(this).text("show all");
48
- });
49
- }
50
-
51
- function searchFrameButtons() {
52
- $('.full_list_link').click(function() {
53
- toggleSearchFrame(this, $(this).attr('href'));
54
- return false;
55
- });
56
- window.addEventListener('message', function(e) {
57
- if (e.data === 'navEscape') {
58
- $('#nav').slideUp(100);
59
- $('#search a').removeClass('active inactive');
60
- $(window).focus();
61
- }
62
- });
63
-
64
- $(window).resize(function() {
65
- if ($('#search:visible').length === 0) {
66
- $('#nav').removeAttr('style');
67
- $('#search a').removeClass('active inactive');
68
- $(window).focus();
69
- }
70
- });
71
- }
72
-
73
- function toggleSearchFrame(id, link) {
74
- var frame = $('#nav');
75
- $('#search a').removeClass('active').addClass('inactive');
76
- if (frame.attr('src') === link && frame.css('display') !== "none") {
77
- frame.slideUp(100);
78
- $('#search a').removeClass('active inactive');
79
- }
80
- else {
81
- $(id).addClass('active').removeClass('inactive');
82
- if (frame.attr('src') !== link) frame.attr('src', link);
83
- frame.slideDown(100);
84
- }
85
- }
86
-
87
- function linkSummaries() {
88
- $('.summary_signature').click(function() {
89
- document.location = $(this).find('a').attr('href');
90
- });
91
- }
92
-
93
- function summaryToggle() {
94
- $('.summary_toggle').click(function(e) {
95
- e.preventDefault();
96
- localStorage.summaryCollapsed = $(this).text();
97
- $('.summary_toggle').each(function() {
98
- $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
99
- var next = $(this).parent().parent().nextAll('ul.summary').first();
100
- if (next.hasClass('compact')) {
101
- next.toggle();
102
- next.nextAll('ul.summary').first().toggle();
103
- }
104
- else if (next.hasClass('summary')) {
105
- var list = $('<ul class="summary compact" />');
106
- list.html(next.html());
107
- list.find('.summary_desc, .note').remove();
108
- list.find('a').each(function() {
109
- $(this).html($(this).find('strong').html());
110
- $(this).parent().html($(this)[0].outerHTML);
111
- });
112
- next.before(list);
113
- next.toggle();
114
- }
115
- });
116
- return false;
117
- });
118
- if (localStorage.summaryCollapsed == "collapse") {
119
- $('.summary_toggle').first().click();
120
- } else { localStorage.summaryCollapsed = "expand"; }
121
- }
122
-
123
- function constantSummaryToggle() {
124
- $('.constants_summary_toggle').click(function(e) {
125
- e.preventDefault();
126
- localStorage.summaryCollapsed = $(this).text();
127
- $('.constants_summary_toggle').each(function() {
128
- $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
129
- var next = $(this).parent().parent().nextAll('dl.constants').first();
130
- if (next.hasClass('compact')) {
131
- next.toggle();
132
- next.nextAll('dl.constants').first().toggle();
133
- }
134
- else if (next.hasClass('constants')) {
135
- var list = $('<dl class="constants compact" />');
136
- list.html(next.html());
137
- list.find('dt').each(function() {
138
- $(this).addClass('summary_signature');
139
- $(this).text( $(this).text().split('=')[0]);
140
- if ($(this).has(".deprecated").length) {
141
- $(this).addClass('deprecated');
142
- };
143
- });
144
- // Add the value of the constant as "Tooltip" to the summary object
145
- list.find('pre.code').each(function() {
146
- console.log($(this).parent());
147
- var dt_element = $(this).parent().prev();
148
- var tooltip = $(this).text();
149
- if (dt_element.hasClass("deprecated")) {
150
- tooltip = 'Deprecated. ' + tooltip;
151
- };
152
- dt_element.attr('title', tooltip);
153
- });
154
- list.find('.docstring, .tags, dd').remove();
155
- next.before(list);
156
- next.toggle();
157
- }
158
- });
159
- return false;
160
- });
161
- if (localStorage.summaryCollapsed == "collapse") {
162
- $('.constants_summary_toggle').first().click();
163
- } else { localStorage.summaryCollapsed = "expand"; }
164
- }
165
-
166
- function generateTOC() {
167
- if ($('#filecontents').length === 0) return;
168
- var _toc = $('<ol class="top"></ol>');
169
- var show = false;
170
- var toc = _toc;
171
- var counter = 0;
172
- var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
173
- var i;
174
- var curli;
175
- if ($('#filecontents h1').length > 1) tags.unshift('h1');
176
- for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
177
- var lastTag = parseInt(tags[0][1], 10);
178
- $(tags.join(', ')).each(function() {
179
- if ($(this).parents('.method_details .docstring').length != 0) return;
180
- if (this.id == "filecontents") return;
181
- show = true;
182
- var thisTag = parseInt(this.tagName[1], 10);
183
- if (this.id.length === 0) {
184
- var proposedId = $(this).attr('toc-id');
185
- if (typeof(proposedId) != "undefined") this.id = proposedId;
186
- else {
187
- var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
188
- if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
189
- this.id = proposedId;
190
- }
191
- }
192
- if (thisTag > lastTag) {
193
- for (i = 0; i < thisTag - lastTag; i++) {
194
- if ( typeof(curli) == "undefined" ) {
195
- curli = $('<li/>');
196
- toc.append(curli);
197
- }
198
- toc = $('<ol/>');
199
- curli.append(toc);
200
- curli = undefined;
201
- }
202
- }
203
- if (thisTag < lastTag) {
204
- for (i = 0; i < lastTag - thisTag; i++) {
205
- toc = toc.parent();
206
- toc = toc.parent();
207
- }
208
- }
209
- var title = $(this).attr('toc-title');
210
- if (typeof(title) == "undefined") title = $(this).text();
211
- curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
212
- toc.append(curli);
213
- lastTag = thisTag;
214
- });
215
- if (!show) return;
216
- html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
217
- $('#content').prepend(html);
218
- $('#toc').append(_toc);
219
- $('#toc .hide_toc').toggle(function() {
220
- $('#toc .top').slideUp('fast');
221
- $('#toc').toggleClass('hidden');
222
- $('#toc .title small').toggle();
223
- }, function() {
224
- $('#toc .top').slideDown('fast');
225
- $('#toc').toggleClass('hidden');
226
- $('#toc .title small').toggle();
227
- });
228
- }
229
-
230
- function navResizeFn(e) {
231
- if (e.which !== 1) {
232
- navResizeFnStop();
233
- return;
234
- }
235
-
236
- sessionStorage.navWidth = e.pageX.toString();
237
- $('.nav_wrap').css('width', e.pageX);
238
- $('.nav_wrap').css('-ms-flex', 'inherit');
239
- }
240
-
241
- function navResizeFnStop() {
242
- $(window).unbind('mousemove', navResizeFn);
243
- window.removeEventListener('message', navMessageFn, false);
244
- }
245
-
246
- function navMessageFn(e) {
247
- if (e.data.action === 'mousemove') navResizeFn(e.data.event);
248
- if (e.data.action === 'mouseup') navResizeFnStop();
249
- }
250
-
251
- function navResizer() {
252
- $('#resizer').mousedown(function(e) {
253
- e.preventDefault();
254
- $(window).mousemove(navResizeFn);
255
- window.addEventListener('message', navMessageFn, false);
256
- });
257
- $(window).mouseup(navResizeFnStop);
258
-
259
- if (sessionStorage.navWidth) {
260
- navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
261
- }
262
- }
263
-
264
- function navExpander() {
265
- var done = false, timer = setTimeout(postMessage, 500);
266
- function postMessage() {
267
- if (done) return;
268
- clearTimeout(timer);
269
- var opts = { action: 'expand', path: pathId };
270
- document.getElementById('nav').contentWindow.postMessage(opts, '*');
271
- done = true;
272
- }
273
-
274
- window.addEventListener('message', function(event) {
275
- if (event.data === 'navReady') postMessage();
276
- return false;
277
- }, false);
278
- }
279
-
280
- function mainFocus() {
281
- var hash = window.location.hash;
282
- if (hash !== '' && $(hash)[0]) {
283
- $(hash)[0].scrollIntoView();
284
- }
285
-
286
- setTimeout(function() { $('#main').focus(); }, 10);
287
- }
288
-
289
- function navigationChange() {
290
- // This works around the broken anchor navigation with the YARD template.
291
- window.onpopstate = function() {
292
- var hash = window.location.hash;
293
- if (hash !== '' && $(hash)[0]) {
294
- $(hash)[0].scrollIntoView();
295
- }
296
- };
297
- }
298
-
299
- $(document).ready(function() {
300
- navResizer();
301
- navExpander();
302
- createSourceLinks();
303
- createDefineLinks();
304
- createFullTreeLinks();
305
- searchFrameButtons();
306
- linkSummaries();
307
- summaryToggle();
308
- constantSummaryToggle();
309
- generateTOC();
310
- mainFocus();
311
- navigationChange();
312
- });
313
-
314
- })();