himg 0.0.10-x86_64-linux → 0.0.12-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40c31099160a43ed40c8f97365127aeac0ba6677252c5336627461ffe7c55ea7
-  data.tar.gz: bf48dd9c7ea453460ef981978ea8670f32ba47b950400c84756f0cad9f5785d9
+  metadata.gz: 86747d0277414e8706fa41174ce82ffff9855f41f9841ac84765fd32e15543dc
+  data.tar.gz: f5874103891fa1ae972b470d75e72b4d71ef110f171e5054d7fc0caabedd3b38
 SHA512:
-  metadata.gz: f5725c6c359c70650bfac5effcdd5b32cc252dfbd7f42861d88b5ef400d0cca464b8a04f1ee3cd16ae6b020c0b4f45af39d22daf6dd5b157057f24a75695c973
-  data.tar.gz: 53a34f0e5ad4da3edc0d5af04e075e44a4ccb1cbbc81927bc2bae32c25230cd382f58375c349c815f6149b9a7d77d30b0a9bed265d1e8a21fa109469b1308370
+  metadata.gz: c7b6fd498922f6f9013ccf3648bb2cb9053b243dac77bd6bb3df295ace6e58511ef968e4f101f20b01b38d72e3cc87f0f7910aa3b0f6544dfff4b1fd6ec34173
+  data.tar.gz: 8a143948c0044c345a9b13695f2f4c6f22fb167609d74213ee6cd275c8918a3d77ece576583950fc8b7ace7b00bc53106c4163e453b2aec8c4cb62ed1ade191f

data/Appraisals

@@ -1,39 +1,59 @@
 appraise "plain-ruby" do
+  remove_gem "appraisal"
+  remove_gem "steep"
+  remove_gem "stackprof"
   remove_gem "rails"
   remove_gem "puma"
 end
 
 appraise "rails-6" do
+  remove_gem "appraisal"
+  remove_gem "steep"
+  remove_gem "stackprof"
   remove_gem "puma"
   gem "rails", "~> 6.0"
   gem "rspec-rails", "~> 6.0"
   gem "concurrent-ruby", "1.3.4" # Logger dependency fix, see: https://stackoverflow.com/questions/79360526/uninitialized-constant-activesupportloggerthreadsafelevellogger-nameerror
   gem "bigdecimal", "~> 1.4" # See: https://github.com/rails/rails/issues/34822
   gem "drb"
+  gem "mutex_m"
 end
 
 appraise "rails-7-0" do
+  remove_gem "appraisal"
+  remove_gem "steep"
+  remove_gem "stackprof"
   remove_gem "puma"
   gem "rails", "~> 7.0.0"
   gem "rspec-rails", "~> 7.0"
   gem "concurrent-ruby", "1.3.4" # Logger dependency fix, see: https://stackoverflow.com/questions/79360526/uninitialized-constant-activesupportloggerthreadsafelevellogger-nameerror
   gem "bigdecimal", "~> 1.4" # See: https://github.com/rails/rails/issues/34822
   gem "drb"
+  gem "mutex_m"
 end
 
 appraise "rails-7-1" do
+  remove_gem "appraisal"
+  remove_gem "steep"
+  remove_gem "stackprof"
   remove_gem "puma"
   gem "rails", "~> 7.1.0"
   gem "rspec-rails", "~> 7.0"
 end
 
 appraise "rails-7-2" do
+  remove_gem "appraisal"
+  remove_gem "steep"
+  remove_gem "stackprof"
   remove_gem "puma"
   gem "rails", "~> 7.2.0"
   gem "rspec-rails", "~> 7.0"
 end
 
 appraise "rails-8" do
+  remove_gem "appraisal"
+  remove_gem "steep"
+  remove_gem "stackprof"
   remove_gem "puma"
   gem "rails", "~> 8.0"
   gem "rspec-rails", "~> 7.0"

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 ## [Unreleased]
 
 
+## [0.0.12] - 2025-08-10
+
+- Himg::Renderer re-used between render calls. Allows us to cache font library loading and the multi-threading runtime.
+- Resolve race condition which sometimes prevented local resources from being processed.
+- CLI accepts input piped from stdin, e.g `echo '<h1>Hello</h1>' | himg screenshot output.png`
+- CLI shows usage help info when screenshot is called with incorrect arguments
+
+## [0.0.11] - 2025-08-05
+
+- Adds missing thor dependency for CLI
+- CLI automatically sets base-url for http(s) resources
+- Added `--http-headers` CLI option for sending custom headers when fetching the initial SOURCE HTML.
+- CLI prints `himg help screenshot` USAGE example by default, including version and description.
+
 ## [0.0.10] - 2025-08-01
 
 - Fixed himg require from native extension

