playwright-runner 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96731975daab3c59ab001fb663aadfdd3cdc79b79af624f24823fd886624908e
-  data.tar.gz: 61b9e76b66eab8488d5569988726cee661c0fc9e2ad4549fe8fe3faf49c0c688
+  metadata.gz: 9d3cb5e46560a71cbf7ea7392e258784661fac579f9c9b7dcf3f8a6072eb2f7f
+  data.tar.gz: fad84f8a69bbd9150ecb0e9395d2d57e5f5673009285ff5b2b95acc9e45a9053
 SHA512:
-  metadata.gz: 470deb264f7e15c05ced9c9021e4e0efad66f5b2e36f797f75a69a21f7fc5ff938899e1499aa4bf1709f61ef51ae442835d8d230ec4818d230596021e2e311c2
-  data.tar.gz: a75b6871098d4954b84579a9059141e92daea649cfaf30ee68fd6bfe47fd1f2707fa583a3ec7162a2fd7b80e52af94afebc980e8d8aa3b0f2efc200c44030514
+  metadata.gz: 3679ea32e8f8279b11f1ea3cb3d3beefda7598b590e342ced27a49995436968c3cbb79947c2edc0a88e823f81cde9fd097bb70dcfa683bf1b0a99c987d7e9f11
+  data.tar.gz: aafdac6993fa160ff9b00efdcd97bdeaef9be79fdb99337b92502b71130971eb6b6fd1c6c7fcb341cced7f6e2550a49abda9c940c957e1a7c2876605682d134d

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.2.0'
 end

data/lib/playwrightrunner.rb

@@ -9,15 +9,19 @@ 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')
+    config = default_config(passed_config)
     Playwright.create(playwright_cli_executable_path: config[:playwright_path]) do |playwright|
       playwright.chromium.launch(headless: true) do |browser|
         page = browser.new_page
@@ -34,18 +38,39 @@ 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 })
+                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 +81,5 @@ module PlaywrightRunner
     end
   end
 
-  module_function :complement_config, :mermaids_to_images
+  module_function :mermaids_to_images, :default_config
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-runner
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kenshi Muto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: playwright-ruby-client