puppeteer-ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f42c72b65d27578da2dbdbbc4dac1544bb0a0038ba3c35ffd8f298dafc47f14
-  data.tar.gz: c1fe854ee2566bb9c8993e42cf71b881ff9c87a709150bb7cddd09a6d952901d
+  metadata.gz: 499744d122eeb8736a1466f17cf9ee09235f488fb19a95d3902da5529406dab0
+  data.tar.gz: f6b27f599887d385c46914e1b255f9738fd7f946a0ff0a4f83a04075e50e092c
 SHA512:
-  metadata.gz: ef51d01afe77f2c1bf31ed70a7bfe3a629377b32b69ceb265413876802639ef5c44de08856b0bfaa69bbddf7bf41a6aaef01bd7e4a2c4a516ec21b645b7caede
-  data.tar.gz: 7a876a89710c9fd956377b01ce41d463a6fd547805991f8778bd89086182a4800459bb6cf5d6009ea8a363629993f4bdd333263475c1e24cfb3a99f9b886e53e
+  metadata.gz: 54ece5985462bc3f4f30c1a803fd43a5975845911657431aa33d78d70fba6e242d447869a03b3ad6cf925e0e94315db2df62b4d9d74d8b00e381b8d95326e311
+  data.tar.gz: d7d3ab0af4b1bd69588b3998d0a47031d04d80fe3d0b7b55ec1f4b1a9b3ccd683c857faf06e103b972b9b59d63bda6fdc3e984f410720eeae17922176d518561

data/.circleci/config.yml

@@ -0,0 +1,41 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  deploy:
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: rake build
+          command: rake build
+      - run:
+          name: setup API key
+          command: |
+            mkdir -p ~/.gem/
+            echo "---" > ~/.gem/credentials
+            echo ":rubygems_api_key: $RUBYGEMS_API_KEY" >> ~/.gem/credentials
+            chmod 600 ~/.gem/credentials
+      - run:
+          name: Check Puppeteer::version
+          command: bundle exec ruby -e 'raise "invalid Puppeteer::VERSION" unless Puppeteer::VERSION == ENV["CIRCLE_TAG"]'
+      - run:
+          name: gem push
+          command: gem push pkg/puppeteer-ruby-$CIRCLE_TAG.gem
+
+workflows:
+  rubygems-deploy:
+    jobs:
+      - deploy:
+          filters:
+            tags:
+              only: /^[0-9]\.[0-9]+\.[0-9].*/
+            branches:
+              ignore: /.*/

data/.rubocop.yml

@@ -1,11 +1,175 @@
-Layout/LineLength:
-  Max: 120
+require:
+  - rubocop-rspec
 
-Style/AccessModifierDeclarations:
-  EnforcedStyle: inline
+AllCops:
+  TargetRubyVersion: 2.7
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
 
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/ClosingHeredocIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: only_before
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/RedundantFreeze:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Empty lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
 
 Style/FrozenStringLiteralComment:
   Enabled: false
@@ -23,6 +187,31 @@ Style/RaiseArgs:
   Enabled: true
   EnforcedStyle: compact
 
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: true
+  EnforcedStyle: inline
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
 Style/TrailingCommaInArguments:
   Enabled: true
   EnforcedStyleForMultiline: comma
@@ -34,3 +223,81 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   Enabled: true
   EnforcedStyleForMultiline: comma
+
+
+# rubocop-rspec
+
+RSpec/EmptyLineAfterExampleGroup:
+  Enabled: true
+
+RSpec/EmptyLineAfterHook:
+  Enabled: true
+
+# bad: expect("success").to eq(result)
+# good: expect(result).to eq("success")
+RSpec/ExpectActual:
+  Enabled: true
+
+# bad: expect{ subject }.to change(Hoge, :count).by(1)
+# good: expect{ subject }.to change{ Hoge.count }.by(1)
+RSpec/ExpectChange:
+  Enabled: true
+  EnforcedStyle: block
+
+RSpec/ExpectInHook:
+  Enabled: true
+
+RSpec/ImplicitBlockExpectation:
+  Enabled: true
+
+RSpec/InstanceVariable:
+  Enabled: true
+
+# bad: it_should_behave_like
+# good: it_behaves_like
+RSpec/ItBehavesLike:
+  Enabled: true
+
+RSpec/LeakyConstantDeclaration:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: true
+
+RSpec/MultipleSubjects:
+  Enabled: true
+
+RSpec/NestedGroups:
+  Enabled: true
+  Max: 4
+
+RSpec/NotToNot:
+  Enabled: true
+
+RSpec/PredicateMatcher:
+  Enabled: true
+
+RSpec/ReceiveCounts:
+  Enabled: true
+
+RSpec/ReceiveNever:
+  Enabled: true
+
+RSpec/ReturnFromStub:
+  Enabled: true
+  EnforcedStyle: and_return
+
+RSpec/SharedContext:
+  Enabled: true
+
+RSpec/SharedExamples:
+  Enabled: true
+
+RSpec/SingleArgumentMessageChain:
+  Enabled: true
+
+RSpec/VoidExpect:
+  Enabled: true
+
+RSpec/Yield:
+  Enabled: true