data/README.md

@@ -1,10 +1,15 @@
-# Himg: The Hyper Image Generator
+<div align="center">
+  <img src="logo.svg" alt="Himg" width="200">
+  <div>
+    <img src="tagline.svg" alt="The Hyper Image Generator" width="600">
+  </div>
 
-You give it HTML and it gives back an image!
+  <p>You give it HTML and it gives back an image!</p>
 
-Parses HTML/CSS, fetches nested resources, renders an image. No browser, no fuss.
+  <p>Parses HTML/CSS, fetches nested resources, renders an image. No browser, no fuss.</p>
 
-Perfect for OpenGraph images - stop losing clicks to boring links by adding a rich image preview that showcases your content.
+  <p>Perfect for OpenGraph images - stop losing clicks to boring links by adding a rich image preview that showcases your content.</p>
+</div>
 
 ![Mockup showing HTML being transformed into a WhatsApp preview](/readme_hero.svg)
 
@@ -14,8 +19,10 @@ Perfect for OpenGraph images - stop losing clicks to boring links by adding a ri
 
 ```bash
 gem install himg
+
 himg screenshot path/to/your.html screenshot.png
-himg screenshot https://github.com/Jamedjo/himg himg.png --width=1024 --verbose --no-truncate
+himg screenshot https://himg.jamedjo.co.uk himg.png --width=1024 --verbose --no-truncate
+echo '<h1>Hello Image</h1>' | himg screenshot --stdin output.png
 ```
 
 ### Ruby
@@ -48,6 +55,8 @@ OpenGraph tags let messenger apps and social media sites know to use your genera
 <meta property="og:image" content="<%= user_url(@user.username, format: :png) %>" />
 ```
 
+![WhatsApp preview comparison showing plain link vs rich OpenGraph preview](/readme_opengraph_comparison.png)
+
 # Usage
 
 Install the gem and add to the application's Gemfile by executing:
@@ -68,6 +77,8 @@ bundle add himg
 |disable_fetch | Disables fetching linked resources from disk and network| bool | false |
 |fetch_timeout | Timeout in seconds for fetching resources | float | 10.0 |
 |gpu | Use GPU renderer instead of CPU renderer | bool | false |
+|http_headers | Headers sent when the CLI fetches the SOURCE HTML (CLI only) | hash | nil |
+|stdin | Read HTML content from stdin instead of a file (CLI only) | bool | false |
 
 
 ### Passing options to a Rails view template
@@ -129,7 +140,7 @@ Himg supports a large subset of the HTML and CSS you'd need to get by, but not a
 
 For a full list, see our [snapshot of the blitz.is status page](https://github.com/Jamedjo/himg/issues/2).
 
-If something you'd like supported is missing and is available [upstream on blitz](https://blitz.is/status), please [open an issue](https://github.com/Jamedjo/himg/issues/new).
+If something you'd like supported is missing and is available [upstream on Blitz](https://blitz.is/status), please [open an issue](https://github.com/Jamedjo/himg/issues/new).
 
 |HTML|Status|
 |-|-|
@@ -193,7 +204,7 @@ If something you'd like supported is missing and is available [upstream on blitz
 
 No browser, just basics!
 
-Himg calls through to the amazing blitz library, which uses Stylo to parse the CSS, servo/html5ever to parse the HTML, fetches network resources, builds a scene graph and hands over to vello to render an image.
+Himg calls through to the amazing [blitz](https://github.com/DioxusLabs/blitz) library, which uses [Stylo](https://github.com/servo/stylo) to parse the CSS, [servo/html5ever](https://github.com/servo/html5ever) to parse the HTML, fetches network resources, builds a scene graph and hands over to [vello](https://github.com/linebender/vello) to render an image.
 
 Interaction between Ruby & Rust is done with the help of `magnus`, `rb_sys` and lots of glue code from the `oxidize-rb` team.
 
@@ -202,10 +213,9 @@ To play nicely with Rails a template handler is registered, which Rails' `defaul
 ## CAVEATS
 
 1. This is **pre-alpha** software, don't expect it to work perfectly yet.
