gkhtmltopdf 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 693828b2a9f004f9038b744c5d4a527a46f27ca55ad7c3d4638478aa2a747ade
-  data.tar.gz: 418727b131d4305641bcb66df639c961aabc73de334fd599b06d772f2b0557ba
+  metadata.gz: 9b1e75b29bc038ca05956a13cecbd811f766f5ce5047b044348f707e18f5fdaf
+  data.tar.gz: 6f4880a82c257459133d3d63cb9eca5b6b538095ee9278b5846d965b53edda95
 SHA512:
-  metadata.gz: 8776f073004b0e5dba496316e4c95e18121784be2430b12f679dc900cfee41e7002befda8fe022f30739e8bdf33c76ce7c51cd625ed5e5095cc95f4eb60b4d3f
-  data.tar.gz: 3df53840690e009d5c39a18710867505eff22e0bbb0d6711dfc6f8cc44a73442c02f1d6f5b5c1c3ac9f5c5c327f61d377bbab9a73dafea0124ff4a20e378426b
+  metadata.gz: ec2c49f78a33d7be7257e09bc66508d14b65880ab88b48d636580de5052abbd31a34f2544d0c7c9acb1491ddda8fe74f09ff5d22c061ea465261170ca85388ae
+  data.tar.gz: 8e518a69a0183db0f3a4545d9fc20e8654cc189df79af68b1297b74b19f96a76ad74288fc12a107aaaab038903e678ab4102ea25983f2ae38e863d11c75907d8

data/CHANGELOG.md

@@ -2,11 +2,24 @@
 
 All noteworthy changes to this project will be documented in this file.
 
+## 1.2.0 / 2026-07-31
+
+- Added `pdf_binary` methods.
+  - PDFバイナリ取得メソッドの追加
+
+## 1.1.1 / 2026-06-29
+
+- Added STDOUT/STDERR for geckodriver.
+  - GeckodriverのSTDOUT/STDERR追加
+
 ## 1.1.0 / 2026-06-29
 
-- UA設定機能の追加
-- mktmpdirの明示的な削除
-- ubuntuでの動かし方とか修正
+- Added User-Agent setting.
+  - UA設定機能の追加
+- Explicit deleted of `mktmpdir`.
+  - `mktmpdir` の明示的な削除
+- Howto and docs updated.
+  - ubuntuでの動かし方とか修正
 
 ## 1.0.0 / 2026-03-19
 

data/README.md

@@ -16,33 +16,19 @@ This gem converts HTML to PDF using Firefox's Geckodriver.
 
 ### 1. Install
 