data/README.md

@@ -6,7 +6,17 @@ REMARK: This Gem is NOT production-ready!!
 
 ## Getting Started
 
-Simple usage:
+### Capture a site
+
+```ruby
+Puppeteer.launch(headless: false) do |browser|
+  page = browser.pages.first || browser.new_page
+  page.goto("https://github.com/YusukeIwaki")
+  page.screenshot(path: "YusukeIwaki.png")
+end
+```
+
+### Simple scraping
 
 ```ruby
 require 'puppeteer'

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/bin/console

@@ -7,5 +7,5 @@ require 'puppeteer'
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
+require 'pry'
 Pry.start

data/lib/puppeteer.rb

@@ -1,6 +1,6 @@
 require 'concurrent'
 
-class Puppeteer ; end
+class Puppeteer; end
 
 # Custom data types.
 require 'puppeteer/device'
@@ -56,7 +56,7 @@ class Puppeteer
     def instance
       @instance ||= Puppeteer.new(
                       project_root: __dir__,
-                      preferred_revision: "706915",
+                      preferred_revision: '706915',
                       is_puppeteer_core: true)
     end
   end

data/lib/puppeteer/async_await_behavior.rb

@@ -2,30 +2,28 @@ module Puppeteer::AsyncAwaitBehavior
   refine Class do
     # wrap with Concurrent::Promises.future
     def async(method_name)
-      begin
-        original_method = instance_method(method_name)
+      original_method = instance_method(method_name)
 
-        unless method_name.to_s.start_with?("async_")
-          puts "async method should start with 'async_': #{self.name}##{method_name}"
-        end
+      unless method_name.to_s.start_with?('async_')
+        puts "async method should start with 'async_': #{self.name}##{method_name}"
+      end
 
-        define_method(method_name) do |*args|
-          Concurrent::Promises.future {
-            original_method.bind(self).call(*args)
-          }
+      define_method(method_name) do |*args|
+        Concurrent::Promises.future do
+          original_method.bind(self).call(*args)
         end
-      rescue NameError
-        if respond_to?(method_name)
-          original_method = singleton_method(method_name)
+      end
+    rescue NameError
+      if respond_to?(method_name)
+        original_method = singleton_method(method_name)
 
-          unless method_name.to_s.start_with?("async_")
-            puts "async method should start with 'async_': #{method_name}"
-          end
+        unless method_name.to_s.start_with?('async_')
+          puts "async method should start with 'async_': #{method_name}"
+        end
 
-          define_singleton_method(method_name) do |*args|
-            Concurrent::Promises.future {
-              original_method.call(*args)
-            }
+        define_singleton_method(method_name) do |*args|
+          Concurrent::Promises.future do
+            original_method.call(*args)
           end
         end
       end

data/lib/puppeteer/browser.rb

@@ -94,7 +94,7 @@ class Puppeteer::Browser
     target = Puppeteer::Target.new(
       target_info: target_info,
       browser_context: context,
-      session_factory: ->{ @connection.create_session(target_info) },
+      session_factory: -> { @connection.create_session(target_info) },
       ignore_https_errors: @ignore_https_errors,
       default_viewport: @default_viewport,
       screenshot_task_queue: @screenshot_task_queue,
@@ -158,18 +158,18 @@ class Puppeteer::Browser
     target_id = result['targetId']
     target = @targets[target_id]
     await target.initialized_promise
-    await target.page;
+    await target.page
   end
 
   # @return {!Array<!Target>}
   def targets
-    @targets.values.select{ |target| target.initialized? }
+    @targets.values.select { |target| target.initialized? }
   end
 
 
   # @return {!Target}
   def target
-    targets.first{ |target| target.type == 'browser' }
+    targets.first { |target| target.type == 'browser' }
   end
 
   # @param {function(!Target):boolean} predicate
@@ -177,7 +177,7 @@ class Puppeteer::Browser
   # @return {!Promise<!Target>}
   def wait_for_target(predicate:, timeout: nil)
     timeout_in_sec = (timeout || 30000).to_i / 1000.0
-    existing_target = targets.first{ |target| predicate.call(target) }
+    existing_target = targets.first { |target| predicate.call(target) }
     return existing_target if existing_target
 
     event_listening_ids = []