-2. Performance needs tuning. Both in the underlying blitz library and how data is passed between Rust and Ruby
+2. Performance needs tuning. Both in the underlying [Blitz](https://github.com/DioxusLabs/blitz) library and how data is passed between Rust and Ruby
 3. Network requests can be made: don't use this library with untrusted inputs. Use `disable_fetch` if you don't need to fetch any resources.
 4. file:// URLs are resolved: this could expose files on your computer. Use `disable_fetch` if you don't need to fetch any resources.
-5. Native extensions are not yet being published for different os/arch
 
 # Development
 
@@ -219,6 +229,7 @@ To play nicely with Rails a template handler is registered, which Rails' `defaul
   - http://localhost:3000/users/jamedjo will render an HTML page with opengraph meta tags
 6. To install this gem onto your local machine, run `bundle exec rake install`.
 7. To simulate a headless server environment without a GPU, use `WGPU_BACKEND=empty bundle exec rspec`
+8. To profile performance with flamegraphs, run `bin/profile spec/fixtures/profile_test.html`
 
 ### Run cargo example directly generate image in Rust
 

data/gemfiles/plain_ruby.gemfile.lock

@@ -1,57 +1,19 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.6)
+    himg (0.0.11)
       rb_sys (~> 0.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.0.2)
-      base64
-      benchmark (>= 0.3)
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.3.1)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0, >= 2.0.5)
-      uri (>= 0.13.1)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
     ast (2.4.3)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
     bump (0.10.0)
-    concurrent-ruby (1.3.5)
-    connection_pool (2.5.1)
-    csv (3.3.4)
     date (3.4.1)
     debug (1.10.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.6.1)
-    drb (2.2.1)
-    ffi (1.17.2)
-    ffi (1.17.2-aarch64-linux-gnu)
-    ffi (1.17.2-aarch64-linux-musl)
-    ffi (1.17.2-arm-linux-gnu)
-    ffi (1.17.2-arm-linux-musl)
-    ffi (1.17.2-arm64-darwin)
-    ffi (1.17.2-x86-linux-gnu)
-    ffi (1.17.2-x86-linux-musl)
-    ffi (1.17.2-x86_64-darwin)
-    ffi (1.17.2-x86_64-linux-gnu)
-    ffi (1.17.2-x86_64-linux-musl)
-    fileutils (1.7.3)
-    i18n (1.14.7)
-      concurrent-ruby (~> 1.0)
     io-console (0.8.0)
     irb (1.15.2)
       pp (>= 0.6.0)
@@ -60,12 +22,6 @@ GEM
     json (2.10.2)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    listen (3.9.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.7.0)
-    minitest (5.25.5)
-    mutex_m (0.3.0)
     parallel (1.27.0)
     parser (3.3.8.0)
       ast (~> 2.4.1)
@@ -83,13 +39,8 @@ GEM
     rake-compiler (1.3.0)
       rake
     rake-compiler-dock (1.9.1)
-    rb-fsevent (0.11.2)
-    rb-inotify (0.11.1)
-      ffi (~> 1.0)
     rb_sys (0.9.111)
       rake-compiler-dock (= 1.9.1)
-    rbs (3.9.2)
-      logger
     rdoc (6.13.1)
       psych (>= 4.0.0)
     regexp_parser (2.10.0)
