playwright-runner 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96731975daab3c59ab001fb663aadfdd3cdc79b79af624f24823fd886624908e
-  data.tar.gz: 61b9e76b66eab8488d5569988726cee661c0fc9e2ad4549fe8fe3faf49c0c688
+  metadata.gz: a399a87fd16e38291470284d5301ac9f90eeece484c6f5f7cc6800885a343ccf
+  data.tar.gz: 15b75986e430acf686ac37865c81d2d36380bbdde99d6e7adddc27216c09cdfc
 SHA512:
-  metadata.gz: 470deb264f7e15c05ced9c9021e4e0efad66f5b2e36f797f75a69a21f7fc5ff938899e1499aa4bf1709f61ef51ae442835d8d230ec4818d230596021e2e311c2
-  data.tar.gz: a75b6871098d4954b84579a9059141e92daea649cfaf30ee68fd6bfe47fd1f2707fa583a3ec7162a2fd7b80e52af94afebc980e8d8aa3b0f2efc200c44030514
+  metadata.gz: 31d4186bb3dbe50865400a4be597663d4611085d6b0ce395de8dec2ad097ecafd24495fba3b9fe03ebd190ccc3f46c37b6f078a87ac00fd49f71b45e2a4367ea
+  data.tar.gz: 928a70639b0d77cbc36b8c59ec6a68a205eb6e70259e8c337cebb68d739d19ac5d8e5b72df06c7a69645bc7f0aa55bfa2dc33fc5b37525d2e04e273407ffabbf

data/.github/workflows/main.yml

@@ -6,13 +6,12 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v5
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.4
+        ruby-version: 3.4
     - name: Run the default task
       run: |
-        gem install bundler -v 2.2.5
         bundle install
         bundle exec rake

data/Gemfile

@@ -4,8 +4,9 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'base64'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 1.45.1'
+gem 'rubocop', '~> 1.80.1'
 gem 'rubocop-performance'
 gem 'rubocop-rake'
 gem 'simplecov'

data/README.md

@@ -27,31 +27,35 @@ Of course PlaywrightRunner needs Playwright npm library.
 
 ## Usage
 
-### Mermaid to PDF or SVG
+### Mermaid to PNG, PDF or SVG
 
-Let's convert HTML files contain [Mermaid](https://mermaid.js.org/) to PDF/SVG.
-You have to install two components also to crop and convert PDF before running:
+Let's convert HTML files contain [Mermaid](https://mermaid.js.org/) to PNG/PDF/SVG.
 