-1. [Firefox](https://www.firefox.com)
-  - Ubuntu  
-    > The snap does not work correctly, so please install it from the [official source](https://support.mozilla.org/en-US/kb/install-firefox-linux).
-    ```bash
-    $ wget -q https://packages.mozilla.org/apt/repo-signing-key.gpg -O- | sudo tee /etc/apt/keyrings/packages.mozilla.org.asc > /dev/null
-    $ echo "deb [signed-by=/etc/apt/keyrings/packages.mozilla.org.asc] https://packages.mozilla.org/apt mozilla main" | tee -a /etc/apt/sources.list.d/mozilla.list > /dev/null
-    $ tee /etc/apt/preferences.d/mozilla > /dev/null << EOF
-      Package: *
-      Pin: origin packages.mozilla.org
-      Pin-Priority: 1000
-      EOF
-    $ apt install -y firefox
-    $ apt install -y fonts-noto # recommended
-    ```
-  - Debian  
-    ```bash
-    $ apt install -y firefox-esr
-    $ apt install -y fonts-noto # recommended
-    ```
-
-2. [geckodriver](https://github.com/mozilla/geckodriver)
-  - Linux (Ubuntu / Debian)  
-    ```bash
-    $ wget "https://github.com/mozilla/geckodriver/releases/download/v0.36.0/geckodriver-v0.36.0-linux64.tar.gz" -O /tmp/geckodriver.tar.gz
-    $ tar -xzf /tmp/geckodriver.tar.gz -C /usr/local/bin
-    ```
+> The following is an example of the setup on Debian 13.  
+> For other operating systems (Ubuntu / Amazon Linux), please see [here](/docs/SupportList.md).
 
+1. [Firefox](https://www.firefox.com)  
+```bash
+$ apt install -y firefox-esr
+$ apt install -y fonts-noto # recommended
+```
+2. [geckodriver](https://github.com/mozilla/geckodriver)  
+```bash
+$ wget "https://github.com/mozilla/geckodriver/releases/download/v0.36.0/geckodriver-v0.36.0-linux64.tar.gz" -O /tmp/geckodriver.tar.gz
+$ tar -xzf /tmp/geckodriver.tar.gz -C /usr/local/bin
+```
 3. gem install
   - bundler  
     ```bash
@@ -82,10 +68,18 @@ Gkhtmltopdf.open do |gkh2p|
   gkh2p.save_pdf('file:///foo/bar/test.html', 'local.pdf')
   gkh2p.save_pdf('https://f6a.net/oss/', 'with_bg.pdf', print_options: {background: true})
 end
-# set custom user-agent
+# After version 1.1.0: set custom user-agent
 Gkhtmltopdf.open(user_agent: 'YOUR USER AGENT') do |gkh2p|
   gkh2p.save_pdf('https://f6a.net/oss/', 'ua.pdf')
 end
+# After version 1.2.0: get PDF binary
+Gkhtmltopdf.open do |gkh2p|
+  pdf_obj = gkh2p.pdf_binary('https://f6a.net/oss/', print_options: {background: true})
+  # for example, If the PDF size between 16KB and 1MB, write binary to a file.
+  max = 1 * 1000 * 1000
+  min = 16 * 1000
+  File.binwrite('binary.pdf', pdf_obj) if pdf_obj.bytesize.between?(min, max)
+end
 ```
 
 #### Shell

data/TODO.md

@@ -22,14 +22,18 @@
 - [x] UA設定機能の追加
 - [x] mktmpdirの明示的な削除
 
-## つぎ v1.2.0
+## 完了 v1.1.1
 
-- [ ] 設定のStruct化?(default切り出し)
-- [ ] pdfをsaveせずバイナリを直接返却するメソッドの追加
-- [ ] 肥大化したconvert.rbの分割( `Gkhtmltopdf::PDF` とかつくるか)
+- [x] GeckodriverのSTDOUT/STDERR追加
+
+## 完了 v1.2.0
+
+- [x] pdfをsaveせずバイナリを直接返却するメソッドの追加
 
 ## 検討中
 
+- [ ] 設定のStruct化?(default切り出し)
+- [ ] 肥大化したconvert.rbの分割( `Gkhtmltopdf::PDF` とかつくるか)
 - [ ] ポート範囲設定?
 - [ ] YARD追加
 - [ ] FireFox timeout

data/dockerfiles/Dockerfile.amazonlinux2023-ruby32

@@ -0,0 +1,21 @@
+# syntax=docker/dockerfile:1.7
+FROM amazonlinux:2023
+RUN yum check-update
+RUN yum install -y wget tar git gzip ruby3.2 ruby3.2-devel libyaml-devel
+RUN yum groupinstall -y "Development Tools"
+
+# Install Noto Fonts
+RUN yum install -y google-noto-cjk-fonts
+RUN yum install -y google-noto-emoji-fonts
+
+# Install Firefox
+RUN yum install -y firefox
+
+# Install Geckodriver
+RUN wget "https://github.com/mozilla/geckodriver/releases/download/v0.36.0/geckodriver-v0.36.0-linux64.tar.gz" -O geckodriver.tar.gz
+RUN tar -xzf geckodriver.tar.gz -C /usr/local/bin
+
+COPY . /app
+WORKDIR /app
+RUN bundle install
+CMD ["bundle", "exec", "rspec"]

data/dockerfiles/Dockerfile.debian13-ruby32

@@ -1,4 +1,3 @@
-# escape=\
 # syntax=docker/dockerfile:1.7
 FROM ruby:3.2-slim
 

data/dockerfiles/Dockerfile.debian13-ruby34

@@ -0,0 +1,20 @@
+# syntax=docker/dockerfile:1.7
+FROM ruby:3.4-slim
+
+RUN apt-get update
+RUN apt-get install -y git wget xz-utils build-essential libyaml-dev
+
+# Install Noto Fonts
+RUN apt-get install -y fonts-noto
+
+# Install Firefox
+RUN apt-get install -y firefox-esr
+
+# Install Geckodriver
+RUN wget "https://github.com/mozilla/geckodriver/releases/download/v0.36.0/geckodriver-v0.36.0-linux64.tar.gz" -O geckodriver.tar.gz
+RUN tar -xzf geckodriver.tar.gz -C /usr/local/bin
+
+COPY . /app
+WORKDIR /app
+RUN bundle install
+CMD ["bundle", "exec", "rspec"]

data/dockerfiles/Dockerfile.debian13-ruby40

@@ -0,0 +1,20 @@
+# syntax=docker/dockerfile:1.7
+FROM ruby:4.0-slim
+
+RUN apt-get update
+RUN apt-get install -y git wget xz-utils build-essential libyaml-dev
+
+# Install Noto Fonts
+RUN apt-get install -y fonts-noto
+
+# Install Firefox
+RUN apt-get install -y firefox-esr
+
+# Install Geckodriver
+RUN wget "https://github.com/mozilla/geckodriver/releases/download/v0.36.0/geckodriver-v0.36.0-linux64.tar.gz" -O geckodriver.tar.gz
+RUN tar -xzf geckodriver.tar.gz -C /usr/local/bin
+
+COPY . /app
+WORKDIR /app
+RUN bundle install
+CMD ["bundle", "exec", "rspec"]

data/dockerfiles/Dockerfile.ubuntu24-ruby32

@@ -1,3 +1,4 @@
+# syntax=docker/dockerfile:1
 FROM ubuntu:noble
 
 RUN apt-get update

data/dockerfiles/Dockerfile.ubuntu26-ruby33

@@ -0,0 +1,35 @@
+# syntax=docker/dockerfile:1
+FROM ubuntu:resolute
+
+RUN apt-get update
+RUN apt-get install -y ruby3.3 bundler
+RUN apt-get install -y git wget xz-utils build-essential libyaml-dev
+
+# Install Noto Fonts
+RUN apt-get install -y fonts-noto
+
+# Install Firefox
+RUN wget -q https://packages.mozilla.org/apt/repo-signing-key.gpg -O- | tee /etc/apt/keyrings/packages.mozilla.org.asc > /dev/null
+RUN tee /etc/apt/sources.list.d/mozilla.sources > /dev/null << EOF
+Types: deb
+URIs: https://packages.mozilla.org/apt
+Suites: mozilla
+Components: main
+Signed-By: /etc/apt/keyrings/packages.mozilla.org.asc
+EOF
+RUN tee /etc/apt/preferences.d/mozilla > /dev/null << EOF
+Package: *
+Pin: origin packages.mozilla.org
+Pin-Priority: 1000
+EOF
+RUN apt-get update
+RUN apt-get install -y firefox
+
+# Install Geckodriver
+RUN wget "https://github.com/mozilla/geckodriver/releases/download/v0.36.0/geckodriver-v0.36.0-linux64.tar.gz" -O geckodriver.tar.gz
+RUN tar -xzf geckodriver.tar.gz -C /usr/local/bin
+
+COPY . /app
+WORKDIR /app
+RUN bundle install
+CMD ["bundle", "exec", "rspec"]

data/docs/ForDeveloper.md

@@ -2,16 +2,44 @@
 
 ## Test
 
+### Docker build
+
 ```bash
 $ docker build -f ./dockerfiles/Dockerfile.debian13-ruby32 . -t gkhtmltopdf-d13r32
 $ docker build -f ./dockerfiles/Dockerfile.ubuntu24-ruby32 . -t gkhtmltopdf-u24r32
+$ docker build -f ./dockerfiles/Dockerfile.ubuntu26-ruby33 . -t gkhtmltopdf-u26r33
+$ docker build -f ./dockerfiles/Dockerfile.debian13-ruby34 . -t gkhtmltopdf-d13r34
+$ docker build -f ./dockerfiles/Dockerfile.debian13-ruby40 . -t gkhtmltopdf-d13r40
+$ docker build -f ./dockerfiles/Dockerfile.amazonlinux2023-ruby32 . -t gkhtmltopdf-a23r32
+```
+
+### Docker run rspec
+
+```bash
 $ docker run --rm gkhtmltopdf-d13r32
 $ docker run --rm gkhtmltopdf-u24r32
+$ docker run --rm gkhtmltopdf-u26r33
+$ docker run --rm gkhtmltopdf-d13r34
+$ docker run --rm gkhtmltopdf-d13r40
+$ docker run --rm gkhtmltopdf-a23r32
+```
+
+### Docker remove image
+
+```bash
 $ docker rmi gkhtmltopdf-d13r32
 $ docker rmi gkhtmltopdf-u24r32
+$ docker rmi gkhtmltopdf-u26r33
+$ docker rmi gkhtmltopdf-d13r34
+$ docker rmi gkhtmltopdf-d13r40
+$ docker rmi gkhtmltopdf-a23r32
 ```
 
+---
+
 ## Build
 
-```
+```bash
+$ gem build gkhtmltopdf.gemspec
+$ gem push ~.gem
 ```

data/docs/SupportList.md

@@ -0,0 +1,13 @@
+# SupportList
+
+Operation has been verified with the following OS and Ruby versions.  
+Please refer to the Dockerfile if you are unsure how to run the application.
+
+|       OS       | Ruby|   Link   |
+|----------------|-----|----------|
+|   Debian 13    |3.2.x| [Dockerfile](/dockerfiles/Dockerfile.debian13-ruby32) |
+|   Debian 13    |3.3.x| [Dockerfile](/dockerfiles/Dockerfile.debian13-ruby33) |
+|   Debian 13    |4.0.x| [Dockerfile](/dockerfiles/Dockerfile.debian13-ruby40) |
+|  Ubuntu 24.04  |3.2.x| [Dockerfile](/dockerfiles/Dockerfile.ubuntu24-ruby32) |
+|  Ubuntu 26.04  |3.3.x| [Dockerfile](/dockerfiles/Dockerfile.ubuntu26-ruby33) |
+|AmazonLinux 2023|3.2.x| [Dockerfile](/dockerfiles/Dockerfile.amazonlinux2023-ruby32) |

data/exe/gkhtmltopdf

@@ -6,7 +6,9 @@ require 'gkhtmltopdf'
 
 options = {
   print_options: {},
-  firefox_prefs: {}
+  firefox_prefs: {},
+  gecko_stdout: File::NULL,
+  gecko_stderr: File::NULL
 }
 
 parser = OptionParser.new do |opts|
@@ -46,6 +48,14 @@ parser = OptionParser.new do |opts|
     options[:wait_time] = v
   end
 
+  opts.on("--stdout", "Show Geckodriver stdout") do |b|
+    options[:gecko_stdout] = b ? (STDOUT) : File::NULL
+  end
+
+  opts.on("--stderr", "Show Geckodriver stderr") do |b|
+    options[:gecko_stdout] = b ? (STDERR) : File::NULL
+  end
+
   opts.on("-v", "--version", "display version") do
     puts "Gkhtmltopdf version #{Gkhtmltopdf::VERSION}"
     exit
@@ -79,6 +89,8 @@ begin
   init_options[:geckodriver_path] = options.delete(:geckodriver_path) if options[:geckodriver_path]
   init_options[:wait_time] = options.delete(:wait_time) if options[:wait_time]
   init_options[:user_agent] = options.delete(:user_agent) if options[:user_agent]
+  init_options[:gecko_stdout] = options.delete(:gecko_stdout) if options[:gecko_stdout]
+  init_options[:gecko_stdout] = options.delete(:gecko_stdout) if options[:gecko_stdout]
 
   Gkhtmltopdf.convert(input_url, output_path, print_options: options[:print_options], **init_options)
 

data/lib/gkhtmltopdf/converter.rb

@@ -12,12 +12,14 @@ module Gkhtmltopdf
   class Converter
     DEFAULT_FX_USER_AGENT = "gkhtmltopdf-rb(v#{VERSION}) by firefox and gecko".freeze
 
-    def open(geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, user_agent: nil)
+    def open(geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, user_agent: nil, gecko_stdout: nil, gecko_stderr: nil)
       @geckodriver_path = resolve_geckodriver_path!(geckodriver_path)
       @firefox_path = resolve_firefox_path!(firefox_path)
       @port = port || get_free_port
       @base_url = "http://127.0.0.1:#{@port}"
-      @pid = spawn("#{@geckodriver_path} --port #{@port}", out: File::NULL, err: File::NULL)
+      gecko_stdout = File::NULL if gecko_stdout.nil?
+      gecko_stderr = File::NULL if gecko_stderr.nil?
+      @pid = spawn("#{@geckodriver_path} --port #{@port}", out: gecko_stdout, err: gecko_stderr)
       wait_time ||= 20
       @profile_path = gen_tmp_profile(user_agent)
       wait_for_gk(wait_time)
@@ -45,6 +47,13 @@ module Gkhtmltopdf
       File.binwrite(output_path, Base64.decode64(pdf_base64))
     end
 
+    def pdf_binary(url, print_options: {})
+      validate_url_scheme!(url)
+      navigate(url)
+      pdf_base64 = print_pdf(print_options)
+      Base64.decode64(pdf_base64)
+    end
+
     private
 
     def get_free_port

data/lib/gkhtmltopdf/dsl.rb

@@ -17,5 +17,9 @@ module Gkhtmltopdf
     def save_pdf(url, output_path, print_options: {})
       @converter.save_pdf(url, output_path, print_options: print_options)
     end
+
+    def pdf_binary(url, print_options: {})
+      @converter.pdf_binary(url, print_options: print_options)
+    end
   end
 end

data/lib/gkhtmltopdf/version.rb

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

data/lib/gkhtmltopdf.rb

@@ -6,17 +6,17 @@ require_relative 'gkhtmltopdf/dsl'
 require_relative 'errors'
 
 module Gkhtmltopdf
-  def self.convert(url, output_path, geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, user_agent: nil, print_options: {})
+  def self.convert(url, output_path, geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, user_agent: nil, gecko_stdout: nil, gecko_stderr: nil, print_options: {})
     converter = DSL.new
-    converter.open(geckodriver_path: geckodriver_path, firefox_path: firefox_path, wait_time: wait_time, port: port, user_agent: user_agent)
+    converter.open(geckodriver_path: geckodriver_path, firefox_path: firefox_path, wait_time: wait_time, port: port, user_agent: user_agent, gecko_stdout: gecko_stdout, gecko_stderr: gecko_stderr)
     converter.save_pdf(url, output_path, print_options: print_options)
   ensure
     converter.close
   end
 
-  def self.open(geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, user_agent: nil, &block)
+  def self.open(geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, user_agent: nil, gecko_stdout: nil, gecko_stderr: nil, &block)
     converter = DSL.new
-    converter.open(geckodriver_path: geckodriver_path, firefox_path: firefox_path, wait_time: wait_time, port: port, user_agent: user_agent)
+    converter.open(geckodriver_path: geckodriver_path, firefox_path: firefox_path, wait_time: wait_time, port: port, user_agent: user_agent, gecko_stdout: gecko_stdout, gecko_stderr: gecko_stderr)
     yield converter
   ensure
     converter.close

data/spec/gkhtmltopdf/converter_spec.rb

@@ -29,6 +29,16 @@ RSpec.describe Gkhtmltopdf::Converter do
       expect(File.binread(output)).to include('/FontName')
     }
   end
+  describe '#pdf_binary' do
+    before { converter.open }
+    let(:url) { "file://#{file_fixture('test.html')}" }
+
+    subject { converter.pdf_binary(url) }
+
+    it {
+      is_expected.to include('/FontName')
+    }
+  end
   describe '#resolve_geckodriver_path!' do
     subject { converter.send(:resolve_geckodriver_path!, nil) }
     context 'geckodriver is not available' do

data/spec/gkhtmltopdf_spec.rb

@@ -24,22 +24,41 @@ RSpec.describe Gkhtmltopdf do
     let(:url) { 'https://f6a.net/oss/' }
     let(:output_path) { Dir.mktmpdir }
     after { FileUtils.remove_entry_secure(output_path) }
+    describe '.save_pdf' do
+      subject do
+        Gkhtmltopdf.open do |gk|
+          (1..3).each { |n| gk.save_pdf("#{url}?test=#{n}", File.join(output_path, "#{n}.pdf")) }
+        end
+      end
 
-    subject do
-      Gkhtmltopdf.open do |gk|
-        (1..3).each { |n| gk.save_pdf("#{url}?test=#{n}", File.join(output_path, "#{n}.pdf")) }
+      it 'successful conversion' do
+        expect { subject }.to change { Dir.glob(File.join(output_path, '*.pdf')).count }.from(0).to(3)
+        expect { subject }.not_to raise_error
       end
-    end
 
-    it 'successful conversion' do
-      expect { subject }.to change { Dir.glob(File.join(output_path, '*.pdf')).count }.from(0).to(3)
-      expect { subject }.not_to raise_error
+      context 'invalid URL' do
+        let(:url) { 'ftp://example.com' }
+        it 'raises an error' do
+          expect { subject }.to raise_error(Gkhtmltopdf::URLSchemeInvalid, 'Invalid URL scheme: (ftp)')
+        end
+      end
     end
-
-    context 'invalid URL' do
-      let(:url) { 'ftp://example.com' }
-      it 'raises an error' do
-        expect { subject }.to raise_error(Gkhtmltopdf::URLSchemeInvalid, 'Invalid URL scheme: (ftp)')
+    describe '.pdf_binary' do
+      subject do
+        Gkhtmltopdf.open do |gk|
+          pdf_binary = gk.pdf_binary("#{url}?test=binary")
+          pdf_binary.bytesize
+        end
+      end
+      it 'successful conversion' do
+        is_expected.to be > 1000
+        expect { subject }.not_to raise_error
+      end
+      context 'invalid URL' do
+        let(:url) { 'ftp://example.com' }
+        it 'raises an error' do
+          expect { subject }.to raise_error(Gkhtmltopdf::URLSchemeInvalid, 'Invalid URL scheme: (ftp)')
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gkhtmltopdf
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kazuki Sakane
@@ -82,9 +82,14 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- dockerfiles/Dockerfile.amazonlinux2023-ruby32
 - dockerfiles/Dockerfile.debian13-ruby32
+- dockerfiles/Dockerfile.debian13-ruby34
+- dockerfiles/Dockerfile.debian13-ruby40
 - dockerfiles/Dockerfile.ubuntu24-ruby32
+- dockerfiles/Dockerfile.ubuntu26-ruby33
 - docs/ForDeveloper.md
+- docs/SupportList.md
 - exe/gkhtmltopdf
 - lib/errors.rb
 - lib/gkhtmltopdf.rb