@@ -123,35 +74,11 @@ GEM
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     ruby-progressbar (1.13.0)
-    securerandom (0.4.1)
-    steep (1.10.0)
-      activesupport (>= 5.1)
-      concurrent-ruby (>= 1.1.10)
-      csv (>= 3.0.9)
-      fileutils (>= 1.1.0)
-      json (>= 2.1.0)
-      language_server-protocol (>= 3.17.0.4, < 4.0)
-      listen (~> 3.0)
-      logger (>= 1.3.0)
-      mutex_m (>= 0.3.0)
-      parser (>= 3.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rbs (~> 3.9)
-      securerandom (>= 0.1)
-      strscan (>= 1.0.0)
-      terminal-table (>= 2, < 5)
-      uri (>= 0.12.0)
     stringio (3.1.7)
-    strscan (3.1.3)
-    terminal-table (4.0.0)
-      unicode-display_width (>= 1.1.1, < 4)
-    thor (1.3.2)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
+    thor (1.4.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.3)
 
 PLATFORMS
   aarch64-linux-gnu
@@ -166,7 +93,6 @@ PLATFORMS
   x86_64-linux-musl
 
 DEPENDENCIES
-  appraisal
   bump
   debug
   himg!
@@ -175,7 +101,7 @@ DEPENDENCIES
   rake-compiler
   rspec
   rubocop
-  steep
+  thor
 
 BUNDLED WITH
    2.6.7

data/gemfiles/rails_6.gemfile

@@ -7,5 +7,6 @@ gem "rspec-rails", "~> 6.0"
 gem "concurrent-ruby", "1.3.4"
 gem "bigdecimal", "~> 1.4"
 gem "drb"
+gem "mutex_m"
 
 gemspec path: "../"

data/gemfiles/rails_6.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.6)
+    himg (0.0.11)
       rb_sys (~> 0.9)
 
 GEM
@@ -66,10 +66,6 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
     ast (2.4.3)
     base64 (0.2.0)
     bigdecimal (1.4.4)
@@ -77,7 +73,6 @@ GEM
     bump (0.10.0)
     concurrent-ruby (1.3.4)
     crass (1.0.6)
-    csv (3.3.4)
     date (3.4.1)
     debug (1.10.0)
       irb (~> 1.10)
@@ -85,15 +80,6 @@ GEM
     diff-lcs (1.6.1)
     drb (2.2.1)
     erubi (1.13.1)
-    ffi (1.17.2-aarch64-linux-gnu)
-    ffi (1.17.2-aarch64-linux-musl)
-    ffi (1.17.2-arm-linux-gnu)
-    ffi (1.17.2-arm-linux-musl)
-    ffi (1.17.2-arm64-darwin)
-    ffi (1.17.2-x86_64-darwin)
-    ffi (1.17.2-x86_64-linux-gnu)
-    ffi (1.17.2-x86_64-linux-musl)
-    fileutils (1.7.3)
     globalid (1.2.1)
       activesupport (>= 6.1)
     i18n (1.14.7)
@@ -106,9 +92,6 @@ GEM
     json (2.10.2)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    listen (3.9.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
     loofah (2.24.0)
       crass (~> 1.0.2)
@@ -197,13 +180,8 @@ GEM
     rake-compiler (1.3.0)
       rake
     rake-compiler-dock (1.9.1)
-    rb-fsevent (0.11.2)
-    rb-inotify (0.11.1)
-      ffi (~> 1.0)
     rb_sys (0.9.111)
       rake-compiler-dock (= 1.9.1)
-    rbs (3.9.2)
-      logger
     rdoc (6.13.1)
       psych (>= 4.0.0)
     regexp_parser (2.10.0)
@@ -245,7 +223,6 @@ GEM
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     ruby-progressbar (1.13.0)
-    securerandom (0.4.1)
     sprockets (4.2.2)
       concurrent-ruby (~> 1.0)
       logger
@@ -254,27 +231,7 @@ GEM
       actionpack (>= 6.1)
       activesupport (>= 6.1)
       sprockets (>= 3.0.0)
-    steep (1.10.0)
-      activesupport (>= 5.1)
-      concurrent-ruby (>= 1.1.10)
-      csv (>= 3.0.9)
-      fileutils (>= 1.1.0)
-      json (>= 2.1.0)
-      language_server-protocol (>= 3.17.0.4, < 4.0)
-      listen (~> 3.0)
-      logger (>= 1.3.0)
-      mutex_m (>= 0.3.0)
-      parser (>= 3.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rbs (~> 3.9)
-      securerandom (>= 0.1)
-      strscan (>= 1.0.0)
-      terminal-table (>= 2, < 5)
-      uri (>= 0.12.0)
     stringio (3.1.7)
-    strscan (3.1.3)
-    terminal-table (4.0.0)
-      unicode-display_width (>= 1.1.1, < 4)
     thor (1.3.2)
     timeout (0.4.3)
     tzinfo (2.0.6)
@@ -282,7 +239,6 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.3)
     websocket-driver (0.7.7)
       base64
       websocket-extensions (>= 0.1.0)
@@ -300,7 +256,6 @@ PLATFORMS
   x86_64-linux-musl
 
 DEPENDENCIES
-  appraisal
   bigdecimal (~> 1.4)
   bump
   concurrent-ruby (= 1.3.4)
@@ -308,13 +263,14 @@ DEPENDENCIES
   drb
   himg!
   irb
+  mutex_m
   rails (~> 6.0)
   rake
   rake-compiler
   rspec
   rspec-rails (~> 6.0)
   rubocop
-  steep
+  thor
 
 BUNDLED WITH
    2.6.7

data/gemfiles/rails_7_0.gemfile

@@ -7,5 +7,6 @@ gem "rspec-rails", "~> 7.0"
 gem "concurrent-ruby", "1.3.4"
 gem "bigdecimal", "~> 1.4"
 gem "drb"
+gem "mutex_m"
 
 gemspec path: "../"

data/gemfiles/rails_7_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.6)
+    himg (0.0.11)
       rb_sys (~> 0.9)
 
 GEM