-- [pdfcrop](https://www.ctan.org/pkg/pdfcrop) in TeXLive.
-- [pdftocairo](https://gitlab.freedesktop.org/poppler/poppler) in poppler (if you'd like to get SVG).
+- To get marginless PDF, you have to install [pdfcrop](https://www.ctan.org/pkg/pdfcrop) from TeXLive.
+- To make SVG, you have to install [pdftocairo](https://gitlab.freedesktop.org/poppler/poppler) from poppler.
 
 On Debian GNU/Linux or its derivatives, ues `apt-get install texlive-extra-utils poppler-utils`.
 
+#### Syntax
 ```ruby
+config = {  # you can omit them if you don't want to change anything
+  playwright_path: './node_modules/.bin/playwright',  # playwright binary path
+  selfcrop: true,  # use chromium's crop logic. if you'd like to use better cropping, set this to false
+  pdfcrop_path: 'pdfcrop',  # pdfcrop path (will be ignored when selfcrop: true)
+  pdftocairo_path: 'pdftocairo'  # pdftocairo path
+}
+
 PlaywrightRunner.mermaids_to_images(
-  {
-    playwright_path: './node_modules/.bin/playwright', // playwright binary path
-    pdfcrop_path: 'pdfcrop', // pdfcrop path
-    pdftocairo_path: 'pdftocairo' // pdftocairo path
-  },
-  src: '.', // source folder contains html files
-  dest: '.', // destination folder to export pdf or svg
-  type: 'pdf' // 'pdf' or 'svg'
+  config,  # config hash. if you want to use default values, specify {}
+  src: '.',  # source folder contains html files
+  dest: '.',  # destination folder to export pdf or svg
+  type: 'pdf'  # 'png', 'pdf', or 'svg'
 )
 ```
 
-It converts all HTML files in the folder specified by `src` into PDF or SVG files (specified by `type`) using that name and writes them in the folder specified by `dest`.
+It converts all HTML files in the folder specified by `src` into PNG, PDF or SVG files (specified by `type`) using that name and writes them in the folder specified by `dest`.
 
+#### Example
 For Example, here is `p1.html` contains Mermaid code.
 
 ```html
@@ -81,7 +85,7 @@ require 'playwrightrunner'
 
 PlaywrightRunner.mermaids_to_images(
   {
-    playwright_path: './node_modules/.bin/playwright' // modify for your env
+    playwright_path: './node_modules/.bin/playwright'  # modify for your env
   },
   src: '.',
   dest: '.',
@@ -96,7 +100,8 @@ require 'playwrightrunner'
 
 PlaywrightRunner.mermaids_to_images(
   {
-    playwright_path: './node_modules/.bin/playwright' // modify for your env
+    playwright_path: './node_modules/.bin/playwright',  # modify for your env
+    pdftocairo: 'pdftocairo'  # set the path to your pdftocairo
   },
   src: '.',
   dest: '.',
@@ -106,6 +111,42 @@ PlaywrightRunner.mermaids_to_images(
 
 ![sample SVG](p1.svg)
 
+Convert it to PNG. `p1.png` will be created.
+
+```ruby
+require 'playwrightrunner'
+
+PlaywrightRunner.mermaids_to_images(
+  {
+    playwright_path: './node_modules/.bin/playwright'  # modify for your env
+  },
+  src: '.',
+  dest: '.',
+  type: 'png'
+)
+```
+
+#### about outside margin of images
+
+In the default settings, white margins occur around the image. This is chromium's specification. To avoid this, you need to crop the PDF using the external command `pdfcrop`.
+
+After installing `pdfcrop`, specify `selfcrop: false` on config.
+
+```ruby
+require 'playwrightrunner'
+
+PlaywrightRunner.mermaids_to_images(
+  {
+    playwright_path: './node_modules/.bin/playwright'  # modify for your env
+    selfcrop: false,
+    pdfcrop_path: 'pdfcrop'  # set the path to your pdfcrop
+  },
+  src: '.',
+  dest: '.',
+  type: 'pdf'
+)
+```
+
 ## License
 
 ```

data/lib/playwrightrunner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlaywrightRunner
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

data/lib/playwrightrunner.rb

@@ -9,22 +9,26 @@ require 'open3'
 require 'fileutils'
 
 module PlaywrightRunner
-  def complement_config(config)
+  def default_config(config)
     config[:playwright_path] ||= './node_modules/.bin/playwright'
+
+    # for Mermaid
+    config[:selfcrop] = true if config[:selfcrop].nil?
     config[:pdfcrop_path] ||= 'pdfcrop'
     config[:pdftocairo_path] ||= 'pdftocairo'
 
     config
   end
 
-  def mermaids_to_images(config, src: '.', dest: '.', type: 'pdf')
+  def mermaids_to_images(passed_config, src: '.', dest: '.', type: 'pdf', timeout: 10_000)
+    config = default_config(passed_config)
     Playwright.create(playwright_cli_executable_path: config[:playwright_path]) do |playwright|
-      playwright.chromium.launch(headless: true) do |browser|
+      playwright.chromium.launch(headless: true, timeout: timeout) do |browser|
         page = browser.new_page
         Dir.glob(File.join(src, '*.html')).each do |entry|
           id = File.basename(entry).sub('.html', '')
-          page.goto("file:///#{File.absolute_path(entry)}")
-          page.locator('svg').wait_for(state: 'visible')
+          page.goto("file:///#{File.absolute_path(entry)}", timeout: timeout)
+          page.locator('svg').wait_for(state: 'visible', timeout: timeout)
           sleep(1)
           1.upto(4) do
             bounds = page.locator('svg').bounding_box
@@ -34,18 +38,40 @@ module PlaywrightRunner
               next
             end
 
-            page.pdf(path: File.join(dest, '__PLAYWRIGHT_TMP__.pdf'))
+            if config[:selfcrop]
+              x = bounds['x'].floor
+              y = bounds['y'].floor
+              width = bounds['width'].ceil
+              height = bounds['height'].ceil
+              page.set_viewport_size({ width: x + width, height: y + height })
+
+              if type == 'png'
+                page.screenshot(path: File.join(dest, "#{id}.png"), clip: { x: x, y: y, width: width, height: height },
+                                timeout: timeout)
+                break
+              end
+
+              page.pdf(path: File.join(dest, "#{id}.pdf"),
+                       width: "#{width + (x * 2)}px",
+                       height: "#{height + (y * 2)}px")
+            else
+              page.pdf(path: File.join(dest, '__PLAYWRIGHT_TMP__.pdf'))
+              Open3.capture2e(config[:pdfcrop_path],
+                              File.join(dest, '__PLAYWRIGHT_TMP__.pdf'),
+                              File.join(dest, "#{id}.pdf"))
+            end
+
             break
           end
 
-          Open3.capture2e(config[:pdfcrop_path],
-                          File.join(dest, '__PLAYWRIGHT_TMP__.pdf'),
-                          File.join(dest, "#{id}.pdf"))
-
           next unless type == 'svg'
 
           Open3.capture2e(config[:pdftocairo_path],
                           '-svg',
+                          '-f',
+                          '1',
+                          '-l',
+                          '1',
                           File.join(dest, "#{id}.pdf"),
                           File.join(dest, "#{id}.svg"))
           FileUtils.rm_f(File.join(dest, "#{id}.pdf"))
@@ -56,5 +82,5 @@ module PlaywrightRunner
     end
   end
 
-  module_function :complement_config, :mermaids_to_images
+  module_function :mermaids_to_images, :default_config
 end

data/playwright-runner.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |spec|
 
   spec.metadata['rubygems_mfa_required'] = 'true'
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/kmuto/playwright-runner'
   spec.metadata['changelog_uri'] = 'https://github.com/kmuto/playwright-runner/commits/main'
 
   # Specify which files should be added to the gem when it is released.
@@ -28,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'playwright-ruby-client', '~> 1.0'
+  spec.add_dependency 'playwright-ruby-client', '~> 1.28'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: playwright-runner
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Kenshi Muto
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: playwright-ruby-client
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.28'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.28'
 description: Provide useful methods to run Playwright, intended to be used with Re:VIEW
 email:
 - kmuto@kmuto.jp
@@ -50,9 +49,7 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/kmuto/playwright-runner
-  source_code_uri: https://github.com/kmuto/playwright-runner
   changelog_uri: https://github.com/kmuto/playwright-runner/commits/main
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -67,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Playwright Runner
 test_files: []