@@ -72,10 +72,6 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
     ast (2.4.3)
     base64 (0.2.0)
     bigdecimal (1.4.4)
@@ -83,7 +79,6 @@ GEM
     bump (0.10.0)
     concurrent-ruby (1.3.4)
     crass (1.0.6)
-    csv (3.3.4)
     date (3.4.1)
     debug (1.10.0)
       irb (~> 1.10)
@@ -91,15 +86,6 @@ GEM
     diff-lcs (1.6.1)
     drb (2.2.1)
     erubi (1.13.1)
-    ffi (1.17.2-aarch64-linux-gnu)
-    ffi (1.17.2-aarch64-linux-musl)
-    ffi (1.17.2-arm-linux-gnu)
-    ffi (1.17.2-arm-linux-musl)
-    ffi (1.17.2-arm64-darwin)
-    ffi (1.17.2-x86_64-darwin)
-    ffi (1.17.2-x86_64-linux-gnu)
-    ffi (1.17.2-x86_64-linux-musl)
-    fileutils (1.7.3)
     globalid (1.2.1)
       activesupport (>= 6.1)
     i18n (1.14.7)
@@ -112,10 +98,6 @@ GEM
     json (2.10.2)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    listen (3.9.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.7.0)
     loofah (2.24.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -203,13 +185,8 @@ GEM
     rake-compiler (1.3.0)
       rake
     rake-compiler-dock (1.9.1)
-    rb-fsevent (0.11.2)
-    rb-inotify (0.11.1)
-      ffi (~> 1.0)
     rb_sys (0.9.111)
       rake-compiler-dock (= 1.9.1)
-    rbs (3.9.2)
-      logger
     rdoc (6.13.1)
       psych (>= 4.0.0)
     regexp_parser (2.10.0)
@@ -251,28 +228,7 @@ GEM
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     ruby-progressbar (1.13.0)
-    securerandom (0.4.1)
-    steep (1.10.0)
-      activesupport (>= 5.1)
-      concurrent-ruby (>= 1.1.10)
-      csv (>= 3.0.9)
-      fileutils (>= 1.1.0)
-      json (>= 2.1.0)
-      language_server-protocol (>= 3.17.0.4, < 4.0)
-      listen (~> 3.0)
-      logger (>= 1.3.0)
-      mutex_m (>= 0.3.0)
-      parser (>= 3.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rbs (~> 3.9)
-      securerandom (>= 0.1)
-      strscan (>= 1.0.0)
-      terminal-table (>= 2, < 5)
-      uri (>= 0.12.0)
     stringio (3.1.7)
-    strscan (3.1.3)
-    terminal-table (4.0.0)
-      unicode-display_width (>= 1.1.1, < 4)
     thor (1.3.2)
     timeout (0.4.3)
     tzinfo (2.0.6)
@@ -280,7 +236,6 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.3)
     websocket-driver (0.7.7)
       base64
       websocket-extensions (>= 0.1.0)
@@ -298,7 +253,6 @@ PLATFORMS
   x86_64-linux-musl
 
 DEPENDENCIES
-  appraisal
   bigdecimal (~> 1.4)
   bump
   concurrent-ruby (= 1.3.4)
@@ -306,13 +260,14 @@ DEPENDENCIES
   drb
   himg!
   irb
+  mutex_m
   rails (~> 7.0.0)
   rake
   rake-compiler
   rspec
   rspec-rails (~> 7.0)
   rubocop
-  steep
+  thor
 
 BUNDLED WITH
    2.6.7